virtus 0.0.10 → 0.1.0

data/.gitignore

@@ -1,11 +1,37 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## Rubinius
+*.rbc
+.rbx
+
+## PROJECT::GENERAL
+*.gem
+coverage
+profiling
+turbulence
+rdoc
+pkg
+tmp
 doc
+log
 .yardoc
-*.gem
+measurements
+
+## BUNDLER
 .bundle
 Gemfile.lock
-pkg/*
-measurements/
-tmp/
-profiling/
-development
-.rbx/
+
+## PROJECT::SPECIFIC

data/.travis.yml

@@ -6,80 +6,10 @@ rvm:
   - 1.9.3
   - ruby-head
   - ree
-  - jruby
-  - rbx
-env:
-  -
-  - JRUBY_OPTS="--1.8"
-  - JRUBY_OPTS="--1.9"
-  - RBXOPT="-X18"
-matrix:
-  exclude:
-    # exclude 1.8.7
-    - rvm: 1.8.7
-      env: JRUBY_OPTS="--1.8"
-    - rvm: 1.8.7
-      env: JRUBY_OPTS="--1.9"
-    - rvm: 1.8.7
-      env: RBXOPT="-X18"
-    - rvm: 1.8.7
-      env: RBXOPT="-X19"
-
-    # exclude 1.9.2
-    - rvm: 1.9.2
-      env: JRUBY_OPTS="--1.8"
-    - rvm: 1.9.2
-      env: JRUBY_OPTS="--1.9"
-    - rvm: 1.9.2
-      env: RBXOPT="-X18"
-    - rvm: 1.9.2
-      env: RBXOPT="-X19"
-
-    # exclude 1.9.3
-    - rvm: 1.9.3
-      env: JRUBY_OPTS="--1.8"
-    - rvm: 1.9.3
-      env: JRUBY_OPTS="--1.9"
-    - rvm: 1.9.3
-      env: RBXOPT="-X18"
-    - rvm: 1.9.3
-      env: RBXOPT="-X19"
-
-    # exclude ruby-head
-    - rvm: ruby-head
-      env: JRUBY_OPTS="--1.8"
-    - rvm: ruby-head
-      env: JRUBY_OPTS="--1.9"
-    - rvm: ruby-head
-      env: RBXOPT="-X18"
-    - rvm: ruby-head
-      env: RBXOPT="-X19"
-
-    # exclude ree
-    - rvm: ree
-      env: JRUBY_OPTS="--1.8"
-    - rvm: ree
-      env: JRUBY_OPTS="--1.9"
-    - rvm: ree
-      env: RBXOPT="-X18"
-    - rvm: ree
-      env: RBXOPT="-X19"
-
-    # exclude jruby
-    - rvm: jruby
-      env:
-    - rvm: jruby
-      env: RBXOPT="-X18"
-    - rvm: jruby
-      env: RBXOPT="-X19"
-
-    # exclude rbx
-    - rvm: rbx
-      env:
-    - rvm: rbx
-      env: JRUBY_OPTS="--1.8"
-    - rvm: rbx
-      env: JRUBY_OPTS="--1.9"
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  # - rbx-19mode  # FIXME: uncomment when rbx 1.9 is more stable
 notifications:
   email:
     - piotr.solnica@gmail.com

data/Changelog.md

@@ -1,9 +1,18 @@
-# v0.0.10 to-be-released
+# v0.1.0 to-be-released
+
+[Compare v0.0.10..master](https://github.com/solnic/virtus/compare/v0.0.10...master)
+
+* [feature] New EmbeddedValue attribute (solnic)
+* [feature] Support for scientific notation handling in string => integer coercion (dkubb)
+* [feature] Handling of string => numeric coercion with a leading + sign (dkubb)
+
+
+# v0.0.10 2011-11-21
 
 * [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)
+[Compare v0.0.9..v0.0.10](https://github.com/solnic/virtus/compare/v0.0.9...v0.0.10)
 
 # v0.0.9 2011-10-11
 

data/Gemfile

@@ -3,17 +3,18 @@ source :rubygems
 gemspec
 
 group :metrics do
-  gem 'flay',      '~> 1.4.2'
-  gem 'flog',      '~> 2.5.1'
-  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'
+  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'
 
   platforms :mri_18 do
-    gem 'json',      '~> 1.5.3'
+    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'

data/README.md

@@ -23,9 +23,11 @@ or
 ``` ruby
 # ./Gemfile
 
-gem 'virtus', '0.0.7'
+gem 'virtus'
 ```
 
+*IMPORTANT*: If you are still using Ruby 1.8.7 then you also have to install backports gem!
+
 Examples
 --------
 
@@ -78,6 +80,86 @@ page.views
   # => 0
 ```
 
+**Embedded Value**
+
+``` ruby
+class City
+  include Virtus
+
+  attribute :name, String
+end
+
+class Address
+  include Virtus
+
+  attribute :street,  String
+  attribute :zipcode, String
+  attribute :city,    City
+end
+
+class User
+  include Virtus
+
+  attribute :name,    String
+  attribute :address, Address
+end
+
+user = User.new(:address => {
+  :street => 'Street 1/2', :zipcode => '12345', :city => { :name => 'NYC' } })
+
+user.address.street # => "Street 1/2"
+user.address.city.name # => "NYC"
+```
+
+**Collection Member Coercions**
+
+``` ruby
+# Support "primitive" classes
+
+class Book
+  include Virtus
+
+  attribute :page_numbers, Array[Integer]
+end
+
+book = Book.new(:page_numbers => %w[1 2 3])
+book.page_numbers # => [1, 2, 3]
+
+# Support EmbeddedValues, too!
+class Address
+  include Virtus
+
+  attribute :address,     String
+  attribute :locality,    String
+  attribute :region,      String
+  attribute :postal_code, String
+end
+
+class PhoneNumber
+  include Virtus
+
+  attribute :number, String
+end
+
+class User
+  include Virtus
+
+  attribute :phone_numbers, Array[PhoneNumber]
+  attribute :addresses,     Set[Address]
+end
+
+user = User.new(
+  :phone_numbers => [
+    { :number => '212-555-1212' },
+    { :number => '919-444-3265' } ],
+  :addresses => [
+    { :address => '1234 Any St.', :locality => 'Anytown', :region => "DC", :postal_code => "21234" } ])
+
+user.phone_numbers # => [#<PhoneNumber:0x007fdb2d3bef88 @number="212-555-1212">, #<PhoneNumber:0x007fdb2d3beb00 @number="919-444-3265">]
+
+user.addresses # => #<Set: {#<Address:0x007fdb2d3be448 @address="1234 Any St.", @locality="Anytown", @region="DC", @postal_code="21234">}>
+```
+
 **Adding Coercions**
 
 Virtus comes with a builtin coercion library.
@@ -160,6 +242,8 @@ Credits
 * Dan Kubb ([dkubb](https://github.com/dkubb))
 * Chris Corbyn ([d11wtq](https://github.com/d11wtq))
 * Emmanuel Gomez ([emmanuel](https://github.com/emmanuel))
+* Ryan Closner ([rclosner](https://github.com/rclosner))
+* Yves Senn ([senny](https://github.com/senny))
 
 
 Contributing

data/TODO

@@ -1,2 +1,20 @@
+* Add missing specs:
+  * Add spec file spec/unit/virtus/coercion/time_coercions/to_date_spec.rb for Virtus::Coercion::TimeCoercions#to_date
+  * Add spec file spec/unit/virtus/coercion/time_coercions/to_time_spec.rb for Virtus::Coercion::TimeCoercions#to_time
+  * Add spec file spec/unit/virtus/coercion/time_coercions/to_string_spec.rb for Virtus::Coercion::TimeCoercions#to_string
+  * Add spec file spec/unit/virtus/coercion/time_coercions/to_datetime_spec.rb for Virtus::Coercion::TimeCoercions#to_datetime
+  * Add spec file spec/unit/virtus/coercion/decimal/class_methods/to_decimal_spec.rb for Virtus::Coercion::Decimal.to_decimal
+  * Add spec file spec/unit/virtus/coercion/float/class_methods/to_float_spec.rb for Virtus::Coercion::Float.to_float
+  * Add spec file spec/unit/virtus/coercion/integer/class_methods/to_integer_spec.rb for Virtus::Coercion::Integer.to_integer
+  * Add spec file spec/unit/virtus/coercion/numeric/class_methods/to_float_spec.rb for Virtus::Coercion::Numeric.to_float
+  * Add spec file spec/unit/virtus/coercion/numeric/class_methods/to_integer_spec.rb for Virtus::Coercion::Numeric.to_integer
+  * Add spec file spec/unit/virtus/coercion/numeric/class_methods/to_string_spec.rb for Virtus::Coercion::Numeric.to_string
+  * Add spec file spec/unit/virtus/coercion/numeric/class_methods/to_decimal_spec.rb for Virtus::Coercion::Numeric.to_decimal
+  * Add spec file spec/unit/virtus/coercion/class_methods/element_reference_spec.rb for Virtus::Coercion.[]
+  * Add spec file spec/unit/virtus/coercion/class_methods/primitive_spec.rb for Virtus::Coercion.primitive
+  * Add spec file spec/unit/virtus/attributes_accessor/define_writer_method_spec.rb for Virtus::AttributesAccessor#define_writer_method
+  * Add spec file spec/unit/virtus/attributes_accessor/inspect_spec.rb for Virtus::AttributesAccessor#inspect
+  * Add spec file spec/unit/virtus/attributes_accessor/define_reader_method_spec.rb for Virtus::AttributesAccessor#define_reader_method
+
 * Make #to_time #to_date and #to_datetime work on Ruby 1.8.7 instead of typecasting to string and parsing the value
 * Add support for defining attributes on Modules

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
-threshold: 20
-total_score: 257
+threshold: 19
+total_score: 322

data/config/flog.yml

@@ -1,2 +1,2 @@
 ---
-threshold: 15.9
+threshold: 16.8

data/config/roodi.yml

@@ -1,8 +1,8 @@
 ---
-AbcMetricMethodCheck:            { score: 10.1 }
+AbcMetricMethodCheck:            { score: 12.1 }
 AssignmentInConditionalCheck:    { }
 CaseMissingElseCheck:            { }
-ClassLineCountCheck:             { line_count: 309 }
+ClassLineCountCheck:             { line_count: 319 }
 ClassNameCheck:                  { pattern: !ruby/regexp /\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/ }
 ClassVariableCheck:              { }
 CyclomaticComplexityBlockCheck:  { complexity: 4 }
@@ -11,7 +11,7 @@ EmptyRescueBodyCheck:            { }
 ForLoopCheck:                    { }
 MethodLineCountCheck:            { line_count: 9 }
 MethodNameCheck:                 { pattern: !ruby/regexp /\A(?:[a-z\d](?:_?[a-z\d])+[?!=]?|\[\]=?|==|<=>|<<|[+*&|-])\z/ }
-ModuleLineCountCheck:            { line_count: 315 }
+ModuleLineCountCheck:            { line_count: 325 }
 ModuleNameCheck:                 { pattern: !ruby/regexp /\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/ }
 # TODO: decrease parameter_count to 2 or less
 ParameterNumberCheck:            { parameter_count: 3 }

data/config/site.reek

@@ -8,10 +8,10 @@ UncommunicativeParameterName:
   - !ruby/regexp /[0-9]$/
   - !ruby/regexp /[A-Z]/
 LargeClass:
-  max_methods: 11
+  max_methods: 14
   exclude: []
   enabled: true
-  max_instance_variables: 7
+  max_instance_variables: 8
 UncommunicativeMethodName:
   accept: []
   exclude: []
@@ -27,6 +27,8 @@ LongParameterList:
   overrides: {}
 FeatureEnvy:
   exclude: [
+    Virtus::Attribute::Boolean#value_coerced?,
+    Virtus::ClassMethods#build_attribute,
     Virtus::Coercion::TimeCoercions#to_string,
     Virtus::Coercion::TimeCoercions#coerce_with_method,
     Virtus::TypeLookup#determine_type_from_primitive
@@ -66,7 +68,10 @@ Duplication:
   max_calls: 1
 UtilityFunction:
   max_helper_calls: 1
-  exclude: []
+  exclude: [
+    Virtus::Attribute::Boolean#value_coerced?,
+    Virtus::ClassMethods#build_attribute
+  ]
   enabled: true
 Attribute:
   exclude: []

data/lib/virtus.rb

@@ -31,6 +31,7 @@ require 'virtus/support/descendants_tracker'
 require 'virtus/support/type_lookup'
 require 'virtus/support/options'
 
+require 'virtus/attributes_accessor'
 require 'virtus/class_methods'
 require 'virtus/instance_methods'
 
@@ -45,6 +46,7 @@ require 'virtus/coercion/decimal'
 require 'virtus/coercion/false_class'
 require 'virtus/coercion/true_class'
 require 'virtus/coercion/hash'
+require 'virtus/coercion/array'
 require 'virtus/coercion/time_coercions'
 require 'virtus/coercion/date'
 require 'virtus/coercion/date_time'
@@ -56,7 +58,9 @@ require 'virtus/attribute/default_value'
 require 'virtus/attribute'
 require 'virtus/attribute/object'
 require 'virtus/attribute/class'
+require 'virtus/attribute/collection'
 require 'virtus/attribute/array'
+require 'virtus/attribute/set'
 require 'virtus/attribute/boolean'
 require 'virtus/attribute/date'
 require 'virtus/attribute/date_time'
@@ -67,3 +71,4 @@ require 'virtus/attribute/hash'
 require 'virtus/attribute/integer'
 require 'virtus/attribute/string'
 require 'virtus/attribute/time'
+require 'virtus/attribute/embedded_value'

data/lib/virtus/attribute.rb

@@ -8,6 +8,11 @@ module Virtus
     extend TypeLookup
     extend Options
 
+    accept_options :primitive, :accessor, :reader,
+      :writer, :coercion_method, :default
+
+    accessor :public
+
     # Returns name of the attribute
     #
     # @example
@@ -27,7 +32,7 @@ module Virtus
 
     # Returns instance variable name of the attribute
     #
-    # @return [String]
+    # @return [Symbol]
     #
     # @api private
     attr_reader :instance_variable_name
@@ -60,16 +65,75 @@ module Virtus
     # @api private
     attr_reader :default
 
-    DEFAULT_ACCESSOR = :public
+    # Builds an attribute instance
+    #
+    # @param [Symbol] name
+    #   the name of an attribute
+    #
+    # @param [Class] type
+    #   the type class of an attribute
+    #
+    # @param [#to_hash] options
+    #   the extra options hash
+    #
+    # @return [Attribute]
+    #
+    # @api private
+    def self.build(name, type, options = {})
+      attribute_class = determine_type(type) or
+        raise ArgumentError, "#{type.inspect} does not map to an attribute type"
+      attribute_options = attribute_class.merge_options(type, options)
+      attribute_class.new(name, attribute_options)
+    end
 
-    OPTIONS = [ :primitive, :accessor, :reader,
-                :writer, :coercion_method, :default ].freeze
+    # Determine attribute type based on class or name
+    #
+    # Returns Attribute::EmbeddedValue if a virtus class is passed
+    #
+    # @example
+    #   address_class = Class.new { include Virtus }
+    #   Virtus::Attribute.determine_type(address_class) # => Virtus::Attribute::EmbeddedValue
+    #
+    # @see Virtus::Support::TypeLookup.determine_type
+    #
+    # @return [Class]
+    #
+    # @api public
+    def self.determine_type(class_or_name)
+      case class_or_name
+      when ::Class
+        if class_or_name <= Virtus
+          Attribute::EmbeddedValue
+        else
+          super
+        end
+      when ::Array, ::Set
+        super(class_or_name.class)
+      else
+        super
+      end
+    end
 
-    accept_options *OPTIONS
+    # A hook for Attributes to update options based on the type from the caller
+    #
+    # @param [Object] type
+    #   The raw type, typically given by the caller of ClassMethods#attribute
+    # @param [Hash] options
+    #   Attribute configuration options
+    #
+    # @return [Hash]
+    #   New Hash instance, potentially updated with information from the args
+    #
+    # @api private
+    #
+    # @todo add type arg to Attribute#initialize signature and handle there?
+    def self.merge_options(type, options)
+      options
+    end
 
     # Initializes an attribute instance
     #
-    # @param [Symbol] name
+    # @param [#to_sym] name
     #   the name of an attribute
     #
     # @param [#to_hash] options
@@ -79,14 +143,13 @@ module Virtus
     #
     # @api private
     def initialize(name, options = {})
-      @name    = name
-      @options = self.class.options.merge(options.to_hash).freeze
-
-      @instance_variable_name = "@#{@name}".freeze
+      @name                   = name.to_sym
+      @options                = self.class.options.merge(options).freeze
+      @instance_variable_name = "@#{@name}".to_sym
+      @primitive              = @options.fetch(:primitive)
       @coercion_method        = @options.fetch(:coercion_method)
       @default                = DefaultValue.new(self, @options[:default])
-
-      set_visibility
+      initialize_visibility
     end
 
     # Returns a concise string representation of the attribute instance
@@ -99,7 +162,7 @@ module Virtus
     #
     # @api public
     def inspect
-      "#<#{self.class.name} @name=#{name.inspect}>"
+      "#<#{self.class.inspect} @name=#{name.inspect}>"
     end
 
     # Returns value of an attribute for the given instance
@@ -118,7 +181,9 @@ module Virtus
       if instance.instance_variable_defined?(instance_variable_name)
         get!(instance)
       else
-        set!(instance, default.evaluate(instance))
+        value = default.evaluate(instance)
+        set!(instance, value)
+        value
       end
     end
 
@@ -157,6 +222,7 @@ module Virtus
     # @api public
     def set!(instance, value)
       instance.instance_variable_set(instance_variable_name, value)
+      self
     end
 
     # Converts the given value to the primitive type
@@ -175,6 +241,39 @@ module Virtus
       Coercion[value.class].send(coercion_method, value)
     end
 
+    # Is the given value coerced into the target type for this attribute?
+    #
+    # @example
+    #   string_attribute = Virtus::Attribute::String.new(:str)
+    #   string_attribute.value_coerced?('foo')        # => true
+    #   string_attribute.value_coerced?(:foo)         # => false
+    #   integer_attribute = Virtus::Attribute::Integer.new(:integer)
+    #   integer_attribute.value_coerced?(5)           # => true
+    #   integer_attribute.value_coerced?('5')         # => false
+    #   date_attribute = Virtus::Attribute::Date.new(:date)
+    #   date_attribute.value_coerced?('2011-12-31')   # => false
+    #   date_attribute.value_coerced?(Date.today)     # => true
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    def value_coerced?(value)
+      @primitive === value
+    end
+
+    # Define reader and writer methods for an Attribute
+    #
+    # @param [Attribute] attribute
+    #
+    # @return [self]
+    #
+    # @api private
+    def define_accessor_methods(mod)
+      define_reader_method(mod)
+      define_writer_method(mod)
+      self
+    end
+
     # Creates an attribute reader method
     #
     # @param [Module] mod
@@ -183,12 +282,7 @@ module Virtus
     #
     # @api private
     def define_reader_method(mod)
-      reader_method_name = name
-      attribute          = self
-
-      mod.send(:define_method,    reader_method_name) { attribute.get(self) }
-      mod.send(reader_visibility, reader_method_name)
-
+      mod.define_reader_method(self, name, reader_visibility)
       self
     end
 
@@ -200,26 +294,39 @@ module Virtus
     #
     # @api private
     def define_writer_method(mod)
-      writer_method_name = "#{name}="
-      attribute          = self
+      mod.define_writer_method(self, "#{name}=".to_sym, writer_visibility)
+      self
+    end
 
-      mod.send(:define_method,    writer_method_name) { |value| attribute.set(self, value) }
-      mod.send(writer_visibility, writer_method_name)
+    # Returns a Boolean indicating whether the reader method is public
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    def public_reader?
+      reader_visibility == :public
+    end
 
-      self
+    # Returns a Boolean indicating whether the writer method is public
+    #
+    # @return [Boolean]
+    #
+    # @api private
+    def public_writer?
+      writer_visibility == :public
     end
 
   private
 
-    # Sets visibility of reader/write methods based on the options hash
+    # Initialize visibility of reader/write methods based on the options hash
     #
     # @return [undefined]
     #
     # @api private
-    def set_visibility
-      default_accessor   = @options.fetch(:accessor, self.class::DEFAULT_ACCESSOR)
-      @reader_visibility = @options.fetch(:reader,   default_accessor)
-      @writer_visibility = @options.fetch(:writer,   default_accessor)
+    def initialize_visibility
+      default_accessor = @options.fetch(:accessor)
+      @reader_visibility = @options.fetch(:reader, default_accessor)
+      @writer_visibility = @options.fetch(:writer, default_accessor)
     end
 
   end # class Attribute