memoit 0.1.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7d5440f6ce3b976230858dcb48b83657621987ec
-  data.tar.gz: 1fe48fce65be49c139a83c3a0fe8c636af0b23ed
+SHA256:
+  metadata.gz: 589b739844b381707d83e9dcd9c81008951e388c9fbb5361821f9d3ead7f9c60
+  data.tar.gz: 6c3e96182dea40b2693db9937f434cff394aaa1b71c88c28f375a53cd13874d7
 SHA512:
-  metadata.gz: 537902c0edacd41f6026d270fdc8ea85c151006a5200d57588d19bd701a0d55b9b853def246caa9b9a82ad2257b20f44b7db3d0a52644fce8a7b8ec9c7626d03
-  data.tar.gz: 701854fb5eca663e2ce7aee4071c437ed4b339c4cbd18eb1a21a656423bd4e84075a54741454e16fdf360efd1773a48ec33436bb51abb117541db8020b83fc75
+  metadata.gz: 187ec3e55ed71647a49c0379c2cbf855b9ce94c266b3e7d1183d1deafcb568cc9305ba5d92d8256872fe998e02816f4f0a75e9a7ddc850d44c754e17c56c8609
+  data.tar.gz: f442100c27d3165c5388f75bb4d6e5c72a8c37c7a50151b5c593bfb5e82df77cb045a366a3e4d08d40b172898d277964ed8d3aaabef32a494bd50e80fb0cd18c

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: Ruby CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version:
+          - 3.1
+          - "3.0"
+          - 2.7
+          - jruby-9.3
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake

data/README.md

@@ -1,5 +1,8 @@
 # Memoit
 
+[![Gem Version](https://badge.fury.io/rb/memoit.svg)](http://badge.fury.io/rb/memoit)
+[![Build Status](https://github.com/jnicklas/memoit/actions/workflows/ci.yml/badge.svg)](https://github.com/jnicklas/memoit/actions/workflows/ci.yml)
+
 Memoizes methods.
 
 ## Installation
@@ -17,9 +20,25 @@ class Foo
   memoize def bar(value)
     expensive_calculation(value)
   end
+
+  memoize_class_method def self.baz(value)
+    expensive_calculation(value)
+  end
 end
 ```
 
+## Is it any good?
+
+[Yes](https://news.ycombinator.com/item?id=3067434).
+
+## Development
+
+```sh
+gem install bundler
+bundle install
+rspec
+```
+
 ## License
 
-[MIT](License.txt)
+[MIT](LICENSE.txt)

data/Rakefile

@@ -1,2 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/memoit/version.rb

@@ -1,3 +1,3 @@
 module Memoit
-  VERSION = "0.1.2"
+  VERSION = "0.4.0"
 end

data/lib/memoit.rb

@@ -11,20 +11,29 @@ module Memoit
   #     end
   #   end
   def memoize(name)
-    ivar_name = "@_memo_#{name}".to_sym
+    ivar_method_name = name.to_s.sub("?", "__questionmark").sub("!", "__bang")
+    ivar_name = "@_memo_#{ivar_method_name}".to_sym
     mod = Module.new do
-      define_method(name) do |*args, &block|
-        return super(*args, &block) if block
+      define_method(name) do |*args, **kwargs, &block|
+        return super(*args, **kwargs, &block) if block
         cache = instance_variable_get(ivar_name) || instance_variable_set(ivar_name, {})
-        hash = args.hash
-        if cache.has_key?(hash)
-          cache[hash]
-        else
-          cache[hash] = super(*args)
-        end
+        cache.fetch(args.hash) { |hash| cache[hash] = super(*args, **kwargs) }
       end
     end
     prepend mod
+    name
+  end
+
+  # Memoize the class method with the given name.
+  #
+  # @example
+  #   class Foo
+  #     memoize_class_method def self.bar(value)
+  #       expensive_calculation(value)
+  #     end
+  #   end
+  def memoize_class_method(name)
+    singleton_class.memoize(name)
   end
 end
 

data/memoit.gemspec

@@ -13,13 +13,12 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = ">= 2.1.0"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 2.3"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
 end

data/spec/memoit_spec.rb

@@ -3,6 +3,10 @@ require "memoit"
 describe Memoit do
   let(:klass) do
     Class.new do
+      memoize_class_method def self.foo
+        rand
+      end
+
       memoize def foo
         rand
       end
@@ -11,10 +15,38 @@ describe Memoit do
         rand
       end
 
+      memoize def baz(pos = nil, hash = {}, kwak: nil)
+        rand
+      end
+
+      memoize def qux(pos = nil, kwak: nil)
+        rand
+      end
+
+      memoize def quux(kwak: nil)
+        rand
+      end
+
+      memoize def corge(hash = {}, kwak: nil)
+        rand
+      end
+
       memoize def falsy
         foo
         false
       end
+
+      memoize def query?
+        rand
+      end
+
+      memoize def bang!
+        rand
+      end
+
+      memoize def ☃
+        rand
+      end
     end
   end
   let(:instance) { klass.new }
@@ -33,6 +65,24 @@ describe Memoit do
       expect(instance.bar(a, 1, :foo, "bar")).not_to eq(instance.bar(Object.new, 1, :foo, "bar"))
     end
 
+    it "caches results when positional, hash and keyword arguments are used" do
+      a = Object.new
+      expect(instance.baz(a, { hash_key: "hash_value" }, kwak: "kwav")).to eq(instance.baz(a, { hash_key: "hash_value" }, kwak: "kwav"))
+    end
+
+    it "caches results when positional and keyword arguments are used" do
+      a = Object.new
+      expect(instance.qux(a, kwak: "kwav")).to eq(instance.qux(a, kwak: "kwav"))
+    end
+
+    it "caches results when keyword arguments are used" do
+      expect(instance.quux(kwak: "kwav")).to eq(instance.quux(kwak: "kwav"))
+    end
+
+    it "caches results when hash and keyword arguments are used" do
+      expect(instance.corge({ hash_key: "hash_value" }, kwak: "kwav")).to eq(instance.corge({ hash_key: "hash_value" }, kwak: "kwav"))
+    end
+
     it "ignores cache when block given" do
       expect(instance.foo { }).not_to eq(instance.foo { })
     end
@@ -41,5 +91,51 @@ describe Memoit do
       expect(instance).to receive(:foo).once
       expect(instance.falsy).to eq(instance.falsy)
     end
+
+    it "handles question-mark methods" do
+      expect(instance.query?).to eq(instance.query?)
+    end
+
+    it "handles bang methods" do
+      expect(instance.bang!).to eq(instance.bang!)
+    end
+
+    it "handles non-ASCII-name methods" do
+      expect(instance.☃).to eq(instance.☃)
+    end
+
+    it "returns the name of the method" do
+      name = nil
+      Class.new do
+        name = memoize def blah
+        end
+      end
+      expect(name).to eq(:blah)
+    end
+
+    it "works in a mixin" do
+      mod = Module.new do
+        memoize def cname
+          self.class.name
+        end
+      end
+
+      Foo = Class.new do
+        include mod
+      end
+
+      Bar = Class.new do
+        include mod
+      end
+
+      expect(Foo.new.cname).to eq("Foo")
+      expect(Bar.new.cname).to eq("Bar")
+    end
+  end
+
+  describe ".memoize_class_method" do
+    it "caches result" do
+      expect(klass.foo).to eq(klass.foo)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memoit
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Jonas Nicklas
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-12-14 00:00:00.000000000 Z
+date: 2022-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,49 +16,50 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: 
+        version: '3.10'
+description:
 email:
 - jonas.nicklas@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - Gemfile
 - LICENSE.txt
@@ -72,7 +73,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,9 +88,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Memoize is back!
 test_files: