go_gem 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d355c8974fe19f813bbdb3766eb1023fb79aa273fe28ef355bd124071cd2f296
-  data.tar.gz: 8ec5443591bc9b6ce2c4da3caef0472f7ebf6e29a035fae261f1510a15ff3818
+  metadata.gz: 0b0aa853597fa94b01abc00c98cd1e743dda0d48c3909a56e24912608e38f659
+  data.tar.gz: 587c9a7cd18f75e599bf73488e8a84f65dfe851a35361e5f1f029a158bbf056e
 SHA512:
-  metadata.gz: ca095b1c1093c31d67608c7e3f981bd0f89cb2424530c96a51f8c2dd9576f4341cce645bcbf95848c3e4e1a909b2077709d8ea3b8a318ca7eea7744da56f1f5e
-  data.tar.gz: eeb9f436aa97a9e2afbbee638ab777e71172ede8601e8c4621252f714bed4416e12522f01c2135706e091a923e32f4ec6ff1a9fdd528b406f304b97571970e3f
+  metadata.gz: 2164714d694ef237e8f41aa32121cef42a597ef86d251d5b47dcdae13741dd3fc1eab6c0278b8735c08e82b6bb49667145eb48785723bbc4dcb9cd219fb3d41b
+  data.tar.gz: c51924855aabdf873fcf78ba052014e89fb16e9792b9633a8699234d09dddd379e519f5f38a5efd524f9677e21f708fbdc7ec329a7de3dba66c4307af216639c

data/README.md

@@ -33,6 +33,68 @@ require "go_gem/mkmf" # Append this
 create_go_makefile("example/example")
 ```
 
+### `GoGem::RakeTask`
+Provides rake tasks for `go test` with CRuby
+
+#### Example (Without config)
+```ruby
+# Rakefile
+require "go_gem/rake_task"
+
+GoGem::RakeTask.new("gem_name")
+```
+
+Following tasks are generated
+
+* `rake go:test`
+* `rake go:testrace`
+* `rake go:fmt`
+
+#### Example (With config)
+```ruby
+# Rakefile
+require "go_gem/rake_task"
+
+GoGem::RakeTask.new("gem_name") do |t|
+  t.task_namespace = "go5"
+  t.go_bin_path = "/path/to/go"
+  t.go_test_args = "-mod=readonly"
+  t.target_dir = "/dir/to/go-mod/"
+end
+```
+
+Following tasks are generated
+
+* `rake go5:test`
+* `rake go5:testrace`
+* `rake go5:fmt`
+
+#### Example (Add additional tasks)
+```ruby
+# Rakefile
+require "go_gem/rake_task"
+
+go_task = GoGem::RakeTask.new("gem_name")
+
+namespace :go do
+  desc "Run golangci-lint"
+  task :lint do
+    go_task.within_target_dir 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"
+    end
+  end
+end
+```
+
+#### Available configurations
+* `task_namespace` : task namespace (default: `:go`)
+* `go_bin_path` : path to go binary (default: `"go"`)
+* `go_test_args` : argument passed to `go test` (default: `"-mod=readonly -count=1"`)
+* `target_dir` : directory when executing go commands. (default: `"ext/#{gem_name}"`)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/go_gem/mkmf.rb

@@ -26,7 +26,7 @@ module GoGem
 
       create_makefile(target, srcprefix)
 
-      case `#{CONFIG["CC"]} --version` # rubocop:disable Lint/LiteralAsCondition
+      case `#{RbConfig::CONFIG["CC"]} --version` # rubocop:disable Lint/LiteralAsCondition
       when /Free Software Foundation/
         ldflags = "-Wl,--unresolved-symbols=ignore-all"
       when /clang/

data/lib/go_gem/rake_task.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require "rake"
+require "rake/tasklib"
+
+module GoGem
+  # Provides rake tasks for `go test` with CRuby
+  #
+  # @example Without config
+  #   # Rakefile
+  #   require "go_gem/rake_task"
+  #
+  #   GoGem::RakeTask.new("gem_name")
+  #
+  # @example With config
+  #   # Rakefile
+  #   require "go_gem/rake_task"
+  #
+  #   GoGem::RakeTask.new("gem_name") do |t|
+  #     t.task_namespace = "go5"
+  #     t.go_bin_path = "/path/to/go"
+  #     t.go_test_args = "-mod=readonly"
+  #     t.target_dir = "/dir/to/go-mod/"
+  #   end
+  #
+  # @example additional tasks
+  #   # Rakefile
+  #   require "go_gem/rake_task"
+  #
+  #   t = GoGem::RakeTask.new("gem_name")
+  #
+  #   namespace :go do
+  #     desc "Run golangci-lint"
+  #     task :lint do
+  #       t.within_target_dir 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"
+  #       end
+  #     end
+  #   end
+  class RakeTask < ::Rake::TaskLib
+    DEFAULT_TASK_NAMESPACE = :go
+
+    DEFAULT_GO_BIN_PATH = "go"
+
+    DEFAULT_GO_TEST_ARGS = "-mod=readonly -count=1"
+
+    # @!attribute [r] gem_name
+    # @return [String]
+    attr_reader :gem_name
+
+    # @!attribute task_namespace
+    #   @return [Symbol,String] task namespace (default: `:go`)
+    attr_accessor :task_namespace
+
+    # @!attribute go_bin_path
+    #   @return [String] path to go binary (default: `"go"`)
+    attr_accessor :go_bin_path
+
+    # @!attribute go_test_args
+    #   @return [String] argument passed to `go test` (default: `"-mod=readonly -count=1"`)
+    attr_accessor :go_test_args
+
+    # @!attribute cwd
+    #   @return [String] directory when executing go commands. (default: `"ext/#{gem_name}"`)
+    attr_accessor :target_dir
+
+    # @param gem_name [String]
+    # @yield configuration of {RakeTask}
+    # @yieldparam t [RakeTask]
+    def initialize(gem_name)
+      super()
+
+      @gem_name = gem_name
+
+      @task_namespace = DEFAULT_TASK_NAMESPACE
+      @go_bin_path = DEFAULT_GO_BIN_PATH
+      @go_test_args = DEFAULT_GO_TEST_ARGS
+      @target_dir = ext_dir
+
+      yield(self) if block_given?
+
+      namespace(task_namespace) do
+        define_go_test_task
+        define_go_testrace_task
+        define_go_fmt_task
+      end
+    end
+
+    # Generate environment variables to build go programs in the Go gem
+    #
+    # @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
+
+      ld_library_path = RbConfig::CONFIG["libdir"]
+
+      {
+        "CGO_CFLAGS"      => cflags,
+        "CGO_LDFLAGS"     => ldflags,
+        "LD_LIBRARY_PATH" => ld_library_path,
+      }
+    end
+
+    # @yield
+    def within_target_dir
+      Dir.chdir(target_dir) do # rubocop:disable Style/ExplicitBlockArgument
+        yield
+      end
+    end
+
+    # @return [String]
+    def ext_dir
+      File.join("ext", gem_name)
+    end
+
+    private
+
+    def define_go_test_task
+      desc "Run #{go_bin_path} test"
+      task(:test) do
+        within_target_dir do
+          sh RakeTask.build_env_vars, "#{go_bin_path} test #{go_test_args} ./..."
+        end
+      end
+    end
+
+    def define_go_testrace_task
+      desc "Run #{go_bin_path} test -race"
+      task(:testrace) do
+        within_target_dir do
+          sh RakeTask.build_env_vars, "#{go_bin_path} test #{go_test_args} -race ./..."
+        end
+      end
+    end
+
+    def define_go_fmt_task
+      desc "Run #{go_bin_path} fmt"
+      task(:fmt) do
+        within_target_dir do
+          sh "#{go_bin_path} fmt ./..."
+        end
+      end
+    end
+  end
+end

data/lib/go_gem/version.rb

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

data/sig/go_gem/mkmf.rbs

@@ -1,5 +1,7 @@
 module GoGem
   module Mkmf
-    def create_go_makefile: (String, String? nil) -> void
+    $objs: Array[untyped]
+
+    def create_go_makefile: (String target, String? srcprefix) -> void
   end
 end

data/sig/go_gem/rake_task.rbs

@@ -0,0 +1,45 @@
+module GoGem
+  class RakeTask < ::Rake::TaskLib
+    @gem_name: String
+
+    @task_namespace: Symbol | String
+
+    @go_bin_path: String
+
+    @go_test_args: String
+
+    @target_dir: String
+
+    DEFAULT_TASK_NAMESPACE: Symbol
+
+    DEFAULT_GO_BIN_PATH: String
+
+    DEFAULT_GO_TEST_ARGS: String
+
+    attr_reader gem_name: String
+
+    attr_accessor task_namespace: Symbol | String
+
+    attr_accessor go_bin_path: String
+
+    attr_accessor go_test_args: String
+
+    attr_accessor target_dir: String
+
+    def initialize: (String gem_name) ?{ (RakeTask) -> void } -> void
+
+    def self.build_env_vars: () -> { "CGO_CFLAGS" => String, "CGO_LDFLAGS" => String, "LD_LIBRARY_PATH" => String }
+
+    private
+
+    def define_go_test_task: () -> void
+
+    def define_go_testrace_task: () -> void
+
+    def define_go_fmt_task: () -> void
+
+    def within_target_dir: () { () -> void } -> void
+
+    def ext_dir: () -> String
+  end
+end

data/sig/go_gem.rbs

@@ -1,4 +1,8 @@
 module GoGem
   VERSION: String
+
+  class Error < StandardError
+  end
+
   # See the writing guide of rbs: https://github.com/ruby/rbs#guides
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: go_gem
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - sue445
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-16 00:00:00.000000000 Z
+date: 2024-11-21 00:00:00.000000000 Z
 dependencies: []
 description: Helpers for compiling Go extensions for ruby
 email:
@@ -23,9 +23,11 @@ files:
 - Rakefile
 - lib/go_gem.rb
 - lib/go_gem/mkmf.rb
+- lib/go_gem/rake_task.rb
 - lib/go_gem/version.rb
 - sig/go_gem.rbs
 - sig/go_gem/mkmf.rbs
+- sig/go_gem/rake_task.rbs
 homepage: https://github.com/ruby-go-gem/go-gem-wrapper
 licenses:
 - MIT
@@ -50,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Helpers for compiling Go extensions for ruby