definition 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99098a9f77beb85c63ac542c0903112ea45ac698ace223d92d6c88c6abf2d372
-  data.tar.gz: 314c23a060b6867edf1a8883eaa3b28ae2b45bfe3b197dab8f86d95d05383204
+  metadata.gz: cdd5d27632b42a3f09476358740ee5fb279f2b0ebb51c03f5473fbf2c0fa8a45
+  data.tar.gz: 5f92025e394507329ec6b980ca01cd45756ad69673436e3cc3afd818c4aa479b
 SHA512:
-  metadata.gz: 2876eb3d16401866eed9f6546b797d3824334d9aad5670d403b205c8995e7af9e63203ff4d4dd62a8156574a523943d0d572e777c2c934e6b0141367e38f62eb
-  data.tar.gz: a251ebc1e96ebfb89b0e49fb418e65cd051ab28a670d3dd2376d1cf4c4fe9992dab3fea8d02224241a82b885befdd668f4baab3ce43666a0f7219bd2d74ec9b7
+  metadata.gz: 760843a1773788716e0b4f1e3cce2e636ef2182a479450cdb18e6893efded1a14b7494e2ecd1521b8f3860881c5685871bf66348d639eed9430777ee422c00c9
+  data.tar.gz: 75f4329226b54d9dd9b930968ec17666f6cad29ad421e6456393317c2000b791a1e9ea4bc22ccb2a52890d2f4d060e646f03e07fd3db1ab016f66240937ae97d

data/Changelog.md

@@ -0,0 +1,13 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2019-01-13
+### Added
+- Added built in definitions for common usecases (e.g. string length validation)
+
+## [0.1.0] - 2019-01-12
+### Added
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Dominik Goltermann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -225,6 +225,66 @@ order = Definition.Keys do
 end
 ```
 
+### Predefined Definitions
+
+#### Strings and Arrays
+
+```ruby
+Definition.MaxSize(5).conform("house") # => pass
+Definition.MaxSize(5).conform([1,2,3,4,5]) # => pass
+```
+
+```ruby
+Definition.MinSize(5).conform("house") # => pass
+Definition.MinSize(5).conform([1,2,3,4,5]) # => pass
+```
+
+#### Strings
+
+```ruby
+Definition.NonEmptyString.conform("house") # => pass
+```
+
+```ruby
+Definition.Regex(/^\d*$/).conform("123") # => pass
+```
+
+#### Numerics
+
+```ruby
+Definition.GreaterThen(5).conform(5.1) # => pass
+Definition.GreaterThenEqual(5).conform(5) # => pass
+Definition.LessThen(5).conform(4) # => pass
+Definition.LessThenEqual(5).conform(5) # => pass
+```
+
+#### Strings, Array, Hashes
+
+```ruby
+Definition.Empty.conform("") # => pass
+Definition.Empty.conform([]) # => pass
+Definition.Empty.conform({}) # => pass
+```
+
+```ruby
+Definition.NonEmpty.conform("Joe") # => pass
+Definition.NonEmpty.conform([1]) # => pass
+Definition.NonEmpty.conform({ a: 1 }) # => pass
+```
+
+#### Nil
+
+```ruby
+Definition.Nil.conform(nil) # => pass
+```
+
+#### All types
+
+```ruby
+Definition.Equal(5).conform(5) # => pass
+Definition.Equal("foo").conform("foo") # => pass
+```
+
 ### Examples
 
 Check out the [integration specs](./spec/integration) for more usage examples.

data/definition.gemspec

@@ -24,7 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "approvals", "~> 0.0"
   spec.add_development_dependency "awesome_print"
   spec.add_development_dependency "benchmark-ips"
-  spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "fuubar"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"

data/lib/definition.rb

@@ -2,8 +2,12 @@
 
 require "definition/version"
 require "definition/dsl"
+require "definition/dsl/comparators"
+require "definition/dsl/nil"
 require "definition/value_object"
 
 module Definition
   extend Dsl
+  extend Dsl::Comparators
+  extend Dsl::Nil
 end

data/lib/definition/dsl/comparators.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Definition
+  module Dsl
+    module Comparators
+      # Example:
+      # MaxSize(5)
+      def MaxSize(max_size) # rubocop:disable Naming/MethodName
+        Types::Lambda.new(:max_size) do |value|
+          case value
+          when String, Enumerable
+            conform_with(value) if value.size <= max_size
+          else
+            value
+          end
+        end
+      end
+
+      # Example:
+      # MinSize(5)
+      def MinSize(min_size) # rubocop:disable Naming/MethodName
+        Types::Lambda.new(:min_size) do |value|
+          case value
+          when String, Enumerable
+            conform_with(value) if value.size >= min_size
+          else
+            value
+          end
+        end
+      end
+
+      # Example:
+      # NonEmptyString
+      def NonEmptyString # rubocop:disable Naming/MethodName
+        Types::And.new(:non_empty_string, Type(String), MinSize(1))
+      end
+
+      # Example:
+      # GreaterThen(5)
+      def GreaterThen(min_value) # rubocop:disable Naming/MethodName
+        Types::Lambda.new("greater_then_#{min_value}") do |value|
+          conform_with(value) if value.is_a?(Numeric) && value > min_value
+        end
+      end
+
+      # Example:
+      # GreaterThenEqual(5)
+      def GreaterThenEqual(min_value) # rubocop:disable Naming/MethodName
+        Types::Lambda.new("greater_then_equal_#{min_value}") do |value|
+          conform_with(value) if value.is_a?(Numeric) && value >= min_value
+        end
+      end
+
+      # Example:
+      # LessThen(5)
+      def LessThen(max_value) # rubocop:disable Naming/MethodName
+        Types::Lambda.new("less_then_#{max_value}") do |value|
+          conform_with(value) if value.is_a?(Numeric) && value < max_value
+        end
+      end
+
+      # Example:
+      # LessThenEqual(5)
+      def LessThenEqual(max_value) # rubocop:disable Naming/MethodName
+        Types::Lambda.new("less_then_equal_#{max_value}") do |value|
+          conform_with(value) if value.is_a?(Numeric) && value <= max_value
+        end
+      end
+
+      # Example:
+      # Equal("value")
+      def Equal(expected_value) # rubocop:disable Naming/MethodName
+        Types::Lambda.new(:equal) do |value|
+          conform_with(value) if value == expected_value
+        end
+      end
+
+      # Example:
+      # Empty
+      def Empty # rubocop:disable Naming/MethodName
+        Types::Lambda.new(:empty) do |value|
+          case value
+          when String, Array, Hash
+            conform_with(value) if value.empty?
+          else
+            value
+          end
+        end
+      end
+
+      # Example:
+      # NonEmpty
+      def NonEmpty # rubocop:disable Naming/MethodName
+        Types::Lambda.new(:non_empty) do |value|
+          case value
+          when String, Array, Hash
+            conform_with(value) unless value.empty?
+          else
+            value
+          end
+        end
+      end
+
+      # Example:
+      # Regex
+      def Regex(regex) # rubocop:disable Naming/MethodName
+        Types::Lambda.new("regex #{regex.inspect}") do |value|
+          case value
+          when String
+            conform_with(value) unless regex.match(value).nil?
+          else
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/definition/dsl/nil.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Definition
+  module Dsl
+    module Nil
+      # Example:
+      # Nil
+      def Nil # rubocop:disable Naming/MethodName
+        Types::Lambda.new(:nil) do |value|
+          conform_with(value) if value.nil?
+        end
+      end
+    end
+  end
+end

data/lib/definition/types/and.rb

@@ -35,7 +35,7 @@ module Definition
             ConformResult.new(results.last.value)
           else
             ConformResult.new(value, errors: [
-                                ConformError.new(definition, "Not all children are valid for #{definition.name}",
+                                ConformError.new(definition, "Not all definitions are valid for #{definition.name}",
                                                  sub_errors: results.map(&:errors).flatten)
                               ])
           end

data/lib/definition/types/or.rb

@@ -33,10 +33,10 @@ module Definition
           if result.is_a?(ConformResult)
             result
           else
-            ConformResult.new(value, errors: [
-                                ConformError.new(definition, "None of the children are valid for #{definition.name}",
-                                                 sub_errors: result)
-                              ])
+            error = ConformError.new(definition,
+                                     "None of the definitions are valid for #{definition.name}",
+                                     sub_errors: result)
+            ConformResult.new(value, errors: [error])
           end
         end
 

data/lib/definition/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: definition
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dominik Goltermann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-12 00:00:00.000000000 Z
+date: 2019-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: approvals
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
@@ -232,8 +218,10 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- Changelog.md
 - Gemfile
 - Guardfile
+- LICENSE
 - README.md
 - Rakefile
 - benchmark/coercion.rb
@@ -246,6 +234,8 @@ files:
 - lib/definition/conform_error.rb
 - lib/definition/conform_result.rb
 - lib/definition/dsl.rb
+- lib/definition/dsl/comparators.rb
+- lib/definition/dsl/nil.rb
 - lib/definition/types.rb
 - lib/definition/types/and.rb
 - lib/definition/types/base.rb