memo-it 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae2ef7f59fcce47065e9e4c8b9f1c80453575b27
-  data.tar.gz: 1b75e93544b70146774b84051eb7dad5720bef00
+  metadata.gz: 5c219d9d1f53efd7dcb2686f35b8ad1627764aa3
+  data.tar.gz: 0b539381c33dd4037cfe3425055b5ead557ba47c
 SHA512:
-  metadata.gz: 50212743b82d81f81650f51f15e0808c9a889bd94f9c8d301fa5aa5a96a603f120d10ec1f657f49c4541e2799e4d7559d9dfd0ef57c850b981b3889df58f8344
-  data.tar.gz: 9a95c272ab56b6251cfba00d407887e890f0d0ec24898732a2d207913f57272074f3cb43de2c60144bd9eb9681beedcb407921d2992cfd6bc08a222ea37ba46f
+  metadata.gz: c64c5ce79094046b63f68d368c4da21583406e6fd27476508efc865d91084383bcfe070c435f6063bed3f819bcc35d2b5b38d014aaef999db9114f2a81a8a9d5
+  data.tar.gz: 14cb63e98f8431a9051de9d8fb11a43a3ccab8af6ae11cd6ca63244d9540707ed30cfa0aeb5a5db3bf92058b4626525060b934153d2329aaf52a45449eabae15

data/.travis.yml

@@ -1,4 +1,7 @@
 sudo: false
 rvm:
+  - 2.2.0
   - 2.3.0
   - 2.4.0
+notifications:
+  email: false

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# CHANGELOG
+
+## 0.3.1
+
+ * simplify key generation (see [issue #7](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))
+
+ * rename `:ignore` to `:except` (see [issue #5](https://github.com/phoet/memo-it/pull/5) for details)
+ * add easy way to disable memoization (see [issue #4](https://github.com/phoet/memo-it/pull/4) for details)
+ * add `:only` option for memoizing method parameters (see [issue #3](https://github.com/phoet/memo-it/pull/3) for details)
+
+## 0.2.0 ([list of commits](https://github.com/phoet/memo-it/compare/0.1.1...v0.2.0))
+
+ * support ignoring selected method parameters (see [issue #2](https://github.com/phoet/memo-it/pull/2) for details)

data/Gemfile

@@ -4,3 +4,5 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'byebug'
+gem 'benchmark-ips'
+gem 'memoist'

data/README.md

@@ -19,7 +19,7 @@ Requiring the gem will add a `memo` method to the `Object` class so that you can
 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')
+  def load_repo(name = 'memo-it')
     memo do
       # in this case the result will be memoized per name
       HTTPClient.get("https://github.com/phoet/#{name}")
@@ -31,7 +31,7 @@ If, on the other hand, you want to memoize parameters but ignore one of them,
 you can do this by adding it to the `:except` list:
 
 ```ruby
-  def load_repo(name =  'memo-it', time = Time.now)
+  def load_repo(name = 'memo-it', time = Time.now)
     memo(except: :time) do
       # in this case the result will be memoized per name
       HTTPClient.get("https://github.com/phoet/#{name}?time=#{time}")
@@ -42,7 +42,7 @@ you can do this by adding it to the `:except` list:
 Or provide a list of parameters to except:
 
 ```ruby
-  def load_repo(name =  'memo-it', time = Time.now, other = 'irrelevant')
+  def load_repo(name = 'memo-it', time = Time.now, other = 'irrelevant')
     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}")
@@ -53,7 +53,7 @@ Or provide a list of parameters to except:
 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')
+  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}")
@@ -100,6 +100,10 @@ If you don't want to include yet another Gem, just run this in your shell:
 
     $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/phoet/memo-it/master/bin/install)"
 
+## Changelog
+
+See [CHANGELOG.md](https://github.com/phoet/memo-it/blob/master/CHANGELOG.md).
+
 ## Development
 
 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.

data/Rakefile

@@ -1,10 +1,38 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
+  t.libs << 'test'
+  t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test
+
+task :benchmark do
+  require_relative 'lib/memo/it'
+  require 'benchmark/ips'
+  require 'memoist'
+
+  class Tester
+    extend Memoist
+
+    def memo_it
+      memo { false }
+    end
+
+    def memoist
+      false
+    end
+
+    memoize :memoist
+  end
+
+  tester = Tester.new
+  Benchmark.ips do |x|
+    x.warmup = 3
+    x.time = 10
+    x.report('memo-it') { tester.memo_it }
+    x.report('memoist') { tester.memoist }
+  end
+end

data/lib/memo/it.rb

@@ -1,5 +1,5 @@
 module Memo
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 
   @enabled = true
 
@@ -27,8 +27,7 @@ module Memo
       end
 
       keys = block.source_location
-      keys << key_names.map { |name| [name, block.binding.local_variable_get(name)] }
-      keys = keys.flatten.map(&:to_s)
+      keys << key_names.flat_map { |name| [name, block.binding.local_variable_get(name)] }
 
       @_memo_it ||= {}
       return @_memo_it[keys] if Memo.enabled? && @_memo_it.key?(keys)

data/memo-it.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "bundler", "> 1.0"
+  spec.add_development_dependency "rake", "> 10.0"
+  spec.add_development_dependency "minitest", "> 5.0"
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: memo-it
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - phoet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-15 00:00:00.000000000 Z
+date: 2017-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '5.0'
 description: "\U0001F4E5 \U0001F4E4 simple yet clever memoization helper with parameter
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt