memoized_inflectors 0.0.2 → 1.0.0.pre.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87e05981dfe99775911f9ab2c7d688366a2a99d9
-  data.tar.gz: c1c8c5dcdc13446e965b8b8d48d39c84a4bdceaa
+  metadata.gz: d8f52803c9ce34f7ba6240f090fb715457b09639
+  data.tar.gz: 492c4a7d13166a9cb3a36fd6419ac22a8b7e912b
 SHA512:
-  metadata.gz: 675b0cd421bdaa214da1c86d8040cbbed909f9d4c8afb83f5abd4121fb32663ef165e6c236bff64dd67bb46ea72f282d8f33d65a5981987d3fead7bd2d83cbbf
-  data.tar.gz: 5b8266a118bf1a615c330f22b2dbded9b0eb8dc8b30ac2b0096d0d5e9f6eb3359ed1f2f5981732874327806ef3dd92d9fc15d4efa6111cf53f31e19899ea77a3
+  metadata.gz: 4b60e5f073cc48607e21207138d6ac0f9c9f0e02cb94d4841bfc9f21528239a250e4e1f5d8c0ed512e7fadcf9a7e8f258d500fd3b68242afe41f7be349367328
+  data.tar.gz: 042e921b89e2ad34ca6cb3469fc4325d9acfdd05bc26e05e50c7ef6a9fcc10f2d554bb927afe15537665bd2245c35bc2940474f33dc7f95d3cfcd483199e07c1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2016 Andrew Ogzewalla
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/memoized_inflectors/integer_methods.rb

@@ -0,0 +1,22 @@
+module MemoizedInflectors
+  module IntegerMethods
+    INFLECTORS = %i[ordinalize ordinal].freeze
+
+    # Define an instance method for each inflector, e.g. `signularize`, `constantize`, etc.
+    (INFLECTORS | ::ActiveSupport::Inflector.instance_methods).each do |inflector|
+      define_method(inflector) do |*args|
+        return super(*args) if ::MemoizedInflectors.disabled
+        cache = ::MemoizedInflectors.cache_for(inflector)
+        key = ::MemoizedInflectors.key_for(self, *args)
+
+        if cache.has_key?(key)
+          cache[key]
+        else
+          cache[key] = super(*args)
+        end
+      end
+    end
+  end
+end
+
+::Integer.send(:prepend, ::MemoizedInflectors::IntegerMethods)

data/lib/memoized_inflectors/string_methods.rb

@@ -0,0 +1,34 @@
+module MemoizedInflectors
+  module StringMethods
+    # TODO: Maintain a default set of inflectors from ActiveSupport and allow users to add or remove from those. *
+    INFLECTORS = [
+      *%i[
+        camelize   classify    dasherize deconstantize
+        demodulize foreign_key humanize  parameterize
+        pluralize  singularize tableize  titleize
+        to_param   underscore
+      ].freeze,
+      *DUP_UNSAFE_INFLECTORS = %i[constantize safe_constantize].freeze
+    ]
+
+    # Define an instance method for each inflector, e.g. `signularize`, `constantize`, etc.
+    (INFLECTORS | ::ActiveSupport::Inflector.instance_methods).each do |inflector|
+      define_method(inflector) do |*args|
+        return super(*args) if ::MemoizedInflectors.disabled
+        cache = ::MemoizedInflectors.cache_for(inflector)
+        key = ::MemoizedInflectors.key_for(self, *args)
+
+        result =
+          if cache.has_key?(key)
+            cache[key]
+          else
+            cache[key] = super(*args)
+          end
+
+        (DUP_UNSAFE_INFLECTORS.include?(inflector) || result.nil?) ? result : result.dup
+      end
+    end
+  end
+end
+
+::String.send(:prepend, ::MemoizedInflectors::StringMethods)

data/lib/memoized_inflectors/version.rb

@@ -1,3 +1,3 @@
 module MemoizedInflectors
-  VERSION = "0.0.2"
+  VERSION = "1.0.0-beta.2"
 end

data/lib/memoized_inflectors.rb

@@ -1,32 +1,62 @@
 require "active_support"
 require "active_support/inflector"
 require "active_support/core_ext/string"
+require "active_support/core_ext/integer"
+require "lru_redux"
+
+require "memoized_inflectors/string_methods"
+require "memoized_inflectors/integer_methods"
 
 module MemoizedInflectors
-  INFLECTOR_METHODS = [
-    :camelize, :classify, :constantize, :dasherize, :deconstantize, :demodulize, :foreign_key,
-    :humanize, :inflections, :ordinal, :ordinalize, :parameterize, :pluralize, :safe_constantize,
-    :singularize, :tableize, :titleize, :transliterate, :underscore
-  ].freeze
-
-  def self.prepended(klass)
-    klass.class_eval do
-      @memoized_inflectors = {}
-      INFLECTOR_METHODS.each do |inflector_name|
-        unless instance_variable_get("@#{ inflector_name }")
-          @memoized_inflectors[inflector_name] = instance_variable_set("@#{ inflector_name }", {})
-        end
+  class << self
+    attr_accessor :disabled
+  end
+
+  def self.new_cache_instance
+    ::LruRedux::ThreadSafeCache.new(1000)  # TODO: allow users to configure the class (e.g. ThreadSafe vs non-ThreadSafe) and max size *
+  end
+
+  def self.caches
+    @caches ||= ::Hash.new { |h,k| h[k] = new_cache_instance }
+  end
+
+  # Returns the cache for the given inflector. Currently inflector names must
+  # be globally unique which works because there are no name collisions between
+  # the String and Integer inflectors.
+  #
+  #=== Example
+  #
+  #   MemoizedInflectors.cache_for(:classify)
+  def self.cache_for(inflector)
+    caches[inflector]
+  end
+
+  # Returns a unique key for the given arguments.
+  def self.key_for(*args)
+    # Using Object#hash rather than MD5 or SHA because it works on arrays, it is faster, and it
+    # also works correctly with hashes without manipulation. I.e. it is simply easier. This method
+    # works since there is no intention of persisting the cache or sharing it across VM instances.
+    args.hash
+  end
+
+  # Clears the cache for the specified inflector(s). If no inflector
+  # is specified, then all caches are cleared.
+  #
+  #=== Examples
+  #   MemoizedInflectors.clear_cache                           # Clears everything.
+  #   MemoizedInflectors.clear_cache(:classify)                # Clear only the :classify cache.
+  #   MemoizedInflectors.clear_cache(:classify, :underscore)   # Clears both the :classify and :underscore caches.
+  def self.clear_cache(*inflectors)
+    if inflectors.any?
+      inflectors.each do |inflector|
+        cache_for(inflector).clear
       end
+    else
+      caches.values.each(&:clear)
     end
   end
 
-  INFLECTOR_METHODS.each do |inflector_name|
-    define_method inflector_name do |*args|
-      memoized_inflections = self.class.instance_variable_get("@#{ inflector_name }")
-      key = [self, *args].hash
-      memoized_inflections.has_key?(key) ? memoized_inflections[key] : memoized_inflections[key] = super(*args)
-    end
+  def self.inflector_methods
+    ::ActiveSupport::Inflector.instance_methods
   end
 end
-
-String.send(:prepend, MemoizedInflectors)

metadata

@@ -1,42 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: memoized_inflectors
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0.pre.beta.2
 platform: ruby
 authors:
-- Andy Ogzewalla
+- WizardOfOgz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-19 00:00:00.000000000 Z
+date: 2016-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: lru_redux
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: |
-  Memoizes inflected strings.
+  Memoizes ActiveSupport inflector methods.
 email:
 - andyogzewalla@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/memoized_inflectors/version.rb
-- lib/memoized_inflectors.rb
-- lib/tasks/memoized_inflectors_tasks.rake
-- MIT-LICENSE
+- LICENSE.txt
 - Rakefile
+- lib/memoized_inflectors.rb
+- lib/memoized_inflectors/integer_methods.rb
+- lib/memoized_inflectors/string_methods.rb
+- lib/memoized_inflectors/version.rb
 homepage: https://github.com/WizardOfOgz/memoized_inflectors
 licenses:
 - MIT
@@ -47,18 +82,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.4
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Memoizes inflected strings.
+summary: Memoizes ActiveSupport inflector methods.
 test_files: []

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2014 Andrew Ogzewalla
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/tasks/memoized_inflectors_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :memoized_inflectors do
-#   # Task goes here
-# end