memoized 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30eefb403ce7300b9b943f9a6a946c56ac21fe619323ace0c06e63ca11198eab
-  data.tar.gz: 5e0e371e3bb72db04dec7fd23789a4c88f1acfffcf49c898529c5edcd60594a4
+  metadata.gz: 1b5c64274f2f14822e1da8bd04450fcaba727b7dd7310ab704e6d418651df057
+  data.tar.gz: f9afb8a81796f1841a5504eabeeb7a67956fc8c1b14e8e82cf89676c59449378
 SHA512:
-  metadata.gz: 7402174132f312c8e7f45389fd18fcae350aeffc006587c0d20921b4ead346ef794c90634e4c6c367891050edbc6d5c0982a4203e822dc9c3cda9b91dfd9ee76
-  data.tar.gz: 6a0676fcac1c743821fde6b3010d9d53a0792097775593fb41a7c912ca45ddb2ef68276cae9996aa96cc7ee92274c1c62e0e0af2442b02d4d69858442f90e99c
+  metadata.gz: 39b17f38a9ffa32e4d3369e1d2e0f2d5db75e522bc412a63d984e0fffa0c3e17310e6dd7a50094c6554fea1192de13a5b5b290823f26a5ee5af62bc94e2e8911
+  data.tar.gz: 0e8696b57c1dee349ef43b40b1949af22ec3f826dbbf1d0fe8b39ddd7a751ba5ca5b0893335620cb21ef9e1fabf1f9e094c61524b97cd3a3ef0c14f26f3b455b

data/.github/workflows/test.yml

@@ -0,0 +1,38 @@
+---
+name: Tests
+'on':
+  push:
+    branches:
+    - master
+  pull_request:
+    branches:
+    - master
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - ruby: 2.5.3
+          gemfile: Gemfile
+        - ruby: 2.6.7
+          gemfile: Gemfile
+        - ruby: 2.7.3
+          gemfile: Gemfile
+        - ruby: 3.0.1
+          gemfile: Gemfile
+    env:
+      BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "${{ matrix.ruby }}"
+    - name: Bundle
+      run: |
+        gem install bundler:2.2.21
+        bundle install --no-deployment
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -1 +1,3 @@
-.idea
+/.idea
+/pkg
+

data/.ruby-version

@@ -1 +1 @@
-2.6.1
+2.6.7

data/CHANGELOG.md

@@ -0,0 +1,60 @@
+All notable changes to this project will be documented in this file.
+
+This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+
+## Unreleased
+
+### Breaking changes
+
+-
+
+### Compatible changes
+
+-
+
+## 1.1.0 - 2022-03-16
+
+### Breaking changes
+
+- Remove no longer supported ruby versions (2.3.8, 2.4.5)
+
+### Compatible changes
+
+- Activate rubygems MFA
+
+## 1.0.2 - 2019-05-22
+
+### Compatible changes
+
+- Preserve arity of methods with optional arguments
+
+## 1.0.1 - 2019-02-27
+
+### Compatible changes
+
+- Fix meta information in gemspec.
+
+
+## 1.0.0 - 2019-02-27
+
+### Compatible changes
+
+Forked [memoizer](https://github.com/wegowise/memoizer) with two changes:
+
+1. Memoized methods now preserve their [arity](https://apidock.com/ruby/Method/arity). Previously all memoized methods had an arity of `-1`.
+2. Memoized methods are now faster at runtime. This will only be noticable if you call a memoized methods many times in the same request.
+
+We published our fork as a new gem named [memoized](https://rubygems.org/gems/memoized).
+
+memoized is API-compatible to memoizer, you just need to `include Memoized` instead of `Memoizer`:
+
+```ruby
+class A
+  include Memoized
+
+  memoize def hello
+    'hello!'
+  end
+end
+```

data/Gemfile

@@ -1,2 +1,10 @@
 source 'https://rubygems.org'
-gemspec
+
+# Development dependencies
+gem 'rake', '~> 10.4.2'
+gem 'rspec', '~> 3.5.0'
+gem 'timecop', '~> 0.8.0'
+gem 'gemika'
+
+# Gem under test
+gem 'memoized', :path => '.'

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    memoized (1.0.3)
+    memoized (1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
+    gemika (0.7.1)
     rake (10.4.2)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -27,10 +28,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  gemika
   memoized!
   rake (~> 10.4.2)
   rspec (~> 3.5.0)
   timecop (~> 0.8.0)
 
 BUNDLED WITH
-   1.17.2
+   2.2.21

data/README.md

@@ -1,6 +1,4 @@
-[![Build Status](https://travis-ci.org/makandra/memoized.svg?branch=master)](https://travis-ci.org/makandra/memoized)
-
-# Memoized
+# Memoized [![Tests](https://github.com/makandra/memoized/workflows/Tests/badge.svg)](https://github.com/makandra/memoized/actions)
 
 Memoized will memoize the results of your methods. It acts much like
 `ActiveSupport::Memoizable` without all of that freezing business. The API for
@@ -14,7 +12,7 @@ $ gem install memoized
 
 ## Usage
 
-To define a memoized instance method, use `memoized def``:
+To define a memoized instance method, use `memoize def`:
 
 ```ruby
 class A
@@ -78,6 +76,64 @@ instance.goodbye        # the goodbye method is now memoized
 instance.unmemoize_all  # neither hello nor goodbye are memoized anymore
 ```
 
+## Limitations
+
+When you are using Memoized with default arguments or default keyword arguments, there are some edge cased you have to
+keep in mind.
+
+When you memoize a method with (keyword) arguments that have an expression as default value, you should be aware
+that the expression is evaluated only once.
+
+```ruby
+memoize def print_time(time = Time.now)
+  time
+end
+
+print_time
+=> 2021-07-23 14:23:18 +0200
+
+sleep(1.minute)
+print_time
+=> 2021-07-23 14:23:18 +0200
+```
+
+When you memoize a method with (keyword) arguments that have default values, you should be aware that Memoized
+differentiates between a method call without arguments and the default values.
+
+```ruby
+def true_or_false(default = true)
+  puts 'calculate value ...'
+  default
+end
+
+true_or_false
+calculate value ...
+=> true
+
+true_or_false
+=> true
+
+true_or_false(true)
+calculate value ...
+=> true
+```
+
+## Development
+
+There are tests in `spec`. We only accept PRs with tests. To run tests:
+
+- Install Ruby 2.6.1
+- Install development dependencies using `bundle install`
+- Run tests using `bundle exec rake current_rspec`
+
+We recommend to test large changes against multiple versions of Ruby. Supported combinations are configured in `.github/workflows/test.yml`. We provide some rake tasks to help with this:
+
+- Install development dependencies using `bundle exec rake matrix:install`
+- Run tests using `bundle exec rake matrix:spec`
+
+Note that we have configured GitHub Actions to automatically run tests in all supported Ruby versions and dependency sets after each push. We will only merge pull requests after a green GitHub Actions run.
+
+I'm very eager to keep this gem leightweight and on topic. If you're unsure whether a change would make it into the gem, [talk to me beforehand](mailto:henning.koch@makandra.de).
 
 ## License
 

data/Rakefile

@@ -1,2 +1,10 @@
 require 'rake'
 require 'bundler/gem_tasks'
+
+begin
+  require 'gemika/tasks'
+rescue LoadError
+  puts 'Run `gem install gemika` for additional tasks'
+end
+
+task :default => 'matrix:spec'

data/lib/memoized/version.rb

@@ -1,3 +1,3 @@
 module Memoized
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/memoized.rb

@@ -22,8 +22,7 @@ module Memoized
 
         arity = instance_method(unmemoized_method).arity
 
-        case arity
-        when 0
+        if arity == 0
           module_eval(<<-RUBY)
             def #{method_name}()
               #{memoized_ivar_name} ||= [#{unmemoized_method}()]
@@ -31,7 +30,7 @@ module Memoized
             end
           RUBY
 
-        when -1
+        elsif arity == -1
           module_eval(<<-RUBY)
             def #{method_name}(*args)
               #{memoized_ivar_name} ||= {}
@@ -43,18 +42,36 @@ module Memoized
             end
           RUBY
 
-        else
-          arg_names = (0..(arity - 1)).map { |i| "arg#{i}" }
+        elsif arity < -1
+          # For Ruby methods that take a variable number of arguments,
+          # Method#arity returns -n-1, where n is the number of required arguments
+          required_arg_names = (1..(-arity - 1)).map { |i| "arg#{i}" }
+          required_args_ruby = required_arg_names.join(', ')
+
+          module_eval(<<-RUBY)
+            def #{method_name}(#{required_args_ruby}, *optional_args)
+              all_args = [#{required_args_ruby}, *optional_args]
+              #{memoized_ivar_name} ||= {}
+              if #{memoized_ivar_name}.has_key?(all_args)
+                #{memoized_ivar_name}[all_args]
+              else
+                #{memoized_ivar_name}[all_args] = #{unmemoized_method}(*all_args)
+              end
+            end
+          RUBY
+
+        else # positive arity
+          arg_names = (1..arity).map { |i| "arg#{i}" }
           args_ruby = arg_names.join(', ')
 
           module_eval(<<-RUBY)
             def #{method_name}(#{args_ruby})
-              args = [#{args_ruby}]
+              all_args = [#{args_ruby}]
               #{memoized_ivar_name} ||= {}
-              if #{memoized_ivar_name}.has_key?(args)
-                #{memoized_ivar_name}[args]
+              if #{memoized_ivar_name}.has_key?(all_args)
+                #{memoized_ivar_name}[all_args]
               else
-                #{memoized_ivar_name}[args] = #{unmemoized_method}(#{args_ruby})
+                #{memoized_ivar_name}[all_args] = #{unmemoized_method}(#{args_ruby})
               end
             end
           RUBY

data/memoized.gemspec

@@ -5,9 +5,15 @@ Gem::Specification.new do |s|
   s.name        = "memoized"
   s.version     = Memoized::VERSION
   s.authors     = ["Barun Singh", "Henning Koch"]
-  s.homepage    = "https://github.com/makandra/memoizer"
+  s.homepage    = "https://github.com/makandra/memoized"
   s.summary     = "Memoized caches the results of your method calls"
   s.description = s.summary
+  s.metadata    = {
+    'source_code_uri' => s.homepage,
+    'bug_tracker_uri' => 'https://github.com/makandra/memoized/issues',
+    'changelog_uri' => 'https://github.com/makandra/memoized/blob/master/CHANGELOG.md',
+    'rubygems_mfa_required' => 'true',
+  }
 
   s.files         = `git ls-files`.split("\n").reject { |path| File.lstat(path).symlink? }
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n").reject { |path| File.lstat(path).symlink? }

data/spec/memoized_spec.rb

@@ -145,6 +145,48 @@ describe Memoized do
 
     end
 
+    context 'for methods with a required and an optional arg' do
+
+      class ArityRequiredAndOptional < MemoizedSpecClass
+        def foo(a, b = 'default')
+          return [a, b]
+        end
+
+        memoize :foo
+      end
+
+      it 'creates a memoized method with a arity of -2' do
+        expect(ArityRequiredAndOptional.instance_method(:foo).arity).to eq(-2)
+      end
+
+      it "preserves the optional arg's default value" do
+        instance = ArityRequiredAndOptional.new
+        expect(instance.foo('foo')).to eq ['foo', 'default']
+      end
+
+    end
+
+    context 'for methods with a required arg and splat args' do
+
+      class ArityArgAndOptional < MemoizedSpecClass
+        def foo(a, *args)
+          return [a, args]
+        end
+
+        memoize :foo
+      end
+
+      it 'creates a memoized method with a arity of -2' do
+        expect(ArityArgAndOptional.instance_method(:foo).arity).to eq(-2)
+      end
+
+      it "passes the splat args to the memoized method" do
+        instance = ArityArgAndOptional.new
+        expect(instance.foo('foo', 'bar', 'baz')).to eq ['foo', ['bar', 'baz']]
+      end
+
+    end
+
   end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memoized
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Barun Singh
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-27 00:00:00.000000000 Z
+date: 2022-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -59,11 +59,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
-- CHANGELOG.txt
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -74,10 +74,14 @@ files:
 - memoized.gemspec
 - spec/memoized_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/makandra/memoizer
+homepage: https://github.com/makandra/memoized
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/makandra/memoized
+  bug_tracker_uri: https://github.com/makandra/memoized/issues
+  changelog_uri: https://github.com/makandra/memoized/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -93,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.2.21
 signing_key: 
 specification_version: 4
 summary: Memoized caches the results of your method calls

data/.travis.yml

@@ -1,26 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.1.8
-  - 2.3.8
-  - 2.4.5
-  - 2.5.3
-  - 2.6.1
-
-gemfile:
-  - Gemfile
-
-script: bundle exec rspec spec
-
-sudo: false
-
-cache: bundler
-
-notifications:
-  email:
-    - fail@makandra.de
-
-install:
-  # Replace default Travis CI bundler script with a version that doesn't
-  # explode when lockfile doesn't match recently bumped version
-  - bundle install --no-deployment --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}

data/CHANGELOG.txt

@@ -1,4 +0,0 @@
-== 1.0.1
-* Bump version to avoid conflict with old memoizer gem
-== 1.0.0
-* Initial release