memo-it 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af982b8ebf877a0f128499d126d2b40bf407894a
-  data.tar.gz: f4c35d3df4468bb778eb075b2fd8ff640313e676
+  metadata.gz: a5d763007910553014d30928bc189551cf02b5d9
+  data.tar.gz: 2f5a1da6d1f6761703d2d05a74d309778d10761e
 SHA512:
-  metadata.gz: 807f598a93993f69e680e2b9b33f01881e6c378ca126cccdba0cef8f8f4e1d4fd14324b6a7c9369cf60a36706ead8859c47eb2fe32796ed37d685cb2682d894e
-  data.tar.gz: c46ce4c40fb9d19da3ff5c34ed76cbce9ba51f40b83dc21dc650638feeb1789c7846a81bf7a186b5540551538aa8a29da7cef1b529a872d61e12985245527625
+  metadata.gz: 0fa8dae350b101a3990e2c322251424dd37c292ccf6b474013a319c93d5f08bf0f9a71274d7891e31b36ef5c7bf6f25ae090726050b9cef0e8c00ad275cf2434
+  data.tar.gz: ccf969487455241a7ea4623ad261852f744325ebf5a4f9047ba9f1ac13b37669508cf130972abd100253eed0d151baa64fc94e175bad986403427a93f1a2c16a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.4.0 ([list of commits](https://github.com/phoet/memo-it/compare/v0.3.2...v0.4.0))
+
+ * separate instance and class level caching (see [issue #7](https://github.com/phoet/memo-it/pull/11) for details)
+
 ## 0.3.2 ([list of commits](https://github.com/phoet/memo-it/compare/v0.3.1...v0.3.2))
 
  * cache on the class level (see [issue #7](https://github.com/phoet/memo-it/pull/9) for details)

data/README.md

@@ -2,7 +2,9 @@
 
 Clever memoization helper that uses Ruby internals instead of meta-programming. [![Build Status](https://travis-ci.org/phoet/memo-it.svg?branch=master)](https://travis-ci.org/phoet/memo-it)
 
-## Usage
+## Using Memo::It
+
+### Basic Usage
 
 Requiring the gem will add a `memo` method to the `Object` class so that you can just use it like so:
 
@@ -16,7 +18,47 @@ Requiring the gem will add a `memo` method to the `Object` class so that you can
   end
 ```
 
-In case you want to memoize something that has parameters, memo-it will just use all local variables in scope to determine the memoization:
+### Instance vs Class memoization
+
+Per default, the memoization will be done on an instance level,
+so every instance of an object will have it's own memoization namespace:
+
+```ruby
+  class Loader
+    def initialize(url)
+      @url = url
+    end
+
+    def content
+      memo do
+        # fetch the url content from the web
+      end
+    end
+  end
+
+  issues_loader = Loader.new('https://github.com/phoet/memo-it/issues')
+  pulls_loader  = Loader.new('https://github.com/phoet/memo-it/pulls')
+
+  issues_loader.content # load & memoize the issues
+  pulls_loader.content # load & memoize the pulls
+```
+
+But you can also memoize on a global/class scope.
+This is needed if you want to use Memo::It in dynamically instanciated objects like Rails helpers:
+
+```ruby
+  module WebHelper
+    def content(url)
+      Memo::It.memo do
+        # fetch the url content from the web
+      end
+    end
+  end
+```
+
+### Parameters as scopes
+
+In case you want to memoize something that has parameters, Memo::It will just use all local variables in scope to determine the memoization:
 
 ```ruby
   def load_repo(name = 'memo-it')
@@ -61,7 +103,9 @@ To be symmetric, it's also possible to define one or more parameters through the
   end
 ```
 
-In case you would like to disable memoization (ie testing) you can disable Memo::It:
+### Turning it on and off
+
+In case you would like to disable memoization (ie. for testing) you can disable Memo::It:
 
 ```ruby
   # enabled is default

data/lib/memo/it.rb

@@ -1,5 +1,5 @@
 module Memo
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
 
   @enabled = true
 
@@ -15,14 +15,6 @@ module Memo
     @enabled = false
   end
 
-  def self.cache
-    @cache ||= {}
-  end
-
-  def self.clear
-    cache.clear
-  end
-
   module It
     def memo(only: [], except: [], &block)
       only = Array(only)
@@ -37,8 +29,9 @@ module Memo
       keys = block.source_location
       keys << key_names.flat_map { |name| [name, block.binding.local_variable_get(name)] }
 
-      return Memo.cache[keys] if Memo.enabled? && Memo.cache.key?(keys)
-      Memo.cache[keys] = yield
+      @_memo_it ||= {}
+      return @_memo_it[keys] if Memo.enabled? && @_memo_it.key?(keys)
+      @_memo_it[keys] = yield
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memo-it
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - phoet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-22 00:00:00.000000000 Z
+date: 2017-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler