virtus 0.0.3 → 0.0.4

data/Gemfile

@@ -1,26 +1,22 @@
-source "http://rubygems.org"
-
-group :virtus do
-  gem 'virtus',    File.read('VERSION'), :path => File.dirname(__FILE__)
-end
+source :rubygems
 
 group :development do
-  gem "jeweler",   "~> 1.5.2"
-  gem "rspec",     "~> 2.6.0"
+  gem 'jeweler', '~> 1.6.4'
+  gem 'rspec',   '~> 2.6.0'
 end
 
-platforms :mri_18 do
-  group :metrics do
-    gem 'flay',      '~> 1.4.2'
-    gem 'flog',      '~> 2.5.1'
+group :metrics do
+  gem 'flay',      '~> 1.4.2'
+  gem 'flog',      '~> 2.5.1'
+  gem 'reek',      '~> 1.2.8', :git => 'git://github.com/dkubb/reek.git'
+  gem 'roodi',     '~> 2.1.0'
+  gem 'yardstick', '~> 0.4.0'
+
+  platforms :mri_18 do
     gem 'heckle',    '~> 1.4.3'
-    gem 'json',      '~> 1.5.1'
     gem 'metric_fu', '~> 2.1.1'
     gem 'mspec',     '~> 1.5.17'
     gem 'rcov',      '~> 0.9.9'
-    gem 'reek',      '~> 1.2.8', :git => 'git://github.com/dkubb/reek.git'
-    gem 'roodi',     '~> 2.1.0'
     gem 'ruby2ruby', '=  1.2.2'
-    gem 'yardstick', '~> 0.4.0'
   end
 end

data/History.txt

@@ -1,3 +1,13 @@
+=== v0.0.4 2011-07-08
+
+* [BREAKING CHANGE] attributes hash has been replaced by a specialized class AttributeSet (dkubb)
+* [BREAKING CHANGE] Virtus::ClassMethods.attribute returns self instead of a created attribute
+* [changed] descendants tracking has been extracted into DescendantsTracker module (dkubb)
+* [changed] Instance #primitive? method has been replaced by class utility method Virtus::Attribute.primitive?
+* [changed] Virtus::Attribute::String#typecast_to_primitive delegates to Virtus::Typecast::String.call
+
+Details: https://github.com/solnic/virtus/compare/v0.0.3...v0.0.4
+
 === v0.0.3 2011-06-09
 
 * [BREAKING CHANGE] Attribute classes were moved to Virtus::Attribute namespace

data/TODO

@@ -0,0 +1,4 @@
+* Add Virtus::Typecast::Array
+* Add Virtus::Typecast::Hash
+* Add support for default values
+* Add better inspection of attribute instances

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/config/flay.yml

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

data/config/flog.yml

@@ -1,2 +1,2 @@
 ---
-threshold: 18.2
+threshold: 17.2

data/config/roodi.yml

@@ -1,18 +1,18 @@
 ---
-AbcMetricMethodCheck:            { score: 11.8 }
+AbcMetricMethodCheck:            { score: 9.5 }
 AssignmentInConditionalCheck:    { }
 CaseMissingElseCheck:            { }
-ClassLineCountCheck:             { line_count: 390 }
+ClassLineCountCheck:             { line_count: 345 }
 ClassNameCheck:                  { pattern: !ruby/regexp /\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/ }
 ClassVariableCheck:              { }
 CyclomaticComplexityBlockCheck:  { complexity: 2 }
-CyclomaticComplexityMethodCheck: { complexity: 5 }
+CyclomaticComplexityMethodCheck: { complexity: 3 }
 EmptyRescueBodyCheck:            { }
 ForLoopCheck:                    { }
 # TODO: decrease line_count to 5 to 10
-MethodLineCountCheck:            { line_count: 20 }
-MethodNameCheck:                 { pattern: !ruby/regexp /\A(?:[a-z\d](?:_?[a-z\d])+[?!=]?|\[\]=?|==|<=>|[+*&|-])\z/ }
-ModuleLineCountCheck:            { line_count: 392 }
+MethodLineCountCheck:            { line_count: 17 }
+MethodNameCheck:                 { pattern: !ruby/regexp /\A(?:[a-z\d](?:_?[a-z\d])+[?!=]?|\[\]=?|==|<=>|<<|[+*&|-])\z/ }
+ModuleLineCountCheck:            { line_count: 351 }
 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/config/site.reek

@@ -8,10 +8,10 @@ UncommunicativeParameterName:
   - !ruby/regexp /[0-9]$/
   - !ruby/regexp /[A-Z]/
 LargeClass:
-  max_methods: 15  # TODO: decrease max_methods to 10-15 or less
+  max_methods: 11
   exclude: []
   enabled: true
-  max_instance_variables: 5
+  max_instance_variables: 8
 UncommunicativeMethodName:
   accept: []
   exclude: []
@@ -50,7 +50,7 @@ NestedIterators:
   enabled: true
   max_allowed_nesting: 1
 LongMethod:
-  max_statements: 7  # TODO: decrease max_statements to 5 or less
+  max_statements: 6
   exclude: []
   enabled: true
 Duplication:
@@ -80,12 +80,12 @@ SimulatedPolymorphism:
 DataClump:
   exclude: []
   enabled: true
-  max_copies: 1
+  max_copies: 2
   min_clump_size: 2
 ControlCouple:
   exclude: []
   enabled: true
 LongYieldList:
-  max_params: 2
+  max_params: 1
   exclude: []
   enabled: true

data/lib/virtus.rb

@@ -1,5 +1,3 @@
-require 'pathname'
-require 'set'
 require 'date'
 require 'time'
 require 'bigdecimal'
@@ -7,10 +5,11 @@ require 'bigdecimal/util'
 
 # Base module which adds Attribute API to your classes
 module Virtus
+
   # Represents an undefined parameter used by auto-generated option methods
-  module Undefined; end
+  Undefined = Object.new.freeze
 
-  # Extends base class with Attributes and Chainable modules
+  # Extends base class with class and instance methods
   #
   # @param [Class] base
   #
@@ -18,12 +17,12 @@ module Virtus
   #
   # @api private
   def self.included(base)
+    base.extend(DescendantsTracker)
     base.extend(ClassMethods)
     base.send(:include, InstanceMethods)
-    base.extend(Support::Chainable)
   end
 
-  # Returns a Virtus::Attributes::Object sub-class based on a name or class
+  # Returns a Virtus::Attribute::Object sub-class based on a name or class
   #
   # @example
   #   Virtus.determine_type('String') # => Virtus::Attribute::String
@@ -32,24 +31,35 @@ module Virtus
   #   name of a class or a class itself
   #
   # @return [Class]
-  #   one of the Virtus::Attributes::Object sub-class
+  #   one of the Virtus::Attribute::Object sub-class
   #
   # @api semipublic
   def self.determine_type(class_or_name)
-    if class_or_name.is_a?(Class) && class_or_name < Attribute::Object
-      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
   end
-end
 
-require 'virtus/support/chainable'
+end # module Virtus
+
+require 'virtus/support/descendants_tracker'
+
 require 'virtus/class_methods'
 require 'virtus/instance_methods'
 
+require 'virtus/attribute_set'
+
 require 'virtus/typecast/boolean'
 require 'virtus/typecast/numeric'
+require 'virtus/typecast/string'
 require 'virtus/typecast/time'
 
 require 'virtus/attribute'

data/lib/virtus/attribute.rb

@@ -1,8 +1,11 @@
 module Virtus
+
   # Abstract class implementing base API for attribute types
   #
   # @abstract
   class Attribute
+    extend DescendantsTracker
+
     # Returns default options hash for a given attribute class
     #
     # @example
@@ -15,9 +18,9 @@ module Virtus
     # @api public
     def self.options
       options = {}
-      accepted_options.each do |method|
-        value = send(method)
-        options[method] = value unless value.nil?
+      accepted_options.each do |option_name|
+        option_value         = send(option_name)
+        options[option_name] = option_value unless option_value.nil?
       end
       options
     end
@@ -47,14 +50,15 @@ module Virtus
     #   All accepted options
     #
     # @api public
-    def self.accept_options(*args)
-      accepted_options.concat(args)
+    def self.accept_options(*new_options)
+      # add new options to the array
+      concat_options(new_options)
 
       # create methods for each new option
-      args.each { |option| add_option_method(option) }
+      new_options.each { |option| add_option_method(option) }
 
       # add new options to all descendants
-      descendants.each { |descendant| descendant.accepted_options.concat(args) }
+      descendants.each { |descendant| descendant.concat_options(new_options) }
 
       accepted_options
     end
@@ -72,34 +76,61 @@ module Virtus
         end                                            # end
       RUBY
     end
+
     private_class_method :add_option_method
 
-    # Returns all the descendant classes
+    # Sets default options
     #
-    # @example
-    #   Virtus::Attribute::Numeric.descendants
-    #   # => [Virtus::Attribute::Decimal, Virtus::Attribute::Float, Virtus::Attribute::Integer]
+    # @param [#to_hash] new_options
+    #   options to be set
+    #
+    # @return [Hash]
+    #   default options set on the attribute class
+    #
+    # @api private
+    def self.set_options(new_options)
+      new_options.to_hash.each do |option_name, option_value|
+        send(option_name, option_value)
+      end
+    end
+
+    # Adds new options that an attribute class can accept
+    #
+    # @param [#to_ary] new_options
+    #   new options to be added
     #
     # @return [Array]
-    #   the array of descendants
+    #   all accepted options
     #
-    # @api public
-    def self.descendants
-      @descendants ||= []
+    # @api private
+    def self.concat_options(new_options)
+      accepted_options.concat(new_options.to_ary).uniq
     end
 
     # Adds descendant to descendants array and inherits default options
     #
-    # @param [Class]
+    # @param [Class] descendant
     #
-    # @return [Class]
+    # @return [self]
     #
     # @api private
     def self.inherited(descendant)
-      descendants << descendant
-      descendant.accepted_options.concat(accepted_options)
-      options.each { |key, value| descendant.send(key, value) }
-      descendant
+      super
+      descendant.concat_options(accepted_options)
+      descendant.set_options(options)
+      self
+    end
+
+    # Returns if the given value's class is an attribute's primitive
+    #
+    # @example
+    #   Virtus::Attribute::String.primitive?('String') # => true
+    #
+    # @return [TrueClass, FalseClass]
+    #
+    # @api semipublic
+    def self.primitive?(value)
+      value.kind_of?(primitive)
     end
 
     # Returns name of the attribute
@@ -112,13 +143,6 @@ module Virtus
     # @api public
     attr_reader :name
 
-    # Returns primitive class of the attribute
-    #
-    # @return [Class]
-    #
-    # @api private
-    attr_reader :primitive
-
     # Returns options hash for the attribute
     #
     # @return [Hash]
@@ -140,7 +164,6 @@ module Virtus
     # @api private
     attr_reader :reader_visibility
 
-
     # Returns write visibility
     #
     # @return [Symbol]
@@ -148,7 +171,7 @@ module Virtus
     # @api private
     attr_reader :writer_visibility
 
-    DEFAULT_ACCESSOR = :public.freeze
+    DEFAULT_ACCESSOR = :public
 
     OPTIONS = [ :primitive, :complex, :accessor, :reader, :writer ].freeze
 
@@ -159,21 +182,18 @@ module Virtus
     # @param [Symbol] name
     #   the name of an attribute
     #
-    # @param [Hash] options
+    # @param [#to_hash] options
     #   hash of extra options which overrides defaults set on an attribute class
     #
     # @api private
     def initialize(name, options = {})
       @name    = name
-      @options = self.class.options.merge(options).freeze
-
-      @primitive = @options[:primitive]
+      @options = self.class.options.merge(options.to_hash).freeze
 
       @instance_variable_name = "@#{@name}".freeze
+      @complex                = @options.fetch(:complex, false)
 
-      default_accessor   = @options.fetch(:accessor, DEFAULT_ACCESSOR)
-      @reader_visibility = @options.fetch(:reader, default_accessor)
-      @writer_visibility = @options.fetch(:writer, default_accessor)
+      set_visibility
     end
 
     # Returns if an attribute is a complex one
@@ -186,16 +206,7 @@ module Virtus
     #
     # @api semipublic
     def complex?
-      options[:complex]
-    end
-
-    # Returns if the given value's class is an attribute's primitive
-    #
-    # @return [TrueClass, FalseClass]
-    #
-    # @api private
-    def primitive?(value)
-      value.kind_of?(primitive)
+      @complex
     end
 
     # Converts the given value to the primitive type
@@ -208,7 +219,7 @@ module Virtus
     #
     # @api private
     def typecast(value)
-      if value.nil? || primitive?(value)
+      if value.nil? || self.class.primitive?(value)
         value
       else
         typecast_to_primitive(value)
@@ -268,17 +279,21 @@ module Virtus
     #
     # @api private
     def add_reader_method(model)
-      model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-        chainable(:attribute) do
-          #{reader_visibility}
+      instance_variable_name = self.instance_variable_name
+      method_name            = name
 
-          def #{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[#{name.inspect}]
+            attribute = self.class.attributes[#{method_name.inspect}]
             #{instance_variable_name} = attribute ? attribute.get(self) : nil
           end
         end
+        include AttributeMethods
       RUBY
+
+      model.send(reader_visibility, method_name)
     end
 
     # Creates an attribute writer method
@@ -287,15 +302,33 @@ module Virtus
     #
     # @api private
     def add_writer_method(model)
-      model.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-        chainable(:attribute) do
-          #{writer_visibility}
+      name        = self.name
+      method_name = "#{name}="
 
-          def #{name}=(value)
+      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
       RUBY
+
+      model.send(writer_visibility, method_name)
     end
-  end # Attribute
-end # Virtus
+
+  private
+
+    # Sets visibility of reader/write methods based on the options hash
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def set_visibility
+      default_accessor   = @options.fetch(:accessor, self.class::DEFAULT_ACCESSOR)
+      @reader_visibility = @options.fetch(:reader, default_accessor)
+      @writer_visibility = @options.fetch(:writer, default_accessor)
+    end
+
+  end # class Attribute
+end # module Virtus