memery 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91c69224d38dc7b680a40c666d20e36ba65383235e70cec68b8b54b5e42f61ef
-  data.tar.gz: 8340fb04f65f8f57a5ee177d6affcb3183d892f65fae04153fb5c2e74d3ee2cf
+  metadata.gz: b422cc5336406f390272a02aea253b991470519a786844cb72b4cc0c05ef3b56
+  data.tar.gz: 12c2329a8539305d85dcb99b30604e55aa04b0f75153fc6a173ae73875f423c8
 SHA512:
-  metadata.gz: 1acd168dd8d4bc989ac51ca5c37eb1229cf86c8378aac3ef0fef716e4ba81bb50e85975712ac4ea1997ded3c58db43647ffe342f186d6f3a12d7bfc87e646293
-  data.tar.gz: 219204fb9a75cd005dcd3102740ba81a67302b5b15609bfceb4c0fe0484698c5a0f1467ce737f7d30067ad85a7b2d9be68df4d489d56d11d6f6789536c7b0533
+  metadata.gz: 94b69a032837511e10b368ab6db8212bf6b48c8b835c5f76732484b05dea8910af17712797a42fa334ee0529973f8c61d69ea052c1949619411bc1ae7c0897fa
+  data.tar.gz: fd17f734226f87487223034bf07afae259ed54ca5b216bfc11322b38adcdf1dd3898bf0f238ab8dcb846492c7f93baa8e51d909584bd1ec1e8b07774d4cc3693

data/.rspec

@@ -1,3 +1,4 @@
 --format documentation
 --color
 --require spec_helper
+--warnings

data/.travis.yml

@@ -11,15 +11,7 @@ rvm:
 
 before_install: gem install bundler
 
-env: SUITE="rspec"
-
-script: bundle exec $SUITE
-
 matrix:
   fast_finish: true
-  # Only run RuboCop on the latest Ruby
-  include:
-    - rvm: 2.6
-      env: SUITE="rubocop"
   allow_failures:
     - rvm: ruby-head

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [1.2.0] - 2019-10-19
+### Added
+- Add `:ttl` option for `memoize` method ([@AlexWayfer]) [#11]
+- Add benchmark script ([@AlexWayfer]) [#14]
+- Add `.memoized?` method ([@AlexWayfer]) [#17]
+
 ## [1.1.0] - 2019-08-05
 ### Fixed
 - Optimize speed and memory for cached values returns. ([@AlexWayfer]) [#10]
@@ -20,7 +26,8 @@
 [0.6.0]: https://github.com/tycooon/memery/compare/v0.5.0...v0.6.0
 [1.0.0]: https://github.com/tycooon/memery/compare/v0.6.0...v1.0.0
 [1.1.0]: https://github.com/tycooon/memery/compare/v1.0.0...v1.1.0
-[Unreleased]: https://github.com/tycooon/memery/compare/v1.1.0...HEAD
+[1.2.0]: https://github.com/tycooon/memery/compare/v1.1.0...v1.2.0
+[Unreleased]: https://github.com/tycooon/memery/compare/v1.2.0...HEAD
 
 [@tycooon]: https://github.com/tycooon
 [@AlexWayfer]: https://github.com/AlexWayfer
@@ -28,3 +35,6 @@
 [#3]: https://github.com/tycooon/memery/pull/3
 [#7]: https://github.com/tycooon/memery/pull/7
 [#10]: https://github.com/tycooon/memery/pull/10
+[#11]: https://github.com/tycooon/memery/pull/11
+[#14]: https://github.com/tycooon/memery/pull/14
+[#17]: https://github.com/tycooon/memery/pull/17

data/Gemfile

@@ -2,5 +2,3 @@
 
 source "https://rubygems.org"
 gemspec
-
-gem "rubocop-config-umbrellio", github: "umbrellio/code-style"

data/README.md

@@ -62,6 +62,25 @@ a.call { 1 } # => 42
 # Will print because passing a block disables memoization
 ```
 
+Methods with arguments are supported and the memoization will be done based on arguments using an internal hash. So this will work as expected:
+
+```ruby
+class A
+  include Memery
+
+  memoize def call(arg1, arg2)
+    puts "calculating"
+    arg1 + arg2
+  end
+end
+
+a = A.new
+a.call(1, 5) # => 6
+a.call(2, 15) # => 17
+a.call(1, 5) # => 6
+# Text will be printed only twice, once per unique argument list.
+```
+
 For class methods:
 
 ```ruby
@@ -117,6 +136,60 @@ a.call # => 42
 # with `true` result of condition block.
 ```
 
+For memoization with time-to-live:
+
+```ruby
+class A
+  include Memery
+
+  def call
+    puts "calculating"
+    42
+  end
+
+  memoize :call, ttl: 3 # seconds
+end
+
+a = A.new
+a.call # => 42
+# calculating
+a.call # => 42
+a.call # => 42
+# Text will be printed again only after 3 seconds of time-to-live.
+# 3 seconds later...
+a.call # => 42
+# calculating
+a.call # => 42
+a.call # => 42
+# another 3 seconds later...
+a.call # => 42
+# calculating
+a.call # => 42
+a.call # => 42
+```
+
+Check if method is memoized:
+
+```ruby
+class A
+  include Memery
+
+  memoize def call
+    puts "calculating"
+    42
+  end
+
+  def execute
+    puts "non-memoized"
+  end
+end
+
+a = A.new
+
+a.memoized?(:call) # => true
+a.memoized?(:execute) # => false
+```
+
 ## Difference with other gems
 Memery is very similar to [Memoist](https://github.com/matthewrudy/memoist). The difference is that it doesn't override methods, instead it uses Ruby 2 `Module.prepend` feature. This approach is cleaner (for example you are able to inspect the original method body using `method(:x).super_method.source`) and it allows subclasses' methods to work properly: if you redefine a memoized method in a subclass, it's not memoized by default, but you can memoize it normally (without using awkward `identifier: ` argument) and it will just work:
 

data/Rakefile

@@ -2,7 +2,13 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:lint)
 
-task default: :spec
+task default: %i[lint spec]
+
+task :benchmark do
+  require_relative "./benchmark"
+end

data/benchmark.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+Bundler.setup
+
+require "benchmark"
+require "benchmark/ips"
+require "benchmark/memory"
+
+puts "```ruby"
+puts File.read(__FILE__)
+puts "```"
+puts
+puts "### Output"
+puts
+puts "```"
+
+require_relative "lib/memery"
+
+class Foo
+  class << self
+    include Memery
+
+    def base_find(char)
+      ("a".."k").find { |letter| letter == char }
+    end
+
+    memoize def find_new(char)
+      base_find(char)
+    end
+  end
+end
+
+def test_memery
+  Foo.find_new("d")
+end
+
+Benchmark.ips do |x|
+  x.report("test_memery") { test_memery }
+end
+
+Benchmark.memory do |x|
+  x.report("test_memery") { 100.times { test_memery } }
+end
+
+puts "```"

data/lib/memery.rb

@@ -3,26 +3,39 @@
 require "memery/version"
 
 module Memery
-  def self.included(base)
-    base.extend(ClassMethods)
-    base.include(InstanceMethods)
-  end
+  class << self
+    def included(base)
+      base.extend(ClassMethods)
+      base.include(InstanceMethods)
+    end
+
+    def method_visibility(klass, method_name)
+      case
+      when klass.private_method_defined?(method_name)
+        :private
+      when klass.protected_method_defined?(method_name)
+        :protected
+      when klass.public_method_defined?(method_name)
+        :public
+      end
+    end
 
-  def self.method_visibility(klass, method_name)
-    case
-    when klass.private_method_defined?(method_name)
-      :private
-    when klass.protected_method_defined?(method_name)
-      :protected
-    when klass.public_method_defined?(method_name)
-      :public
+    def monotonic_clock
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
     end
   end
 
   module ClassMethods
-    def memoize(method_name, condition: nil)
+    def memoize(method_name, condition: nil, ttl: nil)
       prepend_memery_module!
-      define_memoized_method!(method_name, condition: condition)
+      define_memoized_method!(method_name, condition: condition, ttl: ttl)
+    end
+
+    def memoized?(method_name)
+      return false unless defined?(@_memery_module)
+
+      @_memery_module.method_defined?(method_name) ||
+        @_memery_module.private_method_defined?(method_name)
     end
 
     private
@@ -33,7 +46,7 @@ module Memery
       prepend @_memery_module
     end
 
-    def define_memoized_method!(method_name, condition: nil)
+    def define_memoized_method!(method_name, condition: nil, ttl: nil)
       mod_id = @_memery_module.object_id
       visibility = Memery.method_visibility(self, method_name)
       raise ArgumentError, "Method #{method_name} is not defined on #{self}" unless visibility
@@ -46,13 +59,15 @@ module Memery
 
           key = "#{method_name}_#{mod_id}"
 
-          store = @_memery_memoized_values&.[](key)
+          store = (@_memery_memoized_values ||= {})[key] ||= {}
 
-          return store[args] if store&.key?(args)
+          if store.key?(args) && (ttl.nil? || Memery.monotonic_clock <= store[args][:time] + ttl)
+            return store[args][:result]
+          end
 
-          @_memery_memoized_values ||= {}
-          @_memery_memoized_values[key] ||= {}
-          @_memery_memoized_values[key][args] = super(*args)
+          result = super(*args)
+          @_memery_memoized_values[key][args] = { result: result, time: Memery.monotonic_clock }
+          result
         end
 
         send(visibility, method_name)

data/lib/memery/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Memery
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/memery.gemspec

@@ -20,10 +20,13 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "benchmark-ips"
+  spec.add_development_dependency "benchmark-memory"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop-config-umbrellio"
   spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: memery
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Yuri Smirnov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-05 00:00:00.000000000 Z
+date: 2019-10-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  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: benchmark-memory
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-config-umbrellio
+  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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +153,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmark.rb
 - lib/memery.rb
 - lib/memery/version.rb
 - memery.gemspec