activerecord 4.0.13 → 4.1.0.beta1

data/lib/active_record/enum.rb

@@ -0,0 +1,100 @@
+module ActiveRecord
+  # Declare an enum attribute where the values map to integers in the database, but can be queried by name. Example:
+  #
+  #   class Conversation < ActiveRecord::Base
+  #     enum status: [ :active, :archived ]
+  #   end
+  #
+  #   # conversation.update! status: 0
+  #   conversation.active!
+  #   conversation.active? # => true
+  #   conversation.status  # => "active"
+  #
+  #   # conversation.update! status: 1
+  #   conversation.archived!
+  #   conversation.archived? # => true
+  #   conversation.status    # => "archived"
+  #
+  #   # conversation.update! status: 1
+  #   conversation.status = "archived"
+  #
+  # You can set the default value from the database declaration, like:
+  #
+  #   create_table :conversations do |t|
+  #     t.column :status, :integer, default: 0
+  #   end
+  #
+  # Good practice is to let the first declared status be the default.
+  #
+  # Finally, it's also possible to explicitly map the relation between attribute and
+  # database integer with a +Hash+:
+  #
+  #   class Conversation < ActiveRecord::Base
+  #     enum status: { active: 0, archived: 1 }
+  #   end
+  #
+  # Note that when an +Array+ is used, the implicit mapping from the values to database
+  # integers is derived from the order the values appear in the array. In the example,
+  # <tt>:active</tt> is mapped to +0+ as it's the first element, and <tt>:archived</tt>
+  # is mapped to +1+. In general, the +i+-th element is mapped to <tt>i-1</tt> in the
+  # database.
+  #
+  # Therefore, once a value is added to the enum array, its position in the array must
+  # be maintained, and new values should only be added to the end of the array. To
+  # remove unused values, the explicit +Hash+ syntax should be used.
+  #
+  # In rare circumstances you might need to access the mapping directly.
+  # The mappings are exposed through a constant with the attributes name:
+  #
+  #   Conversation::STATUS # => { "active" => 0, "archived" => 1 }
+  #
+  # Use that constant when you need to know the ordinal value of an enum:
+  #
+  #   Conversation.where("status <> ?", Conversation::STATUS[:archived])
+  module Enum
+    def enum(definitions)
+      klass = self
+      definitions.each do |name, values|
+        # DIRECTION = { }
+        enum_values = _enum_methods_module.const_set name.to_s.upcase, ActiveSupport::HashWithIndifferentAccess.new
+        name        = name.to_sym
+
+        _enum_methods_module.module_eval do
+          # def direction=(value) self[:direction] = DIRECTION[value] end
+          define_method("#{name}=") { |value|
+            unless enum_values.has_key?(value)
+              raise ArgumentError, "'#{value}' is not a valid #{name}"
+            end
+            self[name] = enum_values[value]
+          }
+
+          # def direction() DIRECTION.key self[:direction] end
+          define_method(name) { enum_values.key self[name] }
+
+          pairs = values.respond_to?(:each_pair) ? values.each_pair : values.each_with_index
+          pairs.each do |value, i|
+            enum_values[value] = i
+
+            # scope :incoming, -> { where direction: 0 }
+            klass.scope value, -> { klass.where name => i }
+
+            # def incoming?() direction == 0 end
+            define_method("#{value}?") { self[name] == i }
+
+            # def incoming! update! direction: :incoming end
+            define_method("#{value}!") { update! name => value }
+          end
+        end
+      end
+    end
+
+    private
+      def _enum_methods_module
+        @_enum_methods_module ||= begin
+          mod = Module.new
+          include mod
+          mod
+        end
+      end
+  end
+end

data/lib/active_record/errors.rb

@@ -69,10 +69,6 @@ module ActiveRecord
     end
   end
 
-  # Raised when SQL statement is invalid and the application gets a blank result.
-  class ThrowResult < ActiveRecordError
-  end
-
   # Defunct wrapper class kept for compatibility.
   # +StatementInvalid+ wraps the original exception now.
   class WrappedDatabaseException < StatementInvalid
@@ -159,6 +155,15 @@ module ActiveRecord
 
   # Raised when unknown attributes are supplied via mass assignment.
   class UnknownAttributeError < NoMethodError
+
+    attr_reader :record, :attribute
+
+    def initialize(record, attribute)
+      @record = record
+      @attribute = attribute.to_s
+      super("unknown attribute: #{attribute}")
+    end
+
   end
 
   # Raised when an error occurred while doing a mass assignment to an attribute through the
@@ -183,7 +188,7 @@ module ActiveRecord
     end
   end
 
-  # Raised when a primary key is needed, but there is not one specified in the schema or model.
+  # Raised when a primary key is needed, but not specified in the schema or model.
   class UnknownPrimaryKey < ActiveRecordError
     attr_reader :model
 

data/lib/active_record/fixture_set/file.rb

@@ -38,7 +38,8 @@ module ActiveRecord
         end
 
         def render(content)
-          ERB.new(content).result
+          context = ActiveRecord::FixtureSet::RenderContext.create_subclass.new
+          ERB.new(content).result(context.get_binding)
         end
 
         # Validate our unmarshalled data.

data/lib/active_record/fixtures.rb

@@ -119,6 +119,23 @@ module ActiveRecord
   # perhaps you should reexamine whether your application is properly testable. Hence, dynamic values
   # in fixtures are to be considered a code smell.
   #
+  # Helper methods defined in a fixture will not be available in other fixtures, to prevent against
+  # unwanted inter-test dependencies. Methods used by multiple fixtures should be defined in a module
+  # that is included in <tt>ActiveRecord::FixtureSet.context_class</tt>.
+  #
+  # - define a helper method in `test_helper.rb`
+  #     class FixtureFileHelpers
+  #       def file_sha(path)
+  #         Digest::SHA2.hexdigest(File.read(Rails.root.join('test/fixtures', path)))
+  #       end
+  #     end
+  #     ActiveRecord::FixtureSet.context_class.send :include, FixtureFileHelpers
+  #
+  # - use the helper method in a fixture
+  #     photo:
+  #       name: kitten.png
+  #       sha: <%= file_sha 'files/kitten.png' %>
+  #
   # = Transactional Fixtures
   #
   # Test cases can use begin+rollback to isolate their changes to the database instead of having to
@@ -379,22 +396,16 @@ module ActiveRecord
 
     @@all_cached_fixtures = Hash.new { |h,k| h[k] = {} }
 
-    def self.find_table_name(fixture_set_name) # :nodoc:
-      ActiveSupport::Deprecation.warn(
-        "ActiveRecord::Fixtures.find_table_name is deprecated and shall be removed from future releases.  Use ActiveRecord::Fixtures.default_fixture_model_name instead.")
-      default_fixture_model_name(fixture_set_name)
-    end
-
-    def self.default_fixture_model_name(fixture_set_name) # :nodoc:
-      ActiveRecord::Base.pluralize_table_names ?
+    def self.default_fixture_model_name(fixture_set_name, config = ActiveRecord::Base) # :nodoc:
+      config.pluralize_table_names ?
         fixture_set_name.singularize.camelize :
         fixture_set_name.camelize
     end
 
-    def self.default_fixture_table_name(fixture_set_name) # :nodoc:
-       "#{ ActiveRecord::Base.table_name_prefix }"\
+    def self.default_fixture_table_name(fixture_set_name, config = ActiveRecord::Base) # :nodoc:
+       "#{ config.table_name_prefix }"\
        "#{ fixture_set_name.tr('/', '_') }"\
-       "#{ ActiveRecord::Base.table_name_suffix }".to_sym
+       "#{ config.table_name_suffix }".to_sym
     end
 
     def self.reset_cache
@@ -442,9 +453,47 @@ module ActiveRecord
     cattr_accessor :all_loaded_fixtures
     self.all_loaded_fixtures = {}
 
-    def self.create_fixtures(fixtures_directory, fixture_set_names, class_names = {})
+    class ClassCache
+      def initialize(class_names, config)
+        @class_names = class_names.stringify_keys
+        @config      = config
+
+        # Remove string values that aren't constants or subclasses of AR
+        @class_names.delete_if { |k,klass|
+          unless klass.is_a? Class
+            klass = klass.safe_constantize
+            ActiveSupport::Deprecation.warn("The ability to pass in strings as a class name will be removed in Rails 4.2, consider using the class itself instead.")
+          end
+          !insert_class(@class_names, k, klass)
+        }
+      end
+
+      def [](fs_name)
+        @class_names.fetch(fs_name) {
+          klass = default_fixture_model(fs_name, @config).safe_constantize
+          insert_class(@class_names, fs_name, klass)
+        }
+      end
+
+      private
+
+      def insert_class(class_names, name, klass)
+        # We only want to deal with AR objects.
+        if klass && klass < ActiveRecord::Base
+          class_names[name] = klass
+        else
+          class_names[name] = nil
+        end
+      end
+
+      def default_fixture_model(fs_name, config)
+        ActiveRecord::FixtureSet.default_fixture_model_name(fs_name, config)
+      end
+    end
+
+    def self.create_fixtures(fixtures_directory, fixture_set_names, class_names = {}, config = ActiveRecord::Base)
       fixture_set_names = Array(fixture_set_names).map(&:to_s)
-      class_names = class_names.stringify_keys
+      class_names = ClassCache.new class_names, config
 
       # FIXME: Apparently JK uses this.
       connection = block_given? ? yield : ActiveRecord::Base.connection
@@ -458,10 +507,12 @@ module ActiveRecord
           fixtures_map = {}
 
           fixture_sets = files_to_read.map do |fs_name|
+            klass = class_names[fs_name]
+            conn = klass ? klass.connection : connection
             fixtures_map[fs_name] = new( # ActiveRecord::FixtureSet.new
-              connection,
+              conn,
               fs_name,
-              class_names[fs_name] || default_fixture_model_name(fs_name),
+              klass,
               ::File.join(fixtures_directory, fs_name))
           end
 
@@ -470,16 +521,8 @@ module ActiveRecord
           connection.transaction(:requires_new => true) do
             fixture_sets.each do |fs|
               conn = fs.model_class.respond_to?(:connection) ? fs.model_class.connection : connection
-              table_rows = fs.table_rows
-
-              table_rows.keys.each do |table|
-                conn.delete "DELETE FROM #{conn.quote_table_name(table)}", 'Fixture Delete'
-              end
-
-              table_rows.each do |fixture_set_name, rows|
-                rows.each do |row|
-                  conn.insert_fixture(row, fixture_set_name)
-                end
+              fs.fixture_sql(conn).each do |stmt|
+                conn.execute stmt
               end
             end
 
@@ -503,27 +546,36 @@ module ActiveRecord
       Zlib.crc32(label.to_s) % MAX_ID
     end
 
-    attr_reader :table_name, :name, :fixtures, :model_class
+    # Superclass for the evaluation contexts used by ERB fixtures.
+    def self.context_class
+      @context_class ||= Class.new
+    end
+
+    attr_reader :table_name, :name, :fixtures, :model_class, :config
 
-    def initialize(connection, name, class_name, path)
-      @fixtures = {} # Ordered hash
+    def initialize(connection, name, class_name, path, config = ActiveRecord::Base)
       @name     = name
       @path     = path
+      @config   = config
+      @model_class = nil
+
+      if class_name.is_a?(String)
+        ActiveSupport::Deprecation.warn("The ability to pass in strings as a class name will be removed in Rails 4.2, consider using the class itself instead.")
+      end
 
       if class_name.is_a?(Class) # TODO: Should be an AR::Base type class, or any?
         @model_class = class_name
       else
-        @model_class = class_name.constantize rescue nil
+        @model_class = class_name.safe_constantize if class_name
       end
 
-      @connection  = ( model_class.respond_to?(:connection) ?
-                       model_class.connection : connection )
+      @connection  = connection
 
       @table_name = ( model_class.respond_to?(:table_name) ?
                       model_class.table_name :
-                      self.class.default_fixture_table_name(name) )
+                      self.class.default_fixture_table_name(name, config) )
 
-      read_fixture_files
+      @fixtures = read_fixture_files path, @model_class
     end
 
     def [](x)
@@ -542,10 +594,20 @@ module ActiveRecord
       fixtures.size
     end
 
+    def fixture_sql(conn)
+      table_rows = self.table_rows
+
+      table_rows.keys.map { |table|
+        "DELETE FROM #{conn.quote_table_name(table)}"
+      }.concat table_rows.flat_map { |fixture_set_name, rows|
+        rows.map { |row| conn.fixture_sql(row, fixture_set_name) }
+      }
+    end
+
     # Return a hash of rows to be inserted. The key is the table, the value is
     # a list of rows to insert to that table.
     def table_rows
-      now = ActiveRecord::Base.default_timezone == :utc ? Time.now.utc : Time.now
+      now = config.default_timezone == :utc ? Time.now.utc : Time.now
       now = now.to_s(:db)
 
       # allow a standard key to be used for doing defaults in YAML
@@ -557,7 +619,7 @@ module ActiveRecord
       rows[table_name] = fixtures.map do |label, fixture|
         row = fixture.to_hash
 
-        if model_class && model_class < ActiveRecord::Base
+        if model_class
           # fill in timestamp columns if they aren't specified and the model is set to record_timestamps
           if model_class.record_timestamps
             timestamp_column_names.each do |c_name|
@@ -567,7 +629,7 @@ module ActiveRecord
 
           # interpolate the fixture label
           row.each do |key, value|
-            row[key] = label if value == "$LABEL"
+            row[key] = label if "$LABEL" == value
           end
 
           # generate a primary key if necessary
@@ -597,14 +659,9 @@ module ActiveRecord
 
                 row[fk_name] = ActiveRecord::FixtureSet.identify(value)
               end
-            when :has_and_belongs_to_many
-              if (targets = row.delete(association.name.to_s))
-                targets = targets.is_a?(Array) ? targets : targets.split(/\s*,\s*/)
-                table_name = association.join_table
-                rows[table_name].concat targets.map { |target|
-                  { association.foreign_key             => row[primary_key_name],
-                    association.association_foreign_key => ActiveRecord::FixtureSet.identify(target) }
-                }
+            when :has_many
+              if association.options[:through]
+                add_join_records(rows, row, HasManyThroughProxy.new(association))
               end
             end
           end
@@ -615,11 +672,50 @@ module ActiveRecord
       rows
     end
 
+    class ReflectionProxy # :nodoc:
+      def initialize(association)
+        @association = association
+      end
+
+      def join_table
+        @association.join_table
+      end
+
+      def name
+        @association.name
+      end
+    end
+
+    class HasManyThroughProxy < ReflectionProxy # :nodoc:
+      def rhs_key
+        @association.foreign_key
+      end
+
+      def lhs_key
+        @association.through_reflection.foreign_key
+      end
+    end
+
     private
       def primary_key_name
         @primary_key_name ||= model_class && model_class.primary_key
       end
 
+      def add_join_records(rows, row, association)
+        # This is the case when the join table has no fixtures file
+        if (targets = row.delete(association.name.to_s))
+          table_name = association.join_table
+          lhs_key    = association.lhs_key
+          rhs_key    = association.rhs_key
+
+          targets = targets.is_a?(Array) ? targets : targets.split(/\s*,\s*/)
+          rows[table_name].concat targets.map { |target|
+            { lhs_key => row[primary_key_name],
+              rhs_key => ActiveRecord::FixtureSet.identify(target) }
+          }
+        end
+      end
+
       def has_primary_key_column?
         @has_primary_key_column ||= primary_key_name &&
           model_class.columns.any? { |c| c.name == primary_key_name }
@@ -638,12 +734,12 @@ module ActiveRecord
         @column_names ||= @connection.columns(@table_name).collect { |c| c.name }
       end
 
-      def read_fixture_files
-        yaml_files = Dir["#{@path}/{**,*}/*.yml"].select { |f|
+      def read_fixture_files(path, model_class)
+        yaml_files = Dir["#{path}/{**,*}/*.yml"].select { |f|
           ::File.file?(f)
-        } + [yaml_file_path]
+        } + [yaml_file_path(path)]
 
-        yaml_files.each do |file|
+        yaml_files.each_with_object({}) do |file, fixtures|
           FixtureSet::File.open(file) do |fh|
             fh.each do |fixture_name, row|
               fixtures[fixture_name] = ActiveRecord::Fixture.new(row, model_class)
@@ -652,8 +748,8 @@ module ActiveRecord
         end
       end
 
-      def yaml_file_path
-        "#{@path}.yml"
+      def yaml_file_path(path)
+        "#{path}.yml"
       end
 
   end
@@ -696,7 +792,7 @@ module ActiveRecord
 
     def find
       if model_class
-        model_class.unscoped.find(fixture[model_class.primary_key])
+        model_class.find(fixture[model_class.primary_key])
       else
         raise FixtureClassNotFound, "No class attached to find."
       end
@@ -725,14 +821,16 @@ module ActiveRecord
       class_attribute :use_transactional_fixtures
       class_attribute :use_instantiated_fixtures # true, false, or :no_instances
       class_attribute :pre_loaded_fixtures
+      class_attribute :config
 
       self.fixture_table_names = []
       self.use_transactional_fixtures = true
       self.use_instantiated_fixtures = false
       self.pre_loaded_fixtures = false
+      self.config = ActiveRecord::Base
 
       self.fixture_class_names = Hash.new do |h, fixture_set_name|
-        h[fixture_set_name] = ActiveRecord::FixtureSet.default_fixture_model_name(fixture_set_name)
+        h[fixture_set_name] = ActiveRecord::FixtureSet.default_fixture_model_name(fixture_set_name, self.config)
       end
     end
 
@@ -745,13 +843,6 @@ module ActiveRecord
       #                     'namespaced/fixture' => Another::Model
       #
       # The keys must be the fixture names, that coincide with the short paths to the fixture files.
-      #--
-      # It is also possible to pass the class name instead of the class:
-      #   set_fixture_class 'some_fixture' => 'SomeModel'
-      # I think this option is redundant, i propose to deprecate it.
-      # Isn't it easier to always pass the class itself?
-      # (2011-12-20 alexeymuranov)
-      #++
       def set_fixture_class(class_names = {})
         self.fixture_class_names = self.fixture_class_names.merge(class_names.stringify_keys)
       end
@@ -765,7 +856,7 @@ module ActiveRecord
         end
 
         self.fixture_table_names |= fixture_set_names
-        require_fixture_classes(fixture_set_names)
+        require_fixture_classes(fixture_set_names, self.config)
         setup_fixture_accessors(fixture_set_names)
       end
 
@@ -780,7 +871,7 @@ module ActiveRecord
         end
       end
 
-      def require_fixture_classes(fixture_set_names = nil)
+      def require_fixture_classes(fixture_set_names = nil, config = ActiveRecord::Base)
         if fixture_set_names
           fixture_set_names = fixture_set_names.map { |n| n.to_s }
         else
@@ -788,7 +879,7 @@ module ActiveRecord
         end
 
         fixture_set_names.each do |file_name|
-          file_name = file_name.singularize if ActiveRecord::Base.pluralize_table_names
+          file_name = file_name.singularize if config.pluralize_table_names
           try_to_load_dependency(file_name)
         end
       end
@@ -840,9 +931,7 @@ module ActiveRecord
         !self.class.uses_transaction?(method_name)
     end
 
-    def setup_fixtures
-      return if ActiveRecord::Base.configurations.blank?
-
+    def setup_fixtures(config = ActiveRecord::Base)
       if pre_loaded_fixtures && !use_transactional_fixtures
         raise RuntimeError, 'pre_loaded_fixtures requires use_transactional_fixtures'
       end
@@ -856,7 +945,7 @@ module ActiveRecord
         if @@already_loaded_fixtures[self.class]
           @loaded_fixtures = @@already_loaded_fixtures[self.class]
         else
-          @loaded_fixtures = load_fixtures
+          @loaded_fixtures = load_fixtures(config)
           @@already_loaded_fixtures[self.class] = @loaded_fixtures
         end
         @fixture_connections = enlist_fixture_connections
@@ -867,16 +956,14 @@ module ActiveRecord
       else
         ActiveRecord::FixtureSet.reset_cache
         @@already_loaded_fixtures[self.class] = nil
-        @loaded_fixtures = load_fixtures
+        @loaded_fixtures = load_fixtures(config)
       end
 
       # Instantiate fixtures for every test if requested.
-      instantiate_fixtures if use_instantiated_fixtures
+      instantiate_fixtures(config) if use_instantiated_fixtures
     end
 
     def teardown_fixtures
-      return if ActiveRecord::Base.configurations.blank?
-
       # Rollback changes if a transaction is active.
       if run_in_transaction?
         @fixture_connections.each do |connection|
@@ -895,19 +982,19 @@ module ActiveRecord
     end
 
     private
-      def load_fixtures
-        fixtures = ActiveRecord::FixtureSet.create_fixtures(fixture_path, fixture_table_names, fixture_class_names)
+      def load_fixtures(config)
+        fixtures = ActiveRecord::FixtureSet.create_fixtures(fixture_path, fixture_table_names, fixture_class_names, config)
         Hash[fixtures.map { |f| [f.name, f] }]
       end
 
       # for pre_loaded_fixtures, only require the classes once. huge speed improvement
       @@required_fixture_classes = false
 
-      def instantiate_fixtures
+      def instantiate_fixtures(config)
         if pre_loaded_fixtures
           raise RuntimeError, 'Load fixtures before instantiating them.' if ActiveRecord::FixtureSet.all_loaded_fixtures.empty?
           unless @@required_fixture_classes
-            self.class.require_fixture_classes ActiveRecord::FixtureSet.all_loaded_fixtures.keys
+            self.class.require_fixture_classes ActiveRecord::FixtureSet.all_loaded_fixtures.keys, config
             @@required_fixture_classes = true
           end
           ActiveRecord::FixtureSet.instantiate_all_loaded_fixtures(self, load_instances?)
@@ -924,3 +1011,13 @@ module ActiveRecord
       end
   end
 end
+
+class ActiveRecord::FixtureSet::RenderContext # :nodoc:
+  def self.create_subclass
+    Class.new ActiveRecord::FixtureSet.context_class do
+      def get_binding
+        binding()
+      end
+    end
+  end
+end