eapi 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1be90f666a6468f4f4e574b85edcf706d7336a7
-  data.tar.gz: c485bbe47dbd2ff849aad2b3c7dc4a9b8521cc0a
+  metadata.gz: 65b2149ec39bedde36ad3c6305a7eee7fb8b37b6
+  data.tar.gz: 6dc257fc779aeb132e289e7e870364e163104118
 SHA512:
-  metadata.gz: da17b4c132b4f45b868bf64eb1fde65faafe04e34fea500694b372aa057f7c1c21076c222e45169c7f45bdcfe5b66fed65e21bcfec86d2578f45c3fca423951a
-  data.tar.gz: 433e10ff4cd1bd992eef4a4779c003891d9c2f35d72e46ce4559ef83593c88b1e58731868519f538b13f63e10bf4a4f61b9e3d7b1e00f470144bdbab8ee9e46a
+  metadata.gz: 1e36790d62876f6cda906ed3f1cf4b1f29338b1acdbb70fadeac7718119ec4382f78655e7026b5cc289b9a8be5df560d467f912f817a34ec6bb58743322bd4ff
+  data.tar.gz: 440261fc694e382d0664f83f6ecf0f619e7f4922388adea99640b0a9ada69ce31b2f652fc8d376f96d5f59d480fb5a4dbb1ac216a4ec7e2a2bc50f9464dbe7e8

data/README.md

@@ -336,6 +336,79 @@ x.one # => :fluent
 res.equal? x # => true
 ```
 
+#### `converted_or_default_value_for` method
+
+It will return the converted value for the property. If that value is to be ignored (following the rules described with the `ignore` option) then it will return the default one (defined by the `default` option), or `nil` if there is no default value.
+
+```ruby
+class TestKlassWithDefault
+  include Eapi::Item
+  
+  property :something, ignore: :blank?, default: 123
+end
+
+x = TestKlassWithDefault.new
+x.something ''
+x.converted_or_default_value_for(:something) # => 123
+
+x.something 'not blank'
+x.converted_or_default_value_for(:something) # => 'not blank'
+
+
+class TestKlassWithoutDefault
+  include Eapi::Item
+  
+  property :something, ignore: :blank?
+end
+
+x = TestKlassWithoutDefault.new
+x.something ''
+x.converted_or_default_value_for(:something) # => nil
+
+x.something 'not blank'
+x.converted_or_default_value_for(:something) # => 'not blank'
+```
+  
+#### `yield_final_value_for` method
+
+It will yield the converted value for the property. If that value is to be ignored (following the rules described with the `ignore` option) then it will yield the default one (defined by the `default` option), or it won't yield anything if there is no default value.
+
+```ruby
+class TestKlassWithDefault
+  include Eapi::Item
+  
+  property :something, ignore: :blank?, default: 123
+end
+
+x = TestKlassWithDefault.new
+x.something ''
+check = :initial_check
+x.yield_final_value_for(:something) { |v| check = v }
+check # => 123
+
+x.something 'not blank'
+check = :initial_check
+x.yield_final_value_for(:something) { |v| check = v }
+check # => 'not blank'
+
+
+class TestKlassWithoutDefault
+  include Eapi::Item
+  
+  property :something, ignore: :blank?
+end
+
+x = TestKlassWithoutDefault.new
+check = :initial_check
+x.yield_final_value_for(:something) { |v| check = v }
+check # => :initial_check
+
+x.something 'not blank'
+check = :initial_check
+x.yield_final_value_for(:something) { |v| check = v }
+check # => 'not blank'
+``` 
+
 ### Property definition
 
 When defining the property, we can specify some options to specify what values are expected in that property. This serves for validation and automatic initialisation.
@@ -379,6 +452,26 @@ eapi.errors.full_messages # => ["Something can't be blank"]
 eapi.errors.messages # => {something: ["can't be blank"]}
 ```
 
+#### Establish a default value for the property in case of to-be-ignored value with `default` option
+
+A property whose value is ignored (according with the `ignore` option), will use the value specifie in the `default` option.
+
+example:
+
+```ruby
+class TestKlass
+  include Eapi::Item
+
+  property :something, ignored: :blank?, default: 123
+end
+
+eapi = TestKlass.new
+
+# setting a value that will be ignored (in this example, an empty string, that will respond trythy to `.blank?`)
+eapi.something ""
+eapi.render # => {something: 123}
+```
+
 #### Specify the property's Type with `type` option
 
 If a property is defined to be of a specific type, the value will be validated to meet that criteria. It means that the value must be of the specified type. It will use `value.kind_of?(type)` (if type represents an actual class), and if that fails it will use `value.is?(type)` if defined.

data/lib/eapi/item.rb

@@ -19,15 +19,9 @@ module Eapi
     def perform_render
       {}.tap do |hash|
         _properties.each do |prop|
-          val        = converted_value_for(prop)
-          hash[prop] = val unless to_be_ignored?(val, prop)
+          set_value_in_final_hash(hash, prop)
         end
       end
     end
-
-    private
-    def to_be_ignored?(value, property)
-      Eapi::ValueIgnoreChecker.to_be_ignored? value, self.class.ignore_definition(property)
-    end
   end
 end

data/lib/eapi/methods/properties.rb

@@ -8,6 +8,16 @@ module Eapi
           self.class.properties
         end
 
+        def get(field)
+          getter = Eapi::Methods::Names.getter field
+          send(getter)
+        end
+
+        def set(field, value)
+          setter = Eapi::Methods::Names.fluent_setter field
+          send(setter, value)
+        end
+
         def converted_value_for(prop)
           convert_value get(prop)
         end
@@ -16,14 +26,33 @@ module Eapi
           Eapi::ValueConverter.convert_value(value)
         end
 
-        def get(field)
-          getter = Eapi::Methods::Names.getter field
-          send(getter)
+        def converted_or_default_value_for(property)
+          yield_final_value_for(property) { |val| return val }
         end
 
-        def set(field, value)
-          setter = Eapi::Methods::Names.fluent_setter field
-          send(setter, value)
+        # will yield the converted value if it is not to be ignored,
+        # will yield the default value if it is set and the converted value is to be ignored
+        # will not yield anything otherwise
+        def yield_final_value_for(property)
+          val      = converted_value_for(property)
+          accepted = !to_be_ignored?(val, property)
+
+          if accepted
+            yield val
+          elsif self.class.default_value_for?(property)
+            yield self.class.default_value_for(property)
+          end
+        end
+
+        def to_be_ignored?(value, property)
+          Eapi::ValueIgnoreChecker.to_be_ignored? value, self.class.ignore_definition(property)
+        end
+
+        private
+        def set_value_in_final_hash(hash, property)
+          yield_final_value_for(property) do |val|
+            hash[property] = val
+          end
         end
       end
 
@@ -75,6 +104,14 @@ module Eapi
           definition_for(field).fetch(:ignore, :nil?)
         end
 
+        def default_value_for?(property)
+          definition_for(property).key? :default
+        end
+
+        def default_value_for(property)
+          definition_for(property).fetch(:default, nil)
+        end
+
         private :_property_allow_raw
         private :_property_definitions
         private :run_property_definition

data/lib/eapi/version.rb

@@ -1,3 +1,3 @@
 module Eapi
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/ignore_default_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+RSpec.describe Eapi do
+
+  class IgnoreDefaultSpecTestItem
+    include Eapi::Item
+    property :something, ignore: :blank?, default: 123
+  end
+
+  class IgnoreDefaultSpecTestItemWithoutDefault
+    include Eapi::Item
+    property :something, ignore: :blank?
+  end
+
+
+  describe 'on render: ignored values with default option' do
+    describe 'Item' do
+      subject { IgnoreDefaultSpecTestItem.new }
+
+      it 'use the default if value is to be ignored' do
+        subject.something ""
+        expected = {something: 123}
+        expect(subject.render).to eq expected
+      end
+
+      it 'the default value is not used if the actual value is not to be ignored' do
+        subject.something 1
+        expected = {something: 1}
+        expect(subject.render).to eq expected
+      end
+
+      describe '#converted_or_default_value_for' do
+        it 'returns the converted value if it is not ignored' do
+          subject.something 1
+          expect(subject.converted_or_default_value_for :something).to eq 1
+        end
+
+        it 'returns the default value if it is ignored' do
+          subject.something ""
+          expect(subject.converted_or_default_value_for :something).to eq 123
+        end
+
+        describe 'without default value' do
+          subject { IgnoreDefaultSpecTestItemWithoutDefault.new }
+
+          it 'returns nil if the converted value is ignored' do
+            subject.something ""
+            expect(subject.converted_or_default_value_for :something).to be_nil
+          end
+        end
+      end
+
+      describe '#yield_final_value_for' do
+        it 'yields the converted value if it is not ignored' do
+          subject.something 1
+          init = :initial_value
+          subject.yield_final_value_for(:something) { |v| init = v }
+          expect(init).to eq 1
+        end
+
+        it 'yields the default value if it is ignored' do
+          subject.something ""
+          init = :initial_value
+          subject.yield_final_value_for(:something) { |v| init = v }
+          expect(init).to eq 123
+        end
+
+        describe 'without default value' do
+          subject { IgnoreDefaultSpecTestItemWithoutDefault.new }
+
+          it 'does not yield anything if the converted value is ignored' do
+            subject.something ""
+            init = :initial_value
+            subject.yield_final_value_for(:something) { |v| init = v }
+            expect(init).to eq :initial_value
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eapi
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Eduardo Turiño
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-22 00:00:00.000000000 Z
+date: 2014-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -217,6 +217,7 @@ files:
 - spec/definition_spec.rb
 - spec/extension_spec.rb
 - spec/function_spec.rb
+- spec/ignore_default_spec.rb
 - spec/ignore_spec.rb
 - spec/list_elements_spec.rb
 - spec/list_spec.rb
@@ -254,6 +255,7 @@ test_files:
 - spec/definition_spec.rb
 - spec/extension_spec.rb
 - spec/function_spec.rb
+- spec/ignore_default_spec.rb
 - spec/ignore_spec.rb
 - spec/list_elements_spec.rb
 - spec/list_spec.rb