class-table-inheritance 1.0.0

data/README

@@ -0,0 +1,64 @@
+ClassTableInheritance
+=====================
+
+ This is an ActiveRecord plugin designed to allow 
+ simple multiple table (class) inheritance.
+ 
+ This plugin was inspired by:
+ inherits_from plugin => http://github.com/rwl4/inherits_from and
+ Multiple Table Inheritance with ActiveRecord => http://mediumexposure.com/multiple-table-inheritance-active-record/
+
+Example
+=======
+
+  # Migrations 
+
+  create_table :product do |t|
+    t.string :description, :null => false
+    t.decimal :price
+    t.timestamps
+  end
+  
+  create_table :book, :inherits => :product do |t|
+    t.string :author, :null => false
+  end
+  
+  create_table :videos, :inherits => :product do |t|
+    t.string :year, :null => false
+    t.string :genre, :null => false
+  end
+
+  # Models
+
+  class Product < ActiveRecord::Base
+  end
+
+  class Book < ActiveRecord::Base
+    inherits_from :product
+  end
+
+  class Video < ActiveRecord::Base
+    inherits_from :product
+  end
+
+  book = Book.find(1)
+  book.name => "Agile Development with Rails"
+  book.author => "Dave Thomas"
+  book.price => 19.00
+  
+  video = Video.find(2)
+  video.name => "Inseption"
+  video.year => "2010"
+  video.genre => "SCI-FI" 
+  video.price => 22.00
+  
+  book = Book.new
+  book.name = "Hamlet"
+  book.author = "Shakespeare, William"
+  book.price => 14.00
+  book.save
+  
+  if you need help contanct me: bfscordeiro (at) gmail.com .
+
+
+Copyright (c) 2010 Bruno Cordeiro, released under the MIT license

data/lib/class-table-inheritance.rb

@@ -0,0 +1,110 @@
+require 'active_record'
+require 'inherits-migration'
+
+# ClassTableInheritance is an ActiveRecord plugin designed to allow 
+# simple multiple table (class) inheritance.
+class ActiveRecord::Base  
+  attr_reader :reflection
+      
+  def self.inherits_from(association_id)
+
+    # add an association, and set the foreign key.
+    has_one association_id, :foreign_key => :id
+
+
+    # set the primary key, it' need because the generalized table doesn't have
+    # a field ID.
+    set_primary_key "#{association_id}_id"
+
+
+    # Autobuild method to make a instance of association
+    define_method("#{association_id}_with_autobuild") do
+      send("#{association_id}_without_autobuild") || send("build_#{association_id}")
+    end
+
+    
+    # Set a method chain whith autobuild.
+    alias_method_chain association_id, :autobuild    
+
+    
+    # bind the before save, this method call the save of association, and
+    # get our generated ID an set to association_id field.
+    before_save :save_inherit
+    
+    
+    # Bind the validation of association.
+    validate :inherit_association_must_be_valid    
+
+
+    # Generate a method to validate the field of association.    
+    define_method("inherit_association_must_be_valid") do
+      association = send(association_id)
+
+      unless valid = association.valid?
+        association.errors.each do |attr, message|
+          errors.add(attr, message)
+        end
+      end
+      
+      valid
+    end    
+          
+    
+    
+    # get the class of association by reflection, this is needed because
+    # i need to get the methods and attributes to make a proxy methods.
+    reflection = create_reflection(:has_one, association_id, {}, self)
+    association_class = Object.const_get(reflection.class_name)    
+    # Get the colluns of association class.
+    inherited_columns = association_class.column_names
+    # Make a filter in association colluns to exclude the colluns that
+    # the generalized class already have.
+    inherited_columns = inherited_columns.reject { |c| self.column_names.grep(c).length > 0 || c == "type" }
+    # Get the methods of the association class and tun it to an Array of Strings.
+    inherited_methods = association_class.reflections.map { |key,value| key.to_s }
+    # Make a filter in association methods to exclude the methods that
+    # the generalizae class already have.
+    inherited_methods = inherited_methods.reject { |c| self.reflections.map {|key, value| key.to_s }.include?(c) }
+    
+    
+    # create the proxy methods to get and set the properties and methods
+    # in association class.
+    (inherited_columns + inherited_methods).each do |name|
+    	define_method name do
+	  	  # if the field is ID than i only bind that with the association field.
+	  	  # this is needed to bypass the overflow problem when the ActiveRecord
+	  	  # try to get the id to find the association.
+    	  if name == 'id'
+    	    self["#{association_id}_id"]
+    	  else 
+          assoc = send(association_id)
+          assoc.send(name)
+        end
+    	end
+  
+    	
+    	define_method "#{name}=" do |new_value|
+	  	  # if the field is ID than i only bind that with the association field.
+	  	  # this is needed to bypass the overflow problem when the ActiveRecord
+	  	  # try to get the id to find the association.
+    	  if name == 'id'
+    	    self["#{association_id}_id"] = new_value
+    	  else     	  
+          assoc = send(association_id)
+          assoc.send("#{name}=", new_value)
+        end
+    	end
+    end
+
+
+    # Create a method do bind in before_save callback, this method
+    # only call the save of association class and set the id in the
+    # generalized class.
+    define_method("save_inherit") do |*args|
+      association = send(association_id)
+      association.save
+      self["#{association_id}_id"] = association.id
+      true
+    end
+  end
+end

data/lib/inherits-migration.rb

@@ -0,0 +1,28 @@
+module InheritsMigration  
+
+  def self.included(base)
+    base.class_eval do
+      alias_method_chain :create_table , :inherits
+    end
+  end
+  
+  # Generate the association field.
+  def create_table_with_inherits(table_name, options = {}, &block)
+    options[:id] ||= false if options[:inherits]
+    
+    create_table_without_inherits(table_name, options) do |table_defintion|
+      if options[:inherits]
+        association_type = Object.const_get(options[:inherits].to_s.capitalize)
+        association_inst = association_type.send(:new)
+        attr_column = association_inst.column_for_attribute(association_type.primary_key)
+        
+        field_option = {:primary_key => true, :null => false}
+        field_option[:limit] = attr_column.limit if attr_column.limit                
+        table_defintion.column "#{options[:inherits]}_id", attr_column.type, field_option
+      end
+      yield table_defintion  
+    end 
+  end  
+end
+
+ActiveRecord::ConnectionAdapters::SchemaStatements::send(:include, InheritsMigration)

data/test/class_table_inheritance_test.rb

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

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: class-table-inheritance
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Bruno Frank Cordeiro
+autorequire: name
+bindir: bin
+cert_chain: []
+
+date: 2010-11-29 00:00:00 -02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: bfscordeiro@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/class-table-inheritance.rb
+- lib/inherits-migration.rb
+- README
+- test/class_table_inheritance_test.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ActiveRecord plugin designed to allow  simple multiple table (class) inheritance.
+test_files: 
+- test/class_table_inheritance_test.rb