virtus 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9159a933adbe9e8abeda7386590659134150c554
-  data.tar.gz: cd8c5f3edb39d1dc81d5796ab6a42ba941a1485f
+  metadata.gz: 934dc95c7d8fd79268fcf7e2303257cd72378ef9
+  data.tar.gz: dd9096d86a6df285b7b97f4cabab540afa72ed0b
 SHA512:
-  metadata.gz: b57dce024748303a11bb12631e7133b8ac1ee66711bb08b09cd85080552d815c283596b8a9b7af9a87ae77e413592ece743f8059c8293b808d6e4a653bba7837
-  data.tar.gz: f1704e07a82c1de070711b117387fcb2bd067e7bfa95a8f46daf2e1bad818f3faa82500636004d0474e0994ab2a3eb7d1e123ad163b0727f015cdf5ac1ef8326
+  metadata.gz: 9095639c91403b8193bfe71a9067da701298a5190f65bdef2ac0ea0aaef130cf819529b2a672e071b48857ce614082402048a9125658b4a6f129d432968239f7
+  data.tar.gz: ec1343ee430f0e6c6766c6e7a2457d116b7b4de00156f2ffe813989f1f62f96d712218756f750bfb45dc700552ba7999450ae243a3024ed1af3a5671e8a7b817

data/.travis.yml

@@ -1,11 +1,14 @@
 language: ruby
 before_install: gem install bundler
-bundler_args: --without yard guard benchmarks
-script: "bundle exec rake metrics:coverage spec:integration"
+bundler_args: --without tools
+script: "bundle exec rake spec"
+env:
+  - CODECLIMATE_REPO_TOKEN=2b66fbb7c7c72503eb7841a479c0ad923f691729f4109b4aa8c9b4def1ebb42d
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.2
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
   - jruby
   - rbx
   - ruby-head

data/Changelog.md

@@ -1,3 +1,9 @@
+# v1.0.4 2015-01-03
+
+* [feature] Support for :required option when configuring a virtus module (solnic)
+
+[Compare v1.0.3..v1.0.4](https://github.com/solnic/virtus/compare/v1.0.3...v1.0.4)
+
 # v1.0.3 2014-07-24
 
 * [improvement] Expose attribute name in the exception when in strict mode (ntl)
@@ -9,7 +15,7 @@
 
 [Compare v1.0.2..v1.0.3](https://github.com/solnic/virtus/compare/v1.0.2...v1.0.3)
 
-# v1.0.2 2014-12-03
+# v1.0.2 2013-12-03
 
 * [improvement] Don’t override already-defined default values when freezing (amarshall)
 * [improvement] Improved performance of `AttributeSet#each` (Antti)

data/Gemfile

@@ -3,10 +3,19 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'bogus', '~> 0.1'
-gem 'devtools', :git => 'https://github.com/rom-rb/devtools', branch: 'master'
+gem 'inflecto', '~> 0.0.2'
+gem 'rspec', '~> 3.1'
 
-group :test do
-  gem 'inflecto', '~> 0.0.2'
-end
+gem "codeclimate-test-reporter", group: :test, require: false
+
+group :tools do
+  gem 'guard'
+  gem 'guard-rspec'
 
-eval_gemfile 'Gemfile.devtools'
+  gem 'rubocop'
+
+  platform :mri do
+    gem 'mutant'
+    gem 'mutant-rspec'
+  end
+end

data/README.md

@@ -1,27 +1,35 @@
-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]
-[![Inline docs](http://inch-ci.org/github/solnic/virtus.png)][inchpages]
-
 [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
-[inchpages]: http://inch-ci.org/github/solnic/virtus
+[inchpages]: http://inch-ci.org/github/solnic/virtus/
+
+Virtus
+======
+
+# Ruby Object Mapper
+
+[![Gem Version](https://badge.fury.io/rb/rom.svg)][gem]
+[![Build Status](https://travis-ci.org/solnic/virtus.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/solnic/virtus.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/solnic/virtus/badges/gpa.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/solnic/virtus/badges/coverage.svg)][codeclimate]
+[![Inline docs](http://inch-ci.org/github/solnic/virtus.svg?branch=master)][inchpages]
 
-This is a partial extraction of the DataMapper [Property
-API](http://rubydoc.info/github/datamapper/dm-core/master/DataMapper/Property)
-with various modifications and improvements. The goal is to provide a common API
-for defining attributes on a model so all ORMs/ODMs could use it instead of
-reinventing the wheel all over again. It is also suitable for any other
-use case where you need to extend your ruby objects with attributes that require
-data-type coercions.
+Virtus allows you to define attributes on classes, modules or class instances with
+optional information about types, reader/writer method visibility and coercion
+behavior. It supports a lot of coercions and advanced mapping of embedded objects
+and collections.
+
+You can use it in many different contexts like:
+
+* Input parameter sanitization and coercion in web applications
+* Mapping JSON to domain objects
+* Encapsulating data-access in Value Objects
+* Domain model prototyping
+
+And probably more.
 
 Installation
 ------------
@@ -181,6 +189,19 @@ page.reset_attribute(:views)  # => 0
 page.views                    # => 0
 ```
 
+### Default values on dynamically extended instances
+
+This requires you to set `:lazy` option because default values are set in the
+constructor if it's set to false (which is the default setting):
+
+``` ruby
+User = Class.new
+user = User.new
+user.extend(Virtus.model)
+user.attribute :name, String, default: 'jane', lazy: true
+user.name # => "jane"
+```
+
 ### Embedded Value
 
 ``` ruby
@@ -409,7 +430,7 @@ 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
+    value.to_s.upcase
   end
 end
 

data/Rakefile

@@ -1,5 +1,15 @@
-# encoding: utf-8
+require "rspec/core/rake_task"
 
-require 'devtools'
+RSpec::Core::RakeTask.new(:spec)
+task default: [:spec]
 
-Devtools.init_rake_tasks
+begin
+  require "rubocop/rake_task"
+
+  Rake::Task[:default].enhance [:rubocop]
+
+  RuboCop::RakeTask.new do |task|
+    task.options << "--display-cop-names"
+  end
+rescue LoadError
+end

data/lib/virtus/configuration.rb

@@ -12,6 +12,9 @@ module Virtus
     # Access the strict setting for this instance
     attr_accessor :strict
 
+    # Access the required setting for this instance
+    attr_accessor :required
+
     # Access the constructor setting for this instance
     attr_accessor :constructor
 
@@ -24,11 +27,12 @@ module Virtus
     #
     # @api private
     def initialize(options={})
-      @finalize        = options.fetch(:finalize,true)
-      @coerce          = options.fetch(:coerce,true)
-      @strict          = options.fetch(:strict,false)
-      @constructor     = options.fetch(:constructor,true)
-      @mass_assignment = options.fetch(:mass_assignment,true)
+      @finalize        = options.fetch(:finalize, true)
+      @coerce          = options.fetch(:coerce, true)
+      @strict          = options.fetch(:strict, false)
+      @required        = options.fetch(:required, true)
+      @constructor     = options.fetch(:constructor, true)
+      @mass_assignment = options.fetch(:mass_assignment, true)
       @coercer         = Coercible::Coercer.new
 
       yield self if block_given?
@@ -55,6 +59,7 @@ module Virtus
       { :coerce             => coerce,
         :finalize           => finalize,
         :strict             => strict,
+        :required           => required,
         :configured_coercer => coercer }.freeze
     end
 

data/lib/virtus/version.rb

@@ -1,3 +1,3 @@
 module Virtus
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'.freeze
 end

data/spec/integration/collection_member_coercion_spec.rb

@@ -25,10 +25,10 @@ class User
 end
 
 describe User do
-  it { should respond_to(:phone_numbers)  }
-  it { should respond_to(:phone_numbers=) }
-  it { should respond_to(:addresses)  }
-  it { should respond_to(:addresses=) }
+  it { is_expected.to respond_to(:phone_numbers)  }
+  it { is_expected.to respond_to(:phone_numbers=) }
+  it { is_expected.to respond_to(:addresses)  }
+  it { is_expected.to respond_to(:addresses=) }
 
   let(:instance) do
     described_class.new(:phone_numbers => phone_numbers_attributes,
@@ -48,28 +48,49 @@ describe User do
     describe 'first entry' do
       subject { instance.phone_numbers.first }
 
-      it { should be_instance_of(PhoneNumber) }
+      it { is_expected.to be_instance_of(PhoneNumber) }
 
-      its(:number)  { should eql('212-555-1212') }
+      describe '#number' do
+        subject { super().number }
+        it { is_expected.to eql('212-555-1212') }
+      end
     end
 
     describe 'last entry' do
       subject { instance.phone_numbers.last }
 
-      it { should be_instance_of(PhoneNumber) }
+      it { is_expected.to be_instance_of(PhoneNumber) }
 
-      its(:number)  { should eql('919-444-3265') }
+      describe '#number' do
+        subject { super().number }
+        it { is_expected.to eql('919-444-3265') }
+      end
     end
   end
 
   describe '#addresses' do
     subject { instance.addresses.first }
 
-    it { should be_instance_of(Address) }
+    it { is_expected.to be_instance_of(Address) }
 
-    its(:address)     { should eql('1234 Any St.') }
-    its(:locality)    { should eql('Anytown')      }
-    its(:region)      { should eql('DC')           }
-    its(:postal_code) { should eql('21234')        }
+    describe '#address' do
+      subject { super().address }
+      it { is_expected.to eql('1234 Any St.') }
+    end
+
+    describe '#locality' do
+      subject { super().locality }
+      it { is_expected.to eql('Anytown')      }
+    end
+
+    describe '#region' do
+      subject { super().region }
+      it { is_expected.to eql('DC')           }
+    end
+
+    describe '#postal_code' do
+      subject { super().postal_code }
+      it { is_expected.to eql('21234')        }
+    end
   end
 end

data/spec/integration/hash_attributes_coercion_spec.rb

@@ -26,9 +26,9 @@ describe Package do
     it 'has 3 keys' do
       expect(subject.keys.size).to eq(3)
     end
-    it { should have_key :width  }
-    it { should have_key :height }
-    it { should have_key :length }
+    it { is_expected.to have_key :width  }
+    it { is_expected.to have_key :height }
+    it { is_expected.to have_key :length }
 
     it 'should be coerced to [Symbol => Float] format' do
       expect(dimensions[:width]).to  be_eql(2.2)
@@ -43,8 +43,8 @@ describe Package do
     it 'has 2 keys' do
       expect(subject.keys.size).to eq(2)
     end
-    it { should have_key 'from' }
-    it { should have_key 'to'   }
+    it { is_expected.to have_key 'from' }
+    it { is_expected.to have_key 'to'   }
 
     it 'should be coerced to [String => String] format' do
       expect(meta_info['from']).to eq('Me')

data/spec/shared/freeze_method_behavior.rb

@@ -20,7 +20,7 @@ shared_examples_for 'a #freeze method' do
   it_should_behave_like 'an idempotent method'
 
   it 'returns object' do
-    should be(object)
+    is_expected.to be(object)
   end
 
   it 'prevents future modifications' do
@@ -29,7 +29,10 @@ shared_examples_for 'a #freeze method' do
     expect { object.instance_variable_set(:@foo, :bar) }.to(expectation)
   end
 
-  its(:frozen?) { should be(true) }
+  describe '#frozen?' do
+    subject { super().frozen? }
+    it { is_expected.to be(true) }
+  end
 
   it 'allows to access attribute' do
     expect(subject.name).to eql('John')

data/spec/shared/idempotent_method_behaviour.rb

@@ -1,5 +1,5 @@
 shared_examples_for 'an idempotent method' do
   it 'is idempotent' do
-    should equal(subject)
+    is_expected.to equal(subject)
   end
 end

data/spec/shared/options_class_method.rb

@@ -2,15 +2,15 @@ shared_examples_for 'an options class method' do
   context 'with no argument' do
     subject { object.send(method) }
 
-    it { should be(default) }
+    it { is_expected.to be(default) }
   end
 
   context 'with a default value' do
     subject { object.send(method, value) }
 
-    let(:value) { double('value') }
+    let(:value) { mock('value') }
 
-    it { should equal(object) }
+    it { is_expected.to equal(object) }
 
     it 'sets the default value for the class method' do
       expect { subject }.to change { object.send(method) }.from(default).to(value)

data/spec/spec_helper.rb

@@ -1,22 +1,9 @@
-if ENV['COVERAGE'] == 'true'
-  require 'simplecov'
-  require 'coveralls'
-
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-    SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
-  ]
-
-  SimpleCov.start do
-    command_name     'spec:unit'
-    add_filter       'config/'
-    add_filter       'spec'
-    add_filter       '.bundle'
-  end
+if RUBY_ENGINE == "rbx"
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
 end
 
 require 'rspec'
-require 'rspec/its'
 require 'bogus/rspec'
 require 'virtus'
 require 'inflecto' # for resolving namespaced constant names
@@ -33,7 +20,6 @@ ENV['TZ'] = 'UTC'
 Dir[File.expand_path('../shared/**/*.rb', __FILE__)].each { |file| require file }
 
 RSpec.configure do |config|
-
   # Remove anonymous- and example- Attribute classes from Attribute descendants
   config.after :all do
     stack = [ Virtus::Attribute ]
@@ -53,5 +39,4 @@ RSpec.configure do |config|
       end
     end
   end
-
 end

data/spec/unit/virtus/attribute/boolean/coerce_spec.rb

@@ -10,13 +10,13 @@ describe Virtus::Attribute::Boolean, '#coerce' do
     context 'with a truthy value' do
       let(:input) { 1 }
 
-      it { should be(true) }
+      it { is_expected.to be(true) }
     end
 
     context 'with a falsy value' do
       let(:input) { 0 }
 
-      it { should be(false) }
+      it { is_expected.to be(false) }
     end
   end
 
@@ -26,7 +26,7 @@ describe Virtus::Attribute::Boolean, '#coerce' do
     context 'with a coercible input' do
       let(:input) { 1 }
 
-      it { should be(true) }
+      it { is_expected.to be(true) }
     end
 
     context 'with a non-coercible input' do

data/spec/unit/virtus/attribute/boolean/value_coerced_predicate_spec.rb

@@ -8,18 +8,18 @@ describe Virtus::Attribute::Boolean, '#value_coerced?' do
   context 'when input is true' do
     let(:input) { true }
 
-    it { should be(true) }
+    it { is_expected.to be(true) }
   end
 
   context 'when input is false' do
     let(:input) { false }
 
-    it { should be(true) }
+    it { is_expected.to be(true) }
   end
 
   context 'when input is not coerced' do
     let(:input) { 1 }
 
-    it { should be(false) }
+    it { is_expected.to be(false) }
   end
 end