alt_memery 2.0.0 → 3.0.0

checksums.yaml

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

data/CHANGELOG.md

@@ -1,6 +1,31 @@
 # Changelog
 
-## master (unreleased)
+## Unreleased
+
+## 3.0.0 (2026-01-08)
+
+*   Allow to memoize multiple method names.
+*   Performance improvements.
+*   Enshure that marshalizing works correctly.
+*   Add specs for double memoization.
+*   Add Ruby 3.4 and 4.0 support.
+*   Drop Ruby 2.5, 2.6, 2.7, 3.0, 3.1, 3.2 and 3.3 support.
+*   Improve README.
+*   Actualize gem specs metadata.
+*   Add `bundle-audit` CI task.
+*   Improve Cirrus CI config.
+*   Improve RuboCop config.
+*   Resolve new RuboCop offenses.
+*   Lock RuboCop version better.
+*   Update development dependencies.
+
+## 2.1.0 (2021-02-10)
+
+*   Support Ruby 3.
+*   Fix error of `#clear_memery_cache!` with specific methods and without existing cache.
+*   Improve specs.
+*   Update development dependencies.
+*   Update documentation.
 
 ## 2.0.0 (2020-07-09)
 

data/README.md

@@ -1,5 +1,13 @@
 # Alt Memery
 
+[![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/AlexWayfer/alt_memery?style=flat-square)](https://cirrus-ci.com/github/AlexWayfer/alt_memery)
+[![Codecov branch](https://img.shields.io/codecov/c/github/AlexWayfer/alt_memery/main.svg?style=flat-square)](https://codecov.io/gh/AlexWayfer/alt_memery)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/AlexWayfer/alt_memery.svg?style=flat-square)](https://codeclimate.com/github/AlexWayfer/alt_memery)
+[![Depfu](https://img.shields.io/depfu/AlexWayfer/benchmark_toys?style=flat-square)](https://depfu.com/repos/github/AlexWayfer/alt_memery)
+[![Inline docs](https://inch-ci.org/github/AlexWayfer/alt_memery.svg?branch=main)](https://inch-ci.org/github/AlexWayfer/alt_memery)
+[![license](https://img.shields.io/github/license/AlexWayfer/alt_memery.svg?style=flat-square)](https://github.com/AlexWayfer/alt_memery/blob/main/LICENSE.txt)
+[![Gem](https://img.shields.io/gem/v/alt_memery.svg?style=flat-square)](https://rubygems.org/gems/alt_memery)
+
 Alt Memery allows to memoize methods return values.
 
 The native simplest memoization in Ruby looks like this:
@@ -20,6 +28,20 @@ def user
 end
 ```
 
+Even worse: if your calculations require multiple lines, you have to use `begin`/`end` block:
+
+```ruby
+def user
+  @user ||= begin
+    some_id = calculate_id
+    klass = calculate_klass
+    klass.find(some_id)
+  end
+end
+```
+
+And there is no elegant escape if your methods accept arguments.
+
 But with memoization gems, like this one, you can simplify your code:
 
 ```ruby
@@ -42,6 +64,8 @@ So, this fork uses `UnboundMethod` as I've suggested in the PR above.
 
 ## Difference with other gems
 
+### Memoizaion method and ancestors
+
 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.
@@ -49,9 +73,11 @@ 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:
+### Memoized method arguments and clearing cache
+
+This gem 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
@@ -59,27 +85,32 @@ a.clear_memery_cache! :foo, :bar
 
 Without arguments, `#clear_memery_cache!` will clear the whole instance's cache.
 
+### Marshal compatibility
+
+This gem doesn't require any global options, it works well with marshalized objects
+in different proccesses with hashed arguments without performance impact.
+
 ## Installation
 
-Add this line to your application's Gemfile:
+Add `gem 'alt_memery'` to your Gemfile.
 
-```ruby
-gem 'alt_memery'
-```
+## Usage
+
+### Requirement
 
-And then execute:
+Since it's a fork of `memery` gem, require with:
 
-```shell
-bundle install
+```ruby
+require 'memery'
 ```
 
-Or install it yourself as:
+Or from the `Gemfile`:
 
-```shell
-gem install alt_memery
+```ruby
+gem 'alt_memery', require: 'memery'
 ```
 
-## Usage
+### Code
 
 ```ruby
 class A
@@ -89,22 +120,30 @@ class A
     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.
+# "calculating" will only be printed once.
 
 a.call { 1 } # => 42
-# Will print because passing a block disables memoization
+# "calculating" will be printed again because passing a block disables memoization.
+```
+
+Alternatively:
+
+```ruby
+class A
+  include Memery
+
+  def call
+    puts "calculating"
+    42
+  end
+  memoize :call
+end
 ```
 
 Methods with arguments are supported and the memoization will be done based on arguments
@@ -124,7 +163,7 @@ 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.
+# "calculating" will be printed twice, once for each unique argument list.
 ```
 
 For class methods:
@@ -144,10 +183,10 @@ end
 B.call # => 42
 B.call # => 42
 B.call # => 42
-# Text will be printed only once.
+# "calculating" will only be printed once.
 ```
 
-For conditional memoization:
+### Conditional Memoization
 
 ```ruby
 class A
@@ -182,7 +221,7 @@ a.call # => 42
 # with `true` result of condition block.
 ```
 
-For memoization with time-to-live:
+### Memoization with Time-to-Live (TTL)
 
 ```ruby
 class A
@@ -214,7 +253,7 @@ a.call # => 42
 a.call # => 42
 ```
 
-Check if method is memoized:
+### Checking if a Method is Memoized
 
 ```ruby
 class A
@@ -291,6 +330,25 @@ puts C.instance_method(:foo).super_method.owner.memoized_methods[:foo].source
 # end
 ```
 
+### Object Shape Optimization
+
+In Ruby 3.2, a new optimization called "object shape" was introduced,
+which can have negative interactions with dynamically added instance variables.
+Alt Memery minimizes this impact by introducing only one new instance variable
+after initialization (`@_memery_memoized_values`). If you need to ensure a specific object shape,
+you can call `clear_memery_cache!` in your initializer to set the instance variable ahead of time.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+
+Then, run `toys rspec` to run the tests.
+
+To install this gem onto your local machine, run `toys gem install`.
+
+To release a new version, run `toys gem release %version%`.
+See how it works [here](https://github.com/AlexWayfer/gem_toys#release).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/AlexWayfer/alt_memery>.

data/lib/memery/version.rb

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

data/lib/memery.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'module_methods'
-require 'ruby2_keywords'
 
 require_relative 'memery/version'
 
@@ -33,57 +32,74 @@ module Memery
       @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)
+    def memoize(*method_names, condition: nil, ttl: nil)
+      method_names.each do |method_name|
+        memoize_method(method_name, condition:, ttl:)
+      end
 
-      original_method = memoized_methods[method_name] = instance_method(method_name)
+      method_names.size > 1 ? method_names : method_names.first
+    end
 
-      undef_method method_name
+    def memoized?(method_name)
+      memoized_methods.key?(method_name)
+    end
 
-      define_method method_name do |*args, &block|
-        if block || (condition && !instance_exec(&condition))
-          return original_method.bind(self).call(*args, &block)
-        end
+    private
 
-        method_object_id = original_method.object_id
+    def memoize_method(method_name, condition:, ttl:)
+      original_visibility = Memery.method_visibility(self, method_name)
 
-        store =
-          ((@_memery_memoized_values ||= {})[method_name] ||= {})[method_object_id] ||= {}
+      memoized_methods[method_name] = instance_method(method_name)
 
-        if store.key?(args) && (ttl.nil? || Memery.monotonic_clock <= store[args][:time] + ttl)
-          return store[args][:result]
-        end
+      undef_method method_name
 
-        result = original_method.bind(self).call(*args)
-        @_memery_memoized_values[method_name][method_object_id][args] =
-          { result: result, time: Memery.monotonic_clock }
-        result
-      end
+      define_memoized_method(method_name, condition:, ttl:)
 
       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)
+    def define_memoized_method(method_name, condition:, ttl:)
+      original_method = memoized_methods[method_name]
+
+      define_method method_name do |*args, &block|
+        if block || (condition && !instance_exec(&condition))
+          return original_method.bind_call(self, *args, &block)
+        end
+
+        store = memery_store method_name
+
+        return store[args.hash][:result] if memoized_result_actual?(store, args, ttl: ttl)
+
+        call_original_and_memoize original_method, args, store
+      end
     end
   end
 
   def clear_memery_cache!(*method_names)
+    return unless defined? @_memery_memoized_values
+
     if method_names.any?
       method_names.each { |method_name| @_memery_memoized_values[method_name]&.clear }
-    elsif defined? @_memery_memoized_values
+    else
       @_memery_memoized_values.clear
     end
   end
+
+  private
+
+  def memery_store(method_name)
+    ((@_memery_memoized_values ||= {})[method_name] ||= {})[self.class] ||= {}
+  end
+
+  def memoized_result_actual?(store, args, ttl:)
+    store.key?(args.hash) && (ttl.nil? || Memery.monotonic_clock <= store[args.hash][:time] + ttl)
+  end
+
+  def call_original_and_memoize(original_method, args, store)
+    result = original_method.bind_call(self, *args)
+    store[args.hash] = { result: result, time: Memery.monotonic_clock }
+    result
+  end
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alt_memery
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Yuri Smirnov
 - Alexander Popov
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: module_methods
@@ -25,194 +24,6 @@ dependencies:
     - - "~>"
       - !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`.
@@ -230,8 +41,13 @@ files:
 homepage: https://github.com/AlexWayfer/alt_memery
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  bug_tracker_uri: https://github.com/AlexWayfer/alt_memery/issues
+  changelog_uri: https://github.com/AlexWayfer/alt_memery/blob/v3.0.0/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/alt_memery/3.0.0
+  homepage_uri: https://github.com/AlexWayfer/alt_memery
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/AlexWayfer/alt_memery
 rdoc_options: []
 require_paths:
 - lib
@@ -239,15 +55,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.4'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A gem for memoization.
 test_files: []