virtus 0.0.9 → 0.0.10

data/.gitignore

@@ -0,0 +1,11 @@
+doc
+.yardoc
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+measurements/
+tmp/
+profiling/
+development
+.rbx/

data/.travis.yml

@@ -13,7 +13,6 @@ env:
   - JRUBY_OPTS="--1.8"
   - JRUBY_OPTS="--1.9"
   - RBXOPT="-X18"
-  - RBXOPT="-X19"
 matrix:
   exclude:
     # exclude 1.8.7

data/{History.md → Changelog.md}

@@ -1,15 +1,22 @@
-# v0.0.8 to-be-released
+# v0.0.10 to-be-released
+
+* [fixed] Default values are now duped on evaluate (rclosner)
+* [fixed] Allow to override attribute mutator methods (senny)
+
+[Compare v0.0.9..master](https://github.com/solnic/virtus/compare/v0.0.9...master)
+
+# v0.0.9 2011-10-11
 
 * [fixed] Fix in type lookup for anonymous classes (dkubb)
 
-[Compare v0.0.8..master](https://github.com/solnic/virtus/compare/v0.0.8...master)
+[Compare v0.0.8..v0.0.9](https://github.com/solnic/virtus/compare/v0.0.8...v0.0.9)
 
 # v0.0.8 2011-08-25
 
 * [fixed] Fixed conflict with ActiveModel (RichGuk)
 * [changed] Renamed Coercion::String.to_class => Coercion::String.to_constant (emmanuel)
 
-[Compare v0.0.7..master](https://github.com/solnic/virtus/compare/v0.0.7...v0.0.8)
+[Compare v0.0.7..v0.0.8](https://github.com/solnic/virtus/compare/v0.0.7...v0.0.8)
 
 # v0.0.7 2011-07-31
 

data/Gemfile

@@ -1,10 +1,6 @@
 source :rubygems
 
-group :development do
-  gem 'backports', '~> 2.3.0'
-  gem 'jeweler',   '~> 1.6.4'
-  gem 'rspec',     '~> 2.6.0'
-end
+gemspec
 
 group :metrics do
   gem 'flay',      '~> 1.4.2'
@@ -12,9 +8,11 @@ group :metrics do
   gem 'reek',      '~> 1.2.8', :git => 'git://github.com/dkubb/reek.git'
   gem 'roodi',     '~> 2.1.0'
   gem 'yardstick', '~> 0.4.0'
+  gem 'fattr'
+  gem 'arrayfields'
+  gem 'map'
 
   platforms :mri_18 do
-    gem 'heckle',    '~> 1.4.3'
     gem 'json',      '~> 1.5.3'
     gem 'metric_fu', '~> 2.1.1'
     gem 'mspec',     '~> 1.5.17'

data/README.md

@@ -1,4 +1,7 @@
-# Virtus [![Build Status](http://travis-ci.org/solnic/virtus.png)](http://travis-ci.org/solnic/virtus)
+virtus
+======
+
+[![Build Status](http://travis-ci.org/solnic/virtus.png)](http://travis-ci.org/solnic/virtus)
 
 This is a partial extraction of the DataMapper [Property
 API](http://rubydoc.info/github/datamapper/dm-core/master/DataMapper/Property)
@@ -8,123 +11,159 @@ reinventing the wheel all over again. It is also suitable for any other
 usecase where you need to extend your ruby objects with attributes that require
 data type coercions.
 
-## Installation
+Installation
+------------
 
-    gem i virtus
+``` terminal
+$ gem install virtus
+```
 
-## Basic Usage
+or
 
-    require 'virtus'
+``` ruby
+# ./Gemfile
 
-    class User
-      include Virtus
+gem 'virtus', '0.0.7'
+```
 
-      attribute :name,     String
-      attribute :age,      Integer
-      attribute :birthday, DateTime
-    end
+Examples
+--------
 
-    # setting attributes in the constructor
-    user = User.new(:name => 'Piotr', :age => 28)
 
-    # attribute readers
-    user.name  # => "Piotr"
+``` ruby
+require 'virtus'
 
-    # hash of attributes
-    user.attributes  # => { :name => "Piotr" }
+class User
+  include Virtus
 
-    # automatic coercion
-    user.age = '28'
-    user.age  # => 28
+  attribute :name, String
+  attribute :age, Integer
+  attribute :birthday, DateTime
+end
 
-    user.birthday = 'November 18th, 1983'
-    user.birthday  # => #<DateTime: 1983-11-18T00:00:00+00:00 (4891313/2,0/1,2299161)>
+user = User.new :name => 'Piotr', :age => 28
+user.attributes
+  # => { :name => "Piotr", :age => 28 }
 
-## Default values
+user.name
+  # => "Piotr"
 
-    require 'virtus'
+user.age = '28'
+  # => 28
+user.age.class
+  # => Fixnum
 
-    class Page
-      include Virtus
+user.birthday = 'November 18th, 1983'
+  # => #<DateTime: 1983-11-18T00:00:00+00:00 (4891313/2,0/1,2299161)>
+```
 
-      attribute :title,      String
-      attribute :slug,       String,  :default => lambda { |post, attribute| post.title.downcase.gsub(' ', '-') }
-      attribute :view_count, Integer, :default => 0
-    end
 
-    page = Page.new(:title => 'Virtus Is Awesome')
-    page.slug # => 'virtus-is-awesome'
-    page.view_count # => 0
+**Default values**
 
-## Coercions
+``` ruby
+require 'virtus'
 
-Virtus comes with a builtin coercion library. It's super easy to add your own
-coercion classes. Take a look:
+class Page
+  include Virtus
 
-    require 'virtus'
-    require 'digest/md5'
+  attribute :title, String
+  attribute :views, Integer, :default => 0
+  attribute :slug, String, :default => lambda { |page, attribute| page.title.downcase.gsub(' ', '-') }
+end
 
-    class MD5 < Virtus::Attribute::Object
-     primitive       String
-     coercion_method :to_md5
-    end
+page = Page.new :title => 'Virtus Is Awesome'
+page.slug
+  # => 'virtus-is-awesome'
+page.views
+  # => 0
+```
 
-    module Virtus
-     class Coercion
-       class String < Virtus::Coercion::Object
-         def self.to_md5(value)
-           Digest::MD5.hexdigest(value)
-         end
-       end
-     end
-    end
+**Adding Coercions**
+
+Virtus comes with a builtin coercion library.
+It's super easy to add your own coercion classes.
+Take a look:
+
+``` ruby
+require 'virtus'
+require 'digest/md5'
 
-    class User
-      include Virtus
+# Our new attribute type
+class MD5 < Virtus::Attribute::Object
+  primitive String
+  coercion_method :to_md5
+end
 
-      attribute :name,     String
-      attribute :password, MD5
+# Defining the Coercion method
+module Virtus
+  class Coercion
+    class String < Virtus::Coercion::Object
+      def self.to_md5(value)
+        Digest::MD5.hexdigest value
+      end
     end
+  end
+end
 
-    user = User.new(:name => 'Piotr', :password => 'foobar')
-    user.name     # => 'Piotr'
-    user.password # => '3858f62230ac3c915f300c664312c63f'
+# And now the user!
+class User
+  include Virtus
 
-## Custom Attributes
+  attribute :name, String
+  attribute :password, MD5
+end
 
-    require 'virtus'
-    require 'json'
+user = User.new :name => 'Piotr', :password => 'foobar'
+user.name
+  # => 'Piotr'
+user.password
+  # => '3858f62230ac3c915f300c664312c63f'
+```
 
-    module MyApp
-      module Attributes
-        class JSON < Virtus::Attribute::Object
-          primitive Hash
+**Custom Attributes**
 
-          def coerce(value)
-            ::JSON.parse(value)
-          end
-        end
-      end
+``` ruby
+require 'virtus'
+require 'json'
 
-      class User
-        include Virtus
+module MyAppClass
 
-        attribute :info, Attributes::JSON
+  # Defining the custom attribute(s)
+  module Attributes
+    class JSON < Virtus::Attribute::Object
+      primitive Hash
+
+      def coerce(value)
+        ::JSON.parse value
       end
     end
+  end
+
+  class User
+    include Virtus
 
-    user = MyApp::User.new
+    attribute :info, Attributes::JSON
+  end
+end
 
-    user.info = '{"email":"john@domain.com"}'
-    user.info  # => {"email"=>"john@domain.com"}
+user = MyApp::User.new
+user.info = '{"email":"john@domain.com"}'
+  # => {"email"=>"john@domain.com"}
+user.info.class
+  # => Hash
+```
 
-## Contributors
+
+Credits
+-------
 
 * Dan Kubb ([dkubb](https://github.com/dkubb))
 * Chris Corbyn ([d11wtq](https://github.com/d11wtq))
 * Emmanuel Gomez ([emmanuel](https://github.com/emmanuel))
 
-## Note on Patches/Pull Requests
+
+Contributing
+-------------
 
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -134,6 +173,26 @@ coercion classes. Take a look:
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-## Copyright
-
-Copyright (c) 2011 Piotr Solnica. See LICENSE for details.
+License
+-------
+
+Copyright (c) 2011 Piotr Solnica
+
+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

@@ -1,21 +1,7 @@
 require 'rubygems'
 require 'rake'
-require 'jeweler'
-require 'rspec/core/rake_task'
-
-Jeweler::Tasks.new do |gem|
-  gem.name        = 'virtus'
-  gem.platform    = Gem::Platform::RUBY
-  gem.authors     = [ 'Piotr Solnica' ]
-  gem.email       = [ 'piotr@rubyverse.com' ]
-  gem.homepage    = 'https://github.com/solnic/virtus'
-  gem.summary     = 'Attributes for your plain ruby objects'
-  gem.description = gem.summary
-end
-
-Jeweler::GemcutterTasks.new
 
 FileList['tasks/**/*.rake'].each { |task| import task }
 
-desc 'Default: run specs.'
+desc 'Default: run all specs'
 task :default => :spec

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
 threshold: 20
-total_score: 261
+total_score: 257

data/config/roodi.yml

@@ -5,7 +5,7 @@ CaseMissingElseCheck:            { }
 ClassLineCountCheck:             { line_count: 309 }
 ClassNameCheck:                  { pattern: !ruby/regexp /\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/ }
 ClassVariableCheck:              { }
-CyclomaticComplexityBlockCheck:  { complexity: 2 }
+CyclomaticComplexityBlockCheck:  { complexity: 4 }
 CyclomaticComplexityMethodCheck: { complexity: 4 }
 EmptyRescueBodyCheck:            { }
 ForLoopCheck:                    { }

data/config/site.reek

@@ -26,7 +26,11 @@ LongParameterList:
   enabled: true
   overrides: {}
 FeatureEnvy:
-  exclude: [Virtus::Coercion::TimeCoercions#to_string, Virtus::Coercion::TimeCoercions#coerce_with_method]
+  exclude: [
+    Virtus::Coercion::TimeCoercions#to_string,
+    Virtus::Coercion::TimeCoercions#coerce_with_method,
+    Virtus::TypeLookup#determine_type_from_primitive
+  ]
   enabled: true
 ClassVariable:
   exclude: []
@@ -55,7 +59,9 @@ LongMethod:
   enabled: true
 Duplication:
   allow_calls: []
-  exclude: []
+  exclude: [
+    Virtus::Attribute::DefaultValue#evaluate
+  ]
   enabled: true
   max_calls: 1
 UtilityFunction:

data/examples/custom_coercion_spec.rb

@@ -1,6 +1,6 @@
 require './spec/spec_helper'
 
-class MD5 < Virtus::Attribute::Object
+class Md5 < Virtus::Attribute::Object
   primitive       String
   coercion_method :to_md5
 end
@@ -19,7 +19,7 @@ class User
   include Virtus
 
   attribute :name,     String
-  attribute :password, MD5
+  attribute :password, Md5
 end
 
 describe User do

data/examples/override_attribute_methods_spec.rb

@@ -0,0 +1,40 @@
+require './spec/spec_helper'
+
+class Article
+  include Virtus
+
+  attribute :author, String
+
+  def author
+    super || '<unknown>'
+  end
+
+  def author=(name)
+    super unless name == 'Brad'
+  end
+
+end
+
+describe Article, 'override' do
+
+  it 'Alice is an allowed author' do
+    Article.new(:author => 'Alice').author.should == 'Alice'
+  end
+
+  it 'Brad isn not an allowed author' do
+    Article.new(:author => 'Brad').author.should == '<unknown>'
+  end
+
+  context 'with author' do
+    subject { Article.new(:author => 'John') }
+
+    its(:author) { should == 'John' }
+  end
+
+  context 'without author' do
+    subject { Article.new }
+
+    its(:author) { should == '<unknown>' }
+  end
+
+end