virtus 0.2.0 → 0.3.0

data/.pelusa.yml

@@ -0,0 +1,7 @@
+sources: lib/**/*.rb
+
+lints:
+  InstanceVariables:
+    limit: 3
+  LineRestriction:
+    limit: 124

data/.travis.yml

@@ -1,15 +1,17 @@
+language: ruby
 bundler_args: --without guard metrics
 script: "bundle exec rake spec"
 rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - ruby-head
-  - ree
   - jruby-18mode
   - jruby-19mode
   - rbx-18mode
-  # - rbx-19mode  # FIXME: uncomment when rbx 1.9 is more stable
+  - rbx-19mode
+  - ree
+  - ruby-head
+  - jruby-head
 notifications:
   email:
     - piotr.solnica@gmail.com

data/Changelog.md

@@ -1,3 +1,20 @@
+# v0.3.0 to-be-released
+
+* [feature] Support for default values from a symbol (which can be a method name) (solnic)
+* [feature] Support for mass-assignment via custom setters not generated with attribute (fgrehm)
+* [feature] Virtus::Coercion::String.to_constant handles namespaced names (dkubb)
+* [feature] New coercion: Virtus::Coercion::Object.to_array (dkubb)
+* [feature] New coercion: Virtus::Coercion::Object.to_hash (dkubb)
+* [feature] New coercion: Virtus::Coercion::Object.to_string (dkubb)
+* [feature] New coercion: Virtus::Coercion::Object.to_integer (dkubb)
+* [changed] EmbeddedValue relies on @primitive setting rather than @model (mbj)
+* [BREAKING CHANGE] Removed Attribute#writer_visibility in favor of Attribute#public_writer? (solnic)
+* [BREAKING CHANGE] Removed Attribute#reader_visibility in favor of Attribute#public_reader? (solnic)
+* [BREAKING CHANGE] Removed Attribute#instance_variable_name - this is a private ivar (solnic)
+* [BREAKING CHANGE] Removed Equalizer#host_name and Equalizer#keys (solnic)
+
+[Compare v0.2.0..master](https://github.com/solnic/virtus/compare/v0.2.0...master)
+
 # v0.2.0 2012-02-08
 
 * [feature] Support for Value Objects (emmanuel)

data/Gemfile

@@ -20,4 +20,8 @@ group :metrics do
     gem 'rcov',      '~> 0.9.9'
     gem 'ruby2ruby', '=  1.2.2'
   end
+
+  platforms :rbx do
+    gem 'pelusa', :git => 'https://github.com/codegram/pelusa.git'
+  end
 end

data/README.md

@@ -1,7 +1,10 @@
 virtus
 ======
 
-[![Build Status](http://travis-ci.org/solnic/virtus.png)](http://travis-ci.org/solnic/virtus)
+[![Build Status](https://secure.travis-ci.org/solnic/virtus.png)](http://travis-ci.org/solnic/virtus)
+[![Dependency Status](https://gemnasium.com/solnic/virtus.png)](https://gemnasium.com/solnic/virtus)
+
+[Metrics on CodeClimate](https://codeclimate.com/github/solnic/virtus)
 
 This is a partial extraction of the DataMapper [Property
 API](http://rubydoc.info/github/datamapper/dm-core/master/DataMapper/Property)
@@ -18,11 +21,9 @@ Installation
 $ gem install virtus
 ```
 
-or
+or in your **Gemfile**
 
 ``` ruby
-# ./Gemfile
-
 gem 'virtus'
 ```
 
@@ -33,8 +34,6 @@ Examples
 
 
 ``` ruby
-require 'virtus'
-
 class User
   include Virtus
 
@@ -43,41 +42,44 @@ class User
   attribute :birthday, DateTime
 end
 
-user = User.new :name => 'Piotr', :age => 28
-user.attributes
-  # => { :name => "Piotr", :age => 28 }
+user = User.new(:name => 'Piotr', :age => 28)
+user.attributes # => { :name => "Piotr", :age => 28 }
 
-user.name
-  # => "Piotr"
+user.name # => "Piotr"
 
-user.age = '28'
-  # => 28
-user.age.class
-  # => Fixnum
+user.age = '28' # => 28
+user.age.class # => Fixnum
 
-user.birthday = 'November 18th, 1983'
-  # => #<DateTime: 1983-11-18T00:00:00+00:00 (4891313/2,0/1,2299161)>
+user.birthday = 'November 18th, 1983' # => #<DateTime: 1983-11-18T00:00:00+00:00 (4891313/2,0/1,2299161)>
 ```
 
 
 **Default values**
 
 ``` ruby
-require 'virtus'
-
 class Page
   include Virtus
 
   attribute :title, String
+  
+  # default from a singleton value (integer in this case)
   attribute :views, Integer, :default => 0
+  
+  # default from a callable object (proc in this case)
   attribute :slug, String, :default => lambda { |page, attribute| page.title.downcase.gsub(' ', '-') }
+  
+  # default from a method name as symbol
+  attribute :editor_title, String,  :default => :default_editor_title
+
+  def default_editor_title
+    published? ? title : "UNPUBLISHED: #{title}"
+  end
 end
 
-page = Page.new :title => 'Virtus Is Awesome'
-page.slug
-  # => 'virtus-is-awesome'
-page.views
-  # => 0
+page = Page.new(:title => 'Virtus Is Awesome', :editor_title => 'Virtus README')
+page.slug # => 'virtus-is-awesome'
+page.views # => 0
+page.editor_title # => "UNPUBSLISHED: Virtus README"
 ```
 
 **Embedded Value**
@@ -115,7 +117,6 @@ user.address.city.name # => "NYC"
 
 ``` ruby
 # Support "primitive" classes
-
 class Book
   include Virtus
 
@@ -181,7 +182,7 @@ venue = Venue.new(
   :name     => 'Pub',
   :location => { :latitude => 37.160317, :longitude => -98.437500 })
 
-venue.location.latitude  # => 37.160317
+venue.location.latitude # => 37.160317
 venue.location.longitude # => -98.4375
 
 # Supports object's equality
@@ -200,7 +201,6 @@ It's super easy to add your own coercion classes.
 Take a look:
 
 ``` ruby
-require 'virtus'
 require 'digest/md5'
 
 # Our new attribute type
@@ -228,17 +228,14 @@ class User
   attribute :password, MD5
 end
 
-user = User.new :name => 'Piotr', :password => 'foobar'
-user.name
-  # => 'Piotr'
-user.password
-  # => '3858f62230ac3c915f300c664312c63f'
+user = User.new(:name => 'Piotr', :password => 'foobar')
+user.name # => 'Piotr'
+user.password # => '3858f62230ac3c915f300c664312c63f'
 ```
 
 **Custom Attributes**
 
 ``` ruby
-require 'virtus'
 require 'json'
 
 module MyAppClass
@@ -262,10 +259,8 @@ module MyAppClass
 end
 
 user = MyApp::User.new
-user.info = '{"email":"john@domain.com"}'
-  # => {"email"=>"john@domain.com"}
-user.info.class
-  # => Hash
+user.info = '{"email":"john@domain.com"}' # => {"email"=>"john@domain.com"}
+user.info.class # => Hash
 ```
 
 
@@ -275,10 +270,11 @@ Credits
 * Dan Kubb ([dkubb](https://github.com/dkubb))
 * Chris Corbyn ([d11wtq](https://github.com/d11wtq))
 * Emmanuel Gomez ([emmanuel](https://github.com/emmanuel))
+* Fabio Rehm ([fgrehm](https://github.com/fgrehm))
 * Ryan Closner ([rclosner](https://github.com/rclosner))
+* Markus Schirp ([mbj](https://github.com/mbj))
 * Yves Senn ([senny](https://github.com/senny))
 
-
 Contributing
 -------------
 
@@ -286,7 +282,7 @@ Contributing
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
   future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
+* Commit, do not mess with Rakefile or version
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 

data/TODO

@@ -1,31 +1,36 @@
 * Add missing specs:
   * Add spec file spec/unit/virtus/attribute/collection/member_coercion/coerce_and_append_member_spec.rb for Virtus::Attribute::Collection::MemberCoercion#coerce_and_append_member
-  * Add spec file spec/unit/virtus/attribute/collection/coerce_and_append_member_spec.rb for Virtus::Attribute::Collection#coerce_and_append_member
   * Add spec file spec/unit/virtus/attribute/collection/member_type_spec.rb for Virtus::Attribute::Collection#member_type
   * Add spec file spec/unit/virtus/attribute/collection/new_collection_spec.rb for Virtus::Attribute::Collection#new_collection
+  * Add spec file spec/unit/virtus/attribute/collection/coerce_and_append_member_spec.rb for Virtus::Attribute::Collection#coerce_and_append_member
+  * Add spec file spec/unit/virtus/attribute/default_value/from_symbol/class_methods/handle_spec.rb for Virtus::Attribute::DefaultValue::FromSymbol.handle?
+  * Add spec file spec/unit/virtus/attribute/default_value/from_symbol/evaluate_spec.rb for Virtus::Attribute::DefaultValue::FromSymbol#evaluate
+  * Add spec file spec/unit/virtus/attribute/default_value/from_callable/class_methods/handle_spec.rb for Virtus::Attribute::DefaultValue::FromCallable.handle?
+  * Add spec file spec/unit/virtus/attribute/default_value/from_callable/evaluate_spec.rb for Virtus::Attribute::DefaultValue::FromCallable#evaluate
+  * Add spec file spec/unit/virtus/attribute/default_value/from_clonable/class_methods/handle_spec.rb for Virtus::Attribute::DefaultValue::FromClonable.handle?
+  * Add spec file spec/unit/virtus/attribute/default_value/from_clonable/evaluate_spec.rb for Virtus::Attribute::DefaultValue::FromClonable#evaluate
+  * Add spec file spec/unit/virtus/attribute/default_value/class_methods/build_spec.rb for Virtus::Attribute::DefaultValue.build
   * Add spec file spec/unit/virtus/coercion/string/class_methods/to_symbol_spec.rb for Virtus::Coercion::String.to_symbol
   * Add spec file spec/unit/virtus/coercion/time/class_methods/to_integer_spec.rb for Virtus::Coercion::Time.to_integer
-  * Add spec file spec/unit/virtus/coercion/time_coercions/to_time_spec.rb for Virtus::Coercion::TimeCoercions#to_time
   * Add spec file spec/unit/virtus/coercion/time_coercions/to_datetime_spec.rb for Virtus::Coercion::TimeCoercions#to_datetime
+  * Add spec file spec/unit/virtus/coercion/time_coercions/to_time_spec.rb for Virtus::Coercion::TimeCoercions#to_time
   * Add spec file spec/unit/virtus/coercion/time_coercions/to_date_spec.rb for Virtus::Coercion::TimeCoercions#to_date
   * Add spec file spec/unit/virtus/coercion/time_coercions/to_string_spec.rb for Virtus::Coercion::TimeCoercions#to_string
   * Add spec file spec/unit/virtus/coercion/array/class_methods/to_set_spec.rb for Virtus::Coercion::Array.to_set
   * Add spec file spec/unit/virtus/coercion/decimal/class_methods/to_decimal_spec.rb for Virtus::Coercion::Decimal.to_decimal
   * Add spec file spec/unit/virtus/coercion/float/class_methods/to_float_spec.rb for Virtus::Coercion::Float.to_float
   * Add spec file spec/unit/virtus/coercion/integer/class_methods/to_integer_spec.rb for Virtus::Coercion::Integer.to_integer
+  * Add spec file spec/unit/virtus/coercion/numeric/class_methods/to_decimal_spec.rb for Virtus::Coercion::Numeric.to_decimal
   * Add spec file spec/unit/virtus/coercion/numeric/class_methods/to_float_spec.rb for Virtus::Coercion::Numeric.to_float
   * Add spec file spec/unit/virtus/coercion/numeric/class_methods/to_integer_spec.rb for Virtus::Coercion::Numeric.to_integer
   * Add spec file spec/unit/virtus/coercion/numeric/class_methods/to_string_spec.rb for Virtus::Coercion::Numeric.to_string
-  * Add spec file spec/unit/virtus/coercion/numeric/class_methods/to_decimal_spec.rb for Virtus::Coercion::Numeric.to_decimal
   * Add spec file spec/unit/virtus/coercion/class_methods/element_reference_spec.rb for Virtus::Coercion.[]
   * Add spec file spec/unit/virtus/coercion/class_methods/primitive_spec.rb for Virtus::Coercion.primitive
   * Add spec file spec/unit/virtus/value_object/class_methods/attribute_spec.rb for Virtus::ValueObject::ClassMethods#attribute
   * Add spec file spec/unit/virtus/value_object/instance_methods/with_spec.rb for Virtus::ValueObject::InstanceMethods#with
-  * Add spec file spec/unit/virtus/value_object/equalizer/compile_spec.rb for Virtus::ValueObject::Equalizer#compile
   * Add spec file spec/unit/virtus/value_object/equalizer/append_spec.rb for Virtus::ValueObject::Equalizer#<<
-  * Add spec file spec/unit/virtus/value_object/equalizer/host_name_spec.rb for Virtus::ValueObject::Equalizer#host_name
-  * Add spec file spec/unit/virtus/value_object/equalizer/keys_spec.rb for Virtus::ValueObject::Equalizer#keys
-  * Add spec file spec/unit/virtus/attributes_accessor/define_writer_method_spec.rb for Virtus::AttributesAccessor#define_writer_method
+  * Add spec file spec/unit/virtus/value_object/equalizer/compile_spec.rb for Virtus::ValueObject::Equalizer#compile
   * Add spec file spec/unit/virtus/attributes_accessor/define_reader_method_spec.rb for Virtus::AttributesAccessor#define_reader_method
+  * Add spec file spec/unit/virtus/attributes_accessor/define_writer_method_spec.rb for Virtus::AttributesAccessor#define_writer_method
 
 * Make #to_time #to_date and #to_datetime work on Ruby 1.8.7 instead of typecasting to string and parsing the value

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
 threshold: 19
-total_score: 354
+total_score: 326

data/config/flog.yml

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

data/lib/virtus.rb

@@ -7,6 +7,10 @@ require 'bigdecimal/util'
 # 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
+
   # Represents an undefined parameter used by auto-generated option methods
   Undefined = Object.new.freeze
 
@@ -57,6 +61,10 @@ require 'virtus/coercion/string'
 require 'virtus/coercion/symbol'
 
 require 'virtus/attribute/default_value'
+require 'virtus/attribute/default_value/from_clonable'
+require 'virtus/attribute/default_value/from_callable'
+require 'virtus/attribute/default_value/from_symbol'
+
 require 'virtus/attribute'
 require 'virtus/attribute/object'
 require 'virtus/attribute/class'

data/lib/virtus/attribute.rb

@@ -30,27 +30,6 @@ module Virtus
     # @api private
     attr_reader :options
 
-    # Returns instance variable name of the attribute
-    #
-    # @return [Symbol]
-    #
-    # @api private
-    attr_reader :instance_variable_name
-
-    # Returns reader visibility
-    #
-    # @return [Symbol]
-    #
-    # @api private
-    attr_reader :reader_visibility
-
-    # Returns write visibility
-    #
-    # @return [Symbol]
-    #
-    # @api private
-    attr_reader :writer_visibility
-
     # Returns method name that should be used for coerceing
     #
     # @return [Symbol]
@@ -148,7 +127,7 @@ module Virtus
       @instance_variable_name = "@#{@name}".to_sym
       @primitive              = @options.fetch(:primitive)
       @coercion_method        = @options.fetch(:coercion_method)
-      @default                = DefaultValue.new(self, @options[:default])
+      @default                = DefaultValue.build(self, @options[:default])
       initialize_visibility
     end
 
@@ -178,7 +157,7 @@ module Virtus
     #
     # @api public
     def get(instance)
-      if instance.instance_variable_defined?(instance_variable_name)
+      if instance.instance_variable_defined?(@instance_variable_name)
         get!(instance)
       else
         value = default.evaluate(instance)
@@ -197,7 +176,7 @@ module Virtus
     #
     # @api public
     def get!(instance)
-      instance.instance_variable_get(instance_variable_name)
+      instance.instance_variable_get(@instance_variable_name)
     end
 
     # Sets the value on the instance
@@ -221,7 +200,7 @@ module Virtus
     #
     # @api public
     def set!(instance, value)
-      instance.instance_variable_set(instance_variable_name, value)
+      instance.instance_variable_set(@instance_variable_name, value)
       self
     end
 
@@ -282,7 +261,7 @@ module Virtus
     #
     # @api private
     def define_reader_method(mod)
-      mod.define_reader_method(self, name, reader_visibility)
+      mod.define_reader_method(self, name, @reader_visibility)
       self
     end
 
@@ -294,7 +273,7 @@ module Virtus
     #
     # @api private
     def define_writer_method(mod)
-      mod.define_writer_method(self, "#{name}=".to_sym, writer_visibility)
+      mod.define_writer_method(self, "#{name}=".to_sym, @writer_visibility)
       self
     end
 
@@ -304,7 +283,7 @@ module Virtus
     #
     # @api private
     def public_reader?
-      reader_visibility == :public
+      @reader_visibility == :public
     end
 
     # Returns a Boolean indicating whether the writer method is public
@@ -313,7 +292,7 @@ module Virtus
     #
     # @api private
     def public_writer?
-      writer_visibility == :public
+      @writer_visibility == :public
     end
 
   private

data/lib/virtus/attribute/boolean.rb

@@ -43,7 +43,7 @@ module Virtus
       # @api private
       def define_reader_method(mod)
         super
-        mod.define_reader_method(self, "#{name}?", reader_visibility)
+        mod.define_reader_method(self, "#{name}?", @reader_visibility)
         self
       end
 

data/lib/virtus/attribute/default_value.rb

@@ -2,9 +2,20 @@ module Virtus
   class Attribute
 
     # Class representing the default value option
+    #
+    # @api private
     class DefaultValue
-      SINGLETON_CLASSES = [ ::NilClass, ::TrueClass, ::FalseClass,
-                            ::Numeric,  ::Symbol ].freeze
+      extend DescendantsTracker
+
+      # Builds a default value instance
+      #
+      # @return [Virtus::Attribute::DefaultValue]
+      #
+      # @api private
+      def self.build(*args)
+        klass = descendants.detect { |descendant| descendant.handle?(*args) } || self
+        klass.new(*args)
+      end
 
       # Returns the attribute associated with this default value instance
       #
@@ -40,50 +51,9 @@ module Virtus
       #
       # @api private
       def evaluate(instance)
-        if callable?
-          call(instance)
-        elsif cloneable?
-          value.clone
-        else
-          value
-        end
-      end
-
-    private
-
-      # Evaluates a proc value
-      #
-      # @param [Object]
-      #
-      # @return [Object] evaluated value
-      #
-      # @api private
-      def call(instance)
-        value.call(instance, attribute)
+        value
       end
-
-      # Returns if the value is callable
-      #
-      # @return [TrueClass,FalseClass]
-      #
-      # @api private
-      def callable?
-        value.respond_to?(:call)
-      end
-
-      # Returns whether or not the value is cloneable
-      #
-      # # return [TrueClass, FalseClass]
-      #
-      # @api private
-      def cloneable?
-        case value
-        when *SINGLETON_CLASSES then false
-        else
-          true
-        end
-      end
-
     end # class DefaultValue
+
   end # class Attribute
 end # module Virtus