dirty-memoize 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Claudio Bustos
+
+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.rdoc

@@ -0,0 +1,17 @@
+= dirty-memoize
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Claudio Bustos. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dirty-memoize"
+    gem.summary = %Q{Memoize like object, with dirty setters}
+    gem.description = %Q{Works like Memoize [http://raa.ruby-lang.org/project/memoize/http://raa.ruby-lang.org/project/memoize/], but with a global cache. Thats allows to delete all cache when you use #clean() or call one of the methods specified on #dirty_writer }
+    gem.email = "clbustos@gmail.com"
+    gem.homepage = "http://github.com/clbustos/dirty-memoize"
+    gem.authors = ["Claudio Bustos"]
+    gem.add_development_dependency 'rspec'
+    gem.add_development_dependency 'jeweler'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dirty-memoize #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/dirty-memoize.rb

@@ -0,0 +1,84 @@
+# Like Memoize, but designed for mutable and parametizable objects
+# 
+# Use when: 
+# 1. You have one expensive method (\#compute) which set many internal
+#    variables. So, is preferable lazy evaluation of these dependent variables.
+# 2. The expensive operation depends on one or more parameters
+# 3. Changes on one or more parameters affect all dependent variables
+# 4. You may want to hide the call of 'compute' operation
+# 5. The user could want test several different parameters values
+#  
+# By default, the method to compute should be called \#compute. 
+# Set constant DIRTY_COMPUTE to the name of other method if you need it
+#
+# Example:
+#  class ExpensiveCalculation
+#   extend DirtyMemoize
+#   attr_accessor :y, :z
+#   def initialize(y=nil,z=nil)
+#     @y=y
+#     @z=z
+#   def compute
+#     @a=@y*1000+@z*1000
+#   end
+#   def a
+#      @a.nil? nil : "This is the value: #{@a}"
+#   end
+# 
+#  end
+#  puts ExpensiveCalculation.new(1,2).a
+
+module DirtyMemoize
+  # Trick from http://github.com/ecomba/memoizable
+  def self.included(receiver) #:nodoc:
+    receiver.extend DirtyMemoize::ClassMethods
+  end
+  module ClassMethods
+    # Set variables which 
+    def dirty_writer(*independent)
+      independent.each do |sym|
+        sym=sym.to_s+"="
+        alias_method((sym.to_s+"_whitout_dirty").intern, sym)
+        define_method(sym) do |*args|
+          @dirty=true
+          send(sym.to_s+"_whitout_dirty", *args)
+        end
+      end
+    end
+    
+    def dirty_memoize(*dependent)
+      dependent.each do |sym|
+        alias_method((sym.to_s+"_without_dirty").intern, sym)
+        define_method(sym) {|*args|
+          if(dirty?)
+            clean_cache
+            if self.class.const_defined? "DIRTY_COMPUTE"
+              send(self.class.const_get("DIRTY_COMPUTE"))
+            else
+              send(:compute)
+            end
+            @compute_count||=0
+            @compute_count+=1
+            @dirty=false
+          end
+          @cache[sym]||=Hash.new
+          @cache[sym][args]||=send(sym.to_s+"_without_dirty", *args)
+        }
+      end
+    end
+  end # end of ClassMethods
+  # Is the object dirty?
+  def dirty?
+    @dirty=true if @dirty.nil?
+    @dirty
+  end
+  # Number of compute's runs
+  def compute_count
+    @compute_count||=0
+  end
+  def clean_cache
+    @cache=Hash.new
+    @dirty=true
+  end
+  
+end

data/spec/dirty_memoize_spec.rb

@@ -0,0 +1,133 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class ExpensiveClass
+  attr_writer :x, :y
+  attr_reader :count
+  include DirtyMemoize
+  def initialize
+    @a=nil
+    @b=nil
+    @x='x'
+    @y='y'
+    @compute_called=false
+  end
+  def set_a(aa)
+    @a=aa
+  end
+  def compute_called?
+    @compute_called
+  end
+  def compute
+    @a=@x
+    @b=@y
+    @compute_called=true
+  end
+  def a
+    "@a=#{@a}"
+  end
+  def b
+    "@b=#{@b}"
+  end    
+  dirty_writer :x, :y
+  dirty_memoize :a, :b
+end
+
+class ExpensiveClass2 < ExpensiveClass
+  DIRTY_COMPUTE=:compute2
+  def compute2
+    @a=@x+".2"
+  end
+end
+describe DirtyMemoize, "extended object" do
+  before(:each) do
+    @ec=ExpensiveClass.new
+  end
+  it "should initialize with dirty? to true" do 
+    @ec.dirty?.should==true
+  end
+  it "should initialize with number of computation to 0" do
+    @ec.compute_count.should==0
+  end
+  describe "reads 'dirty' attributes " do
+    before(:each) do
+      @ec.a
+    end
+    it "#compute is called" do
+      @ec.compute_called?.should==true
+    end
+    it 'compute_count set to 1' do
+      @ec.compute_count.should==1
+    end
+    it 'dirty? set to false' do
+      @ec.dirty?.should==false
+    end
+    it "compute_count doesn't change with multiple calls" do
+      5.times {@ec.a}
+      @ec.compute_count.should==1
+    end
+  end
+  describe "calls dirty writers before dirty getter" do
+    before(:each) do
+      @ec.x="cache"
+    end
+    it 'set dirty? to true' do
+      @ec.dirty?.should==true
+    end
+    it "doesn't call compute" do
+      @ec.compute_called?.should==false
+    end
+    it "doesn't change dirty getters" do
+      @ec.instance_variable_get("@a").nil?.should==true
+    end
+  end
+  
+  describe "calls dirty getter after call dirty writer" do
+    before(:each) do
+      @ec.x="cache"
+      @ec.a
+    end
+    it 'set dirty? to false' do
+      @ec.dirty?.should==false
+    end    
+    it "calls compute, only once" do
+      @ec.compute_called?.should==true
+      @ec.compute_count.should==1      
+    end
+    it "set value or internal variable" do
+      @ec.instance_variable_get("@a").should=='cache'
+    end
+    it 'set getter method with a different value' do
+      @ec.a.should=='@a=cache'
+    end
+  end
+  describe "uses cache" do
+    before(:each) do
+      @ec.x='cache'
+      @ec.a
+      @ec.set_a('not_cache')
+    end
+    it "so changing internal variables  doesn't produce external changes" do 
+      @ec.instance_variable_get("@a").should=='not_cache'
+      @ec.compute_count.should==1
+      @ec.a.should=='@a=cache'
+    end
+    it "so deleting it implies calculate all again" do
+      @ec.dirty?.should==false
+      @ec.clean_cache
+      @ec.dirty?.should==true
+      @ec.compute_count.should==1
+      @ec.a.should=='@a=cache'
+      @ec.compute_count.should==2
+      
+    end
+  end
+  describe "could call other computation method" do 
+    it "using DIRTY_COMPUTER" do
+      @ec2=ExpensiveClass2.new
+      @ec2.x='cache'
+      @ec2.a.should=='@a=cache.2'
+      @ec2.compute_count.should==1
+      
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+-f s

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'dirty-memoize.rb'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end
+
+class String
+  def deindent
+    gsub /^[ \t]*/, ''
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: dirty-memoize
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Claudio Bustos
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-01 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: "Works like Memoize [http://raa.ruby-lang.org/project/memoize/http://raa.ruby-lang.org/project/memoize/], but with a global cache. Thats allows to delete all cache when you use #clean() or call one of the methods specified on #dirty_writer "
+email: clbustos@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/dirty-memoize.rb
+- spec/dirty_memoize_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/clbustos/dirty-memoize
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Memoize like object, with dirty setters
+test_files: 
+- spec/spec_helper.rb
+- spec/dirty_memoize_spec.rb