mize 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71f0cd0d6b8c6fc9e9886b434dc951794c10ef34
-  data.tar.gz: 3e9932b466d6c234dd4a68fc088df93b4cab5b18
+  metadata.gz: 6e9034cdc4e48b4728a4fc0e15332af968e79a79
+  data.tar.gz: 483494fa7a728960a031bcd3dc1febea921d28f4
 SHA512:
-  metadata.gz: 981c09c71f2abb0fc8c43e18043007a86ea8f47fb97036feddf56fd35f85c11ea59511a35786a75d062e1683abea56fc124a02b51ba79599db21d797bd927632
-  data.tar.gz: a2ac96737adac8ce91dabb99fab4329a42a4afbf650609ea37c2cadae9511429edff4a6c089e090379b74576f5257c376dcdc3e180768da03fa15ff5a0464560
+  metadata.gz: 25ee593f7690ee48fe44def237a2c006797b23f0236779d65fab254656666a65c4b6ccf8c2c116c6e9a2c8c131a0e08bd0933f6b73938ee89748ccf26d25548b
+  data.tar.gz: 25fe53fcbf4802c07beafc0cd8f1b2fdf76e72c3c9b1404fea676172fca927c90a176e1a3577914c26ae9f6e6e29a60c5bc1d900e2ecb3d84659eaede43bc8ad

data/README.md

@@ -2,6 +2,7 @@
 
 ## Description
 
+TODO
 
 ## Installation
 
@@ -17,12 +18,7 @@ and bundle.
 
 ## Usage
 
-### Configuration
-
-
-## Changes
-
-* 2015-12-10 Release 0.0.0
+TODO
 
 ## Download
 

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/lib/mize/memoize.rb

@@ -9,14 +9,16 @@ module Mize
     # memoized results do NOT ONLY depend on the arguments, but ALSO on the
     # object the method is called on. In the latter the memoized results ONLY
     # depend on the arguments given to the function. If the +freeze+ argument
-    # is true, the result is frozen if possible to make it immutable.
-    def memoize(method: nil, function: nil, freeze: false)
+    # is true, the result is frozen if possible to make it immutable. If the
+    # store_nil argument is false do not store nil results and always recompute
+    # otherwise don't which is the default.
+    def memoize(method: nil, function: nil, freeze: false, store_nil: true)
       if method && function
         raise ArgumentError, 'memoize a method xor a function'
       elsif method
-        wrap_method method, freeze: freeze
+        wrap_method method, freeze: freeze, store_nil: store_nil
       elsif function
-        wrap_method function, function: true, freeze: freeze
+        wrap_method function, function: true, freeze: freeze, store_nil: store_nil
       else
         raise ArgumentError, 'missing keyword: method/function'
       end
@@ -24,7 +26,23 @@ module Mize
 
     private
 
-    def wrap_method(method_id, freeze: false, function: false)
+    class << self
+      private
+
+      def compute_result(orig_method, key, context, args, freeze)
+        result = orig_method.bind(context).call(*args)
+        if $DEBUG
+          warn "#{context.class} cached method "\
+            "#{method_id}(#{args.inspect unless args.empty?}) = "\
+            "#{result.inspect} [#{__id__}]"
+        end
+        freeze and result.freeze rescue nil
+        result
+      end
+    end
+
+    def wrap_method(method_id, freeze: false, function: false, store_nil: true)
+      verbose, $VERBOSE = $VERBOSE, nil
       include CacheMethods
 
       function and mc = __mize_cache__
@@ -39,22 +57,22 @@ module Mize
         __send__(:define_method, method_id) do |*args|
           function or mc = __mize_cache__
           key = build_key(method_id, *args)
-          if mc.exist?(key) and result = mc.read(key)
-            result
+          if mc.exist?(key)
+            mc.read(key)
           else
-            result = orig_method.bind(self).call(*args)
-            mc.write(key, result)
-            if $DEBUG
-              warn "#{self.class} cached method "\
-                "#{method_id}(#{args.inspect unless args.empty?}) = "\
-                "#{result.inspect} [#{__id__}]"
+            result = Mize::Memoize.send(
+              :compute_result, orig_method, key, self, args, freeze
+            )
+            if store_nil || !result.nil?
+              mc.write(key, result)
             end
-            freeze and result.freeze rescue result
+            result
           end
-          result
         end
       end
       method_id
+    ensure
+      $VERBOSE = verbose
     end
   end
 end

data/lib/mize/version.rb

@@ -1,6 +1,6 @@
 module Mize
   # Mize version
-  VERSION         = '0.2.1'
+  VERSION         = '0.3.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,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: mize 0.2.1 ruby lib
+# stub: mize 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "mize".freeze
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   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 = "2017-01-23"
+  s.date = "2017-02-27"
   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]
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   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 = "2.6.8".freeze
+  s.rubygems_version = "2.6.10".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]
 

data/spec/mize/memoize_method_spec.rb

@@ -1,12 +1,24 @@
 require 'spec_helper'
 
 class FooBar
-  def self.reset
-    @@foo     = nil
-    @@footsie = nil
-    @@bar     = nil
-    @@baz     = nil
-    Mize.cache_clear
+  class << self
+    def reset
+      @@foo     = nil
+      @@footsie = nil
+      @@bar     = nil
+      @@baz     = nil
+      @@foo_nil_stored     = nil
+      @@foo_nil_not_stored = nil
+      Mize.cache_clear
+    end
+
+    def foo_nil_stored
+      @@foo_nil_stored
+    end
+
+    def foo_nil_not_stored
+      @@foo_nil_not_stored
+    end
   end
 
   def foo(*a)
@@ -28,6 +40,20 @@ class FooBar
   end
   memoize function: :bar
 
+  def foo_nil_stored(*a)
+    @@foo_nil_stored ||= 0
+    @@foo_nil_stored += 1
+    nil
+  end
+  memoize method: :foo_nil_stored, store_nil: true
+
+  def foo_nil_not_stored(*a)
+    @@foo_nil_not_stored ||= 0
+    @@foo_nil_not_stored += 1
+    nil
+  end
+  memoize method: :foo_nil_not_stored, store_nil: false
+
   private
 
   def baz(*a)
@@ -101,6 +127,27 @@ describe Mize do
       expect(fb1.__send__(:footsie, 1, 2)).to eq 1
       expect(fb1.__send__(:foo, 1, 2)).to eq 2
     end
+
+    it 'can store nil' do
+      expect(fb1.__send__(:__mize_cache__)).to be_empty
+      expect(FooBar.foo_nil_stored).to be_nil
+      expect(fb1.foo_nil_stored(1, 2)).to be_nil
+      expect(fb1.__send__(:__mize_cache__)).not_to be_empty
+      expect(FooBar.foo_nil_stored).to eq 1
+      expect(fb1.foo_nil_stored(1, 2)).to be_nil
+      expect(FooBar.foo_nil_stored).to eq 1
+    end
+
+    it 'can skip storing nil' do
+      expect(fb1.__send__(:__mize_cache__)).to be_empty
+      expect(FooBar.foo_nil_not_stored).to be_nil
+      expect(fb1.foo_nil_not_stored(1, 2)).to be_nil
+      expect(fb1.__send__(:__mize_cache__)).to be_empty
+      expect(FooBar.foo_nil_not_stored).to eq 1
+      expect(fb1.foo_nil_not_stored(1, 2)).to be_nil
+      expect(fb1.__send__(:__mize_cache__)).to be_empty
+      expect(FooBar.foo_nil_not_stored).to eq 2
+    end
   end
 
   context 'memoize function' do

data/spec/spec_helper.rb

@@ -4,10 +4,6 @@ if ENV['START_SIMPLECOV'].to_i == 1
     add_filter "#{File.basename(File.dirname(__FILE__))}/"
   end
 end
-if ENV['CODECLIMATE_REPO_TOKEN']
-  require "codeclimate-test-reporter"
-  CodeClimate::TestReporter.start
-end
 require 'rspec'
 begin
   require 'byebug'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mize
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Florian Frank
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-23 00:00:00.000000000 Z
+date: 2017-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -161,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Library that provides memoziation for methods and functions