rutie 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c44100cf0dc7881fa99fbea5202acfe2e80a507e2eadda6cb7ab0e36ae6b494c
-  data.tar.gz: 2821576d1f9d2559fdee905cd0966c96d49285bc1eaa1363ab609a414332e718
+  metadata.gz: 1b64238b8adf58283d6b5f5af059aa5c55fc639b511d028cfe1acbf1ec60f34d
+  data.tar.gz: baa343484d7ee30aa776bd1b964c9da48f3be00bd3087e92616d9cdab81ab88b
 SHA512:
-  metadata.gz: b70f6429b6f61c112f971411817c4ee0ac0563ea8aa01bb9353aec08399c853518a701e7dc84af70b0dbac35b5bc5f0d8cd0ead7e33eb5b5babf3f9dd9de89ad
-  data.tar.gz: d43423e52eee80c8f3ec1da8c1c7b29a929fb9559d3a9212166aeaa72d592211f7f1988d560125653f203067dc1af7423e3542adfe0ea4d8480bba236dd6e69a
+  metadata.gz: b39f0e34b4481f8465dac15e91560f91a1911eaeb296755197eb1d21cd2410e5e536bccaf656773961ecfb1213d11894674440fca36eb87de967995a59c754cc
+  data.tar.gz: d2697285b96743651f9298346fe20766be9cb1715d61b34d835d607684e2f029046995273e8bf4f0f3eb99574a8da51d68aaf2e271636ff420ef36c864c6bc82

data/lib/rutie/rake_task.rb

@@ -0,0 +1,58 @@
+require 'rake'
+require 'rbconfig'
+
+class Rutie
+  # Rake tasks that build a Rutie extension so `ruby` can load it:
+  #
+  #   # Rakefile
+  #   require 'rutie/rake_task'
+  #   Rutie::RakeTask.new
+  #
+  #   Rake::TestTask.new(test: 'rutie:build') { |t| ... }
+  #
+  # `rutie:build` runs `cargo build --release`. On macOS it builds with
+  # `NO_LINK_RUTIE=1` and `-undefined dynamic_lookup` instead, so the extension
+  # uses the libruby of the `ruby` process loading it rather than linking its
+  # own (with a static Ruby that would be a second VM that never booted).
+  # `rutie:clean` runs `cargo clean`.
+  class RakeTask
+    include Rake::DSL
+
+    # `release: false` builds the debug profile, for `Rutie.new(..., release: 'debug')`.
+    # `cargo_args` are extra arguments for cargo, such as `%w[--features foo]`.
+    def initialize(release: true, cargo_args: [], os: nil)
+      @release = release
+      @cargo_args = cargo_args
+      @os = os # for testing purposes
+
+      define_tasks
+    end
+
+    # The environment and command `rutie:build` runs.
+    def build_command
+      profile = @release ? ['--release'] : []
+
+      if macos?
+        [{ 'NO_LINK_RUTIE' => '1' },
+         'cargo', 'rustc', *profile, *@cargo_args, '--', '-C', 'link-args=-Wl,-undefined,dynamic_lookup']
+      else
+        [{}, 'cargo', 'build', *profile, *@cargo_args]
+      end
+    end
+
+    private
+    def define_tasks
+      namespace :rutie do
+        desc 'Build the Rust extension'
+        task(:build) { sh(*build_command) }
+
+        desc 'Remove the Rust build output (cargo clean)'
+        task(:clean) { sh 'cargo', 'clean' }
+      end
+    end
+
+    def macos?
+      (@os || RbConfig::CONFIG['host_os']) =~ /darwin|mac os/
+    end
+  end
+end

data/lib/rutie.rb

@@ -1,4 +1,11 @@
 class Rutie
+  # Raised by #init when the compiled Rust library is not where Rutie looks for
+  # it. A LoadError, so code that rescues LoadError keeps working.
+  class LibraryNotFound < LoadError; end
+
+  # Raised by #init when the library has no function with the init name.
+  class InitFunctionNotFound < LoadError; end
+
   def initialize(project_name, **opts)
     @os = opts.fetch(:os) { nil } # for testing purposes
 
@@ -9,23 +16,68 @@ class Rutie
     @full_lib_path = opts.fetch(:lib_path) { nil }
   end
 
+  # The path of the compiled library. With no `lib_path` option, Rutie looks in
+  # `$CARGO_TARGET_DIR/<release>` when that variable is set, then in
+  # `../target/<release>` relative to `dir`, and returns the first that holds
+  # the library (or the first candidate when none does).
   def ffi_library(dir)
-    file = [ @lib_prefix, @project_name, '.', @lib_suffix ]
+    candidates = library_candidates(dir)
 
-    File.join(lib_path(dir), file.join())
+    candidates.find { |path| File.exist?(path) } || candidates.first
   end
 
-  def init(c_init_method_name, dir)
+  # Loads the compiled Rust library and calls its init function, which defaults
+  # to `Init_<project_name>`:
+  #
+  #   Rutie.new(:my_ext).init __dir__
+  #   Rutie.new(:my_ext).init 'Init_my_ext', __dir__
+  def init(c_init_method_name = "Init_#{@project_name}", dir)
+    library = ffi_library(dir)
+    raise LibraryNotFound, library_not_found_message(dir) unless File.exist?(library)
+
     require 'fiddle'
 
-    Fiddle::Function.new(Fiddle.dlopen(ffi_library dir)[c_init_method_name], [], Fiddle::TYPE_VOIDP).call
+    handle = Fiddle.dlopen(library)
+    function =
+      begin
+        handle[c_init_method_name]
+      rescue Fiddle::DLError
+        raise InitFunctionNotFound, init_not_found_message(library, c_init_method_name)
+      end
+
+    Fiddle::Function.new(function, [], Fiddle::TYPE_VOIDP).call
   end
 
   private
-  def lib_path(dir)
-    path = @full_lib_path || "../target/#{@release}"
+  def library_file
+    [ @lib_prefix, @project_name, '.', @lib_suffix ].join
+  end
+
+  def library_candidates(dir)
+    file = library_file
+
+    return [File.join(File.expand_path(@full_lib_path, dir), file)] if @full_lib_path
+
+    candidates = []
+    target_dir = ENV['CARGO_TARGET_DIR']
+    # Cargo resolves a relative CARGO_TARGET_DIR against the working directory.
+    candidates << File.join(File.expand_path(@release, target_dir), file) unless target_dir.nil? || target_dir.empty?
+    candidates << File.join(File.expand_path("../target/#{@release}", dir), file)
+    candidates.uniq
+  end
+
+  def library_not_found_message(dir)
+    profile = @release == 'release' ? ' --release' : ''
+
+    "Rutie could not find the compiled library for #{@project_name}. " \
+      "Looked for: #{library_candidates(dir).join(', ')}. " \
+      "Build it with `cargo build#{profile}` (see Rutie::RakeTask), " \
+      "or pass `lib_path:` to Rutie.new."
+  end
 
-    File.expand_path(path, dir)
+  def init_not_found_message(library, name)
+    "#{library} has no function #{name}. Define it in Rust as " \
+      "`#[no_mangle] pub extern \"C\" fn #{name}()`, or pass its name to Rutie#init."
   end
 
   def set_prefix
@@ -66,10 +118,12 @@ class Rutie
     def to_str
       @name
     end
+    alias to_s to_str
 
     private
+    # A Cargo library name: snake_case, and digits after the first character.
     def valid_name?(project)
-      project.chars.all? {|c| c[/[a-z_]/] }
+      project.match?(/\A[a-z_][a-z0-9_]*\z/)
     end
 
     class InvalidProjectName < StandardError

data/rutie.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'rutie'
-  spec.version       = '0.0.4'
+  spec.version       = '0.0.5'
   spec.authors       = ['Daniel P. Clark']
   spec.email         = ['6ftdan@gmail.com']
   spec.summary       = 'Rutie helper methods.'
@@ -12,5 +12,9 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/danielpclark/rutie'
   spec.license       = 'MIT'
 
-  spec.files         = %w[rutie.gemspec lib/rutie.rb LICENSE]
+  spec.files         = %w[rutie.gemspec lib/rutie.rb lib/rutie/rake_task.rb LICENSE]
+
+  # Rutie#init loads the extension with Fiddle, a bundled gem rather than a
+  # default gem since Ruby 4.0, so Bundler needs it declared.
+  spec.add_dependency 'fiddle'
 end

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: rutie
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Daniel P. Clark
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-18 00:00:00.000000000 Z
-dependencies: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fiddle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rutie — The Tie Between Ruby and Rust.  Helper methods gem for Rutie.
 email:
 - 6ftdan@gmail.com
@@ -19,12 +32,12 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - lib/rutie.rb
+- lib/rutie/rake_task.rb
 - rutie.gemspec
 homepage: https://github.com/danielpclark/rutie
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -39,8 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Rutie helper methods.
 test_files: []