definition 0.1.0.rc1 → 0.1.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d4178b9d52b38f362ceeefc4e4b593c08bc1db136f39f43791c146890eebeec
-  data.tar.gz: 35a2df7826b4d9e77fa425711fcbff1ba1024438b355240a5aa5ee79a535e2d5
+  metadata.gz: 3af4089033df18151f417df6667ab1f76b266d35728297abc1ead799bb25dab9
+  data.tar.gz: 82e3b50fc7e7bdafd0317669c6960924627808f6ae19086a383ab91b3d3ead8e
 SHA512:
-  metadata.gz: 1f249e44ce43c29716f6943a8373399797d928f1796d42f6ead9f13261595e297cf4dc37418ef99d53717f6c57a5988ae78c01bab3c5cd91e227b3e150b7efae
-  data.tar.gz: 413f8ccf960d01faad85221108feda1b3c7ac41a0766c76d36872e58484f65d2c043a1f71d6fdde2de05814908b1325caeb0e2953f46281f625fe26eefc7f3db
+  metadata.gz: ee6a8ef92b6844cbe89b9e18bccb10b12b4068f7726d73c1d24296873b61cf60dc2478da1948a8350017c7be868c466dce4a6a2482e2672a0959567f8fd8e7e5
+  data.tar.gz: f8ed3f1933198bf18f750334fdd1662666c795dc2dbb80fbf84680c62dce436670ff8e4904bc32c77926e6ee0de0dc189eef304eac1a94f1c802c486b061f836

data/.rubocop.yml

@@ -75,3 +75,6 @@ RSpec/MultipleExpectations:
 
 RSpec/MessageExpectation:
   Enabled: false
+
+RSpec/RepeatedExample:
+  Enabled: false

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/Goltergaul/definition.svg?branch=master)][travis]
 [![Gem Version](https://badge.fury.io/rb/definition.svg)][rubygems]
 
-Simple and composable validation and coercion of data structures
+Simple and composable validation and coercion of data structures. It also includes a ValueObject for convinience.
 
 ## Installation
 
@@ -63,6 +63,44 @@ conform_result.value # => {title: "My first blog post", body: "Shortest one ever
 Because definitions do not only validate input but also transform input, we use
 the term `conform` which stands for validation and coercion.
 
+### Value Objects
+
+```ruby
+class User < Definition::ValueObject
+  definition(Definition.Keys do
+    required :username, Definition.Type(String)
+    required :password, Definition.Type(String)
+  end)
+end
+
+user = User.new(username: "johndoe", password: "zg(2ds8x2/")
+user.username # => "johndoe"
+user[:username] # => "johndoe"
+user.username = "Alice" # => NoMethodError (ValueObjects are immutable)
+user[:username] = "Alice" # => FrozenError (ValueObjects are immutable)
+
+User.new(username: "johndoe") # => Definition::InvalidValueObjectError: hash does not include :last_name
+```
+
+Value objects delegate all calls to the output value of the defined definition,
+so in this example you can use all methods that are defined on `Hash` also on the
+user object. If you use a `Keys` definition, the value object additionally defines
+convenient accessor methods for all attributes.
+
+Value Objects can also be used for all other data structures that can be validated
+by a definition, for example arrays:
+
+```ruby
+class IntegerArray < Definition::ValueObject
+  definition(Definition.Each(Definition.Type(Integer)))
+end
+
+array = IntegerArray.new([1,2,3])
+array.first # => 1
+
+IntegerArray.new([1,2,"3"]) # => Definition::InvalidValueObjectError: Not all items conform with each: { Item "3" did not conform to each: { Is of type String instead of Integer } }
+```
+
 ### Conforming Hashes
 
 Hashes can be conformed by using the `Keys` definition. It allows you to configure

data/lib/definition.rb

@@ -2,6 +2,7 @@
 
 require "definition/version"
 require "definition/dsl"
+require "definition/value_object"
 
 module Definition
   extend Dsl

data/lib/definition/types/keys.rb

@@ -31,6 +31,10 @@ module Definition
         Conformer.new(self, value).conform
       end
 
+      def keys
+        required_definitions.keys + optional_definitions.keys
+      end
+
       class Conformer
         def initialize(definition, value)
           self.definition = definition

data/lib/definition/value_object.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Definition
+  class InvalidValueObjectError < StandardError; end
+  class NotConfiguredError < StandardError; end
+
+  class ValueObject < SimpleDelegator
+    def initialize(args = nil, **kwargs)
+      result = self.class.conform(args || kwargs)
+      raise InvalidValueObjectError.new(result.error_message) unless result.passed?
+
+      super(result.value.freeze)
+    end
+
+    class << self
+      def conform(value)
+        unless @definition
+          raise Definition::NotConfiguredError.new(
+            "Value object has not been configured with a defintion. Use .definition to set a definition"
+          )
+        end
+
+        @definition.conform(value)
+      end
+
+      def definition(definition)
+        @definition = definition
+        define_accessor_methods if definition.is_a?(Definition::Types::Keys)
+      end
+
+      def define_accessor_methods
+        @definition.keys.each do |key|
+          define_method(key) { self[key] }
+        end
+      end
+    end
+  end
+end

data/lib/definition/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Definition
-  VERSION = "0.1.0.rc1"
+  VERSION = "0.1.0.rc2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: definition
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc1
+  version: 0.1.0.rc2
 platform: ruby
 authors:
 - Dominik Goltermann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-30 00:00:00.000000000 Z
+date: 2019-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: approvals
@@ -252,6 +252,7 @@ files:
 - lib/definition/types/lambda.rb
 - lib/definition/types/or.rb
 - lib/definition/types/type.rb
+- lib/definition/value_object.rb
 - lib/definition/version.rb
 homepage: https://github.com/Goltergaul/definition
 licenses: