attributed_object 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22f705e863b9395e8f0b792f2f59d17f2312e27e
-  data.tar.gz: e1add90a18faa65ee4d999efce88fd6e63bf57fe
+  metadata.gz: b9f8eb05a90b0b2fcf0475c3c006c58b0efeaa33
+  data.tar.gz: 306f1a3c191fbd5b1cb19e311eea12a86b1b2f8e
 SHA512:
-  metadata.gz: cf49c1c8e060299308df7954879fcc64701bc61f6051164491b771080068a19ca6b2d985b952fa42217906f44c050e4b36aa9d42fd9a5dca35f8a9a63dd67135
-  data.tar.gz: afd7658ae6f341bbb2b7dbaf9bff5a60690716e6778b902ee745bd3df812083f57fc89fe36bea4c673fe70837869afc4cd7993f51d5a26323182f3a22d4a7ecb
+  metadata.gz: c0707b95ee9cf2ffc1d3949086d89925d1c852a8b806779283df2753a3afc4de369077d66e4e14a6e7584b7851a0fee25bc887f2884133d8f905c610c61c7b3a
+  data.tar.gz: c1d84c5717b5152c18330e5fa1013e6066801dc619fbdb5faf222beac2d071bffcf5263cf6df03f8aff3d180403e4cf40fb0c93ec26d0b3cc60adb7d6dfed426

data/README.md

@@ -70,13 +70,22 @@ MyAttributedObject.new(
 SimpleFoo.new(bar: 12) == SimpleFoo.new(bar: 12)
 ```
 
+### Whitelist
+```ruby
+class MyAttributedObject
+  include AttributedObject::Strict
+
+  attribute :planet, :string, whitelist: ['Earth', 'Mars']
+end
+```
+
 ### Strict Type Checking
 ```ruby
 class MyTypedAttributedObject
   include AttributedObject::Strict
 
   attribute :first, :string, disallow: nil
-  attribute :second, MyAttributedObject, default: nil 
+  attribute :second, MyAttributedObject, default: nil
 end
 
 # Works
@@ -103,7 +112,7 @@ MyTypedAttributedObject.new(
   )
 )
 
-# Supported Types: 
+# Supported Types:
 # :string
 # :boolean
 # :integer
@@ -115,7 +124,7 @@ MyTypedAttributedObject.new(
 # ArrayOf(:integer)
 # HashOf(:symbol, :string)
 # Instances of AttributedObject::Type (example: lib/attributed_object/types/array_of.rb)
-# any Class 
+# any Class
 ```
 
 ## Coercion
@@ -155,7 +164,7 @@ end
     default_to: AttributedObject::Unset, # AttributedObject::Unset | any value | AttributedObject::TypeDefaults
     ignore_extra_keys: false, # false | true
     coerce_blanks_to_nil: false, # false | true
-    disallow: AttributedObject::Unset, # AttributedObject::Unset | any value 
+    disallow: AttributedObject::Unset, # AttributedObject::Unset | any value
 }
 ```
 
@@ -167,7 +176,7 @@ class Defaulting
   include AttributedObject::Strict
   attributed_object default_to: nil
 
-  attribute :foo 
+  attribute :foo
 end
 Defaulting.new.foo # => nil
 
@@ -206,7 +215,7 @@ class WithExtraOptions
   include AttributedObject::Strict
   attributed_object ignore_extra_keys: true
 
-  attribute :foo 
+  attribute :foo
 end
 WithExtraOptions.new(foo: 'asd', something: 'bar') # this will not throw an error, usually it would
 ```
@@ -222,7 +231,7 @@ class WithExtraOptions
   include AttributedObject::Strict
   attributed_object disallow: nil
 
-  attribute :foo 
+  attribute :foo
 end
 WithExtraOptions.new(foo: nil) # this will not throw an error
 ```
@@ -236,3 +245,9 @@ Result: Attributed Object is quite a bit fast (2-3x) than other gems for the spe
 ### keywords
 
 ruby, AttributedObject, attributed object, attributed_object, value, domain driven design, ddd
+
+# Release new Version
+
+- bump Version Number
+- `gem build attributed_object.gemspec`
+- `gem push attributed_object-xxx.gem`

data/lib/attributed_object.rb

@@ -64,4 +64,3 @@ module AttributedObject
   class ConfigurationError < Error
   end
 end
-

data/lib/attributed_object/base.rb

@@ -14,7 +14,8 @@ module AttributedObject
           default_to: Unset,
           ignore_extra_keys: false,
           coerce_blanks_to_nil: false,
-          disallow: Unset
+          disallow: Unset,
+          whitelist: Unset
         }.merge(parent_ops)
       end
 
@@ -25,7 +26,7 @@ module AttributedObject
         @attribute_defs = parent_defs.clone
       end
 
-      def attribute(attr_name, type_info = Unset, default: Unset, disallow: Unset)
+      def attribute(attr_name, type_info = Unset, default: Unset, disallow: Unset, whitelist: Unset)
         if default == Unset
           default_to = attributed_object_options.fetch(:default_to)
 
@@ -37,13 +38,18 @@ module AttributedObject
         if disallow == Unset
           disallow = attributed_object_options.fetch(:disallow)
         end
-        
+
+        if whitelist == Unset
+          whitelist = attributed_object_options.fetch(:whitelist)
+        end
+
         _attributed_object_check_type_supported!(type_info)
 
         attribute_defs[attr_name] = {
           type_info: type_info,
           default: default,
           disallow: disallow,
+          whitelist: whitelist
         }
 
         attr_writer attr_name
@@ -92,6 +98,11 @@ module AttributedObject
           if opts[:type_info] != Unset && symbolized_args[name] != nil
             symbolized_args[name] = _attributed_object_on_init_attribute(opts[:type_info], symbolized_args[name], name: name, args: args)
           end
+
+          if opts[:whitelist] != Unset && !opts[:whitelist].include?(symbolized_args[name])
+            raise DisallowedValueError.new(self.class, name, args)
+          end
+
           self.send("#{name}=", symbolized_args[name])
         }
       end
@@ -108,4 +119,3 @@ module AttributedObject
     end
   end
 end
-

data/lib/attributed_object/strict.rb

@@ -25,4 +25,3 @@ module AttributedObject
     end
   end
 end
-

data/lib/attributed_object/version.rb

@@ -1,3 +1,3 @@
 module AttributedObject
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/spec/attributed_object_spec.rb

@@ -26,6 +26,15 @@ describe AttributedObject do
     end
   end
 
+  class AttributedObjectWithWhitelist
+    include AttributedObject::Strict
+
+    PLANET_EARTH = 'earth'.freeze
+    PLANET_MARS = 'mars'.freeze
+
+    attribute :planet, :string, whitelist: [PLANET_EARTH, PLANET_MARS]
+  end
+
   class ChildFoo < DefaultFoo
     attribute :lollipop, default: "lecker"
   end
@@ -45,6 +54,17 @@ describe AttributedObject do
     end
   end
 
+  describe 'whitelist' do
+    it 'allows whitelisted values' do
+      object = AttributedObjectWithWhitelist.new(planet: AttributedObjectWithWhitelist::PLANET_EARTH)
+      expect(object.planet).to eq(AttributedObjectWithWhitelist::PLANET_EARTH)
+    end
+
+    it 'crashes when provided with not-whitelisted value' do
+      expect { AttributedObjectWithWhitelist.new(planet: 'sun') }.to raise_error(AttributedObject::DisallowedValueError)
+    end
+  end
+
   describe 'default value' do
     before { DefaultFoo.reset }
 
@@ -167,7 +187,7 @@ describe AttributedObject do
           attribute :bar, :integer
           attribute :has_other_disallow, :integer, disallow: 0
         end
-    
+
         expect { FooWithExtra.new(bar: 1, has_other_disallow: 1) }.not_to raise_error
         expect { FooWithExtra.new(bar: 1, has_other_disallow: nil) }.not_to raise_error
         expect { FooWithExtra.new(bar: nil, has_other_disallow: 1) }.to raise_error(AttributedObject::DisallowedValueError)
@@ -203,23 +223,23 @@ describe AttributedObject do
       expect(SimpleFoo.new(bar: 77)).to_not eq(SimpleFoo.new(bar: 12))
     end
   end
-  
+
   describe 'attribute storage' do
     class InnerStructureFoo
       include AttributedObject::Coerce
       attribute :bar, :string, default: 'default'
       attribute :foo, :string, default: 'default'
       attribute :number, :integer, default: 0
-      
+
       def foo=(f)
         @foo = "prefix-#{f}-suffix"
       end
-      
+
       def number=(n)
         @number = n+1
       end
     end
-    
+
     describe '#attributes' do
       it 'returns the attributes as hash' do
         expect(InnerStructureFoo.new(bar: 'hi').attributes).to eq(
@@ -229,15 +249,15 @@ describe AttributedObject do
         )
       end
     end
-    
+
     it 'stores the data in instance vars' do
       expect(InnerStructureFoo.new(bar: 'hi').instance_variable_get('@bar')).to eq('hi')
     end
-    
+
     it 'uses setters' do
       expect(InnerStructureFoo.new(foo: 'middel').foo).to eq('prefix-middel-suffix')
     end
-    
+
     it 'uses setters after coercion' do
       expect(InnerStructureFoo.new(number: '42').number).to eq(43)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attributed_object
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Jaap Groeneveld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-02 00:00:00.000000000 Z
+date: 2017-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler