dirty-memoize 0.0.3 → 0.0.4

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.0.4 / 2011-01-26
+* Better specs
+* Build managed with Hoe

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+LICENSE.txt
+Manifest.txt
+README.txt
+Rakefile
+examples/only_reader.rb
+examples/reader_and_writer.rb
+lib/dirty-memoize.rb
+spec/dirty_memoize_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/README.txt

@@ -0,0 +1,64 @@
+= dirty-memoize
+
+* http://github.com/clbustos/dirty-memoize
+
+== DESCRIPTION 
+
+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
+
+== SYNOPSIS
+
+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:
+ 
+    require 'dirty-memoize'
+    
+    class Factorial
+    include DirtyMemoize
+    attr_reader :result
+    attr_writer :n
+    dirty_memoize :result
+    dirty_writer :n
+    
+    def initialize
+    @n=nil
+    @result=nil
+    end
+    def fact(n)
+    return 1 if n==1
+    n*(fact(n-1))
+    end
+    def compute
+    puts "Computing the factorial!"
+    @result=fact(@n)
+    end
+    end
+    
+    a=Factorial.new
+    a.n=10
+    puts "Our object is dirty: #{a.dirty?}"
+    puts "The result is: #{a.result}"
+    puts "Our object is no longer dirty: #{a.dirty?}"
+    puts "And the result is cached without calling the compute method: #{a.result}"
+    puts "Now, n is changed to 5"
+    a.n=5
+    # Object is now dirty. So, compute will be called when we get result
+    puts "The result is: #{a.result}"
+
+== Sugestions
+
+* Fork, modify and do wathever you need with it. 
+
+== Copyright
+
+Copyright (c) 2010-2011 Claudio Bustos. See LICENSE for details.

data/Rakefile

@@ -1,52 +1,20 @@
+$:.unshift(File.expand_path(File.dirname(__FILE__)+"/lib"))
+$:.unshift(File.expand_path(File.dirname(__FILE__)))
+
 require 'rubygems'
 require 'rake'
+require 'hoe'
+require 'dirty-memoize'
+require 'rspec'
+require 'rspec/core/rake_task'
 
-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') : ""
+Hoe.plugin :git
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "dirty-memoize #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+h=Hoe.spec 'dirty-memoize' do
+  self.testlib=:rspec
+  self.rspec_options << "-c" << "-b"
+  self.developer('Claudio Bustos', 'clbustos_at_gmail.com')
+  self.version=DirtyMemoize::VERSION
+  self.extra_dev_deps << ["rspec",">=2.0"] 
 end

data/examples/only_reader.rb

@@ -0,0 +1,34 @@
+$:.unshift(File.expand_path(File.dirname(__FILE__)+"/../lib"))
+# This example shows the use of dirty_memoize without dirty_writer.
+# When we call the method marked with dirty_memoize on a dirty object
+# compute method is called. 
+
+require 'dirty-memoize'
+
+class Factorial
+  include DirtyMemoize
+  attr_reader :result
+  dirty_memoize :result
+  def initialize(n)
+    @n=n
+    @result=nil
+  end
+  def fact(n)
+    return 1 if n==1
+    n*(fact(n-1))
+  end
+  def compute
+    puts "Computing the factorial!"
+    @result=fact(@n)
+  end
+end
+
+a=Factorial.new(10)
+puts "Our object is dirty: #{a.dirty?}"
+puts "The result is: #{a.result}"
+puts "Our object is no longer dirty: #{a.dirty?}"
+puts "And the result is cached without calling the compute method: #{a.result}"
+a.clean_cache
+# Object is now dirty. So, compute will be called when we get result
+puts "The result is: #{a.result}"
+

data/examples/reader_and_writer.rb

@@ -0,0 +1,40 @@
+$:.unshift(File.expand_path(File.dirname(__FILE__)+"/../lib"))
+# This example shows the use of dirty_memoize with dirty_writer.
+# When we call the method marked with dirty_memoize on a dirty object,
+# compute method is called. 
+# Setting a value on a dirty_writer set the object to dirty
+
+require 'dirty-memoize'
+
+class Factorial
+  include DirtyMemoize
+  attr_reader :result
+  attr_writer :n
+  dirty_memoize :result
+  dirty_writer :n
+
+  def initialize
+    @n=nil
+    @result=nil
+  end
+  def fact(n)
+    return 1 if n==1
+    n*(fact(n-1))
+  end
+  def compute
+    puts "Computing the factorial!"
+    @result=fact(@n)
+  end
+end
+
+a=Factorial.new
+a.n=10
+puts "Our object is dirty: #{a.dirty?}"
+puts "The result is: #{a.result}"
+puts "Our object is no longer dirty: #{a.dirty?}"
+puts "And the result is cached without calling the compute method: #{a.result}"
+puts "Now, n is changed to 5"
+a.n=5
+# Object is now dirty. So, compute will be called when we get result
+puts "The result is: #{a.result}"
+

data/lib/dirty-memoize.rb

@@ -29,6 +29,7 @@
 #  puts ExpensiveCalculation.new(1,2).a
 
 module DirtyMemoize
+  VERSION="0.0.4"
   # Trick from http://github.com/ecomba/memoizable
   def self.included(receiver) #:nodoc:
     receiver.extend DirtyMemoize::ClassMethods
@@ -38,10 +39,10 @@ module DirtyMemoize
     def dirty_writer(*independent)
       independent.each do |sym|
         sym=sym.to_s+"="
-        alias_method((sym.to_s+"_whitout_dirty").intern, sym)
+        alias_method((sym.to_s+"_without_dirty").intern, sym)
         define_method(sym) do |*args|
           @dirty=:true
-          send(sym.to_s+"_whitout_dirty", *args)
+          send(sym.to_s+"_without_dirty", *args)
         end
       end
     end
@@ -49,7 +50,7 @@ module DirtyMemoize
     def dirty_memoize(*dependent)
       dependent.each do |sym|
         alias_method((sym.to_s+"_without_dirty").intern, sym)
-        define_method(sym) {|*args|
+        define_method(sym) do |*args|
           if(dirty?)
             clean_cache
             if self.class.const_defined? "DIRTY_COMPUTE"
@@ -63,7 +64,7 @@ module DirtyMemoize
           end
           @cache[sym]||=Hash.new
           @cache[sym][args]||=send(sym.to_s+"_without_dirty", *args)
-        }
+        end
       end
     end
   end # end of ClassMethods

data/spec/dirty_memoize_spec.rb

@@ -2,25 +2,19 @@ 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}"
@@ -39,61 +33,55 @@ class ExpensiveClass2 < ExpensiveClass
   end
 end
 describe DirtyMemoize, "extended object" do
-  before(:each) do
+  before 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
+  subject { @ec }
+  context "when instanciated" do 
+	  it { should be_dirty}
+	  it "should initialize with number of computation to 0" do
+		  @ec.compute_count.should==0
+	  end
+	  it "read inmediatly the correct value" do
+		  @ec.a.should=='@a=x'
+	  end
   end
-  describe "reads 'dirty' attributes " do
-    before(:each) do
+  context "when reads 'dirty' attributes " do
+    before do
       @ec.a
     end
-    it "#compute is called" do
-      @ec.compute_called?.should==true
-    end
-    it 'compute_count set to 1' do
+	  it 'call compute' 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
+	  end
+	  it{ should_not be_dirty}
+    it "call compute once and only once" do
       5.times {@ec.a}
       @ec.compute_count.should==1
     end
   end
-  describe "calls dirty writers before dirty getter" do
-    before(:each) do
+  context "calls dirty writers before dirty getter" do
+    before do
       @ec.x="cache"
     end
-    it 'set dirty? to true' do
-      @ec.dirty?.should==true
+	  it { should be_dirty}
+    it "doesn't compute anything" do
+      @ec.compute_count.should==0
     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
+    it "doesn't change internal variables" do
+      @ec.instance_variable_get("@a").should be_nil
     end
   end
   
-  describe "calls dirty getter after call dirty writer" do
-    before(:each) do
+  describe "when calls dirty getter after call dirty writer" do
+    before 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
+	  it { @ec.should_not be_dirty}
+    it "calls compute only once" do
       @ec.compute_count.should==1      
     end
-    it "set value or internal variable" do
+    it "set value of internal variable" do
       @ec.instance_variable_get("@a").should=='cache'
     end
     it 'set getter method with a different value' do
@@ -101,24 +89,32 @@ describe DirtyMemoize, "extended object" do
     end
   end
   describe "uses cache" do
-    before(:each) do
+    before 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'
+    it "changing internal doesn't start compute" do 
       @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
+    it {should_not be_dirty}
+    it "doesn't change cache value" do
       @ec.a.should=='@a=cache'
-      @ec.compute_count.should==2
-      
+	  end
+    describe "when cleaning cache" do
+      before do
+        @ec.clean_cache
+      end
+      it {@ec.should be_dirty}
+      it "doesn't call compute" do
+        @ec.compute_count.should==1
+      end
+      describe "when get dirty attribute" do
+        it "returns correct value and call compute again" do
+          @ec.a.should=='@a=cache'
+          @ec.compute_count.should==2
+        end
+      end
     end
   end
   describe "could call other computation method" do 

data/spec/spec_helper.rb

@@ -1,12 +1,15 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.expand_path(File.dirname(__FILE__)+"/../lib"))
+begin
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/spec/"
+    add_group "Libraries", "lib"
+  end
+rescue LoadError
+end
+require 'rspec'
 require 'dirty-memoize.rb'
-require 'spec'
-require 'spec/autorun'
 
-Spec::Runner.configure do |config|
-  
-end
 
 class String
   def deindent

metadata

@@ -5,58 +5,97 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Claudio Bustos
 autorequire: 
 bindir: bin
-cert_chain: []
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDMjCCAhqgAwIBAgIBADANBgkqhkiG9w0BAQUFADA/MREwDwYDVQQDDAhjbGJ1
+  c3RvczEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
+  MB4XDTEwMDMyOTIxMzg1NVoXDTExMDMyOTIxMzg1NVowPzERMA8GA1UEAwwIY2xi
+  dXN0b3MxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
+  bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALf8JVMGqE7m5kYb+PNN
+  neZv2pcXV5fQCi6xkyG8bi2/SIFy/LyxuvLzEeOxBeaz1Be93bayIUquOIqw3dyw
+  /KXWa31FxuNuvAm6CN8fyeRYX/ou4cw3OIUUnIvB7RMNIu4wbgeM6htV/QEsNLrv
+  at1/mh9JpqawPrcjIOVMj4BIp67vmzJCaUf+S/H2uYtSO09F+YQE3tv85TPeRmqU
+  yjyXyTc/oJiw1cXskUL8UtMWZmrwNLHXuZWWIMzkjiz3UNdhJr/t5ROk8S2WPznl
+  0bMy/PMIlAbqWolRn1zl2VFJ3TaXScbqImY8Wf4g62b/1ZSUlGrtnLNsCYXrWiso
+  UPUCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFGu9
+  rrJ1H64qRmNNu3Jj/Qjvh0u5MA0GCSqGSIb3DQEBBQUAA4IBAQCV0Unka5isrhZk
+  GjqSDqY/6hF+G2pbFcbWUpjmC8NWtAxeC+7NGV3ljd0e1SLfoyBj4gnFtFmY8qX4
+  K02tgSZM0eDV8TpgFpWXzK6LzHvoanuahHLZEtk/+Z885lFene+nHadkem1n9iAB
+  cs96JO9/JfFyuXM27wFAwmfHCmJfPF09R4VvGHRAvb8MGzSVgk2i06OJTqkBTwvv
+  JHJdoyw3+8bw9RJ+jLaNoQ+xu+1pQdS2bb3m7xjZpufml/m8zFCtjYM/7qgkKR8z
+  /ZZt8lCiKfFArppRrZayE2FVsps4X6WwBdrKTMZ0CKSXTRctbEj1BAZ67eoTvBBt
+  rpP0jjs0
+  -----END CERTIFICATE-----
 
-date: 2010-04-01 00:00:00 -03:00
+date: 2011-01-26 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
+        - 2
         - 0
-        version: "0"
+        version: "2.0"
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: jeweler
+  name: hoe
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
+        - 2
+        - 8
         - 0
-        version: "0"
+        version: 2.8.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
+description: |-
+  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
+email: 
+- clbustos_at_gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
 files: 
-- .document
-- .gitignore
-- LICENSE
-- README.rdoc
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
 - Rakefile
-- VERSION
+- examples/only_reader.rb
+- examples/reader_and_writer.rb
 - lib/dirty-memoize.rb
 - spec/dirty_memoize_spec.rb
 - spec/spec.opts
@@ -67,10 +106,12 @@ licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --charset=UTF-8
+- --main
+- README.txt
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -78,6 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -86,11 +128,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.6
+rubyforge_project: dirty-memoize
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Memoize like object, with dirty setters
-test_files: 
-- spec/spec_helper.rb
-- spec/dirty_memoize_spec.rb
+summary: "Like Memoize, but designed for mutable and parametizable objects  Use when:  1"
+test_files: []
+

data/.document

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

data/.gitignore

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

data/README.rdoc

@@ -1,37 +0,0 @@
-= dirty-memoize
-
-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
-   include DirtyMemoize
-   attr_reader :a
-   attr_accesor :x
-   # Your evil function
-   def compute
-     @a=x**x**x
-   end
-  end
-  a=new ExpensiveCalculation
-  a.x=1
-  puts a.a
-
-== Sugestions
-
-* Fork, modify and do wathever you need with it. 
-
-== Copyright
-
-Copyright (c) 2010 Claudio Bustos. See LICENSE for details.

data/VERSION

@@ -1 +0,0 @@
-0.0.3