persistize 0.0.3

data/.gitignore

@@ -0,0 +1,2 @@
+doc/
+persistize-*.gem

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Luismi Cavallé & Sergio Gil
+
+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,73 @@
+=Persistize
+
+Persistize is a Rails plugin for easy denormalization. It works just like +memoize+ but it stores the value as an attribute in the database. You only need to write a method with the denormalization logic and a field in the database with the same name of the method. The field will get updated each time the record is saved:
+
+  class Person < ActiveRecord::Base
+    def full_name
+      "#{first_name} #{last_name}"
+    end
+  
+    persistize :full_name
+  end
+  
+  ...
+  
+  Person.create(:first_name => 'Jimi', :last_name => 'Hendrix')
+  Person.find_by_full_name('Jimi Hendrix') # #<Person id:1, first_name:"Jimi", last_name:"Hendrix", full_name:"Jimi Hendrix" ...>
+  
+==Dependency
+
+Sometimes you want to update the field not when the record is changed, but when some other associated records are. For example:
+
+  class Project < ActiveRecord::Base
+    has_many :tasks
+  
+    def completed?
+      tasks.any? && tasks.all?(&:completed?)
+    end
+  
+    persistize :completed?, :depending_on => :tasks
+  
+    named_scope :completed, :conditions => { :completed => true }
+  end
+
+  class Task < ActiveRecord::Base
+    belongs_to :project
+  end
+
+  ...
+
+  project = Project.create(:name => 'Rails')
+  task = project.tasks.create(:name => 'Make it scale', :completed => false)    
+  Project.completed  # []
+
+  task.update_attributes(:completed => true)
+  Project.completed  # [#<Project id:1, name:"Rails", completed:true ...>]
+    
+You can add more than one dependency using an array:
+
+  persistize :summary, :depending_on => [:projects, :people, :tasks]
+
+These examples are just some of the possible applications of this pattern, your imagination is the limit =;-) If you can find better examples, please send them to us.
+
+==Install
+
+===As a plugin (Rails >= 2.1.0)
+
+  $ script/plugin install git://github.com/porras/persistize.git
+  
+===As a gem (Rails >= 2.1.0)
+
+  # in config/environment.rb
+  config.gem "porras-persistize", :lib => "persistize", :source => "http://gems.github.com"
+  
+And then:
+
+  $ [sudo] rake gems:install
+
+==To-do
+
+* More kinds of dependencies (+has_one+, <code>has_many :through</code>)
+* Make cache optional (cache can cause records to be inconsistent if changed and not saved so it would be nice to be able to deactivate it)
+
+Copyright (c) 2008 Luismi Cavallé & Sergio Gil, released under the MIT license

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the persistize plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the persistize plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Persistize'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "persistize"
+    gemspec.authors = ["Sergio Gil", "Luismi Cavallé"]
+    gemspec.email = "ballsbreaking@bebanjo.com"
+    gemspec.homepage = "http://github.com/bebanjo/persistize"
+    gemspec.summary = "Easy denormalization for your ActiveRecord models"
+    gemspec.extra_rdoc_files = ["README.rdoc"]
+  end
+rescue LoadError
+end

data/VERSION

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

data/init.rb

@@ -0,0 +1 @@
+require 'persistize'

data/lib/persistize.rb

@@ -0,0 +1,99 @@
+module Persistize
+  module ClassMethods
+    def persistize(*args)
+      options = args.pop if args.last.is_a?(Hash)
+      
+      args.each do |method|
+        attribute = method.to_s.sub(/\?$/, '')
+        
+        original_method = :"_unpersistized_#{attribute}"
+        update_method   = :"_update_#{attribute}"
+        
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          alias #{original_method} #{method}                # alias _unpersistized_full_name full_name
+                                                            # 
+          def #{method}                                     # def full_name
+            if new_record?                                  #   if new_record?
+              #{original_method}                            #     _unpersistized_full_name
+            else                                            #   else
+              self[:#{attribute}]                           #     self[:full_name]
+            end                                             #   end
+          end                                               # end
+                                                            # 
+          before_save :#{update_method}                     # before_save :_update_full_name
+                                                            # 
+          def #{update_method}                              # def _update_full_name
+            self[:#{attribute}] = #{original_method}        #   self[:full_name] = _unpersistized_full_name
+            true # return true to avoid canceling the save  #   true
+          end                                               # end
+                                                            # 
+          def #{update_method}!                             # def _update_full_name!
+            #{update_method}                                #   _update_full_name
+            save! if #{attribute}_changed?                  #   save! if full_name_changed?
+          end                                               # end
+        RUBY
+
+        if options && options[:depending_on]
+          dependencies = [options[:depending_on]].flatten
+          
+          dependencies.each do |dependency|
+            generate_callback(reflections[dependency], update_method)
+          end
+        end
+        
+      end
+    end
+    
+    private
+    
+    def generate_callback(association, update_method)
+      callback_name = :"#{update_method}_in_#{self.to_s.underscore}_callback"
+      association_type = "#{association.macro}#{'_through' if association.through_reflection}"
+      generate_method = :"generate_#{association_type}_callback"
+      unless respond_to?(generate_method, true)
+        raise "#{association_type} associations are not supported by persistize" 
+      end
+      send(generate_method, association, update_method, callback_name)
+    end
+    
+    def generate_has_many_callback(association, update_method, callback_name)
+      association.klass.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{callback_name}                                                     # def _update_completed_in_project_callback
+          return true unless parent_id = self[:#{association.primary_key_name}]  #   return true unless parent_id = self[:project_id]
+          parent = #{self.name}.find(parent_id)                                  #   parent = Project.find(parent_id)
+          parent.#{update_method}!                                               #   parent._update_completed!
+        end                                                                      # end
+        after_save :#{callback_name}                                             # after_save :_update_completed_in_project_callback
+        after_destroy :#{callback_name}                                          # after_destroy :_update_completed_in_project_callback
+      RUBY
+    end
+    
+    def generate_has_many_through_callback(association, update_method, callback_name)                         
+      association.klass.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{callback_name}                                                                                # def _update_completed_in_person_callback
+          return true unless through_id = self[:#{association.through_reflection.association_foreign_key}]  #   return true unless through_id = self[:project_id]
+          through = #{association.through_reflection.class_name}.find(through_id)                           #   through = Project.find(through_id)                         
+          return true unless parent_id = through[:#{association.primary_key_name}]                          #   return true unless parent_id = self[:person_id]
+          parent = #{self.name}.find(parent_id)                                                             #   parent = Person.find(person_id)
+          parent.#{update_method}!                                                                          #   parent._update_completed!
+        end                                                                                                 # end
+        after_save :#{callback_name}                                                                        # after_save :_update_completed_in_person_callback
+        after_destroy :#{callback_name}                                                                     # after_destroy :_update_completed_in_person_callback
+      RUBY
+    end
+    
+    def generate_belongs_to_callback(association, update_method, callback_name)
+      association.klass.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{callback_name}                                                                  # def _update_project_name_in_task_callback
+          childs = #{self.name}.all(:conditions => {:#{association.primary_key_name} => id})  #   childs = Task.all(:conditions => {:project_id => id})
+          childs.each(&:"#{update_method}!")                                                  #   childs.each(&:"_update_project_name!")
+        end                                                                                   # end
+        after_save :#{callback_name}                                                          # after_save :_update_project_name_in_task_callback
+        after_destroy :#{callback_name}                                                       # after_destroy :_update_project_name_in_task_callback
+      RUBY
+    end
+  
+  end
+end
+
+ActiveRecord::Base.extend(Persistize::ClassMethods)

data/persistize.gemspec

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{persistize}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sergio Gil", "Luismi Cavall\303\251"]
+  s.date = %q{2009-05-22}
+  s.email = %q{ballsbreaking@bebanjo.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/persistize.rb",
+     "persistize.gemspec",
+     "test/models/company.rb",
+     "test/models/person.rb",
+     "test/models/project.rb",
+     "test/models/task.rb",
+     "test/persistize_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/bebanjo/persistize}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Easy denormalization for your ActiveRecord models}
+  s.test_files = [
+    "test/models/company.rb",
+     "test/models/person.rb",
+     "test/models/project.rb",
+     "test/models/task.rb",
+     "test/persistize_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/models/company.rb

@@ -0,0 +1,10 @@
+class Company < ActiveRecord::Base
+  has_many :people
+  has_many :tasks
+  
+  def summary
+    "#{name} has #{people.count} people and #{tasks.count} tasks"
+  end
+  
+  persistize :summary, :depending_on => [ :people, :tasks ]
+end

data/test/models/person.rb

@@ -0,0 +1,20 @@
+class Person < ActiveRecord::Base
+  
+  has_many :projects
+  has_many :tasks, :through => :projects
+  
+  def full_name
+    "#{first_name} #{last_name}"
+  end
+  
+  def initials
+    "#{first_name.first}#{last_name.first}".upcase
+  end
+  
+  def info
+    "#{full_name} has #{tasks.count} tasks in #{projects.count} projects"
+  end
+  
+  persistize :full_name, :initials
+  persistize :info, :depending_on => [:projects, :tasks]
+end

data/test/models/project.rb

@@ -0,0 +1,10 @@
+class Project < ActiveRecord::Base
+  has_many :tasks
+  belongs_to :person
+  
+  def completed?
+    tasks.any? && tasks.all?(&:completed?)
+  end
+  
+  persistize :completed?, :depending_on => :tasks
+end

data/test/models/task.rb

@@ -0,0 +1,9 @@
+class Task < ActiveRecord::Base
+  belongs_to :project
+  
+  def project_name
+    project && project.name
+  end
+  
+  persistize :project_name, :depending_on => :project
+end

data/test/persistize_test.rb

@@ -0,0 +1,115 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class PersistizeTest < Test::Unit::TestCase
+  
+  context "Using persistize" do
+  
+    setup do
+      setup_db
+    end
+  
+    teardown do
+      drop_db
+    end
+  
+    context "a person" do
+    
+      setup do
+        @person = Person.create(:first_name => "Jimi", :last_name => "Hendrix")
+      end
+    
+      should "update the value of full name in the database when created" do
+        assert_equal('Jimi Hendrix', @person[:full_name])
+        assert_equal(@person, Person.find_by_full_name('Jimi Hendrix'))
+      end
+    
+      should "update the value of full name in the database when updated" do
+        @person.update_attributes!(:first_name => "Axl", :last_name => "Rose")
+        assert_equal('Axl Rose', @person[:full_name])
+        assert_equal(@person, Person.find_by_full_name('Axl Rose'))
+      end    
+    
+      should "not update the calculated value until saved" do
+        @person.first_name = 'Axl'
+        assert_equal('Jimi Hendrix', @person.full_name)
+        # TODO: Rethink this behaviour. Do we want to cache or not?
+      end
+    
+      should "call the method when reading before being created" do
+        person = Person.new(:first_name => "Jimi", :last_name => "Hendrix")
+        assert_equal('Jimi Hendrix', person.full_name)
+      end
+    
+      should "also persistize #initials" do
+        assert_equal('JH', @person[:initials])
+      end
+    
+    end
+  
+    context "a project with tasks" do
+    
+      setup do
+        @project = Project.create(:name => "Rails")
+        @task = @project.tasks.create(:completed => true)
+      end
+      
+      should "update @project#completed? when a new task is created" do
+        Task.create(:project_id => @project.id, :completed => false)
+        assert !@project.reload[:completed]
+      end
+    
+      should "update @project#completed? when a task is deleted" do
+        @task.destroy
+        assert !@project.reload[:completed]
+      end
+      
+      should "update @project#completed? when a task is updated" do
+        @task.update_attributes!(:completed => false)
+        assert !@project.reload[:completed]
+      end
+      
+      should "update each task's #project_name when the project name is updated" do
+        @project.update_attributes!(:name => "Merb")
+        assert_equal "Merb", @task.reload[:project_name]
+      end
+    end
+    
+    context "a company with people and tasks" do
+      
+      setup do
+        @company = Company.create(:name => "BeBanjo")
+      end
+      
+      should "update summary when it is created" do
+        assert_equal("BeBanjo has 0 people and 0 tasks", @company.reload[:summary])
+      end
+      
+      should "update summary when a person is created" do
+        @company.people.create(:first_name => 'Bruce', :last_name => 'Dickinson')
+        assert_equal("BeBanjo has 1 people and 0 tasks", @company.reload[:summary])
+      end
+      
+      should "update summary when a task created" do
+        @company.tasks.create
+        assert_equal("BeBanjo has 0 people and 1 tasks", @company.reload[:summary])
+      end
+      
+    end
+    
+    context "a person with projects and tasks" do
+      
+      setup do
+        @person = Person.create(:first_name => "Enjuto", :last_name => "Mojamuto")
+        @project = Project.create(:name => "La Hora Chanante", :person => @person)
+        Project.create(:name => "Wadus", :person => @person)
+        3.times { Task.create(:project => @project)}
+      end
+      
+      should "have info" do
+        assert_equal("Enjuto Mojamuto has 3 tasks in 2 projects", @person.reload[:info])
+      end
+    end
+  
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,42 @@
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+require 'activerecord'
+require 'activesupport'
+require 'ruby-debug'
+
+require File.dirname(__FILE__) + '/../init'
+
+ActiveSupport::Dependencies.load_paths << File.dirname(__FILE__) + '/models'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ActiveRecord::Schema.verbose = false
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :people do |t|
+      t.string :first_name, :last_name, :full_name, :initials, :info
+      t.integer :company_id
+    end
+    create_table :projects do |t|
+      t.string :name
+      t.boolean :completed
+      t.integer :person_id
+    end
+    create_table :tasks do |t|
+      t.integer :project_id, :company_id
+      t.boolean :completed
+      t.string  :project_name
+    end
+    create_table :companies do |t|
+      t.string :name, :summary
+    end
+  end
+end
+
+def drop_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: persistize
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Sergio Gil
+- "Luismi Cavall\xC3\xA9"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-29 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: ballsbreaking@bebanjo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/persistize.rb
+- persistize.gemspec
+- test/models/company.rb
+- test/models/person.rb
+- test/models/project.rb
+- test/models/task.rb
+- test/persistize_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/bebanjo/persistize
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Easy denormalization for your ActiveRecord models
+test_files: 
+- test/models/company.rb
+- test/models/person.rb
+- test/models/project.rb
+- test/models/task.rb
+- test/persistize_test.rb
+- test/test_helper.rb