virtus 0.0.2 → 0.0.3

data/lib/virtus/attribute/array.rb

@@ -0,0 +1,17 @@
+module Virtus
+  class Attribute
+    # Example usage:
+    #
+    #   class Post
+    #     include Virtus
+    #
+    #     attribute :tags, Array
+    #   end
+    #
+    #   post = Post.new(:tags => %w(red green blue))
+    class Array < Object
+      primitive ::Array
+      complex   true
+    end # Integer
+  end # Attributes
+end # Virtus

data/lib/virtus/attribute/boolean.rb

@@ -0,0 +1,60 @@
+module Virtus
+  class Attribute
+    # Bolean attribute allows true or false values to be set
+    # Additionally it adds boolean reader method, like "admin?"
+    #
+    # Example usage:
+    #
+    #   class Post
+    #     include Virtus
+    #
+    #     attribute :published, Boolean
+    #   end
+    #
+    #   post = Post.new(:published => false)
+    #   post.published? # => false
+    #
+    class Boolean < Object
+      primitive TrueClass
+
+      # Returns if the given value is either true or false
+      #
+      # @return [TrueClass,FalseClass]
+      #
+      # @api private
+      def primitive?(value)
+        value.equal?(true) || value.equal?(false)
+      end
+
+      # Coerce value into true or false
+      #
+      # @see Virtus::Typecast::Boolean.call
+      #
+      # @return [TrueClass,FalseClass]
+      #
+      # @api private
+      def typecast_to_primitive(value)
+        Typecast::Boolean.call(value)
+      end
+
+      # Creates standard and boolean attribute reader methods
+      #
+      # @return [NilClass]
+      #
+      # @api private
+      def add_reader_method(model)
+        super
+
+        model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          chainable(:attribute) do
+            #{reader_visibility}
+
+            def #{name}?
+              #{name}
+            end
+          end
+        RUBY
+      end
+    end # Boolean
+  end # Attributes
+end # Virtus

data/lib/virtus/attribute/date.rb

@@ -0,0 +1,35 @@
+module Virtus
+  class Attribute
+    # Example usage:
+    #
+    #   class Post
+    #     include Virtus
+    #
+    #     attribute :published_on, Date
+    #   end
+    #
+    #   Post.new(:published_on => Date.today)
+    #
+    #   # typecasting from a string
+    #   Post.new(:published_on => '2011/06/09')
+    #
+    #   # typecasting from a hash
+    #   Post.new(:published_on => { :year => 2011, :month => 6, :day => 9 })
+    #
+    #   # typecasting from an object which implements #to_date
+    #   Post.new(:published_on => DateTime.now)
+    #
+    class Date < Object
+      primitive ::Date
+
+      # @see Virtus::Typecast::Time.to_date
+      #
+      # @return [Date]
+      #
+      # @api private
+      def typecast_to_primitive(value)
+        Typecast::Time.to_date(value)
+      end
+    end # Date
+  end # Attributes
+end # Virtus

data/lib/virtus/attribute/date_time.rb

@@ -0,0 +1,34 @@
+module Virtus
+  class Attribute
+    # Example usage:
+    #
+    #   class Post
+    #     include Virtus
+    #
+    #     attribute :published_at, DateTime
+    #   end
+    #
+    #   Post.new(:published_at => DateTime.now)
+    #
+    #   # typecasting from a string
+    #   Post.new(:published_on => '2011/06/09 10:48')
+    #
+    #   # typecasting from a hash
+    #   Post.new(:published_on => {
+    #     :year => 2011, :month => 6, :day => 9, :hour => 10, :minutes => 48 })
+    #
+    #   # typecasting from an object which implements #to_datetime
+    #   Post.new(:published_on => Time.now)
+    #
+    class DateTime < Object
+      primitive ::DateTime
+
+      # @see Virtus::Typecast::Time.to_datetime
+      #
+      # @api private
+      def typecast_to_primitive(value)
+        Typecast::Time.to_datetime(value)
+      end
+    end # DateTime
+  end # Attributes
+end # Virtus

data/lib/virtus/attribute/decimal.rb

@@ -0,0 +1,24 @@
+module Virtus
+  class Attribute
+    # Example usage:
+    #
+    #   class ExchangeRate
+    #     include Virtus
+    #
+    #     attribute :dollar, Decimal
+    #   end
+    #
+    #   ExchangeRate.new(:dollar => '2.6948')
+    #
+    class Decimal < Numeric
+      primitive ::BigDecimal
+
+      # @see Virtus::Typecast::Numeric.to_d
+      #
+      # @api private
+      def typecast_to_primitive(value)
+        Typecast::Numeric.to_d(value)
+      end
+    end # Decimal
+  end # Attributes
+end # Virtus

data/lib/virtus/attribute/float.rb

@@ -0,0 +1,33 @@
+module Virtus
+  class Attribute
+    # Example usage:
+    #
+    #   class ExchangeRate
+    #     include Virtus
+    #
+    #     attribute :dollar, Float
+    #   end
+    #
+    #   ExchangeRate.new(:dollar => 2.69)
+    #
+    #   # typecasting from a string
+    #   ExchangeRate.new(:dollar => '2.69')
+    #
+    #   # typecasting from an integer
+    #   ExchangeRate.new(:dollar => 2)
+    #
+    #   # typecasting from an object which implements #to_f
+    #   ExchangeRate.new(:dollar => BigDecimal.new('2.69')
+    #
+    class Float < Numeric
+      primitive ::Float
+
+      # @see Virtus::Typecast::Numeric.to_f
+      #
+      # @api private
+      def typecast_to_primitive(value)
+        Typecast::Numeric.to_f(value)
+      end
+    end # Float
+  end # Attributes
+end # Virtus

data/lib/virtus/attribute/hash.rb

@@ -0,0 +1,18 @@
+module Virtus
+  class Attribute
+    # Example usage:
+    #
+    #   class Post
+    #     include Virtus
+    #
+    #     attribute :meta, Hash
+    #   end
+    #
+    #   Post.new(:meta => { :tags => %w(foo bar) })
+    #
+    class Hash < Object
+      primitive ::Hash
+      complex   true
+    end # Integer
+  end # Attributes
+end # Virtus

data/lib/virtus/attribute/integer.rb

@@ -0,0 +1,30 @@
+module Virtus
+  class Attribute
+    # Example usage:
+    #
+    #   class Post
+    #     include Virtus
+    #
+    #     attribute :read_count, Integer
+    #   end
+    #
+    #   Post.new(:read_count => 100)
+    #
+    #   # typecasting from a string
+    #   Post.new(:read_count => '100')
+    #
+    #   # typecasting from an object that implements #to_i
+    #   Post.new(:read_count => 100.0)
+    #
+    class Integer < Numeric
+      primitive ::Integer
+
+      # @see Virtus::Typecast::Numeric.to_i
+      #
+      # @api private
+      def typecast_to_primitive(value)
+        Typecast::Numeric.to_i(value)
+      end
+    end # Integer
+  end # Attributes
+end # Virtus

data/lib/virtus/{attributes → attribute}/numeric.rb

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

data/lib/virtus/{attributes → attribute}/object.rb

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

data/lib/virtus/attribute/string.rb

@@ -0,0 +1,31 @@
+module Virtus
+  class Attribute
+    # Example usage
+    #
+    #   class User
+    #     include Virtus
+    #
+    #     attribute :name, String
+    #   end
+    #
+    #   User.new(:name => 'John')
+    #
+    #   # typecasting from an object which implements #to_s
+    #   User.new(:name => :John)
+    #
+    class String < Object
+      primitive ::String
+
+      # Typecast the given value to a string
+      #
+      # @param [Object]
+      #
+      # @return [String]
+      #
+      # @api private
+      def typecast_to_primitive(value)
+        value.to_s
+      end
+    end # String
+  end # Attributes
+end # Virtus

data/lib/virtus/attribute/time.rb

@@ -0,0 +1,34 @@
+module Virtus
+  class Attribute
+    # Example usage:
+    #
+    #   class Post
+    #     include Virtus
+    #
+    #     attribute :published_at, Time
+    #   end
+    #
+    #   Post.new(:published_at => Time.now)
+    #
+    #   # typecasting from a string
+    #   Post.new(:published_at => '2011/06/09 11:08')
+    #
+    #   # typecasting from a hash
+    #   Post.new(:published_at => {
+    #     :year => 2011, :month => 6, :day => 9, :hour => 11, :minutes => 8 })
+    #
+    #   # typecasting from an object which implements #to_time
+    #   Post.new(:published_at => DateTime.now)
+    #
+    class Time < Object
+      primitive ::Time
+
+      # @see Virtus::Typecast::Time.to_time
+      #
+      # @api private
+      def typecast_to_primitive(value)
+        Typecast::Time.to_time(value)
+      end
+    end # Time
+  end # Attributes
+end # Virtus

data/lib/virtus/class_methods.rb

@@ -1,9 +1,9 @@
 module Virtus
+  # Class methods that are added when you include Virtus
   module ClassMethods
-    # Defines an attribute on an object's class.
-    #
-    # Usage:
+    # Defines an attribute on an object's class
     #
+    # @example
     #    class Book
     #      include Virtus
     #
@@ -26,11 +26,28 @@ module Virtus
     #
     # @api public
     def attribute(name, type, options = {})
-      attribute_klass  = Virtus.determine_type(type)
-      attributes[name] = attribute_klass.new(name, self, options)
+      attribute_klass = Virtus.determine_type(type)
+      attribute       = attribute_klass.new(name, options)
+
+      attribute.add_reader_method(self)
+      attribute.add_writer_method(self)
+
+      attributes[name] = attribute
     end
 
-    # Returns all the attributes defined on a Class.
+    # Returns all the attributes defined on a Class
+    #
+    # @example
+    #   class User
+    #     include Virtus
+    #
+    #     attribute :name, String
+    #     attribute :age,  Integer
+    #   end
+    #
+    #   User.attributes # =>
+    #
+    #   TODO: implement inspect so the output is not cluttered - solnic
     #
     # @return [Hash]
     #   an attributes hash indexed by attribute names
@@ -42,11 +59,11 @@ module Virtus
 
     private
 
-    # Hooks into const missing process to determine types of attributes.
+    # 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::Attributes::String and Virtus::Attributes::Integer
     #
     # @param [String] name
     #

data/lib/virtus/instance_methods.rb

@@ -1,7 +1,7 @@
 module Virtus
+  # Instance methods that are added when you include Virtus
   module InstanceMethods
-    # Chains Class.new to be able to set attributes during initialization of
-    # an object.
+    # Set attributes during initialization of an object
     #
     # @param [Hash] attributes
     #   the attributes hash to be set
@@ -15,6 +15,16 @@ module Virtus
 
     # Returns a value of the attribute with the given name
     #
+    # @example
+    #   class User
+    #     include Virtus
+    #
+    #     attribute :name, String
+    #   end
+    #
+    #   user = User.new(:name => 'John')
+    #   user.attribute_get(:name) # => "john"
+    #
     # @param [Symbol] name
     #   a name of an attribute
     #
@@ -28,6 +38,17 @@ module Virtus
 
     # Sets a value of the attribute with the given name
     #
+    # @example
+    #   class User
+    #     include Virtus
+    #
+    #     attribute :name, String
+    #   end
+    #
+    #   user = User.new
+    #   user.attribute_set(:name) # => "john"
+    #   user.name # => "john"
+    #
     # @param [Symbol] name
     #   a name of an attribute
     #
@@ -44,6 +65,17 @@ module Virtus
 
     # Mass-assign of attribute values
     #
+    # @example
+    #   class User
+    #     include Virtus
+    #
+    #     attribute :name, String
+    #     attribute :age,  Integer
+    #   end
+    #
+    #   user = User.new
+    #   user.attributes = { :name => 'John', :age => 28 }
+    #
     # @param [Hash] attributes
     #   a hash of attribute values to be set on an object
     #
@@ -53,14 +85,23 @@ module Virtus
     # @api public
     def attributes=(attributes)
       attributes.each do |name, value|
-        if self.class.public_method_defined?(writer_name = "#{name}=")
-          __send__(writer_name, value)
-        end
+        attribute_set(name, value) if respond_to?("#{name}=")
       end
     end
 
     # Returns a hash of all publicly accessible attributes
     #
+    # @example
+    #   class User
+    #     include Virtus
+    #
+    #     attribute :name, String
+    #     attribute :age,  Integer
+    #   end
+    #
+    #   user = User.new(:name => 'John', :age => 28)
+    #   user.attributes # => { :name => 'John', :age => 28 }
+    #
     # @return [Hash]
     #   the attributes
     #
@@ -68,10 +109,8 @@ module Virtus
     def attributes
       attributes = {}
 
-      self.class.attributes.each do |name, attribute|
-        if self.class.public_method_defined?(name)
-          attributes[name] = __send__(attribute.name)
-        end
+      self.class.attributes.each_key do |name|
+        attributes[name] = attribute_get(name) if respond_to?(name)
       end
 
       attributes