sanscript 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78a9a4f83c7ebeabdf0a4ce0b02c0efbe2bb99bd
-  data.tar.gz: 1e16e165ab8587163be05d449301c182d70b8037
+  metadata.gz: 80ce63ec01301d3bafb6e0b5b2e407255c8764e3
+  data.tar.gz: 2da0b081137b3fa9a286e176adb1eea0a329fae1
 SHA512:
-  metadata.gz: 0354c6bb4d13b5aca33b73febb968f72dfaa843a7c6231fc30482f66d04bd8d239250a2aa0f0dbc957e4fef35d46173800319cd8583e8433cb9a1127e192d519
-  data.tar.gz: f0131f094b3a4e88cb7bba19955c27f1337b4ea7f2d1ca419e5bb8cd61f2546b515f52c2f60b44df1bdc91494f5cd0cb3e9f7a52b4c39b680039db7a23ba6bfb
+  metadata.gz: 7d377ccfbc03e784fa18d80b2e65189eb07c76bc012c57224fb12e01712391b511fd5ecb0fd0933545ab25d8c5480fccc0a08cb9adcdc79cecb94ef3168fdcb3
+  data.tar.gz: f1f2be9cbc4414d7c284322ba0d8525732436f7d0a80880b6dfaf5076f65f991fe38e143d69b9254327ecb983d7658182ff7b72ec1522745be5a6732af75bb61

data/lib/sanscript.rb

@@ -10,13 +10,11 @@ require "sanscript/benchmark"
 
 # Sanscript.rb detection/transliteration module for Sanskrit.
 module Sanscript
-  # :nocov:
-  if RUST_AVAILABLE && ENV["SANSCRIPT_NO_RUST"].nil?
-    rust_enable!
-  else
-    rust_disable!
-  end
-  # :nocov:
+  # Whether Rust extension is available.
+  RUST_AVAILABLE = load_rust!
+
+  # Load rust if available.
+  rust_enable!
 
   module_function
 

data/lib/sanscript/benchmark.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-# :nocov:
-begin
-  require "benchmark/ips"
-rescue LoadError
-  module Benchmark
-    def self.ips(*)
-      raise NotImplementedError, "You must install the `benchmark-ips` gem first."
+module Sanscript
+  # :nocov:
+  begin
+    require "benchmark/ips"
+  rescue LoadError
+    module ::Benchmark
+      def self.ips(*)
+        raise NotImplementedError, "You must install the `benchmark-ips` gem first."
+      end
     end
   end
-end
-# :nocov:
+  # :nocov:
 
-module Sanscript
   # Benchmark/testing module.
   module Benchmark
     module_function

data/lib/sanscript/detect.rb

@@ -73,9 +73,5 @@ module Sanscript
     class << self
       alias detect_scheme ruby_detect_scheme
     end
-
-    if defined?(Rust) && Rust.instance_methods.include?(:rust_detect_scheme)
-      extend Rust
-    end
   end
 end

data/lib/sanscript/detect/ruby24.rb

@@ -3,6 +3,7 @@
 module Sanscript
   module Detect
     # Module implementing `detect_scheme` method using Ruby 2.4's faster Regexp#match? method
+    # (Note: This module will only load if chosen by {Sanscript::Detect}.)
     module Ruby24
       # Attempts to detect the encoding scheme of the provided string.
       # Uses Ruby 2.4's Regexp#match? method for additional speed.

data/lib/sanscript/detect/ruby2x.rb

@@ -3,6 +3,7 @@
 module Sanscript
   module Detect
     # Module implementing `detect_scheme` method using Ruby 2.x-compatible syntax.
+    # (Note: This module will only load if chosen by {Sanscript::Detect}.)
     module Ruby2x
       # Attempts to detect the encoding scheme of the provided string.
       #

data/lib/sanscript/detect/rust.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Sanscript
+  module Detect
+    # Module stub for implementing `detect_scheme` method using Rust native extension.
+    # (Note: This module will only exist if the native extension is available and {Sanscript.load_rust!} has been run.)
+    module Rust
+      # @!method rust_detect_scheme(text)
+      # Attempts to detect the encoding scheme of the provided string.
+      # Uses Rust native extension for vastly increased performance.
+      #
+      # @param text [String] a string of Sanskrit text
+      # @return [Symbol, nil] the Symbol of the scheme, or nil if no match
+    end
+  end
+end

data/lib/sanscript/rust.rb

@@ -1,20 +1,22 @@
 # frozen_string_literal: true
 module Sanscript
-  begin
-    require "thermite/fiddle"
+  module_function
 
+  # Attempts to load Rust native extension.
+  # @return [bool] whether the extension loaded.
+  def load_rust!
+    return RUST_AVAILABLE if defined?(RUST_AVAILABLE)
+    require "thermite/fiddle"
     Thermite::Fiddle.load_module("init_rusty_sanscript",
                                  cargo_project_path: GEM_ROOT,
                                  ruby_project_path: GEM_ROOT)
     #:nocov:#
-    RUST_AVAILABLE = true
+    true
   rescue Fiddle::DLError
-    RUST_AVAILABLE = false
+    false
     #:nocov:#
   end
 
-  module_function
-
   # @return [bool] the enabled status of the Rust extension
   def rust_enabled?
     @rust_enabled
@@ -24,12 +26,16 @@ module Sanscript
   # @return [bool] the enabled status of the Rust extension
   def rust_enable!
     if RUST_AVAILABLE
+      # :nocov:
       Detect.module_eval do
         class << self
           alias_method :detect_scheme, :rust_detect_scheme
         end
       end
       @rust_enabled = true
+    else
+      @rust_enabled = false
+      # :nocov:
     end
     @rust_enabled
   end

data/lib/sanscript/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module Sanscript
   # The version number
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 
   GEM_ROOT = Pathname.new(File.realpath(File.join(__dir__, "..", "..")))
   private_constant :GEM_ROOT

data/src/detect/ruby.rs

@@ -39,4 +39,5 @@ pub extern fn init_rusty_sanscript() {
   let m_rust = rb::define_module_under(&m_detect, "Rust");
   rb::define_method(&m_rust, "rust_detect_scheme",
     rbstr_detect_scheme as CallbackPtr, 1);
+  rb::extend_object(&m_detect, &m_rust);
 }

data/src/rb.rs

@@ -46,3 +46,7 @@ pub fn define_method(module: &Value, name: &str, method: CallbackPtr, argc: i32)
   let c_strp = str_to_cstrp(name);
   unsafe { class::rb_define_method(*module, c_strp, method, argc) }
 }
+
+pub fn extend_object(object: &Value, module: &Value) {
+  unsafe { class::rb_extend_object(*object, *module) }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sanscript
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Tim Bellefleur
@@ -190,6 +190,7 @@ files:
 - lib/sanscript/detect.rb
 - lib/sanscript/detect/ruby24.rb
 - lib/sanscript/detect/ruby2x.rb
+- lib/sanscript/detect/rust.rb
 - lib/sanscript/exceptions.rb
 - lib/sanscript/rust.rb
 - lib/sanscript/transliterate.rb