virtus 0.5.2 → 0.5.3

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--profile

data/.travis.yml

@@ -11,6 +11,9 @@ rvm:
   - rbx-19mode
   - ree
   - jruby-head
+matrix:
+  allow_failures:
+    - rvm: jruby-head
 notifications:
   email:
     - piotr.solnica@gmail.com

data/Changelog.md

@@ -1,3 +1,12 @@
+# v0.5.3 2012-09-01 2012-12-13
+
+* [feature] Added Hash member type coercion [example](https://github.com/solnic/virtus#hash-attributes-coercion) (greyblake)
+* [fixed] Fixed issues with String=>Integer coercion and e-notation (greyblake)
+* [changed] Replaced internal DescendantsTracker with the extracted gem (solnic)
+* [interal] Switched to rspec 2 and mutant for mutation testing (mbj)
+
+[Compare v0.5.2..v0.5.3](https://github.com/solnic/virtus/compare/v0.5.2...v0.5.3)
+
 # v0.5.2 2012-09-01
 
 * [feature] Object is now the default attribute type (dkubb)

data/Gemfile

@@ -2,26 +2,6 @@ source 'https://rubygems.org'
 
 gemspec
 
-group :metrics do
-  gem 'fattr',       '~> 2.2.0'
-  gem 'arrayfields', '~> 4.7.4'
-  gem 'flay',        '~> 1.4.2'
-  gem 'flog',        '~> 2.5.1'
-  gem 'map',         '~> 5.2.0'
-  gem 'reek',        '~> 1.2.8', :git => 'git://github.com/dkubb/reek.git'
-  gem 'roodi',       '~> 2.1.0'
-  gem 'yardstick',   '~> 0.4.0'
+gem 'devtools', :git => 'https://github.com/datamapper/devtools'
 
-  platforms :mri_18 do
-    gem 'heckle',    '~> 1.4.3'
-    gem 'json',      '~> 1.6.4'
-    gem 'metric_fu', '~> 2.1.1'
-    gem 'mspec',     '~> 1.5.17'
-    gem 'rcov',      '~> 0.9.9'
-    gem 'ruby2ruby', '=  1.2.2'
-  end
-
-  platforms :rbx do
-    gem 'pelusa', :git => 'https://github.com/codegram/pelusa.git'
-  end
-end
+eval File.read('Gemfile.devtools')

data/Gemfile.devtools

@@ -0,0 +1,44 @@
+group :development do
+  gem 'rake',    '~> 0.9.2'
+  gem 'rspec',   '~> 2.12.0'
+  gem 'yard',    '~> 0.8.3'
+end
+
+group :guard do
+  gem 'guard',         '~> 1.5.4'
+  gem 'guard-bundler', '~> 1.0.0'
+  gem 'guard-rspec',   '~> 2.1.1'
+  gem 'rb-inotify', :git => 'https://github.com/mbj/rb-inotify'
+end
+
+group :benchmarks do
+  gem 'rbench', '~> 0.2.3'
+end
+
+platform :jruby do
+  group :jruby do
+    gem 'jruby-openssl', '~> 0.7.4'
+  end
+end
+
+group :metrics do
+  gem 'flay',      '~> 1.4.2'
+  gem 'flog',      '~> 2.5.1'
+  gem 'reek',      '~> 1.2.8', :git => 'https://github.com/dkubb/reek.git'
+  gem 'roodi',     '~> 2.1.0'
+  gem 'yardstick', '~> 0.8.0'
+  gem 'mutant',    '~> 0.2.0'
+
+  platforms :ruby_18, :ruby_19 do
+    # this indirectly depends on ffi which does not build on ruby-head
+    gem 'yard-spellcheck', '~> 0.1.5'
+  end
+
+  platforms :mri_19 do
+    gem 'simplecov',   '~> 0.7'
+  end
+
+  platforms :rbx do
+    gem 'pelusa', '~> 0.2.1'
+  end
+end

data/README.md

@@ -1,4 +1,4 @@
-virtus
+Virtus
 ======
 
 [![Build Status](https://secure.travis-ci.org/solnic/virtus.png)](http://travis-ci.org/solnic/virtus)
@@ -51,6 +51,11 @@ user.age = '28' # => 28
 user.age.class # => Fixnum
 
 user.birthday = 'November 18th, 1983' # => #<DateTime: 1983-11-18T00:00:00+00:00 (4891313/2,0/1,2299161)>
+
+# mass-assignment
+user.attributes = { :name => 'Jane', :age => 21 }
+user.name # => "Jane"
+user.age  # => 21
 ```
 
 ### Using Virtus with Modules
@@ -205,6 +210,78 @@ user.phone_numbers # => [#<PhoneNumber:0x007fdb2d3bef88 @number="212-555-1212">,
 user.addresses # => #<Set: {#<Address:0x007fdb2d3be448 @address="1234 Any St.", @locality="Anytown", @region="DC", @postal_code="21234">}>
 ```
 
+### Hash attributes coercion
+
+``` ruby
+class Package
+  include Virtus
+
+  attribute :dimensions, Hash[Symbol => Float]
+end
+
+package = Package.new(:dimensions => { 'width' => "2.2", :height => 2, "length" => 4.5 })
+package.dimensions # => { :width => 2.2, :height => 2.0, :length => 4.5 }
+```
+
+### 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
+interfaces then coercion won't be triggered.
+
+Here's an example:
+
+``` ruby
+class Book
+  include Virtus
+
+  attribute :title, String
+end
+
+class Library
+  include Virtus
+
+  attribute :books, Array[Book]
+end
+
+library = Library.new
+
+# This will coerce Hash to a Book instance
+library.books = [ { :title => 'Introduction to Virtus' } ]
+
+# This WILL NOT COERCE the value because you mutate the books array with Array#<<
+library.books << { :title => 'Another Introduction to Virtus' }
+```
+
+A suggested solution to this problem would be to introduce your own class instead of using Array and implement
+mutation methods that perform coercions. For example:
+
+``` ruby
+class Book
+  include Virtus
+
+  attribute :title, String
+end
+
+class BookCollection < Array
+  def <<(book)
+   if book.kind_of?(Hash)
+    super(Book.new(book))
+   else
+     super
+   end
+  end
+end
+
+class Library
+  include Virtus
+
+  attribute :books, BookCollection[Book]
+end
+
+library = Library.new
+library.books << { :title => 'Another Introduction to Virtus' }
+```
+
 ### Value Objects
 
 ``` ruby

data/Rakefile

@@ -1,6 +1,5 @@
-require 'rake'
+# encoding: utf-8
 
-FileList['tasks/**/*.rake'].each { |task| import task }
+require 'devtools'
 
-desc 'Default: run all specs'
-task :default => :spec
+Devtools.init

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
-threshold: 19
-total_score: 425
+threshold: 23
+total_score: 499

data/config/mutant.yml

@@ -0,0 +1,3 @@
+---
+name: virtus
+namespace: Virtus

data/lib/virtus.rb

@@ -47,7 +47,8 @@ module Virtus
 
 end # module Virtus
 
-require 'virtus/support/descendants_tracker'
+require 'descendants_tracker'
+
 require 'virtus/support/type_lookup'
 require 'virtus/support/options'
 require 'virtus/support/equalizer'

data/lib/virtus/attribute.rb

@@ -83,7 +83,7 @@ module Virtus
       case class_or_name
       when ::Class
         Attribute::EmbeddedValue.determine_type(class_or_name) || super
-      when ::Array, ::Set
+      when ::Array, ::Set, ::Hash
         super(class_or_name.class)
       else
         super

data/lib/virtus/attribute/array.rb

@@ -15,6 +15,7 @@ module Virtus
     class Array < Collection
       primitive       ::Array
       coercion_method :to_array
+      default         primitive.new
 
       include Collection::MemberCoercion
 

data/lib/virtus/attribute/class.rb

@@ -7,7 +7,7 @@ module Virtus
     #   class Entity
     #     include Virtus
     #
-    #     attribute :type, Class
+    #     attribute :model, Class
     #   end
     #
     #   post = Entity.new(:model => Model)

data/lib/virtus/attribute/hash.rb

@@ -15,6 +15,90 @@ module Virtus
     class Hash < Object
       primitive       ::Hash
       coercion_method :to_hash
+      default         primitive.new
+
+      # The type to which keys of this hash will be coerced
+      #
+      # @example
+      #
+      #   class Request
+      #     include Virtus
+      #
+      #     attribute :headers, Hash[Symbol => String]
+      #   end
+      #
+      #   Post.attributes[:headers].key_type # => Virtus::Attribute::Symbol
+      #
+      # @return [Virtus::Attribute]
+      #
+      # @api public
+      attr_reader :key_type
+
+      # The type to which values of this hash will be coerced
+      #
+      # @example
+      #
+      #   class Request
+      #     include Virtus
+      #
+      #     attribute :headers, Hash[Symbol => String]
+      #   end
+      #
+      #   Post.attributes[:headers].value_type # => Virtus::Attribute::String
+      #
+      # @return [Virtus::Attribute]
+      #
+      # @api public
+      attr_reader :value_type
+
+      # Handles hashes with [key_type => value_type] syntax.
+      #
+      # @param [Class]
+      #
+      # @param [Hash]
+      #
+      # @return [Hash]
+      #
+      # @api private
+      def self.merge_options(type, options)
+        if !type.respond_to?(:size)
+          options
+        elsif type.size > 1
+          raise ArgumentError, "more than one [key => value] pair in `#{type.inspect}`"
+        else
+          options.merge(:key_type => type.keys.first, :value_type => type.values.first)
+        end
+      end
+
+      # Initializes an instance of {Virtus::Attribute::Hash}
+      #
+      # @api private
+      def initialize(*)
+        super
+        if @options.has_key?(:key_type) && @options.has_key?(:value_type)
+          @key_type   = @options[:key_type]
+          @value_type = @options[:value_type]
+          @key_type_instance   = Attribute.build(@name, @key_type)
+          @value_type_instance = Attribute.build(@name, @value_type)
+        end
+      end
+
+      # Coerce a hash with keys and values
+      #
+      # @param [Object]
+      #
+      # @return [Object]
+      #
+      # @api private
+      def coerce(value)
+        coerced = super
+        return coerced unless coerced.respond_to?(:each_with_object)
+        coerced.each_with_object({}) do |key_and_value, hash|
+          key   = @key_type_instance.coerce(key_and_value[0])
+          value = @value_type_instance.coerce(key_and_value[1])
+          hash[key] = value
+        end
+      end
 
     end # class Hash
   end # class Attribute

data/lib/virtus/attribute/set.rb

@@ -15,6 +15,7 @@ module Virtus
     class Set < Collection
       primitive       ::Set
       coercion_method :to_set
+      default         primitive.new
 
       include Collection::MemberCoercion
 

data/lib/virtus/coercion/string.rb

@@ -11,8 +11,12 @@ module Virtus
 
       INTEGER_REGEXP    = /[-+]?(?:0|[1-9]\d*)/.freeze
       EXPONENT_REGEXP   = /(?:[eE][-+]?\d+)/.freeze
-      FRACTIONAL_REGEXP = /(?:\.\d+#{EXPONENT_REGEXP}?)/.freeze
-      NUMERIC_REGEXP    = /\A(#{INTEGER_REGEXP}#{FRACTIONAL_REGEXP}?|#{FRACTIONAL_REGEXP})\z/.freeze
+      FRACTIONAL_REGEXP = /(?:\.\d+)/.freeze
+
+      NUMERIC_REGEXP    = /\A(
+        #{INTEGER_REGEXP}#{FRACTIONAL_REGEXP}?#{EXPONENT_REGEXP}? |
+        #{FRACTIONAL_REGEXP}#{EXPONENT_REGEXP}?
+      )\z/x.freeze
 
       # Coerce give value to a constant
       #

data/lib/virtus/instance_methods.rb

@@ -191,7 +191,14 @@ module Virtus
     #
     # @api private
     def set_attributes(attributes)
-      ::Hash.try_convert(attributes).each do |name, value|
+      hash = ::Hash.try_convert(attributes)
+
+      if hash.nil?
+        raise NoMethodError,
+          "Expected #{attributes.inspect} to respond to #to_hash"
+      end
+
+      hash.each do |name, value|
         set_attribute(name, value) if allowed_writer_methods.include?("#{name}=")
       end
     end

data/lib/virtus/version.rb

@@ -1,3 +1,3 @@
 module Virtus
-  VERSION = '0.5.2'
+  VERSION = '0.5.3'
 end

data/spec/integration/default_values_spec.rb

@@ -20,6 +20,9 @@ describe "default values" do
         attribute :published,    Boolean, :default => false, :accessor => :private
         attribute :editor_title, String,  :default => :default_editor_title
         attribute :reference,    String,  :default => Reference.new
+        attribute :revisions,    Array
+        attribute :index,        Hash
+        attribute :authors,      Set
 
         def default_editor_title
           published? ? title : "UNPUBLISHED: #{title}"
@@ -49,12 +52,29 @@ describe "default values" do
     subject.editor_title.should == 'UNPUBLISHED: Top Secret'
   end
 
-  context 'with a ValueObject' do
-    it 'should not duplicate the ValueObject' do
+  context 'a ValueObject' do
+    it 'does not duplicate the ValueObject' do
       page1 = Examples::Page.new
       page2 = Examples::Page.new
       page1.reference.should equal(page2.reference)
     end
   end
 
+  context 'an Array' do
+    specify 'without a default the value is an empty Array' do
+      subject.revisions.should eql([])
+    end
+  end
+
+  context 'a Hash' do
+    specify 'without a default the value is an empty Hash' do
+      subject.index.should eql({})
+    end
+  end
+
+  context 'a Set' do
+    specify 'without a default the value is an empty Set' do
+      subject.authors.should eql(Set.new)
+    end
+  end
 end

data/spec/integration/hash_attributes_coercion_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+
+class Package
+  include Virtus
+
+  attribute :dimensions, Hash[Symbol => Float]
+  attribute :meta_info , Hash[String => String]
+end
+
+
+describe Package do
+  let(:instance) do
+    described_class.new(
+      :dimensions => { 'width' => "2.2", :height => 2, "length" => 4.5 },
+      :meta_info  => { 'from'  => :Me  , :to => 'You' }
+    )
+  end
+
+  let(:dimensions) { instance.dimensions }
+  let(:meta_info)  { instance.meta_info  }
+
+  describe '#dimensions' do
+    subject { dimensions }
+
+    it { should have(3).keys }
+    it { should have_key :width  }
+    it { should have_key :height }
+    it { should have_key :length }
+
+    it 'should be coerced to [Symbol => Float] format' do
+      dimensions[:width].should  be_eql(2.2)
+      dimensions[:height].should be_eql(2.0)
+      dimensions[:length].should be_eql(4.5)
+    end
+  end
+
+  describe '#meta_info' do
+    subject { meta_info }
+
+    it { should have(2).keys }
+    it { should have_key 'from' }
+    it { should have_key 'to'   }
+
+    it 'should be coerced to [String => String] format' do
+      meta_info['from'].should == 'Me'
+      meta_info['to'].should == 'You'
+    end
+  end
+end