virtus 0.0.3 → 0.0.4

data/lib/virtus/attribute/array.rb

@@ -1,5 +1,6 @@
 module Virtus
   class Attribute
+
     # Example usage:
     #
     #   class Post
@@ -12,6 +13,6 @@ module Virtus
     class Array < Object
       primitive ::Array
       complex   true
-    end # Integer
-  end # Attributes
-end # Virtus
+    end # class Array
+  end # class Attribute
+end # module Virtus

data/lib/virtus/attribute/boolean.rb

@@ -1,5 +1,6 @@
 module Virtus
   class Attribute
+
     # Bolean attribute allows true or false values to be set
     # Additionally it adds boolean reader method, like "admin?"
     #
@@ -19,10 +20,16 @@ module Virtus
 
       # Returns if the given value is either true or false
       #
+      # @example
+      #   Virtus::Attribute::Boolean.primitive?(true)   # => true
+      #   Virtus::Attribute::Boolean.primitive?(false)  # => true
+      #   Virtus::Attribute::Boolean.primitive?(1)      # => false
+      #   Virtus::Attribute::Boolean.primitive?('true') # => false
+      #
       # @return [TrueClass,FalseClass]
       #
-      # @api private
-      def primitive?(value)
+      # @api semipublic
+      def self.primitive?(value)
         value.equal?(true) || value.equal?(false)
       end
 
@@ -45,16 +52,21 @@ module Virtus
       def add_reader_method(model)
         super
 
-        model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          chainable(:attribute) do
-            #{reader_visibility}
+        name        = self.name
+        method_name = "#{name}?"
 
-            def #{name}?
+        model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          module AttributeMethods
+            def #{method_name}
               #{name}
             end
           end
+          include AttributeMethods
         RUBY
+
+        model.send(reader_visibility, method_name)
       end
-    end # Boolean
-  end # Attributes
-end # Virtus
+
+    end # class Boolean
+  end # class Attribute
+end # module Virtus

data/lib/virtus/attribute/date.rb

@@ -1,5 +1,6 @@
 module Virtus
   class Attribute
+
     # Example usage:
     #
     #   class Post
@@ -30,6 +31,7 @@ module Virtus
       def typecast_to_primitive(value)
         Typecast::Time.to_date(value)
       end
-    end # Date
-  end # Attributes
-end # Virtus
+
+    end # class Date
+  end # class Attribute
+end # module Virtus

data/lib/virtus/attribute/date_time.rb

@@ -1,5 +1,6 @@
 module Virtus
   class Attribute
+
     # Example usage:
     #
     #   class Post
@@ -29,6 +30,7 @@ module Virtus
       def typecast_to_primitive(value)
         Typecast::Time.to_datetime(value)
       end
-    end # DateTime
-  end # Attributes
-end # Virtus
+
+    end # class DateTim
+  end # class Attribute
+end # module Virtus

data/lib/virtus/attribute/decimal.rb

@@ -1,5 +1,6 @@
 module Virtus
   class Attribute
+
     # Example usage:
     #
     #   class ExchangeRate
@@ -19,6 +20,7 @@ module Virtus
       def typecast_to_primitive(value)
         Typecast::Numeric.to_d(value)
       end
-    end # Decimal
-  end # Attributes
-end # Virtus
+
+    end # class Decimal
+  end # class Attribute
+end # module Virtus

data/lib/virtus/attribute/float.rb

@@ -1,5 +1,6 @@
 module Virtus
   class Attribute
+
     # Example usage:
     #
     #   class ExchangeRate
@@ -28,6 +29,7 @@ module Virtus
       def typecast_to_primitive(value)
         Typecast::Numeric.to_f(value)
       end
-    end # Float
-  end # Attributes
-end # Virtus
+
+    end # class Float
+  end # class Attribute
+end # module Virtus

data/lib/virtus/attribute/hash.rb

@@ -1,5 +1,6 @@
 module Virtus
   class Attribute
+
     # Example usage:
     #
     #   class Post
@@ -13,6 +14,6 @@ module Virtus
     class Hash < Object
       primitive ::Hash
       complex   true
-    end # Integer
-  end # Attributes
-end # Virtus
+    end # class Hash
+  end # class Attribute
+end # module Virtus

data/lib/virtus/attribute/integer.rb

@@ -1,5 +1,6 @@
 module Virtus
   class Attribute
+
     # Example usage:
     #
     #   class Post
@@ -25,6 +26,7 @@ module Virtus
       def typecast_to_primitive(value)
         Typecast::Numeric.to_i(value)
       end
-    end # Integer
-  end # Attributes
-end # Virtus
+
+    end # class Integer
+  end # class Attribute
+end # module Virtus

data/lib/virtus/attribute/numeric.rb

@@ -1,8 +1,10 @@
 module Virtus
   class Attribute
+
     # Base class for all numerical attributes
     class Numeric < Object
+      primitive      ::Numeric
       accept_options :min, :max
-    end # Numeric
-  end # Attributes
-end # Virtus
+    end # class Numeric
+  end # class Attribute
+end # module Virtus

data/lib/virtus/attribute/object.rb

@@ -1,9 +1,9 @@
 module Virtus
   class Attribute
+
     # Base class for every attribute
     class Object < Attribute
       primitive ::Object
-      complex   false
-    end # Object
-  end # Attributes
-end # Virtus
+    end # class Object
+  end # class Attribute
+end # module Virtus

data/lib/virtus/attribute/string.rb

@@ -1,5 +1,6 @@
 module Virtus
   class Attribute
+
     # Example usage
     #
     #   class User
@@ -16,16 +17,13 @@ module Virtus
     class String < Object
       primitive ::String
 
-      # Typecast the given value to a string
-      #
-      # @param [Object]
-      #
-      # @return [String]
+      # @see Virtus::Typecast::String.call
       #
       # @api private
       def typecast_to_primitive(value)
-        value.to_s
+        Virtus::Typecast::String.call(value)
       end
-    end # String
-  end # Attributes
-end # Virtus
+
+    end # class String
+  end # class Attribute
+end # module Virtus

data/lib/virtus/attribute/time.rb

@@ -1,5 +1,6 @@
 module Virtus
   class Attribute
+
     # Example usage:
     #
     #   class Post
@@ -29,6 +30,7 @@ module Virtus
       def typecast_to_primitive(value)
         Typecast::Time.to_time(value)
       end
-    end # Time
-  end # Attributes
-end # Virtus
+
+    end # class Time
+  end # class Attribute
+end # module Virtus

data/lib/virtus/attribute_set.rb

@@ -0,0 +1,151 @@
+module Virtus
+
+  # A set of Attribute objects
+  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
+    # @param [Array] attributes
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def initialize(parent = nil, attributes = [])
+      @parent     = parent
+      @attributes = attributes.dup
+      @index      = {}
+      reset
+    end
+
+    # Iterate over each attribute in the set
+    #
+    # @example
+    #   attribute_set = AttributeSet.new(attributes, parent)
+    #   attribute_set.each { |attribute| ... }
+    #
+    # @yield [attribute]
+    #
+    # @yieldparam [Attribute] attribute
+    #   each attribute in the set
+    #
+    # @return [self]
+    #
+    # @api public
+    def each
+      return to_enum unless block_given?
+      @index.each_value { |attribute| yield attribute }
+      self
+    end
+
+    # Adds the attributes to the set
+    #
+    # @example
+    #   attribute_set.merge(attributes)
+    #
+    # @param [Array<Attribute>] attributes
+    #
+    # @return [self]
+    #
+    # @api public
+    def merge(attributes)
+      attributes.each { |attribute| self << attribute }
+      self
+    end
+
+    # Adds an attribute to the set
+    #
+    # @example
+    #   attribute_set << attribute
+    #
+    # @param [Attribute] attribute
+    #
+    # @return [self]
+    #
+    # @api public
+    def <<(attribute)
+      self[attribute.name] = attribute
+      self
+    end
+
+    # Get an attribute by name
+    #
+    # @example
+    #   attribute_set[:name]  # => Attribute object
+    #
+    # @param [Symbol] name
+    #
+    # @return [Attribute]
+    #
+    # @api public
+    def [](name)
+      @index[name]
+    end
+
+    # Set an attribute by name
+    #
+    # @example
+    #   attribute_set[:name] = attribute
+    #
+    # @param [Symbol] name
+    # @param [Attribute] attribute
+    #
+    # @return [Attribute]
+    #
+    # @api public
+    def []=(name, attribute)
+      delete(name)
+      @attributes << attribute
+      @index[name] = attribute
+    end
+
+    # Reset the index when the parent is updated
+    #
+    # @return [self]
+    #
+    # @api private
+    def reset
+      parent = self.parent
+      merge_index(parent) if parent
+      merge_index(@attributes)
+      self
+    end
+
+  private
+
+    # Delete the Attribute by name
+    #
+    # @param [Symbol] name
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def delete(name)
+      @attributes.delete(@index.delete(name))
+    end
+
+    # Add the attributes to the index
+    #
+    # @param [Array<Attribute>] attributes
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def merge_index(attributes)
+      attributes.each { |attribute| @index[attribute.name] = attribute }
+    end
+
+  end # class AttributeSet
+end # module Virtus

data/lib/virtus/class_methods.rb

@@ -1,6 +1,8 @@
 module Virtus
+
   # Class methods that are added when you include Virtus
   module ClassMethods
+
     # Defines an attribute on an object's class
     #
     # @example
@@ -19,20 +21,22 @@ module Virtus
     # @param [Class] type
     #   the type class of an attribute
     #
-    # @param [Hash] options
+    # @param [#to_hash] options
     #   the extra options hash
     #
-    # @return [Virtus::Attributes::Object]
+    # @return [self]
     #
     # @api public
     def attribute(name, type, options = {})
-      attribute_klass = Virtus.determine_type(type)
-      attribute       = attribute_klass.new(name, options)
+      attribute = Virtus.determine_type(type).new(name, options)
 
       attribute.add_reader_method(self)
       attribute.add_writer_method(self)
 
-      attributes[name] = attribute
+      attributes << attribute
+      descendants.each { |descendant| descendant.attributes.reset }
+
+      self
     end
 
     # Returns all the attributes defined on a Class
@@ -54,16 +58,20 @@ module Virtus
     #
     # @api public
     def attributes
-      @attributes ||= {}
+      @attributes ||= begin
+        superclass = self.superclass
+        parent     = superclass.attributes if superclass.respond_to?(:attributes)
+        AttributeSet.new(parent)
+      end
     end
 
-    private
+  private
 
     # Hooks into const missing process to determine types of attributes
     #
     # It is used when an attribute is defined and a global class like String
     # or Integer is provided as the type which needs to be mapped to
-    # Virtus::Attributes::String and Virtus::Attributes::Integer
+    # Virtus::Attribute::String and Virtus::Attribute::Integer
     #
     # @param [String] name
     #
@@ -73,5 +81,6 @@ module Virtus
     def const_missing(name)
       Virtus.determine_type(name) || super
     end
-  end # ClassMethods
-end # Virtus
+
+  end # module ClassMethods
+end # module Virtus