virtus 1.0.1 → 2.0.0

data/lib/virtus/attribute.rb

@@ -13,19 +13,20 @@ module Virtus
   #   # strict mode
   #   attr = Virtus::Attribute.build(Integer, :strict => true)
   #   attr.coerce('not really coercible')
-  #   # => Virtus::CoercionError: Failed to coerce "fsafa" into Integer
+  #   # => Virtus::CoercionError: Failed to coerce "not really coercible" into Integer
   #
   class Attribute
     extend DescendantsTracker, Options, TypeLookup
 
-    include ::Equalizer.new(:type, :options)
+    include Equalizer.new(inspect) << :type << :options
 
-    accept_options :primitive, :accessor, :default, :lazy, :strict, :required, :finalize
+    accept_options :primitive, :accessor, :default, :lazy, :strict, :required, :finalize, :nullify_blank
 
     strict false
     required true
     accessor :public
     finalize true
+    nullify_blank false
 
     # @see Virtus.coerce
     #
@@ -176,6 +177,23 @@ module Virtus
       kind_of?(Strict)
     end
 
+    # Return if the attribute is in the nullify blank coercion mode
+    #
+    # @example
+    #
+    #   attr = Virtus::Attribute.build(String, :nullify_blank => true)
+    #   attr.nullify_blank? # => true
+    #
+    #   attr = Virtus::Attribute.build(String, :nullify_blank => false)
+    #   attr.nullify_blank? # => false
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def nullify_blank?
+      kind_of?(NullifyBlank)
+    end
+
     # Return if the attribute is accepts nil values as valid coercion output
     #
     # @example

data/lib/virtus/attribute/accessor.rb

@@ -34,6 +34,17 @@ module Virtus
         descendant.instance_variable_set('@instance_variable_name', "@#{name}")
       end
 
+      # Return if attribute value is defined
+      #
+      # @param [Object] instance
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def defined?(instance)
+        instance.instance_variable_defined?(instance_variable_name)
+      end
+
       # Return value of the attribute
       #
       # @param [Object] instance

data/lib/virtus/attribute/builder.rb

@@ -25,13 +25,7 @@ module Virtus
     # @api private
     def determine_type
       if type.include?('::')
-        # TODO: wrap it up in Virtus.constantize and use feature-detection to
-        #       pick up either Inflecto or ActiveSupport, whateve is available
-        if defined?(Inflecto)
-          Inflecto.constantize(type)
-        else
-          raise NotImplementedError, 'Virtus needs inflecto gem to constantize namespaced constant names'
-        end
+        Virtus.constantize(type)
       else
         Object.const_get(type)
       end
@@ -53,7 +47,7 @@ module Virtus
 
     # @api private
     def pending?
-      @pending
+      @pending if defined?(@pending)
     end
 
     private
@@ -107,7 +101,7 @@ module Virtus
               determine_type(klass.primitive)
             elsif EmbeddedValue.handles?(klass)
               EmbeddedValue
-            elsif klass < Enumerable
+            elsif klass < Enumerable && !(klass <= Range)
               Collection
             end
         end
@@ -160,10 +154,11 @@ module Virtus
       def initialize_attribute
         @attribute = klass.new(type, options)
 
-        @attribute.extend(Accessor)    if options[:name]
-        @attribute.extend(Coercible)   if options[:coerce]
-        @attribute.extend(Strict)      if options[:strict]
-        @attribute.extend(LazyDefault) if options[:lazy]
+        @attribute.extend(Accessor)     if options[:name]
+        @attribute.extend(Coercible)    if options[:coerce]
+        @attribute.extend(NullifyBlank) if options[:nullify_blank]
+        @attribute.extend(Strict)       if options[:strict]
+        @attribute.extend(LazyDefault)  if options[:lazy]
 
         @attribute.finalize if options[:finalize]
       end

data/lib/virtus/attribute/collection.rb

@@ -66,16 +66,25 @@ 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
 
+      # @api public
+      def value_coerced?(value)
+        super && value.all? { |item| member_type.value_coerced? item }
+      end
+
       # @api private
       def finalize
         return self if finalized?

data/lib/virtus/attribute/default_value.rb

@@ -7,6 +7,8 @@ module Virtus
     class DefaultValue
       extend DescendantsTracker
 
+      include Equalizer.new(inspect) << :value
+
       # Builds a default value instance
       #
       # @return [Virtus::Attribute::DefaultValue]

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/nullify_blank.rb

@@ -0,0 +1,24 @@
+module Virtus
+  class Attribute
+
+    # Attribute extension which nullifies blank attributes when coercion failed
+    #
+    module NullifyBlank
+
+      # @see [Attribute#coerce]
+      #
+      # @api public
+      def coerce(input)
+        output = super
+
+        if !value_coerced?(output) && input.to_s.empty?
+          nil
+        else
+          output
+        end
+      end
+
+    end # NullifyBlank
+
+  end # Attribute
+end # Virtus

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/attribute_set.rb

@@ -43,7 +43,7 @@ module Virtus
     # @api public
     def each
       return to_enum unless block_given?
-      @index.values.uniq.each { |attribute| yield attribute }
+      @index.each { |name, attribute| yield attribute if name.kind_of?(Symbol) }
       self
     end
 
@@ -209,7 +209,7 @@ module Virtus
 
     # @api private
     def skip_default?(object, attribute)
-      attribute.lazy? || object.instance_variable_defined?(attribute.instance_variable_name)
+      attribute.lazy? || attribute.defined?(object)
     end
 
     # Merge the attributes into the index

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
@@ -120,11 +120,7 @@ module Virtus
 
     # @api private
     def extensions
-      super + [
-        Extensions::AllowedWriterMethods,
-        ValueObject::AllowedWriterMethods,
-        ValueObject::InstanceMethods
-      ]
+      super << ValueObject::AllowedWriterMethods << ValueObject::InstanceMethods
     end
 
     # @api private

data/lib/virtus/class_inclusions.rb

@@ -13,7 +13,6 @@ module Virtus
     def self.included(descendant)
       super
       descendant.extend(ClassMethods)
-      descendant.extend(Extensions::AllowedWriterMethods)
       descendant.class_eval { include Methods }
       descendant.class_eval { include InstanceMethods }
       descendant.class_eval { include InstanceMethods::Constructor }

data/lib/virtus/coercer.rb

@@ -3,6 +3,7 @@ module Virtus
   # Abstract coercer class
   #
   class Coercer
+    include Equalizer.new(inspect) << :primitive << :type
 
     # @api private
     attr_reader :primitive, :type

data/lib/virtus/configuration.rb

@@ -12,55 +12,34 @@ module Virtus
     # Access the strict setting for this instance
     attr_accessor :strict
 
+    # Access the nullify_blank setting for this instance
+    attr_accessor :nullify_blank
+
+    # Access the required setting for this instance
+    attr_accessor :required
+
     # Access the constructor setting for this instance
     attr_accessor :constructor
 
     # 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)
+      @nullify_blank   = options.fetch(:nullify_blank, false)
+      @required        = options.fetch(:required, true)
+      @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
@@ -84,6 +63,8 @@ module Virtus
       { :coerce             => coerce,
         :finalize           => finalize,
         :strict             => strict,
+        :nullify_blank      => nullify_blank,
+        :required           => required,
         :configured_coercer => coercer }.freeze
     end
 

data/lib/virtus/extensions.rb

@@ -18,7 +18,6 @@ module Virtus
       object.instance_eval do
         extend Methods
         extend InstanceMethods
-        extend AllowedWriterMethods
         extend InstanceMethods::MassAssignment
       end
     end
@@ -72,26 +71,9 @@ module Virtus
       def values(&block)
         private :attributes= if instance_methods.include?(:attributes=)
         yield
-        include(::Equalizer.new(*attribute_set.map(&:name)))
+        include(Equalizer.new(name, attribute_set.map(&:name)))
       end
 
-      private
-
-      # Return an attribute set for that instance
-      #
-      # @return [AttributeSet]
-      #
-      # @api private
-      def attribute_set
-        @attribute_set
-      end
-
-    end # Methods
-
-    module AllowedWriterMethods
-      WRITER_METHOD_REGEXP   = /=\z/.freeze
-      INVALID_WRITER_METHODS = %w[ == != === []= attributes= ].to_set.freeze
-
       # The list of writer methods that can be mass-assigned to in #attributes=
       #
       # @return [Set]
@@ -106,8 +88,18 @@ module Virtus
           end
       end
 
-    end # AllowedWriterMethods
+      private
 
-  end # module Extensions
+      # Return an attribute set for that instance
+      #
+      # @return [AttributeSet]
+      #
+      # @api private
+      def attribute_set
+        @attribute_set
+      end
 
+    end # Methods
+
+  end # module Extensions
 end # module Virtus

data/lib/virtus/instance_methods.rb

@@ -14,7 +14,7 @@ module Virtus
       #
       # @api private
       def initialize(attributes = nil)
-        self.class.attribute_set.set(self, attributes) if attributes
+        attribute_set.set(self, attributes) if attributes
         set_default_attributes
       end
 
@@ -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
       #
@@ -191,7 +192,7 @@ module Virtus
     #
     # @api public
     def set_default_attributes!
-      attribute_set.set_defaults(self, proc { |_| false })
+      attribute_set.set_defaults(self, proc { |object, attribute| attribute.defined?(object) })
       self
     end
 

data/lib/virtus/model.rb

@@ -31,7 +31,7 @@ module Virtus
         descendant.extend(Extensions::Methods)
         descendant.extend(InstanceMethods)
       end
-      private_class_method :included
+      private_class_method :extended
 
     end # Core
 
@@ -51,7 +51,6 @@ module Virtus
       # @api private
       def self.included(descendant)
         super
-        descendant.extend(Extensions::AllowedWriterMethods)
         descendant.send(:include, InstanceMethods::MassAssignment)
       end
       private_class_method :included
@@ -59,7 +58,6 @@ module Virtus
       # @api private
       def self.extended(descendant)
         super
-        descendant.extend(Extensions::AllowedWriterMethods)
         descendant.extend(InstanceMethods::MassAssignment)
       end
       private_class_method :extended