memoizable 0.4.1 → 0.5.0

data/lib/memoizable.rb

@@ -1,20 +1,19 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'monitor'
-require 'thread_safe'
+require "monitor"
 
-require 'memoizable/instance_methods'
-require 'memoizable/method_builder'
-require 'memoizable/module_methods'
-require 'memoizable/memory'
-require 'memoizable/version'
+require "memoizable/instance_methods"
+require "memoizable/method_builder"
+require "memoizable/module_methods"
+require "memoizable/memory"
+require "memoizable/version"
 
 # Allow methods to be memoized
 module Memoizable
-  include InstanceMethods
+  include Memoizable::InstanceMethods
 
   # Default freezer
-  Freezer = lambda { |object| object.freeze }.freeze
+  Freezer = ->(value) { value.freeze }.freeze # rubocop:disable Style/SymbolProc
 
   # Hook called when module is included
   #
@@ -29,5 +28,4 @@ module Memoizable
     descendant.extend(ModuleMethods)
   end
   private_class_method :included
-
-end # Memoizable
+end

metadata

@@ -1,93 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: memoizable
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Dan Kubb
-- Erik Michaels-Ober
-autorequire: 
+- Erik Berlin
 bindir: bin
 cert_chain: []
-date: 2014-03-04 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: thread_safe
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.5
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
 description: Memoize method return values
 email:
 - dan.kubb@gmail.com
 - sferik@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- CONTRIBUTING.md
-- LICENSE.md
-- README.md
+extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - CONTRIBUTING.md
 - LICENSE.md
 - README.md
-- Rakefile
 - lib/memoizable.rb
 - lib/memoizable/instance_methods.rb
 - lib/memoizable/memory.rb
 - lib/memoizable/method_builder.rb
 - lib/memoizable/module_methods.rb
 - lib/memoizable/version.rb
-- memoizable.gemspec
-- spec/integration/serializable_spec.rb
-- spec/shared/call_super_shared_spec.rb
-- spec/shared/command_method_behavior.rb
-- spec/spec_helper.rb
-- spec/unit/memoizable/class_methods/included_spec.rb
-- 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
-- spec/unit/memoizable/module_methods/included_spec.rb
-- 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
 homepage: https://github.com/dkubb/memoizable
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/dkubb/memoizable
+  source_code_uri: https://github.com/dkubb/memoizable
+  changelog_uri: https://github.com/dkubb/memoizable/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -95,29 +43,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 4.0.7
 specification_version: 4
 summary: Memoize method return values
-test_files:
-- spec/unit/memoizable/class_methods/included_spec.rb
-- 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
-- spec/unit/memoizable/module_methods/included_spec.rb
-- 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
+test_files: []

data/Rakefile

@@ -1,10 +0,0 @@
-# encoding: utf-8
-
-require 'bundler'
-require 'rspec/core/rake_task'
-
-Bundler::GemHelper.install_tasks
-RSpec::Core::RakeTask.new(:spec)
-
-task :test    => :spec
-task :default => :spec

data/memoizable.gemspec

@@ -1,24 +0,0 @@
-# encoding: utf-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', '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'
-  gem.license     = 'MIT'
-
-  gem.require_paths    = %w[lib]
-  gem.files            = %w[CONTRIBUTING.md LICENSE.md README.md Rakefile memoizable.gemspec]
-  gem.files           += Dir.glob('{lib,spec}/**/*.rb')
-  gem.test_files       = Dir.glob('spec/{unit,integration}/**/*.rb')
-  gem.extra_rdoc_files = Dir.glob('**/*.md')
-
-  gem.add_runtime_dependency('thread_safe', '~> 0.2.0')
-
-  gem.add_development_dependency('bundler', '~> 1.3', '>= 1.3.5')
-end

data/spec/integration/serializable_spec.rb

@@ -1,34 +0,0 @@
-# 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/shared/call_super_shared_spec.rb

@@ -1,23 +0,0 @@
-# encoding: utf-8
-
-shared_examples 'it calls super' do |method|
-  around do |example|
-    # Restore original method after each example
-    original = "original_#{method}"
-    superclass.class_eval do
-      alias_method original, method
-      example.call
-      undef_method method
-      alias_method method, original
-    end
-  end
-
-  it "delegates to the superclass ##{method} method" do
-    # This is the most succinct approach I could think of to test whether the
-    # superclass method is called. All of the built-in rspec helpers did not
-    # seem to work for this.
-    called = false
-    superclass.class_eval { define_method(method) { |_| called = true } }
-    expect { subject }.to change { called }.from(false).to(true)
-  end
-end

data/spec/shared/command_method_behavior.rb

@@ -1,7 +0,0 @@
-# encoding: utf-8
-
-shared_examples_for 'a command method' do
-  it 'returns self' do
-    should equal(object)
-  end
-end

data/spec/spec_helper.rb

@@ -1,32 +0,0 @@
-# encoding: utf-8
-
-require 'simplecov'
-require 'coveralls'
-
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-]
-SimpleCov.start do
-  command_name 'spec'
-
-  add_filter 'config'
-  add_filter 'spec'
-  add_filter 'vendor'
-
-  minimum_coverage 100
-end
-
-require 'memoizable'
-require 'rspec'
-
-# Require spec support files and shared behavior
-Dir[File.expand_path('../{support,shared}/**/*.rb', __FILE__)].each do |file|
-  require file.chomp('.rb')
-end
-
-RSpec.configure do |config|
-  config.expect_with :rspec do |expect_with|
-    expect_with.syntax = :expect
-  end
-end

data/spec/unit/memoizable/class_methods/included_spec.rb

@@ -1,18 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-describe Memoizable, '.included' do
-  subject { object.class_eval { include Memoizable } }
-
-  let(:object)     { Class.new }
-  let(:superclass) { Module    }
-
-  it_behaves_like 'it calls super', :included
-
-  it 'extends the descendant with module methods' do
-    subject
-    extended_modules = class << object; included_modules end
-    expect(extended_modules).to include(Memoizable::ModuleMethods)
-  end
-end

data/spec/unit/memoizable/fixtures/classes.rb

@@ -1,41 +0,0 @@
-# encoding: utf-8
-
-module Fixture
-  class Object
-    include Memoizable
-
-    def required_arguments(foo)
-    end
-
-    def optional_arguments(foo = nil)
-    end
-
-    def test
-      'test'
-    end
-
-    def zero_arity
-      caller
-    end
-
-    def one_arity(arg)
-    end
-
-    def public_method
-      caller
-    end
-
-  protected
-
-    def protected_method
-      caller
-    end
-
-  private
-
-    def private_method
-      caller
-    end
-
-  end # class Object
-end # module Fixture

data/spec/unit/memoizable/instance_methods/freeze_spec.rb

@@ -1,27 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-require File.expand_path('../../fixtures/classes', __FILE__)
-
-describe Memoizable::InstanceMethods, '#freeze' do
-  subject { object.freeze }
-
-  let(:described_class) { Class.new(Fixture::Object) }
-
-  before do
-    described_class.memoize(:test)
-  end
-
-  let(:object) { described_class.allocate }
-
-  it_should_behave_like 'a command method'
-
-  it 'freezes the object' do
-    expect { subject }.to change(object, :frozen?).from(false).to(true)
-  end
-
-  it 'allows methods not yet called to be memoized' do
-    subject
-    expect(object.test).to be(object.test)
-  end
-end

data/spec/unit/memoizable/instance_methods/memoize_spec.rb

@@ -1,40 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-require File.expand_path('../../fixtures/classes', __FILE__)
-
-describe Memoizable::InstanceMethods, '#memoize' do
-  subject { object.memoize(method => value) }
-
-  let(:described_class) { Class.new(Fixture::Object) }
-  let(:object)          { described_class.new        }
-  let(:method)          { :test                      }
-
-  before do
-    described_class.memoize(method)
-  end
-
-  context 'when the method is not memoized' do
-    let(:value) { String.new }
-
-    it 'sets the memoized value for the method to the value' do
-      subject
-      expect(object.send(method)).to be(value)
-    end
-
-    it_should_behave_like 'a command method'
-  end
-
-  context 'when the method is already memoized' do
-    let(:value)    { double }
-    let(:original) { nil    }
-
-    before do
-      object.memoize(method => original)
-    end
-
-    it 'raises an exception' do
-      expect { subject }.to raise_error(ArgumentError)
-    end
-  end
-end

data/spec/unit/memoizable/memory_spec.rb

@@ -1,24 +0,0 @@
-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

data/spec/unit/memoizable/method_builder/call_spec.rb

@@ -1,93 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-require File.expand_path('../../fixtures/classes', __FILE__)
-
-describe Memoizable::MethodBuilder, '#call' do
-  subject { object.call }
-
-  let(:object)   { described_class.new(descendant, method_name, freezer) }
-  let(:freezer)  { lambda { |object| object.freeze }                     }
-  let(:instance) { descendant.new                                        }
-
-  let(:descendant) do
-    Class.new do
-      include Memoizable
-
-      def public_method
-        __method__.to_s
-      end
-
-      def protected_method
-        __method__.to_s
-      end
-      protected :protected_method
-
-      def private_method
-        __method__.to_s
-      end
-      private :private_method
-    end
-  end
-
-  shared_examples_for 'Memoizable::MethodBuilder#call' do
-    it_should_behave_like 'a command method'
-
-    it 'creates a method that is memoized' do
-      subject
-      expect(instance.send(method_name)).to be(instance.send(method_name))
-    end
-
-    it 'creates a method that returns the expected value' do
-      subject
-      expect(instance.send(method_name)).to eql(method_name.to_s)
-    end
-
-    it 'creates a method that returns a frozen value' do
-      subject
-      expect(descendant.new.send(method_name)).to be_frozen
-    end
-
-    it 'creates a method that does not accept a block' do
-      subject
-      expect { descendant.new.send(method_name) {} }.to raise_error(
-        described_class::BlockNotAllowedError,
-        "Cannot pass a block to #{descendant}##{method_name}, it is memoized"
-      )
-    end
-  end
-
-  context 'public method' do
-    let(:method_name) { :public_method }
-
-    it_should_behave_like 'Memoizable::MethodBuilder#call'
-
-    it 'creates a public memoized method' do
-      subject
-      expect(descendant).to be_public_method_defined(method_name)
-    end
-  end
-
-  context 'protected method' do
-    let(:method_name) { :protected_method }
-
-    it_should_behave_like 'Memoizable::MethodBuilder#call'
-
-    it 'creates a protected memoized method' do
-      subject
-      expect(descendant).to be_protected_method_defined(method_name)
-    end
-
-  end
-
-  context 'private method' do
-    let(:method_name) { :private_method }
-
-    it_should_behave_like 'Memoizable::MethodBuilder#call'
-
-    it 'creates a private memoized method' do
-      subject
-      expect(descendant).to be_private_method_defined(method_name)
-    end
-  end
-end

data/spec/unit/memoizable/method_builder/class_methods/new_spec.rb

@@ -1,34 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-require File.expand_path('../../../fixtures/classes', __FILE__)
-
-describe Memoizable::MethodBuilder, '.new' do
-  subject { described_class.new(descendant, method_name, freezer) }
-
-  let(:descendant) { Fixture::Object                   }
-  let(:freezer)    { lambda { |object| object.freeze } }
-
-  context 'with a zero arity method' do
-    let(:method_name) { :zero_arity }
-
-    it { should be_instance_of(described_class) }
-
-    it 'sets the original method' do
-      # original method is not memoized
-      method = subject.original_method.bind(descendant.new)
-      expect(method.call).to_not be(method.call)
-    end
-  end
-
-  context 'with a one arity method' do
-    let(:method_name) { :one_arity }
-
-    it 'raises an exception' do
-      expect { subject }.to raise_error(
-        described_class::InvalidArityError,
-        'Cannot memoize Fixture::Object#one_arity, its arity is 1'
-      )
-    end
-  end
-end

data/spec/unit/memoizable/method_builder/original_method_spec.rb

@@ -1,31 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-describe Memoizable::MethodBuilder, '#original_method' do
-  subject { object.original_method }
-
-  let(:object)      { described_class.new(descendant, method_name, freezer) }
-  let(:method_name) { :foo                                                  }
-  let(:freezer)     { lambda { |object| object.freeze }                     }
-
-  let(:descendant) do
-    Class.new do
-      def initialize
-        @foo = 0
-      end
-
-      def foo
-        @foo += 1
-      end
-    end
-  end
-
-  it { should be_instance_of(UnboundMethod) }
-
-  it 'returns the original method' do
-    # original method is not memoized
-    method = subject.bind(descendant.new)
-    expect(method.call).to_not be(method.call)
-  end
-end

data/spec/unit/memoizable/module_methods/included_spec.rb

@@ -1,23 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-describe Memoizable::ModuleMethods, '#included' do
-  subject { descendant.instance_exec(object) { |mod| include mod } }
-
-  let(:object)     { Module.new.extend(described_class) }
-  let(:descendant) { Class.new                          }
-  let(:superclass) { Module                             }
-
-  before do
-    # Prevent Module.included from being called through inheritance
-    Memoizable.stub(:included)
-  end
-
-  it_behaves_like 'it calls super', :included
-
-  it 'includes Memoizable into the descendant' do
-    subject
-    expect(descendant.included_modules).to include(Memoizable)
-  end
-end