ruby_memoized 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8396b17290439869c6555618f070d73da03aa80
+  data.tar.gz: 3de622bd348b5295cb8b4c034446b600ce10ae88
+SHA512:
+  metadata.gz: 50183e3a8c22c13a61e3ad93d86b06a43d12505483bf2baf3c01c30775f12079bd41e3d13fc8f19ea43f06bfb069c8429005a626bc66d4d10d42d086e6a27a24
+  data.tar.gz: edf825b1725d51e115a713daf1c6ccff9b921627ea283f97259bb7dfbf1f62b6e4d17acc8b9cf9adcdd1b29f919931443ec66ee83456af93ea866bdb8f0e797e

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+memoized

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kirill Klimuk
+
+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

@@ -0,0 +1,132 @@
+# Memoized
+
+Memoized makes it easy to memoize methods, even if they have arguments or blocks, 
+by making memoization as easy as declaring a method private.
+To experiment with that code, run `bin/console` for an interactive prompt.
+
+For more information about the motivation behind the gem, 
+please see [this blog post](https://medium.com/@kklimuk/memoization-in-ruby-made-easy-a4b0f6c11846).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_memoized'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install memoized
+
+## Usage
+
+Suppose we have the following class:
+
+```ruby
+class FibonacciCalculator
+  def calculate(n)
+    return n if (0..1).include?(n)
+    calculate(n - 1) + calculate(n - 2)
+  end
+end
+```
+
+Right now, when we try to use this `FibonacciCalculator` for any larger number, it takes quite a while to compute since
+it has to perform the method calls in line 34.
+
+One of the ways we can make this computation much faster is to save (memoize) the pieces so they return immediately.
+Let's do that in a separate method:
+
+```ruby
+class FibonacciCalculator
+  def calculate(n)
+    return n if (0..1).include?(n)
+    calculate(n - 1) + calculate(n - 2)
+  end
+
+  memoized
+
+  def memoized_calculate(n)
+    return n if (0..1).include?(n)
+    memoized_calculate(n - 1) + memoized_calculate(n - 2)
+  end
+end
+```
+
+Here, we put a call to the `memoized` class method. This class method will allow us to make sure that the outputs of 
+any method calls below it will be saved (memoized).
+
+Let's see the how the performance of one stacks up against the other for an `n` of 35.
+
+```
+                    user       system    total     real
+with memoization    0.000000   0.000000  0.000000  ( 0.000469)
+without memoization 46.010000  0.160000  46.170000 (46.597599)
+```
+
+Cool, but now suppose we wrote another method that we didn't want memoized after `memoized_calculate`.
+We could unmemoize it by doing the following:
+
+```ruby
+class FibonacciCalculator
+  include Memoized
+
+  memoized
+
+  def memoized_calculate(n)
+    return n if (0..1).include?(n)
+    memoized_calculate(n - 1) + memoized_calculate(n - 2)
+  end
+  
+  unmemoized
+  
+  def calculate(n)
+    return n if (0..1).include?(n)
+    calculate(n - 1) + calculate(n - 2)
+  end
+end
+```
+
+Alright, that sounds all well and good. But what if we really didn't wanna call `include Memoized` everywhere but
+still wanted to use memoization?
+
+We could just add it to `Object`!
+
+```ruby
+class Object
+  include Memoized
+end
+```
+
+Now we make objects that use `memoized`/`unmemoized` willy-nilly.
+
+```ruby
+class RandomThing
+  memoize
+  def hardcore_calculation
+    # TODO: Write really hardcore calculation.
+  end
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kklimuk/memoized. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'memoized'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/memoized/memoizer.rb

@@ -0,0 +1,19 @@
+module Memoized
+  class Memoizer
+    attr_reader :context, :method
+
+    def initialize(context, method)
+      @context = context
+      @method = method
+    end
+
+    def call(*args, &block)
+      return cache[[args, block]] if cache.has_key?([args, block])
+      cache[[args, block]] = context.send(method, *args, &block)
+    end
+
+    def cache
+      @cache ||= {}
+    end
+  end
+end

data/lib/memoized/version.rb

@@ -0,0 +1,3 @@
+module Memoized
+  VERSION = '0.1.1'
+end

data/lib/memoized.rb

@@ -0,0 +1,44 @@
+require 'memoized/version'
+require 'memoized/memoizer'
+
+module Memoized
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def memoized
+      @memoized = true
+    end
+
+    def unmemoized
+      @memoized = false
+    end
+
+    def method_added(method_name)
+      if @memoized
+        @memoized = false
+
+        unmemoized_method_name = :"unmemoized_#{method_name}"
+
+        memoizer_name = :"memoizer_for_#{method_name}"
+        define_method memoizer_name do
+          memoizer = instance_variable_get "@#{memoizer_name}"
+          if memoizer
+            memoizer
+          else
+            instance_variable_set "@#{memoizer_name}", Memoizer.new(self, unmemoized_method_name)
+          end
+        end
+
+        alias_method unmemoized_method_name, method_name
+
+        define_method method_name do |*args, &block|
+          send(memoizer_name).call(*args, &block)
+        end
+
+        @memoized = true
+      end
+    end
+  end
+end

data/memoized.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'memoized/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby_memoized'
+  spec.version       = Memoized::VERSION
+  spec.authors       = ['Kirill Klimuk']
+  spec.email         = ['kklimuk@gmail.com']
+
+  spec.summary       = %q{Memoize method return values even with different arguments.}
+  spec.description   = <<-DESC.gsub(/\s\s+/, ' ')
+Memoized makes it easy to memoize methods, even if they have arguments or blocks, by making memoization as easy 
+as declaring a method private.
+  DESC
+  spec.homepage      = 'https://github.com/kklimuk/memoized'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  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 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: ruby_memoized
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Kirill Klimuk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-08 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'Memoized makes it easy to memoize methods, even if they have arguments
+  or blocks, by making memoization as easy as declaring a method private.
+
+'
+email:
+- kklimuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/memoized.rb
+- lib/memoized/memoizer.rb
+- lib/memoized/version.rb
+- memoized.gemspec
+homepage: https://github.com/kklimuk/memoized
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Memoize method return values even with different arguments.
+test_files: []