virtus 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6888ad6cccbdd89e1d41781ceafcc78502aea7d6
-  data.tar.gz: 6638f3068fdee7c541917a7171501a79be0077ea
+SHA256:
+  metadata.gz: 51fade6650444cdaba10d9fee1ab99f7a5707ddacbdb9c08a734dc415c6a7af8
+  data.tar.gz: e8569ca6dc7f6b3bbbe6a00e1be51882dd3135b5e27ba218536f2409a3f495ec
 SHA512:
-  metadata.gz: de43cc6cccde89c7009fcb77301e34aa062aea154cfbffc2655efd28d35e41bf0cb0eec547b522cc16861ea66805a7594fa532f2d147366dee5482ae69a9f73f
-  data.tar.gz: 982101e49074af9ce296b4a647e9855e94dd327d7ab35196fb542201d83503b2c2e75e9d4e074e01e5e1565943f26f05b1784c8cca4501d5b638f6ff1992bbe7
+  metadata.gz: 289ce0a7a1d1841d832df7644fe1aa4d0202dd906161fb3b3704d0823ea1adb113976e0320505d8ea9ed2e8d00beb97ba235def16c4760ec9f384ceff3a3cdaf
+  data.tar.gz: 7a0b0d652a88006bd1b5cd1e24157eb96700e788e6e2f6dc5e4d442f838a2fb59274f918aaab1ac93f042d0268bbd5bcee484e2e80cf2b3eeaacfb34f7448a00

data/.travis.yml

@@ -1,17 +1,21 @@
+sudo: false
 language: ruby
-before_install: gem install bundler
-bundler_args: --without yard guard benchmarks
-script: "bundle exec rake spec"
+bundler_args: --without tools
+cache: bundler
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - jruby-19mode
-  - rbx-19mode
-  - ruby-head
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-notifications:
-  email:
-    - piotr.solnica@gmail.com
-    - dan.kubb@gmail.com
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - 3.0
+  - jruby
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Changelog.md

@@ -1,9 +1,50 @@
-# v1.0.0 2013-12-10
+# v2.0.0 2021-06-07
+
+* [added] New method `Virtus::Atrribute::Collection#value_coerced?`  (dslh)
+* [changed] inflecto was replaced with dry-inflector (solnic)
+* [changed] equalizer was replaced with the internal virtus/equalizer (solnic)
+* [changed] `Virtus::Attribute#==` was revised (see ef57af319334a1d4f3e0860acbde7c6d6f0eb8ef) (novikserg)
+* [fixed] Mass assignment bug fix (see #325) (novikserg)
+
+[Compare v1.0.5..v2.0.0](https://github.com/solnic/virtus/compare/v1.0.5...v2.0.0)
+
+# v1.0.5 2015-03-18
+
+* [feature] Support for :nullify_blank option when configuring a virtus module (lucasmazza)
+
+[Compare v1.0.4..v1.0.5](https://github.com/solnic/virtus/compare/v1.0.4...v1.0.5)
+
+# v1.0.4 2015-01-03
+
+* [feature] Support for :required option when configuring a virtus module (solnic)
+
+[Compare v1.0.3..v1.0.4](https://github.com/solnic/virtus/compare/v1.0.3...v1.0.4)
+
+# v1.0.3 2014-07-24
+
+* [improvement] Expose attribute name in the exception when in strict mode (ntl)
+* [improvement] Set #to_h as an alias to #to_hash (fnando)
+* [fixed] Fix handling of nil in collection coercion (edgibbs)
+* [fixed] Fix issues with using multiple virtus modules (trptcolin)
+* [fixed] Fix handling of Range type (hampei)
+* [fixed] Fix strict mode for collection and hash types (solnic)
+
+[Compare v1.0.2..v1.0.3](https://github.com/solnic/virtus/compare/v1.0.2...v1.0.3)
+
+# v1.0.2 2013-12-03
+
+* [improvement] Don’t override already-defined default values when freezing (amarshall)
+* [improvement] Improved performance of `AttributeSet#each` (Antti)
+* updated axiom-types dependency to ~> 0.1 (solnic)
+
+[Compare v1.0.1..v1.0.2](https://github.com/solnic/virtus/compare/v1.0.1...v1.0.2)
+
+# v1.0.1 2013-12-10
 
 * [feature] re-introduce `ValueObject#with`, which was removed in the past (senny)
 * [fixed] strict mode for Boolean type (solnic)
 
-[Compare v1.0.0..master](https://github.com/solnic/virtus/compare/v1.0.0...master)
+[Compare v1.0.0..v1.0.1](https://github.com/solnic/virtus/compare/v1.0.0...v1.0.1)
 
 # v1.0.0 2013-10-16
 

data/Gemfile

@@ -2,9 +2,9 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'bogus', '~> 0.1'
-gem 'devtools', :git => 'https://github.com/rom-rb/devtools', branch: 'master'
+gem 'dry-inflector'
+gem 'rspec'
+gem 'bogus'
+gem 'simplecov', platform: :ruby
 
-eval_gemfile 'Gemfile.devtools'
-
-gem 'mutant', git: 'https://github.com/solnic/mutant.git', branch: 'auto-expand-scope'
+gem "codeclimate-test-reporter", group: :test, require: false

data/README.md

@@ -1,25 +1,38 @@
-Virtus
-======
-
-[![Gem Version](https://badge.fury.io/rb/virtus.png)][gem]
-[![Build Status](https://secure.travis-ci.org/solnic/virtus.png?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/solnic/virtus.png)][gemnasium]
-[![Code Climate](https://codeclimate.com/github/solnic/virtus.png)][codeclimate]
-[![Coverage Status](https://coveralls.io/repos/solnic/virtus/badge.png?branch=master)][coveralls]
-
 [gem]: https://rubygems.org/gems/virtus
 [travis]: https://travis-ci.org/solnic/virtus
-[gemnasium]: https://gemnasium.com/solnic/virtus
 [codeclimate]: https://codeclimate.com/github/solnic/virtus
 [coveralls]: https://coveralls.io/r/solnic/virtus
+[inchpages]: http://inch-ci.org/github/solnic/virtus/
 
-This is a partial extraction of the DataMapper [Property
-API](http://rubydoc.info/github/datamapper/dm-core/master/DataMapper/Property)
-with various modifications and improvements. The goal is to provide a common API
-for defining attributes on a model so all ORMs/ODMs could use it instead of
-reinventing the wheel all over again. It is also suitable for any other
-use case where you need to extend your ruby objects with attributes that require
-data-type coercions.
+DISCONTINUED
+------------
+
+> Working on virtus taught me a lot about handling data in Ruby, which involves coercions, type safety and validation (amongst other things). Even though the project has been successful, and serving well for many people, I decided to build something better. As a result, [dry-types](https://github.com/dry-rb/dry-types), [dry-struct](https://github.com/dry-rb/dry-struct) and [dry-schema](https://github.com/dry-rb/dry-schema) were born. These projects should be considered as virtus' successors, with better separation of concerns and better features. If you're interested in a modern take on same problems that virtus tried to solve, please check out these projects!
+>
+> @solnic
+
+Virtus
+======
+
+[![Gem Version](https://badge.fury.io/rb/virtus.svg)][gem]
+[![Build Status](https://travis-ci.org/solnic/virtus.svg?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/solnic/virtus/badges/gpa.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/solnic/virtus/badges/coverage.svg)][codeclimate]
+[![Inline docs](http://inch-ci.org/github/solnic/virtus.svg?branch=master)][inchpages]
+
+Virtus allows you to define attributes on classes, modules or class instances with
+optional information about types, reader/writer method visibility and coercion
+behavior. It supports a lot of coercions and advanced mapping of embedded objects
+and collections.
+
+You can use it in many different contexts like:
+
+* Input parameter sanitization and coercion in web applications
+* Mapping JSON to domain objects
+* Encapsulating data-access in Value Objects
+* Domain model prototyping
+
+And probably more.
 
 Installation
 ------------
@@ -50,12 +63,12 @@ class User
   attribute :birthday, DateTime
 end
 
-user = User.new(:name => 'Piotr', :age => 29)
-user.attributes # => { :name => "Piotr", :age => 29 }
+user = User.new(:name => 'Piotr', :age => 31)
+user.attributes # => { :name => "Piotr", :age => 31, :birthday => nil }
 
 user.name # => "Piotr"
 
-user.age = '29' # => 29
+user.age = '31' # => 31
 user.age.class # => Fixnum
 
 user.birthday = 'November 18th, 1983' # => #<DateTime: 1983-11-18T00:00:00+00:00 (4891313/2,0/1,2299161)>
@@ -179,6 +192,19 @@ page.reset_attribute(:views)  # => 0
 page.views                    # => 0
 ```
 
+### Default values on dynamically extended instances
+
+This requires you to set `:lazy` option because default values are set in the
+constructor if it's set to false (which is the default setting):
+
+``` ruby
+User = Class.new
+user = User.new
+user.extend(Virtus.model)
+user.attribute :name, String, default: 'jane', lazy: true
+user.name # => "jane"
+```
+
 ### Embedded Value
 
 ``` ruby
@@ -271,6 +297,22 @@ package = Package.new(:dimensions => { 'width' => "2.2", :height => 2, "length"
 package.dimensions # => { :width => 2.2, :height => 2.0, :length => 4.5 }
 ```
 
+### IMPORTANT note about Boolean type
+
+Be aware that some libraries may do a terrible thing and define a global Boolean
+constant which breaks virtus' constant type lookup, if you see issues with the
+boolean type you can workaround it like that:
+
+``` ruby
+class User
+  include Virtus.model
+
+  attribute :admin, Axiom::Types::Boolean
+end
+```
+
+This will be improved in Virtus 2.0.
+
 ### IMPORTANT note about member coercions
 
 Virtus performs coercions only when a value is being assigned. If you mutate the value later on using its own
@@ -381,7 +423,7 @@ end
 class User
   include Virtus.model
 
-  attribute :info, Json
+  attribute :info, Json, default: {}
 end
 
 user = User.new
@@ -391,7 +433,7 @@ user.info.class # => Hash
 # With a custom attribute encapsulating coercion-specific configuration
 class NoisyString < Virtus::Attribute
   def coerce(value)
-    coercer[value.class].to_string.upcase
+    value.to_s.upcase
   end
 end
 
@@ -427,48 +469,31 @@ user.set_unique_id('1234-1234')
 user.unique_id # => '1234-1234'
 ```
 
-Coercions
----------
-
-Virtus uses [Coercible](https://github.com/solnic/coercible) for coercions. This
-feature is turned on by default. You can turn it off for all attributes like that:
-
-```ruby
-# Turn coercions off globally
-Virtus.coerce(false)
+### Overriding setters
 
-# ...or you can turn it off for a single attribute
+``` ruby
 class User
   include Virtus.model
 
-  attribute :name, String, :coerce => false
-end
-```
-
-You can configure coercers too:
+  attribute :name, String
 
-```ruby
-Virtus.coercer do |config|
-  config.string.boolean_map = { 'yup' => true, 'nope' => false }
+  def name=(new_name)
+    custom_name = nil
+    if new_name == "Godzilla"
+      custom_name = "Can't tell"
+    end
+    super custom_name || new_name
+  end
 end
 
-# Virtus.coercer instance is used by default for all attributes.
-# You *can* override it for a single attribute if you want:
+user = User.new(name: "Frank")
+user.name # => 'Frank'
 
-my_cool_coercer = Coercible::Coercer.new do |config|
-  # some customization
-end
+user = User.new(name: "Godzilla")
+user.name # => 'Can't tell'
 
-class User
-  include Virtus.model
-
-  attribute :name, String, :coercer => my_cool_coercer
-end
 ```
 
-Please check out [Coercible README](https://github.com/solnic/coercible/blob/master/README.md)
-for more information.
-
 ## Strict Coercion Mode
 
 By default Virtus returns the input value even when it couldn't coerce it to the expected type.
@@ -486,6 +511,22 @@ end
 User.new :admin => "can't really say if true or false"
 ```
 
+## Nullify Blank Strings Mode
+
+If you want to replace empty Strings with `nil` values (since they can't be
+coerced into the expected type), you can use the `:nullify_blank` option.
+
+``` ruby
+class User
+  include Virtus.model(:nullify_blank => true)
+
+  attribute :birthday, Date
+end
+
+User.new(:birthday => "").birthday # => nil
+```
+
+
 ## Building modules with custom configuration
 
 You can also build Virtus modules that contain their own configuration.
@@ -493,7 +534,7 @@ You can also build Virtus modules that contain their own configuration.
 ```ruby
 YupNopeBooleans = Virtus.model { |mod|
   mod.coerce = true
-  mod.string.boolean_map = { 'yup' => true, 'nope' => false }
+  mod.coercer.config.string.boolean_map = { 'nope' => false, 'yup' => true }
 }
 
 class User
@@ -541,6 +582,24 @@ Blog.attribute_set[:posts].member_type.primitive # => Post
 Post.attribute_set[:blog].type.primitive # => Blog
 ```
 
+## Plugins / Extensions
+
+List of plugins/extensions that add features to Virtus:
+
+* [virtus-localized](https://github.com/XescuGC/virtus-localized): Localize the attributes
+* [virtus-relations](https://github.com/smanolloff/virtus-relations): Add relations to Virtus objects
+
+Ruby version support
+--------------------
+
+Virtus is known to work correctly with the following rubies:
+
+* 1.9.3
+* 2.0.0
+* 2.1.2
+* jruby
+* (probably) rbx
+
 Credits
 -------
 
@@ -562,27 +621,3 @@ Contributing
 * 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.
-
-License
--------
-
-Copyright (c) 2011-2013 Piotr Solnica
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,5 +1,15 @@
-# encoding: utf-8
+require "rspec/core/rake_task"
 
-require 'devtools'
+RSpec::Core::RakeTask.new(:spec)
+task default: [:spec]
 
-Devtools.init_rake_tasks
+begin
+  require "rubocop/rake_task"
+
+  Rake::Task[:default].enhance [:rubocop]
+
+  RuboCop::RakeTask.new do |task|
+    task.options << "--display-cop-names"
+  end
+rescue LoadError
+end

data/lib/virtus.rb

@@ -11,11 +11,31 @@ module Virtus
   Undefined = Object.new.freeze
 
   class CoercionError < StandardError
-    attr_reader :output, :primitive
+    attr_reader :output, :attribute
 
-    def initialize(output, primitive)
-      @output, @primitive = output, primitive
-      super("Failed to coerce #{output.inspect} into #{primitive.inspect}")
+    def initialize(output, attribute)
+      @output, @attribute = output, attribute
+      super(build_message)
+    end
+
+    def build_message
+      if attribute_name?
+        "Failed to coerce attribute `#{attribute_name}' from #{output.inspect} into #{target_type}"
+      else
+        "Failed to coerce #{output.inspect} into #{target_type}"
+      end
+    end
+
+    def attribute_name
+      attribute.options[:name]
+    end
+
+    def attribute_name?
+      attribute_name ? true : false
+    end
+
+    def target_type
+      attribute.primitive.inspect
     end
   end
 
@@ -101,7 +121,8 @@ module Virtus
   #
   # @api public
   def self.config(&block)
-    configuration.call(&block)
+    yield configuration if block_given?
+    configuration
   end
 
   # Provides access to the Virtus module builder
@@ -186,6 +207,25 @@ module Virtus
     @configuration ||= Configuration.new
   end
 
+  # @api private
+  def self.constantize(type)
+    inflector.constantize(type)
+  end
+
+  # @api private
+  def self.inflector
+    @inflector ||=
+      begin
+        require 'dry/inflector'
+        Dry::Inflector.new
+      rescue LoadError
+        raise(
+          NotImplementedError,
+          'Virtus needs dry-inflector gem to constantize namespaced constant names'
+        )
+      end
+  end
+
   # Finalize pending attributes
   #
   # @example
@@ -220,7 +260,6 @@ module Virtus
 end # module Virtus
 
 require 'descendants_tracker'
-require 'equalizer'
 require 'axiom-types'
 require 'coercible'
 
@@ -258,6 +297,7 @@ require 'virtus/attribute/accessor'
 require 'virtus/attribute/coercible'
 require 'virtus/attribute/strict'
 require 'virtus/attribute/lazy_default'
+require 'virtus/attribute/nullify_blank'
 
 require 'virtus/attribute/boolean'
 require 'virtus/attribute/collection'