activerecord 1.1.0 → 1.2.0

data/CHANGELOG

@@ -1,3 +1,253 @@
+*1.2.0*
+
+* Added Base.validates_inclusion_of that validates whether the value of the specified attribute is available in a particular enumerable
+  object. [what-a-day]
+
+    class Person < ActiveRecord::Base
+      validates_inclusion_of :gender, :in=>%w( m f ), :message=>"woah! what are you then!??!!"
+      validates_inclusion_of :age, :in=>0..99
+    end
+
+* Added acts_as_list that can decorates an existing class with methods like move_higher/lower, move_to_top/bottom. [Tobias Luetke] Example:
+
+    class TodoItem < ActiveRecord::Base
+      acts_as_list :scope => :todo_list_id
+      belongs_to :todo_list
+    end
+
+* Added acts_as_tree that can decorates an existing class with a many to many relationship with itself. Perfect for categories in 
+  categories and the likes. [Tobias Luetke]
+
+* Added that Active Records will automatically record creation and/or update timestamps of database objects if fields of the names 
+  created_at/created_on or updated_at/updated_on are present. [Tobias Luetke]
+
+* Added Base.default_error_messages as a hash of all the error messages used in the validates_*_of so they can be changed in one place [Tobias Luetke]
+
+* Added automatic transaction block around AssociationCollection.<<, AssociationCollection.delete, and AssociationCollection.destroy_all
+
+* Fixed that Base#find will return an array if given an array -- regardless of the number of elements #270 [Marten]
+
+* Fixed that has_and_belongs_to_many would generate bad sql when naming conventions differed from using vanilla "id" everywhere [RedTerror]
+
+* Added a better exception for when a type column is used in a table without the intention of triggering single-table inheritance. Example:
+
+    ActiveRecord::SubclassNotFound: The single-table inheritance mechanism failed to locate the subclass: 'bad_class!'.
+    This error is raised because the column 'type' is reserved for storing the class in case of inheritance. 
+    Please rename this column if you didn't intend it to be used for storing the inheritance class or 
+    overwrite Company.inheritance_column to use another column for that information.
+
+* Added that single-table inheritance will only kick in if the inheritance_column (by default "type") is present. Otherwise, inheritance won't
+  have any magic side effects.
+
+* Added the possibility of marking fields as being in error without adding a message (using nil) to it that'll get displayed wth full_messages #208 [mjobin] 
+
+* Fixed Base.errors to be indifferent as to whether strings or symbols are used. Examples:
+
+    Before:
+      errors.add(:name, "must be shorter") if name.size > 10
+      errors.on(:name)  # => "must be shorter"
+      errors.on("name") # => nil
+
+    After:
+      errors.add(:name, "must be shorter") if name.size > 10
+      errors.on(:name)  # => "must be shorter"
+      errors.on("name") # => "must be shorter"
+
+* Added Base.validates_format_of that Validates whether the value of the specified attribute is of the correct form by matching 
+  it against the regular expression provided. [Marcel]
+
+    class Person < ActiveRecord::Base
+      validates_format_of :email, :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/, :on => :create
+    end
+
+* Added Base.validates_length_of that delegates to add_on_boundary_breaking #312 [Tobias Luetke]. Example:
+
+    Validates that the specified attribute matches the length restrictions supplied in either:
+    
+      - configuration[:minimum]
+      - configuration[:maximum]
+      - configuration[:is]
+      - configuration[:within] (aka. configuration[:in])
+    
+    Only one option can be used at a time.
+    
+      class Person < ActiveRecord::Base
+        validates_length_of :first_name, :maximum=>30
+        validates_length_of :last_name, :maximum=>30, :message=>"less than %d if you don't mind"
+        validates_length_of :user_name, :within => 6..20, :too_long => "pick a shorter name", :too_short => "pick a longer name"
+        validates_length_of :fav_bra_size, :minimum=>1, :too_short=>"please enter at least %d character"
+        validates_length_of :smurf_leader, :is=>4, :message=>"papa is spelled with %d characters... don't play me."
+      end
+    
+* Added Base.validate_presence as an alternative to implementing validate and doing errors.add_on_empty yourself.
+
+* Added Base.validates_uniqueness_of that alidates whether the value of the specified attributes are unique across the system. 
+  Useful for making sure that only one user can be named "davidhh".
+  
+    class Person < ActiveRecord::Base
+      validates_uniqueness_of :user_name
+    end
+  
+  When the record is created, a check is performed to make sure that no record exist in the database with the given value for the specified
+  attribute (that maps to a column). When the record is updated, the same check is made but disregarding the record itself.
+
+
+* Added Base.validates_confirmation_of that encapsulates the pattern of wanting to validate a password or email address field with a confirmation. Example:
+ 
+     Model:
+       class Person < ActiveRecord::Base
+         validates_confirmation_of :password
+       end
+  
+     View:
+       <%= password_field "person", "password" %>
+       <%= password_field "person", "password_confirmation" %>
+  
+   The person has to already have a password attribute (a column in the people table), but the password_confirmation is virtual.
+   It exists only as an in-memory variable for validating the password. This check is performed both on create and update.
+
+
+* Added Base.validates_acceptance_of that encapsulates the pattern of wanting to validate the acceptance of a terms of service check box (or similar agreement). Example:
+  
+   class Person < ActiveRecord::Base
+     validates_acceptance_of :terms_of_service
+   end
+  
+  The terms_of_service attribute is entirely virtual. No database column is needed. This check is performed both on create and update.
+
+  NOTE: The agreement is considered valid if it's set to the string "1". This makes it easy to relate it to an HTML checkbox.
+
+  
+* Added validation macros to make the stackable just like the lifecycle callbacks. Examples:
+
+    class Person < ActiveRecord::Base
+      validate { |record| record.errors.add("name", "too short") unless name.size > 10 }
+      validate { |record| record.errors.add("name", "too long")  unless name.size < 20 }
+      validate_on_create :validate_password
+      
+      private
+        def validate_password
+          errors.add("password", "too short") unless password.size > 6
+        end
+    end
+
+* Added the option for sanitizing find_by_sql and the offset parts in regular finds [Sam Stephenson]. Examples:
+
+    Project.find_all ["category = ?", category_name], "created ASC", ["? OFFSET ?", 15, 20]
+    Post.find_by_sql ["SELECT * FROM posts WHERE author = ? AND created > ?", author_id, start_date]
+
+* Fixed value quoting in all generated SQL statements, so that integers are not surrounded in quotes and that all sanitation are happening
+  through the database's own quoting routine. This should hopefully make it lots easier for new adapters that doesn't accept '1' for integer
+  columns.
+
+* Fixed has_and_belongs_to_many guessing of foreign key so that keys are generated correctly for models like SomeVerySpecialClient 
+  [Florian Weber]
+
+* Added counter_sql option for has_many associations [bitsweat]. Documentation:
+
+    <tt>:counter_sql</tt> - specify a complete SQL statement to fetch the size of the association. If +:finder_sql+ is
+    specified but +:counter_sql+, +:counter_sql+ will be generated by replacing SELECT ... FROM with SELECT COUNT(*) FROM.
+
+* Fixed that methods wrapped in callbacks still return their original result #260 [bitsweat]
+
+* Fixed the Inflector to handle the movie/movies pair correctly #261 [Scott Baron]
+
+* Added named bind-style variable interpolation #281 [Michael Koziarski]. Example:
+
+    Person.find(["id = :id and first_name = :first_name", { :id => 5, :first_name = "bob' or 1=1" }])
+
+* Added bind-style variable interpolation for the condition arrays that uses the adapter's quote method [Michael Koziarski]
+
+  Before:
+    find_first([ "user_name = '%s' AND password = '%s'", user_name, password ])]
+    find_first([ "firm_id = %s", firm_id ])] # unsafe!
+
+  After:
+    find_first([ "user_name = ? AND password = ?", user_name, password ])]
+    find_first([ "firm_id = ?", firm_id ])]
+
+* Added CSV format for fixtures #272 [what-a-day]. (See the new and expanded documentation on fixtures for more information)
+
+* Fixed fixtures using primary key fields called something else than "id" [dave]
+
+* Added proper handling of time fields that are turned into Time objects with the dummy date of 2000/1/1 [HariSeldon]
+
+* Added reverse order of deleting fixtures, so referential keys can be maintained #247 [Tim Bates]
+
+* Added relative path search for sqlite dbfiles in database.yml (if RAILS_ROOT is defined) #233 [bitsweat]
+
+* Added option to establish_connection where you'll be able to leave out the parameter to have it use the RAILS_ENV environment variable
+
+* Fixed problems with primary keys and postgresql sequences (#230) [Tim Bates]
+
+* Added reloading for associations under cached environments like FastCGI and mod_ruby. This makes it possible to use those environments for development.
+  This is turned on by default, but can be turned off with ActiveRecord::Base.reload_dependencies = false in production environments.
+
+  NOTE: This will only have an effect if you let the associations manage the requiring of model classes. All libraries loaded through
+  require will be "forever" cached. You can, however, use ActiveRecord::Base.load_or_require("library") to get this behavior outside of the
+  auto-loading associations.
+
+* Added ERB capabilities to the fixture files for dynamic fixture generation. You don't need to do anything, just include ERB blocks like:
+
+    david:
+      id: 1
+      name: David
+
+    jamis:
+      id: 2
+      name: Jamis
+
+    <% for digit in 3..10 %>
+    dev_<%= digit %>:
+      id: <%= digit %>
+      name: fixture_<%= digit %>
+    <% end %>
+
+* Changed the yaml fixture searcher to look in the root of the fixtures directory, so when you before could have something like:
+
+    fixtures/developers/fixtures.yaml
+    fixtures/accounts/fixtures.yaml
+  
+  ...you now need to do:
+  
+    fixtures/developers.yaml
+    fixtures/accounts.yaml
+
+* Changed the fixture format from:
+
+    name: david
+    data:
+     id: 1
+     name: David Heinemeier Hansson
+     birthday: 1979-10-15
+     profession: Systems development
+    ---
+    name: steve
+    data:
+     id: 2
+     name: Steve Ross Kellock
+     birthday: 1974-09-27
+     profession: guy with keyboard
+
+  ...to:
+
+    david:
+     id: 1
+     name: David Heinemeier Hansson
+     birthday: 1979-10-15
+     profession: Systems development
+    
+    steve:
+     id: 2
+     name: Steve Ross Kellock
+     birthday: 1974-09-27
+     profession: guy with keyboard
+    
+  The change is NOT backwards compatible. Fixtures written in the old YAML style needs to be rewritten!
+
+* All associations will now attempt to require the classes that they associate to. Relieving the need for most explicit 'require' statements.
+
+
 *1.1.0* (34)
 
 * Added automatic fixture setup and instance variable availability. Fixtures can also be automatically 

data/README

@@ -57,18 +57,26 @@ A short rundown of the major features:
 
 * Validation rules that can differ for new or existing objects.
 
-   class Post < ActiveRecord::Base
-     def validate # validates on both creates and updates
-       errors.add_on_empty "title"
-     end
-
-     def validate_on_update
-       errors.add_on_empty "password"
-     end
-   end
+    class Account < ActiveRecord::Base
+      validates_presence_of     :subdomain, :name, :email_address, :password
+      validates_uniqueness_of   :subdomain
+      validates_acceptance_of   :terms_of_service, :on => :create
+      validates_confirmation_of :password, :email_address, :on => :create
+    end
 
   Learn more in link:classes/ActiveRecord/Validations.html
 
+
+* Acts that can make records work as lists or trees:
+
+    class Item < ActiveRecord::Base
+      belongs_to   :list
+      acts_as_list :scope => :list
+    end
+    
+    item.move_higher
+    item.move_to_bottom
+
  
 * Callbacks as methods or queues on the entire lifecycle (instantiation, saving, destroying, validating, etc).
 

data/dev-utils/eval_debugger.rb

@@ -1,5 +1,5 @@
 # Require this file to see the methods Active Record generates as they are added.
-class Module
+class Module #:nodoc:
   alias :old_module_eval :module_eval
   def module_eval(*args, &block)
     if args[0]

data/install.rb

@@ -18,7 +18,7 @@ unless $sitedir
   end
 end
 
-makedirs = %w{ active_record/associations active_record/connection_adapters active_record/support active_record/vendor }
+makedirs = %w{ active_record/associations active_record/connection_adapters active_record/support active_record/vendor active_record/acts }
 makedirs.each {|f| File::makedirs(File.join($sitedir, *f.split(/\//)))}
 
 # deprecated files that should be removed
@@ -42,6 +42,8 @@ files = %w-
  active_record/fixtures.rb
  active_record/observer.rb
  active_record/reflection.rb
+ active_record/mixins/list.rb
+ active_record/mixins/touch.rb
  active_record/support/class_attribute_accessors.rb
  active_record/support/class_inheritable_attributes.rb
  active_record/support/clean_logger.rb

data/lib/active_record.rb

@@ -25,7 +25,7 @@
 $:.unshift(File.dirname(__FILE__))
 
 require 'active_record/support/clean_logger'
-# require 'active_record/support/array_ext'
+require 'active_record/support/misc'
 
 require 'active_record/base'
 require 'active_record/observer'
@@ -35,6 +35,9 @@ require 'active_record/associations'
 require 'active_record/aggregations'
 require 'active_record/transactions'
 require 'active_record/reflection'
+require 'active_record/timestamp'
+require 'active_record/acts/list'
+require 'active_record/acts/tree'
 
 ActiveRecord::Base.class_eval do
   include ActiveRecord::Validations
@@ -43,8 +46,12 @@ ActiveRecord::Base.class_eval do
   include ActiveRecord::Aggregations
   include ActiveRecord::Transactions
   include ActiveRecord::Reflection
+  include ActiveRecord::Timestamp
+  include ActiveRecord::Acts::Tree
+  include ActiveRecord::Acts::List
 end
 
 require 'active_record/connection_adapters/mysql_adapter'
 require 'active_record/connection_adapters/postgresql_adapter'
-require 'active_record/connection_adapters/sqlite_adapter'
+require 'active_record/connection_adapters/sqlite_adapter'
+require 'active_record/connection_adapters/sqlserver_adapter'

data/lib/active_record/acts/list.rb

@@ -0,0 +1,178 @@
+module ActiveRecord
+  module Acts #:nodoc:
+    module List #:nodoc:
+      def self.append_features(base)
+        super
+        base.extend(ClassMethods)
+      end
+      
+      # This act provides the capabilities for sorting and reordering a number of objects in list.
+      # The class that has this specified needs to have a "position" column defined as an integer on
+      # the mapped database table.
+      #
+      # Todo list example:
+      #
+      #   class TodoList < ActiveRecord::Base
+      #     has_many :todo_items, :order => "position"
+      #   end
+      #
+      #   class TodoItem < ActiveRecord::Base
+      #     belongs_to :todo_list
+      #     acts_as_list :scope => :todo_list
+      #   end
+      #
+      #   todo_list.first.move_to_bottom
+      #   todo_list.last.move_higher
+      module ClassMethods
+        # Configuration options are:
+        #
+        # * +column+ - specifies the column name to use for keeping the position integer (default: position)
+        # * +scope+ - restricts what is to be considered a list. Given a symbol, it'll attach "_id" (if that hasn't been already) and use that
+        #   as the foreign key restriction. It's also possible to give it an entire string that is interpolated if you need a tighter scope than
+        #   just a foreign key. Example: <tt>acts_as_list :scope => 'todo_list_id = #{todo_list_id} AND completed = 0'</tt>
+        def acts_as_list(options = {})
+          configuration = { :column => "position", :scope => "1" }
+          configuration.update(options) if options.is_a?(Hash)
+
+          configuration[:scope] = "#{configuration[:scope]}_id".intern if configuration[:scope].is_a?(Symbol) && configuration[:scope].to_s !~ /_id$/
+          
+          class_eval <<-EOV
+            include ActiveRecord::Acts::List::InstanceMethods
+
+            def position_column
+              '#{configuration[:column]}'
+            end
+
+            def scope_condition
+              "#{configuration[:scope].is_a?(Symbol) ? configuration[:scope].to_s + " = \#{" + configuration[:scope].to_s + "}" : configuration[:scope]}"
+            end
+            
+            before_destroy :remove_from_list
+            before_create   :add_to_list_bottom
+          EOV
+        end
+      end
+        
+      # All the methods available to a record that has had <tt>acts_as_list</tt> specified.
+      module InstanceMethods
+        def move_lower
+          return unless lower_item
+
+          self.class.transaction do
+            lower_item.decrement_position
+            increment_position
+          end
+        end
+
+        def move_higher
+          return unless higher_item
+
+          self.class.transaction do
+            higher_item.increment_position
+            decrement_position
+          end
+        end
+  
+        def move_to_bottom
+          self.class.transaction do
+            decrement_positions_on_lower_items
+            assume_bottom_position
+          end
+        end
+
+        def move_to_top
+          self.class.transaction do
+            increment_positions_on_higher_items
+            assume_top_position
+          end
+        end
+  
+
+        def remove_from_list
+          decrement_positions_on_lower_items
+        end
+
+
+        def increment_position
+          update_attribute position_column, self.send(position_column).to_i + 1
+        end
+  
+        def decrement_position
+          update_attribute position_column, self.send(position_column).to_i - 1
+        end
+  
+  
+        def first?
+          self.send(position_column) == 1
+        end
+  
+        def last?
+          self.send(position_column) == bottom_position_in_list
+        end
+
+        private
+        
+        def add_to_list_top
+          increment_positions_on_all_items
+        end
+
+        def add_to_list_bottom
+          write_attribute(position_column, bottom_position_in_list.to_i + 1)
+        end
+      
+        # Overwrite this method to define the scope of the list changes
+        def scope_condition() "1" end
+
+        def higher_item
+          self.class.find_first(
+            "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i - 1).to_s}"
+          )
+        end
+
+        def lower_item
+          self.class.find_first(
+            "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i + 1).to_s}"
+          )
+        end
+
+        def bottom_position_in_list
+          item = bottom_item
+          item ? item.send(position_column) : 0
+        end
+
+        def bottom_item
+          self.class.find_first(
+            "#{scope_condition} ",
+            "#{position_column} DESC"
+          )
+        end
+
+        def assume_bottom_position
+          update_attribute position_column, bottom_position_in_list.to_i + 1
+        end
+  
+        def assume_top_position
+          update_attribute position_column, 1
+        end
+  
+        def decrement_positions_on_lower_items
+          self.class.update_all(
+            "#{position_column} = (#{position_column} - 1)",  "#{scope_condition} AND #{position_column} > #{send(position_column).to_i}"
+          )
+        end
+  
+        def increment_positions_on_higher_items
+          self.class.update_all(
+            "#{position_column} = (#{position_column} + 1)",  "#{scope_condition} AND #{position_column} < #{send(position_column)}"
+          )
+        end
+
+        def increment_positions_on_all_items
+          self.class.update_all(
+            "#{position_column} = (#{position_column} + 1)",  "#{scope_condition}"
+          )
+        end
+      end     
+    end
+  end
+end