attr_memoizer 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+*.idea
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matthew McEachen
+
+MIT License
+
+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,99 @@
+# AttrMemoizer [![Build Status](https://api.travis-ci.org/mceachen/attr_memoizer.png?branch=master)](https://travis-ci.org/mceachen/attr_memoizer)
+
+The common ruby idiom for attribute [memoization](http://en.wikipedia.org/wiki/Memoization)
+looks like this:
+
+``` ruby
+class Example
+  def field
+    @field ||= some_expensive_task()
+  end
+end
+```
+
+If ```some_expensive_task``` can return a "falsy" value (like ```nil``` or ```false```), this
+doesn't work correctly—the prior memoized value of
+```some_expensive_task``` will be ignored, and every subsequent call to ```field``` will result
+in another call to ```some_expensive_task```.
+
+<strong>AttrMemoizer aims to usurp your misbegotten love of ```||=```.</strong>
+
+## Usage
+
+1. ```include AttrMemoizer```
+2. Call ```attr_memoizer``` with the attributes you want memoized
+3. Throw your ```@something ||=``` **on the [ground](http://en.wikipedia.org/wiki/Threw_It_on_the_Ground)**.
+
+``` ruby
+class Example
+  include AttrMemoizer
+  attr_memoizer :field, :another_field
+
+  def field
+    # code that computes field
+  end
+
+  def another_field
+    # code that computes another_field
+  end
+end
+```
+
+Calling ```Example.new.field``` will call your definition of ```field```, memoize the result
+for subsequent calls to an ivar called ```@field```, and return that value.
+
+Note that caching method results does **not** span instances:
+
+``` ruby
+class TimeHolder
+  include AttrMemoizer
+  attr_memoizer :a_time
+
+  def a_time
+    Time.now
+  end
+end
+
+t = TimeHolder.new
+t.a_time
+#> 2013-01-01 00:00:00 -0800
+sleep 1
+t.a_time
+#> 2013-01-01 00:00:00 -0800 # < this is the memoized value
+
+# But with a new instance, we get a new value:
+TimeHolder.new.a_time
+#> 2013-01-01 20:26:41 -0800
+```
+
+### Gotcha
+
+To keep the metaprogramming demons at bay, we're using ```alias_method``` to rename the method—if
+you rename the attribute or look for consumers of the attribute, you at least has a chance of
+finding the attribute and their consumers, as opposed to how deferred_attribute worked, which made
+you call a method that only existed after the attr_memoizer method ran.
+
+The problem with using ```alias_method``` at the time that ```attr_memoizer``` is called, is that
+the method may not be defined in the class yet. To get around this issue, we implement the
+class-level ```method_added``` hook, and set up the memoization after the method is defined.
+
+If you are also using ```method_added```, remember to call ```super``` at the end of your
+implementation. See the test cases for examples, and proof that this nonsense all works.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'attr_memoizer'
+```
+
+And then execute:
+
+    $ bundle
+
+## Changelog
+
+### 0.0.1
+
+* There were previous names for this library. We won't speak of them again.

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', 'README.md']
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.libs.push "test"
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/attr_memoizer.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attr_memoizer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "attr_memoizer"
+  gem.version       = AttrMemoizer::VERSION
+  gem.authors       = ["Matthew McEachen"]
+  gem.email         = ["matthew+github@mceachen.org"]
+  gem.description   = %q{Correct attribute memoization for ruby, made easy}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/mceachen/attr_memoizer"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^test/})
+  gem.require_paths = ["lib"]
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'minitest-great_expectations'
+end

data/lib/attr_memoizer.rb

@@ -0,0 +1,33 @@
+require "attr_memoizer/version"
+
+module AttrMemoizer
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+
+  module ClassMethods
+    def attr_memoizer(*attrs)
+      attrs_to_memoize.concat(attrs.collect { |ea| ea.to_sym }).uniq!
+      # OMG 1.8.7 RETURNS STRINGS
+      existing_methods = self.instance_methods(true).collect { |ea| ea.to_sym }
+      (existing_methods & attrs_to_memoize).each do |name|
+        attrs_to_memoize.delete(name)
+        class_eval <<-RUBY
+          alias_method :_#{name}, :#{name}
+          def #{name}
+            defined?(@#{name}) ? @#{name} : @#{name} = _#{name}()
+          end
+        RUBY
+      end
+    end
+
+    def attrs_to_memoize
+      @attrs_to_memoize ||= []
+    end
+
+    def method_added(method_name)
+      attr_memoizer(method_name) if attrs_to_memoize.include?(method_name)
+      super
+    end
+  end
+end

data/lib/attr_memoizer/version.rb

@@ -0,0 +1,3 @@
+module AttrMemoizer
+  VERSION = "0.0.1"
+end

data/test/attr_memoizer_test.rb

@@ -0,0 +1,106 @@
+require 'minitest_helper'
+
+describe AttrMemoizer do
+
+  before :each do
+    Target.call_count = 0
+  end
+
+  class Target
+    class << self
+      attr_accessor :call_count
+      attr_accessor :methods_added
+    end
+
+    self.methods_added = []
+    self.call_count = 0
+
+    def self.method_added(method_name)
+      self.methods_added << method_name
+      super
+    end
+
+    def already_defined_field
+      "prething#{self.class.call_count += 1}"
+    end
+
+    include AttrMemoizer
+    attr_memoizer :thing, :already_defined_field
+    attr_memoizer :one_more_thing
+
+    def thing
+      "thing#{self.class.call_count += 1}"
+    end
+
+    def one_more_thing
+      "iThing#{self.class.call_count += 1}"
+    end
+  end
+
+  class TargetWithMethodsAddedAfter
+    class << self
+      attr_accessor :methods_added
+      attr_accessor :call_count
+    end
+
+    self.methods_added = []
+    self.call_count = 0
+
+    include AttrMemoizer
+    attr_memoizer :thing
+
+    def self.method_added(method_name)
+      self.methods_added << method_name
+      super
+    end
+
+    def thing
+      "thing#{self.class.call_count += 1}"
+    end
+  end
+
+  it "doesn't call on initialize" do
+    Target.new
+    Target.call_count.must_equal 0
+  end
+
+  it "doesn't hide prior-defined method_added" do
+    Target.methods_added.must_include_all [:already_defined_field, :thing, :one_more_thing]
+  end
+
+  it "doesn't hide post-defined method_added" do
+    TargetWithMethodsAddedAfter.methods_added.must_include_all [:thing]
+  end
+
+  it "works for post-defined method_added classes" do
+    t = TargetWithMethodsAddedAfter.new
+    t.thing.must_equal "thing1"
+    t.thing.must_equal "thing1"
+  end
+
+  it "works for already-defined fields" do
+    t = Target.new
+    t.already_defined_field.must_equal "prething1"
+    t.already_defined_field.must_equal "prething1"
+  end
+
+  it "works for fields defined after attr_memoizer" do
+    t = Target.new
+    t.thing.must_equal "thing1"
+    t.thing.must_equal "thing1"
+  end
+
+  it "works for multiple calls to attr_memoizer" do
+    t = Target.new
+    t.one_more_thing.must_equal "iThing1"
+    t.one_more_thing.must_equal "iThing1"
+    Target.new.one_more_thing.must_equal "iThing2"
+  end
+
+  it "doesn't pollute other instances" do
+    targets = 3.times.collect { Target.new }
+    targets.collect { |ea| ea.thing }.must_equal %w(thing1 thing2 thing3)
+    Target.new.thing.must_equal "thing4"
+    targets.collect { |ea| ea.thing }.must_equal %w(thing1 thing2 thing3)
+  end
+end

data/test/minitest_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/great_expectations'
+require 'minitest/autorun'
+require 'attr_memoizer'

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: attr_memoizer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthew McEachen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-great_expectations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Correct attribute memoization for ruby, made easy
+email:
+- matthew+github@mceachen.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- attr_memoizer.gemspec
+- lib/attr_memoizer.rb
+- lib/attr_memoizer/version.rb
+- test/attr_memoizer_test.rb
+- test/minitest_helper.rb
+homepage: https://github.com/mceachen/attr_memoizer
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4020524827246179430
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4020524827246179430
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Correct attribute memoization for ruby, made easy
+test_files:
+- test/attr_memoizer_test.rb
+- test/minitest_helper.rb
+has_rdoc: