active_record_defaults 1.0.1

data/History.txt

@@ -0,0 +1,19 @@
+[13 Nov 09]
+
+* Ported to Gem
+* Moved to Jeweler
+* Pushed to Gemcutter
+
+[20 Sep 07]
+ 
+* Remove ability to set defaults with defaults instance method. Too easy to override values from parameters.
+ 
+[25 Jul 07]
+ 
+* Using a symbol as a default value will cause the return value of the method with that name to be the default.
+ 
+* Documentation updates.
+ 
+[24 Nov 06]
+ 
+* Make plugin work with composed_of [Problem reported by Dan Kubb]

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 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.rdoc

@@ -0,0 +1,38 @@
+= Changes for this Fork
+
+* Ported to a Gem.
+
+
+= Active Record Defaults
+
+If you find this plugin useful, please consider a donation to show your support!
+
+  http://www.paypal.com/cgi-bin/webscr?cmd=_send-money
+  
+  Email address: jonathan.viney@gmail.com
+  
+== Instructions
+
+Allow you to easily specify default values for attributes on new model objects. Eg:
+
+  class Person < ActiveRecord::Base
+    defaults :country => 'New Zealand', :type => 'Unknown', :address => proc { 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.
+
+See active_record_defaults.rb for full documentation.
+  
+== Installation
+
+  script/plugin install http://svn.viney.net.nz/things/rails/plugins/active_record_defaults
+  
+== Help
+
+Feel free to email with any problems, suggestions, bugs etc...
+
+  jonathan dot viney @ gmail . com

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "active_record_defaults"
+    gem.summary = %Q{Easily specify default values for attributes on new model objects.}
+    gem.description = %Q{Allows you to easily specify default values for attributes on new model objects.}
+    gem.email = "jonathan.viney@gmail.com"
+    gem.homepage = "http://github.com/midas/active_record_defaults"
+    gem.authors = ["Jonathan Viney (aussiegeek)", "C. Jason Harrelson (midas)"]
+    gem.add_dependency "activerecord", ">= 2"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tester #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/active_record_defaults.gemspec

@@ -0,0 +1,74 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{active_record_defaults}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jonathan Viney (aussiegeek)", "C. Jason Harrelson (midas)"]
+  s.date = %q{2009-11-13}
+  s.description = %q{Allows you to easily specify default values for attributes on new model objects.}
+  s.email = %q{jonathan.viney@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "History.txt",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "active_record_defaults.gemspec",
+     "lib/active_record/defaults.rb",
+     "lib/active_record_defaults.rb",
+     "script/console",
+     "script/destroy",
+     "script/generate",
+     "test/abstract_unit.rb",
+     "test/database.yml",
+     "test/fixtures/address.rb",
+     "test/fixtures/group.rb",
+     "test/fixtures/people.yml",
+     "test/fixtures/person.rb",
+     "test/fixtures/person_with_default_school.rb",
+     "test/fixtures/person_with_default_school_id.rb",
+     "test/fixtures/school.rb",
+     "test/fixtures/schools.yml",
+     "test/schema.rb",
+     "test/test_active_record_defaults.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/midas/active_record_defaults}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Easily specify default values for attributes on new model objects.}
+  s.test_files = [
+    "test/abstract_unit.rb",
+     "test/fixtures/address.rb",
+     "test/fixtures/group.rb",
+     "test/fixtures/person.rb",
+     "test/fixtures/person_with_default_school.rb",
+     "test/fixtures/person_with_default_school_id.rb",
+     "test/fixtures/school.rb",
+     "test/schema.rb",
+     "test/test_active_record_defaults.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 2"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 2"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 2"])
+  end
+end

data/lib/active_record/defaults.rb

@@ -0,0 +1,132 @@
+module ActiveRecord
+  module Defaults
+    def self.included(base)
+      return if base.included_modules.include?(ActiveRecord::Defaults::InstanceMethods)
+      
+      base.extend ClassMethods
+      base.send(:include, InstanceMethods)
+      
+      base.send :alias_method, :initialize_without_defaults, :initialize
+      base.send :alias_method, :initialize, :initialize_with_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
+        
+        write_inheritable_array :attribute_defaults, [*default_objects]
+      end
+      
+      alias_method :default, :defaults
+    end
+    
+    module InstanceMethods
+      def initialize_with_defaults(attributes = nil)
+        initialize_without_defaults(attributes)
+        apply_default_attribute_values(attributes)
+        yield self if block_given?
+      end
+      
+      def apply_default_attribute_values(attributes)
+        attribute_keys = (attributes || {}).keys.map!(&:to_s)
+        
+        if attribute_defaults = self.class.read_inheritable_attribute(:attribute_defaults)
+          attribute_defaults.each do |default|
+            next if attribute_keys.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 attribute_keys.include?(reflection.primary_key_name)
+              next
+            end
+            
+            # Ignore a default value for association if association_id has been specified
+            reflection = self.class.reflections.values.find { |r| r.respond_to?(:primary_key_name) && r.primary_key_name == default.attribute }
+            if reflection and reflection.macro == :belongs_to and attribute_keys.include?(reflection.name.to_s)
+              next
+            end
+            
+            send("#{default.attribute}=", default.value(self))
+          end
+        end
+      end
+    end
+    
+    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
+        end
+      end
+    end
+  end
+end

data/lib/active_record_defaults.rb

@@ -0,0 +1,10 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'active_record/defaults'
+
+module ActiveRecordDefaults
+  VERSION = '1.0.0'
+end
+
+ActiveRecord::Base.send( :include, ActiveRecord::Defaults ) if defined?( ActiveRecord::Base )

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/active_record_defaults.rb'}"
+puts "Loading active_record_defaults gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/abstract_unit.rb

@@ -0,0 +1,29 @@
+require 'test/unit'
+ 
+begin
+  require File.dirname(__FILE__) + '/../../../../config/environment'
+rescue LoadError
+  require 'rubygems'
+  require_gem 'activerecord'
+end
+ 
+# Search for fixtures first
+fixture_path = File.dirname(__FILE__) + '/fixtures/'
+Dependencies.load_paths.insert(0, fixture_path)
+ 
+require 'active_record/fixtures'
+ 
+require File.dirname(__FILE__) + '/../lib/active_record_defaults'
+ 
+ActiveRecord::Base.configurations = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + '/debug.log')
+ActiveRecord::Base.establish_connection(ENV['DB'] || 'mysql')
+ 
+load(File.dirname(__FILE__) + '/schema.rb')
+ 
+Test::Unit::TestCase.fixture_path = File.dirname(__FILE__) + '/fixtures/'
+ 
+class Test::Unit::TestCase #:nodoc:
+  self.use_transactional_fixtures = true
+  self.use_instantiated_fixtures = false
+end

data/test/database.yml

@@ -0,0 +1,6 @@
+sqlite:
+  :adapter: sqlite
+  :host: localhost
+  :username: rails
+  :password:
+  :database: rails_plugin_test

data/test/fixtures/address.rb

@@ -0,0 +1 @@
+Address = Struct.new(:suburb, :city)

data/test/fixtures/group.rb

@@ -0,0 +1,2 @@
+class Group < ActiveRecord::Base
+end

data/test/fixtures/people.yml

@@ -0,0 +1,7 @@
+jonathan:
+  id: 1
+  first_name: Jonathan
+  last_name:
+  city: Sydney
+  country: Australia
+  type: Person

data/test/fixtures/person.rb

@@ -0,0 +1,20 @@
+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 => Proc.new { 'New Zealand' }
+  
+  default :first_name => 'Sean'
+  
+  default :last_name do
+    'Fitzpatrick'
+  end
+  
+  defaults :lucky_number => proc { 2 }, :favourite_colour => :default_favourite_colour
+  
+  def default_favourite_colour
+    last_name == 'Fitzpatrick' ? "Blue" : "Red"
+  end
+end

data/test/fixtures/person_with_default_school.rb

@@ -0,0 +1,5 @@
+class PersonWithDefaultSchool < Person
+  default :school do
+    School.find(1)
+  end
+end

data/test/fixtures/person_with_default_school_id.rb

@@ -0,0 +1,3 @@
+class PersonWithDefaultSchoolId < Person
+  default :school_id => 1
+end

data/test/fixtures/school.rb

@@ -0,0 +1,3 @@
+class School < ActiveRecord::Base
+  has_many :people
+end

data/test/fixtures/schools.yml

@@ -0,0 +1,3 @@
+riccarton:
+  id: 1
+  name: Riccarton

data/test/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/test/test_active_record_defaults.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require File.dirname(__FILE__) + '/abstract_unit.rb'
+ 
+class ActiveRecordDefaultsTest < Test::Unit::TestCase
+  fixtures :people, :schools
+  
+  def test_defaults_for_new_record
+    p = Person.new
+    
+    assert_equal 'Christchurch', p.city
+    assert_equal 'New Zealand', p.country
+    assert_equal 'Sean', p.first_name
+    assert_equal 'Fitzpatrick', p.last_name
+    assert_equal 2, p.lucky_number
+    assert_equal 'Blue', p.favourite_colour
+  end
+  
+  def test_default_ignored_if_key_present
+    p = Person.new(:city => '', 'lucky_number' => nil)
+    
+    assert_equal '', p.city
+    assert_equal nil, p.lucky_number
+    
+    assert_equal 'New Zealand', p.country
+    assert_equal 'Sean', p.first_name
+    assert_equal 'Fitzpatrick', p.last_name
+    assert_equal 'Blue', p.favourite_colour
+  end
+  
+  def test_existing_records_unchanged
+    assert_nil Person.find(1).last_name
+  end
+  
+  def test_default_relying_on_previous_default
+    assert_equal "Red", Person.new(:last_name => 'Carter').favourite_colour
+  end
+  
+  def test_defaults_on_create
+    p = Person.create!
+    
+    assert_equal 'Christchurch', p.city
+    assert_equal 'New Zealand', p.country
+    assert_equal 'Sean', p.first_name
+    assert_equal 'Fitzpatrick', p.last_name
+    assert_equal 2, p.lucky_number
+    assert_equal 'Blue', p.favourite_colour
+  end
+  
+  def test_default_belongs_to_association
+    assert_equal School.find(1), PersonWithDefaultSchool.new.school
+  end
+  
+  def test_specific_belongs_to_foreign_key_value_overrides_association_default
+    assert_nil PersonWithDefaultSchool.new(:school_id => nil).school
+  end
+  
+  def test_default_belongs_to_association_by_id
+    assert_equal School.find(1), PersonWithDefaultSchoolId.new.school
+  end
+  
+  def test_specific_belong_to_association_overrides_default_foreign_key_value
+    assert_nil PersonWithDefaultSchoolId.new(:school => nil).school
+  end
+  
+  def test_initialize_model_without_any_defaults
+    assert_nothing_raised { Group.new }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/active_record_defaults'

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: active_record_defaults
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- Jonathan Viney (aussiegeek)
+- C. Jason Harrelson (midas)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-13 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2"
+    version: 
+description: Allows you to easily specify default values for attributes on new model objects.
+email: jonathan.viney@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- History.txt
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- active_record_defaults.gemspec
+- lib/active_record/defaults.rb
+- lib/active_record_defaults.rb
+- script/console
+- script/destroy
+- script/generate
+- test/abstract_unit.rb
+- test/database.yml
+- test/fixtures/address.rb
+- test/fixtures/group.rb
+- test/fixtures/people.yml
+- test/fixtures/person.rb
+- test/fixtures/person_with_default_school.rb
+- test/fixtures/person_with_default_school_id.rb
+- test/fixtures/school.rb
+- test/fixtures/schools.yml
+- test/schema.rb
+- test/test_active_record_defaults.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/midas/active_record_defaults
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Easily specify default values for attributes on new model objects.
+test_files: 
+- test/abstract_unit.rb
+- test/fixtures/address.rb
+- test/fixtures/group.rb
+- test/fixtures/person.rb
+- test/fixtures/person_with_default_school.rb
+- test/fixtures/person_with_default_school_id.rb
+- test/fixtures/school.rb
+- test/schema.rb
+- test/test_active_record_defaults.rb
+- test/test_helper.rb