memo-it 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a5d763007910553014d30928bc189551cf02b5d9
-  data.tar.gz: 2f5a1da6d1f6761703d2d05a74d309778d10761e
+SHA256:
+  metadata.gz: cad87d82c561a1ab4b92282a41dbe43bdf4e4cca81c0896062afde0dd94a5e25
+  data.tar.gz: 14fd9a7779219ce974712639a0cb131a94ea9675f0eb7232488219d050270460
 SHA512:
-  metadata.gz: 0fa8dae350b101a3990e2c322251424dd37c292ccf6b474013a319c93d5f08bf0f9a71274d7891e31b36ef5c7bf6f25ae090726050b9cef0e8c00ad275cf2434
-  data.tar.gz: ccf969487455241a7ea4623ad261852f744325ebf5a4f9047ba9f1ac13b37669508cf130972abd100253eed0d151baa64fc94e175bad986403427a93f1a2c16a
+  metadata.gz: 6e3041c9707b52eaa229f02f17732695eaa5d46a563c09ed9f46ce6bb1b557cab9449682f67e492af049e864e41b77afe3039466f71e7e8b149c7945b2e04dec
+  data.tar.gz: 222825cee2c1a4e57a519ebf9af1886a28cee4f9a6ff6a0cb47cffdecf5d2a04e00637c762731081677caeb46131b1c31f77a10f5aa1c67db6fc1dc8a49011cc

data/CHANGELOG.md

@@ -1,16 +1,20 @@
 # CHANGELOG
 
+## 0.5.0 ([list of commits](https://github.com/phoet/memo-it/compare/v0.4.0...v0.5.0))
+
+ * separate instance and class level caching (see [PR](https://github.com/phoet/memo-it/pull/15) for details) <3 @serioushaircut
+
 ## 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)
+ * separate instance and class level caching (see [PR](https://github.com/phoet/memo-it/pull/11) for details) <3 @alto
 
 ## 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)
+ * cache on the class level (see [PR](https://github.com/phoet/memo-it/pull/9) for details)
 
 ## 0.3.1 ([list of commits](https://github.com/phoet/memo-it/compare/v0.3.0...v0.3.1))
 
- * simplify key generation (see [issue #7](https://github.com/phoet/memo-it/pull/7) for details)
+ * simplify key generation (see [PR](https://github.com/phoet/memo-it/pull/7) for details)
 
 ## 0.3.0 ([list of commits](https://github.com/phoet/memo-it/compare/v0.2.0...v0.3.0))
 

data/README.md

@@ -103,6 +103,17 @@ To be symmetric, it's also possible to define one or more parameters through the
   end
 ```
 
+Provide your own memoization keys through the `:provided` key:
+
+```ruby
+  def load_repo(name = 'memo-it')
+    memo(provided: Date.today.day_of_week) do
+      # in this case the result will be memoized per name and day_of_week
+      HTTPClient.get("https://github.com/phoet/#{name}")
+    end
+  end
+```
+
 ### Turning it on and off
 
 In case you would like to disable memoization (ie. for testing) you can disable Memo::It:
@@ -120,6 +131,19 @@ In case you would like to disable memoization (ie. for testing) you can disable
   Memo.enabled? # => true
 ```
 
+## Caveats
+
+### Multiple calls to memo on the same line of code
+
+If you want to call `memo` twice within the same line of code, you would need provide a custom key through the `:provided` argument.
+This is not recommended through. A better alternative would be to put both calls into their own sub-methods and call those instead.
+
+### Runtime-Speed
+
+Compared to other memoization frameworks, the `memo` method requires more computation and is slower by size of a magnitude: https://github.com/phoet/memo-it/issues/6
+Do not use this library to optimize hot code-paths! Use it to cache really slow things such as network-requests or generation of large strings like JSON objects etc.
+Whatever you do, benchmark your code in order to see if the memoization strategy you use is a good fit for your use-case.
+
 ## Installation
 
 ### As a Gem

data/lib/memo/it.rb

@@ -1,5 +1,5 @@
 module Memo
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 
   @enabled = true
 
@@ -16,7 +16,9 @@ module Memo
   end
 
   module It
-    def memo(only: [], except: [], &block)
+    def memo(only: [], except: [], provided: [], &block)
+      return yield unless Memo.enabled?
+
       only = Array(only)
       if only.empty?
         except = Array(except)
@@ -28,9 +30,10 @@ module Memo
 
       keys = block.source_location
       keys << key_names.flat_map { |name| [name, block.binding.local_variable_get(name)] }
+      keys << Array(provided)
 
       @_memo_it ||= {}
-      return @_memo_it[keys] if Memo.enabled? && @_memo_it.key?(keys)
+      return @_memo_it[keys] if @_memo_it.key?(keys)
       @_memo_it[keys] = yield
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memo-it
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - phoet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-04 00:00:00.000000000 Z
+date: 2019-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: "\U0001F4E5 \U0001F4E4 simple yet clever memoization helper with parameter