memoized 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 794d162ed40844f311ed29ff37885d44930b416467b9fa9c49adb77646f6f44b
-  data.tar.gz: 59dcbf3a4cd03d2f0ed4bcab509758dd59a9fccdf0fe85999b325e18cb0d2948
+  metadata.gz: 1b5c64274f2f14822e1da8bd04450fcaba727b7dd7310ab704e6d418651df057
+  data.tar.gz: f9afb8a81796f1841a5504eabeeb7a67956fc8c1b14e8e82cf89676c59449378
 SHA512:
-  metadata.gz: bd346b36f77cca85aa9cf29bb20d4d1f0f5358d409138a087be59675ba07dc65003d69d654c3901b3aaf97de14812a65356e1cb44e8cec5ffbebd45039266537
-  data.tar.gz: cc3d756d28efbeb07ca0ae2510fc46b077b59c1b8945f4752dd9f410105c6e4cbbe566d6a0b67c62772ae8ad5b3cddfa2ca821ba1bea8ae5be023ee165da4393
+  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/.ruby-version

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

data/CHANGELOG.md

@@ -13,6 +13,21 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 -
 
+## 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
 

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.1)
+    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.2'
+  VERSION = '1.1.0'
 end

data/memoized.gemspec

@@ -8,6 +8,12 @@ Gem::Specification.new do |s|
   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? }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memoized
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Barun Singh
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2022-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -59,10 +59,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -77,7 +77,11 @@ files:
 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}