virtus 0.0.6 → 0.0.7

data/History.md

@@ -1,4 +1,13 @@
-# v0.0.6 to-be-released
+# v0.0.7 to-be-released
+
+* [BREAKING CHANGE] Attribute.primitive? has been removed (solnic)
+* [fixed] Added missing coercion_method setting to Virtus::Attribute::Object (solnic)
+* [general] Default value logic has been extracted into Attribute::DefaultValue class (solnic)
+* [added] Virtus::Attribute::Class (solnic)
+
+[Compare v0.0.5..master](https://github.com/solnic/virtus/compare/v0.0.5...master)
+
+# v0.0.6 2011-07-31
 
 * [BREAKING CHANGE] Moved Virtus.determine_type to a shared module Virtus::TypeLookup (dkubb)
 * [BREAKING CHANGE] Attribute#typecast_to_primitive has been replaced by Attribute#coerce (solnic)
@@ -10,7 +19,7 @@
 * [changed] Typecast classes have been replace by a new hierarchy of Coercion classes like Coercion::String, Coercion::Integer etc. (solnic)
 * [changed] Attribute#get, #get!, #set, #set! & #coerce are now part of the public API (solnic)
 
-[Compare v0.0.5..master](https://github.com/solnic/virtus/compare/v0.0.5...master)
+[Compare v0.0.5..v0.0.6](https://github.com/solnic/virtus/compare/v0.0.5...v0.0.6)
 
 # v0.0.5 2011-07-10
 

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
 threshold: 20
-total_score: 268
+total_score: 264

data/config/roodi.yml

@@ -1,5 +1,5 @@
 ---
-AbcMetricMethodCheck:            { score: 8.1 }
+AbcMetricMethodCheck:            { score: 10.1 }
 AssignmentInConditionalCheck:    { }
 CaseMissingElseCheck:            { }
 ClassLineCountCheck:             { line_count: 309 }

data/lib/virtus/attribute/class.rb

@@ -0,0 +1,21 @@
+module Virtus
+  class Attribute
+
+    # Class
+    #
+    # @example
+    #   class Entity
+    #     include Virtus
+    #
+    #     attribute :type, Class
+    #   end
+    #
+    #   post = Entity.new(:model => Model)
+    #
+    class Class < Object
+      primitive       ::Class
+      coercion_method :to_class
+
+    end # class Class
+  end # class Attribute
+end # module Virtus

data/lib/virtus/attribute/default_value.rb

@@ -0,0 +1,71 @@
+module Virtus
+  class Attribute
+
+    # Class representing the default value option
+    class DefaultValue
+      DUP_CLASSES = [ ::NilClass, ::TrueClass, ::FalseClass,
+                      ::Numeric,  ::Symbol ].freeze
+
+      # Returns the attribute associated with this default value instance
+      #
+      # @return [Virtus::Attribute::Object]
+      #
+      # @api private
+      attr_reader :attribute
+
+      # Returns the value instance
+      #
+      # @return [Object]
+      #
+      # @api private
+      attr_reader :value
+
+      # Initializes an default value instance
+      #
+      # @param [Virtus::Attribute] attribute
+      # @param [Object] value
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def initialize(attribute, value)
+        @attribute = attribute
+        @value     = case value when *DUP_CLASSES then value else value.dup end
+      end
+
+      # Evaluates the value
+      #
+      # @param [Object]
+      #
+      # @return [Object] evaluated value
+      #
+      # @api private
+      def evaluate(instance)
+        callable? ? call(instance) : value
+      end
+
+      private
+
+      # Evaluates a proc value
+      #
+      # @param [Object]
+      #
+      # @return [Object] evaluated value
+      #
+      # @api private
+      def call(instance)
+        value.call(instance, attribute)
+      end
+
+      # Returns if the value is callable
+      #
+      # @return [TrueClass,FalseClass]
+      #
+      # @api private
+      def callable?
+        value.respond_to?(:call)
+      end
+
+    end # class DefaultValue
+  end # class Attribute
+end # module Virtus

data/lib/virtus/attribute/object.rb

@@ -3,7 +3,8 @@ module Virtus
 
     # Base class for every attribute
     class Object < Attribute
-      primitive ::Object
+      primitive       ::Object
+      coercion_method :to_object
 
     end # class Object
   end # class Attribute

data/lib/virtus/attribute.rb

@@ -8,18 +8,6 @@ module Virtus
     extend TypeLookup
     extend Options
 
-    # Returns if the given value's class is an attribute's primitive
-    #
-    # @example
-    #   Virtus::Attribute::String.primitive?('String')  # => true
-    #
-    # @return [Boolean]
-    #
-    # @api public
-    def self.primitive?(value)
-      value.kind_of?(primitive)
-    end
-
     # Returns name of the attribute
     #
     # @example
@@ -96,8 +84,8 @@ module Virtus
 
       @instance_variable_name = "@#{@name}".freeze
       @coercion_method        = @options.fetch(:coercion_method)
+      @default                = DefaultValue.new(self, @options[:default])
 
-      set_default
       set_visibility
     end
 
@@ -130,7 +118,7 @@ module Virtus
       if instance.instance_variable_defined?(instance_variable_name)
         get!(instance)
       else
-        set_default_value(instance)
+        set!(instance, default.evaluate(instance))
       end
     end
 
@@ -223,18 +211,6 @@ module Virtus
 
   private
 
-    # Sets a default value
-    #
-    # @param [Object]
-    #
-    # @return [Object]
-    #   default value that was set
-    #
-    # @api private
-    def set_default_value(instance)
-      set!(instance, default.kind_of?(Proc) ? default.call(instance, self) : default)
-    end
-
     # Sets visibility of reader/write methods based on the options hash
     #
     # @return [undefined]
@@ -246,21 +222,5 @@ module Virtus
       @writer_visibility = @options.fetch(:writer,   default_accessor)
     end
 
-    # Sets default value option
-    #
-    # @return [Object]
-    #
-    # @api private
-    def set_default
-      default = @options[:default]
-
-      @default = case default
-                 when Proc, ::NilClass, ::TrueClass, ::FalseClass, ::Numeric, ::Symbol
-                   default
-                 else
-                   default.dup
-                 end
-    end
-
   end # class Attribute
 end # module Virtus

data/lib/virtus/coercion/string.rb

@@ -11,6 +11,21 @@ module Virtus
 
       NUMERIC_REGEXP = /\A(-?(?:0|[1-9]\d*)(?:\.\d+)?|(?:\.\d+))\z/.freeze
 
+      # Coerce give value to a constant
+      #
+      # @example
+      #   Virtus::Coercion::String.to_class('String') # => String
+      #
+      # @param [String] value
+      #
+      # @return [Object]
+      #
+      # @api public
+      def self.to_class(value)
+        # TODO: add support for namespaced classes like 'Virtus::Attribute::String'
+        ::Object.const_get(value)
+      end
+
       # Coerce given value to Time
       #
       # @example

data/lib/virtus/instance_methods.rb

@@ -117,7 +117,20 @@ module Virtus
       end
     end
 
-    # @see Virtus::InstanceMethods#attributes
+    # 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]
     #
     # @api public
     def to_hash

data/lib/virtus.rb

@@ -51,8 +51,10 @@ require 'virtus/coercion/time'
 require 'virtus/coercion/string'
 require 'virtus/coercion/symbol'
 
+require 'virtus/attribute/default_value'
 require 'virtus/attribute'
 require 'virtus/attribute/object'
+require 'virtus/attribute/class'
 require 'virtus/attribute/array'
 require 'virtus/attribute/boolean'
 require 'virtus/attribute/date'

data/spec/integration/virtus/class_methods/attribute_spec.rb

@@ -5,6 +5,13 @@ describe Virtus::ClassMethods, '.attribute' do
     Class.new { include Virtus }
   end
 
+  (Virtus::Attribute.descendants + [Virtus::Attribute::Object]).each do |attribute_class|
+    context "with #{attribute_class.inspect}" do
+      subject { described_class.attribute(:name, attribute_class) }
+      specify { subject.attributes[:name].should be_instance_of(attribute_class) }
+    end
+  end
+
   specify { described_class.should respond_to(:attribute)  }
 
   context "in the class" do

data/spec/unit/shared/attribute/get.rb

@@ -27,7 +27,7 @@ shared_examples_for 'Attribute#get' do
       end
 
       let(:evaluated_proc_value) do
-        attribute.default.call(instance, attribute)
+        attribute.default.evaluate(attribute)
       end
 
       it { should == evaluated_proc_value }

data/spec/unit/shared/attribute.rb

@@ -1,7 +1,6 @@
 shared_examples_for 'Attribute' do
   it_behaves_like 'Attribute.accept_options'
   it_behaves_like 'Attribute.accepted_options'
-  it_behaves_like 'Attribute.primitive?'
   it_behaves_like 'Attribute#inspect'
   it_behaves_like 'Attribute#set'
   it_behaves_like 'Attribute#get'

data/spec/unit/virtus/attribute/class_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Virtus::Attribute::Class do
+  it_should_behave_like 'Attribute' do
+    let(:attribute_name)         { :String }
+    let(:attribute_value)        { String }
+    let(:attribute_value_other)  { 'String' }
+    let(:attribute_default)      { 'Object' }
+    let(:attribute_default_proc) { lambda { |instance, attribute| attribute.name.to_s } }
+  end
+
+  describe '#coerce' do
+    let(:attribute) { described_class.new(:type) }
+
+    subject { attribute.coerce(value) }
+
+    context 'with a String' do
+      let(:value) { 'String' }
+
+      it { should be(String) }
+    end
+  end
+
+end

data/spec/unit/virtus/attribute/default_value/class_methods/new_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Virtus::Attribute::DefaultValue, '.new' do
+  subject { described_class.new(attribute, value) }
+
+  let(:attribute) { Virtus::Attribute::String.new(:attribute) }
+
+  context 'with a value that can be duped' do
+    let(:value) { 'something' }
+
+    its(:value) { should     eql(value)   }
+    its(:value) { should_not equal(value) }
+  end
+
+  context 'with a value that cannot be duped' do
+    [ nil, true, false, 1, :symbol ].each do |value|
+      context "with #{value.inspect}" do
+        let(:value) { value }
+
+        its(:value) { should equal(value) }
+      end
+    end
+  end
+end

data/spec/unit/virtus/attribute/default_value/instance_methods/evaluate_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Virtus::Attribute::DefaultValue, '#evaluate' do
+  subject { object.evaluate(instance) }
+
+  let(:object)    { described_class.new(attribute, value)     }
+  let(:attribute) { Virtus::Attribute::String.new(:title) }
+  let(:instance)  { Class.new }
+
+  context 'with a non-callable value' do
+    let(:value) { 'something' }
+    it { should eql(value) }
+  end
+
+  context 'with a callable value' do
+    let(:value) { lambda { |instance, attribute| attribute.name } }
+    it { should be(:title) }
+  end
+end

data/spec/unit/virtus/attribute/object/class_methods/descendants_spec.rb

@@ -9,7 +9,7 @@ describe Virtus::Attribute::Object, '.descendants' do
       Virtus::Attribute::Float,   Virtus::Attribute::Decimal,
       Virtus::Attribute::Numeric, Virtus::Attribute::DateTime,
       Virtus::Attribute::Date,    Virtus::Attribute::Boolean,
-      Virtus::Attribute::Array ]
+      Virtus::Attribute::Array,   Virtus::Attribute::Class ]
   end
 
   it "should return all known attribute classes" do

data/spec/unit/virtus/coercion/string/class_methods/to_class_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Virtus::Coercion::String, '.to_class' do
+  subject { object.to_class(string) }
+
+  let(:object) { described_class }
+
+  context "with a String" do
+    let(:string) { 'String' }
+
+    it { should be(String) }
+  end
+end

data/virtus.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{virtus}
-  s.version = "0.0.6"
+  s.version = "0.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Piotr Solnica}]
-  s.date = %q{2011-07-30}
+  s.date = %q{2011-07-31}
   s.description = %q{Attributes for your plain ruby objects}
   s.email = [%q{piotr@rubyverse.com}]
   s.extra_rdoc_files = [
@@ -39,9 +39,11 @@ Gem::Specification.new do |s|
     "lib/virtus/attribute.rb",
     "lib/virtus/attribute/array.rb",
     "lib/virtus/attribute/boolean.rb",
+    "lib/virtus/attribute/class.rb",
     "lib/virtus/attribute/date.rb",
     "lib/virtus/attribute/date_time.rb",
     "lib/virtus/attribute/decimal.rb",
+    "lib/virtus/attribute/default_value.rb",
     "lib/virtus/attribute/float.rb",
     "lib/virtus/attribute/hash.rb",
     "lib/virtus/attribute/integer.rb",
@@ -82,14 +84,16 @@ Gem::Specification.new do |s|
     "spec/unit/shared/attribute/accepted_options.rb",
     "spec/unit/shared/attribute/get.rb",
     "spec/unit/shared/attribute/inspect.rb",
-    "spec/unit/shared/attribute/primitive.rb",
     "spec/unit/shared/attribute/set.rb",
     "spec/unit/virtus/attribute/array_spec.rb",
     "spec/unit/virtus/attribute/boolean_spec.rb",
     "spec/unit/virtus/attribute/class_methods/determine_type_spec.rb",
+    "spec/unit/virtus/attribute/class_spec.rb",
     "spec/unit/virtus/attribute/date_spec.rb",
     "spec/unit/virtus/attribute/date_time_spec.rb",
     "spec/unit/virtus/attribute/decimal_spec.rb",
+    "spec/unit/virtus/attribute/default_value/class_methods/new_spec.rb",
+    "spec/unit/virtus/attribute/default_value/instance_methods/evaluate_spec.rb",
     "spec/unit/virtus/attribute/float_spec.rb",
     "spec/unit/virtus/attribute/hash_spec.rb",
     "spec/unit/virtus/attribute/integer_spec.rb",
@@ -131,6 +135,7 @@ Gem::Specification.new do |s|
     "spec/unit/virtus/coercion/integer/class_methods/to_string_spec.rb",
     "spec/unit/virtus/coercion/object/class_methods/method_missing_spec.rb",
     "spec/unit/virtus/coercion/string/class_methods/to_boolean_spec.rb",
+    "spec/unit/virtus/coercion/string/class_methods/to_class_spec.rb",
     "spec/unit/virtus/coercion/string/class_methods/to_date_spec.rb",
     "spec/unit/virtus/coercion/string/class_methods/to_datetime_spec.rb",
     "spec/unit/virtus/coercion/string/class_methods/to_decimal_spec.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: virtus
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Piotr Solnica
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-30 00:00:00 Z
+date: 2011-07-31 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: backports
@@ -98,9 +98,11 @@ files:
 - lib/virtus/attribute.rb
 - lib/virtus/attribute/array.rb
 - lib/virtus/attribute/boolean.rb
+- lib/virtus/attribute/class.rb
 - lib/virtus/attribute/date.rb
 - lib/virtus/attribute/date_time.rb
 - lib/virtus/attribute/decimal.rb
+- lib/virtus/attribute/default_value.rb
 - lib/virtus/attribute/float.rb
 - lib/virtus/attribute/hash.rb
 - lib/virtus/attribute/integer.rb
@@ -141,14 +143,16 @@ files:
 - spec/unit/shared/attribute/accepted_options.rb
 - spec/unit/shared/attribute/get.rb
 - spec/unit/shared/attribute/inspect.rb
-- spec/unit/shared/attribute/primitive.rb
 - spec/unit/shared/attribute/set.rb
 - spec/unit/virtus/attribute/array_spec.rb
 - spec/unit/virtus/attribute/boolean_spec.rb
 - spec/unit/virtus/attribute/class_methods/determine_type_spec.rb
+- spec/unit/virtus/attribute/class_spec.rb
 - spec/unit/virtus/attribute/date_spec.rb
 - spec/unit/virtus/attribute/date_time_spec.rb
 - spec/unit/virtus/attribute/decimal_spec.rb
+- spec/unit/virtus/attribute/default_value/class_methods/new_spec.rb
+- spec/unit/virtus/attribute/default_value/instance_methods/evaluate_spec.rb
 - spec/unit/virtus/attribute/float_spec.rb
 - spec/unit/virtus/attribute/hash_spec.rb
 - spec/unit/virtus/attribute/integer_spec.rb
@@ -190,6 +194,7 @@ files:
 - spec/unit/virtus/coercion/integer/class_methods/to_string_spec.rb
 - spec/unit/virtus/coercion/object/class_methods/method_missing_spec.rb
 - spec/unit/virtus/coercion/string/class_methods/to_boolean_spec.rb
+- spec/unit/virtus/coercion/string/class_methods/to_class_spec.rb
 - spec/unit/virtus/coercion/string/class_methods/to_date_spec.rb
 - spec/unit/virtus/coercion/string/class_methods/to_datetime_spec.rb
 - spec/unit/virtus/coercion/string/class_methods/to_decimal_spec.rb

data/spec/unit/shared/attribute/primitive.rb

@@ -1,15 +0,0 @@
-shared_examples_for 'Attribute.primitive?' do
-  subject { described_class.primitive?(value) }
-
-  let(:attribute) { described_class.new(attribute_name) }
-
-  context 'with a primitive value' do
-    let(:value) { attribute_value }
-    it { should be(true) }
-  end
-
-  context 'with a non-primitive value' do
-    let(:value) { nil }
-    it { should be(false) }
-  end
-end