objecheck 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e5e64af44a98f5a68b9a29c37c3aebb76b07838cab71bf1855b043f2e4c81f3
-  data.tar.gz: 1aab0ebbeb4d062fef6cfd2d89ae063ee9429864c11ed83f99523c053eeea677
+  metadata.gz: 29c7a9581a27191aa05d1df83b5743bb7ad31b82cc4bad3e14c88730e65ffcd5
+  data.tar.gz: a58f1b7f322487a8211ab49ddb2188e5fa88729378bdcdc5740c4ab96ea12a1a
 SHA512:
-  metadata.gz: 8b670597d9010ea8b5abb053f9e2a13f6c6c3b810e7b6b042421dc6a24ceee0b9de8607ba4bcb36e1f26c25fa015fae3e6146b900eab481fff703bae657f65db
-  data.tar.gz: e381afd9b7169b6bf6b38062df731bb4d9738fcbc483f25519c392acfb87e9e2b4da8f54598d189e29f378bfb798d9f5a922ae7ddceae836d0d18f6a93259042
+  metadata.gz: c6ad10d126d6b66c26c6c5c4d8e9ee8c1ff44ec93a69dbb4a0b509af64f1f5a421b85b2f8f8d7200653a95764cf905bb758ce5a7a0e7e339238d3431acd1044a
+  data.tar.gz: 1f21d8d7f8245f9a0e4c640b91740e8adc44cc3da1bfd3750936af45b2d6c4b52278d9d3b80c16115501c4ed6086cd23ff5a7d4d6e860b83060a141097e91872

data/.rubocop.yml

@@ -58,6 +58,9 @@ Metrics/PerceivedComplexity:
 Metrics/CyclomaticComplexity:
   Max: 7
 
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+
 Performance/RedundantMerge:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## v0.4.0
+
+- Add `AnyRule` as `any`
+- Add transaction API to collector for commit/rollback errors
+
 ## v0.3.0
 
 - Add `EqRule` as `eq`

data/README.md

@@ -151,6 +151,20 @@ Example schema:
 }
 ```
 
+### `any`
+
+`any` makes disjunction of rules.
+
+Example schema:
+```ruby
+{
+  any: [
+    { type: Integer },
+    { type: String }
+  ]
+}
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/autopp/objecheck.

data/lib/objecheck/error.rb

@@ -0,0 +1,4 @@
+# Error is used to represent internal error
+#
+class Objecheck::Error < StandardError
+end

data/lib/objecheck/validator/any_rule.rb

@@ -0,0 +1,42 @@
+#
+# 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.
+#
+
+# AnyRule validates that object meets one of the give rules
+#
+class Objecheck::Validator::AnyRule
+  def initialize(validator, schemas)
+    @child_rules = schemas.map do |schema|
+      validator.compile_schema(schema)
+    end
+  end
+
+  def validate(target, collector)
+    t = collector.transaction
+    t.add_error("should satisfy one of the #{@child_rules.size} schemas")
+    t_for_nested_rules = t.transaction
+    result = @child_rules.each.with_index(1).any? do |rules, i|
+      t_for_nested_rules.add_prefix_in("(option #{i})") { t_for_nested_rules.validate(target, rules) }
+    end
+
+    if result
+      t.rollback(t_for_nested_rules)
+      collector.rollback(t)
+    else
+      t.commit(t_for_nested_rules)
+      collector.commit(t)
+    end
+  end
+end

data/lib/objecheck/validator/collector.rb

@@ -17,11 +17,15 @@
 # Collector is used in Validator#validate to aggregate errors
 #
 class Objecheck::Validator::Collector
-  def initialize(validator)
+  attr_reader :current_rule_name, :prefix_stack, :current_t
+
+  def initialize(validator, parent = nil)
     @validator = validator
-    @current_rule_name = nil
-    @prefix_stack = []
+    @current_validation_result = true
+    @current_rule_name = parent ? parent.current_rule_name : nil
+    @prefix_stack = parent ? [parent.prefix_stack.join('')] : []
     @errors = []
+    @current_t = nil
   end
 
   def add_prefix_in(prefix)
@@ -32,20 +36,51 @@ class Objecheck::Validator::Collector
   end
 
   def add_error(msg)
+    @current_validation_result = false
     @errors << "#{@prefix_stack.join('')}: #{@current_rule_name}: #{msg}"
   end
 
   def validate(target, rules)
     prev_rule_name = @current_rule_name
+    prev_validation_result = @current_validation_result
     rules.each do |name, rule|
       @current_rule_name = name
       rule.validate(target, self)
     end
+    @current_validation_result
   ensure
     @current_rule_name = prev_rule_name
+    @current_validation_result = prev_validation_result
   end
 
   def errors
     @errors.dup
   end
+
+  def transaction
+    raise Objecheck::Error, 'another transaction is already created' if @current_t
+
+    @current_t = self.class.new(@validator, self)
+  end
+
+  def commit(t)
+    check_transaction(t)
+    @current_t = nil
+    @errors.concat(t.errors)
+  end
+
+  def rollback(t)
+    check_transaction(t)
+    @current_t = nil
+  end
+
+  private
+
+  def check_transaction(t)
+    raise Objecheck::Error, 'transaction is not created' if !@current_t
+
+    raise Objecheck::Error, "invalid transaction #{t} (current: #{@current_t})" if !t.equal?(@current_t)
+
+    raise Objecheck::Error, "transaction hash uncommited nested transaction (#{t.current_t})" if t.current_t
+  end
 end

data/lib/objecheck/validator.rb

@@ -23,12 +23,14 @@ class Objecheck::Validator
   require 'objecheck/validator/each_value_rule'
   require 'objecheck/validator/key_value_rule'
   require 'objecheck/validator/eq_rule'
+  require 'objecheck/validator/any_rule'
   DEFAULT_RULES = {
     type: TypeRule,
     each: EachRule,
     each_key: EachKeyRule,
     each_value: EachValueRule,
-    key_value: KeyValueRule
+    key_value: KeyValueRule,
+    any: AnyRule
   }.freeze
 
   def initialize(schema, rule_map = DEFAULT_RULES)

data/lib/objecheck.rb

@@ -19,4 +19,5 @@
 module Objecheck
 end
 
+require 'objecheck/error'
 require 'objecheck/validator'

data/objecheck.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'objecheck'
-  spec.version       = '0.3.0'
+  spec.version       = '0.4.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.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - autopp
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-26 00:00:00.000000000 Z
+date: 2018-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,7 +85,9 @@ files:
 - bin/console
 - bin/setup
 - lib/objecheck.rb
+- lib/objecheck/error.rb
 - lib/objecheck/validator.rb
+- lib/objecheck/validator/any_rule.rb
 - lib/objecheck/validator/collector.rb
 - lib/objecheck/validator/each_key_rule.rb
 - lib/objecheck/validator/each_rule.rb