ffi-compiler 1.4.2 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59c39f1d0d925b12810c952af5c52fd0631ab72fab24601fb7b3b2eb9359f9a0
-  data.tar.gz: 45b7b6b883d0e484c87789287bb722105521033c0a70a2dfa6c7aa51162e902e
+  metadata.gz: 9d61e5d60af4f58c5de6720bfe8c34c1d9fe1e1821d64db9d8f9e5776876aea2
+  data.tar.gz: 7a6f9e880348c82957e33f6d023e487fe1e608d259a381643bcab05cbacf29ef
 SHA512:
-  metadata.gz: 3e1fafd139b595d06c04e9edcd46818b1d58a4986aa4617a84b0e2f794395f2575012b48368c0e5d019bb4914b0b882b82ac42bf33d63548bc93d42d94cccff8
-  data.tar.gz: a58808da33f2e358d8445178dbc19aa8fea350e0a0fcbbb54f58be19fc092cbd49fc3eb238af22ae6254501c47d358eeee517bf8ee7d4cb6f3f377ece1fec884
+  metadata.gz: 021641dcb250942eef4a1fe21638b0a06f810f0ad0c11288d7146cab80ec4388634ab16e838a52d04767b4df3df68280bfaa270354a2132012f296315050f281
+  data.tar.gz: c467b06b0f8df3075e626832352d7a8aa5cce24fc0d8000d962eb57013d9157813f2f097e4f8c34e805fe94f8a73d925cdbb04fcb74300166071d1129ca08628

data/Rakefile

@@ -1,6 +1,11 @@
 require 'rubygems'
 require 'rubygems/tasks'
+require 'rspec/core/rake_task'
 
 Gem::Tasks.new do |t|
   t.scm.tag.format = '%s'
 end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/ffi-compiler/loader.rb

@@ -10,11 +10,7 @@ module FFI
         start_path ||= caller_path(caller[0])
 
         # Load from modern extension fast-path when called from an active gem spec
-        if defined?(Gem::Specification) &&
-           (spec = Gem::Specification.find_active_stub_by_path(library)) &&
-           spec.respond_to?(:extension_dir) &&
-           start_path.start_with?(spec.gem_dir)
-
+        if (spec = active_spec_containing(start_path)) && spec.respond_to?(:extension_dir)
           ext_path = File.join(spec.extension_dir, library)
           return ext_path if File.exist?(ext_path)
         end
@@ -38,6 +34,17 @@ module FFI
         raise LoadError.new("cannot find '#{name}' library")
       end
 
+      def self.active_spec_containing(path)
+        return unless defined?(Gem) && Gem.respond_to?(:loaded_specs)
+
+        path = path.to_s
+        Gem.loaded_specs.each_value.find do |spec|
+          gem_dir = spec.full_gem_path # not #gem_dir: Bundler's stub specs read the whole gemspec from disk for it
+          path == gem_dir || path.start_with?(gem_dir + File::SEPARATOR)
+        end
+      end
+      private_class_method :active_spec_containing
+
       def self.caller_path(line = caller[0])
         if FFI::Platform::OS == 'windows'
           drive = line[0..1]

data/lib/ffi-compiler/version.rb

@@ -1,7 +1,7 @@
 
 module FFI
   module Compiler
-    VERSION = "1.4.2"
+    VERSION = "1.4.3"
   end
 end
 

data/spec/loader_spec.rb

@@ -0,0 +1,152 @@
+require 'fileutils'
+require 'tmpdir'
+require 'ffi-compiler/loader'
+
+RSpec.describe FFI::Compiler::Loader do
+  let(:library) { FFI::Compiler::Platform.system.map_library_name('foo') }
+  let(:arch_dir) { "#{FFI::Platform::ARCH}-#{FFI::Platform::OS}" }
+
+  around do |example|
+    Dir.mktmpdir('ffi-compiler-loader') do |dir|
+      @root = File.realpath(dir)
+      example.run
+    end
+  end
+
+  def touch(*parts)
+    path = File.join(@root, *parts)
+    FileUtils.mkdir_p(File.dirname(path))
+    FileUtils.touch(path)
+    path
+  end
+
+  describe '.find' do
+    context 'when searching the legacy lib path' do
+      it 'finds a library below start_path' do
+        expected = touch('mygem', 'lib', 'mygem', library)
+
+        expect(described_class.find('foo', File.join(@root, 'mygem', 'lib'))).to eq(expected)
+      end
+
+      it 'prefers a library in the platform directory over a generic one' do
+        touch('mygem', 'ext', library)
+        expected = touch('mygem', 'ext', arch_dir, library)
+
+        expect(described_class.find('foo', File.join(@root, 'mygem', 'lib'))).to eq(expected)
+      end
+
+      it 'ascends from start_path to the gem root' do
+        expected = touch('mygem', 'ext', library)
+
+        expect(described_class.find('foo', File.join(@root, 'mygem', 'lib', 'mygem'))).to eq(expected)
+      end
+
+      it 'does not search above the gem root' do
+        touch(library)
+        FileUtils.mkdir_p(File.join(@root, 'mygem', 'lib'))
+
+        expect { described_class.find('foo', File.join(@root, 'mygem', 'lib')) }
+          .to raise_error(LoadError, "cannot find 'foo' library")
+      end
+
+      it 'accepts start_path as a Pathname' do
+        expected = touch('mygem', 'ext', library)
+
+        expect(described_class.find('foo', Pathname.new(File.join(@root, 'mygem', 'lib')))).to eq(expected)
+      end
+
+      it 'raises LoadError when the library does not exist' do
+        FileUtils.mkdir_p(File.join(@root, 'mygem', 'lib'))
+
+        expect { described_class.find('foo', File.join(@root, 'mygem', 'lib')) }
+          .to raise_error(LoadError, "cannot find 'foo' library")
+      end
+
+      it "defaults start_path to the caller's directory" do
+        expected = touch('mygem', 'ext', library)
+        caller_file = touch('mygem', 'lib', 'mygem.rb')
+
+        # Evaluate the call as if it were made from lib/mygem.rb
+        expect(eval("FFI::Compiler::Loader.find('foo')", binding, caller_file)).to eq(expected)
+      end
+    end
+
+    context 'when called from an activated gem' do
+      let(:gem_home) { GemHome.new(@root) }
+
+      # Runs Loader.find in a child process with +activate+ gems activated.
+      # Returns the path found, or :load_error.
+      def find_in_gem_home(start_path, activate:)
+        result = gem_home.run(<<~RUBY, activate: activate)
+          require 'ffi-compiler/loader'
+          begin
+            print FFI::Compiler::Loader.find('foo', #{start_path.inspect})
+          rescue LoadError
+            print 'LoadError'
+          end
+        RUBY
+        result == 'LoadError' ? :load_error : result
+      end
+
+      it "finds the library in the gem's extension_dir" do
+        gem_dir = gem_home.install('mygem', ext_files: [library])
+
+        expect(find_in_gem_home(File.join(gem_dir, 'lib'), activate: ['mygem']))
+          .to eq(File.join(gem_home.extension_dir('mygem-1.0'), library))
+      end
+
+      it "prefers the gem's extension_dir over a copy in the gem directory" do
+        gem_dir = gem_home.install('mygem', ext_files: [library], gem_files: ["ext/#{arch_dir}/#{library}"])
+
+        expect(find_in_gem_home(File.join(gem_dir, 'lib'), activate: ['mygem']))
+          .to eq(File.join(gem_home.extension_dir('mygem-1.0'), library))
+      end
+
+      it "falls back to the gem directory when the extension_dir lacks the library" do
+        gem_dir = gem_home.install('mygem', ext_files: ['other.so'], gem_files: ["ext/#{arch_dir}/#{library}"])
+
+        expect(find_in_gem_home(File.join(gem_dir, 'lib'), activate: ['mygem']))
+          .to eq(File.join(gem_dir, 'ext', arch_dir, library))
+      end
+
+      it "does not return a library from another gem's extension_dir" do
+        gem_home.install('other', ext_files: [library])
+        gem_dir = gem_home.install('mygem', gem_files: ["ext/#{library}"])
+
+        expect(find_in_gem_home(File.join(gem_dir, 'lib'), activate: %w[other mygem]))
+          .to eq(File.join(gem_dir, 'ext', library))
+      end
+
+      it "raises LoadError when only another gem's extension_dir has the library" do
+        gem_home.install('other', ext_files: [library])
+        gem_dir = gem_home.install('mygem')
+
+        expect(find_in_gem_home(File.join(gem_dir, 'lib'), activate: %w[other mygem])).to eq(:load_error)
+      end
+
+      it "finds the library in its own extension_dir when another gem's extension_dir has one too" do
+        gem_home.install('another', ext_files: [library])
+        gem_dir = gem_home.install('mygem', ext_files: [library])
+
+        expect(find_in_gem_home(File.join(gem_dir, 'lib'), activate: %w[another mygem]))
+          .to eq(File.join(gem_home.extension_dir('mygem-1.0'), library))
+      end
+
+      it 'finds the library when start_path is the gem directory itself' do
+        gem_dir = gem_home.install('mygem', ext_files: [library], gem_files: ["ext/#{library}"])
+
+        expect(find_in_gem_home(gem_dir, activate: ['mygem']))
+          .to eq(File.join(gem_home.extension_dir('mygem-1.0'), library))
+      end
+
+      it 'does not match a gem whose directory is only a prefix of start_path' do
+        # mygem-1.0 is a string prefix of mygem-1.0-2, the directory of gem "mygem-1.0" version 2
+        gem_home.install('mygem', ext_files: [library])
+        gem_dir = gem_home.install('mygem-1.0', version: '2', gem_files: ["ext/#{library}"])
+
+        expect(find_in_gem_home(File.join(gem_dir, 'lib'), activate: %w[mygem mygem-1.0]))
+          .to eq(File.join(gem_dir, 'ext', library))
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+
+Dir[File.join(__dir__, 'support', '**', '*.rb')].sort.each { |f| require f }
+
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  config.order = :random
+  Kernel.srand config.seed
+end

data/spec/support/gem_home.rb

@@ -0,0 +1,79 @@
+require 'fileutils'
+require 'open3'
+require 'rbconfig'
+
+# Builds a throwaway GEM_HOME with installed gems and runs Ruby code against it
+# in a child process, so specs can activate real gems without touching the
+# bundle the spec run itself is using.
+class GemHome
+  attr_reader :root
+
+  def initialize(root)
+    @root = root
+  end
+
+  # Installs a gem named +name+. Each of +ext_files+ is placed in the gem's
+  # extension_dir, as RubyGems does for a compiled extension, and each of
+  # +gem_files+ is placed in the gem directory. Returns the gem directory.
+  def install(name, version: '1.0', ext_files: [], gem_files: [])
+    full_name = "#{name}-#{version}"
+    gem_dir = File.join(root, 'gems', full_name)
+
+    write(File.join(gem_dir, 'lib', "#{name}.rb"))
+    gem_files.each { |f| write(File.join(gem_dir, f)) }
+
+    unless ext_files.empty?
+      write(File.join(gem_dir, 'ext', 'extconf.rb'))
+      ext_dir = extension_dir(full_name)
+      ext_files.each { |f| write(File.join(ext_dir, f)) }
+      write(File.join(ext_dir, 'gem.build_complete'))
+    end
+
+    write(File.join(root, 'specifications', "#{full_name}.gemspec"), <<~RUBY)
+      Gem::Specification.new do |s|
+        s.name = #{name.inspect}
+        s.version = #{version.inspect}
+        s.summary = 'fake'
+        s.authors = ['fake']
+        s.files = ['lib/#{name}.rb']
+        s.extensions = #{ext_files.empty? ? [] : ['ext/extconf.rb']}
+      end
+    RUBY
+
+    gem_dir
+  end
+
+  def extension_dir(full_name)
+    File.join(root, 'extensions', Gem::Platform.local.to_s, Gem.extension_api_version, full_name)
+  end
+
+  # Activates +gems+ and then runs +code+ in a child process using this
+  # GEM_HOME. Returns the child's stdout; raises if it fails.
+  def run(code, activate: [])
+    script = activate.map { |g| "gem #{g.inspect}\n" }.join + code
+    stdout, stderr, status = Open3.capture3(child_env, RbConfig.ruby, *load_path_args, '-e', script)
+    raise "child process failed:\n#{stderr}" unless status.success?
+
+    stdout
+  end
+
+  private
+
+  def write(path, content = '')
+    FileUtils.mkdir_p(File.dirname(path))
+    File.write(path, content)
+  end
+
+  def child_env
+    env = { 'GEM_HOME' => root, 'GEM_PATH' => root, 'RUBYOPT' => nil, 'RUBYLIB' => nil }
+    ENV.each_key { |k| env[k] = nil if k.start_with?('BUNDLE_', 'BUNDLER_') }
+    env
+  end
+
+  # ffi-compiler and ffi are not installed in this GEM_HOME; put them on the
+  # load path directly.
+  def load_path_args
+    paths = [File.expand_path('../../lib', __dir__)] + Gem.loaded_specs.fetch('ffi').full_require_paths
+    paths.flat_map { |p| ['-I', p] }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-compiler
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.3
 platform: ruby
 authors:
 - Wayne Meissner
@@ -89,6 +89,9 @@ files:
 - lib/ffi-compiler/shell.rb
 - lib/ffi-compiler/task.rb
 - lib/ffi-compiler/version.rb
+- spec/loader_spec.rb
+- spec/spec_helper.rb
+- spec/support/gem_home.rb
 homepage: https://github.com/ffi/ffi-compiler
 licenses:
 - Apache-2.0
@@ -107,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.5
+rubygems_version: 4.0.23
 specification_version: 4
 summary: Ruby FFI Rakefile generator
 test_files: []