virtus 0.0.4 → 0.0.5

data/lib/virtus/attribute/boolean.rb

@@ -13,7 +13,7 @@ module Virtus
     #   end
     #
     #   post = Post.new(:published => false)
-    #   post.published? # => false
+    #   post.published?  # => false
     #
     class Boolean < Object
       primitive TrueClass
@@ -21,14 +21,14 @@ 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
+      #   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]
+      # @return [Boolean]
       #
-      # @api semipublic
+      # @api public
       def self.primitive?(value)
         value.equal?(true) || value.equal?(false)
       end
@@ -37,7 +37,7 @@ module Virtus
       #
       # @see Virtus::Typecast::Boolean.call
       #
-      # @return [TrueClass,FalseClass]
+      # @return [Boolean]
       #
       # @api private
       def typecast_to_primitive(value)
@@ -46,7 +46,9 @@ module Virtus
 
       # Creates standard and boolean attribute reader methods
       #
-      # @return [NilClass]
+      # @param [Class] model
+      #
+      # @return [self]
       #
       # @api private
       def add_reader_method(model)
@@ -56,15 +58,17 @@ module Virtus
         method_name = "#{name}?"
 
         model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          module AttributeMethods
-            def #{method_name}
-              #{name}
-            end
-          end
-          include AttributeMethods
+          module AttributeMethods   # module AttributeMethods
+            def #{method_name}      #   def active?
+              #{name}               #     @active
+            end                     #   end
+          end                       # end
+          include AttributeMethods  # include AttributeMethods
         RUBY
 
         model.send(reader_visibility, method_name)
+
+        self
       end
 
     end # class Boolean

data/lib/virtus/attribute/date_time.rb

@@ -26,6 +26,8 @@ module Virtus
 
       # @see Virtus::Typecast::Time.to_datetime
       #
+      # @return [DateTime]
+      #
       # @api private
       def typecast_to_primitive(value)
         Typecast::Time.to_datetime(value)

data/lib/virtus/attribute/decimal.rb

@@ -16,6 +16,8 @@ module Virtus
 
       # @see Virtus::Typecast::Numeric.to_d
       #
+      # @return [BigDecimal]
+      #
       # @api private
       def typecast_to_primitive(value)
         Typecast::Numeric.to_d(value)

data/lib/virtus/attribute/float.rb

@@ -25,6 +25,8 @@ module Virtus
 
       # @see Virtus::Typecast::Numeric.to_f
       #
+      # @return [Float]
+      #
       # @api private
       def typecast_to_primitive(value)
         Typecast::Numeric.to_f(value)

data/lib/virtus/attribute/integer.rb

@@ -22,6 +22,8 @@ module Virtus
 
       # @see Virtus::Typecast::Numeric.to_i
       #
+      # @return [Integer]
+      #
       # @api private
       def typecast_to_primitive(value)
         Typecast::Numeric.to_i(value)

data/lib/virtus/attribute/string.rb

@@ -19,6 +19,8 @@ module Virtus
 
       # @see Virtus::Typecast::String.call
       #
+      # @return [String]
+      #
       # @api private
       def typecast_to_primitive(value)
         Virtus::Typecast::String.call(value)

data/lib/virtus/attribute/time.rb

@@ -16,7 +16,12 @@ module Virtus
     #
     #   # typecasting from a hash
     #   Post.new(:published_at => {
-    #     :year => 2011, :month => 6, :day => 9, :hour => 11, :minutes => 8 })
+    #     :year    => 2011,
+    #     :month   => 6,
+    #     :day     => 9,
+    #     :hour    => 11,
+    #     :minutes => 8
+    #   })
     #
     #   # typecasting from an object which implements #to_time
     #   Post.new(:published_at => DateTime.now)
@@ -26,6 +31,8 @@ module Virtus
 
       # @see Virtus::Typecast::Time.to_time
       #
+      # @return [Time]
+      #
       # @api private
       def typecast_to_primitive(value)
         Typecast::Time.to_time(value)

data/lib/virtus/class_methods.rb

@@ -28,7 +28,7 @@ module Virtus
     #
     # @api public
     def attribute(name, type, options = {})
-      attribute = Virtus.determine_type(type).new(name, options)
+      attribute = Attribute.determine_type(type).new(name, options)
 
       attribute.add_reader_method(self)
       attribute.add_writer_method(self)
@@ -49,12 +49,11 @@ module Virtus
     #     attribute :age,  Integer
     #   end
     #
-    #   User.attributes # =>
+    #   User.attributes  # =>
     #
     #   TODO: implement inspect so the output is not cluttered - solnic
     #
-    # @return [Hash]
-    #   an attributes hash indexed by attribute names
+    # @return [AttributeSet]
     #
     # @api public
     def attributes
@@ -79,7 +78,7 @@ module Virtus
     #
     # @api private
     def const_missing(name)
-      Virtus.determine_type(name) || super
+      Attribute.determine_type(name) || super
     end
 
   end # module ClassMethods

data/lib/virtus/instance_methods.rb

@@ -8,7 +8,7 @@ module Virtus
     # @param [#to_hash] attributes
     #   the attributes hash to be set
     #
-    # @return [Object]
+    # @return [undefined]
     #
     # @api private
     def initialize(attributes = {})
@@ -25,7 +25,7 @@ module Virtus
     #   end
     #
     #   user = User.new(:name => 'John')
-    #   user[:name] # => "john"
+    #   user[:name]  # => "John"
     #
     # @param [Symbol] name
     #   a name of an attribute
@@ -48,8 +48,8 @@ module Virtus
     #   end
     #
     #   user = User.new
-    #   user[:name] = "john" # => "john"
-    #   user.name # => "john"
+    #   user[:name] = "John"  # => "John"
+    #   user.name             # => "John"
     #
     # @param [Symbol] name
     #   a name of an attribute
@@ -76,10 +76,9 @@ module Virtus
     #   end
     #
     #   user = User.new(:name => 'John', :age => 28)
-    #   user.attributes # => { :name => 'John', :age => 28 }
+    #   user.attributes  # => { :name => 'John', :age => 28 }
     #
     # @return [Hash]
-    #   the attributes
     #
     # @api public
     def attributes
@@ -110,7 +109,6 @@ module Virtus
     #   a hash of attribute values to be set on an object
     #
     # @return [Hash]
-    #   the attributes
     #
     # @api public
     def attributes=(attributes)
@@ -125,6 +123,8 @@ module Virtus
     #
     # @see Virtus::InstanceMethods#[]
     #
+    # @return [Object]
+    #
     # @api private
     def attribute_get(name)
       __send__(name)
@@ -134,6 +134,8 @@ module Virtus
     #
     # @see Virtus::InstanceMethods#[]=
     #
+    # @return [Object]
+    #
     # @api private
     def attribute_set(name, value)
       __send__("#{name}=", value)

data/lib/virtus/support/descendants_tracker.rb

@@ -3,27 +3,41 @@ module Virtus
   # A module that adds descendant tracking to a class
   module DescendantsTracker
 
-    # Hook called when class is inherited
+    # Return the descendants of this class
+    #
+    # @return [Array<Class>]
+    #
+    # @api private
+    def descendants
+      @descendants ||= []
+    end
+
+    # Add the descendant to this class and the superclass
     #
     # @param [Class] descendant
     #
     # @return [self]
     #
     # @api private
-    def inherited(descendant)
+    def add_descendant(descendant)
       superclass = self.superclass
-      superclass.inherited(descendant) if superclass.respond_to?(:descendants)
+      superclass.add_descendant(descendant) if superclass.respond_to?(:add_descendant)
       descendants.unshift(descendant)
       self
     end
 
-    # Return the descendants of this class
+  private
+
+    # Hook called when class is inherited
     #
-    # @return [Array<Class>]
+    # @param [Class] descendant
+    #
+    # @return [self]
     #
     # @api private
-    def descendants
-      @descendants ||= []
+    def inherited(descendant)
+      super
+      add_descendant(descendant)
     end
 
   end # module DescendantsTracker

data/lib/virtus/typecast/boolean.rb

@@ -5,23 +5,23 @@ module Virtus
     # See TRUE_VALUES and FALSE_VALUES constants for a reference.
     class Boolean
 
-      TRUE_VALUES  = [ 1, '1', 't', 'T', 'true',  'TRUE'  ].freeze
-      FALSE_VALUES = [ 0, '0', 'f', 'F', 'false', 'FALSE' ].freeze
+      TRUE_VALUES  = %w[ 1 t true  ].freeze
+      FALSE_VALUES = %w[ 0 f false ].freeze
       BOOLEAN_MAP  = Hash[ TRUE_VALUES.product([ true ]) + FALSE_VALUES.product([ false ]) ].freeze
 
       # Typecast value to TrueClass or FalseClass
       #
       # @example
-      #   Virtus::Typecast::Boolean.call('T') # => true
-      #   Virtus::Typecast::Boolean.call('F') # => false
+      #   Virtus::Typecast::Boolean.call('T')  # => true
+      #   Virtus::Typecast::Boolean.call('F')  # => false
       #
-      # @param [Integer, String]
+      # @param [#to_s]
       #
-      # @return [TrueClass, FalseClass]
+      # @return [Boolean]
       #
       # @api public
       def self.call(value)
-        BOOLEAN_MAP.fetch(value, value)
+        BOOLEAN_MAP.fetch(value.to_s.downcase, value)
       end
 
     end # class Boolean

data/lib/virtus/typecast/numeric.rb

@@ -9,8 +9,8 @@ module Virtus
       # Typecast value to integer
       #
       # @example
-      #   Virtus::Typecast::Numeric.to_i('1') # => 1
-      #   Virtus::Typecast::Numeric.to_i(1.2) # => 1
+      #   Virtus::Typecast::Numeric.to_i('1')  # => 1
+      #   Virtus::Typecast::Numeric.to_i(1.2)  # => 1
       #
       # @param [Object] value
       #
@@ -24,8 +24,8 @@ module Virtus
       # Typecast value to float
       #
       # @example
-      #   Virtus::Typecast::Numeric.to_f('1.2') # => 1.2
-      #   Virtus::Typecast::Numeric.to_f(1)     # => 1.0
+      #   Virtus::Typecast::Numeric.to_f('1.2')  # => 1.2
+      #   Virtus::Typecast::Numeric.to_f(1)      # => 1.0
       #
       # @param [Object] value
       #
@@ -39,8 +39,8 @@ module Virtus
       # Typecast value to decimal
       #
       # @example
-      #   Virtus::Typecast::Numeric.to_d('1.2') # => #<BigDecimal:b72157d4,'0.12E1',8(8)>
-      #   Virtus::Typecast::Numeric.to_d(1)     # => #<BigDecimal:b7212e08,'0.1E1',4(8)>
+      #   Virtus::Typecast::Numeric.to_d('1.2')  # => #<BigDecimal:b72157d4,'0.12E1',8(8)>
+      #   Virtus::Typecast::Numeric.to_d(1)      # => #<BigDecimal:b7212e08,'0.1E1',4(8)>
       #
       # @param [Object] value
       #
@@ -55,8 +55,6 @@ module Virtus
         end
       end
 
-    private
-
       # Match numeric string
       #
       # @param [#to_str, Numeric] value
@@ -82,6 +80,8 @@ module Virtus
         end
       end
 
+      private_class_method :call
+
     end # class Numeric
   end # module Typecast
 end # module Virtus

data/lib/virtus/typecast/string.rb

@@ -7,8 +7,8 @@ module Virtus
       # Typecast value to a string
       #
       # @example
-      #   Virtus::Typecast::String.call(1)  # => '1'
-      #   Virtus::Typecast::String.call([]) # => '[]'
+      #   Virtus::Typecast::String.call(1)   # => "1"
+      #   Virtus::Typecast::String.call([])  # => "[]"
       #
       # @param [Object] value
       #

data/lib/virtus/typecast/time.rb

@@ -19,7 +19,7 @@ module Virtus
       #   Virtus::Typecast::Time.to_time('2011/06/09 12:01')
       #   # => Thu Jun 09 12:01:00 +0200 2011
       #
-      # @param [Hash, #to_mash, #to_s] value
+      # @param [#to_hash, #to_s] value
       #   value to be typecast
       #
       # @return [Time]
@@ -38,7 +38,7 @@ module Virtus
       #   Virtus::Typecast::Time.to_date('2011/06/09')
       #   # => #<Date: 4911443/2,0,2299161>
       #
-      # @param [Hash, #to_mash, #to_s] value
+      # @param [#to_hash, #to_s] value
       #   value to be typecast
       #
       # @return [Date]
@@ -57,7 +57,7 @@ module Virtus
       #   Virtus::Typecast::Time.to_datetime('2011/06/09 12:01')
       #   # => #<DateTime: 3536239681/1440,0,2299161>
       #
-      # @param [Hash, #to_mash, #to_s] value
+      # @param [#to_hash, #to_s] value
       #   value to be typecast
       #
       # @return [DateTime]
@@ -68,15 +68,21 @@ module Virtus
         call(value, :to_datetime)
       end
 
-    private
-
+      # Coerce the value into a Date, Time or DateTime object
+      #
+      # @param [#to_hash, #to_s] value
+      #
+      # @param [Symbol] method
+      #
+      # @return [Object]
+      #
       # @api private
       def self.call(value, method)
         return value.send(method) if value.respond_to?(method)
 
         begin
-          if value.kind_of?(::Hash)
-            from_hash(value, method)
+          if value.respond_to?(:to_hash)
+            from_hash(value.to_hash, method)
           else
             from_string(value.to_s, method)
           end
@@ -85,70 +91,90 @@ module Virtus
         end
       end
 
+      private_class_method :call
+
+      # Coerce the string into a Date, Time or DateTime object
+      #
+      # @param [String] value
+      #
+      # @param [Symbol] method
+      #
+      # @return [Object]
+      #
       # @api private
       def self.from_string(value, method)
-        METHOD_TO_CLASS[method].parse(value.to_s)
+        METHOD_TO_CLASS[method].parse(value)
       end
 
+      private_class_method :from_string
+
+      # Coerce the Hash into a Date, Time or DateTime object
+      #
+      # @param [Hash] value
+      #
+      # @param [Symbol] method
+      #
+      # @return [Object]
+      #
       # @api private
       def self.from_hash(value, method)
         send("hash_#{method}", value)
       end
 
+      private_class_method :from_hash
+
       # Creates a Time instance from a Hash
       #
       # Valid keys are: :year, :month, :day, :hour, :min, :sec
       #
-      # @param [Hash, #to_mash] value
-      #   value to be typecast
+      # @param [Hash] value
       #
       # @return [Time]
-      #   Time constructed from hash
       #
       # @api private
       def self.hash_to_time(value)
         ::Time.local(*extract(value))
       end
 
+      private_class_method :hash_to_time
+
       # Creates a Date instance from a Hash
       #
       # Valid keys are: :year, :month, :day, :hour
       #
-      # @param [Hash, #to_mash] value
-      #   value to be typecast
+      # @param [Hash] value
       #
       # @return [Date]
-      #   Date constructed from hash
       #
       # @api private
       def self.hash_to_date(value)
         ::Date.new(*extract(value).first(3))
       end
 
+      private_class_method :hash_to_date
+
       # Creates a DateTime instance from a Hash
       #
       # Valid keys are: :year, :month, :day, :hour, :min, :sec
       #
-      # @param [Hash, #to_mash] value
-      #   value to be typecast
+      # @param [Hash] value
       #
       # @return [DateTime]
-      #   DateTime constructed from hash
       #
       # @api private
       def self.hash_to_datetime(value)
         ::DateTime.new(*extract(value))
       end
 
-      # Extracts the given args from the hash
+      private_class_method :hash_to_datetime
+
+      # Extracts the given args from a Hash
       #
       # If a value does not exist, it uses the value of Time.now
       #
-      # @param [Hash, #to_mash] value
-      #   value to extract time args from
+      # @param [Hash] value
       #
       # @return [Array]
-      #   Extracted values
       #
       # @api private
       def self.extract(value)
@@ -159,6 +185,8 @@ module Virtus
         end
       end
 
+      private_class_method :extract
+
     end # class Time
   end # module Typecast
 end # module Virtus