virtus 0.4.0 → 0.4.1

data/.travis.yml

@@ -15,3 +15,4 @@ rvm:
 notifications:
   email:
     - piotr.solnica@gmail.com
+    - dan.kubb@gmail.com

data/Changelog.md

@@ -1,10 +1,18 @@
+# v0.4.1 2012-05-06
+
+* [changed] backports gem is now a runtime dependency (solnic)
+* [BREAKING CHANGE] Renamed Virtus::DefaultValue#evaluate => Virtus::DefaultValue#call (solnic)
+* [BREAKING CHANGE] Renamed Virtus::ValueObject::Equalizer to Virtus::Equalizer (dkubb)
+
+[Compare v0.4.0..v0.4.1](https://github.com/solnic/virtus/compare/v0.4.0...v0.4.1)
+
 # v0.4.0 2012-03-22
 
 * [improvement] Add a caching mechanism for type lookups (solnic)
 * [fixed] Fix attributes mass-assignment when nil is passed (fgrehm)
 * [changed] Replace usage of #to_hash with Hash.try_convert (dkubb)
 
-[Compare v0.3.0..v0.4.0](https://github.com/solnic/virtus/compare/v0.3.0...master)
+[Compare v0.3.0..v0.4.0](https://github.com/solnic/virtus/compare/v0.3.0...v0.4.0)
 
 # v0.3.0 2012-02-25
 

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec
 

data/Guardfile

@@ -6,4 +6,3 @@ guard 'rspec', :version => 1 do
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
-

data/README.md

@@ -27,8 +27,6 @@ or in your **Gemfile**
 gem 'virtus'
 ```
 
-*IMPORTANT*: If you are still using Ruby 1.8.7 then you also have to install backports gem!
-
 Examples
 --------
 

data/Rakefile

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'rake'
 
 FileList['tasks/**/*.rake'].each { |task| import task }

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
 threshold: 19
-total_score: 344
+total_score: 365

data/config/flog.yml

@@ -1,2 +1,2 @@
 ---
-threshold: 19.4
+threshold: 22.2

data/config/site.reek

@@ -54,7 +54,7 @@ NestedIterators:
   ignore_iterators: []
   exclude: []
   enabled: true
-  max_allowed_nesting: 1
+  max_allowed_nesting: 2
 LongMethod:
   max_statements: 6
   exclude: []

data/lib/virtus.rb

@@ -3,13 +3,15 @@ require 'date'
 require 'time'
 require 'bigdecimal'
 require 'bigdecimal/util'
+require 'ostruct'
+require 'backports'
 
 # Base module which adds Attribute API to your classes
 module Virtus
 
   # Provides args for const_get and const_defined? to make them behave
   # consistently across different versions of ruby
-  EXTRA_CONST_ARGS = (RUBY_VERSION < '1.9' || RUBY_ENGINE == 'rbx' ? [] : [ false ]).freeze
+  EXTRA_CONST_ARGS = (RUBY_VERSION < '1.9' ? [] : [ false ]).freeze
 
   # Represents an undefined parameter used by auto-generated option methods
   Undefined = Object.new.freeze
@@ -34,6 +36,7 @@ end # module Virtus
 require 'virtus/support/descendants_tracker'
 require 'virtus/support/type_lookup'
 require 'virtus/support/options'
+require 'virtus/support/equalizer'
 
 require 'virtus/attributes_accessor'
 require 'virtus/class_methods'
@@ -83,4 +86,3 @@ require 'virtus/attribute/symbol'
 require 'virtus/attribute/string'
 require 'virtus/attribute/time'
 require 'virtus/attribute/embedded_value'
-

data/lib/virtus/attribute.rb

@@ -127,7 +127,7 @@ module Virtus
       @instance_variable_name = "@#{@name}".to_sym
       @primitive              = @options.fetch(:primitive)
       @coercion_method        = @options.fetch(:coercion_method)
-      @default                = DefaultValue.build(self, @options[:default])
+      @default                = DefaultValue.build(@options[:default])
       initialize_visibility
     end
 
@@ -160,7 +160,7 @@ module Virtus
       if instance.instance_variable_defined?(@instance_variable_name)
         get!(instance)
       else
-        value = default.evaluate(instance)
+        value = default.call(instance, self)
         set!(instance, value)
         value
       end

data/lib/virtus/attribute/boolean.rb

@@ -31,7 +31,7 @@ module Virtus
       #
       # @api public
       def value_coerced?(value)
-        value.equal?(true) || value.equal?(false)
+        value.equal?(true) or value.equal?(false)
       end
 
       # Creates an attribute reader method as a query

data/lib/virtus/attribute/default_value.rb

@@ -17,13 +17,6 @@ module Virtus
         klass.new(*args)
       end
 
-      # Returns the attribute associated with this default value instance
-      #
-      # @return [Virtus::Attribute::Object]
-      #
-      # @api private
-      attr_reader :attribute
-
       # Returns the value instance
       #
       # @return [Object]
@@ -33,27 +26,24 @@ module Virtus
 
       # Initializes an default value instance
       #
-      # @param [Virtus::Attribute] attribute
       # @param [Object] value
       #
       # @return [undefined]
       #
       # @api private
-      def initialize(attribute, value)
-        @attribute, @value = attribute, value
+      def initialize(value)
+        @value = value
       end
 
       # Evaluates the value
       #
-      # @param [Object]
-      #
       # @return [Object] evaluated value
       #
       # @api private
-      def evaluate(instance)
+      def call(*)
         value
       end
-    end # class DefaultValue
 
+    end # class DefaultValue
   end # class Attribute
 end # module Virtus

data/lib/virtus/attribute/default_value/from_callable.rb

@@ -9,10 +9,12 @@ module Virtus
 
         # Return if the class can handle the value
         #
+        # @param [Object] value
+        #
         # @return [Boolean]
         #
         # @api private
-        def self.handle?(attribute, value)
+        def self.handle?(value)
           value.respond_to?(:call)
         end
 
@@ -23,8 +25,8 @@ module Virtus
         # @return [Object] evaluated value
         #
         # @api private
-        def evaluate(instance)
-          @value.call(instance, @attribute)
+        def call(*args)
+          @value.call(*args)
         end
 
       end # class FromCallable

data/lib/virtus/attribute/default_value/from_clonable.rb

@@ -11,10 +11,12 @@ module Virtus
 
         # Return if the class can handle the value
         #
+        # @param [Object] value
+        #
         # @return [Boolean]
         #
         # @api private
-        def self.handle?(attribute, value)
+        def self.handle?(value)
           case value
           when *SINGLETON_CLASSES
             false
@@ -25,12 +27,10 @@ module Virtus
 
         # Evaluates the value via value#clone
         #
-        # @param [Object]
-        #
         # @return [Object] evaluated value
         #
         # @api private
-        def evaluate(instance)
+        def call(*)
           @value.clone
         end
 

data/lib/virtus/attribute/default_value/from_symbol.rb

@@ -9,10 +9,12 @@ module Virtus
 
         # Return if the class can handle the value
         #
+        # @param [Object] value
+        #
         # @return [Boolean]
         #
         # @api private
-        def self.handle?(attribute, value)
+        def self.handle?(value)
           value.is_a?(::Symbol)
         end
 
@@ -20,12 +22,10 @@ module Virtus
         #
         # Symbol value is returned if the instance doesn't respond to value
         #
-        # @param [Object]
-        #
         # @return [Object] evaluated value
         #
         # @api private
-        def evaluate(instance)
+        def call(instance, *)
           instance.respond_to?(@value) ? instance.public_send(@value) : @value
         end
 

data/lib/virtus/attribute/embedded_value.rb

@@ -1,5 +1,3 @@
-require 'ostruct'
-
 module Virtus
   class Attribute
 

data/lib/virtus/class_methods.rb

@@ -143,7 +143,7 @@ module Virtus
     #
     # @api private
     def const_missing(name)
-      Attribute.determine_type(name) || super
+      Attribute.determine_type(name) or super
     end
 
     # Add the attribute to the class' and descendants' attributes

data/lib/virtus/coercion.rb

@@ -25,7 +25,7 @@ module Virtus
     #
     # @api private
     def self.[](name)
-      determine_type(name) || Coercion::Object
+      determine_type(name) or Coercion::Object
     end
 
   end # Coerce

data/lib/virtus/coercion/numeric.rb

@@ -8,9 +8,9 @@ module Virtus
       # Coerce given value to String
       #
       # @example
-      #   Virtus::Coercion::Float.to_string(1.0)  # => "1.0"
+      #   Virtus::Coercion::Numeric.to_string(Rational(2, 2))  # => "1.0"
       #
-      # @param [Float] value
+      # @param [Numeric] value
       #
       # @return [String]
       #
@@ -19,14 +19,14 @@ module Virtus
         value.to_s
       end
 
-      # Creates a Fixnum instance from a numeric object
+      # Creates an Integer instance from a numeric object
       #
       # @example
-      #   Virtus::Coercion::BigDecimal.to_integer(BigDecimal('1.0'))  # => 1
+      #   Virtus::Coercion::Numeric.to_integer(Rational(2, 2))  # => 1
       #
-      # @param [BigDecimal] value
+      # @param [Numeric] value
       #
-      # @return [Fixnum]
+      # @return [Integer]
       #
       # @api public
       def self.to_integer(value)
@@ -36,23 +36,23 @@ module Virtus
       # Creates a Float instance from a numeric object
       #
       # @example
-      #   Virtus::Coercion::BigDecimal.to_float(BigDecimal('1.0'))  # => 1.0
+      #   Virtus::Coercion::Numeric.to_float(Rational(2, 2))  # => 1.0
       #
-      # @param [BigDecimal] value
+      # @param [Numeric] value
       #
-      # @return [Fixnum]
+      # @return [Float]
       #
       # @api public
       def self.to_float(value)
         value.to_f
       end
 
-      # Coerce given value to BigDecimal
+      # Coerce a BigDecimal instance from a numeric object
       #
       # @example
-      #   Virtus::Coercion::Float.to_decimal(1.0)  # => BigDecimal('1.0')
+      #   Virtus::Coercion::Numeric.to_decimal(Rational(2, 2))  # => BigDecimal('1.0')
       #
-      # @param [Float] value
+      # @param [Numeric] value
       #
       # @return [BigDecimal]
       #

data/lib/virtus/coercion/object.rb

@@ -96,7 +96,7 @@ module Virtus
       #
       # @api private
       def self.method_missing(method, *args)
-        if method.to_s =~ COERCION_METHOD_REGEXP && args.size == 1
+        if method.to_s =~ COERCION_METHOD_REGEXP and args.size == 1
           args.first
         else
           super

data/lib/virtus/support/equalizer.rb

@@ -0,0 +1,129 @@
+module Virtus
+
+  # Define equality, equivalence and inspection methods
+  class Equalizer < Module
+
+    # Initialize an Equalizer with the given keys
+    #
+    # Will use the keys with which it is initialized to define #cmp?,
+    # #hash, and #inspect
+    #
+    # @param [String] name
+    #
+    # @param [Array<Symbol>] keys
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def initialize(name, keys = [])
+      @name = name.dup.freeze
+      @keys = keys.dup
+      define_methods
+      include_comparison_methods
+    end
+
+    # Append a key and compile the equality methods
+    #
+    # @return [Equalizer] self
+    #
+    # @api private
+    def <<(key)
+      @keys << key
+      self
+    end
+
+  private
+
+    # Define the equalizer methods based on #keys
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def define_methods
+      define_cmp_method
+      define_hash_method
+      define_inspect_method
+    end
+
+    # Define an #cmp? method based on the instance's values identified by #keys
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def define_cmp_method
+      keys = @keys
+      define_method(:cmp?) do |comparator, other|
+        keys.all? { |key| send(key).send(comparator, other.send(key)) }
+      end
+    end
+
+    # Define a #hash method based on the instance's values identified by #keys
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def define_hash_method
+      keys = @keys
+      define_method(:hash) do
+        keys.map { |key| send(key).hash }.reduce(self.class.hash, :^)
+      end
+    end
+
+    # Define an inspect method that reports the values of the instance's keys
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def define_inspect_method
+      name, keys = @name, @keys
+      define_method(:inspect) do
+        "#<#{name}#{keys.map { |key| " #{key}=#{send(key).inspect}" }.join}>"
+      end
+    end
+
+    # Include the #eql? and #== methods
+    #
+    # @return [undefined]
+    #
+    # @api private
+    def include_comparison_methods
+      module_eval { include Methods }
+    end
+
+    # The comparison methods
+    module Methods
+
+      # Compare the object with other object for equality
+      #
+      # @example
+      #   object.eql?(other)  # => true or false
+      #
+      # @param [Object] other
+      #   the other object to compare with
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def eql?(other)
+        instance_of?(other.class) and cmp?(__method__, other)
+      end
+
+      # Compare the object with other object for equivalency
+      #
+      # @example
+      #   object == other  # => true or false
+      #
+      # @param [Object] other
+      #   the other object to compare with
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def ==(other)
+        return false unless self.class <=> other.class
+        cmp?(__method__, other)
+      end
+
+    end # module Methods
+  end # class Equalizer
+end # module Virtus