fast_underscore 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 07fbe0b6f67b99fa5786e31ff487a444e1ac649b
-  data.tar.gz: 467ac00f6bec4ef82f4ba862dff95751e3ad5063
+SHA256:
+  metadata.gz: 6365c2190445bc7618c3fe443583205ae7fc08cdb0151811a6d088db7582ca9c
+  data.tar.gz: 351dc9c1c0b4c661bc2a909f94dabf4a018eae5cd0a2bb32e2c01916a9387c43
 SHA512:
-  metadata.gz: a075571a7c8b3d84ace4442410bf11b3387a19cd1eb85de6207931426f568b48a7ca02eb8bd007a2e5e4238e4eca8b7eac96e38899a121173515e490aa012620
-  data.tar.gz: 1e87466be79faddedb5f69fa3b554aecb708bb16eaee1e71d7a03b0c1a9fb880456ed3fe39557c05559e9dd5fc9e357edcdacec265777b9b1824cd1bcb8385a4
+  metadata.gz: aae5d5f8d9914d5acc70271c307e39b4e57427a7816b278bd3455f0cc1cf66ce928c844a295796beb7827a81642d511ed2ede47188ac75cef4567e398d8a34f3
+  data.tar.gz: 8fdd103f0920380ce462ca94b2d6f122a2465e4e793df9448d2c53d04a6f86c09ede6277689acab6958cf235cf02dae9a2a24b9ea1e9fe387ab5d7530ef44c35

data/.rubocop.yml

@@ -1,11 +1,14 @@
 AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
   Exclude:
   - 'bin/**/*'
   - 'gemfiles/**/*'
   - 'tmp/**/*'
 
+Style/Documentation:
+  Enabled: false
+
 Style/PerlBackrefs:
   Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fast_underscore (0.1.0)
+    fast_underscore (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -23,7 +23,7 @@ GEM
     powerpack (0.1.1)
     rainbow (3.0.0)
     rake (12.3.0)
-    rake-compiler (0.9.9)
+    rake-compiler (1.0.4)
       rake
     rubocop (0.52.0)
       parallel (~> 1.10)
@@ -48,8 +48,8 @@ DEPENDENCIES
   fast_underscore!
   minitest (~> 5)
   rake (~> 12)
-  rake-compiler (~> 0)
+  rake-compiler (~> 1)
   rubocop (~> 0.52)
 
 BUNDLED WITH
-   1.16.1.pre1
+   1.16.1

data/README.md

@@ -11,19 +11,16 @@ Maybe! Run a stack profiler like [`ruby-prof`](https://github.com/ruby-prof/ruby
 
 ## Usage with Rails
 
-`ActiveSupport::Inflector#underscore` is actually used significantly throughout the Rails boot process, so it's best to hook into that process early to get the best results. Place the following lines above the `require 'rails'` line in your `application.rb` file:
+`ActiveSupport::Inflector#underscore`, in addition to underscoring the input will additionally take into account known acronyms. Since this can't be done at compile time, `FastUnderscore` will detect when `ActiveSupport` is loaded and take advantage of its knowledge of acronyms while still using the native extension.
 
-```ruby
-require 'active_support'
-require 'fast_underscore'
-```
-
-This will allow Rails to use the faster underscore method while it is booting, which is used for autoloading dependencies, as well as determining table names.
+Since the `#underscore` method is used so much throughout the Rails boot process (for autoloading dependencies, determining table names, determining inverse associations, etc.), it's best to hook into Rails as early as possible. As such, for the best results in your `Gemfile` add `require: false` to the `gem 'fast_underscore'` declaration and add `require 'fast_underscore'` to the bottom of `config/boot.rb`.
 
 ## Is it fast?
 
 At last check, these were the benchmarks (obtained by running `bin/benchmark`):
 
+### Rails 5.1.4
+
 ```
 Warming up --------------------------------------
        ActiveSupport     2.000  i/100ms
@@ -37,6 +34,21 @@ Comparison:
        ActiveSupport:       28.8 i/s - 22.54x  slower
 ```
 
+### Rails 5.2.0
+
+```
+Warming up --------------------------------------
+       ActiveSupport     5.000  i/100ms
+      FastUnderscore    66.000  i/100ms
+Calculating -------------------------------------
+       ActiveSupport     50.055  (± 6.0%) i/s -    250.000  in   5.016223s
+      FastUnderscore    655.181  (± 2.1%) i/s -      3.300k in   5.038968s
+
+Comparison:
+      FastUnderscore:      655.2 i/s
+       ActiveSupport:       50.1 i/s - 13.09x  slower
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/bin/benchmark

@@ -12,7 +12,7 @@ words = 500.times.map { Array.new(100) { source.sample }.join }
 
 Benchmark.ips do |x|
   x.report('ActiveSupport') do
-    words.each { |word| ActiveSupport::Inflector.underscore(word) }
+    words.each { |word| ActiveSupport::Inflector.as_underscore(word) }
   end
 
   x.report('FastUnderscore') do

data/bin/console

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'bundler/setup'
-require 'active_support'
 require 'fast_underscore'
 
 require 'irb'

data/ext/fast_underscore/fast_underscore.c

@@ -350,7 +350,7 @@ builder_free(builder_t *builder) {
  *     camelize(underscore('SSLError'))  # => "SslError"
  */
 static VALUE
-rb_str_underscore(VALUE self, VALUE rb_string) {
+str_underscore(VALUE rb_string) {
   VALUE resultant;
   rb_encoding *encoding;
 
@@ -381,6 +381,15 @@ rb_str_underscore(VALUE self, VALUE rb_string) {
   return resultant;
 }
 
+/**
+ * A singleton method calls with a string that delegates to `str_underscore` to
+ * form an underscored, lowercase form from the expression in the string.
+ */
+static VALUE
+rb_str_underscore(VALUE self, VALUE rb_string) {
+  return str_underscore(rb_string);
+}
+
 /**
  * Hook into Ruby and define the `FastUnderscore::underscore`.
  */
@@ -388,4 +397,5 @@ void
 Init_fast_underscore(void) {
   VALUE rb_cFastUnderscore = rb_define_module("FastUnderscore");
   rb_define_singleton_method(rb_cFastUnderscore, "underscore", rb_str_underscore, 1);
+  rb_define_method(rb_cString, "underscore", str_underscore, 0);
 }

data/fast_underscore.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1'
   spec.add_development_dependency 'minitest', '~> 5'
   spec.add_development_dependency 'rake', '~> 12'
-  spec.add_development_dependency 'rake-compiler', '~> 0'
+  spec.add_development_dependency 'rake-compiler', '~> 1'
   spec.add_development_dependency 'rubocop', '~> 0.52'
 end

data/lib/fast_underscore/ext/acronym_regex.rb

@@ -11,19 +11,18 @@ module FastUnderscore
       @pattern ||= /(?:(?<=([A-Za-z\d]))|\b)(#{acronym_regex})(?=\b|[^a-z])/
     end
 
-    def underscore
-      return self unless /[A-Z-]|::/.match?(self)
+    def underscore(string)
+      return string unless /[A-Z-]|::/.match?(string)
 
-      response = dup
+      response = string.dup
       response.gsub!(AcronymRegex.pattern) { "#{$1 && '_'}#{$2.downcase}" }
 
       FastUnderscore.underscore(response)
     end
   end
-end
-
-String.prepend(FastUnderscore::AcronymRegex)
 
-class << ActiveSupport::Inflector
-  define_method(:underscore, &FastUnderscore.method(:underscore))
+  class << ActiveSupport::Inflector
+    alias as_underscore underscore
+    prepend AcronymRegex
+  end
 end

data/lib/fast_underscore/ext/acronym_underscore_regex.rb

@@ -4,10 +4,10 @@ module FastUnderscore
   # Uses ActiveSupport's `acronym_underscore_regex` method for replacing
   # acronyms within strings that need to be underscored.
   module AcronymUnderscoreRegex
-    def underscore
-      return self unless /[A-Z-]|::/.match?(self)
+    def underscore(string)
+      return string unless /[A-Z-]|::/.match?(string)
 
-      response = dup
+      response = string.dup
       acronyms = ActiveSupport::Inflector.inflections.acronyms_underscore_regex
 
       response.gsub!(acronyms) { "#{$1 && '_'}#{$2.downcase}" }
@@ -15,10 +15,9 @@ module FastUnderscore
       FastUnderscore.underscore(response)
     end
   end
-end
-
-String.prepend(FastUnderscore::AcronymUnderscoreRegex)
 
-class << ActiveSupport::Inflector
-  define_method(:underscore, &FastUnderscore.method(:underscore))
+  class << ActiveSupport::Inflector
+    alias as_underscore underscore
+    prepend AcronymUnderscoreRegex
+  end
 end

data/lib/fast_underscore/version.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# Provides a C-optimized method for underscoring a string
 module FastUnderscore
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/fast_underscore.rb

@@ -3,10 +3,29 @@
 require 'fast_underscore/version'
 require 'fast_underscore/fast_underscore'
 
-if !defined?(ActiveSupport)
-  require 'fast_underscore/ext/plain_string'
-elsif ActiveSupport::VERSION::MAJOR == 5 && ActiveSupport::VERSION::MINOR >= 2
-  require 'fast_underscore/ext/acronym_underscore_regex'
-else
-  require 'fast_underscore/ext/acronym_regex'
+module FastUnderscore
+  # Hooks into ActiveSupport::Inflector and waits for the #underscore method to
+  # be defined. When it is, it automatically redefines it by hooking into its
+  # acronyms and then still calling the native extension.
+  module ActiveSupportHook
+    def method_added(method)
+      return super if method != :underscore || !defined?(ActiveSupport)
+      require 'active_support/version'
+
+      if ActiveSupport::VERSION::MAJOR == 5 &&
+         ActiveSupport::VERSION::MINOR >= 2
+        require 'fast_underscore/ext/acronym_underscore_regex'
+      else
+        require 'fast_underscore/ext/acronym_regex'
+      end
+    end
+  end
+end
+
+module ActiveSupport
+  module Inflector
+    class << self
+      prepend FastUnderscore::ActiveSupportHook
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_underscore
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-17 00:00:00.000000000 Z
+date: 2018-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Fast String#underscore implementation