objecheck 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c34dee3669dc8ba5d6da6601f2691dfa1cdf596b23cdb575ce99fec568e84283
-  data.tar.gz: 5a190c9ad765f40ae422a87462134a2066c48497acb63518f2cc63f1cded79e1
+  metadata.gz: affc792d7a719592fb092a7e9c8bf3aa3bfbc06afca7fad8809ba1d053d1edbf
+  data.tar.gz: d776e2cb69dcf8193f60f526bc07adec05aa8c27c80a4bb51c0d19ceba365f00
 SHA512:
-  metadata.gz: 57c538a3674c233bbf7ba84a6bd0a454b8f0532306d62530adce569b6965143180c60be60e3899064eb671f293d31886ae515d65b6418641e13c66d6ac36f2e0
-  data.tar.gz: df4388871daec2f26406fa2bd91e0c9e9779d70fbef3a8c32a11187bd6effb43f90130dab742c4e094ced95f182356e058a5c2cfbc23b2f8bab1b6a6c20fa3de
+  metadata.gz: 5ccebbd3396d7f066cb2e7f6cb56c36de1e839d6ee12511e52128355b5e56708f614ed323fab8df3f9b48350d584eb486515376eb96cad4abe76bf9fd83258bf
+  data.tar.gz: bbb8f479f54c1461e9b3c8a690d11fa86eaf6471a31d36c4d393312d47be60c14dfd29aa146791627eabc412a96a84cd4381a46172e0b57a779bdf2f091834d5

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## v0.2.0
+
+- Change signature of rule's `#validate` to enable nested schema
+- Include rule name in error message
+- Add `EachRule` as `each_rule`
+- Add `EachKeyRule` as `each_key_rule`
+- Add `EachValueRule` as `each_value_rule`
+- Add `KeyValueRule` as `key_value_rule`
+
 ## v0.1.0
 
 First release

data/README.md

@@ -1,5 +1,6 @@
 # Objecheck
 
+[![Gem Version](https://badge.fury.io/rb/objecheck.svg)](https://badge.fury.io/rb/objecheck)
 [![CircleCI](https://circleci.com/gh/autopp/objecheck/tree/master.svg?style=shield)](https://circleci.com/gh/autopp/objecheck/tree/master)
 
 Objecheck provides a simple and extensible object validator
@@ -33,6 +34,32 @@ validator = Objecheck::Validator.new({
 # Validator#validate checks the given object and returns error messages as a array
 p validator.validate({ a: 1, b: 2 }) # => []
 p validator.validate([1, 2]) # => ["root: the type should be a Hash (got Array)"]
+
+# Validate type of keys and values
+validator = Objecheck::Validator.new({
+  each_key: { type: Symbol }
+  each_value: { type: Integer }
+})
+
+p validator.validate({ a: 1, b: 2 }) # => []
+
+# Validate array that contains specific key/value
+validator = Objecheck::Validator.new({
+  type: Array,
+  each: {
+    key_value: {
+      name: {
+        value: { type: String }
+      },
+      age: {
+        required: false,
+        value: { type: Integer }
+      }
+    }
+  }
+})
+
+p validator.validate([{ name: 'Jhon', age: 20 }, { name: 'Tom' }]) # => []
 ```
 
 ## Builtin rules
@@ -48,6 +75,64 @@ Example schema:
 }
 ```
 
+### `each`
+
+`each` checks elements of the object by using `each`.
+
+Example schema:
+```ruby
+{
+  each: {
+    type: Integer
+  }
+}
+```
+
+### `each_key`
+
+`each_key` checks keys of the object by using `each_key`.
+
+Example schema:
+```ruby
+{
+  each_key: {
+    type: Symbol
+  }
+}
+```
+
+### `each_value`
+
+`each_value` checks values of the object by using `each_pair`.
+
+Example schema:
+```ruby
+{
+  each_value: {
+    type: Integer
+  }
+}
+```
+
+### `key_value`
+
+`key_value` checks key/values of the object by using `each_pair`.
+
+Example schema:
+```ruby
+{
+  key_value: {
+    name: {
+      value: { type: String }
+    },
+    age: {
+      required: false # Default is true
+      value: { type: Integer }
+    }
+  }
+}
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/autopp/objecheck.

data/lib/objecheck/validator/collector.rb

@@ -19,6 +19,7 @@
 class Objecheck::Validator::Collector
   def initialize(validator)
     @validator = validator
+    @current_rule_name = nil
     @prefix_stack = []
     @errors = []
   end
@@ -31,7 +32,17 @@ class Objecheck::Validator::Collector
   end
 
   def add_error(msg)
-    @errors << "#{@prefix_stack.join('')}: #{msg}"
+    @errors << "#{@prefix_stack.join('')}: #{@current_rule_name}: #{msg}"
+  end
+
+  def validate(target, rules)
+    prev_rule_name = @current_rule_name
+    rules.each do |name, rule|
+      @current_rule_name = name
+      rule.validate(target, self)
+    end
+  ensure
+    @current_rule_name = prev_rule_name
   end
 
   def errors

data/lib/objecheck/validator/each_key_rule.rb

@@ -0,0 +1,36 @@
+#
+# Objecheck
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+
+# EachKeyRule validates keys in the target by using each_key
+#
+class Objecheck::Validator::EachKeyRule
+  def initialize(validator, key_schema)
+    @key_rules = validator.compile_schema(key_schema)
+  end
+
+  def validate(target, collector)
+    if !target.respond_to?(:each_key)
+      collector.add_error('should respond to `each_key`')
+      return
+    end
+
+    target.each_key do |key|
+      collector.add_prefix_in(".key(#{key.inspect})") do
+        collector.validate(key, @key_rules)
+      end
+    end
+  end
+end

data/lib/objecheck/validator/each_rule.rb

@@ -0,0 +1,36 @@
+#
+# Objecheck
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+
+# EachRule validates elements in the target by using each
+#
+class Objecheck::Validator::EachRule
+  def initialize(validator, element_schema)
+    @element_rules = validator.compile_schema(element_schema)
+  end
+
+  def validate(target, collector)
+    if !target.respond_to?(:each)
+      collector.add_error('should respond to `each`')
+      return
+    end
+
+    target.each.with_index do |elem, i|
+      collector.add_prefix_in("[#{i}]") do
+        collector.validate(elem, @element_rules)
+      end
+    end
+  end
+end

data/lib/objecheck/validator/each_value_rule.rb

@@ -0,0 +1,36 @@
+#
+# Objecheck
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+
+# EachValueRule validates values in the target by using each_pair
+#
+class Objecheck::Validator::EachValueRule
+  def initialize(validator, value_schema)
+    @value_rules = validator.compile_schema(value_schema)
+  end
+
+  def validate(target, collector)
+    if !target.respond_to?(:each_pair)
+      collector.add_error('should respond to `each_pair`')
+      return
+    end
+
+    target.each_pair do |key, value|
+      collector.add_prefix_in("[#{key.inspect}]") do
+        collector.validate(value, @value_rules)
+      end
+    end
+  end
+end

data/lib/objecheck/validator/key_value_rule.rb

@@ -0,0 +1,45 @@
+#
+# Objecheck
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+
+# KeyValueRule validates key/value in the target by using each_pair
+#
+class Objecheck::Validator::KeyValueRule
+  def initialize(validator, key_value_schema)
+    @key_value_rules = key_value_schema.each_with_object({}) do |(key, schema), rules|
+      rules[key] = {
+        required: schema.fetch(:required, true),
+        rule: validator.compile_schema(schema[:value])
+      }
+    end
+  end
+
+  def validate(target, collector)
+    if !target.respond_to?(:each_pair)
+      collector.add_error('should respond to `each_pair`')
+      return
+    end
+
+    @key_value_rules.each_pair do |key, rule|
+      if target.key?(key)
+        collector.add_prefix_in("[#{key.inspect}]") do
+          collector.validate(target[key], rule[:rule])
+        end
+      elsif rule[:required]
+        collector.add_error("should contain key #{key.inspect}")
+      end
+    end
+  end
+end

data/lib/objecheck/validator/type_rule.rb

@@ -17,11 +17,11 @@
 # TypeRule validates type of a target
 #
 class Objecheck::Validator::TypeRule
-  def initialize(type)
+  def initialize(_validator, type)
     @type = type
   end
 
   def validate(target, collector)
-    collector.add_error("the type should be a #{@type} (got #{target.class})") if !target.is_a?(@type)
+    collector.add_error("should be a #{@type} (got #{target.class})") if !target.is_a?(@type)
   end
 end

data/lib/objecheck/validator.rb

@@ -18,25 +18,36 @@
 #
 class Objecheck::Validator
   require 'objecheck/validator/type_rule'
+  require 'objecheck/validator/each_rule'
+  require 'objecheck/validator/each_key_rule'
+  require 'objecheck/validator/each_value_rule'
+  require 'objecheck/validator/key_value_rule'
   DEFAULT_RULES = {
-    type: TypeRule
+    type: TypeRule,
+    each: EachRule,
+    each_key: EachKeyRule,
+    each_value: EachValueRule,
+    key_value: KeyValueRule
   }.freeze
 
-  def initialize(schema, rules = DEFAULT_RULES)
-    @rules = schema.map do |rule_name, param|
-      rules[rule_name].new(param)
-    end
+  def initialize(schema, rule_map = DEFAULT_RULES)
+    @rule_map = rule_map
+    @rules = compile_schema(schema)
   end
 
   def validate(target)
     collector = Collector.new(self)
     collector.add_prefix_in('root') do
-      @rules.each do |rule|
-        rule.validate(target, collector)
-      end
+      collector.validate(target, @rules)
     end
     collector.errors
   end
+
+  def compile_schema(schema)
+    schema.each_with_object({}) do |(rule_name, param), rules|
+      rules[rule_name] = @rule_map[rule_name].new(self, param)
+    end
+  end
 end
 
 require 'objecheck/validator/collector'

data/objecheck.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'objecheck'
-  spec.version       = '0.1.0'
+  spec.version       = '0.2.0'
   spec.authors       = ['autopp']
   spec.email         = ['autopp.inc@gmail.com']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: objecheck
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - autopp
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-18 00:00:00.000000000 Z
+date: 2018-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,6 +87,10 @@ files:
 - lib/objecheck.rb
 - lib/objecheck/validator.rb
 - lib/objecheck/validator/collector.rb
+- lib/objecheck/validator/each_key_rule.rb
+- lib/objecheck/validator/each_rule.rb
+- lib/objecheck/validator/each_value_rule.rb
+- lib/objecheck/validator/key_value_rule.rb
 - lib/objecheck/validator/type_rule.rb
 - objecheck.gemspec
 homepage: https://github.com/autopp/objecheck