virtus 0.5.5 → 1.0.0.beta3

data/.rspec

@@ -1,2 +1,2 @@
 --color
---profile
+--order random

data/.ruby-gemset

@@ -0,0 +1 @@
+virtus

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/.travis.yml

@@ -1,19 +1,17 @@
 language: ruby
-bundler_args: --without guard metrics
+before_install: gem install bundler
+bundler_args: --without yard guard benchmarks
 script: "bundle exec rake spec"
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
-  - jruby-18mode
+  - 2.0.0
   - jruby-19mode
-  - rbx-18mode
   - rbx-19mode
-  - ree
-  - jruby-head
+  - ruby-head
 matrix:
   allow_failures:
-    - rvm: jruby-head
+    - rvm: ruby-head
+    - rvm: rbx-19mode
 notifications:
   email:
     - piotr.solnica@gmail.com

data/Gemfile

@@ -2,6 +2,12 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'devtools', :git => 'https://github.com/datamapper/devtools'
+gem 'bogus', '~> 0.1'
 
-eval File.read('Gemfile.devtools')
+gem 'axiom-types', :git => 'https://github.com/dkubb/axiom-types'
+
+gem 'devtools', :git => 'https://github.com/rom-rb/devtools', branch: 'master'
+
+eval_gemfile 'Gemfile.devtools'
+
+gem 'mutant', git: 'https://github.com/solnic/mutant.git', branch: 'auto-expand-scope'

data/Gemfile.devtools

@@ -1,52 +1,46 @@
 # encoding: utf-8
 
 group :development do
-  gem 'rake',  '~> 10.0.4'
-  gem 'rspec', '~> 2.13.0'
-  gem 'yard',  '~> 0.8.6.1'
+  gem 'rake',  '~> 10.1.0'
+  gem 'rspec', '~> 2.14.1'
+  gem 'yard',  '~> 0.8.7'
 end
 
 group :yard do
-  gem 'kramdown', '~> 1.0.1'
+  gem 'kramdown', '~> 1.2.0'
 end
 
 group :guard do
-  gem 'guard',         '~> 1.8.0'
+  gem 'guard',         '~> 1.8.1'
   gem 'guard-bundler', '~> 1.0.0'
-  gem 'guard-rspec',   '~> 2.5.4'
+  gem 'guard-rspec',   '~> 3.0.2'
+  gem 'guard-rubocop', '~> 0.2.0'
+  gem 'guard-mutant',  '~> 0.0.1'
 
   # file system change event handling
-  gem 'listen',     '~> 1.0.2'
-  gem 'rb-fchange', '~> 0.0.6', :require => false
-  gem 'rb-fsevent', '~> 0.9.3', :require => false
-  gem 'rb-inotify', '~> 0.9.0', :require => false
+  gem 'listen',     '~> 1.3.0'
+  gem 'rb-fchange', '~> 0.0.6', require: false
+  gem 'rb-fsevent', '~> 0.9.3', require: false
+  gem 'rb-inotify', '~> 0.9.0', require: false
 
   # notification handling
-  gem 'libnotify',               '~> 0.8.0', :require => false
-  gem 'rb-notifu',               '~> 0.0.4', :require => false
-  gem 'terminal-notifier-guard', '~> 1.5.3', :require => false
+  gem 'libnotify',               '~> 0.8.0', require: false
+  gem 'rb-notifu',               '~> 0.0.4', require: false
+  gem 'terminal-notifier-guard', '~> 1.5.3', require: false
 end
 
 group :metrics do
-  gem 'backports',       '~> 3.3', '>= 3.3.0'
-  gem 'coveralls',       '~> 0.6.6'
-  gem 'flay',            '~> 2.2.0'
-  gem 'flog',            '~> 4.0.0'
-  gem 'reek',            '~> 1.3.1', :git => 'https://github.com/troessner/reek.git'
-  gem 'simplecov',       '~> 0.7.1'
-  gem 'yardstick',       '~> 0.9.6'
-
-  platforms :ruby_19 do
+  gem 'coveralls', '~> 0.6.7'
+  gem 'flay',      '~> 2.4.0'
+  gem 'flog',      '~> 4.1.1'
+  gem 'reek',      '~> 1.3.2'
+  gem 'rubocop',   '~> 0.13.0'
+  gem 'simplecov', '~> 0.7.1'
+  gem 'yardstick', '~> 0.9.7', git: 'https://github.com/dkubb/yardstick.git'
+
+  platforms :ruby_19, :ruby_20 do
     gem 'yard-spellcheck', '~> 0.1.5'
   end
-
-  platforms :mri_19, :rbx do
-    gem 'mutant', '~> 0.2.20'
-  end
-
-  platforms :rbx do
-    gem 'pelusa', '~> 0.2.2'
-  end
 end
 
 group :benchmarks do

data/Guardfile

@@ -1,8 +1,19 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
+guard :rspec, spec_paths: 'spec/unit' do
+  #run all specs if configuration is modified
+  watch('Guardfile')           { 'spec' }
+  watch('Gemfile.lock')        { 'spec' }
+  watch('spec/spec_helper.rb') { 'spec' }
 
-guard 'rspec', :version => 1 do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  # run all specs if supporting files files are modified
+  watch(%r{\Aspec/(?:lib|support|shared)/.+\.rb\z}) { 'spec' }
+
+  # run unit specs if associated lib code is modified
+  watch(%r{\Alib/(.+)\.rb\z})                                         { |m| Dir["spec/unit/#{m[1]}"]         }
+  watch(%r{\Alib/(.+)/support/(.+)\.rb\z})                            { |m| Dir["spec/unit/#{m[1]}/#{m[2]}"] }
+  watch("lib/#{File.basename(File.expand_path('../', __FILE__))}.rb") { 'spec'                               }
+
+  # run a spec if it is modified
+  watch(%r{\Aspec/(?:unit|integration)/.+_spec\.rb\z})
+
+  notification :tmux, :display_message => true
 end

data/README.md

@@ -1,9 +1,17 @@
 Virtus
 ======
 
-[![Build Status](https://secure.travis-ci.org/solnic/virtus.png)](http://travis-ci.org/solnic/virtus)
-[![Dependency Status](https://gemnasium.com/solnic/virtus.png)](https://gemnasium.com/solnic/virtus)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/solnic/virtus)
+[![Gem Version](https://badge.fury.io/rb/virtus.png)][gem]
+[![Build Status](https://secure.travis-ci.org/solnic/virtus.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/solnic/virtus.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/solnic/virtus.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/solnic/virtus/badge.png?branch=master)][coveralls]
+
+[gem]: https://rubygems.org/gems/virtus
+[travis]: https://travis-ci.org/solnic/virtus
+[gemnasium]: https://gemnasium.com/solnic/virtus
+[codeclimate]: https://codeclimate.com/github/solnic/virtus
+[coveralls]: https://coveralls.io/r/solnic/virtus
 
 This is a partial extraction of the DataMapper [Property
 API](http://rubydoc.info/github/datamapper/dm-core/master/DataMapper/Property)
@@ -35,19 +43,19 @@ You can create classes extended with virtus and define attributes:
 
 ``` ruby
 class User
-  include Virtus
+  include Virtus.model
 
   attribute :name, String
   attribute :age, Integer
   attribute :birthday, DateTime
 end
 
-user = User.new(:name => 'Piotr', :age => 28)
-user.attributes # => { :name => "Piotr", :age => 28 }
+user = User.new(:name => 'Piotr', :age => 29)
+user.attributes # => { :name => "Piotr", :age => 29 }
 
 user.name # => "Piotr"
 
-user.age = '28' # => 28
+user.age = '29' # => 29
 user.age.class # => Fixnum
 
 user.birthday = 'November 18th, 1983' # => #<DateTime: 1983-11-18T00:00:00+00:00 (4891313/2,0/1,2299161)>
@@ -58,6 +66,51 @@ user.name # => "Jane"
 user.age  # => 21
 ```
 
+### Cherry-picking extensions
+
+``` ruby
+# include just the attribute DSL
+class User
+  include Virtus::Model::Core
+
+  attribute :name, String
+end
+
+user = User.new
+user.name = 'Piotr'
+
+# include attribute DSL + constructor
+class User
+  include Virtus::Model::Core
+  include Virtus::Model::Constructor
+
+  attribute :name, String
+end
+
+User.new(:name => 'Piotr')
+
+# include attribute DSL + constructor + mass-assignment
+class User
+  include Virtus::Model::Core
+  include Virtus::Model::Constructor
+  include Virtus::Model::MassAssignment
+
+  attribute :name, String
+end
+
+user = User.new(:name => 'Piotr')
+user.attributes = { :name => 'John' }
+user.attributes
+# => {:name => 'John'}
+
+# starting from virtus 1.0.0 preffered way to do this is to use module builder
+MyModel = Virtus.model(:constructor => false, :mass_assignment => false)
+
+class User
+  include MyModel
+end
+```
+
 ### Using Virtus with Modules
 
 You can create modules extended with virtus and define attributes for later
@@ -65,13 +118,13 @@ inclusion in your classes:
 
 ```ruby
 module Name
-  include Virtus
+  include Virtus.module
 
   attribute :name, String
 end
 
 module Age
-  include Virtus
+  include Virtus.module(:coerce => false)
 
   attribute :age, Integer
 end
@@ -80,7 +133,7 @@ class User
   include Name, Age
 end
 
-user = User.new(:name => 'John', :age => '30')
+user = User.new(:name => 'John', :age => 30)
 ```
 
 ### Dynamically Extending Instances
@@ -93,7 +146,7 @@ class User
 end
 
 user = User.new
-user.extend(Virtus)
+user.extend(Virtus.model)
 user.attribute :name, String
 user.name = 'John'
 user.name # => 'John'
@@ -103,7 +156,7 @@ user.name # => 'John'
 
 ``` ruby
 class Page
-  include Virtus
+  include Virtus.model
 
   attribute :title, String
 
@@ -129,19 +182,24 @@ page.slug         # => 'virtus-readme'
 page.views        # => 0
 page.published    # => false
 page.editor_title # => "UNPUBLISHED: Virtus README"
+
+page.views = 10
+page.views                    # => 10
+page.reset_attribute(:views)  # => 0
+page.views                    # => 0
 ```
 
 ### Embedded Value
 
 ``` ruby
 class City
-  include Virtus
+  include Virtus.model
 
   attribute :name, String
 end
 
 class Address
-  include Virtus
+  include Virtus.model
 
   attribute :street,  String
   attribute :zipcode, String
@@ -149,7 +207,7 @@ class Address
 end
 
 class User
-  include Virtus
+  include Virtus.model
 
   attribute :name,    String
   attribute :address, Address
@@ -167,7 +225,7 @@ user.address.city.name # => "NYC"
 ``` ruby
 # Support "primitive" classes
 class Book
-  include Virtus
+  include Virtus.model
 
   attribute :page_numbers, Array[Integer]
 end
@@ -177,7 +235,7 @@ book.page_numbers # => [1, 2, 3]
 
 # Support EmbeddedValues, too!
 class Address
-  include Virtus
+  include Virtus.model
 
   attribute :address,     String
   attribute :locality,    String
@@ -186,13 +244,13 @@ class Address
 end
 
 class PhoneNumber
-  include Virtus
+  include Virtus.model
 
   attribute :number, String
 end
 
 class User
-  include Virtus
+  include Virtus.model
 
   attribute :phone_numbers, Array[PhoneNumber]
   attribute :addresses,     Set[Address]
@@ -214,7 +272,7 @@ user.addresses # => #<Set: {#<Address:0x007fdb2d3be448 @address="1234 Any St.",
 
 ``` ruby
 class Package
-  include Virtus
+  include Virtus.model
 
   attribute :dimensions, Hash[Symbol => Float]
 end
@@ -232,13 +290,13 @@ Here's an example:
 
 ``` ruby
 class Book
-  include Virtus
+  include Virtus.model
 
   attribute :title, String
 end
 
 class Library
-  include Virtus
+  include Virtus.model
 
   attribute :books, Array[Book]
 end
@@ -257,7 +315,7 @@ mutation methods that perform coercions. For example:
 
 ``` ruby
 class Book
-  include Virtus
+  include Virtus.model
 
   attribute :title, String
 end
@@ -273,7 +331,7 @@ class BookCollection < Array
 end
 
 class Library
-  include Virtus
+  include Virtus.model
 
   attribute :books, BookCollection[Book]
 end
@@ -286,17 +344,21 @@ library.books << { :title => 'Another Introduction to Virtus' }
 
 ``` ruby
 class GeoLocation
-  include Virtus::ValueObject
+  include Virtus.value_object
 
-  attribute :latitude,  Float
-  attribute :longitude, Float
+  values do
+    attribute :latitude,  Float
+    attribute :longitude, Float
+  end
 end
 
 class Venue
-  include Virtus
+  include Virtus.value_object
 
-  attribute :name,     String
-  attribute :location, GeoLocation
+  values do
+    attribute :name,     String
+    attribute :location, GeoLocation
+  end
 end
 
 venue = Venue.new(
@@ -315,75 +377,151 @@ venue_other = Venue.new(
 venue.location === venue_other.location # => true
 ```
 
-### Adding Coercions
+### Custom Coercions
+
+``` ruby
+require 'json'
+
+class Json < Virtus::Attribute
+  def coerce(value)
+    value.is_a?(::Hash) ? value : JSON.parse(value)
+  end
+end
+
+class User
+  include Virtus.model
+
+  attribute :info, Json
+end
+
+user = User.new
+user.info = '{"email":"john@domain.com"}' # => {"email"=>"john@domain.com"}
+user.info.class # => Hash
+
+# With a custom attribute encapsulating coercion-specific configuration
+class NoisyString < Virtus::Attribute
+  def coerce(value)
+    coercer[value.class].to_string.upcase
+  end
+end
+
+class User
+  include Virtus.model
+
+  attribute :scream, NoisyString
+end
 
-Virtus comes with a builtin coercion library.
-It's super easy to add your own coercion classes.
-Take a look:
+user = User.new(:scream => 'hello world!')
+user.scream # => "HELLO WORLD!"
+```
+
+### Private Attributes
 
 ``` ruby
-require 'digest/md5'
-
-# Our new attribute type
-class MD5 < Virtus::Attribute::Object
-  primitive String
-  coercion_method :to_md5
-end
-
-# Defining the Coercion method
-module Virtus
-  class Coercion
-    class String < Virtus::Coercion::Object
-      def self.to_md5(value)
-        Digest::MD5.hexdigest value
-      end
-    end
+class User
+  include Virtus.model
+
+  attribute :unique_id, String, :writer => :private
+
+  def set_unique_id(id)
+    self.unique_id = id
   end
 end
 
-# And now the user!
+user = User.new(:unique_id => '1234-1234')
+user.unique_id # => nil
+
+user.unique_id = '1234-1234' # => NoMethodError: private method `unique_id='
+
+user.set_unique_id('1234-1234')
+user.unique_id # => '1234-1234'
+```
+
+Coercions
+---------
+
+Virtus uses [Coercible](https://github.com/solnic/coercible) for coercions. This
+feature is turned on by default. You can turn it off for all attributes like that:
+
+```ruby
+# Turn coercions off globally
+Virtus.coerce(false)
+
+# ...or you can turn it off for a single attribute
 class User
-  include Virtus
+  include Virtus.model
 
-  attribute :name, String
-  attribute :password, MD5
+  attribute :name, String, :coerce => false
+end
+```
+
+You can configure coercers too:
+
+```ruby
+Virtus.coercer do |config|
+  config.string.boolean_map = { 'yup' => true, 'nope' => false }
 end
 
-user = User.new(:name => 'Piotr', :password => 'foobar')
-user.name # => 'Piotr'
-user.password # => '3858f62230ac3c915f300c664312c63f'
+# Virtus.coercer instance is used by default for all attributes.
+# You *can* override it for a single attribute if you want:
+
+my_cool_coercer = Coercible::Coercer.new do |config|
+  # some customization
+end
+
+class User
+  include Virtus.model
+
+  attribute :name, String, :coercer => my_cool_coercer
+end
 ```
 
-### Custom Attributes
+## Strict Coercion Mode
+
+By default virtus returns input value even when it couldn't coerce it to expected type.
+If you want to catch such cases in a noisy way you can use the strict mode in which
+virtus raises an exception when it failed to coerce an input value.
 
 ``` ruby
-require 'json'
+class User
+  include Virtus.model(:strict => true)
 
-module MyApp
+  attribute :admin, Boolean
+end
 
-  # Defining the custom attribute(s)
-  module Attributes
-    class JSON < Virtus::Attribute::Object
-      primitive Hash
+# this will raise an error
+User.new :admin => "can't really say if true or false"
+```
 
-      def coerce(value)
-        ::JSON.parse value
-      end
-    end
-  end
+## Building modules with custom configuration
 
-  class User
-    include Virtus
+You can also build Virtus modules that contain their own configuration.
 
-    attribute :info, Attributes::JSON
-  end
+```ruby
+YupNopeBooleans = Virtus.model { |mod|
+  mod.coerce = true
+  mod.string.boolean_map = { 'yup' => true, 'nope' => false }
+}
+
+class User
+  include YupNopeBooleans
+
+  attribute :name, String
+  attribute :admin, Boolean
 end
 
-user = MyApp::User.new
-user.info = '{"email":"john@domain.com"}' # => {"email"=>"john@domain.com"}
-user.info.class # => Hash
+# Or just include the module straight away ...
+class User
+  include Virtus.model(:coerce => false)
+
+  attribute :name, String
+  attribute :admin, Boolean
+end
 ```
 
+Please check out [Coercible README](https://github.com/solnic/coercible/blob/master/README.md)
+for more information.
+
 Credits
 -------
 
@@ -409,7 +547,7 @@ Contributing
 License
 -------
 
-Copyright (c) 2011-2012 Piotr Solnica
+Copyright (c) 2011-2013 Piotr Solnica
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the