objection 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3358f787269ed5510b59bf457e35a299a10e7c3c
-  data.tar.gz: 86ea1cf14e1a3674ab863014e01e7a8f01d4fa38
+  metadata.gz: aff7ba240a5dab954c6fd26b32283011979c2c4d
+  data.tar.gz: 3d3a10950c6cf4039ca23550f68b1e900ed11e0c
 SHA512:
-  metadata.gz: 347cceeb291a63b044ac80f41283cc45b550741eb0aae29cd5b51e6054438fdd18931628e3314ab059ec722334822cdd39fe4cd4a97a6aece50c0ebe5f7384cc
-  data.tar.gz: 47f26069162a0bc99bcfcf5e986cd2163e295fdb321d60f9a99674a57f47025f57733a2f2a88dfa4d38762ee75502a585a643750c8c66da4161b2abf98daecca
+  metadata.gz: 0eae990b088391861e2818d3576e872992e80b53261c1bd02765c5fcf14684b41612f059fa1f21a55c4ea7b901e1b1324c303fbb80f6fd7a92d0b21441d8a9db
+  data.tar.gz: 3ede58e66e4557b9ca78f9dbd80d4152f1d378c77cd76ab9e841b7145fec7a4b615818b23ec54b033ed646bf649a7cbd724eba4019869fcd8487c2f657f652ac

data/README.md

@@ -85,13 +85,27 @@ obj.car.is_a?(DemoNestedCar)
 obj.car.car_model == "<value given via ['car']['car_model']>"
 ```
 
-This also works for arrays. When an array is given where an object is suspected, then each item within the array will be
-convered into the declared object.
+This also works for arrays. When an array is given where an object is suspected, then each item within the array will be converted into the declared object.
+
+## Leasurely mode
+When Objection is instantiated with unknown fields in the parameters (a field not declared as optional or required), then an error will be thrown, because the contract is broken.
+But sometimes that is just how the world works, and the contract has to be breakable.
+Introduce the Leasure-mode, which can be set per contract by inheriting from the Leasurely-module:
+
+```ruby
+class DemoLeasurely < Objection::Leasurely::Base
+  requires :required_1
+end
+
+obj = DemoLeasurely.new(required_1: 'dummy', unknown_1: 'dummy')
+```
+The instantiation above will not raise an error. 
+**Beware**: the field 'unknown_1' will not be referencable via a getter-function.
 
 ## To hash
 
 For better connection with other services, objection can convert its values to an hash, with the `to_hash` function.
-This operation with recursivly with nested objects and arrays of objects.
+This operation works recursivly with nested objects and arrays of objects.
 
 ## Contributing
 

data/lib/objection/version.rb

@@ -1,3 +1,3 @@
 module Objection
-  VERSION = "1.3.1"
+  VERSION = "1.4.0"
 end

data/lib/objection.rb

@@ -162,4 +162,12 @@ module Objection
         self.class.instance_variable_get('@input_types') || {}
       end
   end
+
+  module Leasurely
+    class Base < ::Objection::Base
+      def unknown_fields_present?
+        false
+      end
+    end
+  end
 end

data/spec/objection/objection_spec.rb

@@ -1,5 +1,6 @@
 require_relative '../spec_helper'
 require_relative '../support/demo_basic'
+require_relative '../support/demo_leasurely'
 require_relative '../support/demo_requires'
 require_relative '../support/demo_optionals'
 require_relative '../support/demo_typed'
@@ -80,6 +81,26 @@ describe Objection do
     end
   end
 
+  context 'unknown fields in leasurely-mode' do
+    it 'can be defined and fetched' do
+      obj = DemoLeasurely.new(required_1: 'dummy')
+
+      expect(obj).to be_kind_of(DemoLeasurely)
+      expect(obj).to be_kind_of(Objection::Leasurely::Base)
+      expect(obj.send(:required_fields)).to eq([:required_1])
+      expect(obj.send(:optional_fields)).to eq([])
+    end
+
+    it 'raises no error, if an unknown field is given' do
+      obj = DemoLeasurely.new(required_1: 'dummy', unknown_1: 'dummy')
+
+      expect(obj).to be_kind_of(DemoLeasurely)
+      expect(obj).to be_kind_of(Objection::Leasurely::Base)
+      expect(obj.send(:required_fields)).to eq([:required_1])
+      expect(obj.send(:optional_fields)).to eq([])
+    end
+  end
+
   context 'typed_input' do
     let(:obj) { build_object_for_known_fields }
 
@@ -159,19 +180,19 @@ describe Objection do
     end
 
     it 'raises an error. when unknown fields are supplied' do
-      expect{DemoOptionals.new(unknown_field: 'dummy')}.to raise_error(Objection::Base::UnknownFieldGiven, 'unknown_field')
+      expect{DemoOptionals.new(unknown_field: 'dummy')}.to raise_error(Objection::Base::UnknownFieldGiven, 'unknown_field for class: DemoOptionals')
     end
 
     it 'raises an error. when not all required fields are supplied' do
-      expect{DemoRequires.new(required_2: 'dummy')}.to raise_error(Objection::Base::RequiredFieldMissing, 'required_1')
+      expect{DemoRequires.new(required_2: 'dummy')}.to raise_error(Objection::Base::RequiredFieldMissing, 'required_1 for class: DemoRequires')
     end
 
     it 'raises an error, when a required field is blank' do
-      expect{DemoRequires.new(required_1: 'value', required_2: '')}.to raise_error(Objection::Base::RequiredFieldEmpty, 'required_2')
+      expect{DemoRequires.new(required_1: 'value', required_2: '')}.to raise_error(Objection::Base::RequiredFieldEmpty, 'required_2 for class: DemoRequires')
     end
 
     it 'raises an error, when a required field is nil' do
-      expect{DemoRequires.new(required_1: nil, required_2: 'value')}.to raise_error(Objection::Base::RequiredFieldEmpty, 'required_1')
+      expect{DemoRequires.new(required_1: nil, required_2: 'value')}.to raise_error(Objection::Base::RequiredFieldEmpty, 'required_1 for class: DemoRequires')
     end
   end
 

data/spec/support/demo_leasurely.rb

@@ -0,0 +1,3 @@
+class DemoLeasurely < Objection::Leasurely::Base
+  requires :required_1
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: objection
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Ewout Quax
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-19 00:00:00.000000000 Z
+date: 2015-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,6 +99,7 @@ files:
 - spec/objection/objection_spec.rb
 - spec/spec_helper.rb
 - spec/support/demo_basic.rb
+- spec/support/demo_leasurely.rb
 - spec/support/demo_nested.rb
 - spec/support/demo_optionals.rb
 - spec/support/demo_requires.rb
@@ -123,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Declare a predefined contract for use with services
@@ -131,6 +132,7 @@ test_files:
 - spec/objection/objection_spec.rb
 - spec/spec_helper.rb
 - spec/support/demo_basic.rb
+- spec/support/demo_leasurely.rb
 - spec/support/demo_nested.rb
 - spec/support/demo_optionals.rb
 - spec/support/demo_requires.rb