virtus 1.0.2 → 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9159a933adbe9e8abeda7386590659134150c554
+  data.tar.gz: cd8c5f3edb39d1dc81d5796ab6a42ba941a1485f
+SHA512:
+  metadata.gz: b57dce024748303a11bb12631e7133b8ac1ee66711bb08b09cd85080552d815c283596b8a9b7af9a87ae77e413592ece743f8059c8293b808d6e4a653bba7837
+  data.tar.gz: f1704e07a82c1de070711b117387fcb2bd067e7bfa95a8f46daf2e1bad818f3faa82500636004d0474e0994ab2a3eb7d1e123ad163b0727f015cdf5ac1ef8326

data/.ruby-version

@@ -1 +1 @@
-1.9.3
+2.1

data/.travis.yml

@@ -5,8 +5,8 @@ script: "bundle exec rake metrics:coverage spec:integration"
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
-  - jruby-19mode
+  - 2.1.2
+  - jruby
   - rbx
   - ruby-head
 matrix:

data/Changelog.md

@@ -1,3 +1,14 @@
+# v1.0.3 2014-07-24
+
+* [improvement] Expose attribute name in the exception when in strict mode (ntl)
+* [improvement] Set #to_h as an alias to #to_hash (fnando)
+* [fixed] Fix handling of nil in collection coercion (edgibbs)
+* [fixed] Fix issues with using multiple virtus modules (trptcolin)
+* [fixed] Fix handling of Range type (hampei)
+* [fixed] Fix strict mode for collection and hash types (solnic)
+
+[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
 
 * [improvement] Don’t override already-defined default values when freezing (amarshall)

data/Gemfile

@@ -5,6 +5,8 @@ gemspec
 gem 'bogus', '~> 0.1'
 gem 'devtools', :git => 'https://github.com/rom-rb/devtools', branch: 'master'
 
-eval_gemfile 'Gemfile.devtools'
+group :test do
+  gem 'inflecto', '~> 0.0.2'
+end
 
-gem 'mutant', git: 'https://github.com/solnic/mutant.git', branch: 'auto-expand-scope'
+eval_gemfile 'Gemfile.devtools'

data/Gemfile.devtools

@@ -1,10 +1,10 @@
 # encoding: utf-8
 
 group :development do
-  gem 'rake',       '~> 10.1.0'
-  gem 'rspec',      '~> 2.14.1'
-  gem 'rspec-core', '~> 2.14.8'
-  gem 'yard',       '~> 0.8.7'
+  gem 'rake',       '~> 10.3.2'
+  gem 'rspec',      '~> 3.0.0'
+  gem 'rspec-its',  '~> 1.0.1'
+  gem 'yard',       '~> 0.8.7.4'
 
   platform :rbx do
     gem 'rubysl-singleton', '~> 2.0.0'
@@ -12,45 +12,51 @@ group :development do
 end
 
 group :yard do
-  gem 'kramdown', '~> 1.3.2'
+  gem 'kramdown', '~> 1.3.3'
 end
 
 group :guard do
-  gem 'guard',         '~> 2.4.0'
+  gem 'guard',         '~> 2.6.1'
   gem 'guard-bundler', '~> 2.0.0'
-  gem 'guard-rspec',   '~> 4.2.6'
-  gem 'guard-rubocop', '~> 1.0.2'
+  gem 'guard-rspec',   '~> 4.2.9'
+  gem 'guard-rubocop', '~> 1.1.0'
 
   # file system change event handling
-  gem 'listen',     '~> 2.5.0'
+  gem 'listen',     '~> 2.7.7'
   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 'rb-fsevent', '~> 0.9.4', require: false
+  gem 'rb-inotify', '~> 0.9.5', require: false
 
   # notification handling
-  gem 'libnotify',               '~> 0.8.0', require: false
+  gem 'libnotify',               '~> 0.8.3', require: false
   gem 'rb-notifu',               '~> 0.0.4', require: false
   gem 'terminal-notifier-guard', '~> 1.5.3', require: false
 end
 
 group :metrics do
   gem 'coveralls', '~> 0.7.0'
-  gem 'flay',      '~> 2.4.0'
-  gem 'flog',      '~> 4.2.0'
-  gem 'reek',      '~> 1.3.2'
-  gem 'simplecov', '~> 0.8.2'
+  gem 'flay',      '~> 2.5.0'
+  gem 'flog',      '~> 4.2.1'
+  gem 'reek',      '~> 1.3.7'
+  gem 'rubocop',   '~> 0.23.0'
+  gem 'simplecov', '~> 0.7.1'
   gem 'yardstick', '~> 0.9.9'
 
+  platforms :mri do
+    gem 'mutant',       '~> 0.5.23'
+    gem 'mutant-rspec', '~> 0.5.21'
+  end
+
   platforms :ruby_19, :ruby_20 do
     gem 'yard-spellcheck', '~> 0.1.5'
   end
 
   platform :rbx do
     gem 'json',               '~> 1.8.1'
-    gem 'racc',               '~> 1.4'
+    gem 'racc',               '~> 1.4.11'
     gem 'rubysl-logger',      '~> 2.0.0'
     gem 'rubysl-open-uri',    '~> 2.0.0'
-    gem 'rubysl-prettyprint', '~> 2.0.2'
+    gem 'rubysl-prettyprint', '~> 2.0.3'
   end
 end
 
@@ -60,6 +66,6 @@ end
 
 platform :jruby do
   group :jruby do
-    gem 'jruby-openssl', '~> 0.8.5'
+    gem 'jruby-openssl', '~> 0.9.4'
   end
 end

data/README.md

@@ -6,14 +6,14 @@ Virtus
 [![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-pages.github.io/github/solnic/virtus.png)][inchpages]
+[![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-pages.github.io/github/solnic/virtus
+[inchpages]: http://inch-ci.org/github/solnic/virtus
 
 This is a partial extraction of the DataMapper [Property
 API](http://rubydoc.info/github/datamapper/dm-core/master/DataMapper/Property)
@@ -273,6 +273,22 @@ package = Package.new(:dimensions => { 'width' => "2.2", :height => 2, "length"
 package.dimensions # => { :width => 2.2, :height => 2.0, :length => 4.5 }
 ```
 
+### IMPORTANT note about Boolean type
+
+Be aware that some libraries may do a terrible thing and define a global Boolean
+constant which breaks virtus' constant type lookup, if you see issues with the
+boolean type you can workaround it like that:
+
+``` ruby
+class User
+  include Virtus.model
+
+  attribute :admin, Axiom::Types::Boolean
+end
+```
+
+This will be improved in Virtus 2.0.
+
 ### IMPORTANT note about member coercions
 
 Virtus performs coercions only when a value is being assigned. If you mutate the value later on using its own
@@ -383,7 +399,7 @@ end
 class User
   include Virtus.model
 
-  attribute :info, Json
+  attribute :info, Json, default: {}
 end
 
 user = User.new
@@ -429,6 +445,31 @@ user.set_unique_id('1234-1234')
 user.unique_id # => '1234-1234'
 ```
 
+### Overriding setters
+
+``` ruby
+class User
+  include Virtus.model
+
+  attribute :name, String
+
+  def name=(new_name)
+    custom_name = nil
+    if new_name == "Godzilla"
+      custom_name = "Can't tell"
+    end
+    super custom_name || new_name
+  end
+end
+
+user = User.new(name: "Frank")
+user.name # => 'Frank'
+
+user = User.new(name: "Godzilla")
+user.name # => 'Can't tell'
+
+```
+
 ## Strict Coercion Mode
 
 By default Virtus returns the input value even when it couldn't coerce it to the expected type.
@@ -453,7 +494,7 @@ You can also build Virtus modules that contain their own configuration.
 ```ruby
 YupNopeBooleans = Virtus.model { |mod|
   mod.coerce = true
-  mod.string.boolean_map = { 'yup' => true, 'nope' => false }
+  mod.coercer.config.string.boolean_map = { 'nope' => false, 'yup' => true }
 }
 
 class User
@@ -501,6 +542,17 @@ Blog.attribute_set[:posts].member_type.primitive # => Post
 Post.attribute_set[:blog].type.primitive # => Blog
 ```
 
+Ruby version support
+--------------------
+
+Virtus is known to work correctly with the following rubies:
+
+* 1.9.3
+* 2.0.0
+* 2.1.2
+* jruby
+* (probably) rbx
+
 Credits
 -------
 

data/lib/virtus.rb

@@ -11,11 +11,31 @@ module Virtus
   Undefined = Object.new.freeze
 
   class CoercionError < StandardError
-    attr_reader :output, :primitive
+    attr_reader :output, :attribute
 
-    def initialize(output, primitive)
-      @output, @primitive = output, primitive
-      super("Failed to coerce #{output.inspect} into #{primitive.inspect}")
+    def initialize(output, attribute)
+      @output, @attribute = output, attribute
+      super(build_message)
+    end
+
+    def build_message
+      if attribute_name?
+        "Failed to coerce attribute `#{attribute_name}' from #{output.inspect} into #{target_type}"
+      else
+        "Failed to coerce #{output.inspect} into #{target_type}"
+      end
+    end
+
+    def attribute_name
+      attribute.options[:name]
+    end
+
+    def attribute_name?
+      attribute_name ? true : false
+    end
+
+    def target_type
+      attribute.primitive.inspect
     end
   end
 
@@ -101,7 +121,8 @@ module Virtus
   #
   # @api public
   def self.config(&block)
-    configuration.call(&block)
+    yield configuration if block_given?
+    configuration
   end
 
   # Provides access to the Virtus module builder

data/lib/virtus/attribute/builder.rb

@@ -53,7 +53,7 @@ module Virtus
 
     # @api private
     def pending?
-      @pending
+      @pending if defined?(@pending)
     end
 
     private
@@ -107,7 +107,7 @@ module Virtus
               determine_type(klass.primitive)
             elsif EmbeddedValue.handles?(klass)
               EmbeddedValue
-            elsif klass < Enumerable
+            elsif klass < Enumerable && !(klass <= Range)
               Collection
             end
         end

data/lib/virtus/attribute/collection.rb

@@ -66,12 +66,16 @@ module Virtus
 
       # @api private
       def self.merge_options!(type, options)
-        options[:member_type] ||= Attribute.build(type.member_type)
+        options[:member_type] ||= Attribute.build(type.member_type, strict: options[:strict])
       end
 
       # @api public
-      def coerce(*)
-        super.each_with_object(primitive.new) do |entry, collection|
+      def coerce(value)
+        coerced = super
+
+        return coerced unless coerced.respond_to?(:each_with_object)
+
+        coerced.each_with_object(primitive.new) do |entry, collection|
           collection << member_type.coerce(entry)
         end
       end

data/lib/virtus/attribute/hash.rb

@@ -70,7 +70,7 @@ module Virtus
                 value_type
               end
 
-            { :key_type   => key_primitive, :value_type => value_primitive}
+            { :key_type => key_primitive, :value_type => value_primitive}
           end
         end
 
@@ -92,8 +92,8 @@ module Virtus
 
       # @api private
       def self.merge_options!(type, options)
-        options[:key_type]   ||= Attribute.build(type.key_type)
-        options[:value_type] ||= Attribute.build(type.value_type)
+        options[:key_type]   ||= Attribute.build(type.key_type, :strict => options[:strict])
+        options[:value_type] ||= Attribute.build(type.value_type, :strict => options[:strict])
       end
 
       # Coerce members

data/lib/virtus/attribute/strict.rb

@@ -16,7 +16,7 @@ module Virtus
         if value_coerced?(output) || !required? && output.nil?
           output
         else
-          raise CoercionError.new(output, primitive)
+          raise CoercionError.new(output, self)
         end
       end
 

data/lib/virtus/builder.rb

@@ -25,7 +25,7 @@ module Virtus
 
     # @api private
     def self.call(options, &block)
-      new(Configuration.build(options, &block)).mod
+      new(Configuration.new(options, &block)).mod
     end
 
     # @api private

data/lib/virtus/configuration.rb

@@ -18,49 +18,20 @@ module Virtus
     # Access the mass-assignment setting for this instance
     attr_accessor :mass_assignment
 
-    # Build new configuration instance using the passed block
-    #
-    # @example
-    #   Configuration.build do |config|
-    #     config.coerce = false
-    #   end
-    #
-    # @return [Configuration]
-    #
-    # @api public
-    def self.build(options = {}, &block)
-      config = new.call(&block)
-      options.each { |key, value| config.public_send("#{key}=", value) }
-      config
-    end
-
     # Initialized a configuration instance
     #
     # @return [undefined]
     #
     # @api private
-    def initialize
-      @finalize        = true
-      @coerce          = true
-      @strict          = false
-      @constructor     = true
-      @mass_assignment = true
+    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)
       @coercer         = Coercible::Coercer.new
-    end
 
-    # Provide access to the attributes and methods via the passed block
-    #
-    # @example
-    #   configuration.call do |config|
-    #     config.coerce = false
-    #   end
-    #
-    # @return [self]
-    #
-    # @api private
-    def call(&block)
-      block.call(self) if block_given?
-      self
+      yield self if block_given?
     end
 
     # Access the coercer for this instance and optional configure a

data/lib/virtus/instance_methods.rb

@@ -42,6 +42,7 @@ module Virtus
         attribute_set.get(self)
       end
       alias_method :to_hash, :attributes
+      alias_method :to_h, :attributes
 
       # Mass-assign attribute values
       #

data/lib/virtus/module_extensions.rb

@@ -15,7 +15,9 @@ module Virtus
     # @api private
     def self.setup(mod, inclusions = [Model], attribute_definitions = [])
       mod.instance_variable_set('@inclusions', inclusions)
-      mod.instance_variable_set('@attribute_definitions', attribute_definitions)
+      existing_attributes = mod.instance_variable_get('@attribute_definitions')
+      new_attributes = (existing_attributes || []) + attribute_definitions
+      mod.instance_variable_set('@attribute_definitions', new_attributes)
     end
 
     # Define an attribute in the module
@@ -57,7 +59,11 @@ module Virtus
       super
 
       if Class === object
-        @inclusions.each { |mod| object.send(:include, mod) }
+        @inclusions.reject do |mod|
+          object.ancestors.include?(mod)
+        end.each do |mod|
+          object.send(:include, mod)
+        end
         define_attributes(object)
       else
         object.extend(ModuleExtensions)