attribute_defaults 0.1

data/Changelog.md

@@ -0,0 +1,3 @@
+## 0.1 (July 2, 2011)
+
+Initial release supporting Rails 3.0 and 3.1.

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    attribute_defaults (0.1)
+      activerecord (>= 3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.9)
+      activemodel (= 3.0.9)
+      activesupport (= 3.0.9)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.9)
+    arel (2.0.10)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    i18n (0.5.0)
+    mysql2 (0.2.11)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    tzinfo (0.3.29)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  attribute_defaults!
+  mysql2 (< 0.3)
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jonathan Viney
+
+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.

data/Readme.md

@@ -0,0 +1,84 @@
+# Active Record Attribute Defaults
+
+An easy way to specify default attribute values for new records.
+
+## Quick start
+
+    class Person < ActiveRecord::Base
+      defaults :country => 'New Zealand', :type => 'Unknown', :address => lambda { Address.new }
+  
+      default :last_name do |person|
+        person.first_name
+      end
+    end
+  
+The default value is only used if the attribute is not present in the attributes hash, so any values you pass in when creating the record will take precedence.
+
+Note that the defaults are evaluated when the model class is loaded, so if a default is meant to
+be dynamic, such as today's date, it must be specified as a proc.
+
+    class Person < ActiveRecord::Base
+      default :today => Date.today            # WRONG
+      default :today => lambda { Date.today } # RIGHT
+    end
+  
+Interestingly, because the model classes are reloaded for every request in development mode,
+the first default would always work as expected. But in production, where the model classes are
+only loaded once, the date will shortly become incorrect.
+
+## More information
+
+Use this gem to define default values for attributes on new records.
+Requires a hash of `attribute => value` 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.current if person.wants_birthday_today?
+      end
+      
+      default :favourite_colour => :default_favourite_colour
+      
+      def default_favourite_colour
+        "Blue"
+      end
+    end
+
+The `defaults` and the `default` 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.
+Therefore, the above code will behave in the following way:
+
+    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.favourite }
+    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.

data/attribute_defaults.gemspec

@@ -0,0 +1,17 @@
+require File.expand_path("../lib/active_record/attribute_defaults/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "attribute_defaults"
+  s.version     = ActiveRecord::AttributeDefaults::VERSION
+  s.summary     = "attribute_defaults-#{s.version}"
+  s.description = "Add default attribute values when creating models."
+  s.authors     = ["Jonathan Viney"]
+  s.email       = "jonathan.viney@gmail.com"
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = "http://github.com/jviney/attribute_defaults"
+  
+  s.add_dependency "activerecord", ">= 3"
+  
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "mysql2", "< 0.3"
+end

data/init.rb

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

data/lib/active_record/attribute_defaults.rb

@@ -0,0 +1,138 @@
+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

@@ -0,0 +1,21 @@
+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

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

data/spec/active_record/attribute_defaults_spec.rb

@@ -0,0 +1,78 @@
+require "spec_helper"
+
+describe "active_record/attribute_defaults" do
+  it "should supply defaults for a new record" do
+    p = Person.new
+    
+    p.city.should == "Christchurch"
+    p.country.should == "New Zealand"
+    p.first_name.should == "Sean"
+    p.last_name.should == "Fitzpatrick"
+    p.lucky_number.should == 2
+    p.favourite_colour.should == "Blue"
+  end
+  
+  it "should ignore the default if a specific value is given" do
+    p = Person.new(:city => "", "lucky_number" => nil)
+    
+    p.city.should == ""
+    p.lucky_number.should be_nil
+    
+    p.country.should == "New Zealand"
+    p.first_name.should == "Sean"
+    p.last_name.should == "Fitzpatrick"
+    p.favourite_colour.should == "Blue"
+  end
+  
+  it "should not cache the result of the default block" do
+    one = Person.new
+    two = Person.new
+    
+    one.first_name.object_id.should_not == two.first_name.object_id
+  end
+  
+  it "should not provide defaults for existing records" do
+    existing_person = Person.create!(:last_name => "Key")
+    Person.find(existing_person.id).last_name.should == "Key"
+  end
+  
+  it "should process the defaults in the order of definition" do
+    Person.new(:last_name => "Carter").favourite_colour.should == "Red"
+  end
+  
+  it "should add defaults on create!" do
+    p = Person.create!
+    
+    p.city.should == "Christchurch"
+    p.country.should == "New Zealand"
+    p.first_name.should == "Sean"
+    p.last_name.should == "Fitzpatrick"
+    p.lucky_number.should == 2
+    p.favourite_colour.should == "Blue"
+  end
+  
+  it "should allow a default object for a belongs_to association" do
+    @school = School.create! { |s| s.id = 1 }
+    PersonWithDefaultSchool.new.school.should == @school
+    @school.destroy
+  end
+  
+  it "should not use the default for a belongs to association when a nil id is supplied" do
+    PersonWithDefaultSchool.new(:school_id => nil).school.should be_nil
+  end
+  
+  it "should allow a default id for a belongs_to association" do
+    @school = School.create! { |s| s.id = 1 }
+    PersonWithDefaultSchoolId.new.school.should == @school
+    @school.destroy
+  end
+  
+  it "should ignore a default id for a belongs_to association when an object is supplied" do
+    PersonWithDefaultSchoolId.new(:school => nil).school.should be_nil
+  end
+  
+  it "should not raise an error when no defaults are defined" do
+    klass = Class.new(ActiveRecord::Base) { set_table_name "people" }
+    lambda { klass.new }.should_not raise_error
+  end
+end

data/spec/database.yml

@@ -0,0 +1,7 @@
+mysql:
+  :adapter: mysql2
+  :host: localhost
+  :username: rails
+  :password:
+  :database: rails_plugin_test
+  :socket: /tmp/mysql.sock

data/spec/schema.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Schema.define :version => 0 do
+  create_table :people, :force => true do |t|
+    t.column :first_name,       :string
+    t.column :middle_name,      :string
+    t.column :last_name,        :string
+    t.column :city,             :string
+    t.column :country,          :string
+    t.column :birthdate,        :date
+    t.column :lucky_number,     :integer
+    t.column :favourite_colour, :string
+    t.column :type,             :string
+    t.column :school_id,        :integer
+  end
+  
+  create_table :schools, :force => true do |t|
+    t.column :name, :string
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+require "rubygems"
+require "bundler/setup"
+require "rspec"
+
+require "active_record"
+require "active_record/base"
+
+require File.expand_path("../../lib/active_record/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")
+ActiveRecord::Base.establish_connection(ENV["DB"] || "mysql")
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+# Fixtures
+Address = Struct.new(:suburb, :city)
+
+class Group < ActiveRecord::Base
+end
+
+class Person < ActiveRecord::Base
+  belongs_to :school
+  
+  # Include an aggregate reflection to check compatibility
+  composed_of :address, :mapping => [%w(address_suburb suburb), %(address_city city)]
+  
+  defaults :city => "Christchurch", :country => lambda { "New Zealand" }
+  
+  default :first_name => "Sean"
+  
+  default :last_name do
+    "Fitzpatrick"
+  end
+  
+  defaults :lucky_number => lambda { 2 }, :favourite_colour => :default_favourite_colour
+  
+  def default_favourite_colour
+    last_name == "Fitzpatrick" ? "Blue" : "Red"
+  end
+end
+
+class PersonWithDefaultSchool < Person
+  default :school do
+    School.find(1)
+  end
+end
+
+class PersonWithDefaultSchoolId < Person
+  default :school_id => 1
+end
+
+class School < ActiveRecord::Base
+  has_many :people
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: attribute_defaults
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Jonathan Viney
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-02 00:00:00 +12:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        version: "3"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mysql2
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 3
+        version: "0.3"
+  type: :development
+  version_requirements: *id003
+description: Add default attribute values when creating models.
+email: jonathan.viney@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Changelog.md
+- Gemfile
+- Gemfile.lock
+- 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
+- spec/database.yml
+- spec/schema.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jviney/attribute_defaults
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: attribute_defaults-0.1
+test_files: []
+