attribute_defaults 0.1 → 0.2

data/Gemfile

@@ -1,2 +1,5 @@
 source "http://rubygems.org"
 gemspec
+
+gem "rspec"
+gem "mysql2", "< 0.3"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    attribute_defaults (0.1)
+    attribute_defaults (0.2)
       activerecord (>= 3)
 
 GEM

data/attribute_defaults.gemspec

@@ -1,8 +1,8 @@
-require File.expand_path("../lib/active_record/attribute_defaults/version", __FILE__)
+require File.expand_path("../lib/attribute_defaults/version", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "attribute_defaults"
-  s.version     = ActiveRecord::AttributeDefaults::VERSION
+  s.version     = AttributeDefaults::VERSION
   s.summary     = "attribute_defaults-#{s.version}"
   s.description = "Add default attribute values when creating models."
   s.authors     = ["Jonathan Viney"]

data/lib/attribute_defaults.rb

@@ -0,0 +1,136 @@
+require "active_support/concern"
+require "active_support/core_ext/module/aliasing"
+require "active_support/core_ext/class/attribute"
+
+require "attribute_defaults/default"
+
+module AttributeDefaults
+  extend ActiveSupport::Concern
+  
+  included do
+    alias_method_chain :initialize, :defaults
+    
+    class_attribute :attribute_defaults
+    self.attribute_defaults = []
+  end
+  
+  module ClassMethods
+    # Define default values for attributes on new records. Requires a hash of <tt>attribute => value</tt> pairs, or a single attribute with an associated block.
+    # If the value is a block, it will be called to retrieve the default value.
+    # If the value is a symbol, a method by that name will be called on the object to retrieve the default value.
+    # 
+    # The following code demonstrates the different ways default values can be specified. Defaults are applied in the order they are defined.
+    # 
+    #   class Person < ActiveRecord::Base
+    #     defaults :name => 'My name', :city => lambda { 'My city' }
+    #     
+    #     default :birthdate do |person|
+    #       Date.today if person.wants_birthday_today?
+    #     end
+    #     
+    #     default :favourite_colour => :default_favourite_colour
+    #     
+    #     def default_favourite_colour
+    #       "Blue"
+    #     end
+    #   end
+    # 
+    # The <tt>defaults</tt> and the <tt>default</tt> methods behave the same way. Use whichever is appropriate.
+    #
+    # The default values are only used if the key is not present in the given attributes.
+    # 
+    #   p = Person.new
+    #   p.name # "My name"
+    #   p.city # "My city"
+    #   
+    #   p = Person.new(:name => nil)
+    #   p.name # nil
+    #   p.city # "My city"
+    #
+    # == Default values for belongs_to associations
+    # 
+    # Default values can also be specified for an association. For instance:
+    #
+    #   class Student < ActiveRecord::Base
+    #     belongs_to :school
+    #     default :school => lambda { School.new }
+    #   end
+    #
+    # In this scenario, if a school_id was provided in the attributes hash, the default value for the association will be ignored:
+    #
+    #   s = Student.new
+    #   s.school # => #<School: ...>
+    # 
+    #   s = Student.new(:school_id => nil)
+    #   s.school # => nil
+    #
+    # Similarly, if a default value is specified for the foreign key and an object for the association is provided, the default foreign key is ignored.
+    def defaults(defaults, &block)
+      default_objects = case
+      when defaults.is_a?(Hash)
+        defaults.map { |attribute, value| Default.new(attribute, value) }
+        
+      when defaults.is_a?(Symbol) && block
+        Default.new(defaults, block)
+        
+      else
+        raise "pass either a hash of attribute/value pairs, or a single attribute with a block"
+      end
+      
+      self.attribute_defaults += Array.wrap(default_objects)
+    end
+    
+    alias_method :default, :defaults
+  end
+  
+  module InstanceMethods
+    if ActiveRecord::VERSION::STRING >= "3.1"
+      def initialize_with_defaults(attributes = nil, options = {})
+        initialize_without_defaults(attributes, options) do |record|
+          record.apply_default_attribute_values(attributes)
+          yield record if block_given?
+        end
+      end
+    else
+      def initialize_with_defaults(attributes = nil)
+        initialize_without_defaults(attributes) do |record|
+          record.apply_default_attribute_values(attributes)
+          yield record if block_given?
+        end
+      end
+    end
+    
+    def apply_default_attribute_values(specific_attributes)
+      specific_attributes = (specific_attributes || {}).stringify_keys
+      
+      # Rails 3.1 deprecates #primary_key_name in favour of :foreign_key
+      foreign_key_method = if ActiveRecord::VERSION::STRING >= "3.1"
+        :foreign_key
+      else
+        :primary_key_name
+      end
+      
+      self.class.attribute_defaults.each do |default|
+        next if specific_attributes.include?(default.attribute)
+        
+        # Ignore a default value for association_id if association has been specified
+        reflection = self.class.reflections[default.attribute.to_sym]
+        if reflection and reflection.macro == :belongs_to and specific_attributes.include?(reflection.send(foreign_key_method).to_s)
+          next
+        end
+        
+        # Ignore a default value for association if association_id has been specified
+        reflection = self.class.reflections.values.find { |r| r.macro == :belongs_to && r.send(foreign_key_method).to_s == default.attribute }
+        if reflection and specific_attributes.include?(reflection.name.to_s)
+          next
+        end
+        
+        send("#{default.attribute}=", default.value(self))
+      end
+    end
+  end
+end
+
+class ActiveRecord::Base
+  include AttributeDefaults
+end

data/lib/attribute_defaults/default.rb

@@ -0,0 +1,19 @@
+module AttributeDefaults
+  class Default
+    attr_reader :attribute
+    
+    def initialize(attribute, value)
+      @attribute, @value = attribute.to_s, value
+    end
+    
+    def value(record)
+      if @value.is_a?(Symbol)
+        record.send(@value)
+      elsif @value.respond_to?(:call)
+        @value.call(record)
+      else
+        @value.duplicable? ? @value.dup : @value
+      end
+    end
+  end
+end

data/lib/attribute_defaults/version.rb

@@ -0,0 +1,3 @@
+module AttributeDefaults
+  VERSION = "0.2"
+end

data/spec/{active_record/attribute_defaults_spec.rb → attribute_defaults_spec.rb}

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe "active_record/attribute_defaults" do
+describe "attribute_defaults" do
   it "should supply defaults for a new record" do
     p = Person.new
     

data/spec/spec_helper.rb

@@ -5,7 +5,7 @@ require "rspec"
 require "active_record"
 require "active_record/base"
 
-require File.expand_path("../../lib/active_record/attribute_defaults", __FILE__)
+require File.expand_path("../../lib/attribute_defaults", __FILE__)
 
 ActiveRecord::Base.configurations = YAML::load(IO.read(File.dirname(__FILE__) + "/database.yml"))
 ActiveRecord::Base.logger = ActiveSupport::BufferedLogger.new(File.dirname(__FILE__) + "/debug.log")

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: attribute_defaults
 version: !ruby/object:Gem::Version 
-  hash: 9
-  prerelease: 
+  hash: 15
+  prerelease: false
   segments: 
   - 0
-  - 1
-  version: "0.1"
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - Jonathan Viney
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-02 00:00:00 +12:00
+date: 2011-07-03 00:00:00 +12:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -75,11 +75,10 @@ files:
 - LICENSE
 - Readme.md
 - attribute_defaults.gemspec
-- init.rb
-- lib/active_record/attribute_defaults.rb
-- lib/active_record/attribute_defaults/default.rb
-- lib/active_record/attribute_defaults/version.rb
-- spec/active_record/attribute_defaults_spec.rb
+- lib/attribute_defaults.rb
+- lib/attribute_defaults/default.rb
+- lib/attribute_defaults/version.rb
+- spec/attribute_defaults_spec.rb
 - spec/database.yml
 - spec/schema.rb
 - spec/spec_helper.rb
@@ -113,9 +112,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: attribute_defaults-0.1
+summary: attribute_defaults-0.2
 test_files: []
 

data/init.rb

@@ -1 +0,0 @@
-require "active_record/attribute_defaults"

data/lib/active_record/attribute_defaults.rb

@@ -1,138 +0,0 @@
-require "active_support/concern"
-require "active_support/core_ext/module/aliasing"
-require "active_support/core_ext/class/attribute"
-
-require "active_record/attribute_defaults/default"
-
-module ActiveRecord
-  module AttributeDefaults
-    extend ActiveSupport::Concern
-    
-    included do
-      alias_method_chain :initialize, :defaults
-      
-      class_attribute :attribute_defaults
-      self.attribute_defaults = []
-    end
-    
-    module ClassMethods
-      # Define default values for attributes on new records. Requires a hash of <tt>attribute => value</tt> pairs, or a single attribute with an associated block.
-      # If the value is a block, it will be called to retrieve the default value.
-      # If the value is a symbol, a method by that name will be called on the object to retrieve the default value.
-      # 
-      # The following code demonstrates the different ways default values can be specified. Defaults are applied in the order they are defined.
-      # 
-      #   class Person < ActiveRecord::Base
-      #     defaults :name => 'My name', :city => lambda { 'My city' }
-      #     
-      #     default :birthdate do |person|
-      #       Date.today if person.wants_birthday_today?
-      #     end
-      #     
-      #     default :favourite_colour => :default_favourite_colour
-      #     
-      #     def default_favourite_colour
-      #       "Blue"
-      #     end
-      #   end
-      # 
-      # The <tt>defaults</tt> and the <tt>default</tt> methods behave the same way. Use whichever is appropriate.
-      #
-      # The default values are only used if the key is not present in the given attributes.
-      # 
-      #   p = Person.new
-      #   p.name # "My name"
-      #   p.city # "My city"
-      #   
-      #   p = Person.new(:name => nil)
-      #   p.name # nil
-      #   p.city # "My city"
-      #
-      # == Default values for belongs_to associations
-      # 
-      # Default values can also be specified for an association. For instance:
-      #
-      #   class Student < ActiveRecord::Base
-      #     belongs_to :school
-      #     default :school => lambda { School.new }
-      #   end
-      #
-      # In this scenario, if a school_id was provided in the attributes hash, the default value for the association will be ignored:
-      #
-      #   s = Student.new
-      #   s.school # => #<School: ...>
-      # 
-      #   s = Student.new(:school_id => nil)
-      #   s.school # => nil
-      #
-      # Similarly, if a default value is specified for the foreign key and an object for the association is provided, the default foreign key is ignored.
-      def defaults(defaults, &block)
-        default_objects = case
-        when defaults.is_a?(Hash)
-          defaults.map { |attribute, value| Default.new(attribute, value) }
-          
-        when defaults.is_a?(Symbol) && block
-          Default.new(defaults, block)
-          
-        else
-          raise "pass either a hash of attribute/value pairs, or a single attribute with a block"
-        end
-        
-        self.attribute_defaults += Array.wrap(default_objects)
-      end
-      
-      alias_method :default, :defaults
-    end
-    
-    module InstanceMethods
-      if ActiveRecord::VERSION::STRING >= "3.1"
-        def initialize_with_defaults(attributes = nil, options = {})
-          initialize_without_defaults(attributes, options) do |record|
-            record.apply_default_attribute_values(attributes)
-            yield record if block_given?
-          end
-        end
-      else
-        def initialize_with_defaults(attributes = nil)
-          initialize_without_defaults(attributes) do |record|
-            record.apply_default_attribute_values(attributes)
-            yield record if block_given?
-          end
-        end
-      end
-      
-      def apply_default_attribute_values(specific_attributes)
-        specific_attributes = (specific_attributes || {}).stringify_keys
-        
-        # Rails 3.1 deprecates #primary_key_name in favour of :foreign_key
-        foreign_key_method = if ActiveRecord::VERSION::STRING >= "3.1"
-          :foreign_key
-        else
-          :primary_key_name
-        end
-        
-        self.class.attribute_defaults.each do |default|
-          next if specific_attributes.include?(default.attribute)
-          
-          # Ignore a default value for association_id if association has been specified
-          reflection = self.class.reflections[default.attribute.to_sym]
-          if reflection and reflection.macro == :belongs_to and specific_attributes.include?(reflection.send(foreign_key_method).to_s)
-            next
-          end
-          
-          # Ignore a default value for association if association_id has been specified
-          reflection = self.class.reflections.values.find { |r| r.macro == :belongs_to && r.send(foreign_key_method).to_s == default.attribute }
-          if reflection and specific_attributes.include?(reflection.name.to_s)
-            next
-          end
-          
-          send("#{default.attribute}=", default.value(self))
-        end
-      end
-    end
-  end
-end
-
-class ActiveRecord::Base
-  include ActiveRecord::AttributeDefaults
-end

data/lib/active_record/attribute_defaults/default.rb

@@ -1,21 +0,0 @@
-module ActiveRecord
-  module AttributeDefaults
-    class Default
-      attr_reader :attribute
-      
-      def initialize(attribute, value)
-        @attribute, @value = attribute.to_s, value
-      end
-      
-      def value(record)
-        if @value.is_a?(Symbol)
-          record.send(@value)
-        elsif @value.respond_to?(:call)
-          @value.call(record)
-        else
-          @value.duplicable? ? @value.dup : @value
-        end
-      end
-    end
-  end
-end

data/lib/active_record/attribute_defaults/version.rb

@@ -1,5 +0,0 @@
-module ActiveRecord
-  module AttributeDefaults
-    VERSION = "0.1"
-  end
-end