class-table-inheritance 1.2.1 → 1.3.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+test/cti_plugin.sqlite3

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in correios.gemspec
+gemspec

data/README

@@ -1,9 +1,17 @@
+Change log
+==========
+
+* Now you can inherits from and to modules like inherits_from 'Module::Model', see the the name of field 
+must be module_model_id:integer thanks for Marc Remolt (https://github.com/mremolt).
+* Unit test
+
+
 Versions
 ========
 
 If you are using Rails 2.3.8 or other version < 3, you have to use the version 1.1.x of this plugin, for Rails 3 you need to use the version 1.2.x or master of this plugin.
 
-ClassTableInheritance 1.2.0 
+ClassTableInheritance 1.2.1 
 ===========================
 
  This is an ActiveRecord plugin designed to allow 
@@ -23,14 +31,14 @@ Example
 
   # Migrations 
 
-  create_table :product do |t|
+  create_table :products do |t|
     t.string :description, :null => false
 	t.string :subtype # Only if you need access of both side see example
     t.decimal :price
     t.timestamps
   end
   
-  create_table :book, :inherits => :product do |t|
+  create_table :books, :inherits => :product do |t|
     t.string :author, :null => false
   end
   
@@ -39,6 +47,7 @@ Example
     t.string :genre, :null => false
   end
 
+
   # Models
 
   class Product < ActiveRecord::Base
@@ -69,6 +78,28 @@ Example
   book.author = "Shakespeare, William"
   book.price => 14.00
   book.save
+  
+  
+Module inheritance
+==================
+# Migrations 
+
+create_table :mod_users do |t|
+  t.string :name, :null => false
+end  
+
+create_table :managers, :inherits => 'Mod::User' do |t|
+  t.string :salary, :null => false
+end
+
+# Models
+
+class Mod::User < ActiveRecord::Base
+end  
+
+class Manager < ActiveRecord::Base
+  inherits_from 'Mod::User'  
+end
 
 Top-down access (Polymorphic)
 =============================

data/Rakefile

@@ -1,23 +1,11 @@
-require 'rake'
+require 'bundler'
 require 'rake/testtask'
-require 'rake/rdoctask'
+Bundler::GemHelper.install_tasks
 
-desc 'Default: run unit tests.'
-task :default => :test
-
-desc 'Test the class_table_inheritance plugin.'
-Rake::TestTask.new(:test) do |t|
+# just 'rake test'
+Rake::TestTask.new do |t|
   t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
-end
-
-desc 'Generate documentation for the class_table_inheritance plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ClassTableInheritance'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/class-table-inheritance.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'class-table-inheritance/version'
+
+Gem::Specification.new do |s|
+  s.name        = "class-table-inheritance"
+  s.version     = ClassTableInheritance::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bruno Frank"]
+  s.email       = ["bfscordeiro@gmail.com"]
+  s.homepage    = "https://github.com/brunofrank/class-table-inheritance"
+  s.summary     = %q{ActiveRecord plugin designed to allow simple multiple table (class) inheritance.}
+  s.description = %q{ActiveRecord plugin designed to allow simple multiple table (class) inheritance.}
+
+  s.rubyforge_project = "class-table-inheritance"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/class-table-inheritance.rb

@@ -1,141 +1,3 @@
 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.acts_as_superclass
-    if self.column_names.include?("subtype")
-      def self.find(*args)
-        super_classes = super
-        begin
-          if super_classes.kind_of? Array
-            super_classes.map do |item|
-              if !item.subtype.nil? && !item.subtype.blank?
-                inherits_type = Object.const_get(item.subtype.to_s)
-                inherits_type.send(:find, item.id)
-              else
-                super_classes
-              end
-            end
-          else
-            if !super_classes.subtype.nil? && !super_classes.subtype.blank?
-              inherits_type = Object.const_get(super_classes.subtype.to_s)
-              inherits_type.send(:find, *args)
-            else
-              super_classes
-            end
-          end
-        rescue
-          super_classes
-        end
-      end
-    end  
-  end
-
-  def self.inherits_from(association_id)
-    
-    # add an association, and set the foreign key.
-    has_one association_id, :foreign_key => :id, :dependent => :destroy
-
-
-    # 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" || c == "subtype"}
-    # 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)
-      if association.attribute_names.include?("subtype")
-        association.subtype = self.class.to_s
-      end
-      association.save
-      self["#{association_id}_id"] = association.id
-      true
-    end
-  end
-end
+require 'class-table-inheritance/inherits-migration'
+require 'class-table-inheritance/class-table-inheritance'

data/lib/class-table-inheritance/class-table-inheritance.rb

@@ -0,0 +1,145 @@
+
+# ClassTableInheritance is an ActiveRecord plugin designed to allow 
+# simple multiple table (class) inheritance.
+class ActiveRecord::Base  
+  attr_reader :reflection
+
+  def self.acts_as_superclass
+    if self.column_names.include?("subtype")
+      def self.find(*args)
+        super_classes = super
+        begin
+          if super_classes.kind_of? Array
+            super_classes.map do |item|
+              if !item.subtype.nil? && !item.subtype.blank?
+                inherits_type = super_classes.subtype.to_s.classify.constantize
+                inherits_type.send(:find, item.id)
+              else
+                super_classes
+              end
+            end
+          else
+            if !super_classes.subtype.nil? && !super_classes.subtype.blank?
+              inherits_type = super_classes.subtype.to_s.classify.constantize
+              inherits_type.send(:find, *args)
+            else
+              super_classes
+            end
+          end
+        rescue
+          super_classes
+        end
+      end
+    end  
+  end
+
+  def self.inherits_from(association_id)
+    # Subst the module simbol to dash and if this is string
+    if association_id.kind_of?(String)
+      class_name = association_id
+      association_id = association_id.to_s.gsub(/::/, '_').downcase.to_sym
+    else
+      class_name = association_id.to_s.classify
+    end
+    
+    # add an association, and set the foreign key.
+    has_one association_id, :class_name => class_name, :foreign_key => :id, :dependent => :destroy
+
+
+    # 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.
+    association_class = class_name.constantize
+    # 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" || c == "subtype"}
+    # 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)
+      if association.attribute_names.include?("subtype")
+        association.subtype = self.class.to_s
+      end
+      association.save
+      self["#{association_id}_id"] = association.id
+      true
+    end
+  end
+end

data/lib/{inherits-migration.rb → class-table-inheritance/inherits-migration.rb}

@@ -1,4 +1,3 @@
-require 'active_record'
 
 module InheritsMigration  
 
@@ -14,19 +13,24 @@ module InheritsMigration
     
     create_table_without_inherits(table_name, options) do |table_defintion|
       if options[:inherits]
-        association_type = Object.const_get(options[:inherits].to_s.capitalize)
+        if options[:inherits].kind_of?(String)
+          column_to_create = options[:inherits].gsub(/::/, '_').downcase
+          association_type = options[:inherits].constantize
+        else
+          column_to_create = options[:inherits]
+          association_type = options[:inherits].to_s.classify.constantize 
+        end        
         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
+        table_defintion.column "#{column_to_create}_id", attr_column.type, field_option
       end
       yield table_defintion  
     end 
   end  
 end
 
-#ActiveRecord::ConnectionAdapters::SchemaStatements::send(:include, InheritsMigration)
 ActiveRecord::Base
 ActiveRecord::ConnectionAdapters::SchemaStatements::send(:include, InheritsMigration)

data/lib/class-table-inheritance/version.rb

@@ -0,0 +1,3 @@
+class ClassTableInheritance
+  VERSION = "1.3.0"
+end

data/test/class_table_inheritance_test.rb

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+class ClassTableInheritanceTest < Test::Unit::TestCase
+  
+  def test_create
+    name = 'Bike'
+    
+    product = Product.new
+    product.name = name
+    assert_equal true, product.save
+    
+    product = Product.find product.id
+    assert_equal name, product.name
+  end
+
+  
+  def test_inheritance_book
+    title = 'Atlas Shrugged'
+    isbn = '9780451191144'
+
+    book = Book.new
+    book.name = title
+    book.isbn = isbn
+    assert_equal true, book.save
+    
+    book = Book.find book.id
+    assert_equal title, book.name
+    assert_equal isbn, book.isbn    
+  end  
+  
+  def test_inheritance_video
+    name = 'Amy Whinehouse - Rehab'
+    url = 'http://www.youtube.com/watch?v=3QI8RjKibyc'
+    
+    video = Mod::Video.new
+    video.name = name
+    video.url = url
+    assert_equal true, video.save
+    
+    video = Mod::Video.find video.id
+    assert_equal name, video.name
+    assert_equal url, video.url    
+  end  
+
+  def test_inheritance_user_save
+    name = 'bfscordeiro'
+    
+    user = Mod::User.new
+    user.name = name
+    assert_equal true, user.save
+    
+    user = Mod::User.find user.id
+    assert_equal name, user.name
+  end  
+
+  def test_inheritance_manager_save
+    name = 'bfscordeiro'
+    salary = '6000'
+    
+    manager = Manager.new
+    manager.name = name
+    manager.salary = salary
+    assert_equal true, manager.save
+    
+    manager = Manager.find manager.id
+    assert_equal name, manager.name
+    assert_equal salary, manager.salary    
+  end  
+
+  
+end

data/test/database.yml

@@ -0,0 +1,4 @@
+sqlite3:
+  :adapter: sqlite3
+  :database: test/cti_plugin.sqlite3
+ 

data/test/models/book.rb

@@ -0,0 +1,3 @@
+class Book < ActiveRecord::Base
+  inherits_from :product
+end

data/test/models/manager.rb

@@ -0,0 +1,3 @@
+class Manager < ActiveRecord::Base
+  inherits_from 'Mod::User'
+end

data/test/models/mod.rb

@@ -0,0 +1,5 @@
+module Mod
+  def self.table_name_prefix
+    'mod_'
+  end
+end

data/test/models/mod/user.rb

@@ -0,0 +1,2 @@
+class Mod::User < ActiveRecord::Base
+end

data/test/models/mod/video.rb

@@ -0,0 +1,3 @@
+class Mod::Video < ActiveRecord::Base
+  inherits_from :product
+end

data/test/models/product.rb

@@ -0,0 +1,2 @@
+class Product < ActiveRecord::Base
+end

data/test/schema.rb

@@ -0,0 +1,24 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :products, :force => true do |t|
+    t.string :name
+  end
+  
+  create_table :books, :force => true do |t|
+    t.string :isbn
+    t.integer :product_id
+  end
+  
+  create_table :mod_videos, :force => true do |t|
+    t.integer :product_id
+    t.string :url   
+  end  
+  
+  create_table :mod_users, :force => true do |t|
+    t.string :name
+  end  
+  
+  create_table :managers, :force => true do |t|
+    t.integer :mod_user_id
+    t.string :salary
+  end  
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'class-table-inheritance'
+require 'yaml'
+
+database = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.establish_connection(database['sqlite3'])
+load(File.dirname(__FILE__) + "/schema.rb") if !File.exists?(database['sqlite3'][:database])
+
+require 'models/product'
+require 'models/book'
+require 'models/mod'
+require 'models/mod/video'
+require 'models/mod/user'
+require 'models/manager'

metadata

@@ -1,45 +1,51 @@
 --- !ruby/object:Gem::Specification 
 name: class-table-inheritance
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 1
-  - 2
-  - 1
-  version: 1.2.1
+  prerelease: 
+  version: 1.3.0
 platform: ruby
 authors: 
-- Bruno Frank Cordeiro
+- Bruno Frank
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-12-03 00:00:00 -02:00
+date: 2011-07-25 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
-description: ActiveRecord plugin designed to allow simple multiple table inheritance CTI.
-email: bfscordeiro@gmail.com
+description: ActiveRecord plugin designed to allow simple multiple table (class) inheritance.
+email: 
+- bfscordeiro@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README
+extra_rdoc_files: []
+
 files: 
-- class-table-inheritance-1.0.0.gem
-- class-table-inheritance-1.1.0.gem
-- class-table-inheritance-1.1.1.gem
-- class-table-inheritance-1.2.0.gem
-- class-table-inheritance-1.2.1.gem
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- class-table-inheritance.gemspec
 - init.rb
 - lib/class-table-inheritance.rb
-- lib/inherits-migration.rb
-- Rakefile
-- README
+- lib/class-table-inheritance/class-table-inheritance.rb
+- lib/class-table-inheritance/inherits-migration.rb
+- lib/class-table-inheritance/version.rb
+- test/class_table_inheritance_test.rb
+- test/database.yml
+- test/models/book.rb
+- test/models/manager.rb
+- test/models/mod.rb
+- test/models/mod/user.rb
+- test/models/mod/video.rb
+- test/models/product.rb
+- test/schema.rb
+- test/test_helper.rb
 has_rdoc: true
-homepage: 
+homepage: https://github.com/brunofrank/class-table-inheritance
 licenses: []
 
 post_install_message: 
@@ -52,25 +58,28 @@ required_ruby_version: !ruby/object:Gem::Requirement
   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
+rubyforge_project: class-table-inheritance
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: ActiveRecord plugin designed to allow  simple multiple table (class) inheritance.
-test_files: []
-
+summary: ActiveRecord plugin designed to allow simple multiple table (class) inheritance.
+test_files: 
+- test/class_table_inheritance_test.rb
+- test/database.yml
+- test/models/book.rb
+- test/models/manager.rb
+- test/models/mod.rb
+- test/models/mod/user.rb
+- test/models/mod/video.rb
+- test/models/product.rb
+- test/schema.rb
+- test/test_helper.rb