alt_memery 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 34a090f8bb82efcf602abd829780cf4ad2999a5a4ef2832c739438e05ffde120
+  data.tar.gz: 205faeba1520ae7fc16877b00260450db78dbf425904e2140bdc8733dac8e1db
+SHA512:
+  metadata.gz: 2d5d4380c23de08c5501e2875debfc1eb64db87e2df49c07dca6a1f71a1fd702a205284971a2266a176bcea6de65be0897bfd35f0a13e43ada5996d6cd2e48d3
+  data.tar.gz: 6f0f56fc4abb3277d49235a086933228e86ad30917978c6ac994732cb511bfb9537dab641a7b9baf9085f250decd803cc51e234aa089a4d76ceb719d070466f1

data/CHANGELOG.md

@@ -0,0 +1,54 @@
+# Changelog
+
+## master (unreleased)
+
+## 2.0.0 (2020-07-09)
+
+*   Rename gem.
+*   Rewrite implementation from `prepend Module` to `UnboundMethod`.
+    See discussion here: <https://github.com/tycooon/memery/pull/1>.
+*   Delete `Gemfile.lock` and lock dependencies versions in `gemspec`.
+*   Update dependencies.
+    Unmaintained `coveralls` replaced with `codecov`.
+    `bundler` dependency dropped with `Rakefile`.
+*   Replace `require` with `require_relative`.
+*   Replace Umbrella styles with standard RuboCop.
+*   Improve README.
+*   Replace Travis CI with Cirrus CI.
+    You can see discussion here: <https://github.com/tycooon/memery/issues/28>.
+*   Add `remark` CI task for linting Markdown.
+*   Delete `benchmark.rb`.
+    You can find improving example here: <https://gist.github.com/AlexWayfer/37ebb8b9f3429650b86fb4cea7ae3693>.
+
+### Unreleased Memery
+
+*   Fix compatibility with `ActiveSupport::Concern`.
+
+## 1.3.0 (2020-02-10)
+
+*   Allow memoization after including module with Memery.
+*   Make `memoize` return the method name to allow chaining.
+*   Fix warnings in Ruby 2.7.
+
+## 1.2.0 (2019-10-19)
+
+*   Add `:ttl` option for `memoize` method.
+*   Add benchmark script.
+*   Add `.memoized?` method.
+
+## 1.1.0 (2019-08-05)
+
+*   Optimize speed and memory for cached values returns.
+
+## 1.0.0 (2018-08-31)
+
+*   Add `:condition` option for `.memoize` method.
+
+## 0.6.0 (2018-04-20)
+
+*   Add example of class methods memoization into README.
+*   Memery raises `ArgumentError` if method is not defined when you call `memoize`.
+
+## 0.5.0 (2017-06-12)
+
+*   Initial public version.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Yuri Smirnov
+
+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/README.md

@@ -0,0 +1,300 @@
+# Alt Memery
+
+Alt Memery allows to memoize methods return values.
+
+The native simplest memoization in Ruby looks like this:
+
+```ruby
+def user
+  @user ||= User.find(some_id)
+end
+```
+
+But if you want to memoize falsy values — you have to use `defined?` instead of `||=`:
+
+```ruby
+def user
+  return @user if defined?(@user)
+
+  @user = User.find(some_id)
+end
+```
+
+But with memoization gems, like this one, you can simplify your code:
+
+```ruby
+memoize def user
+  User.find(some_id)
+end
+```
+
+Also, you're getting additional features, like conditions of memoization, time-to-live,
+handy memoized values flushing, etc.
+
+## Alt?
+
+It's a fork of [Memery gem](https://github.com/tycooon/memery).
+Original Memery uses `prepend Module.new` with memoized methods, not touching original ones.
+This approach has advantages, but also has problems, see discussion here:
+<https://github.com/tycooon/memery/pull/1>
+
+So, this fork uses `UnboundMethod` as I've suggested in the PR above.
+
+## Difference with other gems
+
+Such gems like [Memoist](https://github.com/matthewrudy/memoist) override methods.
+So, if you want to memoize a method in a child class with the same named memoized method
+in a parent class — you have to use something like awkward `identifier: ` argument.
+This gem allows you to just memoize methods when you want to.
+
+Note how both method's return values are cached separately and don't interfere with each other.
+
+The other key difference is that it doesn't change method's arguments
+(no extra param like `reload`). If you need to get unmemoize result of method —
+just call the `#clear_memery_cache!` method with needed memoized method names:
+
+```ruby
+a.clear_memery_cache! :foo, :bar
+```
+
+Without arguments, `#clear_memery_cache!` will clear the whole instance's cache.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alt_memery'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install alt_memery
+```
+
+## Usage
+
+```ruby
+class A
+  include Memery
+
+  memoize def call
+    puts "calculating"
+    42
+  end
+
+  # or:
+  # def call
+  #   ...
+  # end
+  # memoize :call
+end
+
+a = A.new
+a.call # => 42
+a.call # => 42
+a.call # => 42
+# Text will be printed only once.
+
+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
+class B
+  class << self
+    include Memery
+
+    memoize def call
+      puts "calculating"
+      42
+    end
+  end
+end
+
+B.call # => 42
+B.call # => 42
+B.call # => 42
+# Text will be printed only once.
+```
+
+For conditional memoization:
+
+```ruby
+class A
+  include Memery
+
+  attr_accessor :environment
+
+  def call
+    puts "calculating"
+    42
+  end
+
+  memoize :call, condition: -> { environment == 'production' }
+end
+
+a = A.new
+a.environment = 'development'
+a.call # => 42
+# calculating
+a.call # => 42
+# calculating
+a.call # => 42
+# calculating
+# Text will be printed every time because result of condition block is `false`.
+
+a.environment = 'production'
+a.call # => 42
+# calculating
+a.call # => 42
+a.call # => 42
+# Text will be printed only once because there is memoization
+# 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
+```
+
+If you want to see memoized method source:
+
+```ruby
+class A
+  include Memery
+
+  memoize def call
+    puts "calculating"
+    42
+  end
+end
+
+# This will print memoization logic, don't use it.
+# The same for `show-source A#call` in `pry`.
+puts A.instance_method(:call).source
+
+# And this will work correctly.
+puts A.memoized_methods[:call].source
+```
+
+But if a memoized method has been defined in an included module — it'd be a bit harder:
+
+```ruby
+module A
+  include Memery
+
+  memoize def foo
+    'source'
+  end
+end
+
+module B
+  include Memery
+  include A
+
+  memoize def foo
+    "Get this #{super}!"
+  end
+end
+
+class C
+  include B
+end
+
+puts C.instance_method(:foo).owner.memoized_methods[:foo].source
+# memoize def foo
+#   "Get this #{super}!"
+# end
+
+puts C.instance_method(:foo).super_method.owner.memoized_methods[:foo].source
+# memoize def foo
+#   'source'
+# end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/AlexWayfer/alt_memery>.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/memery.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'module_methods'
+require 'ruby2_keywords'
+
+require_relative 'memery/version'
+
+## Module for memoization
+module Memery
+  extend ::ModuleMethods::Extension
+
+  class << self
+    def monotonic_clock
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
+    def method_visibility(klass, method_name)
+      if klass.private_method_defined?(method_name)
+        :private
+      elsif klass.protected_method_defined?(method_name)
+        :protected
+      elsif klass.public_method_defined?(method_name)
+        :public
+      else
+        raise ArgumentError, "Method #{method_name} is not defined on #{klass}"
+      end
+    end
+  end
+
+  ## Module for class methods
+  module ClassMethods
+    def memoized_methods
+      @memoized_methods ||= {}
+    end
+
+    ## TODO: Resolve this
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
+    def memoize(method_name, condition: nil, ttl: nil)
+      original_visibility = Memery.method_visibility(self, method_name)
+
+      original_method = memoized_methods[method_name] = instance_method(method_name)
+
+      undef_method method_name
+
+      define_method method_name do |*args, &block|
+        if block || (condition && !instance_exec(&condition))
+          return original_method.bind(self).call(*args, &block)
+        end
+
+        method_object_id = original_method.object_id
+
+        store =
+          ((@_memery_memoized_values ||= {})[method_name] ||= {})[method_object_id] ||= {}
+
+        if store.key?(args) && (ttl.nil? || Memery.monotonic_clock <= store[args][:time] + ttl)
+          return store[args][:result]
+        end
+
+        result = original_method.bind(self).call(*args)
+        @_memery_memoized_values[method_name][method_object_id][args] =
+          { result: result, time: Memery.monotonic_clock }
+        result
+      end
+
+      ruby2_keywords method_name
+
+      send original_visibility, method_name
+
+      method_name
+    end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+
+    def memoized?(method_name)
+      memoized_methods.key?(method_name)
+    end
+  end
+
+  def clear_memery_cache!(*method_names)
+    if method_names.any?
+      method_names.each { |method_name| @_memery_memoized_values[method_name]&.clear }
+    elsif defined? @_memery_memoized_values
+      @_memery_memoized_values.clear
+    end
+  end
+end

data/lib/memery/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Memery
+  VERSION = '2.0.0'
+end

metadata

@@ -0,0 +1,253 @@
+--- !ruby/object:Gem::Specification
+name: alt_memery
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Yuri Smirnov
+- Alexander Popov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: module_methods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: ruby2_keywords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-memory
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.1.18
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.1.18
+- !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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.87.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.87.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.38'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.38'
+- !ruby/object:Gem::Dependency
+  name: gem_toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: |
+  Alt Memery is a gem for memoization.
+  It's a fork of Memery with implementation via `UnboundMethod` instead of `prepend Module`.
+email:
+- alex.wayfer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/memery.rb
+- lib/memery/version.rb
+homepage: https://github.com/AlexWayfer/alt_memery
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+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'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A gem for memoization.
+test_files: []