attribute-defaults 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+spec/tmp

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+group :test do
+  gem 'activerecord', '3.0.0'
+  gem 'activesupport', '3.0.0'
+  gem "sqlite3-ruby"
+  gem "rspec", "~> 2.0.0.beta"
+end

data/Gemfile.lock

@@ -0,0 +1,39 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    i18n (0.4.1)
+    rspec (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+      rspec-mocks (= 2.0.0.beta.22)
+    rspec-core (2.0.0.beta.22)
+    rspec-expectations (2.0.0.beta.22)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+    sqlite3-ruby (1.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 3.0.0)
+  activesupport (= 3.0.0)
+  rspec (~> 2.0.0.beta)
+  sqlite3-ruby

data/README.rdoc

@@ -0,0 +1,110 @@
+= Attribute Defaults (attribute-defaults)
+
+Simple ActiveRecord plugin that allows to specify default values for attributes.
+
+== Installation
+
+Just add <tt>gem attribute-defaults</tt> to your Gemfile.
+
+Alternatively, run <tt>sudo gem install attribute-defaults</tt> and add
+<tt>require 'attribute_defaults'</tt> to your app.
+
+== Examples
+
+First, a simple case ...
+
+  class Foo < ActiveRecord::Base
+    attr_default :age, 18
+    attr_default :last_seen do
+      Time.now
+    end
+  end
+  Foo.new # => age: 18, last_seen: '2010-09-15 10:30'
+
+... or the same via mass-definition ...
+
+  class Foo < ActiveRecord::Base
+    attr_defaults :age => 18, :last_seen => lambda { Time.now }
+  end
+  Foo.new # => age: 18, last_seen: '2010-09-15 10:30'
+
+It doesn't override values that are already set ...
+
+  class Foo < ActiveRecord::Base
+    attr_defaults :age => 18
+  end
+  Foo.new(:age => 25) # => age: 25
+
+... but allows you to force overrides when e.g. blank ...
+
+  class Foo < ActiveRecord::Base
+    attr_defaults  :name => { :default => 'MUST HAVE', :force => :blank }
+  end
+  Foo.new(:name => '') # => name: 'MUST HAVE'
+
+... and it respects protected attributes ...
+
+  class Foo < ActiveRecord::Base
+    attr_protected :age
+    attr_defaults  :age => 18
+  end
+  Foo.new(:age => 25) # => age: 18
+
+When attributes aren't database columns ...
+
+  class Foo < ActiveRecord::Base
+    attr_accessor  :birth_year
+    attr_defaults  :birth_year => lambda {|r| r.age ? Time.now.year - r.age : nil }
+  end
+  Foo.new(:age => 30) # => age: 30, birth_year: 1980
+
+It works with persisted records ...
+
+  # DB table 'foos': [{id: 1, age: NULL}, {id: 2, age: 25}]
+  class Foo < ActiveRecord::Base
+    attr_defaults  :age => 18
+  end
+  Foo.all # => [{id: 1, age: 18}, {id: 2, age: 25}]
+
+... or not ...
+
+  class Foo < ActiveRecord::Base
+    attr_defaults  :age => { :default => 18, :persisted => false }
+  end
+  Foo.all # => [{id: 1, age: nil}, {id: 2, age: 25}]
+
+To specify a Hash as a default value, use ...
+
+  class Foo < ActiveRecord::Base
+    attr_accessor  :some_hash
+    attr_default   :some_hash, :default => {}
+  end
+  Foo.new.some_hash # => {}
+
+== Acknowledgements
+
+Inspired by the default_value_for plugin
+http://github.com/FooBarWidget/default_value_for
+
+= LICENSE
+
+(The MIT License)
+
+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/Rakefile

@@ -0,0 +1,25 @@
+require 'rake'
+require 'rspec/mocks/version'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Default: run specs.'
+task :default => :spec
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "attribute-defaults"
+    gemspec.summary = "Specify default values for attributes"
+    gemspec.description = "Simple ActiveRecord plugin that allows to specify default values for attributes"
+    gemspec.email = "dimitrij@blacksquaremedia.com"
+    gemspec.homepage = "http://github.com/bsm/attribute-defaults"
+    gemspec.authors = ["Dimitrij Denissenko"]
+    gemspec.add_runtime_dependency "activerecord", ">= 3.0.0"
+    gemspec.add_runtime_dependency "activesupport", ">= 3.0.0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

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

data/lib/attribute-defaults.rb

@@ -0,0 +1 @@
+require 'attribute_defaults'

data/lib/attribute_defaults.rb

@@ -0,0 +1,57 @@
+module ActiveRecord
+  module AttributesWithDefaults
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      # Set defaults. Examples:
+      #   attr_default    :age, 12
+      #   attr_default    :description, '(none)'
+      #   attr_default    :age do |record|
+      #     Time.zone.year - record.dob.year
+      #   end
+      #   attr_default    :description, '(none)', :if => :blank
+      #   attr_default    :description, '(none)', :persisted => false
+      #   attr_default    :description, :default => '(none)', :persisted => false
+      def attr_default(sym, *args, &block)
+        options = args.extract_options!
+        default = options.delete(:default) || args.shift
+        raise 'Default value or block required' unless !default.nil? || block
+
+        evaluator = "__eval_attr_default_for_#{sym}".to_sym
+        setter    = "__set_attr_default_for_#{sym}".to_sym
+        block   ||= default.is_a?(Proc) ? default : Proc.new { default }
+
+        after_initialize setter.to_sym
+        define_method(evaluator, &block)
+
+        module_eval(<<-EVAL, __FILE__, __LINE__ + 1)
+          def #{setter}
+            #{'return if persisted?' if options[:persisted] == false}
+            return unless self.#{sym}.send(#{options[:force] == :blank ? ':blank?' : ':nil?'})
+            value = #{evaluator}(self)
+            self.#{sym} = value.duplicable? ? value.dup : value
+          rescue ActiveModel::MissingAttributeError
+          end
+        EVAL
+        private evaluator, setter
+      end
+
+      # Default mass-assignment. Examples:
+      #   attr_defaults   :description => '(none)', :age => 12
+      #   attr_defaults   :description => '(none)', :age => lambda {|r| Time.zone.year - r.dob.year }
+      #   attr_defaults   :description => '(none)', :age => { :default => 12, :persisted => false }
+      def attr_defaults(pairs)
+        pairs.each do |pair|
+          attr_default *pair
+        end
+      end
+
+    end
+  end
+
+  class Base
+    include AttributesWithDefaults
+  end
+
+end

data/spec/attribute_defaults_spec.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe ActiveRecord::AttributesWithDefaults do
+
+  def foo(options = {})
+    @foo ||= Foo.new options.reverse_merge(:age => 30)
+  end
+
+  def bar(options = {})
+    @bar ||= Bar.new options.reverse_merge(:age => 30)
+  end
+
+  def baz(options = {})
+    @baz ||= Baz.new
+  end
+
+  it 'should initialize records setting defaults' do
+    foo.description.should == '(no description)'
+    foo.locale.should == 'en'
+    foo.birth_year.should == 30.years.ago.year
+  end
+
+  it 'should allow to foce overrides on blank values' do
+    foo(:locale => '', :description => '')
+    foo.locale.should == ''
+    foo.description.should == '(no description)'
+  end
+
+  it 'should not override attributes that were set manually' do
+    foo(:locale => 'en-GB').locale.should == 'en-GB'
+  end
+
+  it 'should respect :persisted => false option' do
+    persisted = Foo.first
+    persisted.description.should == '(no description)'
+    persisted.locale.should be_nil
+  end
+
+  it 'should work with protected attributes' do
+    foo(:description => 'Custom').description.should == '(no description)'
+  end
+
+  it 'should correctly apply defaults in subclasses' do
+    bar.description.should == '(no description)'
+    bar.locale.should == 'en'
+    bar.birth_year.should == 30.years.ago.year
+  end
+
+  it 'should allow mass-assignment' do
+    baz.description.should == 'Please set ...'
+    baz.locale.should == 'en-US'
+    baz.age.should == 18
+
+    persisted = Baz.first
+    persisted.age.should be_nil
+  end
+
+  it 'should allow Hashes as default values' do
+    bar.some_hash.should == {}
+  end
+
+  it 'should ensure default values are duplicated' do
+    bar.some_hash[:a] = 'A'
+    bar.some_hash.should == {:a => 'A'}
+    Bar.new.some_hash.should == {}
+  end
+
+  it 'should handle missing attributes (e.g. in case of Base#exists?)' do
+    lambda { Foo.exists? }.should_not raise_error
+    lambda { Foo.select(:locale).first }.should_not raise_error
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+$: << File.dirname(__FILE__) + '/../lib'
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+Bundler.require :default, :test
+
+require 'active_support'
+require 'active_record'
+require 'rspec'
+require 'fileutils'
+require 'attribute_defaults'
+
+SPEC_DATABASE = File.dirname(__FILE__) + '/tmp/test.sqlite3'
+
+RSpec.configure do |c|
+
+  c.before do
+    FileUtils.mkdir_p File.dirname(SPEC_DATABASE)
+    base = ActiveRecord::Base
+    base.establish_connection('adapter' => 'sqlite3', 'database' => SPEC_DATABASE)
+    base.connection.create_table :foos do |t|
+      t.string   :name
+      t.integer  :age
+      t.string   :locale
+      t.string   :description
+      t.timestamps
+    end
+    Foo.create!(:name => 'Bogus') {|f| f.description = nil; f.locale = nil }
+  end
+
+  c.after do
+    FileUtils.rm_f(SPEC_DATABASE)
+  end
+
+end
+
+class Foo < ActiveRecord::Base
+  attr_accessible :name, :age, :locale
+  attr_accessor   :birth_year
+
+  attr_default    :description, "(no description)", :force => :blank
+  attr_default    :locale, "en", :persisted => false
+  attr_default    :birth_year do |f|
+    f.age ? Time.now.year - f.age : nil
+  end
+end
+
+class Bar < Foo
+  attr_accessor   :some_hash
+  attr_default    :some_hash, :default => {}
+end
+
+class Baz < ActiveRecord::Base
+  set_table_name 'foos'
+  attr_defaults :description => "Please set ...", :age => { :default => 18, :persisted => false }, :locale => lambda { 'en-US' }
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: attribute-defaults
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dimitrij Denissenko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-15 00:00:00 +01: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: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+description: Simple ActiveRecord plugin that allows to specify default values for attributes
+email: dimitrij@blacksquaremedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/attribute-defaults.rb
+- lib/attribute_defaults.rb
+- spec/attribute_defaults_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/bsm/attribute-defaults
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.7
+signing_key: 
+specification_version: 3
+summary: Specify default values for attributes
+test_files: 
+- spec/attribute_defaults_spec.rb
+- spec/spec_helper.rb