memoizable 0.3.1 → 0.4.0

data/README.md

@@ -73,6 +73,38 @@ not safe in every domain. If it was possible for one of the attributes to
 change between method calls, memoizing that value could produce the wrong
 result. Please keep this in mind when considering which methods to memoize.
 
+Supported Ruby Versions
+-----------------------
+
+This library aims to support and is [tested against][travis] the following Ruby
+implementations:
+
+* Ruby 1.8.7
+* Ruby 1.9.2
+* Ruby 1.9.3
+* Ruby 2.0.0
+* [JRuby][]
+* [Rubinius][]
+* [Ruby Enterprise Edition][ree]
+
+[jruby]: http://jruby.org/
+[rubinius]: http://rubini.us/
+[ree]: http://www.rubyenterpriseedition.com/
+
+If something doesn't work on one of these versions, it's a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby versions or
+implementations, however support will only be provided for the implementations
+listed above.
+
+If you would like this library to support another Ruby version or
+implementation, you may volunteer to be a maintainer. Being a maintainer
+entails making sure all tests run and pass on that implementation. When
+something breaks on your implementation, you will be responsible for providing
+patches in a timely fashion. If critical issues for a particular implementation
+exist at the time of a major release, support for that Ruby version may be
+dropped.
+
 ## Copyright
 
 Copyright © 2013 Dan Kubb, Erik Michaels-Ober. See LICENSE for details.

data/lib/memoizable/memory.rb

@@ -7,6 +7,8 @@ module Memoizable
 
     # Initialize the memory storage for memoized methods
     #
+    # @param [ThreadSafe::Cache] memory
+    #
     # @return [undefined]
     #
     # @api private
@@ -75,5 +77,28 @@ module Memoizable
       @memory.key?(name)
     end
 
+    # A hook that allows Marshal to dump the object
+    #
+    # @return [Hash]
+    #   A hash used to populate the internal memory
+    #
+    # @api public
+    def marshal_dump
+      @memory.marshal_dump
+    end
+
+    # A hook that allows Marshal to load the object
+    #
+    # @param [Hash] hash
+    #   A hash used to populate the internal memory
+    #
+    # @return [undefined]
+    #
+    # @api public
+    def marshal_load(hash)
+      initialize
+      @memory.marshal_load(hash)
+    end
+
   end # Memory
 end # Memoizable

data/lib/memoizable/method_builder.rb

@@ -99,7 +99,8 @@ module Memoizable
     #
     # @api private
     def remove_original_method
-      descendant_exec(@method_name) { |name| undef_method(name) }
+      name = @method_name
+      @descendant.module_eval { undef_method(name) }
     end
 
     # Create a new memoized method
@@ -108,7 +109,8 @@ module Memoizable
     #
     # @api private
     def create_memoized_method
-      descendant_exec(@method_name, @original_method, @freezer) do |name, method, freezer|
+      name, method, freezer = @method_name, @original_method, @freezer
+      @descendant.module_eval do
         define_method(name) do |&block|
           fail BlockNotAllowedError.new(self.class, name) if block
           memoized_method_cache.fetch(name) do
@@ -139,16 +141,5 @@ module Memoizable
       end
     end
 
-    # Helper method to execute code within the descendant scope
-    #
-    # @param [Array] args
-    #
-    # @return [undefined]
-    #
-    # @api private
-    def descendant_exec(*args, &block)
-      @descendant.instance_exec(*args, &block)
-    end
-
   end # MethodBuilder
 end # Memoizable

data/lib/memoizable/version.rb

@@ -3,6 +3,6 @@
 module Memoizable
 
   # Gem version
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.4.0'.freeze
 
 end # Memoizable

data/memoizable.gemspec

@@ -5,8 +5,8 @@ require File.expand_path('../lib/memoizable/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.name        = 'memoizable'
   gem.version     = Memoizable::VERSION.dup
-  gem.authors     = ['Dan Kubb']
-  gem.email       = 'dan.kubb@gmail.com'
+  gem.authors     = ['Dan Kubb', 'Erik Michaels-Ober']
+  gem.email       = ['dan.kubb@gmail.com', 'sferik@gmail.com']
   gem.description = 'Memoize method return values'
   gem.summary     = gem.description
   gem.homepage    = 'https://github.com/dkubb/memoizable'

data/spec/integration/serializable_spec.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+class Serializable
+  include Memoizable
+
+  def random_number
+    rand(10000)
+  end
+  memoize :random_number
+end
+
+describe 'A serializable object' do
+  let(:serializable) do
+    Serializable.new
+  end
+
+  before do
+    serializable.random_number # Call the memoized method to trigger lazy memoization
+  end
+
+  it 'is serializable with Marshal' do
+    expect { Marshal.dump(serializable) }.not_to raise_error
+  end
+
+  it 'is deserializable with Marshal' do
+    serialized = Marshal.dump(serializable)
+    deserialized = Marshal.load(serialized)
+
+    expect(deserialized).to be_an_instance_of(Serializable)
+    expect(deserialized.random_number).to eql(serializable.random_number)
+  end
+end

data/spec/unit/memoizable/memory_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Memoizable::Memory do
+  let(:memory) { Memoizable::Memory.new }
+
+  context "serialization" do
+    let(:deserialized) { Marshal.load(Marshal.dump(memory)) }
+
+    it 'is serializable with Marshal' do
+      expect { Marshal.dump(memory) }.not_to raise_error
+    end
+
+    it 'is deserializable with Marshal' do
+      expect(deserialized).to be_an_instance_of(Memoizable::Memory)
+    end
+
+    it 'mantains the same class of cache when deserialized' do
+      original_cache     = memory.instance_variable_get(:@memory)
+      deserialized_cache = deserialized.instance_variable_get(:@memory)
+
+      expect(deserialized_cache.class).to eql(original_cache.class)
+    end
+  end
+end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: memoizable
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
 - Dan Kubb
+- Erik Michaels-Ober
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-18 00:00:00.000000000 Z
+date: 2013-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thread_safe
@@ -50,7 +51,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.3.5
 description: Memoize method return values
-email: dan.kubb@gmail.com
+email:
+- dan.kubb@gmail.com
+- sferik@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -69,6 +72,7 @@ files:
 - lib/memoizable/module_methods.rb
 - lib/memoizable/version.rb
 - lib/memoizable.rb
+- spec/integration/serializable_spec.rb
 - spec/shared/call_super_shared_spec.rb
 - spec/shared/command_method_behavior.rb
 - spec/spec_helper.rb
@@ -76,6 +80,7 @@ files:
 - spec/unit/memoizable/fixtures/classes.rb
 - spec/unit/memoizable/instance_methods/freeze_spec.rb
 - spec/unit/memoizable/instance_methods/memoize_spec.rb
+- spec/unit/memoizable/memory_spec.rb
 - spec/unit/memoizable/method_builder/call_spec.rb
 - spec/unit/memoizable/method_builder/class_methods/new_spec.rb
 - spec/unit/memoizable/method_builder/original_method_spec.rb
@@ -98,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3254840289484637315
+      hash: 1369072694341033356
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -107,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3254840289484637315
+      hash: 1369072694341033356
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -119,6 +124,7 @@ test_files:
 - spec/unit/memoizable/fixtures/classes.rb
 - spec/unit/memoizable/instance_methods/freeze_spec.rb
 - spec/unit/memoizable/instance_methods/memoize_spec.rb
+- spec/unit/memoizable/memory_spec.rb
 - spec/unit/memoizable/method_builder/call_spec.rb
 - spec/unit/memoizable/method_builder/class_methods/new_spec.rb
 - spec/unit/memoizable/method_builder/original_method_spec.rb
@@ -126,3 +132,4 @@ test_files:
 - spec/unit/memoizable/module_methods/memoize_spec.rb
 - spec/unit/memoizable/module_methods/memoized_predicate_spec.rb
 - spec/unit/memoizable/module_methods/unmemoized_instance_method_spec.rb
+- spec/integration/serializable_spec.rb