laserlemon-belongs_to_versioned 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Steve Richert
+
+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,10 @@
+belongs_to_versioned.gemspec
+init.rb
+lib/belongs_to_versioned.rb
+MIT-LICENSE
+Rakefile
+README.rdoc
+test/belongs_to_versioned_test.rb
+test/test_helper.rb
+VERSION.yml
+Manifest

data/README.rdoc

@@ -0,0 +1,88 @@
+= belongs_to_versioned
+
+The purpose of <tt>belongs_to_versioned</tt> is to save version information as used by the <tt>acts_as_versioned</tt>[http://github.com/technoweenie/acts_as_versioned/tree/master] plugin by technoweenie[http://github.com/technoweenie] alongside <tt>belongs_to</tt> ActiveRecord associations.
+
+== Installation
+
+  script/plugin install git://github.com/laserlemon/belongs_to_versioned.git
+
+== Example
+
+In your migrations:
+
+  create_table :products do |t|
+    t.string :name
+    t.text :description
+    t.integer :price
+    t.integer :version
+    t.timestamps
+  end
+  Product.create_versioned_table
+
+
+  create_table :line_items do |t|
+    t.belongs_to :product
+    t.integer :product_version
+    t.integer :quantity
+    t.timestamps
+  end
+
+In your models:
+
+  class Product < ActiveRecord::Base
+    validates_presence_of :name, :description, :price
+    validates_numericality_of :price, :greater_than_or_equal_to => 0, :only_integer => true
+    
+    acts_as_versioned :if_changed => [:price]
+    
+    has_many :line_items
+  end
+
+
+  class LineItem < ActiveRecord::Base
+    validates_presence_of :product, :quantity
+    validates_numericality_of :quantity, :greater_than => 0, :only_integer => true
+    
+    belongs_to_versioned :product
+    
+    def subtotal
+      product.price * quantity
+    end
+  end
+
+In your controller:
+
+  product = Product.create(
+    :name => 'Settlers of Catan',
+    :description => 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',
+    :price => 3999
+  )
+  @line_items = []
+  @line_items << LineItem.create(:product => product, :quantity => 1)
+  product.update_attributes(:price => 2999)
+  @line_items << LineItem.create(:product => product, :quantity => 1)
+
+In your view:
+
+  <table>
+    <tr>
+      <th>Quantity</th>
+      <th>Product</th>
+      <th>Price</th>
+      <th>Subtotal</th>
+    </tr>
+    <%- @line_items.each do |line_item| -%>
+    <tr>
+      <td><%= line_item.quantity %></td>
+      <td><%=h line_item.product.name %></td>
+      <td><%= number_to_currency(line_item.product.price.to_f / 100) %></td>
+      <td><%= number_to_currency(line_item.subtotal.to_f / 100) %></td>
+    </tr>
+    <%- end -%>
+  </table>
+
+== Tips
+
+* As an alternative to the <tt>belongs_to_versioned</tt> method, you can pass a <tt>:versioned => true</tt> option to a typical <tt>belongs_to</tt> association.
+* The <tt>:revert_to</tt> option is an optional string specifying the column name to use when reverting the parent object. This defaults to the name of the association appended by <tt>"_version"</tt>.
+* If the <tt>:revert_to</tt> value is a symbol, that <tt>acts_as_versioned</tt> extension method will be used when reverting the parent object (i.e. <tt>:earliest</tt>).

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('belongs_to_versioned', '0.1.0') do |g|
+  g.description = %(Simplify ActiveRecord associations using acts_as_versioned)
+  g.url = 'http://github.com/laserlemon/belongs_to_versioned'
+  g.author = 'Steve Richert'
+  g.email = 'steve@laserlemon.com'
+  g.ignore_pattern = %w(tmp/* script/*)
+  g.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each{|t| load t }

data/VERSION.yml

@@ -0,0 +1,4 @@
+---
+:major: 0
+:minor: 1
+:patch: 0

data/belongs_to_versioned.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{belongs_to_versioned}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Steve Richert"]
+  s.date = %q{2009-04-28}
+  s.description = %q{Simplify ActiveRecord associations using acts_as_versioned}
+  s.email = %q{steve@laserlemon.com}
+  s.extra_rdoc_files = ["lib/belongs_to_versioned.rb", "README.rdoc"]
+  s.files = ["belongs_to_versioned.gemspec", "init.rb", "lib/belongs_to_versioned.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README.rdoc", "test/belongs_to_versioned_test.rb", "test/test_helper.rb", "VERSION.yml"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/laserlemon/belongs_to_versioned}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Belongs_to_versioned", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{belongs_to_versioned}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Simplify ActiveRecord associations using acts_as_versioned}
+  s.test_files = ["test/belongs_to_versioned_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/init.rb

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

data/lib/belongs_to_versioned.rb

@@ -0,0 +1,45 @@
+module LaserLemon
+  module BelongsToVersioned
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do
+        class << self
+          alias_method_chain :belongs_to, :versioned
+        end
+      end
+    end
+    
+    module ClassMethods
+      def belongs_to_versioned(association_id, options = {})
+        revert_to = options.delete(:revert_to) || association_id.to_s.foreign_key.gsub(/_id$/, '_version')
+        
+        belongs_to association_id, options
+        
+        define_method "#{association_id}_with_belongs_to_versioned" do
+          parent = send("#{association_id}_without_belongs_to_versioned")
+          target_version = case revert_to
+            when String: read_attribute(revert_to)
+            when Symbol: (parent.respond_to?(:versions) ? parent.versions.send(revert_to).version : nil)
+            end
+          parent.revert_to(target_version) if target_version && parent.respond_to?(:revert_to)
+          parent
+        end
+        
+        alias_method_chain association_id, :belongs_to_versioned
+        
+        define_method "#{association_id}_with_belongs_to_versioned=" do |parent|
+          write_attribute(revert_to, (parent.respond_to?(:version) ? parent.version : nil)) if revert_to.is_a?(String)
+          send("#{association_id}_without_belongs_to_versioned=", parent)
+        end
+        
+        alias_method_chain "#{association_id}=", :belongs_to_versioned
+      end
+      
+      def belongs_to_with_versioned(a, o = {})
+        o.delete(:versioned) ? belongs_to_versioned(a, o) : belongs_to_without_versioned(a, o)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, LaserLemon::BelongsToVersioned)

data/test/belongs_to_versioned_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class BelongsToVersionedTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: laserlemon-belongs_to_versioned
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Steve Richert
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-28 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Simplify ActiveRecord associations using acts_as_versioned
+email: steve@laserlemon.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/belongs_to_versioned.rb
+- README.rdoc
+files: 
+- belongs_to_versioned.gemspec
+- init.rb
+- lib/belongs_to_versioned.rb
+- Manifest
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- test/belongs_to_versioned_test.rb
+- test/test_helper.rb
+- VERSION.yml
+has_rdoc: true
+homepage: http://github.com/laserlemon/belongs_to_versioned
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Belongs_to_versioned
+- --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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: belongs_to_versioned
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simplify ActiveRecord associations using acts_as_versioned
+test_files: 
+- test/belongs_to_versioned_test.rb
+- test/test_helper.rb