memoist2 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e212b34d8d7eed959ebc763094d38b50e7d8b00
-  data.tar.gz: a4d5a63ac608b8ada9c146ab9ec2366a7db4b35c
+  metadata.gz: 829d1ae3d37827ff9822e3435752208f5d96c376
+  data.tar.gz: 399d3e864904a801173ac73416e9fac4f86dad09
 SHA512:
-  metadata.gz: bc242e6f1f0901c52a8625a39e5e94ad5a586911a9316aefd6007bebf4d76cb95a9651fef0e6f8340a5b6da26f28e0ac22af18136663327f3ec90a99375e0b0a
-  data.tar.gz: 190214b45843f9d85b32a097df62ec3ab26eebae4b69850bd4c389362dc6197b9b595bd2b03dd90dcc8e411a5399dd4a094ab955cf8e814b4d1f1e3f1b5902b6
+  metadata.gz: 437e09101708635c4861064ed156cd5d6a419468f4da942395deb7c90b0c19569dd04515c6ad635d6d41a1c620a72084175b4b277e0c1ca3517baf23e8614f50
+  data.tar.gz: e84bae0e10a00897fe7afb5eabfa81b9d2d88294664896f0c7b5df1655fa0d514f5dbb9d2b5062dcb239e72fed40e48a23e6c1c4badc9574c9f53987a3da68ae

data/Gemfile

@@ -1,4 +1,2 @@
 source "https://rubygems.org"
-
-gem "rspec"
-gem "rake"
+gemspec

data/LICENCE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 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,4 +1,38 @@
 memoist2
 ========
 
-Simple Memoization for Ruby 2.0
+Simple Memoization for Ruby 2.0
+
+Example
+=======
+
+Memoize an instance method
+
+  class Foo
+    extend Memoist2
+
+    def bar
+      sleep 1 && 2**10
+    end
+    memoize :bar
+  end
+
+Memoize a class method
+
+  class Foo
+    class << self
+      extend Memoist2
+
+      def bar
+        # something expensive
+      end
+      memoize :bar
+    end
+  end
+
+Licence
+=======
+
+Licensed under the MIT licence.
+
+See the file LICENCE.

data/Rakefile

@@ -15,11 +15,12 @@ spec = Gem::Specification.new do |s|
 
   # Basic details
   s.name              = "memoist2"
-  s.version           = "0.1.1"
+  s.version           = "0.1.2"
   s.summary           = "Really simple memoization for ruby 2.0"
   s.author            = "Matthew Rudy Jacobs"
   s.email             = "MatthewRudyJacobs@gmail.com"
   s.homepage          = "https://github.com/matthewrudy/memoist2"
+  s.license           = "MIT"
 
   s.has_rdoc          = true
   s.extra_rdoc_files  = %w(README.md)

data/benchmark.rb

@@ -0,0 +1,72 @@
+<<-INTRO
+
+Question:
+  Is Memoist2 performant?
+
+Answer:
+
+  Raw is a little bit slower
+                                         user     system      total        real
+    raw method                       2.220000   0.000000   2.220000 (  2.216027)
+    memoist2 method                  1.670000   0.000000   1.670000 (  1.670678)
+    manual memoized (||=)            1.280000   0.000000   1.280000 (  1.286099)
+    manual memoized (defined?)       1.380000   0.000000   1.380000 (  1.372037)
+
+INTRO
+
+require 'benchmark'
+require 'memoist2'
+
+TIMES = 10_000_000
+
+class MyClass
+  extend Memoist2
+
+  def raw
+    (2**10)**2 # something mildly difficult
+  end
+
+  def memoized
+    1
+  end
+  memoize :memoized
+
+  def variable_cache
+    @variable_cache ||= 1
+  end
+
+  def defined_cache
+    unless defined?(@defined_cache)
+      @defined_cache = 1
+    end
+    @defined_cache
+  end
+end
+
+INSTANCE = MyClass.new
+
+Benchmark.bm(30) do |x|
+  x.report("raw method") do
+    TIMES.times do
+      INSTANCE.raw
+    end
+  end
+
+  x.report("memoist2 method") do
+    TIMES.times do
+      INSTANCE.memoized
+    end
+  end
+
+  x.report("manual memoized (||=)") do
+    TIMES.times do
+      INSTANCE.variable_cache
+    end
+  end
+
+  x.report("manual memoized (defined?)") do
+    TIMES.times do
+      INSTANCE.defined_cache
+    end
+  end
+end

data/memoist2.gemspec

@@ -2,17 +2,18 @@
 
 Gem::Specification.new do |s|
   s.name = "memoist2"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matthew Rudy Jacobs"]
   s.date = "2013-07-19"
   s.email = "MatthewRudyJacobs@gmail.com"
   s.extra_rdoc_files = ["README.md"]
-  s.files = [".gitignore", ".rspec", ".ruby-version", ".travis.yml", "Gemfile", "README.md", "Rakefile", "example/foo.rb", "lib/memoist2.rb", "spec/memoist2_spec.rb", "spec/spec_helper.rb"]
+  s.files = [".gitignore", ".rspec", ".ruby-version", ".travis.yml", "Gemfile", "README.md", "Rakefile", "example/foo.rb", "lib/memoist2.rb", "memoist2.gemspec", "spec/memoist2_spec.rb", "spec/spec_helper.rb"]
   s.homepage = "https://github.com/matthewrudy/memoist2"
   s.rdoc_options = ["--main", "README.md"]
   s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 2.0.0")
   s.rubygems_version = "2.0.3"
   s.summary = "Really simple memoization for ruby 2.0"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: memoist2
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Matthew Rudy Jacobs
@@ -50,15 +50,18 @@ files:
 - .ruby-version
 - .travis.yml
 - Gemfile
+- LICENCE
 - README.md
 - Rakefile
+- benchmark.rb
 - example/foo.rb
 - lib/memoist2.rb
 - memoist2.gemspec
 - spec/memoist2_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/matthewrudy/memoist2
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: