more_core_extensions 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8445d02cce0bc6bc1cfc1554bd6db773e335c2f8
-  data.tar.gz: 010cb3f4eb19a5d6c36a7593e77d65012b48e8c8
+  metadata.gz: 413a7851ecc9b2985a2186985d125319d91d7260
+  data.tar.gz: d8b660b117dca1de5e71a21184e75485942c8406
 SHA512:
-  metadata.gz: 4731d3a3029b3aa664031f4c794ce22f57da5c4718dd6c6bd4810b0a98a112d19028c3d7ca1400c64568f3505d6e6798dd76b4eec59e106bbedba7637b894a84
-  data.tar.gz: f0660e800d33a9d89c02a84e21825b7ed0ff7712594844dc3b5159dc1d0dbf960023a15005221501aabe5aa0255d9986c2e9f8e64497e1ecd673c25841b63489
+  metadata.gz: ec665edef944f6aab6555c17bdb2c6e2ead4a0c782a107b45c096d3fd89a4aad81cf5fa54c9921a24048a70bdbcb3197d7e83ac4f48f0a672f1bfd6a7bebbf4d
+  data.tar.gz: baba9a0b258fc9097bb6759ca4af9d753a8fbc8e0475b9ef50676e464247df8bb5252fd8f92cf0abb23b72c52c884704c106d847625bfbf9ac5e9442f67b0d35

data/.rubocop_local.yml

@@ -0,0 +1,4 @@
+GlobalVars:
+  AllowedVariables:
+  - $cache_with_timeout
+  - $cache_with_timeout_lock

data/CHANGELOG.md

@@ -4,6 +4,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [3.4.0] - 2017-08-11
+### Added
+- Added Module#cache_with_timeout [[#51](https://github.com/ManageIQ/more_core_extensions/pull/51)]
+
+### Changed
+- Performance improvements to store_path [[#54](https://github.com/ManageIQ/more_core_extensions/pull/54)]
+  and fetch_path [[#55](https://github.com/ManageIQ/more_core_extensions/pull/55)]
+
 ## [3.3.0] - 2017-07-21
 ### Added
 - Added Symbol#to_i [[#49](https://github.com/ManageIQ/more_core_extensions/pull/49)]
@@ -45,7 +53,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Upgraded to RSpec 3 [[#16](https://github.com/ManageIQ/more_core_extensions/pull/16)]
 - Added the Change Log!
 
-[Unreleased]: https://github.com/ManageIQ/more_core_extensions/compare/v3.3.0...HEAD
+[Unreleased]: https://github.com/ManageIQ/more_core_extensions/compare/v3.4.0...HEAD
+[3.4.0]: https://github.com/ManageIQ/more_core_extensions/compare/v3.3.0...v3.4.0
 [3.3.0]: https://github.com/ManageIQ/more_core_extensions/compare/v3.2.0...v3.3.0
 [3.2.0]: https://github.com/ManageIQ/more_core_extensions/compare/v3.1.1...v3.2.0
 [3.1.1]: https://github.com/ManageIQ/more_core_extensions/compare/v3.1.0...v3.1.1

data/README.md

@@ -57,6 +57,9 @@ MoreCoreExtensions are a set of core extensions beyond those provided by ActiveS
 
 #### Module
 
+* core_ext/module/cache_with_timeout.rb
+  * `#cache_with_timeout` - Creates singleton methods that cache the results of the given block, but only for a short amount of time.
+  * `.clear_all_cache_with_timeout` - Globally clears all cached values across all classes.
 * core_ext/module/namespace.rb
   * `#namespace` - Returns an Array with the namespace to the current Module
 

data/lib/more_core_extensions/core_ext/module.rb

@@ -1 +1,2 @@
+require 'more_core_extensions/core_ext/module/cache_with_timeout'
 require 'more_core_extensions/core_ext/module/namespace'

data/lib/more_core_extensions/core_ext/module/cache_with_timeout.rb

@@ -0,0 +1,101 @@
+require 'sync'
+
+$cache_with_timeout = {}
+$cache_with_timeout_lock = Sync.new
+
+module MoreCoreExtensions
+  module CacheWithTimeout
+    # cache_with_timeout creates singleton methods that cache the
+    #   results of the given block, but only for a short amount of time.
+    #   If the method is called again after time has passed, then the
+    #   cache is cleared and the block is reevaluated.  Note that the
+    #   cache is only cleared on the next invocation after the time has
+    #   passed, so if the block retains references to large objects,
+    #   they will never be garbage collected if the method is never
+    #   called again.
+    #
+    #   The methods created are
+    #   - `method`
+    #   - `#{method}_clear_cache` - Will clear the cached value on demand
+    #   - `#{method}_cached?` - Says whether or not there is a value cached
+    #
+    # Example:
+    #    class Foo
+    #      cache_with_timeout(:expensive_operation) do
+    #        sleep 100
+    #        rand(100)
+    #      end
+    #    end
+    #
+    #    Foo.expensive_operation # => 42
+    #    Foo.expensive_operation # => 42
+    #    # ... wait 5+ minutes ...
+    #    Foo.expensive_operation # => 18
+    #
+    # @param [String|Symbol] method The name of the method to create.
+    # @param [Integer] timeout The number of seconds after which the cache is
+    #   cleared (defaults to: 300 (5 minutes))
+    # @returns [Symbol] The name of the method created.
+    def cache_with_timeout(method, timeout = nil, &block)
+      raise "no block given" if block.nil?
+      raise ArgumentError, "method must be a Symbol" unless method.respond_to?(:to_sym)
+
+      key = "#{name}.#{method}".to_sym
+
+      $cache_with_timeout_lock.synchronize(:EX) do
+        $cache_with_timeout[key] = {}
+      end
+
+      define_singleton_method(method) do |*args|
+        force_reload = args.first
+        return $cache_with_timeout_lock.synchronize(:EX) do
+          cache = $cache_with_timeout[key]
+
+          old_timeout = cache[:timeout]
+          cache.clear if force_reload || (old_timeout && Time.now.utc > old_timeout)
+          break cache[:value] if cache.key?(:value)
+
+          new_timeout = timeout || 300 # 5 minutes
+          new_timeout = new_timeout.call if new_timeout.kind_of?(Proc)
+          new_timeout = Time.now.utc + new_timeout
+          new_value   = block.call
+
+          cache[:timeout] = new_timeout
+          cache[:value]   = new_value
+        end
+      end
+
+      define_singleton_method("#{method}_clear_cache") do |*_args|
+        $cache_with_timeout_lock.synchronize(:EX) do
+          $cache_with_timeout[key].clear
+        end
+      end
+
+      define_singleton_method("#{method}_cached?") do |*_args|
+        $cache_with_timeout_lock.synchronize(:EX) do
+          !$cache_with_timeout[key].empty?
+        end
+      end
+
+      method.to_sym
+    end
+
+    module ClassMethods
+      # Globally clears all cached values across all classes.  This is
+      #   mostly useful for testing to avoid test contamination.
+      #
+      # Example:
+      #    RSpec.configure do |c|
+      #      c.after { Module.clear_all_cache_with_timeout }
+      #    end
+      def clear_all_cache_with_timeout
+        $cache_with_timeout_lock.synchronize(:EX) do
+          $cache_with_timeout.each_value(&:clear)
+        end
+      end
+    end
+  end
+end
+
+Module.send(:include, MoreCoreExtensions::CacheWithTimeout)
+Module.send(:extend, MoreCoreExtensions::CacheWithTimeout::ClassMethods)

data/lib/more_core_extensions/core_ext/shared/nested.rb

@@ -26,13 +26,17 @@ module MoreCoreExtensions
         args = args.first if args.length == 1 && args.first.kind_of?(Array)
         raise ArgumentError, "must pass at least one key" if args.empty?
 
-        key = args.first
-        raise ArgumentError, "must be a number" if self.kind_of?(Array) && !key.kind_of?(Numeric)
+        result = self
+        args.each_with_index do |key, i|
+          raise ArgumentError, "must be a number" if result.kind_of?(Array) && !key.kind_of?(Numeric)
 
-        child = self[key]
-        return child if args.length == 1
-        return nil unless child.respond_to?(:fetch_path)
-        return child.fetch_path(args[1..-1])
+          result = result[key]
+          if !result.respond_to?(:fetch_path) && (i + 1) != args.size
+            result = nil
+            break
+          end
+        end
+        result
       end
 
       #
@@ -62,21 +66,25 @@ module MoreCoreExtensions
       def store_path(*args)
         raise ArgumentError, "must pass at least one key, and a value" if args.length < 2
         value = args.pop
-        args = args.first if args.length == 1 && args.first.kind_of?(Array)
+        child = self
+        key   = args.first
 
-        key = args.first
-        raise ArgumentError, "must be a number" if self.kind_of?(Array) && !key.kind_of?(Numeric)
+        if args.length > 1 || args.first.kind_of?(Array)
+          keys = args.first.kind_of?(Array) ? args.first : args
+          keys.each_with_index do |cur_key, i|
+            raise ArgumentError, "must be a number" if child.kind_of?(Array) && !cur_key.kind_of?(Numeric)
+            key = cur_key # keep track of this for value assignment later
+            break if i + 1 == keys.size
 
-        if args.length == 1
-          self[key] = value
-        else
-          child = self[key]
-          unless child.respond_to?(:store_path)
-            self[key] = self.class.new
-            child = self[key]
+            unless child[cur_key].respond_to?(:store_path)
+              child[cur_key] = child.class.new
+            end
+
+            child = child[cur_key]
           end
-          child.store_path(args[1..-1].push, value)
         end
+
+        child[key] = value
       end
 
       #

data/lib/more_core_extensions/version.rb

@@ -1,3 +1,3 @@
 module MoreCoreExtensions
-  VERSION = "3.3.0".freeze
+  VERSION = "3.4.0".freeze
 end

data/more_core_extensions.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", ">= 3.0"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "timecop"
 
   spec.add_runtime_dependency "activesupport"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: more_core_extensions
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Jason Frey
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-24 00:00:00.000000000 Z
+date: 2017-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,6 +81,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +147,7 @@ files:
 - lib/more_core_extensions/core_ext/hash/nested.rb
 - lib/more_core_extensions/core_ext/hash/sorting.rb
 - lib/more_core_extensions/core_ext/module.rb
+- lib/more_core_extensions/core_ext/module/cache_with_timeout.rb
 - lib/more_core_extensions/core_ext/module/namespace.rb
 - lib/more_core_extensions/core_ext/numeric.rb
 - lib/more_core_extensions/core_ext/numeric/clamp.rb
@@ -173,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: MoreCoreExtensions are a set of core extensions beyond those provided by