activerecord 3.2.22.4 → 4.0.13

data/lib/active_record/serializers/xml_serializer.rb

@@ -1,4 +1,3 @@
-require 'active_support/core_ext/array/wrap'
 require 'active_support/core_ext/hash/conversions'
 
 module ActiveRecord #:nodoc:
@@ -19,8 +18,8 @@ module ActiveRecord #:nodoc:
     #     <id type="integer">1</id>
     #     <approved type="boolean">false</approved>
     #     <replies-count type="integer">0</replies-count>
-    #     <bonus-time type="datetime">2000-01-01T08:28:00+12:00</bonus-time>
-    #     <written-on type="datetime">2003-07-16T09:28:00+1200</written-on>
+    #     <bonus-time type="dateTime">2000-01-01T08:28:00+12:00</bonus-time>
+    #     <written-on type="dateTime">2003-07-16T09:28:00+1200</written-on>
     #     <content>Have a nice day</content>
     #     <author-email-address>david@loudthinking.com</author-email-address>
     #     <parent-id></parent-id>
@@ -37,7 +36,7 @@ module ActiveRecord #:nodoc:
     #
     # For instance:
     #
-    #   topic.to_xml(:skip_instruct => true, :except => [ :id, :bonus_time, :written_on, :replies_count ])
+    #   topic.to_xml(skip_instruct: true, except: [ :id, :bonus_time, :written_on, :replies_count ])
     #
     #   <topic>
     #     <title>The First Topic</title>
@@ -51,7 +50,7 @@ module ActiveRecord #:nodoc:
     #
     # To include first level associations use <tt>:include</tt>:
     #
-    #   firm.to_xml :include => [ :account, :clients ]
+    #   firm.to_xml include: [ :account, :clients ]
     #
     #   <?xml version="1.0" encoding="UTF-8"?>
     #   <firm>
@@ -82,7 +81,7 @@ module ActiveRecord #:nodoc:
     # associated with models.
     #
     #   proc = Proc.new { |options, record| options[:builder].tag!('name-reverse', record.name.reverse) }
-    #   firm.to_xml :procs => [ proc ]
+    #   firm.to_xml procs: [ proc ]
     #
     #   <firm>
     #     # ... normal attributes as shown above ...
@@ -91,7 +90,7 @@ module ActiveRecord #:nodoc:
     #
     # To include deeper levels of associations pass a hash like this:
     #
-    #   firm.to_xml :include => {:account => {}, :clients => {:include => :address}}
+    #   firm.to_xml include: {account: {}, clients: {include: :address}}
     #   <?xml version="1.0" encoding="UTF-8"?>
     #   <firm>
     #     <id type="integer">1</id>
@@ -121,7 +120,7 @@ module ActiveRecord #:nodoc:
     #
     # To include any methods on the model being called use <tt>:methods</tt>:
     #
-    #   firm.to_xml :methods => [ :calculated_earnings, :real_earnings ]
+    #   firm.to_xml methods: [ :calculated_earnings, :real_earnings ]
     #
     #   <firm>
     #     # ... normal attributes as shown above ...
@@ -133,7 +132,7 @@ module ActiveRecord #:nodoc:
     # modified version of the options hash that was given to +to_xml+:
     #
     #   proc = Proc.new { |options| options[:builder].tag!('abc', 'def') }
-    #   firm.to_xml :procs => [ proc ]
+    #   firm.to_xml procs: [ proc ]
     #
     #   <firm>
     #     # ... normal attributes as shown above ...
@@ -165,7 +164,7 @@ module ActiveRecord #:nodoc:
     #     def to_xml(options = {})
     #       require 'builder'
     #       options[:indent] ||= 2
-    #       xml = options[:builder] ||= ::Builder::XmlMarkup.new(:indent => options[:indent])
+    #       xml = options[:builder] ||= ::Builder::XmlMarkup.new(indent: options[:indent])
     #       xml.instruct! unless options[:skip_instruct]
     #       xml.level_one do
     #         xml.tag!(:second_level, 'content')
@@ -178,11 +177,6 @@ module ActiveRecord #:nodoc:
   end
 
   class XmlSerializer < ActiveModel::Serializers::Xml::Serializer #:nodoc:
-    def initialize(*args)
-      super
-      options[:except] = Array.wrap(options[:except]) | Array.wrap(@serializable.class.inheritance_column)
-    end
-
     class Attribute < ActiveModel::Serializers::Xml::Serializer::Attribute #:nodoc:
       def compute_type
         klass = @serializable.class

data/lib/active_record/statement_cache.rb

@@ -0,0 +1,26 @@
+module ActiveRecord
+
+  # Statement cache is used to cache a single statement in order to avoid creating the AST again.
+  # Initializing the cache is done by passing the statement in the initialization block:
+  #
+  #   cache = ActiveRecord::StatementCache.new do
+  #     Book.where(name: "my book").limit(100)
+  #   end
+  #
+  # The cached statement is executed by using the +execute+ method:
+  #
+  #   cache.execute
+  #
+  # The relation returned by the block is cached, and for each +execute+ call the cached relation gets duped.
+  # Database is queried when +to_a+ is called on the relation.
+  class StatementCache
+    def initialize
+      @relation = yield
+      raise ArgumentError.new("Statement cannot be nil") if @relation.nil?
+    end
+
+    def execute
+      @relation.dup.to_a
+    end
+  end
+end

data/lib/active_record/store.rb

@@ -1,6 +1,8 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
 module ActiveRecord
   # Store gives you a thin wrapper around serialize for the purpose of storing hashes in a single column.
-  # It's like a simple key/value store backed into your record when you don't care about being able to
+  # It's like a simple key/value store baked into your record when you don't care about being able to
   # query that store outside the context of a single record.
   #
   # You can then declare accessors to this store that are then accessible just like any other attribute
@@ -10,43 +12,157 @@ module ActiveRecord
   # Make sure that you declare the database column used for the serialized store as a text, so there's
   # plenty of room.
   #
+  # You can set custom coder to encode/decode your serialized attributes to/from different formats.
+  # JSON, YAML, Marshal are supported out of the box. Generally it can be any wrapper that provides +load+ and +dump+.
+  #
   # Examples:
   #
   #   class User < ActiveRecord::Base
-  #     store :settings, accessors: [ :color, :homepage ]
+  #     store :settings, accessors: [ :color, :homepage ], coder: JSON
   #   end
-  #   
+  #
   #   u = User.new(color: 'black', homepage: '37signals.com')
   #   u.color                          # Accessor stored attribute
   #   u.settings[:country] = 'Denmark' # Any attribute, even if not specified with an accessor
   #
+  #   # There is no difference between strings and symbols for accessing custom attributes
+  #   u.settings[:country]  # => 'Denmark'
+  #   u.settings['country'] # => 'Denmark'
+  #
   #   # Add additional accessors to an existing store through store_accessor
   #   class SuperUser < User
   #     store_accessor :settings, :privileges, :servants
   #   end
+  #
+  # The stored attribute names can be retrieved using +stored_attributes+.
+  #
+  #   User.stored_attributes[:settings] # [:color, :homepage]
+  #
+  # == Overwriting default accessors
+  #
+  # All stored values are automatically available through accessors on the Active Record
+  # object, but sometimes you want to specialize this behavior. This can be done by overwriting
+  # the default accessors (using the same name as the attribute) and calling <tt>super</tt>
+  # to actually change things.
+  #
+  #   class Song < ActiveRecord::Base
+  #     # Uses a stored integer to hold the volume adjustment of the song
+  #     store :settings, accessors: [:volume_adjustment]
+  #
+  #     def volume_adjustment=(decibels)
+  #       super(decibels.to_i)
+  #     end
+  #
+  #     def volume_adjustment
+  #       super.to_i
+  #     end
+  #   end
   module Store
     extend ActiveSupport::Concern
-  
+
+    included do
+      class << self
+        attr_accessor :local_stored_attributes
+      end
+    end
+
     module ClassMethods
       def store(store_attribute, options = {})
-        serialize store_attribute, Hash
+        serialize store_attribute, IndifferentCoder.new(options[:coder])
         store_accessor(store_attribute, options[:accessors]) if options.has_key? :accessors
       end
 
       def store_accessor(store_attribute, *keys)
-        Array(keys).flatten.each do |key|
-          define_method("#{key}=") do |value|
-            send("#{store_attribute}=", {}) unless send(store_attribute).is_a?(Hash)
-            send("#{store_attribute}_will_change!")
-            send(store_attribute)[key] = value
+        keys = keys.flatten
+
+        _store_accessors_module.module_eval do
+          keys.each do |key|
+            define_method("#{key}=") do |value|
+              write_store_attribute(store_attribute, key, value)
+            end
+
+            define_method(key) do
+              read_store_attribute(store_attribute, key)
+            end
           end
-    
-          define_method(key) do
-            send("#{store_attribute}=", {}) unless send(store_attribute).is_a?(Hash)
-            send(store_attribute)[key]
+        end
+
+        # assign new store attribute and create new hash to ensure that each class in the hierarchy
+        # has its own hash of stored attributes.
+        self.local_stored_attributes ||= {}
+        self.local_stored_attributes[store_attribute] ||= []
+        self.local_stored_attributes[store_attribute] |= keys
+      end
+
+      def _store_accessors_module
+        @_store_accessors_module ||= begin
+          mod = Module.new
+          include mod
+          mod
+        end
+      end
+
+      def stored_attributes
+        parent = superclass.respond_to?(:stored_attributes) ? superclass.stored_attributes : {}
+        if self.local_stored_attributes
+          parent.merge!(self.local_stored_attributes) { |k, a, b| a | b }
+        end
+        parent
+      end
+    end
+
+    protected
+      def read_store_attribute(store_attribute, key)
+        attribute = initialize_store_attribute(store_attribute)
+        attribute[key]
+      end
+
+      def write_store_attribute(store_attribute, key, value)
+        attribute = initialize_store_attribute(store_attribute)
+        if value != attribute[key]
+          send :"#{store_attribute}_will_change!"
+          attribute[key] = value
+        end
+      end
+
+    private
+      def initialize_store_attribute(store_attribute)
+        attribute = send(store_attribute)
+        unless attribute.is_a?(ActiveSupport::HashWithIndifferentAccess)
+          attribute = IndifferentCoder.as_indifferent_hash(attribute)
+          send :"#{store_attribute}=", attribute
+        end
+        attribute
+      end
+
+    class IndifferentCoder # :nodoc:
+      def initialize(coder_or_class_name)
+        @coder =
+          if coder_or_class_name.respond_to?(:load) && coder_or_class_name.respond_to?(:dump)
+            coder_or_class_name
+          else
+            ActiveRecord::Coders::YAMLColumn.new(coder_or_class_name || Object)
           end
+      end
+
+      def dump(obj)
+        @coder.dump self.class.as_indifferent_hash(obj)
+      end
+
+      def load(yaml)
+        self.class.as_indifferent_hash @coder.load(yaml || '')
+      end
+
+      def self.as_indifferent_hash(obj)
+        case obj
+        when ActiveSupport::HashWithIndifferentAccess
+          obj
+        when Hash
+          obj.with_indifferent_access
+        else
+          ActiveSupport::HashWithIndifferentAccess.new
         end
       end
     end
   end
-end
+end

data/lib/active_record/tasks/database_tasks.rb

@@ -0,0 +1,204 @@
+module ActiveRecord
+  module Tasks # :nodoc:
+    class DatabaseAlreadyExists < StandardError; end # :nodoc:
+    class DatabaseNotSupported < StandardError; end # :nodoc:
+
+    # <tt>ActiveRecord::Tasks::DatabaseTasks</tt> is a utility class, which encapsulates
+    # logic behind common tasks used to manage database and migrations.
+    #
+    # The tasks defined here are used in rake tasks provided by Active Record.
+    #
+    # In order to use DatabaseTasks, a few config values need to be set. All the needed
+    # config values are set by Rails already, so it's necessary to do it only if you
+    # want to change the defaults or when you want to use Active Record outside of Rails
+    # (in such case after configuring the database tasks, you can also use the rake tasks
+    # defined in Active Record).
+    #
+    #
+    # The possible config values are:
+    #
+    #   * +env+: current environment (like Rails.env).
+    #   * +database_configuration+: configuration of your databases (as in +config/database.yml+).
+    #   * +db_dir+: your +db+ directory.
+    #   * +fixtures_path+: a path to fixtures directory.
+    #   * +migrations_paths+: a list of paths to directories with migrations.
+    #   * +seed_loader+: an object which will load seeds, it needs to respond to the +load_seed+ method.
+    #   * +root+: a path to the root of the application.
+    #
+    # Example usage of +DatabaseTasks+ outside Rails could look as such:
+    #
+    #   include ActiveRecord::Tasks
+    #   DatabaseTasks.database_configuration = YAML.load(File.read('my_database_config.yml'))
+    #   DatabaseTasks.db_dir = 'db'
+    #   # other settings...
+    #
+    #   DatabaseTasks.create_current('production')
+    module DatabaseTasks
+      extend self
+
+      attr_writer :current_config
+      attr_accessor :database_configuration, :migrations_paths, :seed_loader, :db_dir,
+                    :fixtures_path, :env, :root
+
+      LOCAL_HOSTS    = ['127.0.0.1', 'localhost']
+
+      def register_task(pattern, task)
+        @tasks ||= {}
+        @tasks[pattern] = task
+      end
+
+      register_task(/mysql/,        ActiveRecord::Tasks::MySQLDatabaseTasks)
+      register_task(/postgresql/,   ActiveRecord::Tasks::PostgreSQLDatabaseTasks)
+      register_task(/sqlite/,       ActiveRecord::Tasks::SQLiteDatabaseTasks)
+
+      register_task(/firebird/,     ActiveRecord::Tasks::FirebirdDatabaseTasks)
+      register_task(/sqlserver/,    ActiveRecord::Tasks::SqlserverDatabaseTasks)
+      register_task(/(oci|oracle)/, ActiveRecord::Tasks::OracleDatabaseTasks)
+
+      def current_config(options = {})
+        options.reverse_merge! :env => env
+        if options.has_key?(:config)
+          @current_config = options[:config]
+        else
+          @current_config ||= if ENV['DATABASE_URL']
+                                database_url_config
+                              else
+                                ActiveRecord::Base.configurations[options[:env]]
+                              end
+        end
+      end
+
+      def create(*arguments)
+        configuration = arguments.first
+        class_for_adapter(configuration['adapter']).new(*arguments).create
+      rescue DatabaseAlreadyExists
+        $stderr.puts "#{configuration['database']} already exists"
+      rescue Exception => error
+        $stderr.puts error, *(error.backtrace)
+        $stderr.puts "Couldn't create database for #{configuration.inspect}"
+      end
+
+      def create_all
+        each_local_configuration { |configuration| create configuration }
+      end
+
+      def create_current(environment = env)
+        each_current_configuration(environment) { |configuration|
+          create configuration
+        }
+        ActiveRecord::Base.establish_connection environment
+      end
+
+      def create_database_url
+        create database_url_config
+      end
+
+      def drop(*arguments)
+        configuration = arguments.first
+        class_for_adapter(configuration['adapter']).new(*arguments).drop
+      rescue Exception => error
+        $stderr.puts error, *(error.backtrace)
+        $stderr.puts "Couldn't drop #{configuration['database']}"
+      end
+
+      def drop_all
+        each_local_configuration { |configuration| drop configuration }
+      end
+
+      def drop_current(environment = env)
+        each_current_configuration(environment) { |configuration|
+          drop configuration
+        }
+      end
+
+      def drop_database_url
+        drop database_url_config
+      end
+
+      def charset_current(environment = env)
+        charset ActiveRecord::Base.configurations[environment]
+      end
+
+      def charset(*arguments)
+        configuration = arguments.first
+        class_for_adapter(configuration['adapter']).new(*arguments).charset
+      end
+
+      def collation_current(environment = env)
+        collation ActiveRecord::Base.configurations[environment]
+      end
+
+      def collation(*arguments)
+        configuration = arguments.first
+        class_for_adapter(configuration['adapter']).new(*arguments).collation
+      end
+
+      def purge(configuration)
+        class_for_adapter(configuration['adapter']).new(configuration).purge
+      end
+
+      def structure_dump(*arguments)
+        configuration = arguments.first
+        filename = arguments.delete_at 1
+        class_for_adapter(configuration['adapter']).new(*arguments).structure_dump(filename)
+      end
+
+      def structure_load(*arguments)
+        configuration = arguments.first
+        filename = arguments.delete_at 1
+        class_for_adapter(configuration['adapter']).new(*arguments).structure_load(filename)
+      end
+
+      def load_seed
+        if seed_loader
+          seed_loader.load_seed
+        else
+          raise "You tried to load seed data, but no seed loader is specified. Please specify seed " +
+                "loader with ActiveRecord::Tasks::DatabaseTasks.seed_loader = your_seed_loader\n" +
+                "Seed loader should respond to load_seed method"
+        end
+      end
+
+      private
+
+      def database_url_config
+        @database_url_config ||=
+               ConnectionAdapters::ConnectionSpecification::Resolver.new(ENV["DATABASE_URL"], {}).spec.config.stringify_keys
+      end
+
+      def class_for_adapter(adapter)
+        key = @tasks.keys.detect { |pattern| adapter[pattern] }
+        unless key
+          raise DatabaseNotSupported, "Rake tasks not supported by '#{adapter}' adapter"
+        end
+        @tasks[key]
+      end
+
+      def each_current_configuration(environment)
+        environments = [environment]
+        environments << 'test' if environment == 'development'
+
+        configurations = ActiveRecord::Base.configurations.values_at(*environments)
+        configurations.compact.each do |configuration|
+          yield configuration unless configuration['database'].blank?
+        end
+      end
+
+      def each_local_configuration
+        ActiveRecord::Base.configurations.each_value do |configuration|
+          next unless configuration['database']
+
+          if local_database?(configuration)
+            yield configuration
+          else
+            $stderr.puts "This task only modifies local databases. #{configuration['database']} is on a remote host."
+          end
+        end
+      end
+
+      def local_database?(configuration)
+        configuration['host'].blank? || LOCAL_HOSTS.include?(configuration['host'])
+      end
+    end
+  end
+end

data/lib/active_record/tasks/firebird_database_tasks.rb

@@ -0,0 +1,56 @@
+module ActiveRecord
+  module Tasks # :nodoc:
+    class FirebirdDatabaseTasks # :nodoc:
+      delegate :connection, :establish_connection, to: ActiveRecord::Base
+
+      def initialize(configuration)
+        ActiveSupport::Deprecation.warn "This database tasks were deprecated, because this tasks should be served by the 3rd party adapter."
+        @configuration = configuration
+      end
+
+      def create
+        $stderr.puts 'sorry, your database adapter is not supported yet, feel free to submit a patch'
+      end
+
+      def drop
+        $stderr.puts 'sorry, your database adapter is not supported yet, feel free to submit a patch'
+      end
+
+      def purge
+        establish_connection(:test)
+        connection.recreate_database!
+      end
+
+      def charset
+        $stderr.puts 'sorry, your database adapter is not supported yet, feel free to submit a patch'
+      end
+
+      def structure_dump(filename)
+        set_firebird_env(configuration)
+        db_string = firebird_db_string(configuration)
+        Kernel.system "isql -a #{db_string} > #{filename}"
+      end
+
+      def structure_load(filename)
+        set_firebird_env(configuration)
+        db_string = firebird_db_string(configuration)
+        Kernel.system "isql -i #{filename} #{db_string}"
+      end
+
+      private
+
+      def set_firebird_env(config)
+        ENV['ISC_USER']     = config['username'].to_s if config['username']
+        ENV['ISC_PASSWORD'] = config['password'].to_s if config['password']
+      end
+
+      def firebird_db_string(config)
+        FireRuby::Database.db_string_for(config.symbolize_keys)
+      end
+
+      def configuration
+        @configuration
+      end
+    end
+  end
+end