Merge pull request #175 from sue445/feature/create_go_makefile

Impl `create_go_makefile`

Author: sue445

.yardopts

@@ -3,6 +3,7 @@
 --hide-void-return
 _tools/ruby_h_to_go/*.rb
 _tools/ruby_h_to_go/lib/**/*.rb
+gem/**/*.rb
 -
 CHANGELOG.md
 LICENSE

_tools/patch_for_go_gem/patch_for_go_gem.rb

@@ -31,6 +31,7 @@ def perform
     create_go_mod
     update_gem_name_c
     update_extconf_rb
+    update_gemspec
   end
 
   private
@@ -125,65 +126,45 @@ def update_gem_name_c
     save_file(file_path: gem_name_c_path, content:)
   end
 
-  def update_extconf_rb # rubocop:disable Metrics/MethodLength
+  def update_extconf_rb
     extconf_rb_path = File.join(ext_dir, "extconf.rb")
 
     content = File.read(extconf_rb_path)
 
-    unless content.include?(<<~RUBY)
-      require "mkmf"
-
-      find_executable("go")
-    RUBY
-
+    unless content.include?(%(require "go_gem/mkmf"))
       content.gsub!(<<~RUBY, <<~RUBY)
         require "mkmf"
       RUBY
         require "mkmf"
-
-        find_executable("go")
-
-        # rubocop:disable Style/GlobalVars
-        $objs = []
-        def $objs.empty?; false; end
-        # rubocop:enable Style/GlobalVars
-
+        require "go_gem/mkmf"
       RUBY
     end
 
-    unless content.include?(<<~RUBY)
-      create_makefile("#{gem_name}/#{gem_name}")
-
-      case `\#{CONFIG["CC"]} --version` # rubocop:disable Lint/LiteralAsCondition
-    RUBY
-
+    unless content.include?(%(create_go_makefile("#{gem_name}/#{gem_name}")))
       content.gsub!(<<~RUBY, <<~RUBY)
         create_makefile("#{gem_name}/#{gem_name}")
       RUBY
-        create_makefile("#{gem_name}/#{gem_name}")
+        create_go_makefile("#{gem_name}/#{gem_name}")
+      RUBY
+    end
 
-        case `\#{CONFIG["CC"]} --version` # rubocop:disable Lint/LiteralAsCondition
-        when /Free Software Foundation/
-          ldflags = "-Wl,--unresolved-symbols=ignore-all"
-        when /clang/
-          ldflags = "-undefined dynamic_lookup"
-        end
+    save_file(file_path: extconf_rb_path, content:)
+  end
 
-        current_dir = File.expand_path(".")
+  def update_gemspec
+    content = File.read(gemspec_file)
 
-        File.open("Makefile", "a") do |f|
-          f.write <<~MAKEFILE.gsub(/^ {8}/, "\t")
-            $(DLLIB): Makefile $(srcdir)/*.go
-                    cd $(srcdir); \
-                    CGO_CFLAGS='$(INCFLAGS)' CGO_LDFLAGS='\#{ldflags}' \\
-                      go build -p 4 -buildmode=c-shared -o \#{current_dir}/$(DLLIB)
-          MAKEFILE
-        end
+    return if content.include?(%(.add_dependency "go_gem")) || content.include?(%(.add_runtime_dependency "go_gem"))
 
-      RUBY
-    end
+    content =~ /Gem::Specification\.new\s+do\s+\|(.+)\|/
+    spec_var_name = ::Regexp.last_match(1)
 
-    save_file(file_path: extconf_rb_path, content:)
+    content.gsub!(/^end\n/, <<~RUBY)
+        #{spec_var_name}.add_dependency "go_gem"
+      end
+    RUBY
+
+    save_file(file_path: gemspec_file, content:)
   end
 
   # @param file_path [String]

_tools/patch_for_go_gem/spec/patch_for_go_gem_spec.rb

@@ -88,47 +88,18 @@ module github.com/username/#{gem_name}
   end
 
   describe file(File.join(gem_name, "ext", gem_name, "extconf.rb")) do
-    let(:content1) do
-      <<~RUBY
-        require "mkmf"
-
-        find_executable("go")
-
-        # rubocop:disable Style/GlobalVars
-        $objs = []
-        def $objs.empty?; false; end
-        # rubocop:enable Style/GlobalVars
-      RUBY
-    end
-
-    let(:content2) do
-      <<~RUBY
-        create_makefile("#{gem_name}/#{gem_name}")
-
-        case `\#{CONFIG["CC"]} --version` # rubocop:disable Lint/LiteralAsCondition
-        when /Free Software Foundation/
-          ldflags = "-Wl,--unresolved-symbols=ignore-all"
-        when /clang/
-          ldflags = "-undefined dynamic_lookup"
-        end
-
-        current_dir = File.expand_path(".")
+    it { should be_file }
+    it { should exist }
 
-        File.open("Makefile", "a") do |f|
-          f.write <<~MAKEFILE.gsub(/^ {8}/, "\t")
-            $(DLLIB): Makefile $(srcdir)/*.go
-                    cd $(srcdir); \
-                    CGO_CFLAGS='$(INCFLAGS)' CGO_LDFLAGS='\#{ldflags}' \\
-                      go build -p 4 -buildmode=c-shared -o \#{current_dir}/$(DLLIB)
-          MAKEFILE
-        end
-      RUBY
-    end
+    its(:content) { should include %(require "go_gem/mkmf") }
+    its(:content) { should include %(create_go_makefile("#{gem_name}/#{gem_name}")) }
+    its(:content) { should_not include %(create_makefile("#{gem_name}/#{gem_name}")) }
+  end
 
+  describe file(File.join(gem_name, "#{gem_name}.gemspec")) do
     it { should be_file }
     it { should exist }
 
-    its(:content) { should include content1 }
-    its(:content) { should include content2 }
+    its(:content) { should include %(spec.add_dependency "go_gem") }
   end
 end

gem/lib/go_gem/mkmf.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module GoGem
+  # Helper module for creating Go Makefiles
+  module Mkmf
+    # Create Makefile for go-gem
+    #
+    # @param target [String]
+    # @param srcprefix [String,nil]
+    #
+    # @example
+    #   require "mkmf"
+    #   require "go_gem/mkmf" # Append this
+    #
+    #   # Use create_go_makefile instead of create_makefile
+    #   # create_makefile("example/example")
+    #   create_go_makefile("example/example")
+    def create_go_makefile(target, srcprefix = nil)
+      find_executable("go")
+
+      # rubocop:disable Style/GlobalVars
+      $objs = []
+      def $objs.empty?; false; end
+      # rubocop:enable Style/GlobalVars
+
+      create_makefile(target, srcprefix)
+
+      case `#{CONFIG["CC"]} --version` # rubocop:disable Lint/LiteralAsCondition
+      when /Free Software Foundation/
+        ldflags = "-Wl,--unresolved-symbols=ignore-all"
+      when /clang/
+        ldflags = "-undefined dynamic_lookup"
+      end
+
+      current_dir = File.expand_path(".")
+
+      File.open("Makefile", "a") do |f|
+        f.write <<~MAKEFILE.gsub(/^ {8}/, "\t")
+          $(DLLIB): Makefile $(srcdir)/*.go
+                  cd $(srcdir); \
+                  CGO_CFLAGS='$(INCFLAGS)' CGO_LDFLAGS='#{ldflags}' \
+                    go build -p 4 -buildmode=c-shared -o #{current_dir}/$(DLLIB)
+        MAKEFILE
+      end
+    end
+  end
+end
+
+include GoGem::Mkmf # rubocop:disable Style/MixinUsage

gem/spec/go_gem/mkmf_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+RSpec.describe GoGem::Mkmf do
+  describe "#create_go_makefile" do
+    gem_name = "new_gem"
+
+    before(:all) do
+      @temp_dir = Dir.mktmpdir
+
+      Dir.chdir(@temp_dir) do
+        create_go_makefile("#{gem_name}/#{gem_name}")
+      end
+    end
+
+    after(:all) do
+      FileUtils.remove_entry_secure(@temp_dir) if @temp_dir && Dir.exist?(@temp_dir)
+    end
+
+    around do |example|
+      Dir.chdir(@temp_dir) do
+        example.run
+      end
+    end
+
+    describe file("Makefile") do
+      it { should be_file }
+      it { should exist }
+
+      # content of create_makefile
+      its(:content) { should match(%r{^SHELL = /bin/sh$}) }
+
+      # content of create_go_makefile
+      its(:content) { should match(%r{^\$\(DLLIB\): Makefile \$\(srcdir\)/\*\.go$}) }
+    end
+  end
+end

gem/spec/go_gem_spec.rb

@@ -1,6 +1,13 @@
 # frozen_string_literal: true
 
 require "go_gem"
+require "go_gem/mkmf"
+
+require "tmpdir"
+require "serverspec"
+require "mkmf"
+
+set :backend, :exec
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
@@ -12,4 +19,10 @@
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end
+
+  config.filter_run_when_matching :focus
+
+  config.define_derived_metadata do |meta|
+    meta[:aggregate_failures] = true
+  end
 end

gem/spec/spec_helper.rb

@@ -3,38 +3,14 @@
 require "mkmf"
 
 ############ Appended for go native extension
-find_executable("go")
-
-# rubocop:disable Style/GlobalVars
-$objs = []
-def $objs.empty?; false; end
-# rubocop:enable Style/GlobalVars
-
+require "go_gem/mkmf"
 ############ Appended for go native extension
 
 # Makes all symbols private by default to avoid unintended conflict
 # with other gems. To explicitly export symbols you can use RUBY_FUNC_EXPORTED
 # selectively, or entirely remove this flag.
 append_cflags("-fvisibility=hidden")
 
-create_makefile("example/example")
-
 ############ Appended for go native extension
-case `#{CONFIG["CC"]} --version` # rubocop:disable Lint/LiteralAsCondition
-when /Free Software Foundation/
-  ldflags = "-Wl,--unresolved-symbols=ignore-all"
-when /clang/
-  ldflags = "-undefined dynamic_lookup"
-end
-
-current_dir = File.expand_path(".")
-
-File.open("Makefile", "a") do |f|
-  f.write <<~MAKEFILE.gsub(/^ {8}/, "\t")
-    $(DLLIB): Makefile $(srcdir)/*.go
-            cd $(srcdir); \
-            CGO_CFLAGS='$(INCFLAGS)' CGO_LDFLAGS='#{ldflags}' \
-              go build -p 4 -buildmode=c-shared -o #{current_dir}/$(DLLIB)
-  MAKEFILE
-end
+create_go_makefile("example/example")
 ############ Appended for go native extension