activerecord 1.0.0

data/examples/shared_setup.rb

@@ -0,0 +1,15 @@
+# Be sure to change the mysql_connection details and create a database for the example
+
+$: << File.dirname(__FILE__) + '/../lib'
+
+require 'active_record'
+require 'logger'; class Logger; def format_message(severity, timestamp, msg, progname) "#{msg}\n" end; end
+
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+ActiveRecord::Base.establish_connection(
+  :adapter  => "mysql", 
+  :host     => "localhost", 
+  :username => "root", 
+  :password => "", 
+  :database => "activerecord_examples"
+)

data/examples/validation.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/shared_setup'
+
+logger = Logger.new(STDOUT)
+
+# Database setup ---------------
+
+logger.info "\nCreate tables"
+
+[ "DROP TABLE people",
+  "CREATE TABLE people (id int(11) auto_increment, name varchar(100), pass varchar(100), email varchar(100), PRIMARY KEY (id))"
+].each { |statement|
+  begin; ActiveRecord::Base.connection.execute(statement); rescue ActiveRecord::StatementInvalid; end # Tables doesn't necessarily already exist
+}
+
+
+# Class setup ---------------
+
+class Person < ActiveRecord::Base
+  # Active Record can only guess simple table names like Card/cards, Company/companies
+  def self.table_name() "people" end
+
+  # Using 
+  def self.authenticate(name, pass)
+    # find_first "name = '#{name}' AND pass = '#{pass}'" would be open to sql-injection (in a web-app scenario)
+    find_first [ "name = '%s' AND pass = '%s'", name, pass ]
+  end
+
+  def self.name_exists?(name, id = nil)
+    if id.nil?
+      condition = [ "name = '%s'", name ]
+    else
+      # Check if anyone else than the person identified by person_id has that user_name
+      condition = [ "name = '%s' AND id <> %d", name, id ]
+    end
+
+    !find_first(condition).nil?
+  end
+
+  def email_address_with_name
+    "\"#{name}\" <#{email}>"
+  end
+        
+  protected
+    def validate
+      errors.add_on_empty(%w(name pass email))
+      errors.add("email", "must be valid") unless email_address_valid?
+    end
+
+    def validate_on_create
+      if attribute_present?("name") && Person.name_exists?(name)
+          errors.add("name", "is already taken by another person")
+      end
+    end
+
+    def validate_on_update
+      if attribute_present?("name") && Person.name_exists?(name, id)
+          errors.add("name", "is already taken by another person")
+      end
+    end
+  
+  private
+    def email_address_valid?() email =~ /\w[-.\w]*\@[-\w]+[-.\w]*\.\w+/ end
+end
+
+# Usage ---------------
+
+logger.info "\nCreate fixtures"
+david = Person.new("name" => "David Heinemeier Hansson", "pass" => "", "email" => "")
+unless david.save
+  puts "There was #{david.errors.count} error(s)"
+  david.errors.each_full { |error| puts error }
+end
+
+david.pass = "something"
+david.email = "invalid_address"
+unless david.save
+  puts "There was #{david.errors.count} error(s)"
+  puts "It was email with: " + david.errors.on("email")
+end
+
+david.email = "david@loudthinking.com"
+if david.save then puts "David finally made it!" end
+
+
+another_david = Person.new("name" => "David Heinemeier Hansson", "pass" => "xc", "email" => "david@loudthinking")
+unless another_david.save
+  puts "Error on name: " + another_david.errors.on("name")
+end

data/install.rb

@@ -0,0 +1,60 @@
+require 'rbconfig'
+require 'find'
+require 'ftools'
+
+include Config
+
+# this was adapted from rdoc's install.rb by ways of Log4r
+
+$sitedir = CONFIG["sitelibdir"]
+unless $sitedir
+  version = CONFIG["MAJOR"] + "." + CONFIG["MINOR"]
+  $libdir = File.join(CONFIG["libdir"], "ruby", version)
+  $sitedir = $:.find {|x| x =~ /site_ruby/ }
+  if !$sitedir
+    $sitedir = File.join($libdir, "site_ruby")
+  elsif $sitedir !~ Regexp.quote(version)
+    $sitedir = File.join($sitedir, version)
+  end
+end
+
+makedirs = %w{ active_record/associations active_record/connection_adapters active_record/support active_record/vendor }
+makedirs.each {|f| File::makedirs(File.join($sitedir, *f.split(/\//)))}
+
+# deprecated files that should be removed
+# deprecated = %w{ }
+
+# files to install in library path
+files = %w-
+ active_record.rb
+ active_record/aggregations.rb
+ active_record/associations.rb
+ active_record/associations/association_collection.rb
+ active_record/associations/has_and_belongs_to_many_association.rb
+ active_record/associations/has_many_association.rb
+ active_record/base.rb
+ active_record/callbacks.rb
+ active_record/connection_adapters/abstract_adapter.rb
+ active_record/connection_adapters/mysql_adapter.rb
+ active_record/connection_adapters/postgresql_adapter.rb
+ active_record/connection_adapters/sqlite_adapter.rb
+ active_record/deprecated_associations.rb
+ active_record/fixtures.rb
+ active_record/observer.rb
+ active_record/reflection.rb
+ active_record/support/class_attribute_accessors.rb
+ active_record/support/class_inheritable_attributes.rb
+ active_record/support/clean_logger.rb
+ active_record/support/inflector.rb
+ active_record/transactions.rb
+ active_record/validations.rb
+ active_record/vendor/mysql.rb
+ active_record/vendor/simple.rb
+-
+
+# the acual gruntwork
+Dir.chdir("lib")
+# File::safe_unlink *deprecated.collect{|f| File.join($sitedir, f.split(/\//))}
+files.each {|f| 
+  File::install(f, File.join($sitedir, *f.split(/\//)), 0644, true)
+}

data/lib/active_record.rb

@@ -0,0 +1,48 @@
+#--
+# Copyright (c) 2004 David Heinemeier Hansson
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+$:.unshift(File.dirname(__FILE__))
+
+require 'active_record/support/clean_logger'
+
+require 'active_record/base'
+require 'active_record/observer'
+require 'active_record/validations'
+require 'active_record/callbacks'
+require 'active_record/associations'
+require 'active_record/aggregations'
+require 'active_record/transactions'
+require 'active_record/reflection'
+
+ActiveRecord::Base.class_eval do
+  include ActiveRecord::Validations
+  include ActiveRecord::Callbacks
+  include ActiveRecord::Associations
+  include ActiveRecord::Aggregations
+  include ActiveRecord::Transactions
+  include ActiveRecord::Reflection
+end
+
+require 'active_record/connection_adapters/mysql_adapter'
+require 'active_record/connection_adapters/postgresql_adapter'
+require 'active_record/connection_adapters/sqlite_adapter'

data/lib/active_record/aggregations.rb

@@ -0,0 +1,165 @@
+module ActiveRecord
+  module Aggregations # :nodoc:
+    def self.append_features(base)
+      super
+      base.extend(ClassMethods)
+    end
+
+    # Active Record implements aggregation through a macro-like class method called +composed_of+ for representing attributes 
+    # as value objects. It expresses relationships like "Account [is] composed of Money [among other things]" or "Person [is]
+    # composed of [an] address". Each call to the macro adds a description on how the value objects are created from the 
+    # attributes of the entity object (when the entity is initialized either as a new object or from finding an existing) 
+    # and how it can be turned back into attributes (when the entity is saved to the database). Example:
+    #
+    #   class Customer < ActiveRecord::Base
+    #     composed_of :balance, :class_name => "Money", :mapping => %w(balance amount)
+    #     composed_of :address, :mapping => [ %w(address_street street), %w(address_city city) ]
+    #   end
+    #
+    # The customer class now has the following methods to manipulate the value objects:
+    # * <tt>Customer#balance, Customer#balance=(money)</tt>
+    # * <tt>Customer#address, Customer#address=(address)</tt>
+    #
+    # These methods will operate with value objects like the ones described below:
+    #
+    #  class Money
+    #    include Comparable
+    #    attr_reader :amount, :currency
+    #    EXCHANGE_RATES = { "USD_TO_DKK" => 6 }  
+    # 
+    #    def initialize(amount, currency = "USD") 
+    #      @amount, @currency = amount, currency 
+    #    end
+    #
+    #    def exchange_to(other_currency)
+    #      exchanged_amount = (amount * EXCHANGE_RATES["#{currency}_TO_#{other_currency}"]).floor
+    #      Money.new(exchanged_amount, other_currency)
+    #    end
+    #
+    #    def ==(other_money)
+    #      amount == other_money.amount && currency == other_money.currency
+    #    end
+    #
+    #    def <=>(other_money)
+    #      if currency == other_money.currency
+    #        among <=> amount
+    #      else
+    #        amount <=> other_money.exchange_to(currency).amount
+    #      end
+    #    end
+    #  end
+    #
+    #  class Address
+    #    attr_reader :street, :city
+    #    def initialize(street, city) 
+    #      @street, @city = street, city 
+    #    end
+    #
+    #    def close_to?(other_address) 
+    #      city == other_address.city 
+    #    end
+    #
+    #    def ==(other_address)
+    #      city == other_address.city && street == other_address.street
+    #    end
+    #  end
+    #  
+    # Now it's possible to access attributes from the database through the value objects instead. If you choose to name the
+    # composition the same as the attributes name, it will be the only way to access that attribute. That's the case with our
+    # +balance+ attribute. You interact with the value objects just like you would any other attribute, though:
+    #
+    #   customer.balance = Money.new(20)     # sets the Money value object and the attribute
+    #   customer.balance                     # => Money value object
+    #   customer.balance.exchanged_to("DKK") # => Money.new(120, "DKK")
+    #   customer.balance > Money.new(10)     # => true
+    #   customer.balance == Money.new(20)    # => true
+    #   customer.balance < Money.new(5)      # => false
+    #
+    # Value objects can also be composed of multiple attributes, such as the case of Address. The order of the mappings will
+    # determine the order of the parameters. Example:
+    #
+    #   customer.address_street = "Hyancintvej"
+    #   customer.address_city   = "Copenhagen"
+    #   customer.address        # => Address.new("Hyancintvej", "Copenhagen")
+    #   customer.address = Address.new("May Street", "Chicago")
+    #   customer.address_street # => "May Street" 
+    #   customer.address_city   # => "Chicago" 
+    #
+    # == Writing value objects
+    #
+    # Value objects are immutable and interchangeable objects that represent a given value, such as a Money object representing
+    # $5. Two Money objects both representing $5 should be equal (through methods such == and <=> from Comparable if ranking makes
+    # sense). This is unlike a entity objects where equality is determined by identity. An entity class such as Customer can
+    # easily have two different objects that both have an address on Hyancintvej. Entity identity is determined by object or
+    # relational unique identifiers (such as primary keys). Normal ActiveRecord::Base classes are entity objects.
+    #
+    # It's also important to treat the value objects as immutable. Don't allow the Money object to have its amount changed after
+    # creation. Create a new money object with the new value instead. This is examplified by the Money#exchanged_to method that
+    # returns a new value object instead of changing its own values. Active Record won't persist value objects that have been
+    # changed through other means than the writer method.
+    #
+    # The immutable requirement is enforced by Active Record by freezing any object assigned as a value object. Attempting to 
+    # change it afterwards will result in a TypeError.
+    # 
+    # Read more about value objects on http://c2.com/cgi/wiki?ValueObject and on the dangers of not keeping value objects
+    # immutable on http://c2.com/cgi/wiki?ValueObjectsShouldBeImmutable
+    module ClassMethods
+      # Adds the a reader and writer method for manipulating a value object, so
+      # <tt>composed_of :address</tt> would add <tt>address</tt> and <tt>address=(new_address)</tt>.
+      #
+      # Options are:
+      # * <tt>:class_name</tt>  - specify the class name of the association. Use it only if that name can't be infered
+      #   from the part id. So <tt>composed_of :address</tt> will by default be linked to the +Address+ class, but
+      #   if the real class name is +CompanyAddress+, you'll have to specify it with this option.
+      # * <tt>:mapping</tt> - specifies a number of mapping arrays (attribute, parameter) that bind an attribute name
+      #   to a constructor parameter on the value class.
+      #
+      # Option examples:
+      #   composed_of :temperature, :mapping => %w(reading celsius)
+      #   composed_of :balance, :class_name => "Money", :mapping => %w(balance amount)
+      #   composed_of :address, :mapping => [ %w(address_street street), %w(address_city city) ]
+      def composed_of(part_id, options = {})
+        validate_options([ :class_name, :mapping ], options.keys)
+
+        name        = part_id.id2name
+        class_name  = options[:class_name] || name_to_class_name(name)
+        mapping     = options[:mapping]
+
+        reader_method(name, class_name, mapping)
+        writer_method(name, class_name, mapping)
+      end
+
+      private
+        # Raises an exception if an invalid option has been specified to prevent misspellings from slipping through 
+        def validate_options(valid_option_keys, supplied_option_keys)
+          unknown_option_keys = supplied_option_keys - valid_option_keys
+          raise(ActiveRecordError, "Unknown options: #{unknown_option_keys}") unless unknown_option_keys.empty?
+        end
+
+        def name_to_class_name(name)
+          name.capitalize.gsub(/_(.)/) { |s| $1.capitalize }
+        end
+        
+        def reader_method(name, class_name, mapping)
+          module_eval <<-end_eval
+            def #{name}(force_reload = false)
+              if @#{name}.nil? || force_reload
+                @#{name} = #{class_name}.new(#{(Array === mapping.first ? mapping : [ mapping ]).collect{ |pair| "read_attribute(\"#{pair.first}\")"}.join(", ")})
+              end
+              
+              return @#{name}
+            end
+          end_eval
+        end        
+        
+        def writer_method(name, class_name, mapping)
+          module_eval <<-end_eval
+            def #{name}=(part)
+              @#{name} = part.freeze
+              #{(Array === mapping.first ? mapping : [ mapping ]).collect{ |pair| "@attributes[\"#{pair.first}\"] = part.#{pair.last}" }.join("\n")}
+            end
+          end_eval
+        end
+    end
+  end
+end

data/lib/active_record/associations.rb

@@ -0,0 +1,536 @@
+require 'active_record/associations/association_collection'
+require 'active_record/associations/has_many_association'
+require 'active_record/associations/has_and_belongs_to_many_association'
+require 'active_record/deprecated_associations'
+
+module ActiveRecord
+  module Associations # :nodoc:
+    def self.append_features(base)
+      super
+      base.extend(ClassMethods)
+    end
+
+    # Associations are a set of macro-like class methods for tying objects together through foreign keys. They express relationships like 
+    # "Project has one Project Manager" or "Project belongs to a Portfolio". Each macro adds a number of methods to the class which are 
+    # specialized according to the collection or association symbol and the options hash. It works much the same was as Ruby's own attr* 
+    # methods. Example:
+    #
+    #   class Project < ActiveRecord::Base
+    #     belongs_to              :portfolio
+    #     has_one                 :project_manager 
+    #     has_many                :milestones
+    #     has_and_belongs_to_many :categories
+    #   end
+    #
+    # The project class now has the following methods to ease the traversel and manipulation of its relationships:
+    # * <tt>Project#portfolio, Project#portfolio=(portfolio), Project#portfolio.nil?, Project#portfolio?(portfolio)</tt>
+    # * <tt>Project#project_manager, Project#project_manager=(project_manager), Project#project_manger.nil?,</tt>
+    #   <tt>Project#project_manager?(project_manager), Project#build_project_manager, Project#create_project_manager</tt>
+    # * <tt>Project#milestones.empty?, Project#milestones.size, Project#milestones, Project#milestones<<(milestone),</tt>
+    #   <tt>Project#milestones.delete(milestone), Project#milestones.find(milestone_id), Project#milestones.find_all(conditions),</tt>
+    #   <tt>Project#milestones.build, Project#milestones.create</tt>
+    # * <tt>Project#categories.empty?, Project#categories.size, Project#categories, Project#categories<<(category1),</tt>
+    #   <tt>Project#categories.delete(category1)</tt>
+    #
+    # == Example
+    #
+    # link:../examples/associations.png
+    #
+    # == Is it belongs_to or has_one?
+    #
+    # Both express a 1-1 relationship, the difference is mostly where to place the foreign key, which goes on the table for the class
+    # saying belongs_to. Example:
+    #
+    #   class Post < ActiveRecord::Base
+    #     has_one :author
+    #   end
+    #
+    #   class Author < ActiveRecord::Base
+    #     belongs_to :post
+    #   end
+    #
+    # The tables for these classes could look something like:
+    #
+    #   CREATE TABLE posts (
+    #     id int(11) NOT NULL auto_increment,
+    #     title varchar default NULL,
+    #     PRIMARY KEY  (id)
+    #   )
+    #
+    #   CREATE TABLE authors (
+    #     id int(11) NOT NULL auto_increment,
+    #     post_id int(11) default NULL,
+    #     name varchar default NULL,
+    #     PRIMARY KEY  (id)
+    #   )
+    #
+    # == Caching
+    #
+    # All of the methods are built on a simple caching principle that will keep the result of the last query around unless specifically
+    # instructed not to. The cache is even shared across methods to make it even cheaper to use the macro-added methods without 
+    # worrying too much about performance at the first go. Example:
+    #
+    #   project.milestones             # fetches milestones from the database
+    #   project.milestones.size        # uses the milestone cache
+    #   project.milestones.empty?      # uses the milestone cache
+    #   project.milestones(true).size  # fetches milestones from the database
+    #   project.milestones             # uses the milestone cache
+    #
+    # == Modules
+    #
+    # By default, associations will look for objects within the current module scope. Consider:
+    #
+    #   module MyApplication
+    #     module Business
+    #       class Firm < ActiveRecord::Base
+    #          has_many :clients
+    #        end
+    #
+    #       class Company < ActiveRecord::Base; end
+    #     end
+    #   end
+    #
+    # When Firm#clients is called, it'll in turn call <tt>MyApplication::Business::Company.find(firm.id)</tt>. If you want to associate
+    # with a class in another module scope this can be done by specifying the complete class name, such as:
+    #
+    #   module MyApplication
+    #     module Business
+    #       class Firm < ActiveRecord::Base; end
+    #     end
+    #
+    #     module Billing
+    #       class Account < ActiveRecord::Base
+    #         belongs_to :firm, :class_name => "MyApplication::Business::Firm"
+    #       end
+    #     end
+    #   end
+    #
+    # == Type safety with ActiveRecord::AssociationTypeMismatch
+    #
+    # If you attempt to assign an object to an association that doesn't match the inferred or specified <tt>:class_name</tt>, you'll
+    # get a ActiveRecord::AssociationTypeMismatch.
+    #
+    # == Options
+    #
+    # All of the association macros can be specialized through options which makes more complex cases than the simple and guessable ones
+    # possible.
+    module ClassMethods
+      # Adds the following methods for retrival and query of collections of associated objects.
+      # +collection+ is replaced with the symbol passed as the first argument, so 
+      # <tt>has_many :clients</tt> would add among others <tt>has_clients?</tt>.
+      # * <tt>collection(force_reload = false)</tt> - returns an array of all the associated objects.
+      #   An empty array is returned if none is found.
+      # * <tt>collection<<(object)</tt> - adds the object to the collection (by setting the foreign key on it) and saves it.
+      # * <tt>collection.delete(object)</tt> - removes the association by setting the foreign key to null on the associated object.
+      # * <tt>!collection.empty?</tt> - returns true if there's any associated objects.
+      # * <tt>collection.size</tt> - returns the number of associated objects.
+      # * <tt>collection.find(id)</tt> - finds an associated object responding to the +id+ and that
+      #   meets the condition that it has to be associated with this object.
+      # * <tt>collection.find_all(conditions = nil, orderings = nil, limit = nil, joins = nil)</tt> - finds all associated objects responding 
+      #   criterias mentioned (like in the standard find_all) and that meets the condition that it has to be associated with this object.
+      # * <tt>collection.build(attributes = {})</tt> - returns a new object of the collection type that has been instantiated
+      #   with +attributes+ and linked to this object through a foreign key but has not yet been saved.
+      # * <tt>collection.create(attributes = {})</tt> - returns a new object of the collection type that has been instantiated
+      #   with +attributes+ and linked to this object through a foreign key and that has already been saved (if it passed the validation).
+      #
+      # Example: A Firm class declares <tt>has_many :clients</tt>, which will add:
+      # * <tt>Firm#clients</tt> (similar to <tt>Clients.find_all "firm_id = #{id}"</tt>)
+      # * <tt>Firm#clients<<</tt>
+      # * <tt>Firm#clients.delete</tt>
+      # * <tt>!Firm#clients.empty?</tt> (similar to <tt>firm.clients.length > 0</tt>)
+      # * <tt>Firm#clients.size</tt> (similar to <tt>Client.count "firm_id = #{id}"</tt>)
+      # * <tt>Firm#clients.find</tt> (similar to <tt>Client.find_on_conditions(id, "firm_id = #{id}")</tt>)
+      # * <tt>Firm#clients.find_all</tt> (similar to <tt>Client.find_all "firm_id = #{id}"</tt>)
+      # * <tt>Firm#clients.build</tt> (similar to <tt>Client.new("firm_id" => id)</tt>)
+      # * <tt>Firm#clients.create</tt> (similar to <tt>c = Client.new("client_id" => id); c.save; c</tt>)
+      # The declaration can also include an options hash to specialize the generated methods.
+      # 
+      # Options are:
+      # * <tt>:class_name</tt>  - specify the class name of the association. Use it only if that name can't be infered
+      #   from the association name. So <tt>has_many :products</tt> will by default be linked to the +Product+ class, but
+      #   if the real class name is +SpecialProduct+, you'll have to specify it with this option.
+      # * <tt>:conditions</tt>  - specify the conditions that the associated objects must meet in order to be included as a "WHERE"
+      #   sql fragment, such as "price > 5 AND name LIKE 'B%'".
+      # * <tt>:order</tt>       - specify the order in which the associated objects are returned as a "ORDER BY" sql fragment,
+      #   such as "last_name, first_name DESC"
+      # * <tt>:foreign_key</tt> - specify the foreign key used for the association. By default this is guessed to be the name
+      #   of this class in lower-case and "_id" suffixed. So a +Person+ class that makes a has_many association will use "person_id"
+      #   as the default foreign_key.
+      # * <tt>:dependent</tt>   - if set to true all the associated object are destroyed alongside this object
+      # * <tt>:exclusively_dependent</tt>   - if set to true all the associated object are deleted in one SQL statement without having their
+      #   before_destroy callback run. This should only be used on associations that depend solely on this class and don't need to do any
+      #   clean-up in before_destroy. The upside is that it's much faster, especially if there's a counter_cache involved.
+      # * <tt>:finder_sql</tt>  - specify a complete SQL statement to fetch the association. This is a good way to go for complex
+      #   associations that depends on multiple tables. Note: When this option is used, +find_in_collection+ is _not_ added.
+      #
+      # Option examples:
+      #   has_many :comments, :order => "posted_on"
+      #   has_many :people, :class_name => "Person", :conditions => "deleted = 0", :order => "name"
+      #   has_many :tracks, :order => "position", :dependent => true
+      #   has_many :subscribers, :class_name => "Person", :finder_sql =>
+      #       'SELECT DISTINCT people.* ' +
+      #       'FROM people p, post_subscriptions ps ' +
+      #       'WHERE ps.post_id = #{id} AND ps.person_id = p.id ' +
+      #       'ORDER BY p.first_name'
+      def has_many(association_id, options = {})
+        validate_options([ :foreign_key, :class_name, :exclusively_dependent, :dependent, :conditions, :order, :finder_sql ], options.keys)
+        association_name, association_class_name, association_class_primary_key_name =
+              associate_identification(association_id, options[:class_name], options[:foreign_key])
+ 
+        if options[:dependent]
+          module_eval "before_destroy '#{association_name}.each { |o| o.destroy }'"
+        end
+
+        if options[:exclusively_dependent]
+          module_eval "before_destroy Proc.new{ |record| #{association_class_name}.delete_all(%(#{association_class_primary_key_name} = '\#{record.id}')) }"
+        end
+
+        module_eval <<-"end_eval", __FILE__, __LINE__
+          def #{association_name}(force_reload = false)
+            if @#{association_name}.nil?
+                @#{association_name} = HasManyAssociation.new(self, "#{association_name}", "#{association_class_name}", 
+                  "#{association_class_primary_key_name}", #{options.inspect})
+            end
+            @#{association_name}.reload if force_reload
+            
+            return @#{association_name}
+          end
+        end_eval
+        
+        # deprecated api
+        deprecated_collection_count_method(association_name)
+        deprecated_add_association_relation(association_name)
+        deprecated_remove_association_relation(association_name)
+        deprecated_has_collection_method(association_name)
+        deprecated_find_in_collection_method(association_name)
+        deprecated_find_all_in_collection_method(association_name)
+        deprecated_create_method(association_name)
+        deprecated_build_method(association_name)
+      end
+
+      # Adds the following methods for retrival and query of a single associated object.
+      # +association+ is replaced with the symbol passed as the first argument, so 
+      # <tt>has_one :manager</tt> would add among others <tt>has_manager?</tt>.
+      # * <tt>association(force_reload = false)</tt> - returns the associated object. Nil is returned if none is found.
+      # * <tt>association=(associate)</tt> - assigns the associate object, extracts the primary key, sets it as the foreign key, 
+      #   and saves the associate object.
+      # * <tt>association?(object, force_reload = false)</tt> - returns true if the +object+ is of the same type and has the
+      #   same id as the associated object.
+      # * <tt>!association.nil?</tt> - returns true if there's an associated object.
+      # * <tt>build_association(attributes = {})</tt> - returns a new object of the associated type that has been instantiated
+      #   with +attributes+ and linked to this object through a foreign key but has not yet been saved.
+      # * <tt>create_association(attributes = {})</tt> - returns a new object of the associated type that has been instantiated
+      #   with +attributes+ and linked to this object through a foreign key and that has already been saved (if it passed the validation).
+      #
+      # Example: An Account class declares <tt>has_one :beneficiary</tt>, which will add:
+      # * <tt>Account#beneficiary</tt> (similar to <tt>Beneficiary.find_first "account_id = #{id}"</tt>)
+      # * <tt>Account#beneficiary=(beneficiary)</tt> (similar to <tt>beneficiary.account_id = account.id; beneficiary.save</tt>)
+      # * <tt>Account#beneficiary?</tt> (similar to <tt>account.beneficiary == some_beneficiary</tt>)
+      # * <tt>!Account#beneficiary.nil?</tt>
+      # * <tt>Account#build_beneficiary</tt> (similar to <tt>Beneficiary.new("account_id" => id)</tt>)
+      # * <tt>Account#create_beneficiary</tt> (similar to <tt>b = Beneficiary.new("account_id" => id); b.save; b</tt>)
+      # The declaration can also include an options hash to specialize the generated methods.
+      # 
+      # Options are:
+      # * <tt>:class_name</tt>  - specify the class name of the association. Use it only if that name can't be infered
+      #   from the association name. So <tt>has_one :manager</tt> will by default be linked to the +Manager+ class, but
+      #   if the real class name is +Person+, you'll have to specify it with this option.
+      # * <tt>:conditions</tt>  - specify the conditions that the associated object must meet in order to be included as a "WHERE"
+      #   sql fragment, such as "rank = 5".
+      # * <tt>:order</tt>       - specify the order from which the associated object will be picked at the top. Specified as
+      #    an "ORDER BY" sql fragment, such as "last_name, first_name DESC"
+      # * <tt>:dependent</tt>   - if set to true the associated object is destroyed alongside this object
+      # * <tt>:foreign_key</tt> - specify the foreign key used for the association. By default this is guessed to be the name
+      #   of this class in lower-case and "_id" suffixed. So a +Person+ class that makes a has_one association will use "person_id"
+      #   as the default foreign_key.
+      #
+      # Option examples:
+      #   has_one :credit_card, :dependent => true
+      #   has_one :last_comment, :class_name => "Comment", :order => "posted_on"
+      #   has_one :project_manager, :class_name => "Person", :conditions => "role = 'project_manager'"
+      def has_one(association_id, options = {})
+        options.merge!({ :remote => true })
+        belongs_to(association_id, options)
+
+        association_name, association_class_name, class_primary_key_name =
+            associate_identification(association_id, options[:class_name], options[:foreign_key], false)
+
+        has_one_writer_method(association_name, association_class_name, class_primary_key_name)
+        build_method("build_", association_name, association_class_name, class_primary_key_name)
+        create_method("create_", association_name, association_class_name, class_primary_key_name)
+        
+        module_eval "before_destroy '#{association_name}.destroy if has_#{association_name}?'" if options[:dependent]
+      end
+
+      # Adds the following methods for retrival and query for a single associated object that this object holds an id to.
+      # +association+ is replaced with the symbol passed as the first argument, so 
+      # <tt>belongs_to :author</tt> would add among others <tt>has_author?</tt>.
+      # * <tt>association(force_reload = false)</tt> - returns the associated object. Nil is returned if none is found.
+      # * <tt>association=(associate)</tt> - assigns the associate object, extracts the primary key, and sets it as the foreign key.
+      # * <tt>association?(object, force_reload = false)</tt> - returns true if the +object+ is of the same type and has the
+      #   same id as the associated object.
+      # * <tt>association.nil?</tt> - returns true if there's an associated object.
+      #
+      # Example: An Post class declares <tt>has_one :author</tt>, which will add:
+      # * <tt>Post#author</tt> (similar to <tt>Author.find(author_id)</tt>)
+      # * <tt>Post#author=(author)</tt> (similar to <tt>post.author_id = author.id</tt>)
+      # * <tt>Post#author?</tt> (similar to <tt>post.author == some_author</tt>)
+      # * <tt>!Post#author.nil?</tt>
+      # The declaration can also include an options hash to specialize the generated methods.
+      # 
+      # Options are:
+      # * <tt>:class_name</tt>  - specify the class name of the association. Use it only if that name can't be infered
+      #   from the association name. So <tt>has_one :author</tt> will by default be linked to the +Author+ class, but
+      #   if the real class name is +Person+, you'll have to specify it with this option.
+      # * <tt>:conditions</tt>  - specify the conditions that the associated object must meet in order to be included as a "WHERE"
+      #   sql fragment, such as "authorized = 1".
+      # * <tt>:order</tt>       - specify the order from which the associated object will be picked at the top. Specified as
+      #   an "ORDER BY" sql fragment, such as "last_name, first_name DESC"
+      # * <tt>:foreign_key</tt> - specify the foreign key used for the association. By default this is guessed to be the name
+      #   of the associated class in lower-case and "_id" suffixed. So a +Person+ class that makes a belongs_to association to a
+      #   +Boss+ class will use "boss_id" as the default foreign_key.
+      # * <tt>:counter_cache</tt> - caches the number of belonging objects on the associate class through use of increment_counter 
+      #   and decrement_counter. The counter cache is incremented when an object of this class is created and decremented when it's
+      #   destroyed. This requires that a column named "#{table_name}_count" (such as comments_count for a belonging Comment class)
+      #   is used on the associate class (such as a Post class).
+      #
+      # Option examples:
+      #   belongs_to :firm, :foreign_key => "client_of"
+      #   belongs_to :author, :class_name => "Person", :foreign_key => "author_id"
+      #   belongs_to :valid_coupon, :class_name => "Coupon", :foreign_key => "coupon_id", 
+      #              :conditions => 'discounts > #{payments_count}'
+       def belongs_to(association_id, options = {})
+          validate_options([ :class_name, :foreign_key, :remote, :conditions, :order, :dependent, :counter_cache ], options.keys)
+
+          association_name, association_class_name, class_primary_key_name =
+              associate_identification(association_id, options[:class_name], options[:foreign_key], false)
+
+          association_class_primary_key_name = options[:foreign_key] || Inflector.underscore(Inflector.demodulize(association_class_name)) + "_id"
+
+          if options[:remote]
+            association_finder = <<-"end_eval"
+              #{association_class_name}.find_first(
+                "#{class_primary_key_name} = '\#{id}'#{options[:conditions] ? " AND " + options[:conditions] : ""}",
+                #{options[:order] ? "\"" + options[:order] + "\"" : "nil" }
+              )
+            end_eval
+          else
+            association_finder = options[:conditions] ?
+              "#{association_class_name}.find_on_conditions(#{association_class_primary_key_name}, \"#{options[:conditions]}\")" :
+              "#{association_class_name}.find(#{association_class_primary_key_name})"
+          end
+
+          has_association_method(association_name)
+          association_reader_method(association_name, association_finder)
+          belongs_to_writer_method(association_name, association_class_name, association_class_primary_key_name)
+          association_comparison_method(association_name, association_class_name)
+
+          if options[:counter_cache]
+            module_eval(
+              "after_create '#{association_class_name}.increment_counter(\"#{Inflector.pluralize(self.to_s.downcase). + "_count"}\", #{association_class_primary_key_name})" +
+              " if has_#{association_name}?'"
+            )
+
+            module_eval(
+              "before_destroy '#{association_class_name}.decrement_counter(\"#{Inflector.pluralize(self.to_s.downcase) + "_count"}\", #{association_class_primary_key_name})" +
+              " if has_#{association_name}?'"
+            )          
+          end
+        end
+
+      # Associates two classes via an intermediate join table.  Unless the join table is explicitly specified as
+      # an option, it is guessed using the lexical order of the class names. So a join between Developer and Project
+      # will give the default join table name of "developers_projects" because "D" outranks "P".
+      # Adds the following methods for retrival and query.
+      # +collection+ is replaced with the symbol passed as the first argument, so 
+      # <tt>has_and_belongs_to_many :categories</tt> would add among others +add_categories+.
+      # * <tt>collection(force_reload = false)</tt> - returns an array of all the associated objects.
+      #   An empty array is returned if none is found.
+      # * <tt>!collection.empty?</tt> - returns true if there's any associated objects.
+      # * <tt>collection.size</tt> - returns the number of associated objects.
+      # * <tt>collection<<(object)</tt> - adds an association between this object and the object given as argument. Multiple associations
+      #   can be created by passing an array of objects instead.
+      # * <tt>collection.delete(object)</tt> - removes the association between this object and the object given as 
+      #   argument. Multiple associations can be removed by passing an array of objects instead.
+      #
+      # Example: An Developer class declares <tt>has_and_belongs_to_many :projects</tt>, which will add:
+      # * <tt>Developer#projects</tt>
+      # * <tt>!Developer#projects.empty?</tt>
+      # * <tt>Developer#projects.size</tt>
+      # * <tt>Developer#projects<<</tt>
+      # * <tt>Developer#projects.delete</tt>
+      # The declaration can also include an options hash to specialize the generated methods.
+      # 
+      # Options are:
+      # * <tt>:class_name</tt> - specify the class name of the association. Use it only if that name can't be infered
+      #   from the association name. So <tt>has_and_belongs_to_many :projects</tt> will by default be linked to the 
+      #   +Project+ class, but if the real class name is +SuperProject+, you'll have to specify it with this option.
+      # * <tt>:join_table</tt> - specify the name of the join table if the default based on lexical order isn't what you want.
+      #   WARNING: If you're overwriting the table name of either class, the table_name method MUST be declared underneath any
+      #   has_and_belongs_to_many declaration in order to work.
+      # * <tt>:foreign_key</tt> - specify the foreign key used for the association. By default this is guessed to be the name
+      #   of this class in lower-case and "_id" suffixed. So a +Person+ class that makes a has_and_belongs_to_many association
+      #   will use "person_id" as the default foreign_key.
+      # * <tt>:association_foreign_key</tt> - specify the association foreign key used for the association. By default this is
+      #   guessed to be the name of the associated class in lower-case and "_id" suffixed. So the associated class is +Project+
+      #   that makes a has_and_belongs_to_many association will use "project_id" as the default association foreign_key.
+      # * <tt>:order</tt> - specify the order in which the associated objects are returned as a "ORDER BY" sql fragment, such as "last_name, first_name DESC".
+      # * <tt>:finder_sql</tt> - overwrite the default generated SQL used to fetch the association with a manual one
+      # * <tt>:delete_sql</tt> - overwrite the default generated SQL used to remove links between the associated 
+      #   classes with a manual one
+      # * <tt>:insert_sql</tt> - overwrite the default generated SQL used to add links between the associated classes
+      #   with a manual one
+      #
+      # Option examples:
+      #   has_and_belongs_to_many :projects
+      #   has_and_belongs_to_many :nations, :class_name => "Country"
+      #   has_and_belongs_to_many :categories, :join_table => "prods_cats"
+      def has_and_belongs_to_many(association_id, options = {})
+        validate_options([ :class_name, :table_name, :foreign_key, :association_foreign_key,
+                           :join_table, :finder_sql, :delete_sql, :insert_sql, :order ], options.keys)
+        association_name, association_class_name, association_class_primary_key_name =
+              associate_identification(association_id, options[:class_name], options[:foreign_key])
+
+        join_table  = options[:join_table] || 
+          join_table_name(undecorated_table_name(self.to_s), undecorated_table_name(association_class_name))
+ 
+        
+        module_eval <<-"end_eval", __FILE__, __LINE__
+          def #{association_name}(force_reload = false)
+            if @#{association_name}.nil?
+                @#{association_name} = HasAndBelongsToManyCollection.new(self, "#{association_name}", "#{association_class_name}", 
+                  "#{association_class_primary_key_name}", '#{join_table}', #{options.inspect})
+            end
+            @#{association_name}.reload if force_reload
+            
+            return @#{association_name}
+          end
+        end_eval
+
+        before_destroy_sql = "DELETE FROM #{join_table} WHERE #{Inflector.foreign_key(self.class_name)} = '\\\#{self.id}'"
+        module_eval(%{before_destroy "self.connection.delete(%{#{before_destroy_sql}})"}) # "
+        
+        # deprecated api
+        deprecated_collection_count_method(association_name)
+        deprecated_add_association_relation(association_name)
+        deprecated_remove_association_relation(association_name)
+        deprecated_has_collection_method(association_name)
+      end
+
+      private
+        # Raises an exception if an invalid option has been specified to prevent misspellings from slipping through 
+        def validate_options(valid_option_keys, supplied_option_keys)
+          unknown_option_keys = supplied_option_keys - valid_option_keys
+          raise(ActiveRecord::ActiveRecordError, "Unknown options: #{unknown_option_keys}") unless unknown_option_keys.empty?
+        end
+        
+        def join_table_name(first_table_name, second_table_name)
+          if first_table_name < second_table_name
+            join_table = "#{first_table_name}_#{second_table_name}"
+          else
+            join_table = "#{second_table_name}_#{first_table_name}"
+          end
+
+          table_name_prefix + join_table + table_name_suffix
+        end
+        
+        def associate_identification(association_id, association_class_name, foreign_key, plural = true)
+          if association_class_name !~ /::/
+            association_class_name = type_name_with_module(
+              association_class_name || 
+                Inflector.camelize(plural ? Inflector.singularize(association_id.id2name) : association_id.id2name)
+            )
+          end
+
+          primary_key_name = foreign_key || Inflector.underscore(Inflector.demodulize(name)) + "_id"
+        
+          return association_id.id2name, association_class_name, primary_key_name
+        end
+        
+        def association_comparison_method(association_name, association_class_name)
+          module_eval <<-"end_eval", __FILE__, __LINE__
+            def #{association_name}?(comparison_object, force_reload = false)
+              if comparison_object.kind_of?(#{association_class_name})
+                #{association_name}(force_reload) == comparison_object
+              else
+                raise "Comparison object is a #{association_class_name}, should have been \#{comparison_object.class.name}"
+              end
+            end
+          end_eval
+        end
+
+        def association_reader_method(association_name, association_finder)
+          module_eval <<-"end_eval", __FILE__, __LINE__
+            def #{association_name}(force_reload = false)
+              if @#{association_name}.nil? || force_reload
+                begin
+                  @#{association_name} = #{association_finder}
+                rescue ActiveRecord::StatementInvalid, ActiveRecord::RecordNotFound
+                  nil
+                end
+              end
+              
+              return @#{association_name}
+            end
+          end_eval
+        end
+
+        def has_one_writer_method(association_name, association_class_name, class_primary_key_name)
+          module_eval <<-"end_eval", __FILE__, __LINE__
+            def #{association_name}=(association)
+              if association.nil?
+                @#{association_name}.#{class_primary_key_name} = nil
+                @#{association_name}.save(false)
+                @#{association_name} = nil
+              else
+                raise ActiveRecord::AssociationTypeMismatch unless #{association_class_name} === association
+                association.#{class_primary_key_name} = id
+                association.save(false)
+                @#{association_name} = association
+              end
+            end
+          end_eval
+        end
+
+        def belongs_to_writer_method(association_name, association_class_name, association_class_primary_key_name)
+          module_eval <<-"end_eval", __FILE__, __LINE__
+            def #{association_name}=(association)
+              if association.nil?
+                @#{association_name} = self.#{association_class_primary_key_name} = nil
+              else
+                raise ActiveRecord::AssociationTypeMismatch unless #{association_class_name} === association
+                @#{association_name} = association
+                self.#{association_class_primary_key_name} = association.id
+              end
+            end
+          end_eval
+        end
+
+        def has_association_method(association_name)
+          module_eval <<-"end_eval", __FILE__, __LINE__
+            def has_#{association_name}?(force_reload = false)
+              !#{association_name}(force_reload).nil?
+            end
+          end_eval
+        end
+        
+        def build_method(method_prefix, collection_name, collection_class_name, class_primary_key_name)
+          module_eval <<-"end_eval", __FILE__, __LINE__
+            def #{method_prefix + collection_name}(attributes = {})
+              association = #{collection_class_name}.new
+              association.attributes = attributes.merge({ "#{class_primary_key_name}" => id})
+              association
+            end
+          end_eval
+        end
+
+        def create_method(method_prefix, collection_name, collection_class_name, class_primary_key_name)
+          module_eval <<-"end_eval", __FILE__, __LINE__
+            def #{method_prefix + collection_name}(attributes = nil)
+              #{collection_class_name}.create((attributes || {}).merge({ "#{class_primary_key_name}" => id}))
+            end
+          end_eval
+        end
+    end
+  end
+end