super_sti 0.2.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.tmproj
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

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

data/Gemfile

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

data/README

@@ -0,0 +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. It removes the need to have lots of nullable columns.
+
+Usage
+---------
+Use in Rails 3 app. Add to bundler:
+gem "has_extra_data"
+
+Tests
+---------
+Uses rspec for testing.
+Run tests with rspec spec/*
+
+Todo
+---------
+* Automatically load extra data class with main class.
+* Automatically load associations in main class.
+* Automatically pass attributes through to main class.
+
+Example
+---------
+
+Usage:
+
+    Account.each do |account|
+      puts account.balance
+    end
+
+    BankAccount.each do |bank_account|
+      puts bank_account.balance
+      puts bank_account.bank.name
+    end
+
+Classes:
+    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 Bank < ActiveRecord::Base
+      has_one :bank_account
+    end
+
+Database Schema:
+
+    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/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/super_sti/hook.rb

@@ -0,0 +1,51 @@
+module SuperSTI
+  module Hook
+    
+    ######
+    # 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 = 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", :foreign_key => options[:foreign_key]
+      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/super_sti/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails'
+require 'super_sti'
+
+module SuperSTI
+  class Railtie < Rails::Railtie
+    railtie_name :super_sti
+    
+    config.to_prepare do
+      ActiveRecord::Base.send(:extend, SuperSTI::Hook)
+    end
+  end
+end

data/lib/super_sti/version.rb

@@ -0,0 +1,3 @@
+module SuperSTI
+  VERSION = "0.2.1"
+end

data/lib/super_sti.rb

@@ -0,0 +1,3 @@
+require 'active_support/core_ext'
+require File.join(File.dirname(__FILE__), "super_sti/hook")
+require File.join(File.dirname(__FILE__), "super_sti/railtie")

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require 'rails'
+require 'rspec-rails'
+require 'active_record'
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+
+# Thie first line isn't working so I have added the second...
+require File.dirname(__FILE__) + '/../lib/super_sti'
+ActiveRecord::Base.send(:extend, SuperSTI::Hook)
+ 
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ 
+# AR keeps printing annoying schema statements
+$stdout = StringIO.new
+
+ActiveRecord::Base.logger
+ActiveRecord::Schema.define(:version => 1) do
+  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
+  
+  create_table :unusual_table_name do |t|
+    t.integer :unusual_table_name_id, :null => false
+  end
+
+  create_table :unusual_foreign_key_data do |t|
+    t.integer :unusual_foreign_key, :null => false
+  end
+end
+
+require 'test_classes'

data/spec/super_sti.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe "Super STI models with has_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
+
+  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 "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 "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 "can have a specifc foreign_key" do
+    obj = UnusualForeignKey.create!
+    obj.data.should_not be_nil
+  end
+  
+  it "can have any table name" do
+    obj = UnusualTableName.create!
+    obj.data.should_not be_nil
+  end
+  
+end

data/spec/test_classes.rb

@@ -0,0 +1,31 @@
+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 UnusualForeignKey < Account
+  has_extra_data :foreign_key => "unusual_foreign_key"
+end
+
+class UnusualTableName < Account
+  has_extra_data :table_name => "unusual_table_name"
+end
+
+class Bank < ActiveRecord::Base
+  has_one :bank_account
+end

data/super_sti.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "super_sti/version"
+
+Gem::Specification.new do |s|
+  s.name        = "super_sti"
+  s.version     = SuperSTI::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jeremy Walker"]
+  s.email       = ["jez.walker@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Ruby Rails - Add has_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. Means you can use STI but keep your database clean.}
+
+  s.add_dependency "rails"
+  s.add_development_dependency "rspec-rails"
+  
+  s.rubyforge_project = "has_extra_data"
+
+  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

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: super_sti
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Jeremy Walker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+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: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README
+- Rakefile
+- lib/super_sti.rb
+- lib/super_sti/hook.rb
+- lib/super_sti/railtie.rb
+- lib/super_sti/version.rb
+- spec/spec_helper.rb
+- spec/super_sti.rb
+- spec/test_classes.rb
+- super_sti.gemspec
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: has_extra_data
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Ruby Rails - Add has_extra_data to SDI models with clean database tables.
+test_files: 
+- spec/spec_helper.rb
+- spec/super_sti.rb
+- spec/test_classes.rb