has_magic_columns 0.1.2 → 0.2.0

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/README.md

@@ -30,37 +30,37 @@ Usage
 
 Sprinkle a little magic into an existing model:
 
-    class User < ActiveRecord::Base
+    class Person < ActiveRecord::Base
       has_magic_columns
     end
 
 Add magic columns to your model:
 
-    @bob = User.create(:email => "bob@example.com")
-    @bob.magic_columns.create(:name => "first_name")
+    @charlie = Person.create(:email => "charlie@example.com")
+    @charlie.magic_columns.create(:name => "first_name")
 
 Supply additional options if you have more specific requirements for your columns:
 
-    @bob.magic_columns.create(:name => "last_name", :is_required => true)
-    @bob.magic_columns.create(:name => "birthday", :datatype => :date)
-    @bob.magic_columns.create(:name => "salary", :default => "40000", :pretty_name => "Yearly Salary")
+    @charlie.magic_columns.create(:name => "last_name", :is_required => true)
+    @charlie.magic_columns.create(:name => "birthday", :datatype => :date)
+    @charlie.magic_columns.create(:name => "salary", :default => "40000", :pretty_name => "Yearly Salary")
 
 The :datatype option supports :check_box_boolean, :date, :datetime, or :integer.
 
 Use your new columns just like you would with any other ActiveRecord attribute:
 
-    @bob.first_name = "Bob"
-    @bob.last_name = "Magic!"
-    @bob.birthday = Date.today
-    @bob.save
+    @charlie.first_name = "Charlie"
+    @charlie.last_name = "Magic!"
+    @charlie.birthday = Date.today
+    @charlie.save
 
-Find @bob and inspect him:
+Find @charlie and inspect him:
 
-    @bob = User.find(@bob.id)
-    @bob.first_name	#=> "Bob"
-    @bob.last_name	#=> "Magic!"
-    @bob.birthday	#=> #<Date: 4908497/2,0,2299161>
-    @bob.salary     #=> "40000", this is from :salary having a :default
+    @charlie = User.find(@charlie.id)
+    @charlie.first_name	#=> "Charlie"
+    @charlie.last_name	#=> "Magic!"
+    @charlie.birthday	#=> #<Date: 4908497/2,0,2299161>
+    @charlie.salary     #=> "40000", this is from :salary having a :default
 
 ## Inherited Model
 
@@ -71,6 +71,7 @@ as having magic columns:
       has_many :users
       has_magic_columns
     end
+    @account = Account.create(:name => "BobCorp")
 
 And declare the child as having magic columns :through the parent.
 
@@ -78,36 +79,34 @@ And declare the child as having magic columns :through the parent.
       belongs_to :account
       has_magic_columns :through => :account
     end
+    @alice = User.create(:name => "alice", :account => @account)
 
 To see all the magic columns available for a child from its parent:
 
-    @user.magic_columns #=> [#<MagicColumn>,...]
-    @user.account.magic_columns #=> [#<MagicColumn>,...]
+    @alice.magic_columns #=> [#<MagicColumn>,...]
+    @account.magic_columns #=> [#<MagicColumn>,...]
+    @alice.account.magic_columns #=> [#<MagicColumn>,...]
 
 To add magic columns, go through the parent or child:
 
-    @user.magic_columns.create(...)
-    @user.account.magic_columns.create(...)
+    @alice.magic_columns.create(...)
+    @account.magic_columns.create(...)
 
 All children for a given parent will have access to the same magic columns:
 
-    @account = Account.create(:name => "BobCorp")
+    @alice.magic_columns.create(:name => "salary")
+    @alice.salary = "40000"
 
     @bob = User.create(:name => "bob", :account => @account)
-    @bob.magic_columns.create(:name => "salary")
-    @bob.salary = "40000"
-
-    @steve = User.create(:name => "bob", :account => @account)
-    # no need to add the column again
-    @steve.salary = "50000"
+    # Magic! No need to add the column again!
+    @bob.salary = "50000"
 
 To Do
 =====
 
-This gem is mostly functional. Here's a short list of things that need to be
-done to polish it up:
+Here's a short list of things that need to be done to polish up this gem:
 
-* Test
+* Test other parts of the data model (e.g. magic_attributes, magic_options)
 * Benchmark and optimize
 
 Maintainers
@@ -119,3 +118,9 @@ Maintainers
 Contribute
 ==========
 See the [CONTRIBUTORS guide](https://github.com/latortuga/has_magic_columns/blob/master/CONTRIBUTORS.md).
+
+Credits
+=======
+
+* Thank you to Brandon Keene for his original work making this plugin.
+* Thank you to the [will_paginate](https://github.com/mislav/will_paginate) gem for iinspiration and code examples for how to test a Rails plugin.

data/Rakefile

@@ -1,20 +1,11 @@
 require 'rake'
 gem 'rdoc'
 require 'rdoc/task'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-#desc 'Default: run unit tests.'
-task :default => :test
-
-Rake::TestTask.new do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
-
 desc 'Generate documentation.'
 RDoc::Task.new do |rdoc|
   rdoc.main = "README.md"
@@ -23,3 +14,18 @@ RDoc::Task.new do |rdoc|
   rdoc.title    = 'HasMagicColumns'
   rdoc.options << '--line-numbers' << '--inline-source'
 end
+
+task :default => :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.ruby_opts = "-Ilib:spec"
+end
+
+namespace :spec do
+  desc "Run Rails specs"
+  RSpec::Core::RakeTask.new(:rails) do |t|
+    t.pattern = %w'spec/finders/active_record_spec.rb spec/view_helpers/action_view_spec.rb'
+  end
+end

data/has_magic_columns.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.date = Date.today
 
   s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- {test,spec,features}/`.split("\n")
+  s.test_files = `git ls-files -- spec/`.split("\n")
   s.require_paths = ["lib"]
 
   s.add_dependency("activesupport", ["~> 3.0"])

data/init.rb

@@ -1 +1,5 @@
-ActiveRecord::Base.send :include, Has::Magic::Columns
+require 'has_magic_columns'
+
+if defined? ActiveRecord::Base
+  require 'has_magic_columns/active_record'
+end

data/lib/app/models/magic_attribute.rb

@@ -24,6 +24,6 @@ private
 
   def find_magic_option_for(value)
     magic_column.magic_options.find(:first,
-      :conditions => ["value = ? or synonym = ?", value, value])
+      :conditions => ["value = ? or synonym = ?", value, value]) unless magic_column.nil? or magic_column.magic_options.nil?
   end
 end

data/lib/has_magic_columns.rb

@@ -1,7 +1,3 @@
-require 'has_magic_columns/has_magic_columns'
-require 'has_magic_columns/version'
-require 'has_magic_columns/railtie' if defined?(Rails)
-
 # Has Magic Columns
 #
 # Copyright (c) 2007 Brandon Keene <bkeene AT gmail DOT com>
@@ -22,3 +18,11 @@ require 'has_magic_columns/railtie' if defined?(Rails)
 module HasMagicColumns # :nodoc:
 end
 
+require 'has_magic_columns/version'
+
+if defined? Rails::Railtie
+  require 'has_magic_columns/railtie'
+elsif defined? Rails::Initializer
+  $stderr.puts "\nhas_magic_columns is not compatible with Rails 2, use at your own risk.\n\n"
+end
+

data/lib/has_magic_columns/active_record.rb

@@ -0,0 +1,183 @@
+require 'active_support'
+require 'active_record'
+
+module HasMagicColumns #:nodoc:
+  module ActiveRecord
+    module ClassMethods
+      def has_magic_columns(options = {})
+        unless magical?
+          # Associations
+          has_many :magic_attribute_relationships, :as => :owner, :dependent => :destroy
+          has_many :magic_attributes, :through => :magic_attribute_relationships, :dependent => :destroy
+          
+          # Eager loading - EXPERIMENTAL!
+          if options[:eager]
+            class_eval do
+              def after_initialize
+                initialize_magic_columns
+              end
+            end
+          end
+          
+          # Inheritence
+          cattr_accessor :inherited_from
+
+          # if options[:through] is supplied, treat as an inherited relationship
+          if self.inherited_from = options[:through]
+            class_eval do
+              def inherited_magic_columns
+                raise "Cannot inherit MagicColumns from a non-existant association: #{@inherited_from}" unless self.class.method_defined?(inherited_from)# and self.send(inherited_from)
+                self.send(inherited_from).magic_columns
+              end
+            end
+            alias_method :magic_columns, :inherited_magic_columns unless method_defined? :magic_columns
+
+          # otherwise the calling model has the relationships
+          else
+            has_many :magic_column_relationships, :as => :owner, :dependent => :destroy
+            has_many :magic_columns, :through => :magic_column_relationships, :dependent => :destroy
+          end
+          
+          # Hook into Base
+          class_eval do
+            alias_method :reload_without_magic, :reload
+            alias_method :create_or_update_without_magic, :create_or_update
+            alias_method :read_attribute_without_magic, :read_attribute
+          end
+        end
+        include InstanceMethods
+        
+        # Add Magic to Base
+        alias_method :reload, :reload_with_magic
+        alias_method :read_attribute, :read_attribute_with_magic
+        alias_method :create_or_update, :create_or_update_with_magic
+      end
+
+      def magical?
+        self.included_modules.include?(InstanceMethods)
+      end
+    end
+
+    module InstanceMethods #:nodoc:
+      # Reinitialize MagicColumns and MagicAttributes when Model is reloaded
+      def reload_with_magic
+        initialize_magic_columns
+        reload_without_magic
+      end
+
+      def update_attributes(new_attributes)
+        attributes = new_attributes.stringify_keys
+        magic_attrs = magic_columns.map(&:name)
+
+        super(attributes.select{ |k, v| !magic_attrs.include?(k) })
+        attributes.select{ |k, v| magic_attrs.include?(k) }.each do |k, v|
+          col = find_magic_column_by_name(k)
+          attr = find_magic_attribute_by_column(col).first
+          attr.update_attributes(:value => v)
+        end
+      end
+
+      private
+      
+      # Save MagicAttributes from @attributes
+      def create_or_update_with_magic
+        if result = create_or_update_without_magic
+          magic_columns.each do |column|
+            value = @attributes[column.name]
+            existing = find_magic_attribute_by_column(column)
+            
+            unless column.datatype == 'check_box_multiple'
+              (attr = existing.first) ? 
+                update_magic_attribute(attr, value) : 
+                create_magic_attribute(column, value)
+            else
+              #TODO - make this more efficient
+              value = [value] unless value.is_a? Array
+              existing.map(&:destroy) if existing
+              value.collect {|v| create_magic_attribute(column, v)}
+            end
+          end
+        end
+        result
+      end
+      
+      # Load (lazily) MagicAttributes or fall back
+      def method_missing(method_id, *args)
+        super(method_id, *args)
+      rescue NoMethodError
+        method_name = method_id.to_s
+        attr_names = magic_columns.map(&:name)
+        initialize_magic_columns and retry if attr_names.include?(method_name) or 
+          (md = /[\?|\=]/.match(method_name) and 
+          attr_names.include?(md.pre_match))
+        super(method_id, *args)
+      end
+      
+      # Load the MagicAttribute(s) associated with attr_name and cast them to proper type.
+      def read_attribute_with_magic(attr_name)
+        return read_attribute_without_magic(attr_name) if column_for_attribute(attr_name) # filter for regular columns
+        attr_name = attr_name.to_s
+        
+        if !(value = @attributes[attr_name]).nil?
+          if column = find_magic_column_by_name(attr_name)
+            if value.is_a? Array
+              value.map {|v| column.type_cast(v)}
+            else
+              column.type_cast(value)
+            end
+          else
+            value
+          end
+        else
+          nil
+        end
+      end
+      
+      # Lookup all MagicAttributes and setup @attributes
+      def initialize_magic_columns
+        magic_columns.each do |column| 
+          attribute = find_magic_attribute_by_column(column)
+          name = column.name
+          
+          # Validation
+          self.class.validates_presence_of(name) if column.is_required?
+          
+          # Write attribute
+          unless column.datatype == 'check_box_multiple'
+            (attr = attribute.first) ?
+              write_attribute(name, attr.to_s) :
+              write_attribute(name, column.default)
+          else
+            write_attribute(name, attribute.map(&:to_s))
+          end
+        end
+      end
+      
+      def find_magic_attribute_by_column(column)
+        magic_attributes.to_a.find_all {|attr| attr.magic_column_id == column.id}
+      end
+      
+      def find_magic_column_by_name(attr_name)
+        magic_columns.to_a.find {|column| column.name == attr_name}
+      end
+      
+      def create_magic_attribute(magic_column, value)
+        magic_attributes << MagicAttribute.create(:magic_column => magic_column, :value => value)
+      end
+      
+      def update_magic_attribute(magic_attribute, value)
+        magic_attribute.update_attributes(:value => value)
+      end
+    end
+
+    # mix into Active Record
+    ::ActiveRecord::Base.extend ClassMethods
+
+    %w{ models }.each do |dir|
+      path = File.join(File.dirname(__FILE__), '../app', dir)
+      $LOAD_PATH << path
+      ActiveSupport::Dependencies.autoload_paths << path
+      ActiveSupport::Dependencies.autoload_once_paths.delete(path)
+    end
+  end
+end

data/lib/has_magic_columns/railtie.rb

@@ -3,19 +3,8 @@ require 'has_magic_columns'
 module HasMagicColumns
   class Railtie < Rails::Railtie
     initializer "has_magic_columns" do
-
-      # I think this is probably a ghetto way of doing this
-      # based on some limited research into other plugins. Neverhtless
-      # it's the only way I know for the moment.
       ActiveSupport.on_load :active_record do
-        ActiveRecord::Base.send(:include, HasMagicColumns)
-
-        %w{ models }.each do |dir|
-          path = File.join(File.dirname(__FILE__), '../app', dir)
-          $LOAD_PATH << path
-          ActiveSupport::Dependencies.autoload_paths << path
-          ActiveSupport::Dependencies.autoload_once_paths.delete(path)
-        end
+        require 'has_magic_columns/active_record'
       end
     end
   end

data/lib/has_magic_columns/version.rb

@@ -1,3 +1,3 @@
 module HasMagicColumns
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/database.yml

@@ -0,0 +1,23 @@
+sqlite3:
+  database: ":memory:"
+  adapter: sqlite3
+  timeout: 500
+
+mysql:
+  adapter: mysql
+  database: has_magic_columns
+  username: 
+  encoding: utf8
+
+mysql2:
+  adapter: mysql2
+  database: has_magic_columns
+  username: 
+  encoding: utf8
+
+postgres:
+  adapter: postgresql
+  database: has_magic_columns
+  username: postgres
+  min_messages: warning
+

data/spec/finders/activerecord_test_connector.rb

@@ -0,0 +1,113 @@
+require 'active_record'
+require 'active_record/fixtures'
+require 'active_support/multibyte' # needed for Ruby 1.9.1
+
+$query_count = 0
+$query_sql = []
+
+ignore_sql = /
+    ^(
+      PRAGMA | SHOW\ max_identifier_length |
+      SELECT\ (currval|CAST|@@IDENTITY|@@ROWCOUNT) |
+      SHOW\ (FIELDS|TABLES)
+    )\b |
+    \bFROM\ (sqlite_master|pg_tables|pg_attribute)\b
+  /x
+
+ActiveSupport::Notifications.subscribe(/^sql\./) do |*args|
+  payload = args.last
+  unless payload[:name] =~ /^Fixture/ or payload[:sql] =~ ignore_sql
+    $query_count += 1
+    $query_sql << payload[:sql]
+  end
+end
+
+module ActiverecordTestConnector
+  extend self
+
+  attr_accessor :able_to_connect
+  attr_accessor :connected
+
+  FIXTURES_PATH = File.expand_path('../../fixtures', __FILE__)
+
+  Fixtures = defined?(ActiveRecord::Fixtures) ? ActiveRecord::Fixtures : ::Fixtures
+
+  # Set our defaults
+  self.connected = false
+  self.able_to_connect = true
+
+  def setup
+    unless self.connected || !self.able_to_connect
+      setup_connection
+      load_schema
+      add_load_path FIXTURES_PATH
+      self.connected = true
+    end
+  rescue Exception => e  # errors from ActiveRecord setup
+    $stderr.puts "\nSkipping ActiveRecord tests: #{e}\n\n"
+    self.able_to_connect = false
+  end
+
+  private
+  
+  def add_load_path(path)
+    dep = defined?(ActiveSupport::Dependencies) ? ActiveSupport::Dependencies : ::Dependencies
+    dep.autoload_paths.unshift path
+  end
+
+  def setup_connection
+    db = ENV['DB'].blank? ? 'sqlite3' : ENV['DB']
+
+    configurations = YAML.load_file(File.expand_path('../../database.yml', __FILE__))
+    raise "no configuration for '#{db}'" unless configurations.key? db
+    configuration = configurations[db]
+
+    # ActiveRecord::Base.logger = Logger.new(STDOUT) if $0 == 'irb'
+    puts "using #{configuration['adapter']} adapter"
+
+    ActiveRecord::Base.configurations = { db => configuration }
+    ActiveRecord::Base.establish_connection(db)
+    ActiveRecord::Base.default_timezone = :utc
+  end
+
+  def load_schema
+    ActiveRecord::Base.silence do
+      ActiveRecord::Migration.verbose = false
+      load File.join(FIXTURES_PATH, 'schema.rb')
+    end
+  end
+
+  module FixtureSetup
+    def fixtures(*tables)
+      table_names = tables.map { |t| t.to_s }
+
+      fixtures = Fixtures.create_fixtures ActiverecordTestConnector::FIXTURES_PATH, table_names
+      @@loaded_fixtures = {}
+      @@fixture_cache = {}
+
+      unless fixtures.nil?
+        if fixtures.instance_of?(Fixtures)
+          @@loaded_fixtures[fixtures.table_name] = fixtures
+        else
+          fixtures.each { |f| @@loaded_fixtures[f.table_name] = f }
+        end
+      end
+
+      table_names.each do |table_name|
+        define_method(table_name) do |*fixtures|
+          @@fixture_cache[table_name] ||= {}
+
+          instances = fixtures.map do |fixture|
+            if @@loaded_fixtures[table_name][fixture.to_s]
+              @@fixture_cache[table_name][fixture] ||= @@loaded_fixtures[table_name][fixture.to_s].find
+            else
+              raise StandardError, "No fixture with name '#{fixture}' found for table '#{table_name}'"
+            end
+          end
+
+          instances.size == 1 ? instances.first : instances
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/account.rb

@@ -0,0 +1,7 @@
+# Account class tests the case where has_magic_columns is used in a parent-
+# child fashion where the Account model has the magic columns and the User
+# model inherits them through the associated Account.
+class Account < ActiveRecord::Base
+  has_many :users
+  has_magic_columns
+end

data/spec/fixtures/accounts.yml

@@ -0,0 +1,2 @@
+important:
+  name: "Important Account"

data/spec/fixtures/people.yml

@@ -0,0 +1,5 @@
+charlie:
+  name: "Charlie"
+
+denise:
+  name: "Denise"

data/spec/fixtures/person.rb

@@ -0,0 +1,5 @@
+# Person class tests the case where has_magic_columns is used on a model
+# without the parent-child relationship.
+class Person < ActiveRecord::Base
+  has_magic_columns
+end

data/spec/fixtures/schema.rb

@@ -0,0 +1,61 @@
+ActiveRecord::Schema.define do
+
+  create_table "users", :force => true do |t|
+    t.column "name",       :text
+    t.column "account_id", :integer
+  end
+
+  create_table "accounts", :force => true do |t|
+    t.column "name",       :text
+  end
+
+  create_table "people", :force => true do |t|
+    t.column "name",       :text
+  end
+
+
+  # Has Magic Columns migration generator output
+
+  create_table :magic_columns do |t|
+    t.column :name,           :string
+    t.column :pretty_name,    :string
+    t.column :datatype,       :string, :default => "string"
+    t.column :default,        :string
+    t.column :is_required,    :boolean, :default => false
+    t.column :include_blank,  :boolean, :default => false
+    t.column :allow_other,    :boolean, :default => true
+    t.column :created_at,     :datetime
+    t.column :updated_at,     :datetime
+  end
+  
+  create_table :magic_attributes do |t|
+    t.column :magic_column_id, :integer
+    t.column :magic_option_id, :integer
+    t.column :value, :string
+    t.column :created_at, :datetime
+    t.column :updated_at, :datetime
+  end
+  
+  create_table :magic_options do |t|
+    t.column :magic_column_id, :integer
+    t.column :value, :string
+    t.column :synonym, :string
+    t.column :created_at, :datetime
+    t.column :updated_at, :datetime
+  end
+  
+  create_table :magic_column_relationships do |t|
+    t.column :magic_column_id, :integer
+    t.column :owner_id, :integer
+    t.column :owner_type, :string
+    t.column :created_at, :datetime
+    t.column :updated_at, :datetime
+  end
+  
+  create_table :magic_attribute_relationships do |t|
+    t.column :magic_attribute_id, :integer
+    t.column :owner_id, :integer
+    t.column :owner_type, :string
+  end   
+
+end

data/spec/fixtures/user.rb

@@ -0,0 +1,7 @@
+# User class tests the case where has_magic_columns is used in a parent-
+# child fashion where the Account model has the magic columns and the User
+# model inherits them through the associated Account.
+class User < ActiveRecord::Base
+  belongs_to :account
+  has_magic_columns :through => :account
+end

data/spec/fixtures/users.yml

@@ -0,0 +1,7 @@
+alice:
+  name: "Alice"
+  account: important
+
+bob:
+  name: "Bob"
+  account: important

data/spec/has_magic_columns_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+require 'has_magic_columns/active_record'
+require 'finders/activerecord_test_connector'
+
+ActiverecordTestConnector.setup
+abort unless ActiverecordTestConnector.able_to_connect
+
+describe HasMagicColumns do
+  extend ActiverecordTestConnector::FixtureSetup
+
+  fixtures :people, :accounts, :users
+
+  context "on a single model" do
+    before(:each) do
+      @charlie = people(:charlie)
+    end
+
+    it "initializes magic columns correctly" do
+      @charlie.should_not be_nil
+      @charlie.class.should be(Person)
+      @charlie.magic_columns.should_not be_nil
+    end
+
+    it "allows adding a magic column" do
+      @charlie.magic_columns.create(:name => 'salary')
+      @charlie.magic_columns.length.should be(1)
+    end
+
+    it "allows setting and saving of magic attributes" do
+      @charlie.magic_columns.create(:name => 'salary')
+      @charlie.salary = 50000
+      @charlie.save
+      @charlie = Person.find(people(:charlie).id)
+      @charlie.salary.should_not be_nil
+    end
+
+    #it "forces required if is_required is true" do
+    #  # TODO figure out why this fails
+    #  @charlie.magic_columns.create(:name => "last_name", :is_required => true)
+    #  @charlie.save.should be_false
+    #end
+      
+    it "allows datatype to be :date" do
+      @charlie.magic_columns.create(:name => "birthday", :datatype => :date)
+      @charlie.birthday = Date.today
+      @charlie.save.should be_true
+    end
+
+    it "allows datatype to be :datetime" do
+      @charlie.magic_columns.create(:name => "signed_up_at", :datatype => :datetime)
+      @charlie.signed_up_at = DateTime.now
+      @charlie.save.should be_true
+    end
+
+    it "allows datatype to be :integer" do
+      @charlie.magic_columns.create(:name => "age", :datatype => :integer)
+      @charlie.age = 5
+      @charlie.save.should be_true
+    end
+
+    it "allows datatype to be :check_box_boolean" do
+      @charlie.magic_columns.create(:name => "retired", :datatype => :check_box_boolean)
+      @charlie.retired = false
+      @charlie.save.should be_true
+    end
+
+    it "allows default to be set" do
+      @charlie.magic_columns.create(:name => "bonus", :default => "40000")
+      @charlie.bonus.should == "40000"
+    end
+
+    it "allows a pretty display name to be set" do
+      @charlie.magic_columns.create(:name => "zip", :pretty_name => "Zip Code")
+      @charlie.magic_columns.last.pretty_name.should == "Zip Code"
+    end
+  end
+
+  context "in a parent-child relationship" do
+    before(:each) do
+      @alice = users(:alice)
+      @account = accounts(:important)
+    end
+
+    it "initializes magic columns correctly" do
+      @alice.should_not be_nil
+      @alice.class.should be(User)
+      @alice.magic_columns.should_not be_nil
+
+      @account.should_not be_nil
+      @account.class.should be(Account)
+      @alice.magic_columns.should_not be_nil
+    end
+
+    it "allows adding a magic column to the child" do
+      @alice.magic_columns.create(:name => 'salary')
+      lambda{@alice.salary}.should_not raise_error
+      lambda{@account.reload_with_magic.salary}.should_not raise_error
+    end
+
+    it "allows adding a magic column to the parent" do
+      @account.magic_columns.create(:name => 'age')
+      lambda{@alice.reload_with_magic.age}.should_not raise_error
+    end
+
+    it "sets magic columns for all child models" do
+      @bob = users(:bob)
+      @bob.magic_columns.create(:name => 'birthday')
+      @alice.reload_with_magic
+      lambda{@alice.birthday}.should_not raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rspec'
+begin
+  require 'ruby-debug'
+rescue LoadError
+  # no debugger available
+end
+
+RSpec.configure do |config|
+  # config.include My::Pony, My::Horse, :type => :farm
+  # config.include MyExtras
+  # config.predicate_matchers[:swim] = :can_swim?
+  # config.mock_with :mocha
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: has_magic_columns
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-06 00:00:00.000000000Z
+date: 2011-09-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &80667260 !ruby/object:Gem::Requirement
+  requirement: &73612880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *80667260
+  version_requirements: *73612880
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &80666990 !ruby/object:Gem::Requirement
+  requirement: &73612610 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *80666990
+  version_requirements: *73612610
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &80666750 !ruby/object:Gem::Requirement
+  requirement: &73612370 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,10 +45,10 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *80666750
+  version_requirements: *73612370
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &80666560 !ruby/object:Gem::Requirement
+  requirement: &73612180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80666560
+  version_requirements: *73612180
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &80666280 !ruby/object:Gem::Requirement
+  requirement: &73611900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -67,10 +67,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *80666280
+  version_requirements: *73611900
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &80666070 !ruby/object:Gem::Requirement
+  requirement: &73611670 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,7 +78,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80666070
+  version_requirements: *73611670
 description: Allow addition of custom 'magic' columns to ActiveRecord models.
 email:
 - latortuga@gmail.com
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - CONTRIBUTORS.md
 - Gemfile
 - LICENSE
@@ -104,10 +105,20 @@ files:
 - lib/generators/has_magic_columns/install/install_generator.rb
 - lib/generators/has_magic_columns/install/templates/migration.rb
 - lib/has_magic_columns.rb
-- lib/has_magic_columns/has_magic_columns.rb
+- lib/has_magic_columns/active_record.rb
 - lib/has_magic_columns/railtie.rb
 - lib/has_magic_columns/version.rb
-- test/has_magic_columns_test.rb
+- spec/database.yml
+- spec/finders/activerecord_test_connector.rb
+- spec/fixtures/account.rb
+- spec/fixtures/accounts.yml
+- spec/fixtures/people.yml
+- spec/fixtures/person.rb
+- spec/fixtures/schema.rb
+- spec/fixtures/user.rb
+- spec/fixtures/users.yml
+- spec/has_magic_columns_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/latortuga/has_magic_columns
 licenses: []
 post_install_message: 
@@ -132,4 +143,15 @@ rubygems_version: 1.8.0
 signing_key: 
 specification_version: 3
 summary: Custom fields for Rails 3
-test_files: []
+test_files:
+- spec/database.yml
+- spec/finders/activerecord_test_connector.rb
+- spec/fixtures/account.rb
+- spec/fixtures/accounts.yml
+- spec/fixtures/people.yml
+- spec/fixtures/person.rb
+- spec/fixtures/schema.rb
+- spec/fixtures/user.rb
+- spec/fixtures/users.yml
+- spec/has_magic_columns_spec.rb
+- spec/spec_helper.rb

data/lib/has_magic_columns/has_magic_columns.rb

@@ -1,172 +0,0 @@
-module HasMagicColumns #:nodoc:
-  def self.included(base) # :nodoc:
-    base.extend ClassMethods
-  end
-
-  module ClassMethods
-    def has_magic_columns(options = {})
-      unless magical?
-        # Associations
-        has_many :magic_attribute_relationships, :as => :owner, :dependent => :destroy
-        has_many :magic_attributes, :through => :magic_attribute_relationships, :dependent => :destroy
-        
-        # Eager loading - EXPERIMENTAL!
-        if options[:eager]
-          class_eval do
-            def after_initialize
-              initialize_magic_columns
-            end
-          end
-        end
-        
-        # Inheritence
-        cattr_accessor :inherited_from
-
-        # if options[:through] is supplied, treat as an inherited relationship
-        if self.inherited_from = options[:through]
-          class_eval do
-            def inherited_magic_columns
-              raise "Cannot inherit MagicColumns from a non-existant association: #{@inherited_from}" unless self.class.method_defined?(inherited_from)# and self.send(inherited_from)
-              self.send(inherited_from).magic_columns
-            end
-          end
-          alias_method :magic_columns, :inherited_magic_columns unless method_defined? :magic_columns
-
-        # otherwise the calling model has the relationships
-        else
-          has_many :magic_column_relationships, :as => :owner, :dependent => :destroy
-          has_many :magic_columns, :through => :magic_column_relationships, :dependent => :destroy
-        end
-        
-        # Hook into Base
-        class_eval do
-          alias_method :reload_without_magic, :reload
-          alias_method :create_or_update_without_magic, :create_or_update
-          alias_method :read_attribute_without_magic, :read_attribute
-        end
-      end
-      include InstanceMethods
-      
-      # Add Magic to Base
-      alias_method :reload, :reload_with_magic
-      alias_method :read_attribute, :read_attribute_with_magic
-      alias_method :create_or_update, :create_or_update_with_magic
-    end
-
-    def magical?
-      self.included_modules.include?(InstanceMethods)
-    end
-  end
-
-  module InstanceMethods #:nodoc:
-    # Reinitialize MagicColumns and MagicAttributes when Model is reloaded
-    def reload_with_magic
-      initialize_magic_columns
-      reload_without_magic
-    end
-
-    def update_attributes(new_attributes)
-      attributes = new_attributes.stringify_keys
-      magic_attrs = magic_columns.map(&:name)
-
-      super(attributes.select{ |k, v| !magic_attrs.include?(k) })
-      attributes.select{ |k, v| magic_attrs.include?(k) }.each do |k, v|
-        col = find_magic_column_by_name(k)
-        attr = find_magic_attribute_by_column(col).first
-        attr.update_attributes(:value => v)
-      end
-    end
-
-    private
-    
-    # Save MagicAttributes from @attributes
-    def create_or_update_with_magic
-      if result = create_or_update_without_magic
-        magic_columns.each do |column|
-          value = @attributes[column.name]
-          existing = find_magic_attribute_by_column(column)
-          
-          unless column.datatype == 'check_box_multiple'
-            (attr = existing.first) ? 
-              update_magic_attribute(attr, value) : 
-              create_magic_attribute(column, value)
-          else
-            #TODO - make this more efficient
-            value = [value] unless value.is_a? Array
-            existing.map(&:destroy) if existing
-            value.collect {|v| create_magic_attribute(column, v)}
-          end
-        end
-      end
-      result
-    end
-    
-    # Load (lazily) MagicAttributes or fall back
-    def method_missing(method_id, *args)
-      super(method_id, *args)
-    rescue NoMethodError
-      method_name = method_id.to_s
-      attr_names = magic_columns.map(&:name)
-      initialize_magic_columns and retry if attr_names.include?(method_name) or 
-        (md = /[\?|\=]/.match(method_name) and 
-        attr_names.include?(md.pre_match))
-      super(method_id, *args)
-    end
-    
-    # Load the MagicAttribute(s) associated with attr_name and cast them to proper type.
-    def read_attribute_with_magic(attr_name)
-      return read_attribute_without_magic(attr_name) if column_for_attribute(attr_name) # filter for regular columns
-      attr_name = attr_name.to_s
-      
-      if !(value = @attributes[attr_name]).nil?
-        if column = find_magic_column_by_name(attr_name)
-          if value.is_a? Array
-            value.map {|v| column.type_cast(v)}
-          else
-            column.type_cast(value)
-          end
-        else
-          value
-        end
-      else
-        nil
-      end
-    end
-    
-    # Lookup all MagicAttributes and setup @attributes
-    def initialize_magic_columns
-      magic_columns.each do |column| 
-        attribute = find_magic_attribute_by_column(column)
-        name = column.name
-        
-        # Validation
-        self.class.validates_presence_of(name) if column.is_required?
-        
-        # Write attribute
-        unless column.datatype == 'check_box_multiple'
-          (attr = attribute.first) ?
-            write_attribute(name, attr.to_s) :
-            write_attribute(name, column.default)
-        else
-          write_attribute(name, attribute.map(&:to_s))
-        end
-      end
-    end
-    
-    def find_magic_attribute_by_column(column)
-      magic_attributes.to_a.find_all {|attr| attr.magic_column_id == column.id}
-    end
-    
-    def find_magic_column_by_name(attr_name)
-      magic_columns.to_a.find {|column| column.name == attr_name}
-    end
-    
-    def create_magic_attribute(magic_column, value)
-      magic_attributes << MagicAttribute.create(:magic_column => magic_column, :value => value)
-    end
-    
-    def update_magic_attribute(magic_attribute, value)
-      magic_attribute.update_attributes(:value => value)
-    end
-  end
-end

data/test/has_magic_columns_test.rb

@@ -1,8 +0,0 @@
-require 'test/unit'
-
-class HasMagicColumnsTest < Test::Unit::TestCase
-  # Replace this with your real tests.
-  def test_this_plugin
-    flunk
-  end
-end