ryanb-association-freezer 0.1.1

data/CHANGELOG

@@ -0,0 +1,13 @@
+*0.1.1* (July 14th, 2008)
+
+* frozen record is no longer considered new
+
+* frozen record keeps id attribute of old record
+
+* don't raise exception when trying to freeze nil association
+
+* raise an exception when trying to replace frozen association
+
+*0.1.0* (July 14th, 2008)
+
+* initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Ryan Bates
+
+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/Manifest

@@ -0,0 +1,16 @@
+association-freezer.gemspec
+CHANGELOG
+lib/association_freezer/belongs_to_freezer.rb
+lib/association_freezer/method_generator.rb
+lib/association_freezer/model_additions.rb
+lib/association_freezer.rb
+LICENSE
+Manifest
+README
+spec/freezer_spec.rb
+spec/lib/order.rb
+spec/lib/ship_method.rb
+spec/spec_helper.rb
+tasks/deployment.rake
+tasks/spec.rake
+tmp/test.sqlite3

data/README

@@ -0,0 +1,110 @@
+= Association Freezer
+
+Freeze an Active Record belongs_to association to ignore any future changes.
+
+
+== Install
+
+First specify it in your Rails config.
+
+	config.gem 'ryanb-association-freezer', :lib => 'association_freezer', :source => 'http://gems.github.com'
+
+And then install it.
+
+  rake gems:install
+
+Follow the instructions below to finish setup. Rails 2.1 or later 
+required.
+
+
+== Scenario
+
+Let's say we have an Order model with a couple belongs_to associations 
+for setting the billing and shipping address.
+
+  class Order < ActiveRecord::Base
+    belongs_to :shipping_address, :class_name => 'Address'
+    belongs_to :billing_address, :class_name => 'Address'
+    # ...
+  end
+
+Consider this scenario. A user comes to the site and places an order. 
+Then he comes back a month later and changes his address. Now our Order 
+model is incorrect, it will point to this new address instead of the 
+old one he placed the order with.
+
+There's a couple ways to solve this, one is to create a new Address 
+model whenever one edits the address. Another is to freeze the address 
+attributes upon placing an order so it isn't effected when the original 
+Address changes. This gem will help with the latter.
+
+
+== Usage
+
+First you need to generate a binary (or blob) column to hold each 
+frozen assoiation. The name of the column must start with "frozen_" and 
+end with the association name. You can do that with a migration like 
+this:
+
+  script/generate migration add_frozen_addresses_to_orders \
+    frozen_billing_address:binary frozen_shipping_address:binary
+
+
+Next, enable the association freezer on your model. This must be done 
+AFTER the associations have been specified.
+
+  class Order < ActiveRecord::Base
+    belongs_to :shipping_address, :class_name => 'Address'
+    belongs_to :billing_address, :class_name => 'Address'
+    enable_association_freezer
+    #...
+  end
+
+Now you can freeze the association at will:
+
+  # in order
+  def purchase
+    #...
+    freeze_billing_address
+    freeze_shipping_address
+    save!
+  end
+
+When freezing an association, the attributes will be set to the frozen 
+column. However, the model is not saved automatically, so you must call 
+save at some point after freezing.
+
+Here's where the magic starts. Now when you fetch the frozen 
+association (order.billing_address), the association freezer will step 
+in and return an Address model which is built from the attributes in 
+the frozen column, not the attributes in the addresses table. 
+Therefore, any changes to the address will not effect the order's 
+address. "freeze" is called on the model before returning it to prevent 
+accidentally altering the data.
+
+You can also unfreeze an already frozen association if you want it to 
+use the database record instead.
+
+  unfreeze_billing_address
+
+You can then freeze it again to use the updated attributes.
+
+
+== Alternative Usage
+
+Not only is this gem good at handling the situation above, but it can 
+also be used as a caching technique. If the belongs_to association is 
+frequently accessed, it can be more efficient to freeze (cache) it to 
+remove the need for a database call. Of course with this approach you 
+want it to stay in sync with the database, so you'll need to expire the 
+cache (refreeze the association) whenever the associated model changes.
+
+
+== Development
+
+This project can be found on github at the following URL.
+
+http://github.com/ryanb/association-freezer/
+
+If you would like to contribute to this project, please fork the 
+repository and send me a pull request.

data/association-freezer.gemspec

@@ -0,0 +1,50 @@
+
+# Gem::Specification for Association-freezer-0.1.1
+# Originally generated by Echoe
+
+Gem::Specification.new do |s|
+  s.name = %q{association-freezer}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Bates"]
+  s.date = %q{2008-07-24}
+  s.description = %q{Freeze an Active Record belongs_to association.}
+  s.email = %q{ryan (at) railscasts (dot) com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/association_freezer/belongs_to_freezer.rb", "lib/association_freezer/method_generator.rb", "lib/association_freezer/model_additions.rb", "lib/association_freezer.rb", "LICENSE", "README", "tasks/deployment.rake", "tasks/spec.rake"]
+  s.files = ["association-freezer.gemspec", "CHANGELOG", "lib/association_freezer/belongs_to_freezer.rb", "lib/association_freezer/method_generator.rb", "lib/association_freezer/model_additions.rb", "lib/association_freezer.rb", "LICENSE", "Manifest", "README", "spec/freezer_spec.rb", "spec/lib/order.rb", "spec/lib/ship_method.rb", "spec/spec_helper.rb", "tasks/deployment.rake", "tasks/spec.rake", "tmp/test.sqlite3"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/ryanb/association-freezer}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Association-freezer", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{association-freezer}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Freeze an Active Record belongs_to association.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+    if current_version >= 3 then
+    else
+    end
+  else
+  end
+end
+
+
+# # Original Rakefile source (requires the Echoe gem):
+# 
+# require 'rubygems'
+# require 'rake'
+# require 'echoe'
+# 
+# Echoe.new('association-freezer', '0.1.1') do |p|
+#   p.summary        = "Freeze an Active Record belongs_to association."
+#   p.description    = "Freeze an Active Record belongs_to association."
+#   p.url            = "http://github.com/ryanb/association-freezer"
+#   p.author         = 'Ryan Bates'
+#   p.email          = "ryan (at) railscasts (dot) com"
+#   p.ignore_pattern = ["script/*"]
+# end
+# 
+# Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/association_freezer/belongs_to_freezer.rb

@@ -0,0 +1,60 @@
+module AssociationFreezer
+  class BelongsToFreezer
+    def initialize(owner, reflection)
+      @owner = owner
+      @reflection = reflection
+    end
+    
+    def freeze
+      self.frozen_data = Marshal.dump(nonfrozen.attributes) if nonfrozen
+    end
+    
+    def unfreeze
+      @frozen = nil
+      self.frozen_data = nil
+    end
+    
+    def fetch(*args)
+      frozen || nonfrozen(*args)
+    end
+    
+    def frozen?
+      frozen_data
+    end
+    
+    private
+    
+    def frozen
+      @frozen ||= load_frozen if frozen?
+    end
+    
+    def load_frozen
+      attributes = Marshal.load(frozen_data)
+      target = target_class.new(attributes.except('id'))
+      target.id = attributes['id']
+      target.instance_variable_set('@new_record', false)
+      target.readonly!
+      target.freeze
+    end
+    
+    def nonfrozen(*args)
+      @owner.send("#{name}_without_frozen_check", *args)
+    end
+    
+    def frozen_data=(data)
+      @owner.write_attribute("frozen_#{name}", data)
+    end
+    
+    def frozen_data
+      @owner.read_attribute("frozen_#{name}")
+    end
+    
+    def target_class
+      @reflection.klass
+    end
+    
+    def name
+      @reflection.name
+    end
+  end
+end

data/lib/association_freezer/method_generator.rb

@@ -0,0 +1,63 @@
+module AssociationFreezer
+  class MethodGenerator
+
+    def initialize(reflection)
+      @reflection = reflection
+    end
+    
+    def generate
+      # it is very important that we first make sure this hasn't already been done
+      # because otherwise it will result in an endless loop the way alias method works.
+      return if previously_generated? || !frozen_column_exists?
+      
+      reflection = @reflection
+      freezer = "#{reflection.name}_freezer"
+      
+      generate_method freezer do
+        read_attribute("@#{freezer}") || write_attribute("@#{freezer}", BelongsToFreezer.new(self, reflection))
+      end
+      
+      generate_method "freeze_#{reflection.name}" do
+        send(freezer).freeze
+      end
+      
+      generate_method "unfreeze_#{reflection.name}" do
+        send(freezer).unfreeze
+      end
+      
+      generate_method "#{reflection.name}_with_frozen_check" do |*args|
+        send(freezer).fetch(*args)
+      end
+      model_class.alias_method_chain reflection.name, :frozen_check
+      
+      generate_method "#{reflection.name}_with_frozen_check=" do |*args|
+        if send(freezer).frozen?
+          # TODO make this a custom exception
+          raise "Unable to set #{reflection.name} because association is frozen." 
+        else
+          send("#{reflection.name}_without_frozen_check=", *args)
+        end
+      end
+      model_class.alias_method_chain "#{reflection.name}=", :frozen_check
+    end
+    
+    private
+    
+    def previously_generated?
+      model_class.instance_methods.include? "freeze_#{@reflection.name}"
+    end
+    
+    def frozen_column_exists?
+      model_class.column_names.include? "frozen_#{@reflection.name}"
+    end
+    
+    def model_class
+      @reflection.active_record
+    end
+    
+    def generate_method(name, &block)
+      model_class.send(:define_method, name, &block)
+    end
+    
+  end
+end

data/lib/association_freezer/model_additions.rb

@@ -0,0 +1,14 @@
+module AssociationFreezer
+  module ModelAdditions
+    # REFACTORME !!!
+    def enable_association_freezer
+      reflect_on_all_associations(:belongs_to).each do |reflection|
+        MethodGenerator.new(reflection).generate
+      end
+    end
+  end
+end
+
+class ActiveRecord::Base
+  extend AssociationFreezer::ModelAdditions
+end

data/lib/association_freezer.rb

@@ -0,0 +1,4 @@
+$:.unshift(File.dirname(__FILE__))
+require 'association_freezer/model_additions'
+require 'association_freezer/method_generator'
+require 'association_freezer/belongs_to_freezer'

data/spec/freezer_spec.rb

@@ -0,0 +1,106 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Order do
+  it "respond to enable_association_freezer" do
+    Order.should respond_to(:enable_association_freezer)
+  end
+  
+  describe "with freezer" do
+    before(:each) do
+      Order.enable_association_freezer
+      @order = Order.new
+    end
+    
+    it "should add a freeze association method" do
+      @order.should respond_to(:freeze_ship_method)
+    end
+  
+    it "should add an unfreeze association method" do
+      @order.should respond_to(:unfreeze_ship_method)
+    end
+  
+    it "should not add freeze/unfreeze methods to cart association since it doesn't have a frozen column" do
+      @order.should_not respond_to(:freeze_cart)
+      @order.should_not respond_to(:unfreeze_cart)
+    end
+    
+    it "should not be frozen at first" do
+      @order.ship_method = ShipMethod.create!
+      @order.ship_method(true).should_not be_frozen
+    end
+    
+    it "should freeze association in its current state" do
+      ship_method = ShipMethod.create!(:price => 2)
+      @order.ship_method = ship_method
+      ship_method.price = 3
+      @order.freeze_ship_method
+      @order.ship_method.price.should == 3
+    end
+    
+    it "should do nothing when attempting to freeze a nil association" do
+      @order.ship_method.should be_nil
+      lambda { @order.freeze_ship_method }.should_not raise_error
+      @order.ship_method.should be_nil
+    end
+    
+    describe "when freezing association" do
+      before(:each) do
+        @ship_method = ShipMethod.create!(:price => 5)
+        @order.ship_method = @ship_method
+        @order.freeze_ship_method
+      end
+      
+      it "should freeze associated model" do
+        @order.ship_method.should be_frozen
+      end
+      
+      it "should not freeze original object" do
+        @ship_method.should_not be_frozen
+      end
+      
+      it "should still consider model frozen after reloading association" do
+        @order.ship_method(true).should be_frozen
+      end
+      
+      it "should ignore changes to associated model" do
+        @ship_method.update_attribute(:price, 8)
+        @order.ship_method.price.should == 5
+        @order.ship_method(true).price.should == 5
+      end
+      
+      it "should be frozen after reloading order" do
+        @order.save!
+        @order.reload
+        @order.ship_method.should be_frozen
+      end
+      
+      it "should not be frozen when unfreezing" do
+        @order.unfreeze_ship_method
+        @order.ship_method.should_not be_frozen
+      end
+      
+      it "should restore original attributes when unfreezing" do
+        @ship_method.update_attribute(:price, 8)
+        @order.unfreeze_ship_method
+        @order.ship_method.price.should == 8
+      end
+      
+      it "should raise an exception when attempting to save associated model" do
+        lambda { @order.ship_method.save }.should raise_error
+        lambda { @order.ship_method.save! }.should raise_error
+      end
+      
+      it "should raise an exception when attempting to replace association" do
+        lambda { @order.ship_method = ShipMethod.new }.should raise_error
+      end
+      
+      it "should keep id attribute for association" do
+        @order.ship_method.id.should == @ship_method.id
+      end
+      
+      it "should not consider association a new record" do
+        @order.ship_method.should_not be_new_record
+      end
+    end
+  end
+end

data/spec/lib/order.rb

@@ -0,0 +1,18 @@
+class Order < ActiveRecord::Base
+  belongs_to :ship_method
+  belongs_to :cart
+end
+
+class CreateOrders < ActiveRecord::Migration
+  def self.up
+    create_table :orders do |t|
+      t.integer :ship_method_id
+      t.binary  :frozen_ship_method
+      t.binary  :cart_id
+    end
+  end
+  
+  def self.down
+    drop_table :orders
+  end
+end

data/spec/lib/ship_method.rb

@@ -0,0 +1,15 @@
+class ShipMethod < ActiveRecord::Base
+  has_many :orders
+end
+
+class CreateShipMethods < ActiveRecord::Migration
+  def self.up
+    create_table :ship_methods do |t|
+      t.decimal :price
+    end
+  end
+  
+  def self.down
+    drop_table :ship_methods
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'spec'
+require 'active_support'
+require 'active_record'
+require File.dirname(__FILE__) + '/../lib/association_freezer.rb'
+
+# setup database adapter
+FileUtils.mkdir_p(File.dirname(__FILE__) + "/../tmp/")
+ActiveRecord::Base.establish_connection({
+  :adapter => "sqlite3", 
+  :dbfile => File.dirname(__FILE__) + "/../tmp/test.sqlite3" 
+})
+
+# load models
+# there's probably a better way to handle this
+require File.dirname(__FILE__) + '/lib/order.rb'
+CreateOrders.migrate(:up) unless Order.table_exists?
+require File.dirname(__FILE__) + '/lib/ship_method.rb'
+CreateShipMethods.migrate(:up) unless ShipMethod.table_exists?
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

data/tasks/deployment.rake

@@ -0,0 +1,2 @@
+desc "Build the manifest and gemspec files."
+task :build => [:build_manifest, :build_gemspec]

data/tasks/spec.rake

@@ -0,0 +1,9 @@
+require 'spec/rake/spectask'
+
+spec_files = Rake::FileList["spec/**/*_spec.rb"]
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = spec_files
+  t.spec_opts = ["-c"]
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: ryanb-association-freezer
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Ryan Bates
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-24 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Freeze an Active Record belongs_to association.
+email: ryan (at) railscasts (dot) com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/association_freezer/belongs_to_freezer.rb
+- lib/association_freezer/method_generator.rb
+- lib/association_freezer/model_additions.rb
+- lib/association_freezer.rb
+- LICENSE
+- README
+- tasks/deployment.rake
+- tasks/spec.rake
+files: 
+- association-freezer.gemspec
+- CHANGELOG
+- lib/association_freezer/belongs_to_freezer.rb
+- lib/association_freezer/method_generator.rb
+- lib/association_freezer/model_additions.rb
+- lib/association_freezer.rb
+- LICENSE
+- Manifest
+- README
+- spec/freezer_spec.rb
+- spec/lib/order.rb
+- spec/lib/ship_method.rb
+- spec/spec_helper.rb
+- tasks/deployment.rake
+- tasks/spec.rake
+- tmp/test.sqlite3
+has_rdoc: true
+homepage: http://github.com/ryanb/association-freezer
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Association-freezer
+- --main
+- README
+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: association-freezer
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Freeze an Active Record belongs_to association.
+test_files: []
+