go_gem 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de781c3ea978d43846ab114c957f973d1273a385b4a2cda8b4ab8bcae31e7b61
-  data.tar.gz: ff9e4ec5ee199bcc5aeabeec13426caa2db9cf2d593bb5fdca44f164daed6f2f
+  metadata.gz: 372d05e6534c3254be71447f646e7d290dd78613048742d2c914143e82d2fad6
+  data.tar.gz: aa14dcda3d97d4dc243d40c650b32779c32f4f0a396b76ce434b848b28162855
 SHA512:
-  metadata.gz: 55fe501bd31919fe173a8ed9dbb7998a51da0098679e15f3d1ad2da120c62b78d80dc91139feb9056f949d08e49ed0bcd5ef1e217dd6d7e52297baa9039b9871
-  data.tar.gz: 82d8f84fb59e73fd7e555446fc02121e516fb5a376478a2484174bff7f2e3cdb60e7d5f461432783126fef30130c7b7e6e9081cbe6460957e87de0b1bf8b8cdd
+  metadata.gz: 3099662a439bff9fdfa46e72fbf7f80fccb8d057a9374fdc1481eeb62fa825b55c8342569f51d150c634e2004e93be7683fc066ec308accda474ae777e3efd6d
+  data.tar.gz: 2110ac170d7e3f63186fa8d90f4049132860b4a0038c66e0a54ebf2f828ce529cbd687ee3350d846b824f6e4627cbf23ac709241a3aafd65969dcb372ec5afdb

data/README.md

@@ -15,7 +15,7 @@ See below for details.
 [/_tools/patch_for_go_gem/](/_tools/patch_for_go_gem/)
 
 ## Usage
-### `create_go_makefile`
+### [`create_go_makefile`](https://ruby-go-gem.github.io/go-gem-wrapper/GoGem/Mkmf.html#create_go_makefile-instance_method)
 `create_go_makefile` is an extension of `create_makefile`.
 
 Add a task and hacks to build Go against the `Makefile` generated by `create_makefile`.
@@ -31,9 +31,12 @@ require "go_gem/mkmf" # Append this
 # Use create_go_makefile instead of create_makefile
 # create_makefile("example/example")
 create_go_makefile("example/example")
+
+# Pass debug flags to `go build`
+create_go_makefile("example/example", go_build_args: "-gcflags='all=-N -l'")
 ```
 
-### `GoGem::RakeTask`
+### [`GoGem::RakeTask`](https://ruby-go-gem.github.io/go-gem-wrapper/GoGem/RakeTask.html)
 Provides rake tasks for `go test` with CRuby
 
 #### Example (Without config)
@@ -85,7 +88,9 @@ namespace :go do
       sh "which golangci-lint" do |ok, _|
         raise "golangci-lint isn't installed. See. https://golangci-lint.run/welcome/install/" unless ok
       end
-      sh GoGem::RakeTask.build_env_vars, "golangci-lint run"
+
+      build_tag = GoGem::Util.ruby_minor_version_build_tag
+      sh GoGem::RakeTask.build_env_vars, "golangci-lint run --build-tags #{build_tag} --modules-download-mode=readonly"
     end
   end
 end
@@ -101,12 +106,19 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-go@v5
       - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
 
       - name: export CGO_CFLAGS for golangci-lint
         run: bundle exec rake go:build_envs[CGO_CFLAGS] >> $GITHUB_ENV
 
+      - name: export BUILD_TAG for golangci-lint
+        run: echo "BUILD_TAG=$(bundle exec rake go:build_tag)" >> $GITHUB_ENV
+
       - name: Run golangci-lint
         uses: golangci/golangci-lint-action@v6
+        with:
+          args: --build-tags ${{ env.BUILD_TAG }} --modules-download-mode=readonly
 ```
 
 #### Available configurations

data/lib/go_gem/mkmf.rb

@@ -9,6 +9,7 @@ module GoGem
     #
     # @param target [String]
     # @param srcprefix [String,nil]
+    # @param go_build_args [String,nil] Arguments passed to `go build`
     #
     # @example
     #   require "mkmf"
@@ -17,7 +18,10 @@ module GoGem
     #   # Use create_go_makefile instead of create_makefile
     #   # create_makefile("example/example")
     #   create_go_makefile("example/example")
-    def create_go_makefile(target, srcprefix = nil)
+    #
+    # @example Pass debug flags to `go build`
+    #   create_go_makefile("example/example", go_build_args: "-gcflags='all=-N -l'")
+    def create_go_makefile(target, srcprefix: nil, go_build_args: nil)
       find_executable("go")
 
       # rubocop:disable Style/GlobalVars
@@ -28,13 +32,7 @@ module GoGem
 
       create_makefile(target, srcprefix)
 
-      case `#{RbConfig::CONFIG["CC"]} --version` # rubocop:disable Lint/LiteralAsCondition
-      when /Free Software Foundation/
-        ldflags = "-Wl,--unresolved-symbols=ignore-all"
-      when /clang/
-        ldflags = "-undefined dynamic_lookup"
-      end
-
+      ldflags = GoGem::Util.generate_ldflags
       current_dir = File.expand_path(".")
 
       goflags = "-tags=#{GoGem::Util.ruby_minor_version_build_tag}"
@@ -44,7 +42,7 @@ module GoGem
           $(DLLIB): Makefile $(srcdir)/*.go
                   cd $(srcdir); \
                   CGO_CFLAGS='$(INCFLAGS)' CGO_LDFLAGS='#{ldflags}' GOFLAGS='#{goflags}' \
-                    go build -p 4 -buildmode=c-shared -o #{current_dir}/$(DLLIB)
+                    go build -p 4 -buildmode=c-shared -o #{current_dir}/$(DLLIB) #{go_build_args}
         MAKEFILE
       end
     end

data/lib/go_gem/rake_task.rb

@@ -6,6 +6,8 @@ require "rake/tasklib"
 require_relative "util"
 
 module GoGem
+  # rubocop:disable Layout/LineLength
+
   # Provides rake tasks for `go test` with CRuby
   #
   # @example Without config
@@ -38,11 +40,15 @@ module GoGem
   #         sh "which golangci-lint" do |ok, _|
   #           raise "golangci-lint isn't installed. See. https://golangci-lint.run/welcome/install/" unless ok
   #         end
-  #         sh GoGem::RakeTask.build_env_vars, "golangci-lint run"
+  #
+  #         build_tag = GoGem::Util.ruby_minor_version_build_tag
+  #         sh GoGem::RakeTask.build_env_vars, "golangci-lint run --build-tags #{build_tag} --modules-download-mode=readonly"
   #       end
   #     end
   #   end
-  class RakeTask < ::Rake::TaskLib # rubocop:disable Metrics/ClassLength
+  class RakeTask < ::Rake::TaskLib
+    # rubocop:enable Layout/LineLength
+
     DEFAULT_TASK_NAMESPACE = :go
 
     DEFAULT_GO_BIN_PATH = "go"
@@ -97,61 +103,21 @@ module GoGem
     #
     # @return [Hash<String, String>]
     def self.build_env_vars
-      ldflags = generate_ldflags
-      cflags = generate_cflags
-
-      # FIXME: Workaround for Ubuntu (GitHub Actions)
-      if RUBY_PLATFORM =~ /linux/i
-        cflags.gsub!("-Wno-self-assign", "")
-        cflags.gsub!("-Wno-parentheses-equality", "")
-        cflags.gsub!("-Wno-constant-logical-operand", "")
-        cflags.gsub!("-Wsuggest-attribute=format", "")
-        cflags.gsub!("-Wold-style-definition", "")
-        cflags.gsub!("-Wsuggest-attribute=noreturn", "")
-        ldflags.gsub!("-Wl,--unresolved-symbols=ignore-all", "")
-      end
+      ldflags = GoGem::Util.generate_ldflags
+      cflags = GoGem::Util.generate_cflags
 
       ld_library_path = RbConfig::CONFIG["libdir"].to_s
 
       {
-        "GOFLAGS"         => generate_goflags,
+        "GOFLAGS"         => GoGem::Util.generate_goflags,
         "CGO_CFLAGS"      => cflags,
         "CGO_LDFLAGS"     => ldflags,
         "LD_LIBRARY_PATH" => ld_library_path,
       }
     end
 
-    # @return [String]
-    def self.generate_goflags
-      "-tags=#{GoGem::Util.ruby_minor_version_build_tag}"
-    end
-    private_class_method :generate_goflags
-
-    # @return [String]
-    def self.generate_ldflags
-      ldflags = "-L#{RbConfig::CONFIG["libdir"]} -l#{RbConfig::CONFIG["RUBY_SO_NAME"]}"
-
-      case `#{RbConfig::CONFIG["CC"]} --version` # rubocop:disable Lint/LiteralAsCondition
-      when /Free Software Foundation/
-        ldflags << " -Wl,--unresolved-symbols=ignore-all"
-      when /clang/
-        ldflags << " -undefined dynamic_lookup"
-      end
-
-      ldflags
-    end
-    private_class_method :generate_ldflags
-
-    # @return [String]
-    def self.generate_cflags
-      [
-        RbConfig::CONFIG["CFLAGS"],
-        "-I#{RbConfig::CONFIG["rubyarchhdrdir"]}",
-        "-I#{RbConfig::CONFIG["rubyhdrdir"]}",
-      ].join(" ")
-    end
-    private_class_method :generate_cflags
-
+    # Change current working dir inside `ext/<GEM_NAME>/`
+    #
     # @yield
     def within_target_dir
       Dir.chdir(target_dir) do # rubocop:disable Style/ExplicitBlockArgument
@@ -159,7 +125,7 @@ module GoGem
       end
     end
 
-    # @return [String]
+    # @return [String] ext dir name (e.g.`ext/<GEM_NAME>/`)
     def ext_dir
       File.join("ext", gem_name)
     end

data/lib/go_gem/util.rb

@@ -14,5 +14,52 @@ module GoGem
     def self.ruby_minor_version_build_tag(ruby_version = RUBY_VERSION)
       "ruby_#{ruby_version.to_f.to_s.gsub(".", "_")}"
     end
+
+    # @return [String]
+    def self.generate_ldflags
+      ldflags = "-L#{RbConfig::CONFIG["libdir"]} -l#{RbConfig::CONFIG["RUBY_SO_NAME"]}"
+
+      case `#{RbConfig::CONFIG["CC"]} --version` # rubocop:disable Lint/LiteralAsCondition
+      when /Free Software Foundation/
+        ldflags << " -Wl,--unresolved-symbols=ignore-all"
+      when /clang/
+        ldflags << " -undefined dynamic_lookup"
+      end
+
+      # FIXME: Workaround for Ubuntu (GitHub Actions)
+      ldflags.gsub!("-Wl,--unresolved-symbols=ignore-all", "") if RUBY_PLATFORM =~ /linux/i
+
+      ldflags.strip
+    end
+
+    # @return [String]
+    def self.generate_cflags
+      cflags =
+        [
+          RbConfig::CONFIG["CFLAGS"],
+          "-I#{RbConfig::CONFIG["rubyarchhdrdir"]}",
+          "-I#{RbConfig::CONFIG["rubyhdrdir"]}",
+        ].join(" ")
+
+      # FIXME: Workaround for Ubuntu (GitHub Actions)
+      if RUBY_PLATFORM =~ /linux/i
+        cflags.gsub!("-Wno-self-assign", "")
+        cflags.gsub!("-Wno-parentheses-equality", "")
+        cflags.gsub!("-Wno-constant-logical-operand", "")
+        cflags.gsub!("-Wsuggest-attribute=format", "")
+        cflags.gsub!("-Wold-style-definition", "")
+        cflags.gsub!("-Wsuggest-attribute=noreturn", "")
+      end
+
+      # FIXME: Workaround for Alpine
+      cflags.gsub!("-Wpointer-arith", "") if RUBY_PLATFORM =~ /linux-musl/i
+
+      cflags.strip
+    end
+
+    # @return [String]
+    def self.generate_goflags
+      "-tags=#{ruby_minor_version_build_tag}"
+    end
   end
 end

data/lib/go_gem/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GoGem
-  VERSION = "0.6.0"
+  VERSION = "0.7.1"
 end

data/sig/go_gem/mkmf.rbs

@@ -2,6 +2,6 @@ module GoGem
   module Mkmf
     $objs: Array[untyped]
 
-    def create_go_makefile: (String target, String? srcprefix) -> void
+    def create_go_makefile: (String target, ?srcprefix: String?, ?go_build_args: String?) -> void
   end
 end

data/sig/go_gem/rake_task.rbs

@@ -30,12 +30,6 @@ module GoGem
 
     def self.build_env_vars: () -> { "GOFLAGS" => String, "CGO_CFLAGS" => String, "CGO_LDFLAGS" => String, "LD_LIBRARY_PATH" => String }
 
-    def self.generate_goflags: () -> String
-
-    def self.generate_ldflags: () -> String
-
-    def self.generate_cflags: () -> String
-
     private
 
     def define_go_test_task: () -> void

data/sig/go_gem/util.rbs

@@ -1,5 +1,11 @@
 module GoGem
   module Util
     def self.ruby_minor_version_build_tag: (?String ruby_version) -> String
+
+    def self.generate_ldflags: () -> String
+
+    def self.generate_cflags: () -> String
+
+    def self.generate_goflags: () -> String
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: go_gem
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - sue445
 bindir: exe
 cert_chain: []
-date: 2025-01-06 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies: []
 description: Helpers for compiling Go extensions for ruby
 email: