rake-compiler 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 168f62a83a0e87ed5dd8ddc21151082d826a18af8baa3319be221704fd559e1b
-  data.tar.gz: 62247a212ea5dce5803ef33d4490d3a6a982e5bf78716a5da0339e1c980b467a
+  metadata.gz: 530d28062d0a6bc7601e7aec15adba736048594ad4e0026dff17594f4462a2ca
+  data.tar.gz: 94dea28437dd1dedaef5a48f7eb13672102bc11d43a371e755d593126cac20b7
 SHA512:
-  metadata.gz: 5857be6b32518649261bb405df56b6986083e019f38621801323aea374544a9771c30bca2f7cc539c7fc8cd4f0cc44b8861f93bab4877ff4bfc45aecbb6e5d44
-  data.tar.gz: 61c4b8db10ff10e4b8ec45a7688241689981bc3c70f2a2b7eb2eebf877e9ca623844f70e70858daf899812a7ef8deb7c13c77b9fc0570d3bdcff7d367b445e07
+  metadata.gz: 8c4066120b1718f19299eacfee717a8efd7ca381078124e38107b372f3925791b9016aa6048bd773c6aebf6875e94937cb5eff38365e759c665102e6f55e8b1f
+  data.tar.gz: 804376554f6efa4c5b4e62b28b2d18cbffb0273c0de6e0bbc3fb7674dc4669a1bab83e121c3dd2bb1f5c1a1cffc89b5977ca96410c7599b589affbe075c0abd9

data/History.md

@@ -1,3 +1,17 @@
+### 1.2.1 / 2022-12-16
+
+* Enhancements:
+  * GH-209: Added support for RubyGems 3.3.21 or later.
+    [Patch by Mike Dalessio]
+
+* Fixes:
+  * GH-208: Fixed a typo in documentation.
+    [Patch by Garen Torikian]
+
+* Thanks:
+  * Garen Torikian
+  * Mike Dalessio
+
 ### 1.2.0 / 2022-04-15
 
 * Enhancements:

data/README.md

@@ -241,7 +241,7 @@ several settings for `Rake::ExtensionTask`:
 | no_native            | ExtensionTask (CRuby) | [Optional] Set to true to prevent non-CRuby platforms from defining native tasks. Default: `false`. |
 | config_includes      | ExtensionTask (CRuby) | [Optional] Specify an Array of paths to include as `-I...:...` includes during compilation. Default: `['.']`. |
 | classpath            | JavaExtensionTask     | [Optional] Specify additional classpath paths as an Array. Default: _Uses the current CLASSPATH._  |
-| debug                | JavaExtensionTask     | [Optional] Whether to set the debug flag during complication. Default: `false`. |
+| debug                | JavaExtensionTask     | [Optional] Whether to set the debug flag during compilation. Default: `false`. |
 | source_version       | JavaExtensionTask     | [Optional] The JRE version that your source code requires to compile. Default: `1.6`. |
 | target_version       | JavaExtensionTask     | [Optional] The oldest JRE version you want to support. Default: `1.6`. |
 | encoding             | JavaExtensionTask     | [Optional] Specify an -encoding option to provide to the compiler. Default: `nil`. |

data/lib/rake/baseextensiontask.rb

@@ -5,6 +5,8 @@ require 'rbconfig'
 
 require 'pathname'
 
+require_relative "compiler_config"
+
 module Rake
   class BaseExtensionTask < TaskLib
 

data/lib/rake/compiler_config.rb

@@ -0,0 +1,38 @@
+module Rake
+  class CompilerConfig
+    def initialize(config_path)
+      require "yaml"
+      @config = YAML.load_file(config_path)
+    end
+
+    def find(ruby_version, gem_platform)
+      gem_platform = Gem::Platform.new(gem_platform)
+
+      @config.each do |config_name, config_location|
+        # There are two variations we might find in the rake-compiler config.yml
+        #
+        # 1. config_name: rbconfig-x86_64-linux-3.0.0
+        #    runtime_platform_name: x86_64-linux
+        #    runtime_version: 3.0.0
+        #
+        # 2. config_name: rbconfig-x86_64-linux-gnu-3.0.0
+        #    runtime_platform_name: x86_64-linux-gnu
+        #    runtime_version: 3.0.0
+        #
+        # With rubygems < 3.3.21, both variations will be present (two entries pointing at the same
+        # installation).
+        #
+        # With rubygems >= 3.3.21, only the second variation will be present.
+        runtime_platform_name = config_name.split("-")[1..-2].join("-")
+        runtime_version = config_name.split("-").last
+        runtime_platform = Gem::Platform.new(runtime_platform_name)
+
+        if (ruby_version == runtime_version) && (gem_platform =~ runtime_platform)
+          return config_location
+        end
+      end
+
+      nil
+    end
+  end
+end

data/lib/rake/extensiontask.rb

@@ -393,8 +393,11 @@ Java extension should be preferred.
         return
       end
 
-      require "yaml"
-      config_file = YAML.load_file(config_path)
+      rbconfig_file = Rake::CompilerConfig.new(config_path).find(ruby_ver, for_platform)
+      unless rbconfig_file
+        warn "no configuration section for specified version of Ruby (rbconfig-#{for_platform}-#{ruby_ver})"
+        return
+      end
 
       # tmp_path
       tmp_path = "#{@tmp_dir}/#{for_platform}/#{@name}/#{ruby_ver}"
@@ -405,11 +408,6 @@ Java extension should be preferred.
       # lib_binary_path
       lib_binary_path = "#{lib_path}/#{File.basename(binary(for_platform))}"
 
-      unless rbconfig_file = config_file["rbconfig-#{for_platform}-#{ruby_ver}"] then
-        warn "no configuration section for specified version of Ruby (rbconfig-#{for_platform}-#{ruby_ver})"
-        return
-      end
-
       # mkmf
       mkmf_file = File.expand_path(File.join(File.dirname(rbconfig_file), '..', 'mkmf.rb'))
 

data/spec/lib/rake/compiler_config_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+require 'rake/extensiontask'
+require 'rbconfig'
+require 'tempfile'
+
+describe Rake::CompilerConfig do
+  def config_file(contents)
+    Tempfile.new.tap do |tf|
+      tf.write(contents)
+      tf.close
+    end
+  end
+
+  it "returns the matching config for exact platform match" do
+    cc = Rake::CompilerConfig.new(config_file(<<~CONFIG))
+      ---
+      rbconfig-x86_64-linux-3.0.0: "/path/to/aaa/rbconfig.rb"
+      rbconfig-x86_64-darwin-3.1.0: "/path/to/bbb/rbconfig.rb"
+      rbconfig-x86_64-linux-3.1.0: "/path/to/ccc/rbconfig.rb"
+    CONFIG
+
+    expect(cc.find("3.0.0", "x86_64-linux")).to eq("/path/to/aaa/rbconfig.rb")
+    expect(cc.find("3.1.0", "x86_64-darwin")).to eq("/path/to/bbb/rbconfig.rb")
+    expect(cc.find("3.1.0", "x86_64-linux")).to eq("/path/to/ccc/rbconfig.rb")
+
+    expect(cc.find("2.7.0", "x86_64-linux")).to be_nil
+    expect(cc.find("3.1.0", "arm64-linux")).to be_nil
+  end
+
+  it "returns the matching config for inexact platform match" do
+    cc = Rake::CompilerConfig.new(config_file(<<~CONFIG))
+      ---
+      rbconfig-x86_64-linux-gnu-3.0.0: "/path/to/aaa/rbconfig.rb"
+      rbconfig-x86_64-linux-musl-3.1.0: "/path/to/bbb/rbconfig.rb"
+    CONFIG
+
+    expect(cc.find("3.0.0", "x86_64-linux")).to eq("/path/to/aaa/rbconfig.rb")
+    expect(cc.find("3.1.0", "x86_64-linux")).to eq("/path/to/bbb/rbconfig.rb")
+  end
+
+  it "does not match the other way around" do
+    if Gem::Version.new(Gem::VERSION) < Gem::Version.new("3.3.21")
+      skip "rubygems 3.3.21+ only"
+    end
+
+    cc = Rake::CompilerConfig.new(config_file(<<~CONFIG))
+      ---
+      rbconfig-x86_64-linux-3.1.0: "/path/to/bbb/rbconfig.rb"
+    CONFIG
+
+    expect(cc.find("3.1.0", "x86_64-linux-musl")).to be_nil
+  end
+end

data/spec/lib/rake/extensiontask_spec.rb

@@ -381,9 +381,10 @@ describe Rake::ExtensionTask do
       end
 
       it 'should warn if no section of config file defines running version of ruby' do
-        config = Hash.new
-        expect(config).to receive(:[]).with("rbconfig-#{@platform}-#{@ruby_ver}").and_return(nil)
-        allow(YAML).to receive(:load_file).and_return(config)
+        allow_any_instance_of(Rake::CompilerConfig).to(
+          receive(:find).with(@ruby_ver, @platform).and_return(nil)
+        )
+
         out, err = capture_output do
           Rake::ExtensionTask.new('extension_one') do |ext|
             ext.cross_compile = true
@@ -403,9 +404,9 @@ describe Rake::ExtensionTask do
       end
 
       it 'should generate additional rake tasks if files are added when cross compiling' do
-        config = Hash.new
-        allow(config).to receive(:[]).and_return('/rubies/1.9.1/rbconfig.rb')
-        allow(YAML).to receive(:load_file).and_return(config)
+        allow_any_instance_of(Rake::CompilerConfig).to(
+          receive(:find).and_return("/rubies/1.9.1/rbconfig.rb")
+        )
 
         # Use a real spec instead of a mock because define_native_tasks dups and
         # calls methods on Gem::Specification, which is more than mock can do.
@@ -433,9 +434,11 @@ describe Rake::ExtensionTask do
       end
 
       it 'should allow usage of RUBY_CC_VERSION to indicate a different version of ruby' do
-        config = Hash.new
-        expect(config).to receive(:[]).with("rbconfig-i386-mingw32-1.9.1").and_return('/rubies/1.9.1/rbconfig.rb')
-        allow(YAML).to receive(:load_file).and_return(config)
+        allow_any_instance_of(Rake::CompilerConfig).to(
+          receive(:find)
+            .with("1.9.1", "i386-mingw32")
+            .and_return("/rubies/1.9.1/rbconfig.rb")
+        )
 
         ENV['RUBY_CC_VERSION'] = '1.9.1'
         Rake::ExtensionTask.new('extension_one') do |ext|
@@ -444,10 +447,16 @@ describe Rake::ExtensionTask do
       end
 
       it 'should allow multiple versions be supplied to RUBY_CC_VERSION' do
-        config = Hash.new
-        expect(config).to receive(:[]).once.with("rbconfig-i386-mingw32-1.8.6").and_return('/rubies/1.8.6/rbconfig.rb')
-        expect(config).to receive(:[]).once.with("rbconfig-i386-mingw32-1.9.1").and_return('/rubies/1.9.1/rbconfig.rb')
-        allow(YAML).to receive(:load_file).and_return(config)
+        allow_any_instance_of(Rake::CompilerConfig).to(
+          receive(:find)
+            .with("1.8.6", "i386-mingw32")
+            .and_return("/rubies/1.8.6/rbconfig.rb")
+        )
+        allow_any_instance_of(Rake::CompilerConfig).to(
+          receive(:find)
+            .with("1.9.1", "i386-mingw32")
+            .and_return("/rubies/1.9.1/rbconfig.rb")
+        )
 
         ENV['RUBY_CC_VERSION'] = '1.8.6:1.9.1'
         Rake::ExtensionTask.new('extension_one') do |ext|
@@ -459,18 +468,19 @@ describe Rake::ExtensionTask do
         platforms = ["x86-mingw32", "x64-mingw32"]
         ruby_cc_versions = ["1.8.6", "2.1.10", "2.2.6", "2.3.3", "2.10.1", "2.11.0"]
         ENV["RUBY_CC_VERSION"] = ruby_cc_versions.join(":")
-        config = Hash.new
+
         ruby_cc_versions.each do |ruby_cc_version|
           platforms.each do |platform|
             unless platform == "x64-mingw32" && ruby_cc_version == "2.11.0"
               rbconf = "/rubies/#{ruby_cc_version}/rbconfig.rb"
             end
-            allow(config).to receive(:[]).
-              with("rbconfig-#{platform}-#{ruby_cc_version}").
-              and_return(rbconf)
+            allow_any_instance_of(Rake::CompilerConfig).to(
+              receive(:find)
+                .with(ruby_cc_version, platform)
+                .and_return(rbconf)
+            )
           end
         end
-        allow(YAML).to receive(:load_file).and_return(config)
 
         allow(Gem).to receive_message_chain(:configuration, :verbose=).and_return(true)
 
@@ -515,9 +525,16 @@ describe Rake::ExtensionTask do
 
       context "(cross compile for multiple versions)" do
         before :each do
-          config = Hash.new
-          allow(config).to receive(:[]).and_return('/rubies/1.8.6/rbconfig.rb', '/rubies/1.9.1/rbconfig.rb')
-          allow(YAML).to receive(:load_file).and_return(config)
+          allow_any_instance_of(Rake::CompilerConfig).to(
+            receive(:find)
+              .with("1.8.6", "universal-unknown")
+              .and_return("/rubies/1.8.6/rbconfig.rb")
+          )
+          allow_any_instance_of(Rake::CompilerConfig).to(
+            receive(:find)
+              .with("1.9.1", "universal-unknown")
+              .and_return("/rubies/1.9.1/rbconfig.rb")
+          )
 
           ENV['RUBY_CC_VERSION'] = '1.8.6:1.9.1'
           @ext = Rake::ExtensionTask.new('extension_one') do |ext|

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rake-compiler
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Kouhei Sutou
 - Luis Lavena
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-15 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -108,9 +108,11 @@ files:
 - features/support/generator_helpers.rb
 - features/support/platform_extension_helpers.rb
 - lib/rake/baseextensiontask.rb
+- lib/rake/compiler_config.rb
 - lib/rake/extensioncompiler.rb
 - lib/rake/extensiontask.rb
 - lib/rake/javaextensiontask.rb
+- spec/lib/rake/compiler_config_spec.rb
 - spec/lib/rake/extensiontask_spec.rb
 - spec/lib/rake/javaextensiontask_spec.rb
 - spec/spec.opts
@@ -126,7 +128,7 @@ homepage: https://github.com/rake-compiler/rake-compiler
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -146,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.8.23
 requirements: []
 rubygems_version: 3.4.0.dev
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Rake-based Ruby Extension (C, Java) task generator.
 test_files: []