go_gem 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf04032b5fd467ed3123d922c9ad7978e577601552bf46a2fe4bde8b0b464caf
-  data.tar.gz: dd5a7b4c2742f4d3a8b19871729c89ae59ceb4035d7a573476f34a9178406b4d
+  metadata.gz: 9391de7a479373991e4d34ffc16b48c12b0b939f7738d3534d35d46d0e8f031a
+  data.tar.gz: 9de4ce2876dfd5e63c2858502ab63f268c3dda3c0da535701f4cfc739b3f1cf8
 SHA512:
-  metadata.gz: 66a47a395e84b2b241974b77da353834f8f344982b2f85ab9ec2a7c2ddb67b29242b3ecc9235f36188be82a575733b3d608b16e367adb74e03476c77d929f27c
-  data.tar.gz: 3db32329bcbba23583fca335ae00b0fa78b4dcbab64262afba18e09fd495af47e0eda7c5c16cf3abc7cdd2fca67441fbebb777003ab3c116d83541a96203c481
+  metadata.gz: c5bbf69c9727d91331d4ac4e316a3cfa9462fcd180b965789da3f7e57c1d61e2cfad60d46e2db49be1335ddf88c83c18b931afe4cf0ce42a17ad208476f6ccc6
+  data.tar.gz: c78e49338aabb2cdd1490a8f258e5e39db8c1a75bb63397f280ecad88deacc39338bdddcb134d8c619c76a997abaa216cb4d6e5921133e5305a076f9a8e0f772

data/README.md

@@ -85,7 +85,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}"
     end
   end
 end
@@ -101,12 +103,28 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-go@v5
       - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: false
+
+      # FIXME: setup-go installs cache in `vendor/` and setup-ruby installs cache in `vendor/bundle/`
+      #        If we use the cache in setup-go and setup-ruby at the same time, this doesn't work well because they use the same directory.
+      #        Therefore, the installation location needs to be changed from the setup-ruby default.
+      - name: bundle install
+        run: |
+          set -xe
+          bundle config --local path ruby-vendor/bundle
+          bundle install --jobs 4
 
       - 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 }}
 ```
 
 #### Available configurations

data/lib/go_gem/mkmf.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "util"
+
 module GoGem
   # Helper module for creating Go Makefiles
   module Mkmf
@@ -7,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"
@@ -15,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
@@ -26,21 +32,17 @@ 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}"
+
       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)
+                  CGO_CFLAGS='$(INCFLAGS)' CGO_LDFLAGS='#{ldflags}' GOFLAGS='#{goflags}' \
+                    go build -p 4 -buildmode=c-shared -o #{current_dir}/$(DLLIB) #{go_build_args}
         MAKEFILE
       end
     end

data/lib/go_gem/rake_task.rb

@@ -3,6 +3,8 @@
 require "rake"
 require "rake/tasklib"
 
+require_relative "util"
+
 module GoGem
   # Provides rake tasks for `go test` with CRuby
   #
@@ -36,7 +38,9 @@ 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}"
   #       end
   #     end
   #   end
@@ -87,6 +91,7 @@ module GoGem
         define_go_testrace_task
         define_go_fmt_task
         define_go_build_envs_task
+        define_go_build_tag_task
       end
     end
 
@@ -94,35 +99,13 @@ module GoGem
     #
     # @return [Hash<String, String>]
     def self.build_env_vars
-      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
-
-      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", "")
-        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"         => GoGem::Util.generate_goflags,
         "CGO_CFLAGS"      => cflags,
         "CGO_LDFLAGS"     => ldflags,
         "LD_LIBRARY_PATH" => ld_library_path,
@@ -183,5 +166,12 @@ module GoGem
         end
       end
     end
+
+    def define_go_build_tag_task
+      desc "Print build tag"
+      task(:build_tag) do
+        puts GoGem::Util.ruby_minor_version_build_tag
+      end
+    end
   end
 end

data/lib/go_gem/util.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module GoGem
+  # Common utility methods for {GoGem::Mkmf} and {GoGem::RakeTask}
+  module Util
+    # Return ruby version build tag for `go build` and `go test`
+    #
+    # @param ruby_version [String]
+    # @return [String]
+    #
+    # @example
+    #   GoGem::Util.ruby_minor_version_build_tag("3.4.1")
+    #   #=> "ruby_3_4"
+    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.5.1"
+  VERSION = "0.7.0"
 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

@@ -28,7 +28,7 @@ module GoGem
 
     def initialize: (String gem_name) ?{ (RakeTask) -> void } -> void
 
-    def self.build_env_vars: () -> { "CGO_CFLAGS" => String, "CGO_LDFLAGS" => String, "LD_LIBRARY_PATH" => String }
+    def self.build_env_vars: () -> { "GOFLAGS" => String, "CGO_CFLAGS" => String, "CGO_LDFLAGS" => String, "LD_LIBRARY_PATH" => String }
 
     private
 
@@ -40,6 +40,8 @@ module GoGem
 
     def define_go_build_envs_task: () -> void
 
+    def define_go_build_tag_task: () -> void
+
     def within_target_dir: () { () -> void } -> void
 
     def ext_dir: () -> String

data/sig/go_gem/util.rbs

@@ -0,0 +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,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: go_gem
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - sue445
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-15 00:00:00.000000000 Z
+date: 2025-01-24 00:00:00.000000000 Z
 dependencies: []
 description: Helpers for compiling Go extensions for ruby
 email:
@@ -24,10 +23,12 @@ files:
 - lib/go_gem.rb
 - lib/go_gem/mkmf.rb
 - lib/go_gem/rake_task.rb
+- lib/go_gem/util.rb
 - lib/go_gem/version.rb
 - sig/go_gem.rbs
 - sig/go_gem/mkmf.rbs
 - sig/go_gem/rake_task.rbs
+- sig/go_gem/util.rbs
 homepage: https://github.com/ruby-go-gem/go-gem-wrapper
 licenses:
 - MIT
@@ -37,7 +38,6 @@ metadata:
   changelog_uri: https://github.com/ruby-go-gem/go-gem-wrapper/blob/main/CHANGELOG.md
   documentation_uri: https://ruby-go-gem.github.io/go-gem-wrapper/
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -46,14 +46,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: 3.3.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Helpers for compiling Go extensions for ruby
 test_files: []