virtus 0.0.5 → 0.0.6

data/lib/virtus/coercion.rb

@@ -0,0 +1,32 @@
+module Virtus
+
+  # Coerce abstract class
+  #
+  # @abstract
+  #
+  class Coercion
+    extend DescendantsTracker
+    extend TypeLookup
+    extend Options
+
+    accept_options :primitive
+
+    # Return a class that matches given name
+    #
+    # Defaults to Virtus::Coercion::Object
+    #
+    # @example
+    #   Virtus::Coercion['String'] # => Virtus::Coercion::String
+    #   Virtus::Coercion[String]   # => Virtus::Coercion::String
+    #
+    # @param [String]
+    #
+    # @return [Class]
+    #
+    # @api private
+    def self.[](name)
+      determine_type(name) || Coercion::Object
+    end
+
+  end # Coerce
+end # Virtus

data/lib/virtus/coercion/date.rb

@@ -0,0 +1,26 @@
+module Virtus
+  class Coercion
+
+    # Coerce Date values
+    class Date < Object
+      extend TimeCoercions
+
+      primitive ::Date
+
+      # Passthrough the value
+      #
+      # @example
+      #   Virtus::Coercion::DateTime.to_date(date)  # => Date object
+      #
+      # @param [DateTime] value
+      #
+      # @return [Date]
+      #
+      # @api public
+      def self.to_date(value)
+        value
+      end
+
+    end # class Date
+  end # class Coercion
+end # module Virtus

data/lib/virtus/coercion/date_time.rb

@@ -0,0 +1,26 @@
+module Virtus
+  class Coercion
+
+    # Coerce DateTime values
+    class DateTime < Object
+      primitive ::DateTime
+
+      extend TimeCoercions
+
+      # Passthrough the value
+      #
+      # @example
+      #   Virtus::Coercion::DateTime.to_datetime(datetime)  # => DateTime object
+      #
+      # @param [DateTime] value
+      #
+      # @return [Date]
+      #
+      # @api public
+      def self.to_datetime(value)
+        value
+      end
+
+    end # class DateTime
+  end # class Coercion
+end # module Virtus

data/lib/virtus/coercion/decimal.rb

@@ -0,0 +1,40 @@
+module Virtus
+  class Coercion
+
+    # Coerce BigDecimal values
+    class Decimal < Numeric
+      primitive ::BigDecimal
+
+      FLOAT_FORMAT = 'F'.freeze
+
+      # Coerce given value to String
+      #
+      # @example
+      #   Virtus::Coercion::BigDecimal.to_string(BigDecimal('1.0')) # => "1.0"
+      #
+      # @param [BigDecimal] value
+      #
+      # @return [String]
+      #
+      # @api public
+      def self.to_string(value)
+        value.to_s(FLOAT_FORMAT)
+      end
+
+      # Passthrough the value
+      #
+      # @example
+      #   Virtus::Coercion::BigDecimal.to_decimal(BigDecimal('1.0')) # => BigDecimal('1.0')
+      #
+      # @param [BigDecimal] value
+      #
+      # @return [Fixnum]
+      #
+      # @api public
+      def self.to_decimal(value)
+        value
+      end
+
+    end # class BigDecimal
+  end # class Coercion
+end # module Virtus

data/lib/virtus/coercion/false_class.rb

@@ -0,0 +1,24 @@
+module Virtus
+  class Coercion
+
+    # Coerce false values
+    class FalseClass < Object
+      primitive ::FalseClass
+
+      # Coerce given value to String
+      #
+      # @example
+      #   Virtus::Coercion::FalseClass.to_string(false)  # => "false"
+      #
+      # @param [FalseClass] value
+      #
+      # @return [String]
+      #
+      # @api public
+      def self.to_string(value)
+        value.to_s
+      end
+
+    end # class FalseClass
+  end # class Coercion
+end # module Virtus

data/lib/virtus/coercion/float.rb

@@ -0,0 +1,24 @@
+module Virtus
+  class Coercion
+
+    # Coerce Float values
+    class Float < Numeric
+      primitive ::Float
+
+      # Passthrough the value
+      #
+      # @example
+      #   Virtus::Coercion::Float.to_float(1.0)  # => 1.0
+      #
+      # @param [Float] value
+      #
+      # @return [Integer]
+      #
+      # @api public
+      def self.to_float(value)
+        value
+      end
+
+    end # class Float
+  end # class Coercion
+end # module Virtus

data/lib/virtus/coercion/hash.rb

@@ -0,0 +1,82 @@
+module Virtus
+  class Coercion
+
+    # Coerce Hash values
+    class Hash < Object
+      primitive ::Hash
+
+      TIME_SEGMENTS = [ :year, :month, :day, :hour, :min, :sec ].freeze
+
+      # Creates an Array instance from a Hash
+      #
+      # @param [Hash] value
+      #
+      # @return [Array]
+      #
+      # @api private
+      def self.to_array(value)
+        value.to_a
+      end
+
+      # Creates a Time instance from a Hash
+      #
+      # Valid keys are: :year, :month, :day, :hour, :min, :sec
+      #
+      # @param [Hash] value
+      #
+      # @return [Time]
+      #
+      # @api private
+      def self.to_time(value)
+        ::Time.local(*extract(value))
+      end
+
+      # Creates a Date instance from a Hash
+      #
+      # Valid keys are: :year, :month, :day, :hour
+      #
+      # @param [Hash] value
+      #
+      # @return [Date]
+      #
+      # @api private
+      def self.to_date(value)
+        ::Date.new(*extract(value).first(3))
+      end
+
+      # Creates a DateTime instance from a Hash
+      #
+      # Valid keys are: :year, :month, :day, :hour, :min, :sec
+      #
+      # @param [Hash] value
+      #
+      # @return [DateTime]
+      #
+      # @api private
+      def self.to_datetime(value)
+        ::DateTime.new(*extract(value))
+      end
+
+      # Extracts the given args from a Hash
+      #
+      # If a value does not exist, it uses the value of Time.now
+      #
+      # @param [Hash] value
+      #
+      # @return [Array]
+      #
+      # @api private
+      def self.extract(value)
+        now = ::Time.now
+
+        TIME_SEGMENTS.map do |segment|
+          val = value.fetch(segment, now.send(segment))
+          Coercion[val.class.name].to_integer(val)
+        end
+      end
+
+      private_class_method :extract
+
+    end # class Hash
+  end # class Coercion
+end # module Virtus

data/lib/virtus/coercion/integer.rb

@@ -0,0 +1,60 @@
+module Virtus
+  class Coercion
+
+    # Coerce Fixnum values
+    class Integer < Numeric
+      primitive ::Integer
+
+      # Coerce given value to String
+      #
+      # @example
+      #   Virtus::Coercion::Fixnum.to_string(1)  # => "1"
+      #
+      # @param [Fixnum] value
+      #
+      # @return [String]
+      #
+      # @api public
+      def self.to_string(value)
+        value.to_s
+      end
+
+      # Passthrough the value
+      #
+      # @example
+      #   Virtus::Coercion::Fixnum.to_integer(1)  # => 1
+      #
+      # @param [Fixnum] value
+      #
+      # @return [Float]
+      #
+      # @api public
+      def self.to_integer(value)
+        value
+      end
+
+      # Coerce given value to a Boolean
+      #
+      # @example with a 1
+      #   Virtus::Coercion::Fixnum.to_boolean(1)  # => true
+      #
+      # @example with a 0
+      #   Virtus::Coercion::Fixnum.to_boolean(0)  # => false
+      #
+      # @param [Fixnum] value
+      #
+      # @return [BigDecimal]
+      #
+      # @api public
+      def self.to_boolean(value)
+        case value
+        when 1 then true
+        when 0 then false
+        else
+          value
+        end
+      end
+
+    end # class Fixnum
+  end # class Coercion
+end # module Virtus

data/lib/virtus/coercion/numeric.rb

@@ -0,0 +1,66 @@
+module Virtus
+  class Coercion
+
+    # Base class for all numeric Coercion classes
+    class Numeric < Object
+      primitive ::Numeric
+
+      # Coerce given value to String
+      #
+      # @example
+      #   Virtus::Coercion::Float.to_string(1.0)  # => "1.0"
+      #
+      # @param [Float] value
+      #
+      # @return [String]
+      #
+      # @api public
+      def self.to_string(value)
+        value.to_s
+      end
+
+      # Creates a Fixnum instance from a numeric object
+      #
+      # @example
+      #   Virtus::Coercion::BigDecimal.to_integer(BigDecimal('1.0'))  # => 1
+      #
+      # @param [BigDecimal] value
+      #
+      # @return [Fixnum]
+      #
+      # @api public
+      def self.to_integer(value)
+        value.to_i
+      end
+
+      # Creates a Float instance from a numeric object
+      #
+      # @example
+      #   Virtus::Coercion::BigDecimal.to_float(BigDecimal('1.0'))  # => 1.0
+      #
+      # @param [BigDecimal] value
+      #
+      # @return [Fixnum]
+      #
+      # @api public
+      def self.to_float(value)
+        value.to_f
+      end
+
+      # Coerce given value to BigDecimal
+      #
+      # @example
+      #   Virtus::Coercion::Float.to_decimal(1.0)  # => BigDecimal('1.0')
+      #
+      # @param [Float] value
+      #
+      # @return [BigDecimal]
+      #
+      # @api public
+      def self.to_decimal(value)
+        to_string(value).to_d
+      end
+
+    end
+  end # class Coercion
+end # module Virtus

data/lib/virtus/coercion/object.rb

@@ -0,0 +1,25 @@
+module Virtus
+  class Coercion
+
+    # Coerce Object values
+    class Object < Coercion
+      primitive ::Object
+
+      # Passthrough given value
+      #
+      # @param [Object] value
+      #
+      # @return [Object]
+      #
+      # @api private
+      def self.method_missing(method, *args)
+        if method.to_s[0, 3] == 'to_' && args.size == 1
+          args.first
+        else
+          super
+        end
+      end
+
+    end # class Object
+  end # class Coercion
+end # module Virtus

data/lib/virtus/coercion/string.rb

@@ -0,0 +1,155 @@
+module Virtus
+  class Coercion
+
+    # Coerce String values
+    class String < Object
+      primitive ::String
+
+      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
+
+      NUMERIC_REGEXP = /\A(-?(?:0|[1-9]\d*)(?:\.\d+)?|(?:\.\d+))\z/.freeze
+
+      # Coerce given value to Time
+      #
+      # @example
+      #   Virtus::Coercion::String.to_time(string)  # => Time object
+      #
+      # @param [String] value
+      #
+      # @return [Time]
+      #
+      # @api public
+      def self.to_time(value)
+        parse_value(::Time, value)
+      end
+
+      # Coerce given value to Date
+      #
+      # @example
+      #   Virtus::Coercion::String.to_date(string)  # => Date object
+      #
+      # @param [String] value
+      #
+      # @return [Date]
+      #
+      # @api public
+      def self.to_date(value)
+        parse_value(::Date, value)
+      end
+
+      # Coerce given value to DateTime
+      #
+      # @example
+      #   Virtus::Coercion::String.to_datetime(string)  # => DateTime object
+      #
+      # @param [String] value
+      #
+      # @return [DateTime]
+      #
+      # @api public
+      def self.to_datetime(value)
+        parse_value(::DateTime, value)
+      end
+
+      # Coerce value to TrueClass or FalseClass
+      #
+      # @example with "T"
+      #   Virtus::Coercion::String.to_boolean('T')  # => true
+      #
+      # @example with "F"
+      #   Virtus::Coercion::String.to_boolean('F')  # => false
+      #
+      # @param [#to_s]
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def self.to_boolean(value)
+        BOOLEAN_MAP.fetch(value.downcase, value)
+      end
+
+      # Coerce value to integer
+      #
+      # @example
+      #   Virtus::Coercion::String.to_integer('1')  # => 1
+      #
+      # @param [Object] value
+      #
+      # @return [Integer]
+      #
+      # @api public
+      def self.to_integer(value)
+        to_numeric(value, :to_i)
+      end
+
+      # Coerce value to float
+      #
+      # @example
+      #   Virtus::Coercion::String.to_float('1.2')  # => 1.2
+      #
+      # @param [Object] value
+      #
+      # @return [Float]
+      #
+      # @api public
+      def self.to_float(value)
+        to_numeric(value, :to_f)
+      end
+
+      # Coerce value to decimal
+      #
+      # @example
+      #   Virtus::Coercion::String.to_decimal('1.2')  # => #<BigDecimal:b72157d4,'0.12E1',8(8)>
+      #
+      # @param [Object] value
+      #
+      # @return [BigDecimal]
+      #
+      # @api public
+      def self.to_decimal(value)
+        to_numeric(value, :to_d)
+      end
+
+      # Match numeric string
+      #
+      # @param [String] value
+      #   value to typecast
+      # @param [Symbol] method
+      #   method to typecast with
+      #
+      # @return [Numeric]
+      #   number if matched, value if no match
+      #
+      # @api private
+      def self.to_numeric(value, method)
+        if value =~ NUMERIC_REGEXP
+          $1.send(method)
+        else
+          value
+        end
+      end
+
+      private_class_method :to_numeric
+
+      # Parse the value or return it as-is if it is invalid
+      #
+      # @param [#parse] parser
+      #
+      # @param [String] value
+      #
+      # @return [Time]
+      #
+      # @api private
+      def self.parse_value(parser, value)
+        parser.parse(value)
+      rescue ArgumentError
+        return value
+      end
+
+      private_class_method :parse_value
+
+    end # class String
+  end # class Coercion
+end # module Virtus