has_extra_data 0.1 → 0.2

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format doc

data/README

@@ -1,48 +1,79 @@
-Adds an add_extra_data method to ActiveRecord that invisibly includes an extra data table. Use with STI to keep your database clean.
+Adds an add_extra_data method to ActiveRecord that invisibly includes an extra data table. Use with STI to keep your database clean. It removes the need to have lots of nullable columns.
 
-Uses rspec for test.
+Usage
+---------
+Use in Rails 3 app. Add to bundler:
+gem "has_extra_data"
 
-This is an example of it in use...
+Tests
+---------
+Uses rspec for testing.
+Run tests with rspec spec/*
 
-Usage
--------
-Drink.all
-Drink.first.is_hot?
+Todo
+---------
+* Automatically load extra data class with main class.
+* Automatically load associations in main class.
+* Automatically pass attributes through to main class.
 
-Coke.all
-Coke.first.is_hot?
-Coke.first.is_diet?
+Example
+---------
 
-Classes
---------
+Usage:
 
-class Drink < ActiveRecord::Base
-  validates :is_hot, :in => [true, false]
-end
+    Account.each do |account|
+      puts account.balance
+    end
 
-class Coffee < Product
-end
+    BankAccount.each do |bank_account|
+      puts bank_account.balance
+      puts bank_account.bank_account.name
+    end
 
-class Water < Product
-end
+Classes:
+    class Account < ActiveRecord::Base
+      before_create :set_initial_balance
+  
+    private
+      def set_initial_balance
+        self.balance = 0
+        true
+      end
+    end
 
-class Coke < Product
-  has_extra_data
-  validates :is_diet, :in => [true, false]
-end
+    class BankAccount < Account
+      has_extra_data do
+        belongs_to :bank
+      end
+    end
 
-schema
+    class CreditCard < Account
+      has_extra_data
+    end
 
-create_table :drinks do |t|
-  t.string type, :null => false
-  t.boolean :is_hot, :null => false
-end 
+    class Bank < ActiveRecord::Base
+      has_one :bank_account
+    end
 
-create_table :coke_data do |t|
-  t.integer :coke_id, :null => false # Foreign key here...
-  t.boolean :is_diet, :null => false
-end
+Database Schema:
 
-Todo
-----
-Automatically pass attributes through.
+    create_table :accounts do |t|
+      t.float :balance
+    end
+
+    create_table :bank_account_data do |t|
+      t.integer :bank_account_id, :null => false
+      t.integer :bank_id, :null => false
+      t.string :account_number, :null => false
+      t.string :sort_code, :null => false
+    end
+
+    create_table :credit_card_data do |t|
+      t.integer :credit_card_id, :null => false
+      t.string :credit_card_number, :null => false
+      t.date :expiry_date, :null => false
+    end
+
+    create_table :banks do |t|
+      t.string :name, :null => false
+    end

data/has_extra_data.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["jez.walker@gmail.com"]
   s.homepage    = ""
   s.summary     = %q{Ruby Rails - Add extra data to SDI models with clean database tables.}
-  s.description = %q{Adds an add_extra_data method to ActiveRecord that invisibly includes an extra data table. Use with STI to keep your database clean.}
+  s.description = %q{Adds an add_extra_data method to ActiveRecord that invisibly includes an extra data table. Means you can use STI but keep your database clean.}
 
   s.add_dependency "rails"
   s.add_development_dependency "rspec-rails"

data/lib/has_extra_data/hook.rb

@@ -1,16 +1,51 @@
 module HasExtraData
   module Hook
-    def has_extra_data(&block)
+    
+    ######
+    # has_extra_data(options = {})
+    #
+    # In it's most raw form, this method creates an associated Data class, 
+    # which seamlessly adds attributes and methods to the main class
+    #
+    # If passed a block, extra attributes can be set on the data table, 
+    # methods (e.g. has_many) can be called, and other methods can be defined.
+    #
+    # Options:
+    #   table_name: The table name of the class
+    #####
+    def has_extra_data(options = {}, &block)
 
-      table_name = "#{self.name.underscore.gsub("/", "_")}_data"
+      table_name = options[:table_name] || "#{self.name.underscore.gsub("/", "_")}_data"
       klass = Class.new(ActiveRecord::Base) do
         set_table_name(table_name)
       end
       klass.class_eval &block if block_given?
       self.const_set "Data", klass
-
+  
+      # Add a reference to a data object that gets created when this is created
       has_one :data, :class_name => "#{self.name}::Data"
-      before_create :build_data
+      before_create :get_data
+      
+      # A helper method which gets the existing data or builds a new object
+      define_method :get_data do
+        data || build_data
+      end
+      
+      # Override respond_to? to check both this object and its data object.
+      define_method "respond_to?" do |sym, include_private = false|
+        super(sym, include_private) || get_data.respond_to?(sym, include_private)
+      end
+      
+      # Override method_missing to check both this object and it's data object for any methods or magic functionality.
+      # Firstly, try the original method_missing because there may well be 
+      # some magic piping that will return a result and then try the data object.
+      define_method :method_missing do |sym, *args|
+        begin
+          super(sym, args)
+        rescue
+          get_data.send(sym, *args)
+        end
+      end
     end
   end
 end

data/lib/has_extra_data/version.rb

@@ -1,3 +1,3 @@
 module HasExtraData
-  VERSION = "0.1"
+  VERSION = "0.2"
 end

data/spec/has_extra_data.rb

@@ -1,30 +1,47 @@
 require 'spec_helper'
 
-describe "HasExtraData" do
+describe "Extra data models" do
+  
+  before :each do 
+    @bank = Bank.create!(:name => "My Bank")
+    @bank_account = BankAccount.new
+    @valid_bank_account_attributes = {:account_number => "12345678", :sort_code => "12 34 56", :bank => @bank}
+  end
+  
+  it "have the data method" do
+    @bank_account.should respond_to(:data)
+  end
 
-  before :each do
-    if Object.const_defined?("TestClass")
-      Object.send(:remove_const, "TestClass")
-    end
-    @klass = Class.new(ActiveRecord::Base)
-    Object.const_set "TestClass", @klass
+  it "can have variables set" do
+    @bank_account.account_number = "12345678"
+    @bank_account.sort_code = "12 34 56"
+    @bank_account.bank = @bank
+    @bank_account.save!
+    @bank_account.data.id.should_not == 0
+  end
+  
+  it "creates data with the test class" do
+    @bank_account.attributes = @valid_bank_account_attributes
+    @bank_account.save!
+    @bank_account.data.id.should_not == 0
   end
 
-  it "has_extra_data can be called on an AR class" do
-    lambda{
-      @klass.class_eval{has_extra_data}
-    }.should_not raise_error
+  it "can read attributes" do
+    @bank_account.attributes = @valid_bank_account_attributes
+    @bank_account.save!
+    @bank_account = BankAccount.find(@bank_account.id)
+    @bank_account.account_number.should == "12345678"
   end
   
-  it "has_extra_data adds the data method" do
-    @klass.class_eval{has_extra_data}
-    @klass.new.should respond_to(:data)
+  it "can read associations" do
+    @bank_account.attributes = @valid_bank_account_attributes
+    @bank_account.save!
+    @bank_account = BankAccount.find(@bank_account.id)
+    @bank_account.bank.should == @bank
   end
   
-  it "creates data with the test class" do
-    @klass.class_eval{has_extra_data}
-    obj = @klass.create!
-    obj.data.id.should_not == 0
+  it "can have any table name" do
+    SillyAccount.create!
   end
   
 end

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@ require 'active_record'
 
 $:.unshift File.dirname(__FILE__) + '/../lib'
 
-# This isn't working so I have to use the second line...
+# Thie first line isn't working so I have added the second...
 require File.dirname(__FILE__) + '/../lib/has_extra_data'
 ActiveRecord::Base.send(:extend, HasExtraData::Hook)
  
@@ -17,10 +17,30 @@ $stdout = StringIO.new
 
 ActiveRecord::Base.logger
 ActiveRecord::Schema.define(:version => 1) do
-  create_table :test_classes do |t|
+  create_table :accounts do |t|
+    t.float :balance
   end
   
-  create_table :test_class_data do |t|
-    t.integer :test_class_id, :null => false
+  create_table :bank_account_data do |t|
+    t.integer :bank_account_id, :null => false
+    t.integer :bank_id, :null => false
+    t.string :account_number, :null => false
+    t.string :sort_code, :null => false
   end
-end
+
+  create_table :credit_card_data do |t|
+    t.integer :credit_card_id, :null => false
+    t.string :credit_card_number, :null => false
+    t.date :expiry_date, :null => false
+  end
+
+  create_table :banks do |t|
+    t.string :name, :null => false
+  end
+  
+  create_table :silly_table_name do |t|
+    t.integer :silly_account_id, :null => false
+  end
+end
+
+require 'test_classes'

data/spec/test_classes.rb

@@ -0,0 +1,27 @@
+class Account < ActiveRecord::Base
+  before_create :set_initial_balance
+  
+private
+  def set_initial_balance
+    self.balance = 0
+    true
+  end
+end
+
+class BankAccount < Account
+  has_extra_data do
+    belongs_to :bank
+  end
+end
+
+class CreditCard < Account
+  has_extra_data
+end
+
+class SillyAccount < Account
+  has_extra_data :table_name => "silly_table_name" 
+end
+
+class Bank < ActiveRecord::Base
+  has_one :bank_account
+end

metadata

@@ -2,7 +2,7 @@
 name: has_extra_data
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: "0.1"
+  version: "0.2"
 platform: ruby
 authors: 
 - Jeremy Walker
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-16 00:00:00 +01:00
+date: 2011-05-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,7 +35,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
-description: Adds an add_extra_data method to ActiveRecord that invisibly includes an extra data table. Use with STI to keep your database clean.
+description: Adds an add_extra_data method to ActiveRecord that invisibly includes an extra data table. Means you can use STI but keep your database clean.
 email: 
 - jez.walker@gmail.com
 executables: []
@@ -46,6 +46,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
 - Gemfile
 - README
 - Rakefile
@@ -56,6 +57,7 @@ files:
 - lib/has_extra_data/version.rb
 - spec/has_extra_data.rb
 - spec/spec_helper.rb
+- spec/test_classes.rb
 has_rdoc: true
 homepage: ""
 licenses: []
@@ -87,3 +89,4 @@ summary: Ruby Rails - Add extra data to SDI models with clean database tables.
 test_files: 
 - spec/has_extra_data.rb
 - spec/spec_helper.rb
+- spec/test_classes.rb