virtus 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 934dc95c7d8fd79268fcf7e2303257cd72378ef9
-  data.tar.gz: dd9096d86a6df285b7b97f4cabab540afa72ed0b
+  metadata.gz: 1a85ace0a75695ebb65294da839a389e5349b660
+  data.tar.gz: 2c8d5150758b6bab5ce1bb8484cdaff11d1fe581
 SHA512:
-  metadata.gz: 9095639c91403b8193bfe71a9067da701298a5190f65bdef2ac0ea0aaef130cf819529b2a672e071b48857ce614082402048a9125658b4a6f129d432968239f7
-  data.tar.gz: ec1343ee430f0e6c6766c6e7a2457d116b7b4de00156f2ffe813989f1f62f96d712218756f750bfb45dc700552ba7999450ae243a3024ed1af3a5671e8a7b817
+  metadata.gz: e92ffbfc9ee7b17c58253130ad0e5bdf45857618d04d64d5c8e58b0d3d156deac13d2cc44d3b628f08ec76cdc9bc8634aca2570e987de2cd64e07ffe21fb8d04
+  data.tar.gz: 33db1e4a9040ce6d008062683a6eedcce3632b4854290a114795accad964233094d80f324d1b703487f6f14d6b1510e383dfce32bf7a341f9bf372d95fd37363

data/Changelog.md

@@ -1,3 +1,9 @@
+# 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)

data/README.md

@@ -10,7 +10,7 @@ Virtus
 
 # Ruby Object Mapper
 
-[![Gem Version](https://badge.fury.io/rb/rom.svg)][gem]
+[![Gem Version](https://badge.fury.io/rb/virtus.svg)][gem]
 [![Build Status](https://travis-ci.org/solnic/virtus.svg?branch=master)][travis]
 [![Dependency Status](https://gemnasium.com/solnic/virtus.png)][gemnasium]
 [![Code Climate](https://codeclimate.com/github/solnic/virtus/badges/gpa.svg)][codeclimate]
@@ -60,12 +60,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 }
 
 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)>
@@ -508,6 +508,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.

data/lib/virtus.rb

@@ -279,6 +279,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'

data/lib/virtus/attribute.rb

@@ -20,12 +20,13 @@ module Virtus
 
     include ::Equalizer.new(:type, :options)
 
-    accept_options :primitive, :accessor, :default, :lazy, :strict, :required, :finalize
+    accept_options :primitive, :accessor, :default, :lazy, :strict, :required, :finalize, :nullify_blank
 
     strict false
     required true
     accessor :public
     finalize true
+    nullify_blank false
 
     # @see Virtus.coerce
     #
@@ -176,6 +177,23 @@ module Virtus
       kind_of?(Strict)
     end
 
+    # Return if the attribute is in the nullify blank coercion mode
+    #
+    # @example
+    #
+    #   attr = Virtus::Attribute.build(String, :nullify_blank => true)
+    #   attr.nullify_blank? # => true
+    #
+    #   attr = Virtus::Attribute.build(String, :nullify_blank => false)
+    #   attr.nullify_blank? # => false
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def nullify_blank?
+      kind_of?(NullifyBlank)
+    end
+
     # Return if the attribute is accepts nil values as valid coercion output
     #
     # @example

data/lib/virtus/attribute/builder.rb

@@ -160,10 +160,11 @@ module Virtus
       def initialize_attribute
         @attribute = klass.new(type, options)
 
-        @attribute.extend(Accessor)    if options[:name]
-        @attribute.extend(Coercible)   if options[:coerce]
-        @attribute.extend(Strict)      if options[:strict]
-        @attribute.extend(LazyDefault) if options[:lazy]
+        @attribute.extend(Accessor)     if options[:name]
+        @attribute.extend(Coercible)    if options[:coerce]
+        @attribute.extend(NullifyBlank) if options[:nullify_blank]
+        @attribute.extend(Strict)       if options[:strict]
+        @attribute.extend(LazyDefault)  if options[:lazy]
 
         @attribute.finalize if options[:finalize]
       end

data/lib/virtus/attribute/nullify_blank.rb

@@ -0,0 +1,24 @@
+module Virtus
+  class Attribute
+
+    # Attribute extension which nullifies blank attributes when coercion failed
+    #
+    module NullifyBlank
+
+      # @see [Attribute#coerce]
+      #
+      # @api public
+      def coerce(input)
+        output = super
+
+        if !value_coerced?(output) && input.to_s.empty?
+          nil
+        else
+          output
+        end
+      end
+
+    end # NullifyBlank
+
+  end # Attribute
+end # Virtus

data/lib/virtus/configuration.rb

@@ -12,6 +12,9 @@ module Virtus
     # Access the strict setting for this instance
     attr_accessor :strict
 
+    # Access the nullify_blank setting for this instance
+    attr_accessor :nullify_blank
+
     # Access the required setting for this instance
     attr_accessor :required
 
@@ -30,6 +33,7 @@ module Virtus
       @finalize        = options.fetch(:finalize, true)
       @coerce          = options.fetch(:coerce, true)
       @strict          = options.fetch(:strict, false)
+      @nullify_blank   = options.fetch(:nullify_blank, false)
       @required        = options.fetch(:required, true)
       @constructor     = options.fetch(:constructor, true)
       @mass_assignment = options.fetch(:mass_assignment, true)
@@ -59,6 +63,7 @@ module Virtus
       { :coerce             => coerce,
         :finalize           => finalize,
         :strict             => strict,
+        :nullify_blank      => nullify_blank,
         :required           => required,
         :configured_coercer => coercer }.freeze
     end

data/lib/virtus/version.rb

@@ -1,3 +1,3 @@
 module Virtus
-  VERSION = '1.0.4'.freeze
+  VERSION = '1.0.5'.freeze
 end

data/spec/integration/building_module_spec.rb

@@ -19,6 +19,10 @@ describe 'I can create a Virtus module' do
         config.strict = true
       }
 
+      BlankModule = Virtus.model { |config|
+        config.nullify_blank = true
+      }
+
       class NoncoercedUser
         include NoncoercingModule
 
@@ -39,6 +43,13 @@ describe 'I can create a Virtus module' do
         attribute :stuff, Hash
         attribute :happy, Boolean, :strict => false
       end
+
+      class BlankModel
+        include BlankModule
+
+        attribute :stuff, Hash
+        attribute :happy, Boolean, :nullify_blank => false
+      end
     end
   end
 
@@ -65,4 +76,15 @@ describe 'I can create a Virtus module' do
 
     expect(model.happy).to eql('foo')
   end
+
+  specify 'including a custom module with nullify blank enabled' do
+    model = Examples::BlankModel.new
+
+    model.stuff = ''
+    expect(model.stuff).to be_nil
+
+    model.happy = 'foo'
+
+    expect(model.happy).to eql('foo')
+  end
 end

data/spec/unit/virtus/attribute/class_methods/build_spec.rb

@@ -78,6 +78,14 @@ describe Virtus::Attribute, '.build' do
     it { is_expected.to be_strict }
   end
 
+  context 'when options specify nullify blank mode' do
+    let(:options) { { :nullify_blank => true } }
+
+    it_behaves_like 'a valid attribute instance'
+
+    it { is_expected.to be_nullify_blank }
+  end
+
   context 'when type is a string' do
     let(:type) { 'Integer' }
 

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

@@ -7,10 +7,11 @@ describe Virtus::Attribute, '#coerce' do
 
   let(:object)   {
     described_class.build(String,
-      :coercer => coercer, :strict => strict, :required => required)
+      :coercer => coercer, :strict => strict, :required => required, :nullify_blank => nullify_blank)
   }
 
   let(:required) { true }
+  let(:nullify_blank) { false }
   let(:input)    { 1 }
   let(:output)   { '1' }
 
@@ -78,4 +79,51 @@ describe Virtus::Attribute, '#coerce' do
       expect(coercer).to have_received.success?(String, input)
     end
   end
+
+  context 'when the input is an empty String' do
+    let(:input) { '' }
+    let(:output) { '' }
+
+    context 'when nullify_blank is turned on' do
+      let(:nullify_blank) { true }
+      let(:strict) { false }
+      let(:require) { false }
+
+      it 'returns nil' do
+        mock(coercer).call(input) { input }
+        mock(coercer).success?(String, input) { false }
+
+        expect(subject).to be_nil
+
+        expect(coercer).to have_received.call(input)
+        expect(coercer).to have_received.success?(String, input)
+      end
+
+      it 'returns the ouput if it was coerced' do
+        mock(coercer).call(input) { output }
+        mock(coercer).success?(String, output) { true }
+
+        expect(subject).to be(output)
+
+        expect(coercer).to have_received.call(input)
+        expect(coercer).to have_received.success?(String, output)
+      end
+    end
+
+    context 'when both nullify_blank and strict are turned on' do
+      let(:nullify_blank) { true }
+      let(:strict) { true }
+
+      it 'does not raises an coercion error' do
+        mock(coercer).call(input) { input }
+        mock(coercer).success?(String, input) { false }
+
+        expect { subject }.not_to raise_error
+        expect(subject).to be_nil
+
+        expect(coercer).to have_received.call(input)
+        expect(coercer).to have_received.success?(String, input)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: virtus
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-03 00:00:00.000000000 Z
+date: 2015-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: descendants_tracker
@@ -132,6 +132,7 @@ files:
 - lib/virtus/attribute/embedded_value.rb
 - lib/virtus/attribute/hash.rb
 - lib/virtus/attribute/lazy_default.rb
+- lib/virtus/attribute/nullify_blank.rb
 - lib/virtus/attribute/strict.rb
 - lib/virtus/attribute_set.rb
 - lib/virtus/builder.rb
@@ -237,9 +238,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Attributes on Steroids for Plain Old Ruby Objects
 test_files: []
-has_rdoc: