memoist 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e0b4aa15826f19afb39c63ff8c7706abc4e53a2
-  data.tar.gz: a376c4966fb18ef1ea0b38df8a6ab5c6d4af975c
+  metadata.gz: 630e2e80eea33c244c75ee3cab805415e627f357
+  data.tar.gz: 4e7760bdbe28b2e7aee579e722c80142cc775976
 SHA512:
-  metadata.gz: 5dca60e9396ec42bc701b7891151ef5e27baad27dc90a3d4dfd87f4510ba5f4eadfbe87755482c079c1d6c5591109fdd2bfc04f0a0618892af75b016420b69e3
-  data.tar.gz: 23a7bfc511cd96f10d80432f0514582e795eab96beba8ea3b4ce5bba6721e0eb373ee15fb6f63bb5f793475a77336132da62f4f5e1cacb179fdbf9a6104982da
+  metadata.gz: 99ea31ce66097c7350d6f1393bfdb322b9002d145674caa68e04545ec082a4db8da671553f21198463125685275194843e55a256ae9315c7cdccdcf344b4e548
+  data.tar.gz: 24b7a97927feb6a684e1c1dcc31b827510ccccb194b176de04ab852cdc1d5d8a88be845a79c6f1d3c0317341b154f4c44253d0133d8d65623cdc4281f152bafe

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - 1.8.7
+  - jruby-18mode
+  - jruby-19mode
+  - rbx
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in memoist.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2012-2013 Matthew Rudy Jacobs
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,6 +1,8 @@
 Memoist
 =============
 
+[![Build Status](https://travis-ci.org/matthewrudy/memoist.png?branch=master)](https://travis-ci.org/matthewrudy/memoist)
+
 Memoist is an extraction of ActiveSupport::Memoizable.
 
 Since June 2011 ActiveSupport::Memoizable has been deprecated.
@@ -15,7 +17,7 @@ Just extend with the Memoist module
     require 'memoist'
     class Person
       extend Memoist
-      
+
       def social_security
         decrypt_social_security
       end
@@ -24,7 +26,7 @@ Just extend with the Memoist module
 
 And person.social_security will only be calculated once.
 
-Every memoized function (which initially was not accepting any arguments) has a ```(reload)``` 
+Every memoized function (which initially was not accepting any arguments) has a ```(reload)```
 argument you can pass in to bypass and reset the memoization:
 
     def some_method
@@ -46,6 +48,21 @@ You can even memoize method that takes arguments.
 
 This will only be calculated once per value of income.
 
+You can also memoize class methods.
+
+    class Person
+
+      class << self
+        extend Memoist
+        def with_overdue_taxes
+          # ...
+        end
+        memoize :with_overdue_taxes
+      end
+
+    end
+
+
 Reload
 ------
 
@@ -53,7 +70,7 @@ Each memoized function comes with a way to flush the existing value.
 
     person.social_security       # returns the memoized value
     person.social_security(true) # bypasses the memoized value and rememoizes it
-    
+
 This also works with a memoized method with arguments
 
     person.taxes_due(100_000)       # returns the memoized value
@@ -79,6 +96,16 @@ Everyone who contributed to it in the rails repository.
 * Jay Pignata
 * Damien Mathieu
 * José Valim
+* Matthew Rudy Jacobs
+
+Contributing
+============
+
+1. Fork it ( http://github.com/<my-github-username>/memoist/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
 
 License
 =======

data/Rakefile

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+task :default => ["test"]

data/lib/memoist.rb

@@ -96,7 +96,7 @@ module Memoist
         include InstanceMethods
 
         if method_defined?(unmemoized_method)
-          raise "Already memoized #{method_name}"
+          raise AlreadyMemoizedError.new("Already memoized #{method_name}")
         end
         alias_method unmemoized_method, method_name
 
@@ -194,4 +194,6 @@ module Memoist
       end
     end
   end
+
+  class AlreadyMemoizedError < RuntimeError; end
 end

data/lib/memoist/version.rb

@@ -0,0 +1,3 @@
+module Memoist
+  VERSION = "0.9.2"
+end

data/memoist.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'memoist/version'
+
+AUTHORS = [
+  ["Joshua Peek",               "josh@joshpeek.com"],
+  ["Tarmo Tänav",               "tarmo@itech.ee"],
+  ["Jeremy Kemper",             "jeremy@bitsweat.net"],
+  ["Eugene Pimenov",            "libc@mac.com"],
+  ["Xavier Noria",              "fxn@hashref.com"],
+  ["Niels Ganser",              "niels@herimedia.co"],
+  ["Carl Lerche & Yehuda Katz", "wycats@gmail.com"],
+  ["jeem",                      "jeem@hughesorama.com"],
+  ["Jay Pignata",               "john.pignata@gmail.com"],
+  ["Damien Mathieu",            "42@dmathieu.com"],
+  ["José Valim",                "jose.valim@gmail.com"],
+  ["Matthew Rudy Jacobs",       "matthewrudyjacobs@gmail.com"],
+]
+
+Gem::Specification.new do |spec|
+  spec.name          = "memoist"
+  spec.version       = Memoist::VERSION
+  spec.authors       = AUTHORS.map{ |name, email| name }
+  spec.email         = AUTHORS.map{ |name, email| email }
+  spec.summary       = %q{memoize methods invocation}
+  spec.homepage      = "https://github.com/matthewrudy/memoist"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/test/memoist_test.rb

@@ -289,15 +289,15 @@ class MemoistTest < Test::Unit::TestCase
   end
 
   def test_double_memoization
-    assert_raise(RuntimeError) { Person.memoize :name }
+    assert_raise(Memoist::AlreadyMemoizedError) { Person.memoize :name }
     person = Person.new
     person.extend Memoist
-    assert_raise(RuntimeError) { person.memoize :name }
+    assert_raise(Memoist::AlreadyMemoizedError) { person.memoize :name }
 
     company = Company.new
     company.extend Memoist
     company.memoize :name
-    assert_raise(RuntimeError) { company.memoize :name }
+    assert_raise(Memoist::AlreadyMemoizedError) { company.memoize :name }
   end
 
   def test_double_memoization_with_identifier

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memoist
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Joshua Peek
@@ -15,11 +15,40 @@ authors:
 - Jay Pignata
 - Damien Mathieu
 - José Valim
+- Matthew Rudy Jacobs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
-dependencies: []
+date: 2014-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - josh@joshpeek.com
@@ -33,41 +62,48 @@ email:
 - john.pignata@gmail.com
 - 42@dmathieu.com
 - jose.valim@gmail.com
+- matthewrudyjacobs@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.md
+extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
 - README.md
-- test/benchmark/memoist_benchmark.rb
+- Rakefile
+- lib/memoist.rb
+- lib/memoist/core_ext/singleton_class.rb
+- lib/memoist/version.rb
+- memoist.gemspec
 - test/memoist_test.rb
 - test/test_helper.rb
-- lib/memoist/core_ext/singleton_class.rb
-- lib/memoist.rb
 homepage: https://github.com/matthewrudy/memoist
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options:
-- --main
-- README.md
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: memoize methods invocation
-test_files: []
+test_files:
+- test/memoist_test.rb
+- test/test_helper.rb
+has_rdoc: 

data/test/benchmark/memoist_benchmark.rb

@@ -1,143 +0,0 @@
-<<-INTRO
-
-Question:
-  How fast are these simple use case of memoisation
-
-    hash = {}
-    hash[:name] = "Peter"
-    hash[:age]  = 23
-    hash[:hair_colour] = "black"
-    hash
-
-    {}.tap do |hash|
-      hash[:name] = "Peter"
-      hash[:age]  = 23
-      hash[:hair_colour] = "black"
-    end
-
-Answer:
-  Not really
-
-                       user     system      total        real
-  local variable  14.170000   0.060000  14.230000 ( 14.223995)
-  tap             15.440000   0.040000  15.480000 ( 15.492474)
-
-INTRO
-
-require 'memoist'
-
-class Foo
-  extend Memoist
-
-  def memoized
-    42
-  end
-  memoize :memoized
-
-  def memoized_manually
-    @memoized_manually ||= 42
-  end
-
-  def memoized_manually_with_defined
-    unless defined?(@memoized_manually_with_defined)
-      @memoized_manually_with_defined = 42
-    end
-    @memoized_manually_with_defined
-  end
-
-  def raw
-    42
-  end
-
-  def memoized_with_arg(arg)
-    42
-  end
-  memoize :memoized_with_arg
-end
-
-require 'benchmark'
-
-TIMES = 10_000_000
-
-Benchmark.bm(40) do |x|
-  x.report "calling memoized method" do
-    foo = Foo.new
-    TIMES.times do
-      foo.memoized
-    end
-  end
-
-  x.report "calling manually memoized method" do
-    foo = Foo.new
-    TIMES.times do
-      foo.memoized_manually
-    end
-  end
-  
-  x.report "calling manually memoized (with defined?) method" do
-    foo = Foo.new
-    TIMES.times do
-      foo.memoized_manually_with_defined
-    end
-  end
-  
-  x.report "calling non-memoized method" do
-    foo = Foo.new
-    TIMES.times do
-      foo.raw
-    end
-  end
-
-  x.report "calling memoized method - one time" do
-    TIMES.times do
-      foo = Foo.new
-      foo.memoized
-    end
-  end
-
-  x.report "calling manually memoized method - one time" do
-    TIMES.times do
-      foo = Foo.new
-      foo.memoized_manually
-    end
-  end
-
-  x.report "calling manually memoized (with defined?) method - one time" do
-    TIMES.times do
-      foo = Foo.new
-      foo.memoized_manually_with_defined
-    end
-  end
-
-  x.report "calling non-memoized method - one time" do
-    TIMES.times do
-      foo = Foo.new
-      foo.raw
-    end
-  end
-  x.report "re-loading memoized method" do
-    foo = Foo.new
-    TIMES.times do
-      foo.memoized(true)
-    end
-  end
-  
-  comment = <<-COMMENT
-  
-  x.report "calling memoized method with args" do
-    foo = Foo.new
-    TIMES.times do
-      foo.memoized_with_arg(1337)
-    end
-  end
-  
-  x.report "calling memoized method with args - no cache" do
-    foo = Foo.new
-    TIMES.times do |i|
-      foo.memoized_with_arg(i)
-    end
-  end
-
-  COMMENT
-
-end