mize 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6801c5af1f329caa1ee938a76571ce85883bb6de8f6084c3bde227923136e88
-  data.tar.gz: 32a2c0ac847bfbcdb23f0758dfa4f7c416fbadfa771bf1fbe6e0b47dd6e06200
+  metadata.gz: 517d9cb2997631d2645b96f8c54c2b9390370146aa1164f6c4acdf36ec99475a
+  data.tar.gz: e9a36341149d75c25156496b2a4a630ad561aaa620dd2428ecce38cb33786cea
 SHA512:
-  metadata.gz: 8c88a8042b29f17f2ba1399d455d8d3c9faa38ff64790feea6cccb03751926e69661241f1ddf1223f8414f77c1296503fbda7849c4d932759c2348fe337ec244
-  data.tar.gz: 8f2c43358d0e21aead7e762745c58e22d2cf3e4f53da1f512a1b4f23bfb989db1166969b7e1aea347445d0fb22849e5c4da896c1af3e8d55417552a120ce85a1
+  metadata.gz: 1a9c6cca1a2bbc599b153c8cdcb8b6fdfe80cadd591d269d7e6a70db666edec61651fc61f18e0e9b24d61a4cfc0489b096844eec3cf29c3ce3bee5d7c89c11cc
+  data.tar.gz: '058e70026c3535d00bcaecd775e17c04bfcb0cf70c836f88624080f79668ed79b0201b6b7e5bf5f76d33d5e3a2b20d8bee27e5dd6e252a6db76a75f15e3581a8'

data/.all_images.yml

@@ -1,23 +1,29 @@
 dockerfile: |-
-  RUN apk add --no-cache build-base git
-  RUN gem update --system
-  RUN gem install gem_hadar bundler
+  RUN apk add --no-cache build-base git bash
+  RUN bash <<NUR
+    if [[ "$(ruby -e 'print RUBY_VERSION')" > '3' ]]
+    then
+      gem update --system
+      gem install gem_hadar bundler
+    else
+      gem install gem_hadar
+      gem install bundler -v 2.4.22
+    fi
+  NUR
 
 script: &script |-
   echo -e "\e[1m"
   ruby -v
   echo -e "\e[0m"
-  bundle update
   bundle
-  bundle exec rake spec
+  rake spec
 
 fail_fast: yes
 
 images:
+  ruby:3.3-alpine: *script
+  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
-  ruby:2.5-alpine: *script
-  ruby:2.4-alpine: *script
-  ruby:2.3-alpine: *script

data/.gitignore

@@ -5,6 +5,8 @@
 .yard*
 Gemfile.lock
 coverage
+doc
 errors.lst
 pkg
 tags
+yard

data/.tool-versions

@@ -1 +1 @@
-ruby 3.1.2
+ruby 3.3.4

data/.utilsrc

@@ -1,12 +1,12 @@
 # vim: set ft=ruby:
 
 search do
-  prune_dirs /\A(\.svn|\.git|CVS|tmp|tags|coverage|pkg)\z/
+  prune_dirs /\A(\.svn|\.git|CVS|tmp|tags|coverage|doc|pkg)\z/
   skip_files /(\A\.|\.sw[pon]\z|\.(log|fnm|jpg|jpeg|png|pdf|svg)\z|tags|~\z)/i
 end
 
 discover do
-  prune_dirs /\A(\.svn|\.git|CVS|tmp|tags|coverage|pkg)\z/
+  prune_dirs /\A(\.svn|\.git|CVS|tmp|tags|coverage|doc|pkg)\z/
   skip_files /(\A\.|\.sw[pon]\z|\.log\z|~\z)/
   binary false
 end

data/README.md

@@ -2,7 +2,7 @@
 
 ## Description
 
-TODO
+Library to memoize methods or functions in Ruby.
 
 ## Installation
 
@@ -18,7 +18,52 @@ and bundle.
 
 ## Usage
 
-TODO
+Memoizes methods, that is the values depend on the receiver, like this:
+
+```
+class A
+  @@c = 0
+
+  memoize method:
+  def foo(x)
+    "foo #{x} #{@@c += 1}"
+  end
+end
+
+a1 = A.new
+a1.foo(23) # => "foo 23 1"
+a1.foo(23) # => "foo 23 1"
+a2 = A.new
+a2.foo(23) # => "foo 23 2"
+a2.foo(23) # => "foo 23 2"
+a2.mize_cache_clear
+a2.foo(23) # => "foo 23 3"
+a1.foo(23) # => "foo 23 1"
+```
+
+Memoizes functions, that is the values do not depend on the receiver, like
+this:
+
+```
+class B
+  @@c = 0
+
+  memoize function:
+  def foo(x)
+    "foo #{x} #{@@c += 1}"
+  end
+end
+
+b1 = B.new
+b1.foo(23) # => "foo 23 1"
+b1.foo(23) # => "foo 23 1"
+b2 = B.new
+b2.foo(23) # => "foo 23 1"
+b2.foo(23) # => "foo 23 1"
+B.mize_cache_clear
+b2.foo(23) # => "foo 23 2"
+b1.foo(23) # => "foo 23 2"
+```
 
 ## Download
 

data/Rakefile

@@ -6,18 +6,20 @@ GemHadar do
   name        'mize'
   author      'Florian Frank'
   email       'flori@ping.de'
-  homepage    "http://flori.github.com/#{name}"
+  homepage    "https://github.com/flori/#{name}"
   summary     'Library that provides memoziation for methods and functions'
   description "#{summary} for Ruby."
   readme      'README.md'
   licenses << 'MIT'
 
   test_dir    'spec'
+  yard_dir    'doc'
+
   ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', 'coverage', '.rvmrc',
-    '.AppleDouble', 'tags', '.byebug_history', '.yard*', 'errors.lst'
+    '.AppleDouble', 'tags', '.byebug_history', '.yard*', 'yard', 'doc',
+    'errors.lst'
 
 
-  dependency 'protocol', '~> 2.0'
   development_dependency 'rake'
   development_dependency 'simplecov'
   development_dependency 'rspec'
@@ -27,29 +29,4 @@ GemHadar do
   required_ruby_version '>= 2'
 end
 
-namespace :yard do
-  require 'pathname'
-
-  yard_dir = Pathname.new('yard')
-
-  desc 'Create yard documentation'
-  task :create do
-    sh 'yardoc'
-  end
-
-  desc 'View the yard documentation'
-  task :view do
-    index_file = yard_dir + 'index.html'
-    File.exist?(index_file)
-    sh "open #{index_file}"
-  end
-
-  desc 'Clean the yard documentation'
-  task :clean do
-    rm_rf yard_dir
-  end
-end
-
-task :yard => %i[ yard:create yard:view ]
-
 task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.6.0

data/lib/mize/cache_methods.rb

@@ -21,7 +21,6 @@ module Mize::CacheMethods
 
   # Set the cache object to +cache+.
   def __mize_cache__=(cache)
-    Mize::CacheProtocol =~ cache
     @__mize_cache__ = cache
   end
 

data/lib/mize/cache_protocol.rb

@@ -1,32 +1,2 @@
-require 'protocol'
-
-# The protocol the cache object has to conform to. This is a minimal subset of
-# the ActiveSupport::Cache::Store protocol.
-Mize::CacheProtocol = Protocol do
-  # Clear the entire cache.
-  def clear(options = nil)
-  end
-
-  # Returns true if the cache contains an entry for the given key.
-  def exist?(name, options = nil)
-  end
-
-  # Fetches data from the cache, using the given key. If there is data in the
-  # cache with the given key, then that data is returned. Otherwise, nil is
-  # returned.
-  def read(name, options = nil)
-  end
-
-  # Writes the value to the cache, with the key.
-  def write(name, value, options = nil)
-  end
-
-  # Iterate over all cache entries and yield to their names.
-  def each_name(&block)
-  end
-
-  # Return another cache instance that was correctly configured.
-  def prototype
-    dup
-  end
+module Mize::CacheProtocol
 end

data/lib/mize/default_cache.rb

@@ -1,44 +1,68 @@
 require 'monitor'
 
 class Mize::DefaultCache
+  include Mize::CacheProtocol
   include MonitorMixin
 
   def initialize
     @data = {}
   end
 
+  # Clear the cache by removing all entries from the cache
   def clear(options = nil)
     @data.clear
     self
   end
 
+  # Determine whether a cache entry exists in this cache.
+  #
+  # @param name [String] The name of the cache entry to check.
+  # @return [Boolean] Whether or not the cache entry exists.
   def exist?(name, options = nil)
     @data.key?(name)
   end
 
+  # Read a value from the cache by name. If the entry does not exist in the
+  # cache, it will return nil.
+  #
+  # @param name [String] The name of the cache entry to read.
+  # @return [Object] The value stored in the cache for the given name.
   def read(name, options = nil)
     @data.fetch(name, nil)
   end
 
+  # Write a value to the cache by name. If an entry with the same name already
+  # exists in the cache, it will be overwritten.
+  #
+  # @param name [String] The name of the cache entry to write.
+  # @param value [Object] The value to store in the cache for the given name.
+  # @return [Object] The value stored in the chache.
   def write(name, value, options = nil)
     @data.store(name, value)
   end
 
+  # Delete a cache entry by name. If the entry does not exist in the cache, it
+  # will do nothing.
+  #
+  # @param name [String] The name of the cache entry to delete.
+  # @return [Object] The value stored in the chache before deletion.
   def delete(name, options = nil)
     @data.delete(name)
   end
 
+  # Each name of the cache is yielded to the block.
+  # @return [self]
   def each_name(&block)
     @data.each_key(&block)
     self
   end
 
+  # Initialize a duplicate of this cache.
+  # @param other [Mize::DefaultCache] The other cache to initialize a duplicate of.
   def initialize_dup(other)
     super
     other.instance_variable_set :@data, @data.dup
   end
 
   alias prototype dup
-
-  conform_to Mize::CacheProtocol
 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.4.1'
+  VERSION         = '0.6.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/mize.gemspec

@@ -1,45 +1,32 @@
 # -*- encoding: utf-8 -*-
-# stub: mize 0.4.1 ruby lib
+# stub: mize 0.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "mize".freeze
-  s.version = "0.4.1"
+  s.version = "0.6.0".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 = "2022-11-21"
+  s.date = "2024-07-25"
   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.homepage = "http://flori.github.com/mize".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.3.17".freeze
+  s.rubygems_version = "3.5.16".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]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-  end
+  s.specification_version = 4
 
-  if s.respond_to? :add_runtime_dependency then
-    s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.12.0"])
-    s.add_development_dependency(%q<rake>.freeze, [">= 0"])
-    s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
-    s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
-    s.add_development_dependency(%q<yard>.freeze, [">= 0"])
-    s.add_development_dependency(%q<all_images>.freeze, [">= 0"])
-    s.add_runtime_dependency(%q<protocol>.freeze, ["~> 2.0"])
-  else
-    s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.12.0"])
-    s.add_dependency(%q<rake>.freeze, [">= 0"])
-    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
-    s.add_dependency(%q<rspec>.freeze, [">= 0"])
-    s.add_dependency(%q<yard>.freeze, [">= 0"])
-    s.add_dependency(%q<all_images>.freeze, [">= 0"])
-    s.add_dependency(%q<protocol>.freeze, ["~> 2.0"])
-  end
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.16.1".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])
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mize
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Florian Frank
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-21 00:00:00.000000000 Z
+date: 2024-07-25 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.12.0
+        version: 1.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.16.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: protocol
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 description: Library that provides memoziation for methods and functions for Ruby.
 email: flori@ping.de
 executables: []
@@ -153,7 +139,7 @@ files:
 - spec/mize/memoize_reload_spec.rb
 - spec/mize/version_spec.rb
 - spec/spec_helper.rb
-homepage: http://flori.github.com/mize
+homepage: https://github.com/flori/mize
 licenses:
 - MIT
 metadata: {}
@@ -176,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.17
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Library that provides memoziation for methods and functions