memoize_method 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 625db8efd68673a84c9b1f7f5acd20dcc0cd1a2c
+  data.tar.gz: aec37329d8f3b6c7ad748147503f7e673a8aa537
+SHA512:
+  metadata.gz: a08d034547a8cbc1fd48d78ea8426e24ab1a221c36fb8e77a9c59674f721a3daf2549172fdddcfe85508e0d320b934ebb91cc623fb5bf089e85a153b8b8589e5
+  data.tar.gz: 4b0c739fc9ef0cf11ad39fe882226d6c2d034c2f75ec76ea872ce7eb5d2fa7212d35eb64a5b5222fd43b76b75ffbf982d66818127421ab1c70a3d4f5e4c18afb

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,89 @@
+# MemoizeMethod
+
+Memoize Method lets you memoize the return value of methods methods with a single word.
+
+```ruby
+cache def my_expensive_computation
+  ...
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'memoize_method'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install memoize_method
+
+## Usage
+
+You are going to want to extend MemoizeMethod in your class
+
+```ruby
+class A
+  extend MemoizeMethod
+end
+
+irb> A.methods - Object.methods
+=> [:cache]
+```
+
+Now lets cache our method.
+
+```ruby
+class A
+  extend MemoizeMethod
+  cache def foo
+    Time.now
+  end
+end
+
+irb> A.new.methods - Object.new.methods
+=> [:foo, :cacheless_foo, :recompute_foo]
+```
+
+Now you have 3 methods where you defined `foo`,
+- `foo` is will compute the first time, then cache after that.
+- `cacheless_foo` lets you get at the current value without busting the cache.
+- `recompute_foo` will bust the cache and assign it to the new value.
+
+Example:
+```ruby
+irb> a = A.new
+=> #<A:0x007f98212599f8>
+irb> a.foo
+=> 2015-11-15 10:38:09 -0800
+irb> a.foo
+=> 2015-11-15 10:38:09 -0800
+irb> a.foo == a.foo
+=> true
+irb> a.cacheless_foo
+=> 2015-11-15 10:38:41 -0800
+irb> a.cacheless_foo != a.foo
+=> true
+irb(main):018:0> a.recompute_foo
+=> 2015-11-15 10:41:01 -0800
+irb(main):019:0> a.foo
+=> 2015-11-15 10:41:01 -0800
+irb(main):020:0> a.recompute_foo == a.foo
+=> true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` 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/hparker/memoize_method.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "memoize_method"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/memoize_method.rb

@@ -0,0 +1,18 @@
+require "memoize_method/version"
+
+module MemoizeMethod
+  def cache(method)
+    cacheless_method = "cacheless_" + method.to_s
+    recompute_method = "recompute_" + method.to_s
+    cache_var = "@" + method.to_s + "_cache"
+    alias_method cacheless_method, method
+    define_method(method) { |*args|
+      instance_eval(cache_var) ||
+        instance_eval("#{cache_var} ||= send(cacheless_method, *args)")
+    }
+
+    define_method(recompute_method) { |*args|
+      instance_eval("#{cache_var} = send(cacheless_method, *args)")
+    }
+  end
+end

data/lib/memoize_method/version.rb

@@ -0,0 +1,3 @@
+module MemoizeMethod
+  VERSION = "0.1.0"
+end

data/memoize_method.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'memoize_method/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "memoize_method"
+  spec.version       = MemoizeMethod::VERSION
+  spec.authors       = ["Adam Hess"]
+  spec.email         = ["adamhess1991@gmail.com"]
+
+  spec.summary       = %q{allow simple caching of ruby methods.}
+  spec.description   = %q{will expose your method, which is cached, a cacheless version and a recompute version}
+  spec.homepage      = "https://github.com/HParker/ruby_memoize_method"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: memoize_method
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Hess
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: will expose your method, which is cached, a cacheless version and a recompute
+  version
+email:
+- adamhess1991@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/memoize_method.rb
+- lib/memoize_method/version.rb
+- memoize_method.gemspec
+homepage: https://github.com/HParker/ruby_memoize_method
+licenses: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: allow simple caching of ruby methods.
+test_files: []