virtus 0.0.4 → 0.0.5

data/Gemfile

@@ -1,8 +1,9 @@
 source :rubygems
 
 group :development do
-  gem 'jeweler', '~> 1.6.4'
-  gem 'rspec',   '~> 2.6.0'
+  gem 'backports', '~> 2.3.0'
+  gem 'jeweler',   '~> 1.6.4'
+  gem 'rspec',     '~> 2.6.0'
 end
 
 group :metrics do
@@ -14,6 +15,7 @@ group :metrics do
 
   platforms :mri_18 do
     gem 'heckle',    '~> 1.4.3'
+    gem 'json',      '~> 1.5.3'
     gem 'metric_fu', '~> 2.1.1'
     gem 'mspec',     '~> 1.5.17'
     gem 'rcov',      '~> 0.9.9'

data/History.txt

@@ -1,3 +1,10 @@
+=== v0.0.5 to-be-released
+
+Details: https://github.com/solnic/virtus/compare/v0.0.4...master
+
+* [BREAKING CHANGE] Moved Virtus.determine_type to Virtus::Attribute.determine_type (dkubb)
+* [general] Added backports as a development dependency (dkubb)
+
 === v0.0.4 2011-07-08
 
 * [BREAKING CHANGE] attributes hash has been replaced by a specialized class AttributeSet (dkubb)

data/README.markdown

@@ -25,20 +25,20 @@ attributes that require typecasting and/or validations.
     end
 
     # setting attributes in the constructor
-    user = User.new(:age => 28)
+    user = User.new(:name => 'Piotr', :age => 28)
 
     # attribute readers
-    user.name # => "Piotr"
+    user.name  # => "Piotr"
 
     # hash of attributes
-    user.attributes # => { :name => "Piotr" }
+    user.attributes  # => { :name => "Piotr" }
 
     # automatic typecasting
     user.age = '28'
-    user.age # => 28
+    user.age  # => 28
 
     user.birthday = 'November 18th, 1983'
-    user.birthday # => #<DateTime: 1983-11-18T00:00:00+00:00 (4891313/2,0/1,2299161)>
+    user.birthday  # => #<DateTime: 1983-11-18T00:00:00+00:00 (4891313/2,0/1,2299161)>
 
 ## Custom Attributes
 
@@ -65,8 +65,8 @@ attributes that require typecasting and/or validations.
 
     user = MyApp::User.new
 
-    user.info = '{"email" : "john@domain.com" }'
-    user.info # => {"email"=>"john@domain.com"}
+    user.info = '{"email":"john@domain.com"}'
+    user.info  # => {"email"=>"john@domain.com"}
 
 ## Note on Patches/Pull Requests
 

data/Rakefile

@@ -4,18 +4,13 @@ require 'jeweler'
 require 'rspec/core/rake_task'
 
 Jeweler::Tasks.new do |gem|
-  gem.name        = "virtus"
+  gem.name        = 'virtus'
   gem.platform    = Gem::Platform::RUBY
-  gem.authors     = ["Piotr Solnica"]
-  gem.email       = ["piotr@rubyverse.com"]
-  gem.homepage    = "https://github.com/solnic/virtus"
-  gem.summary     = %q{Attributes for your plain ruby objects}
+  gem.authors     = [ 'Piotr Solnica' ]
+  gem.email       = [ 'piotr@rubyverse.com' ]
+  gem.homepage    = 'https://github.com/solnic/virtus'
+  gem.summary     = 'Attributes for your plain ruby objects'
   gem.description = gem.summary
-
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  gem.require_paths = ["lib"]
 end
 
 Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
 threshold: 19.0
-total_score: 208
+total_score: 187

data/config/roodi.yml

@@ -2,7 +2,7 @@
 AbcMetricMethodCheck:            { score: 9.5 }
 AssignmentInConditionalCheck:    { }
 CaseMissingElseCheck:            { }
-ClassLineCountCheck:             { line_count: 345 }
+ClassLineCountCheck:             { line_count: 404 }
 ClassNameCheck:                  { pattern: !ruby/regexp /\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/ }
 ClassVariableCheck:              { }
 CyclomaticComplexityBlockCheck:  { complexity: 2 }
@@ -10,9 +10,9 @@ CyclomaticComplexityMethodCheck: { complexity: 3 }
 EmptyRescueBodyCheck:            { }
 ForLoopCheck:                    { }
 # TODO: decrease line_count to 5 to 10
-MethodLineCountCheck:            { line_count: 17 }
+MethodLineCountCheck:            { line_count: 19 }
 MethodNameCheck:                 { pattern: !ruby/regexp /\A(?:[a-z\d](?:_?[a-z\d])+[?!=]?|\[\]=?|==|<=>|<<|[+*&|-])\z/ }
-ModuleLineCountCheck:            { line_count: 351 }
+ModuleLineCountCheck:            { line_count: 410 }
 ModuleNameCheck:                 { pattern: !ruby/regexp /\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/ }
 # TODO: decrease parameter_count to 2 or less
 ParameterNumberCheck:            { parameter_count: 3 }

data/lib/virtus.rb

@@ -11,41 +11,15 @@ module Virtus
 
   # Extends base class with class and instance methods
   #
-  # @param [Class] base
+  # @param [Class] descendant
   #
   # @return [Class]
   #
   # @api private
-  def self.included(base)
-    base.extend(DescendantsTracker)
-    base.extend(ClassMethods)
-    base.send(:include, InstanceMethods)
-  end
-
-  # Returns a Virtus::Attribute::Object sub-class based on a name or class
-  #
-  # @example
-  #   Virtus.determine_type('String') # => Virtus::Attribute::String
-  #
-  # @param [Class,String] class_or_name
-  #   name of a class or a class itself
-  #
-  # @return [Class]
-  #   one of the Virtus::Attribute::Object sub-class
-  #
-  # @api semipublic
-  def self.determine_type(class_or_name)
-    if class_or_name.kind_of?(Class)
-      if class_or_name < Attribute::Object
-        class_or_name
-      else
-        Attribute.descendants.detect do |descendant|
-          class_or_name <= descendant.primitive
-        end
-      end
-    elsif Attribute.const_defined?(name = class_or_name.to_s)
-      Attribute.const_get(name)
-    end
+  def self.included(descendant)
+    descendant.extend(DescendantsTracker)
+    descendant.extend(ClassMethods)
+    descendant.send(:include, InstanceMethods)
   end
 
 end # module Virtus

data/lib/virtus/attribute.rb

@@ -6,6 +6,77 @@ module Virtus
   class Attribute
     extend DescendantsTracker
 
+    # Returns a Virtus::Attribute::Object descendant based on a name or class
+    #
+    # @example
+    #   Attribute.determine_type('String')  # => Virtus::Attribute::String
+    #
+    # @param [Class, #to_s] class_or_name
+    #   name of a class or a class itself
+    #
+    # @return [Class]
+    #   one of the Virtus::Attribute::Object descendants
+    #
+    # @return [nil]
+    #   nil if the type cannot be determined by the class_or_name
+    #
+    # @api public
+    def self.determine_type(class_or_name)
+      # first match on the Attribute singleton class first, then match
+      # any class, finally fallback to matching on the string
+      case class_or_name
+      when Attribute::Object.singleton_class then determine_type_from_attribute(class_or_name)
+      when Class                             then determine_type_from_primitive(class_or_name)
+      else
+        determine_type_from_string(class_or_name.to_s)
+      end
+    end
+
+    # Return the Attribute class given an Attribute descendant
+    #
+    # @param [Class<Attribute>] attribute
+    #
+    # @return [Class<Attribute>]
+    #
+    # @api private
+    def self.determine_type_from_attribute(attribute)
+      attribute
+    end
+
+    private_class_method :determine_type_from_attribute
+
+    # Return the Attribute class given a primitive
+    #
+    # @param [Class] primitive
+    #
+    # @return [Class<Attribute>]
+    #
+    # @return [nil]
+    #   nil if the type cannot be determined by the primitive
+    #
+    # @api private
+    def self.determine_type_from_primitive(primitive)
+      descendants.detect { |descendant| primitive <= descendant.primitive }
+    end
+
+    private_class_method :determine_type_from_primitive
+
+    # Return the Attribute class given a string
+    #
+    # @param [String] string
+    #
+    # @return [Class<Attribute>]
+    #
+    # @return [nil]
+    #   nil if the type cannot be determined by the string
+    #
+    # @api private
+    def self.determine_type_from_string(string)
+      const_get(string) if const_defined?(string)
+    end
+
+    private_class_method :determine_type_from_string
+
     # Returns default options hash for a given attribute class
     #
     # @example
@@ -51,29 +122,23 @@ module Virtus
     #
     # @api public
     def self.accept_options(*new_options)
-      # add new options to the array
-      concat_options(new_options)
-
-      # create methods for each new option
+      add_accepted_options(new_options)
       new_options.each { |option| add_option_method(option) }
-
-      # add new options to all descendants
-      descendants.each { |descendant| descendant.concat_options(new_options) }
-
-      accepted_options
+      descendants.each { |descendant| descendant.add_accepted_options(new_options) }
+      self
     end
 
     # Adds a reader/writer method for the give option name
     #
-    # @return [NilClass]
+    # @return [undefined]
     #
     # @api private
     def self.add_option_method(option)
       class_eval <<-RUBY, __FILE__, __LINE__ + 1
-        def self.#{option}(value = Undefined)          # def self.unique(value = Undefined)
-          return @#{option} if value.equal?(Undefined) #   return @unique if value.equal?(Undefined)
-          @#{option} = value                           #   @unique = value
-        end                                            # end
+        def self.#{option}(value = Undefined)           # def self.primitive(value = Undefined)
+          return @#{option} if value.equal?(Undefined)  #   return @primitive if value.equal?(Undefined)
+          @#{option} = value                            #   @primitive = value
+        end                                             # end
       RUBY
     end
 
@@ -84,14 +149,14 @@ module Virtus
     # @param [#to_hash] new_options
     #   options to be set
     #
-    # @return [Hash]
-    #   default options set on the attribute class
+    # @return [self]
     #
     # @api private
     def self.set_options(new_options)
       new_options.to_hash.each do |option_name, option_value|
         send(option_name, option_value)
       end
+      self
     end
 
     # Adds new options that an attribute class can accept
@@ -99,12 +164,12 @@ module Virtus
     # @param [#to_ary] new_options
     #   new options to be added
     #
-    # @return [Array]
-    #   all accepted options
+    # @return [self]
     #
     # @api private
-    def self.concat_options(new_options)
-      accepted_options.concat(new_options.to_ary).uniq
+    def self.add_accepted_options(new_options)
+      accepted_options.concat(new_options.to_ary)
+      self
     end
 
     # Adds descendant to descendants array and inherits default options
@@ -116,19 +181,18 @@ module Virtus
     # @api private
     def self.inherited(descendant)
       super
-      descendant.concat_options(accepted_options)
-      descendant.set_options(options)
+      descendant.add_accepted_options(accepted_options).set_options(options)
       self
     end
 
     # Returns if the given value's class is an attribute's primitive
     #
     # @example
-    #   Virtus::Attribute::String.primitive?('String') # => true
+    #   Virtus::Attribute::String.primitive?('String')  # => true
     #
-    # @return [TrueClass, FalseClass]
+    # @return [Boolean]
     #
-    # @api semipublic
+    # @api public
     def self.primitive?(value)
       value.kind_of?(primitive)
     end
@@ -136,7 +200,7 @@ module Virtus
     # Returns name of the attribute
     #
     # @example
-    #   User.attributes[:age].name # => :age
+    #   User.attributes[:age].name  # => :age
     #
     # @return [Symbol]
     #
@@ -185,6 +249,8 @@ module Virtus
     # @param [#to_hash] options
     #   hash of extra options which overrides defaults set on an attribute class
     #
+    # @return [undefined]
+    #
     # @api private
     def initialize(name, options = {})
       @name    = name
@@ -199,12 +265,12 @@ module Virtus
     # Returns if an attribute is a complex one
     #
     # @example
-    #   Virtus::Attribute::String.complex? # => false
-    #   Virtus::Attribute::Array.complex? # => true
+    #   Virtus::Attribute::String.complex?  # => false
+    #   Virtus::Attribute::Array.complex?   # => true
     #
-    # @return [TrueClass, FalseClass]
+    # @return [Boolean]
     #
-    # @api semipublic
+    # @api public
     def complex?
       @complex
     end
@@ -228,6 +294,8 @@ module Virtus
 
     # Converts the given value to the primitive type
     #
+    # @return [Object]
+    #
     # @api private
     def typecast_to_primitive(value)
       value
@@ -275,7 +343,7 @@ module Virtus
 
     # Creates an attribute reader method
     #
-    # @return [NilClass]
+    # @return [self]
     #
     # @api private
     def add_reader_method(model)
@@ -283,22 +351,24 @@ module Virtus
       method_name            = name
 
       model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-        module AttributeMethods
-          def #{method_name}
-            return #{instance_variable_name} if defined?(#{instance_variable_name})
-            attribute = self.class.attributes[#{method_name.inspect}]
-            #{instance_variable_name} = attribute ? attribute.get(self) : nil
-          end
-        end
-        include AttributeMethods
+        module AttributeMethods                                                      # module AttributeMethods
+          def #{method_name}                                                         #   def name
+            return #{instance_variable_name} if defined?(#{instance_variable_name})  #     return @name if defined?(@name)
+            attribute = self.class.attributes[#{method_name.inspect}]                #     attribute = self.class.attributes[:name]
+            #{instance_variable_name} = attribute ? attribute.get(self) : nil        #     @name = attribute ? attribute.get(self) : nil
+          end                                                                        #   end
+        end                                                                          # end
+        include AttributeMethods                                                     # include AttributeMethods
       RUBY
 
       model.send(reader_visibility, method_name)
+
+      self
     end
 
     # Creates an attribute writer method
     #
-    # @return [NilClass]
+    # @return [self]
     #
     # @api private
     def add_writer_method(model)
@@ -306,15 +376,17 @@ module Virtus
       method_name = "#{name}="
 
       model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-        module AttributeMethods
-          def #{method_name}(value)
-            self.class.attributes[#{name.inspect}].set(self, value)
-          end
-        end
-        include AttributeMethods
+        module AttributeMethods                                      # module AttributeMethods
+          def #{method_name}(value)                                  #   def name=(value)
+            self.class.attributes[#{name.inspect}].set(self, value)  #     self.class.attributes[:name].set(self, value)
+          end                                                        #   end
+        end                                                          # end
+        include AttributeMethods                                     # include AttributeMethods
       RUBY
 
       model.send(writer_visibility, method_name)
+
+      self
     end
 
   private