memo-it 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ba70b290050e4ac1069de24e58bbe33b242fcf8
-  data.tar.gz: dd171e80509a3427abced4b6ab35f8d47fb168dc
+  metadata.gz: ae2ef7f59fcce47065e9e4c8b9f1c80453575b27
+  data.tar.gz: 1b75e93544b70146774b84051eb7dad5720bef00
 SHA512:
-  metadata.gz: 0a670f8c4f7a572c4ab62a58ff372796e44823d660466234c407f34a91582ed11c3b7bfd21006d07813843c5a9fe5efead90cee29b484ee85f9f0cb75f963434
-  data.tar.gz: 9a7bb9853224dc5414a29a5ba3bc688f7d6b23a0c160c4657d549b2282b88044c227419fca35acb71fe32c396687afecbdd896b925d9670105c116c5a3ca1c4c
+  metadata.gz: 50212743b82d81f81650f51f15e0808c9a889bd94f9c8d301fa5aa5a96a603f120d10ec1f657f49c4541e2799e4d7559d9dfd0ef57c850b981b3889df58f8344
+  data.tar.gz: 9a95c272ab56b6251cfba00d407887e890f0d0ec24898732a2d207913f57272074f3cb43de2c60144bd9eb9681beedcb407921d2992cfd6bc08a222ea37ba46f

data/README.md

@@ -28,28 +28,54 @@ In case you want to memoize something that has parameters, memo-it will just use
 ```
 
 If, on the other hand, you want to memoize parameters but ignore one of them,
-you can do this by adding it to the `:ignore` list:
+you can do this by adding it to the `:except` list:
 
 ```ruby
   def load_repo(name =  'memo-it', time = Time.now)
-    memo(ignore: :time) do
+    memo(except: :time) do
       # in this case the result will be memoized per name
       HTTPClient.get("https://github.com/phoet/#{name}?time=#{time}")
     end
   end
 ```
 
-Or provide a list of parameters to ignore:
+Or provide a list of parameters to except:
 
 ```ruby
   def load_repo(name =  'memo-it', time = Time.now, other = 'irrelevant')
-    memo(ignore: [:time, :other]) do
+    memo(except: [:time, :other]) do
       # in this case the result will be memoized per name
       HTTPClient.get("https://github.com/phoet/#{name}?time=#{time}&other=#{other}")
     end
   end
 ```
 
+To be symmetric, it's also possible to define one or more parameters through the `:only` key:
+
+```ruby
+  def load_repo(name =  'memo-it', time = Time.now, format = 'json')
+    memo(only: [:name, :format]) do
+      # in this case the result will be memoized per name & format
+      HTTPClient.get("https://github.com/phoet/#{name}?time=#{time}&format=#{format}")
+    end
+  end
+```
+
+In case you would like to disable memoization (ie testing) you can disable Memo::It:
+
+```ruby
+  # enabled is default
+  Memo.enabled? # => true
+
+  # disable memoization globally
+  Memo.disable
+  Memo.enabled? # => false
+
+  # re-enable memoization
+  Memo.enable
+  Memo.enabled? # => true
+```
+
 ## Installation
 
 ### As a Gem
@@ -78,11 +104,11 @@ If you don't want to include yet another Gem, just run this in your shell:
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/memo-it. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/phoet/memo-it. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/memo/it.rb

@@ -1,17 +1,37 @@
 module Memo
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
+
+  @enabled = true
+
+  def self.enabled?
+    @enabled
+  end
+
+  def self.enable
+    @enabled = true
+  end
+
+  def self.disable
+    @enabled = false
+  end
+
   module It
-    def memo(ignore: [], &block)
-      keys = block.source_location
-      ignore = Array(ignore)
-      keys << block.binding.local_variables.map do |name|
-        next if ignore.include?(name)
-        [name, block.binding.local_variable_get(name)]
+    def memo(only: [], except: [], &block)
+      only = Array(only)
+      if only.empty?
+        except = Array(except)
+        key_names = block.binding.local_variables
+        key_names -= except unless except.empty?
+      else
+        key_names = only
       end
+
+      keys = block.source_location
+      keys << key_names.map { |name| [name, block.binding.local_variable_get(name)] }
       keys = keys.flatten.map(&:to_s)
 
       @_memo_it ||= {}
-      return @_memo_it[keys] if @_memo_it.key? keys
+      return @_memo_it[keys] if Memo.enabled? && @_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.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - phoet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-12 00:00:00.000000000 Z
+date: 2017-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler