default_value_for 0.1.0 → 1.0.0

data/README.rdoc

@@ -163,11 +163,11 @@ It works with anything for which there's an assignment method:
   user.age    # => 20
   user.instance_variable_get('@registering')    # => true
 
-=== Default values are *not* duplicated
+=== Default values are duplicated
 
-The given default values are *not* duplicated when they are filled in, so if
-you mutate a value that was filled in with a default value, then it will affect
-all subsequent default values:
+The given default values are duplicated when they are filled in, so if
+you mutate a value that was filled in with a default value, then it will
+not affect all subsequent default values:
 
   class Author < ActiveRecord::Base
     # This model only has a 'name' attribute.
@@ -182,33 +182,44 @@ all subsequent default values:
   
   book1 = Book.new
   book1.author.name  # => nil
-  # This mutates the default value:
+  # This does not mutate the default value:
   book1.author.name = "John"
   
   book2 = Book.new
-  book2.author.name  # => "John"
+  book2.author.name  # => nil
+
+However the duplication is shallow. If you modify any objects that are
+referenced by the default value then it will affect subsequent default values:
+
+  class Author < ActiveRecord::Base
+    attr_accessor :useless_hash
+    default_value_for :useless_hash, { :foo => [] }
+  end
+  
+  author1 = Author.new
+  author1.useless_hash    # => { :foo => [] }
+  # This mutates the referred array:
+  author1.useless_hash[:foo] << 1
+  
+  author2 = Author.new
+  author2.useless_hash    # => { :foo => [1] }
 
 You can prevent this from happening by passing a block to +default_value_for+,
-which returns a new object instance every time:
+which returns a new object instance with fresh references every time:
 
-  class Book < ActiveRecord::Base
-    belongs_to :author
-    
-    default_value_for :author do
-      Author.new
+  class Author < ActiveRecord::Base
+    attr_accessor :useless_hash
+    default_value_for :useless_hash do
+      { :foo => [] }
     end
   end
   
-  book1 = Book.new
-  book1.author.name  # => nil
-  book1.author.name = "John"
+  author1 = Author.new
+  author1.useless_hash    # => { :foo => [] }
+  author1.useless_hash[:foo] << 1
   
-  book2 = Book.new
-  book2.author.name  # => nil
-
-The main reason why default values are not duplicated is because not all
-objects can be duplicated. For example, +Fixnum+ responds to +dup+, but calling
-+dup+ on a Fixnum will raise an exception.
+  author2 = Author.new
+  author2.useless_hash    # => { :foo => [] }
 
 === Caveats
 
@@ -249,16 +260,20 @@ can specify a default value in a migration as follows:
   create_table :users do |t|
     t.string    :username,  :null => false, :default => 'default username'
     t.integer   :age,       :null => false, :default => 20
-    t.timestamp :last_seen, :null => false, :default => Time.now
   end
 
-This has the same effect as passing the default value as the second argument to
+This has similar effects as passing the default value as the second argument to
 +default_value_for+:
 
+  default_value_for(:username, 'default_username')
+  default_value_for(:age, 20)
+
+Default values are filled in whether you use the schema defaults or the
+default_value_for defaults:
+
   user = User.new
   user.username   # => 'default username'
   user.age        # => 20
-  user.timestamp  # => Mon Sep 22 18:31:47 +0200 2008
 
 It's recommended that you use this over +default_value_for+ whenever possible.
 

data/Rakefile

@@ -1,24 +1,3 @@
-begin
-  require 'rake'
-rescue LoadError
-  require 'rubygems' 
-  require 'rake'
-end
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "default_value_for"
-    gemspec.summary = "Provides a way to specify default values for ActiveRecord models"
-    gemspec.description = "The default_value_for plugin allows one to define default values for ActiveRecord models in a declarative manner"
-    gemspec.email = "info@phusion.nl"
-    gemspec.homepage = "http://github.com/FooBarWidget/default_value_for"
-    gemspec.authors = ["Hongli Lai"]
-  end
-rescue LoadError
-  puts "default_value_for not available. Install it with: sudo gem install default_value_for"
-end
-
 task :default => :test
 
 desc "Run unit tests."

data/default_value_for.gemspec

@@ -0,0 +1,10 @@
+Gem::Specification.new do |s|
+  s.name = %q{default_value_for}
+  s.version = "1.0.0"
+  s.summary = %q{Provides a way to specify default values for ActiveRecord models}
+  s.description = %q{The default_value_for plugin allows one to define default values for ActiveRecord models in a declarative manner}
+  s.email = %q{info@phusion.nl}
+  s.homepage = %q{http://github.com/FooBarWidget/default_value_for}
+  s.authors = ["Hongli Lai"]
+  s.files = ['default_value_for.gemspec', 'init.rb', 'LICENSE.TXT', 'Rakefile', 'README.rdoc', 'test.rb']
+end

data/init.rb

@@ -1 +1,99 @@
-require 'lib/default_value_for.rb'
+# Copyright (c) 2008 Phusion
+# 
+# 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.
+
+module DefaultValueForPlugin
+	class NormalValueContainer
+		def initialize(value)
+			@value = value
+		end
+	
+		def evaluate(instance)
+			if @value.duplicable?
+				return @value.dup
+			else
+				return @value
+			end
+		end
+	end
+	
+	class BlockValueContainer
+		def initialize(block)
+			@block = block
+		end
+	
+		def evaluate(instance)
+			return @block.call(instance)
+		end
+	end
+	
+	module ClassMethods
+		def default_value_for(attribute, value = nil, &block)
+			if !method_defined?(:initialize_with_defaults)
+				include(InstanceMethods)
+				alias_method_chain :initialize, :defaults
+				class_inheritable_accessor :_default_attribute_values
+				self._default_attribute_values = ActiveSupport::OrderedHash.new
+			end
+			if block_given?
+				container = BlockValueContainer.new(block)
+			else
+				container = NormalValueContainer.new(value)
+			end
+			_default_attribute_values[attribute.to_s] = container
+		end
+		
+		def default_values(values)
+			values.each_pair do |key, value|
+				if value.kind_of? Proc
+					default_value_for(key, &value)
+				else
+					default_value_for(key, value)
+				end
+			end
+		end
+	end
+	
+	module InstanceMethods
+		def initialize_with_defaults(attrs = nil)
+			initialize_without_defaults(attrs) do
+				if attrs
+					stringified_attrs = attrs.stringify_keys
+					safe_attrs = if respond_to? :sanitize_for_mass_assignment
+						sanitize_for_mass_assignment(stringified_attrs)
+					else
+						remove_attributes_protected_from_mass_assignment(stringified_attrs)
+					end
+					safe_attribute_names = safe_attrs.keys.map do |x|
+						x.to_s
+					end
+				end
+				self.class._default_attribute_values.each do |attribute, container|
+					if safe_attribute_names.nil? || !safe_attribute_names.any? { |attr_name| attr_name =~ /^#{attribute}($|\()/ }
+						__send__("#{attribute}=", container.evaluate(self))
+						changed_attributes.delete(attribute)
+					end
+				end
+				yield(self) if block_given?
+			end
+		end
+	end
+end
+
+ActiveRecord::Base.extend(DefaultValueForPlugin::ClassMethods)

data/test.rb

@@ -255,7 +255,7 @@ class DefaultValuePluginTest < Test::Unit::TestCase
 		assert_equal(["type"], object.changed)
 	end
 	
-	def test_default_values_are_not_duplicated
+	def test_default_values_are_duplicated
 		define_model_class do
 			set_table_name "users"
 			default_value_for :username, "hello"
@@ -263,7 +263,19 @@ class DefaultValuePluginTest < Test::Unit::TestCase
 		user1 = TestClass.new
 		user1.username << " world"
 		user2 = TestClass.new
-		assert_equal("hello world", user2.username)
+		assert_equal("hello", user2.username)
+	end
+	
+	def test_default_values_are_shallow_copied
+		define_model_class do
+			set_table_name "users"
+			attr_accessor :hash
+			default_value_for :hash, { 1 => [] }
+		end
+		user1 = TestClass.new
+		user1.hash[1] << 1
+		user2 = TestClass.new
+		assert_equal([1], user2.hash[1])
 	end
 	
 	def test_constructor_does_not_affect_the_hash_passed_to_it

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: default_value_for
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Hongli Lai
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-20 00:00:00 +01:00
+date: 2010-08-29 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -19,42 +25,46 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE.TXT
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- .gitignore
+- default_value_for.gemspec
+- init.rb
 - LICENSE.TXT
-- README.rdoc
 - Rakefile
-- VERSION
-- init.rb
+- README.rdoc
 - test.rb
 has_rdoc: true
 homepage: http://github.com/FooBarWidget/default_value_for
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+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"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Provides a way to specify default values for ActiveRecord models

data/.gitignore

@@ -1 +0,0 @@
-test.sqlite3

data/VERSION

@@ -1 +0,0 @@
-0.1.0