rake-compiler 1.2.2 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1307a1f8d635b6fa407ce62a9e301a9d2ccfb358fb77e3ed85c3d22492fd6a1e
-  data.tar.gz: d562c91bfee82d65d39b67b118c9b9395e33be402b2c41058d4251ae2e88a37f
+  metadata.gz: 89347c74f92c88f38e362b44957b4f3995846f9354f3462bd2774e9fab7fe2a9
+  data.tar.gz: 0e074b3563de7228bcf09036527eb2756653e519c3493926fdfeda3b64761b92
 SHA512:
-  metadata.gz: 1d1c34c803284711dff655cd8b4d7a34766d1ade90556ffeed111349777c67e143a55705bda5bce95f6629c2bc45a7e528da666f20595cb45c7e2986ee3c9269
-  data.tar.gz: dfabaa0805a27ee2150a406a2e7e26c6345ea279866e271c1936ab95b8090a0bb6fa0919a42509ae4d6652e8d249a694c4b70b7ace351335afb7cbace8fa7cf8
+  metadata.gz: 6d9d1a747ff0ad05422b8bf96de8f5be572f405a66ba8dbcb9a97fd6c4a343358f27de553ab02b9c5674ed52dd6697144dc2b176ec7da3d2eea99ae28f9fc5d4
+  data.tar.gz: 9350f3c428d92e6a9b0a08ecdd0b220043d3990ffb1fcaf33aaf4e9ffd513d0001f0bcf0e9a78964392f135dd9263d45e21b2d8dbe33e74f4582fdafd8387fa4

data/History.md

@@ -1,3 +1,31 @@
+### 1.2.4 / 2023-08-01
+
+* Enhancements:
+  * GH-221: Enabled syntax highlighting in documents.
+    [Patch by Ryo Nakamura]
+  * GH-202 GH-222: Use environment variables to set install paths.
+    [Reported by Brandon Fish]
+    [Patch by Michael Go]
+
+* Thanks:
+  * Ryo Nakamura
+  * Brandon Fish
+  * Michael Go
+
+### 1.2.3 / 2023-05-30
+
+* Enhancements:
+  * GH-217: Added support for `nil` in build options again.
+    [Patch by Mike Dalessio]
+
+* Fixes:
+  * GH-219: Fixed a typo in documentation.
+    [Patch by y-yagi]
+
+* Thanks:
+  * Mike Dalessio
+  * y-yagi
+
 ### 1.2.2 / 2023-05-25
 
 * Enhancements:
@@ -9,7 +37,7 @@
     [Reported by Jun Aruga]
 
 * Fixes:
-  * GH-211: Fixed a typo in documentation.
+  * GH-212: Fixed a typo in documentation.
     [Patch by Jan-Benedikt Jagusch]
 
 * Thanks:

data/README.md

@@ -69,17 +69,19 @@ contribute back to your project.
 Now the fun part. It's time to introduce the code to your projects Rakefile
 to tell it to use rake-compiler to build your extension:
 
-    # File: extconf.rb
+```ruby
+# File: extconf.rb
 
-    # these lines must exist already
-    require 'mkmf'
-    create_makefile('hello_world')
+# these lines must exist already
+require 'mkmf'
+create_makefile('hello_world')
 
-    # File: Rakefile
+# File: Rakefile
 
-    require 'rake/extensiontask'
+require 'rake/extensiontask'
 
-    Rake::ExtensionTask.new('hello_world')
+Rake::ExtensionTask.new('hello_world')
+```
 
 That's it? Yes, that's it! No other lines of code are needed for
 rake-compiler to work its magic.
@@ -93,11 +95,13 @@ below for details.
 If you want to do the same for a JRuby extension written in Java, it's just
 as easy:
 
-    # File: Rakefile
+```ruby
+# File: Rakefile
 
-    require 'rake/javaextensiontask'
+require 'rake/javaextensiontask'
 
-    Rake::JavaExtensionTask.new('hello_world')
+Rake::JavaExtensionTask.new('hello_world')
+```
 
 ### The simple process
 
@@ -140,19 +144,21 @@ building native gems on Windows systems.
 Creating native gems is really easy with rake-compiler's
 `Rake::ExtensionTask`:
 
-    # somewhere in your Rakefile, define your gem spec
-    spec = Gem::Specification.new do |s|
-      s.name = "my_gem"
-      s.platform = Gem::Platform::RUBY
-      s.extensions = FileList["ext/**/extconf.rb"]
-    end
+```ruby
+# somewhere in your Rakefile, define your gem spec
+spec = Gem::Specification.new do |s|
+  s.name = "my_gem"
+  s.platform = Gem::Platform::RUBY
+  s.extensions = FileList["ext/**/extconf.rb"]
+end
 
-    # add your default gem packing task
-    Gem::PackageTask.new(spec) do |pkg|
-    end
+# add your default gem packing task
+Gem::PackageTask.new(spec) do |pkg|
+end
 
-    # feed the ExtensionTask with your spec
-    Rake::ExtensionTask.new('hello_world', spec)
+# feed the ExtensionTask with your spec
+Rake::ExtensionTask.new('hello_world', spec)
+```
 
 As expected, you can still build your pure-ruby gem in the usual way
 (standard output) by running:
@@ -209,18 +215,19 @@ Yes you can! While the conventional project structure is recommended, you may
 want, or need, to tweak those conventions. Rake-compiler allows you to customize
 several settings for `Rake::ExtensionTask`:
 
-    Rake::ExtensionTask.new do |ext|
-      ext.name = 'hello_world'                # indicate the name of the extension.
-      ext.ext_dir = 'ext/weird_world'         # search for 'hello_world' inside it.
-      ext.lib_dir = 'lib/my_lib'              # put binaries into this folder.
-      ext.config_script = 'custom_extconf.rb' # use instead of the default 'extconf.rb'.
-      ext.tmp_dir = 'tmp'                     # temporary folder used during compilation.
-      ext.source_pattern = "*.{c,cpp}"        # monitor file changes to allow simple rebuild.
-      ext.config_options << '--with-foo'      # supply additional options to configure script.
-      ext.gem_spec = spec                     # optionally indicate which gem specification
-                                              # will be used.
-    end
-
+```ruby
+Rake::ExtensionTask.new do |ext|
+  ext.name = 'hello_world'                # indicate the name of the extension.
+  ext.ext_dir = 'ext/weird_world'         # search for 'hello_world' inside it.
+  ext.lib_dir = 'lib/my_lib'              # put binaries into this folder.
+  ext.config_script = 'custom_extconf.rb' # use instead of the default 'extconf.rb'.
+  ext.tmp_dir = 'tmp'                     # temporary folder used during compilation.
+  ext.source_pattern = "*.{c,cpp}"        # monitor file changes to allow simple rebuild.
+  ext.config_options << '--with-foo'      # supply additional options to configure script.
+  ext.gem_spec = spec                     # optionally indicate which gem specification
+                                          # will be used.
+end
+```
 
 ### Show me all of the supported configuration options
 
@@ -338,30 +345,32 @@ reporting any issues.
 
 Now, you only need specify a few additional options in your extension definition:
 
-    Rake::ExtensionTask.new('my_extension', gem_spec) do |ext|
-      # enable cross compilation (requires cross compile toolchain)
-      ext.cross_compile = true
-
-      # set a single platform or an array of platforms to target
-      ext.cross_platform = ['x86-mingw32', 'x64-mingw32']
-
-      # cross-compile options will be passed to extconf.rb for each
-      # platform build, with platform-specific options in a hash.
-      ext.cross_config_options << '--with-common-option'
-      ext.cross_config_options << {
-        'x86-mswin32-60' => '--with-some-option',
-        'x64-mingw32'   => '--enable-64bits',
-      }
-      ext.cross_config_options << '--with-final-option'
-
-      # perform alterations on the gemspec when cross compiling
-      ext.cross_compiling do |gem_spec|
-        # such as packaging a file that isn't specified in the gemspec
-        gem_spec.files << 'lib/generated_file.rb'
-        # or adding a new installation message
-        gem_spec.post_install_message = "You installed the binary version of this gem!"
-      end
-    end
+```ruby
+Rake::ExtensionTask.new('my_extension', gem_spec) do |ext|
+  # enable cross compilation (requires cross compile toolchain)
+  ext.cross_compile = true
+
+  # set a single platform or an array of platforms to target
+  ext.cross_platform = ['x86-mingw32', 'x64-mingw32']
+
+  # cross-compile options will be passed to extconf.rb for each
+  # platform build, with platform-specific options in a hash.
+  ext.cross_config_options << '--with-common-option'
+  ext.cross_config_options << {
+    'x86-mswin32-60' => '--with-some-option',
+    'x64-mingw32'   => '--enable-64bits',
+  }
+  ext.cross_config_options << '--with-final-option'
+
+  # perform alterations on the gemspec when cross compiling
+  ext.cross_compiling do |gem_spec|
+    # such as packaging a file that isn't specified in the gemspec
+    gem_spec.files << 'lib/generated_file.rb'
+    # or adding a new installation message
+    gem_spec.post_install_message = "You installed the binary version of this gem!"
+  end
+end
+```
 
 By default, cross compilation targets 'i386-mingw32' which is the default
 GCC platform for Ruby. MRI Ruby's current official distribution uses
@@ -419,12 +428,14 @@ cross compiling from a Linux or OSX host. Patches are welcome if building
 
 Now it's up to you to make your gem load the proper binary at runtime:
 
-    begin
-      RUBY_VERSION =~ /(\d+\.\d+)/
-      require "#{$1}/my_extension"
-    rescue LoadError
-      require "my_extension"
-    end
+```ruby
+begin
+  RUBY_VERSION =~ /(\d+\.\d+)/
+  require "#{$1}/my_extension"
+rescue LoadError
+  require "my_extension"
+end
+```
 
 The above technique will lookup first for 1.8 or 1.9 version of the extension
 and when not found, will look for the plain extension.

data/lib/rake/extensiontask.rb

@@ -1,4 +1,5 @@
 require "rbconfig"
+require "shellwords"
 
 require 'rake/baseextensiontask'
 require "rubygems/package_task"
@@ -79,6 +80,26 @@ module Rake
       end.flatten
     end
 
+    def make_makefile_cmd(root_path, tmp_path, extconf, cross_platform) # :nodoc:
+      # include current directory
+      include_dirs = ['.'].concat(@config_includes).uniq.join(File::PATH_SEPARATOR)
+
+      # build a relative path to extconf script
+      abs_tmp_path = (Pathname.new(root_path) + tmp_path).realpath
+      abs_extconf = (Pathname.new(root_path) + extconf).realpath
+      rel_extconf = abs_extconf.relative_path_from(abs_tmp_path).to_s
+
+      # base command
+      cmd = [Gem.ruby, "-I#{include_dirs}", rel_extconf]
+
+      # add all the options
+      cmd += @config_options
+      cmd += cross_config_options(cross_platform) if cross_platform
+      cmd += extra_options
+
+      cmd.compact
+    end
+
     private
     # copy other gem files to staging directory
     def define_staging_file_tasks(files, lib_path, stage_path, platf, ruby_ver)
@@ -120,7 +141,6 @@ module Rake
       tmp_path = "#{@tmp_dir}/#{platf}/#{@name}/#{ruby_ver}"
       stage_path = "#{@tmp_dir}/#{platf}/stage"
 
-      siteconf_path = "#{tmp_path}/.rake-compiler-siteconf.rb"
       tmp_binary_path = "#{tmp_path}/#{binary_path}"
       tmp_binary_dir_path = File.dirname(tmp_binary_path)
       stage_binary_path = "#{stage_path}/#{lib_binary_path}"
@@ -138,26 +158,20 @@ module Rake
       directory lib_path
       directory stage_binary_dir_path
 
-      directory File.dirname(siteconf_path)
-      # Set paths for "make install" destinations
-      file siteconf_path => File.dirname(siteconf_path) do
-        File.open(siteconf_path, "w") do |siteconf|
-          siteconf.puts "require 'rbconfig'"
-          siteconf.puts "require 'mkmf'"
-          siteconf.puts "dest_path = mkintpath(#{File.expand_path(lib_path).dump})"
-          %w[sitearchdir sitelibdir].each do |dir|
-            siteconf.puts "RbConfig::MAKEFILE_CONFIG['#{dir}'] = dest_path"
-            siteconf.puts "RbConfig::CONFIG['#{dir}'] = dest_path"
-          end
-        end
-      end
-
       # copy binary from temporary location to final lib
       # tmp/extension_name/extension_name.{so,bundle} => lib/
       task "copy:#{@name}:#{platf}:#{ruby_ver}" => [lib_path, tmp_binary_path, "#{tmp_path}/Makefile"] do
         # install in lib for native platform only
         unless for_platform
-          sh "#{make} install target_prefix=", chdir: tmp_path
+          relative_lib_path = Pathname(lib_path).relative_path_from(tmp_path)
+
+          make_command_line = Shellwords.shellsplit(make)
+          make_command_line << "install"
+          make_command_line << "sitearchdir=#{relative_lib_path}"
+          make_command_line << "sitelibdir=#{relative_lib_path}"
+          make_command_line << "target_prefix="
+
+          sh(*make_command_line, chdir: tmp_path)
         end
       end
       # copy binary from temporary location to staging directory
@@ -187,35 +201,17 @@ Java extension should be preferred.
 
       # makefile depends of tmp_dir and config_script
       # tmp/extension_name/Makefile
-      file "#{tmp_path}/Makefile" => [tmp_path, extconf, siteconf_path] do |t|
-        options = @config_options.dup
-
-        # include current directory
-        include_dirs = ['.'].concat(@config_includes).uniq.join(File::PATH_SEPARATOR)
-        cmd = [Gem.ruby, "-I#{include_dirs}", "-r#{File.basename(siteconf_path)}"]
-
-        # build a relative path to extconf script
-        abs_tmp_path = (Pathname.new(Dir.pwd) + tmp_path).realpath
-        abs_extconf = (Pathname.new(Dir.pwd) + extconf).realpath
-
-        # now add the extconf script
-        cmd << abs_extconf.relative_path_from(abs_tmp_path).to_s
-
-        # fake.rb will be present if we are cross compiling
-        if t.prerequisites.include?("#{tmp_path}/fake.rb") then
-          options.push(*cross_config_options(platf))
+      file "#{tmp_path}/Makefile" => [tmp_path, extconf] do |t|
+        if t.prerequisites.include?("#{tmp_path}/fake.rb")
+          cross_platform = platf
+        else
+          cross_platform = nil
         end
 
-        # add options to command
-        cmd.push(*options)
-
-        # add any extra command line options
-        unless extra_options.empty?
-          cmd.push(*extra_options)
-        end
+        command = make_makefile_cmd(Dir.pwd, tmp_path, extconf, cross_platform)
 
         chdir tmp_path do
-          sh *cmd
+          sh(*command)
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rake-compiler
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.4
 platform: ruby
 authors:
 - Kouhei Sutou
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-25 00:00:00.000000000 Z
+date: 2023-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -112,12 +112,6 @@ files:
 - 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
-- spec/spec_helper.rb
-- spec/support/capture_output_helper.rb
 - tasks/bin/cross-ruby.rake
 - tasks/bootstrap.rake
 - tasks/common.rake

data/spec/lib/rake/compiler_config_spec.rb

@@ -1,54 +0,0 @@
-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