bebanjo-persistize 0.0.1

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/lib/persistize.rb

@@ -0,0 +1,84 @@
+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"
+      generate_method = :"generate_#{association.macro}_callback"
+      unless respond_to?(generate_method, true)
+        raise "#{association.macro} 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_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)

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: bebanjo-persistize
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Sergio Gil
+- "Luismi Cavall\xC3\xA9"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: ballsbreaking@bebanjo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- lib/persistize.rb
+has_rdoc: true
+homepage: http://github.com/bebanjo/persistize
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.rdoc
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Easy denormalization for your ActiveRecord models
+test_files: []
+