virtus 0.3.0 → 0.4.0

data/Changelog.md

@@ -1,4 +1,12 @@
-# v0.3.0 to-be-released
+# v0.4.0 2012-03-22
+
+* [improvement] Add a caching mechanism for type lookups (solnic)
+* [fixed] Fix attributes mass-assignment when nil is passed (fgrehm)
+* [changed] Replace usage of #to_hash with Hash.try_convert (dkubb)
+
+[Compare v0.3.0..v0.4.0](https://github.com/solnic/virtus/compare/v0.3.0...master)
+
+# v0.3.0 2012-02-25
 
 * [feature] Support for default values from a symbol (which can be a method name) (solnic)
 * [feature] Support for mass-assignment via custom setters not generated with attribute (fgrehm)
@@ -13,7 +21,7 @@
 * [BREAKING CHANGE] Removed Attribute#instance_variable_name - this is a private ivar (solnic)
 * [BREAKING CHANGE] Removed Equalizer#host_name and Equalizer#keys (solnic)
 
-[Compare v0.2.0..master](https://github.com/solnic/virtus/compare/v0.2.0...master)
+[Compare v0.2.0..v0.3.0](https://github.com/solnic/virtus/compare/v0.2.0...v0.3.0)
 
 # v0.2.0 2012-02-08
 

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+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" }
+end
+

data/README.md

@@ -61,13 +61,16 @@ class Page
   include Virtus
 
   attribute :title, String
-  
+
   # default from a singleton value (integer in this case)
   attribute :views, Integer, :default => 0
-  
+
+  # default from a singleton value (boolean in this case)
+  attribute :published, Boolean, :default => false
+
   # default from a callable object (proc in this case)
   attribute :slug, String, :default => lambda { |page, attribute| page.title.downcase.gsub(' ', '-') }
-  
+
   # default from a method name as symbol
   attribute :editor_title, String,  :default => :default_editor_title
 
@@ -76,10 +79,11 @@ class Page
   end
 end
 
-page = Page.new(:title => 'Virtus Is Awesome', :editor_title => 'Virtus README')
-page.slug # => 'virtus-is-awesome'
-page.views # => 0
-page.editor_title # => "UNPUBSLISHED: Virtus README"
+page = Page.new(:title => 'Virtus README')
+page.slug         # => 'virtus-readme'
+page.views        # => 0
+page.published    # => false
+page.editor_title # => "UNPUBLISHED: Virtus README"
 ```
 
 **Embedded Value**
@@ -238,7 +242,7 @@ user.password # => '3858f62230ac3c915f300c664312c63f'
 ``` ruby
 require 'json'
 
-module MyAppClass
+module MyApp
 
   # Defining the custom attribute(s)
   module Attributes

data/TODO

@@ -1,36 +1 @@
-* Add missing specs:
-  * Add spec file spec/unit/virtus/attribute/collection/member_coercion/coerce_and_append_member_spec.rb for Virtus::Attribute::Collection::MemberCoercion#coerce_and_append_member
-  * Add spec file spec/unit/virtus/attribute/collection/member_type_spec.rb for Virtus::Attribute::Collection#member_type
-  * Add spec file spec/unit/virtus/attribute/collection/new_collection_spec.rb for Virtus::Attribute::Collection#new_collection
-  * Add spec file spec/unit/virtus/attribute/collection/coerce_and_append_member_spec.rb for Virtus::Attribute::Collection#coerce_and_append_member
-  * Add spec file spec/unit/virtus/attribute/default_value/from_symbol/class_methods/handle_spec.rb for Virtus::Attribute::DefaultValue::FromSymbol.handle?
-  * Add spec file spec/unit/virtus/attribute/default_value/from_symbol/evaluate_spec.rb for Virtus::Attribute::DefaultValue::FromSymbol#evaluate
-  * Add spec file spec/unit/virtus/attribute/default_value/from_callable/class_methods/handle_spec.rb for Virtus::Attribute::DefaultValue::FromCallable.handle?
-  * Add spec file spec/unit/virtus/attribute/default_value/from_callable/evaluate_spec.rb for Virtus::Attribute::DefaultValue::FromCallable#evaluate
-  * Add spec file spec/unit/virtus/attribute/default_value/from_clonable/class_methods/handle_spec.rb for Virtus::Attribute::DefaultValue::FromClonable.handle?
-  * Add spec file spec/unit/virtus/attribute/default_value/from_clonable/evaluate_spec.rb for Virtus::Attribute::DefaultValue::FromClonable#evaluate
-  * Add spec file spec/unit/virtus/attribute/default_value/class_methods/build_spec.rb for Virtus::Attribute::DefaultValue.build
-  * Add spec file spec/unit/virtus/coercion/string/class_methods/to_symbol_spec.rb for Virtus::Coercion::String.to_symbol
-  * Add spec file spec/unit/virtus/coercion/time/class_methods/to_integer_spec.rb for Virtus::Coercion::Time.to_integer
-  * 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/time_coercions/to_time_spec.rb for Virtus::Coercion::TimeCoercions#to_time
-  * 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_string_spec.rb for Virtus::Coercion::TimeCoercions#to_string
-  * Add spec file spec/unit/virtus/coercion/array/class_methods/to_set_spec.rb for Virtus::Coercion::Array.to_set
-  * 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_decimal_spec.rb for Virtus::Coercion::Numeric.to_decimal
-  * 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/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/value_object/class_methods/attribute_spec.rb for Virtus::ValueObject::ClassMethods#attribute
-  * Add spec file spec/unit/virtus/value_object/instance_methods/with_spec.rb for Virtus::ValueObject::InstanceMethods#with
-  * Add spec file spec/unit/virtus/value_object/equalizer/append_spec.rb for Virtus::ValueObject::Equalizer#<<
-  * Add spec file spec/unit/virtus/value_object/equalizer/compile_spec.rb for Virtus::ValueObject::Equalizer#compile
-  * Add spec file spec/unit/virtus/attributes_accessor/define_reader_method_spec.rb for Virtus::AttributesAccessor#define_reader_method
-  * Add spec file spec/unit/virtus/attributes_accessor/define_writer_method_spec.rb for Virtus::AttributesAccessor#define_writer_method
-
 * Make #to_time #to_date and #to_datetime work on Ruby 1.8.7 instead of typecasting to string and parsing the value

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
 threshold: 19
-total_score: 326
+total_score: 344

data/config/site.reek

@@ -94,7 +94,9 @@ DataClump:
   max_copies: 2
   min_clump_size: 2
 ControlCouple:
-  exclude: []
+  exclude: [
+    'Virtus::InstanceMethods#initialize'
+  ]
   enabled: true
 LongYieldList:
   max_params: 1

data/lib/virtus.rb

@@ -83,3 +83,4 @@ require 'virtus/attribute/symbol'
 require 'virtus/attribute/string'
 require 'virtus/attribute/time'
 require 'virtus/attribute/embedded_value'
+

data/lib/virtus/attribute.rb

@@ -217,7 +217,7 @@ module Virtus
     #
     # @api public
     def coerce(value)
-      Coercion[value.class].send(coercion_method, value)
+      Coercion[value.class].public_send(coercion_method, value)
     end
 
     # Is the given value coerced into the target type for this attribute?

data/lib/virtus/attribute/collection.rb

@@ -63,8 +63,8 @@ module Virtus
       def coerce(value)
         coerced = super
         return coerced unless coerced.respond_to?(:inject)
-        coerced.inject(new_collection) do |collection, entry|
-          coerce_and_append_member(collection, entry)
+        coerced.inject(new_collection) do |*args|
+          coerce_and_append_member(*args)
         end
       end
 

data/lib/virtus/attribute/default_value/from_symbol.rb

@@ -16,7 +16,7 @@ module Virtus
           value.is_a?(::Symbol)
         end
 
-        # Evaluates the value via instance#__send__(value)
+        # Evaluates the value via instance#public_send(value)
         #
         # Symbol value is returned if the instance doesn't respond to value
         #
@@ -26,7 +26,7 @@ module Virtus
         #
         # @api private
         def evaluate(instance)
-          instance.respond_to?(@value) ? instance.__send__(@value) : @value
+          instance.respond_to?(@value) ? instance.public_send(@value) : @value
         end
 
       end # class FromSymbol

data/lib/virtus/attribute_set.rb

@@ -4,17 +4,6 @@ module Virtus
   class AttributeSet
     include Enumerable
 
-    # Return the parent attributes
-    #
-    # @return [AttributeSet]
-    #   the parent attributes
-    #
-    # @return [nil]
-    #   nil if there are no parent attributes
-    #
-    # @api private
-    attr_reader :parent
-
     # Initialize an AttributeSet
     #
     # @param [AttributeSet] parent
@@ -27,7 +16,6 @@ module Virtus
       @parent       = parent
       @attributes   = attributes.dup
       @index        = {}
-      @string_index = {}
       reset
     end
 
@@ -47,7 +35,7 @@ module Virtus
     # @api public
     def each
       return to_enum unless block_given?
-      @index.each_value { |attribute| yield attribute }
+      @index.values.uniq.each { |attribute| yield attribute }
       self
     end
 
@@ -92,7 +80,7 @@ module Virtus
     #
     # @api public
     def [](name)
-      @index.fetch(name) { @string_index[name] }
+      @index[name]
     end
 
     # Set an attribute by name
@@ -117,8 +105,7 @@ module Virtus
     #
     # @api private
     def reset
-      parent = self.parent
-      merge_attributes(parent) if parent
+      merge_attributes(@parent) if @parent
       merge_attributes(@attributes)
       self
     end
@@ -146,7 +133,7 @@ module Virtus
     #
     # @api private
     def update_index(name, attribute)
-      @index[name] = @string_index[name.to_s.freeze] = attribute
+      @index[name] = @index[name.to_s.freeze] = attribute
     end
 
   end # class AttributeSet

data/lib/virtus/attributes_accessor.rb

@@ -3,25 +3,6 @@ module Virtus
   # Host attribute accessor methods
   class AttributesAccessor < Module
 
-    # The inspect value of this Module
-    #
-    # This provides meaningful output when inspecting the ancestors
-    # of a class/module that includes this module
-    #
-    # @example
-    #
-    #   class ClassWithAttributes
-    #     include Virtus
-    #   end
-    #
-    #   mod = ClassWithAttributes.send(:virtus_setup_attributes_accessor_module)
-    #   mod.inspect
-    #
-    # @return [String]
-    #
-    # @api public
-    attr_reader :inspect
-
     # Initialize a module for hosting Attribute access methods
     #
     # @param [Symbol, String] name
@@ -29,7 +10,7 @@ module Virtus
     # @api private
     def initialize(name)
       super()
-      @inspect = "#{name}::AttributesAccessor"
+      @name = name
     end
 
     # Defines an attribute reader method
@@ -62,5 +43,26 @@ module Virtus
       self
     end
 
+    # The inspect value of this Module
+    #
+    # This provides meaningful output when inspecting the ancestors
+    # of a class/module that includes this module
+    #
+    # @example
+    #
+    #   class ClassWithAttributes
+    #     include Virtus
+    #   end
+    #
+    #   mod = ClassWithAttributes.send(:virtus_setup_attributes_accessor_module)
+    #   mod.inspect
+    #
+    # @return [String]
+    #
+    # @api public
+    def inspect
+      "#{@name}::AttributesAccessor"
+    end
+
   end
 end

data/lib/virtus/class_methods.rb

@@ -76,7 +76,7 @@ module Virtus
       return @attributes if defined?(@attributes)
       superclass  = self.superclass
       method      = __method__
-      parent      = superclass.send(method) if superclass.respond_to?(method)
+      parent      = superclass.public_send(method) if superclass.respond_to?(method)
       @attributes = AttributeSet.new(parent)
     end
 

data/lib/virtus/coercion/hash.rb

@@ -59,7 +59,7 @@ module Virtus
         now = ::Time.now
 
         TIME_SEGMENTS.map do |segment|
-          val = value.fetch(segment, now.send(segment))
+          val = value.fetch(segment, now.public_send(segment))
           Coercion[val.class.name].to_integer(val)
         end
       end

data/lib/virtus/coercion/object.rb

@@ -115,7 +115,7 @@ module Virtus
       #
       # @api private
       def self.coerce_with_method(value, method)
-        value.respond_to?(method) ? value.send(method) : value
+        value.respond_to?(method) ? value.public_send(method) : value
       end
 
       private_class_method :coerce_with_method

data/lib/virtus/coercion/string.rb

@@ -27,15 +27,28 @@ module Virtus
       def self.to_constant(value)
         names = value.split('::')
         names.shift if names.first.empty?
-        names.inject(::Object) do |mod, name|
-          if mod.const_defined?(name, *EXTRA_CONST_ARGS)
-            mod.const_get(name, *EXTRA_CONST_ARGS)
-          else
-            mod.const_missing(name)
-          end
+        names.inject(::Object) { |*args| constant_lookup(*args) }
+      end
+
+      # Lookup a constant within a module
+      #
+      # @param [Module] mod
+      #
+      # @param [String] name
+      #
+      # @return [Object]
+      #
+      # @api private
+      def self.constant_lookup(mod, name)
+        if mod.const_defined?(name, *EXTRA_CONST_ARGS)
+          mod.const_get(name, *EXTRA_CONST_ARGS)
+        else
+          mod.const_missing(name)
         end
       end
 
+      private_class_method :constant_lookup
+
       # Coerce give value to a symbol
       #
       # @example
@@ -167,7 +180,7 @@ module Virtus
       # @api private
       def self.to_numeric(value, method)
         if value =~ NUMERIC_REGEXP
-          $1.send(method)
+          $1.public_send(method)
         else
           value
         end

data/lib/virtus/coercion/time_coercions.rb

@@ -74,7 +74,11 @@ module Virtus
       # @api private
       def coerce_with_method(value, method)
         coerced = super
-        coerced.equal?(value) ? String.send(method, to_string(value)) : coerced
+        if coerced.equal?(value)
+          String.public_send(method, to_string(value))
+        else
+          coerced
+        end
       end
 
     end # module TimeCoercions

data/lib/virtus/instance_methods.rb

@@ -11,8 +11,8 @@ module Virtus
     # @return [undefined]
     #
     # @api private
-    def initialize(attribute_values = {})
-      self.attributes = attribute_values
+    def initialize(attributes = nil)
+      self.attributes = attributes if attributes
     end
 
     # Returns a value of the attribute with the given name
@@ -87,7 +87,7 @@ module Virtus
 
     # Mass-assign attribute values
     #
-    # Keys in the +attribute_values+ param can be symbols or strings.
+    # Keys in the +attributes+ param can be symbols or strings.
     # All referenced Attribute writer methods *will* be called.
     # Non-attribute setter methods on the receiver *will* be called.
     #
@@ -102,14 +102,14 @@ module Virtus
     #   user = User.new
     #   user.attributes = { :name => 'John', 'age' => 28 }
     #
-    # @param [#to_hash] attribute_values
+    # @param [#to_hash] attributes
     #   a hash of attribute names and values to set on the receiver
     #
     # @return [Hash]
     #
     # @api public
-    def attributes=(attribute_values)
-      set_attributes(attribute_values)
+    def attributes=(attributes)
+      set_attributes(attributes)
     end
 
     # Returns a hash of all publicly accessible attributes
@@ -153,8 +153,8 @@ module Virtus
     # @return [Hash]
     #
     # @api private
-    def set_attributes(attribute_values)
-      attribute_values.each do |name, value|
+    def set_attributes(attributes)
+      ::Hash.try_convert(attributes).each do |name, value|
         set_attribute(name, value) if self.class.allowed_writer_methods.include?("#{name}=")
       end
     end

data/lib/virtus/support/type_lookup.rb

@@ -5,6 +5,17 @@ module Virtus
 
     TYPE_FORMAT = /\A[A-Z]\w*\z/.freeze
 
+    # Set cache ivar on the model
+    #
+    # @param [Class] model
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def self.extended(model)
+      model.instance_variable_set('@type_lookup_cache', {})
+    end
+
     # Returns a descendant based on a name or class
     #
     # @example
@@ -21,14 +32,7 @@ module Virtus
     #
     # @api public
     def determine_type(class_or_name)
-      case class_or_name
-      when singleton_class
-        determine_type_from_descendant(class_or_name)
-      when Class
-        determine_type_from_primitive(class_or_name)
-      else
-        determine_type_from_string(class_or_name.to_s)
-      end
+      @type_lookup_cache[class_or_name] ||= determine_type_and_cache(class_or_name)
     end
 
     # Return the default primitive supported
@@ -42,6 +46,18 @@ module Virtus
 
   private
 
+    # @api private
+    def determine_type_and_cache(class_or_name)
+      type = case class_or_name
+      when singleton_class
+        determine_type_from_descendant(class_or_name)
+      when Class
+        determine_type_from_primitive(class_or_name)
+      else
+        determine_type_from_string(class_or_name.to_s)
+      end
+    end
+
     # Return the class given a descendant
     #
     # @param [Class] descendant