definition 0.1.0.rc2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3af4089033df18151f417df6667ab1f76b266d35728297abc1ead799bb25dab9
-  data.tar.gz: 82e3b50fc7e7bdafd0317669c6960924627808f6ae19086a383ab91b3d3ead8e
+  metadata.gz: 99098a9f77beb85c63ac542c0903112ea45ac698ace223d92d6c88c6abf2d372
+  data.tar.gz: 314c23a060b6867edf1a8883eaa3b28ae2b45bfe3b197dab8f86d95d05383204
 SHA512:
-  metadata.gz: ee6a8ef92b6844cbe89b9e18bccb10b12b4068f7726d73c1d24296873b61cf60dc2478da1948a8350017c7be868c466dce4a6a2482e2672a0959567f8fd8e7e5
-  data.tar.gz: f8ed3f1933198bf18f750334fdd1662666c795dc2dbb80fbf84680c62dce436670ff8e4904bc32c77926e6ee0de0dc189eef304eac1a94f1c802c486b061f836
+  metadata.gz: 2876eb3d16401866eed9f6546b797d3824334d9aad5670d403b205c8995e7af9e63203ff4d4dd62a8156574a523943d0d572e777c2c934e6b0141367e38f62eb
+  data.tar.gz: a251ebc1e96ebfb89b0e49fb418e65cd051ab28a670d3dd2376d1cf4c4fe9992dab3fea8d02224241a82b885befdd668f4baab3ce43666a0f7219bd2d74ec9b7

data/.travis.yml

@@ -12,3 +12,10 @@ jobs:
     - stage: linting
       rvm: ruby-head
       script: bundle exec rake rubocop
+    - stage: benchmark
+      script: bundle exec ruby benchmark/complex_example.rb
+      rvm: ruby-head
+    - script: bundle exec ruby benchmark/coercion.rb
+      rvm: ruby-head
+    - script: bundle exec ruby benchmark/validation_only.rb
+      rvm: ruby-head

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. It also includes a ValueObject for convinience.
+Simple and composable validation and coercion of data structures. It also includes a ValueObject for convenience.
 
 ## Installation
 
@@ -79,7 +79,7 @@ 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
+User.new(username: "johndoe") # => Definition::InvalidValueObjectError: hash does not include :password
 ```
 
 Value objects delegate all calls to the output value of the defined definition,

data/benchmark/coercion.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "bundler/inline"
+
+gemfile do
+  source "https://rubygems.org"
+  gem "definition"
+  gem "dry-validation"
+  gem "awesome_print"
+  gem "benchmark-ips"
+  gem "pry"
+end
+
+DryTimeCoercionType = Dry::Types["strict.string"].constructor do |value|
+  if value.is_a?(Integer)
+    Time.at(value).utc
+  else
+    value
+  end
+end
+DrySchema = Dry::Validation.Params do
+  configure do
+    config.type_specs = true
+  end
+
+  required(:name, :string).value(type?: String)
+  required(:time, DryTimeCoercionType).value(type?: Time)
+end
+
+DefinitionSchema = Definition.Keys do
+  required(:name, Definition.Type(String))
+  required(:time, Definition.Lambda(:time) do |value|
+    conform_with(Time.at(value).utc) if value.is_a?(Integer)
+  end)
+end
+
+puts "Benchmark with valid input data:"
+valid_data = { name: "test", time: Time.now.to_i }
+ap DefinitionSchema.conform(valid_data).value
+ap DrySchema.call(valid_data)
+Benchmark.ips do |x|
+  x.config(time: 5, warmup: 2)
+
+  x.report("definition") do
+    DefinitionSchema.conform(valid_data).value
+  end
+
+  x.report("dry-validation") do
+    DrySchema.call(valid_data)
+  end
+
+  x.compare!
+end
+
+puts "Benchmark with invalid input data:"
+invalid_data = { name: 1, time: Time.now.to_s }
+ap DefinitionSchema.conform(invalid_data).error_message
+ap DrySchema.call(invalid_data).errors
+Benchmark.ips do |x|
+  x.config(time: 5, warmup: 2)
+
+  x.report("definition") do
+    DefinitionSchema.conform(invalid_data)
+  end
+
+  x.report("dry-validation") do
+    DrySchema.call(invalid_data)
+  end
+
+  x.compare!
+end

data/benchmark/complex_example.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+require "bundler/inline"
+
+gemfile do
+  source "https://rubygems.org"
+  gem "definition"
+  gem "dry-validation"
+  gem "awesome_print"
+  gem "benchmark-ips"
+  gem "pry"
+end
+
+DryTimeCoercionType = Dry::Types["strict.string"].constructor do |value|
+  if value.is_a?(Integer)
+    Time.at(value / 1000.0).utc
+  else
+    value
+  end
+end
+DrySchema = Dry::Validation.Params do # rubocop:disable Metrics/BlockLength
+  configure do
+    config.type_specs = true
+  end
+
+  required(:data).schema do
+    required(:type, :string).value(Dry::Types["strict.string"].enum("article"))
+    required(:id, :string).value(type?: String)
+    required(:attributes).schema do
+      required(:title, :string).filled(max_size?: 1000)
+      required(:body, :string).filled(max_size?: 1000)
+      required(:publish_date, DryTimeCoercionType).value(type?: Time)
+    end
+
+    required(:relationships).schema do
+      required(:author).schema do
+        required(:data).schema do
+          required(:id, :string).value(type?: String)
+          required(:type, :string).value(Dry::Types["strict.string"].enum("people"))
+        end
+      end
+      optional(:comments).schema do
+        required(:data).each do
+          schema do
+            required(:id, :string).value(type?: String)
+            required(:type, :string).value(Dry::Types["strict.string"].enum("comment"))
+          end
+        end
+      end
+    end
+  end
+end
+
+MAX_LENGTH = Definition.Lambda(:max_length) do |value|
+  conform_with(value) if value.size <= 1000
+end
+MAX_STRING_LENGTH = Definition.And(
+  Definition.Type(String),
+  MAX_LENGTH
+)
+MILLISECONDS_TIME = Definition.Lambda(:milliseconds_time) do |v|
+  conform_with(Time.at(v / 1000.0).utc) if v.is_a?(Integer)
+end
+DefinitionSchema = Definition.Keys do
+  required(:data, Definition.Keys do
+    required :type, Definition.Enum("article")
+    required :id, Definition.Type(String)
+    required(:attributes, Definition.Keys do
+      required :title, MAX_STRING_LENGTH
+      required :body, MAX_STRING_LENGTH
+      required :publish_date, MILLISECONDS_TIME
+    end)
+
+    required(:relationships, Definition.Keys do
+      required(:author, Definition.Keys do
+        required(:data, Definition.Keys do
+          required :id, Definition.Type(String)
+          required :type, Definition.Enum("people")
+        end)
+      end)
+      optional(:comments, Definition.Keys do
+        required(:data, Definition.Each(
+                          Definition.Keys do
+                            required :id, Definition.Type(String)
+                            required :type, Definition.Enum("comment")
+                          end
+                        ))
+      end)
+    end)
+  end)
+end
+
+puts "Benchmark with valid input data:"
+valid_data = {
+  "data": {
+    "type":          "article",
+    "id":            "1",
+    "attributes":    {
+      "title":        "JSON:API paints my bikeshed!",
+      "body":         "The shortest article. Ever.",
+      "publish_date": Time.utc(2018).to_i * 1000
+    },
+    "relationships": {
+      "author":   {
+        "data": { "id": "42", "type": "people" }
+      },
+      "comments": {
+        "data": [
+          { "id": "1", "type": "comment" },
+          { "id": "2", "type": "comment" }
+        ]
+      }
+    }
+  }
+}
+ap DefinitionSchema.conform(valid_data).value
+ap DrySchema.call(valid_data)
+raise unless DefinitionSchema.conform(valid_data).passed?
+raise unless DrySchema.call(valid_data).success?
+
+Benchmark.ips do |x|
+  x.config(time: 5, warmup: 2)
+
+  x.report("definition") do
+    DefinitionSchema.conform(valid_data)
+  end
+
+  x.report("dry-validation") do
+    DrySchema.call(valid_data)
+  end
+
+  x.compare!
+end
+
+puts "Benchmark with invalid input data:"
+invalid_data = {
+  "data": {
+    "type":          "article",
+    "id":            "1",
+    "attributes":    {
+      "title":        "JSON:API paints my bikeshed!",
+      "body":         "The shortest article. Ever.",
+      "publish_date": Time.utc(2018).to_s
+    },
+    "relationships": {
+      "author":   {
+        "data": { "id": "42", "type": "people" }
+      },
+      "comments": {
+        "data": [
+          { "id": "1", "type": "comment" },
+          { "id": "2", "type": "post" }
+        ]
+      }
+    }
+  }
+}
+ap DefinitionSchema.conform(invalid_data).error_message
+ap DrySchema.call(invalid_data).errors
+raise if DefinitionSchema.conform(invalid_data).passed?
+raise if DrySchema.call(invalid_data).success?
+
+Benchmark.ips do |x|
+  x.config(time: 5, warmup: 2)
+
+  x.report("definition") do
+    DefinitionSchema.conform(invalid_data)
+  end
+
+  x.report("dry-validation") do
+    DrySchema.call(invalid_data)
+  end
+
+  x.compare!
+end

data/benchmark/validation_only.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "bundler/inline"
+
+gemfile do
+  source "https://rubygems.org"
+  gem "definition"
+  gem "dry-validation"
+  gem "awesome_print"
+  gem "benchmark-ips"
+end
+
+DrySchema = Dry::Validation.Params do
+  configure do
+    config.type_specs = true
+  end
+
+  required(:name, :string).value(type?: String)
+  required(:time, :time).value(type?: String)
+end
+
+DefinitionSchema = Definition.Keys do
+  required(:name, Definition.Type(String))
+  required(:time, Definition.Type(Time))
+end
+
+puts "Benchmark with valid input data:"
+valid_data = { name: "test", time: Time.now }
+ap DefinitionSchema.conform(valid_data).value
+ap DrySchema.call(valid_data)
+Benchmark.ips do |x|
+  x.config(time: 5, warmup: 2)
+
+  x.report("definition") do
+    DefinitionSchema.conform(valid_data)
+  end
+
+  x.report("dry-validation") do
+    DrySchema.call(valid_data)
+  end
+
+  x.compare!
+end
+
+puts "Benchmark with invalid input data:"
+invalid_data = { name: 1, time: Time.now.to_s }
+ap DefinitionSchema.conform(invalid_data).error_message
+ap DrySchema.call(invalid_data).errors
+Benchmark.ips do |x|
+  x.config(time: 5, warmup: 2)
+
+  x.report("definition") do
+    DefinitionSchema.conform(invalid_data)
+  end
+
+  x.report("dry-validation") do
+    DrySchema.call(invalid_data)
+  end
+
+  x.compare!
+end

data/lib/definition/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: definition
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc2
+  version: 0.1.0
 platform: ruby
 authors:
 - Dominik Goltermann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-02 00:00:00.000000000 Z
+date: 2019-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: approvals
@@ -236,6 +236,9 @@ files:
 - Guardfile
 - README.md
 - Rakefile
+- benchmark/coercion.rb
+- benchmark/complex_example.rb
+- benchmark/validation_only.rb
 - bin/console
 - bin/setup
 - definition.gemspec
@@ -269,9 +272,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6