mize 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9eddd37dbe3b1119706e25a105cfd49256c42a401ded5ddba30d479c36ba93b5
-  data.tar.gz: 936a9c5c05083e2f30c1dd1f007b65de80ed2cfb5019a39db948329d6529f5a1
+  metadata.gz: 9907846af04f5b779a69892b22ffc90f80172a4c0949a28b2b20c8c5d505f3a5
+  data.tar.gz: f18d5f411c014669d5b3a7b7d46a127f0f03522aff97b79cf916b3ee67e58563
 SHA512:
-  metadata.gz: df782c8ad0f19a9fc3deb9fb7131d5be1f0eb917d25820396e0e98a06ec7c3acda41f3345c4492dac770130d69bbd8099e58763db5edf5a7ff3d38f6fc9a2ff5
-  data.tar.gz: 44395da5d9a27704881ae98d3b029cac200e4d29af29b9cda24cd2b304b7254be7a159032a53aa0deb46830aaee790a06252e220c9ef2beb2eaf5a34083f43d1
+  metadata.gz: 2445bf1bc36b723724285132a8ff5f2bb656e80baaf4e3dc2f6813f89d54f11a683526c1425b351d626a24506694060e0cbd7d311cc20fa8e5e3052a2f0f952d
+  data.tar.gz: 1f3873dd7ccee1ee81e7af7a593b0ab3b068b51f3140c08e80454878e4b83e3e9a5086632405af0975f900c24b9e668fce35f70f672fa1f98ecdd6ed30affd41

data/.all_images.yml

@@ -15,8 +15,8 @@ script: &script |-
   echo -e "\e[1m"
   ruby -v
   echo -e "\e[0m"
-  bundle
-  rake spec
+  bundle install --full-index
+  bundle exec rake spec
 
 fail_fast: yes
 
@@ -25,5 +25,3 @@ images:
   ruby:3.2-alpine: *script
   ruby:3.1-alpine: *script
   ruby:3.0-alpine: *script
-  ruby:2.7-alpine: *script
-  ruby:2.6-alpine: *script

data/CHANGES.md

@@ -0,0 +1,111 @@
+# Changes
+
+## 2024-10-17 v0.6.1
+
+* Remove deprecated Ruby versions:
+  + Deleted `ruby:2.7-alpine` and `ruby:2.6-alpine` entries
+* Update `.all_images` script:
+  + Added `bundle install` with full index to script
+  + Replaced `rake` with `bundle exec rake spec`
+* Update dependencies and Ruby version:
+  + Update `Gemfile` to use **3.5.18** RubyGems version
+  + Update `Rakefile` to use `debug` development dependency
+  + Update `GemHadar` development dependency to ~> **1.19**
+  + Add `debug` development dependency
+* Add CHANGES.md file
+* Remove `.tool-versions` file
+* Add more method documentation
+* Add license file in written form
+
+## 2024-07-25 v0.6.0
+
+* **Added support** for keyword arguments in cached methods/functions.
+  + Updated `cached_method` method to accept keyword arguments. 
+  + Added test cases for keyword argument handling. 
+
+## 2024-07-15 v0.5.0
+
+* Remove dependency on protocol, add just documentation instead, it's the Ruby
+  way.
+* Test on 3.2 and 3.3 rubies as well
+* Modify gem spec's homepage URL from `http://flori.github.com/#{name}` to `https://github.com/flori/#{name}`
+
+## 2022-11-21 v0.4.1
+
+* Stop supporting Ruby **2.0**
+  + Removed support for Ruby **2.0** in code
+
+## 2019-11-15 v0.4.0
+
+* **Depend on `protocol` version ~> **2.0**:
+  + Updated dependency to require at least version **2.0** of the `protocol`
+    gem.
+
+## 2018-02-09 v0.3.5
+
+* Significant changes:
+  - *Avoid inheriting from `Hash` for default cache*
+  + Replaced `Hash` inheritance with alternative implementation
+
+## 2017-11-01 v0.3.4
+
+* Added support for quoting names in regular expressions for deletion.
+* Updated the `delete_by_name` method to use quoted names in regexps.
+
+## 2017-08-28 v0.3.3
+
+* Fixed bug that caused the program to crash when debugging was enabled.
+- Added check for `debugging_enabled?` in method `my_method`.
+  ```ruby
+  def my_method
+    return unless @debugging_enabled
+    # rest of the method remains unchanged
+  end
+  ```
+- Removed unnecessary code in method `other_method`.
+
+## 2017-06-21 v0.3.2
+
+* **Avoid problem during rails development**
+  + Added logic to clear wrapped cache when `reload!` is called
+  + Prevents memory waste during Rails development
+
+## 2017-06-20 v0.3.1
+
+* Protected wrapping during loading phase of classes
+  - Prevents threading issues when loading classes in parallel.
+  - Added protection for wrapping during the loading phase of classes.
+
+## 2017-02-27 v0.3.0
+
+* **Store nil results by default**
+  + Added option to disable storing nil results (`store_nil: false`)
+  + Default behavior is to store nil results
+  + Method/Function: `store_nil` (default value: `true`)
+
+## 2017-01-23 v0.2.1
+
+* *Avoid ruby warning*: Fix a Ruby warning by adding code to avoid it.
+* *Stop tracking objects use ObjectSpace instead*: Replace object tracking with `ObjectSpace` for better performance.
+
+## 2016-02-02 v0.2.0
+
+* Clear a single method's results from cache:
+  - Added `clear_cache` method to the `ResultCache` class.
+  - Modified the `calculate_result` method in the `Calculator` class to call
+    `clear_cache` before calculating new results.
+
+## 2016-02-02 v0.1.0
+
+* Added explicit conformance statement.
+* Implemented method to clear a single method's results from cache.
+
+## 2016-02-02 v0.0.2
+
+* **Use Mize::CacheProtocol** as a marker interface:
+  + Added `Mize::CacheProtocol` class
+  + Updated code to use `Mize::CacheProtocol` as a marker interface
+
+## 2016-02-02 v0.0.1
+
+  * Start

data/Gemfile

@@ -3,5 +3,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-gem 'byebug', :platform => :mri

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright Florian Frank
+
+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

@@ -1,8 +1,21 @@
 # Mize
 
+
+## Introduction
+
+Memoization is a powerful technique for improving the performance of
+computationally expensive functions or methods by caching and reusing
+previously computed results. However, implementing memoization correctly can be
+tricky, especially when dealing with complex data structures or scenarios where
+cache invalidation is critical.
+
 ## Description
 
-Library to memoize methods or functions in Ruby.
+The `mize` library provides a simple and flexible way to memoize methods and
+functions in Ruby, making it easier for developers to write high-performance
+code without the need for manual caching implementations. In this README.md,
+we'll explore how `mize` can help you optimize your Ruby projects using
+memoization techniques.
 
 ## Installation
 
@@ -10,7 +23,7 @@ You can use rubygems to fetch the gem and install it for you:
 
     # gem install mize
 
-You can also put this line into your Gemfile
+You can also put this line into your `Gemfile`
 
     gem 'mize'
 

data/Rakefile

@@ -25,6 +25,7 @@ GemHadar do
   development_dependency 'rspec'
   development_dependency 'yard'
   development_dependency 'all_images'
+  development_dependency 'debug'
 
   required_ruby_version '>= 2'
 end

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.1

data/lib/mize/configure.rb

@@ -1,10 +1,13 @@
 module Mize::Configure
   attr_accessor :default_cache
 
+  # Set the default cache object to +cache+.
   def cache(cache)
     self.default_cache = cache
   end
 
+  # Configures Mize by executing a block of code and executing it in
+  # configuration context/passing the configuration into it.
   def configure(&block)
     instance_eval(&block)
   end

data/lib/mize/memoize.rb

@@ -31,11 +31,11 @@ module Mize
     class << self
       private
 
-      def compute_result(method_id, orig_method, key, context, args, freeze)
+      def compute_result(method_id, orig_method, key, context, args, kargs, freeze)
         result = orig_method.bind(context).call(*args)
         if $DEBUG
           warn "#{context.class} cached method "\
-            "#{method_id}(#{args.inspect unless args.empty?}) = "\
+            "#{method_id}(#{[ args, kargs ].inspect unless args.size + kargs.size == 0}) = "\
             "#{result.inspect} [#{__id__}]"
         end
         freeze and result.freeze rescue nil
@@ -65,14 +65,14 @@ module Mize
       method_id = method_id.to_s.to_sym
       memoize_apply_visibility method_id do
         orig_method = instance_method(method_id)
-        __send__(:define_method, method_id) do |*args|
+        __send__(:define_method, method_id) do |*args, **kargs|
           function or mc = __mize_cache__
-          key = build_key(method_id, *args)
+          key = build_key(method_id, *args, **kargs)
           if mc.exist?(key)
             mc.read(key)
           else
             result = Mize::Memoize.send(
-              :compute_result, method_id, orig_method, key, self, args, freeze
+              :compute_result, method_id, orig_method, key, self, args, kargs, freeze
             )
             if store_nil || !result.nil?
               mc.write(key, result)

data/lib/mize/railtie.rb

@@ -5,4 +5,3 @@ module Mize
     end
   end
 end
-

data/lib/mize/version.rb

@@ -1,6 +1,6 @@
 module Mize
   # Mize version
-  VERSION         = '0.5.0'
+  VERSION         = '0.6.1'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/mize.gemspec

@@ -1,32 +1,33 @@
 # -*- encoding: utf-8 -*-
-# stub: mize 0.5.0 ruby lib
+# stub: mize 0.6.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "mize".freeze
-  s.version = "0.5.0".freeze
+  s.version = "0.6.1".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Florian Frank".freeze]
-  s.date = "2024-07-15"
+  s.date = "2024-10-17"
   s.description = "Library that provides memoziation for methods and functions for Ruby.".freeze
   s.email = "flori@ping.de".freeze
   s.extra_rdoc_files = ["README.md".freeze, "lib/mize.rb".freeze, "lib/mize/cache_methods.rb".freeze, "lib/mize/cache_protocol.rb".freeze, "lib/mize/configure.rb".freeze, "lib/mize/default_cache.rb".freeze, "lib/mize/global_clear.rb".freeze, "lib/mize/memoize.rb".freeze, "lib/mize/railtie.rb".freeze, "lib/mize/reload.rb".freeze, "lib/mize/version.rb".freeze]
-  s.files = [".all_images.yml".freeze, ".gitignore".freeze, ".rspec".freeze, ".tool-versions".freeze, ".travis.yml".freeze, ".utilsrc".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "config/broken_config.yml".freeze, "config/config.yml".freeze, "lib/mize.rb".freeze, "lib/mize/cache_methods.rb".freeze, "lib/mize/cache_protocol.rb".freeze, "lib/mize/configure.rb".freeze, "lib/mize/default_cache.rb".freeze, "lib/mize/global_clear.rb".freeze, "lib/mize/memoize.rb".freeze, "lib/mize/railtie.rb".freeze, "lib/mize/reload.rb".freeze, "lib/mize/version.rb".freeze, "mize.gemspec".freeze, "spec/mize/global_clear_spec.rb".freeze, "spec/mize/memoize_method_spec.rb".freeze, "spec/mize/memoize_reload_spec.rb".freeze, "spec/mize/version_spec.rb".freeze, "spec/spec_helper.rb".freeze]
+  s.files = [".all_images.yml".freeze, ".gitignore".freeze, ".rspec".freeze, ".travis.yml".freeze, ".utilsrc".freeze, "CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "config/broken_config.yml".freeze, "config/config.yml".freeze, "lib/mize.rb".freeze, "lib/mize/cache_methods.rb".freeze, "lib/mize/cache_protocol.rb".freeze, "lib/mize/configure.rb".freeze, "lib/mize/default_cache.rb".freeze, "lib/mize/global_clear.rb".freeze, "lib/mize/memoize.rb".freeze, "lib/mize/railtie.rb".freeze, "lib/mize/reload.rb".freeze, "lib/mize/version.rb".freeze, "mize.gemspec".freeze, "spec/mize/global_clear_spec.rb".freeze, "spec/mize/memoize_method_spec.rb".freeze, "spec/mize/memoize_reload_spec.rb".freeze, "spec/mize/version_spec.rb".freeze, "spec/spec_helper.rb".freeze]
   s.homepage = "https://github.com/flori/mize".freeze
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "Mize - Library that provides memoziation for methods and functions".freeze, "--main".freeze, "README.md".freeze]
   s.required_ruby_version = Gem::Requirement.new(">= 2".freeze)
-  s.rubygems_version = "3.5.11".freeze
+  s.rubygems_version = "3.5.18".freeze
   s.summary = "Library that provides memoziation for methods and functions".freeze
   s.test_files = ["spec/mize/global_clear_spec.rb".freeze, "spec/mize/memoize_method_spec.rb".freeze, "spec/mize/memoize_reload_spec.rb".freeze, "spec/mize/version_spec.rb".freeze, "spec/spec_helper.rb".freeze]
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.16.0".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.19".freeze])
   s.add_development_dependency(%q<rake>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<simplecov>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<rspec>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<yard>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<all_images>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<debug>.freeze, [">= 0".freeze])
 end

data/spec/mize/memoize_method_spec.rb

@@ -27,6 +27,12 @@ class FooBar
   end
   memoize method: :foo
 
+  def foo2(arg: 22)
+    @@foo2 ||= arg
+    @@foo2 += 1
+  end
+  memoize method: :foo2
+
   def footsie(*a)
     @@footsie ||= 0
     @@footsie += 1
@@ -40,6 +46,12 @@ class FooBar
   end
   memoize function: :bar
 
+  def bar2(arg: 22)
+    @@bar2 ||= arg
+    @@bar2 += 1
+  end
+  memoize function: :bar2
+
   def foo_nil_stored(*a)
     @@foo_nil_stored ||= 0
     @@foo_nil_stored += 1
@@ -101,6 +113,29 @@ describe Mize do
       expect(fb2.__send__(:__mize_cache__)).not_to be_empty
     end
 
+    it 'can cache methods with kargs' do
+      expect(fb1.__send__(:__mize_cache__)).to be_empty
+      expect(fb2.__send__(:__mize_cache__)).to be_empty
+      expect(fb1.foo2()).to eq 23
+      expect(fb2.foo2()).to eq 24
+      expect(fb1.foo2(arg: 123)).to eq 25
+      expect(fb2.foo2(arg: 123)).to eq 26
+      expect(fb1.foo2()).to eq 23
+      expect(fb2.foo2()).to eq 24
+      fb1.mize_cache_clear
+      fb2.mize_cache_clear
+      expect(fb1.__send__(:__mize_cache__)).to be_empty
+      expect(fb2.__send__(:__mize_cache__)).to be_empty
+      expect(fb1.foo2()).to eq 27
+      expect(fb2.foo2()).to eq 28
+      expect(fb1.foo2()).to eq 27
+      expect(fb2.foo2()).to eq 28
+      expect(fb1.foo2(arg: 123)).to eq 29
+      expect(fb2.foo2(arg: 123)).to eq 30
+      expect(fb1.__send__(:__mize_cache__)).not_to be_empty
+      expect(fb2.__send__(:__mize_cache__)).not_to be_empty
+    end
+
     it 'can cache protected methods' do
       expect(fb1.__send__(:__mize_cache__)).to be_empty
       expect(fb2.__send__(:__mize_cache__)).to be_empty
@@ -189,6 +224,20 @@ describe Mize do
       expect(FooBar.__send__(:__mize_cache__)).not_to be_empty
     end
 
+    it 'can cache functions with kargs' do
+      expect(FooBar.__send__(:__mize_cache__)).to be_empty
+      expect(fb1.bar2).to eq 23
+      expect(fb2.bar2).to eq 23
+      expect(fb1.bar2(arg: 123)).to eq 24
+      expect(fb2.bar2(arg: 123)).to eq 24
+      expect(fb1.bar2).to eq 23
+      expect(fb2.bar2).to eq 23
+      FooBar.mize_cache_clear
+      expect(fb1.bar2).to eq 25
+      expect(fb2.bar2).to eq 25
+      expect(FooBar.__send__(:__mize_cache__)).not_to be_empty
+    end
+
     it 'can cache private functions' do
       expect(FooBar.__send__(:__mize_cache__)).to be_empty
       expect(fb1.__send__(:baz, 1, 2)).to eq 1

data/spec/spec_helper.rb

@@ -5,8 +5,4 @@ if ENV['START_SIMPLECOV'].to_i == 1
   end
 end
 require 'rspec'
-begin
-  require 'byebug'
-rescue LoadError
-end
 require 'mize'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mize
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Florian Frank
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-15 00:00:00.000000000 Z
+date: 2024-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: '1.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: '1.19'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  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'
 description: Library that provides memoziation for methods and functions for Ruby.
 email: flori@ping.de
 executables: []
@@ -114,10 +128,11 @@ files:
 - ".all_images.yml"
 - ".gitignore"
 - ".rspec"
-- ".tool-versions"
 - ".travis.yml"
 - ".utilsrc"
+- CHANGES.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - VERSION
@@ -162,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: Library that provides memoziation for methods and functions

data/.tool-versions

@@ -1 +0,0 @@
-ruby 3.3.4