easy_json_matcher 0.2.2 → 0.3.0

data/test/validation_step_not_required_test.rb

@@ -0,0 +1,35 @@
+require "test_helper"
+require "validation_chain_test_helper"
+
+include ValidationChainTestHelper
+
+module EasyJSONMatcher
+
+  describe "Not Required Validation Step" do
+
+    describe "should halt the chain if the value is missing" do
+
+      it "should halt the chain if the value is missing" do
+        head, tail = get_validation_chain
+        test_value = nil
+        head.check(value: test_value).must_be :empty?
+      end
+
+      it "should allow the chain to continue if the value is present" do
+        head, tail = get_validation_chain
+        test_value = 1
+        tail.expect(:check, [], [{ value: 1 }])
+        tail.expect(:nil?, false)
+        head.check(value: test_value)
+        tail.verify
+      end
+    end
+
+    def get_validation_chain
+      head = ValidationChainFactory.get_step_for validating: :not_required
+      tail = Minitest::Mock.new
+      head >> tail
+      return head, tail
+    end
+  end
+end

data/test/validation_step_number_test.rb

@@ -0,0 +1,23 @@
+require "test_helper"
+require "validation_chain_test_helper"
+
+include ValidationChainTestHelper
+
+describe "Number Validation Step" do
+
+  describe "should be able to return a instance that validates numbers" do
+
+    it "the instance should not return any errors for a valid number" do
+      require 'bigdecimal'
+      (-10..10).step(0.01) do |n|
+        n = BigDecimal.new(n,3).to_f
+        assert_chain_verifies(type: :number, test_value: n, outcome: true ) 
+      end
+    end
+
+    it "the instance should return errors for invalid numbers" do
+      no_number = "hello"
+      assert_chain_verifies(type: :number, test_value: no_number, outcome: false) 
+    end
+  end
+end

data/test/validation_step_object_test.rb

@@ -0,0 +1,20 @@
+require "test_helper"
+require "validation_chain_test_helper"
+
+include ValidationChainTestHelper
+
+describe "Object validation step" do
+
+    describe "should be able to return an instance that validates objects" do
+
+      it "the instance should not return any errors for a valid object" do
+        test_value = JSON.parse({}.to_json) # Yes, I know this is odd
+        assert_chain_verifies(type: :object, test_value: test_value, outcome: true)
+      end
+
+      it "the instance should return errors for an invalid object" do
+        no_object = String.new
+        assert_chain_verifies(type: :object, test_value: no_object, outcome: false)
+      end
+    end
+end

data/test/validation_step_required_test.rb

@@ -0,0 +1,19 @@
+require "test_helper"
+require "validation_chain_test_helper"
+
+include ValidationChainTestHelper
+
+describe "Required Validation Step" do
+
+  describe ":required option" do
+
+    it "should not return any errors if the value is present" do
+      present = 1
+      assert_chain_verifies type: :required, test_value: present, outcome: true
+    end
+
+    it "should return an error if a value is not present" do
+      [nil].each { |v| assert_chain_verifies type: :required, test_value: v, outcome: false }
+    end
+  end
+end

data/test/validation_step_string_test.rb

@@ -0,0 +1,20 @@
+require "test_helper"
+require "validation_chain_test_helper"
+
+include ValidationChainTestHelper
+
+describe "String Validation Chain" do
+
+  describe "should be able to retun an instance that validates strings" do
+
+    it "the instance should not return any errors for a valid string" do
+      string = String.new
+      assert_chain_verifies(type: :string, test_value: string, outcome: true)
+    end
+
+    it "the instance should return errors if the value is not a string" do
+      no_string = 1
+      assert_chain_verifies(type: :string, test_value: no_string, outcome: false)
+    end
+  end
+end

data/test/validation_step_test.rb

@@ -0,0 +1,55 @@
+require "test_helper"
+require "easy_json_matcher/validation_step"
+
+module EasyJSONMatcher
+
+  class ValidationStepTest < ActiveSupport::TestCase
+
+    setup do
+      @subject = ValidationStep.new(verify_with: ->(value, errors) {} )
+    end
+
+    test "it_should_respond_to_check" do
+      assert_respond_to(@subject, :check)
+    end
+
+    test "It should allow the user to chain validation steps together" do
+      head = @subject
+      tail = MiniTest::Mock.new
+      test_value = "hello!"
+      head >> tail
+      tail.expect(:check, [], [Hash])
+      tail.expect(:nil?, false)
+      head.check(value: test_value)
+      tail.verify
+    end
+
+    test "It should send call to the verifier assigned to it" do
+      verifier = MiniTest::Mock.new
+      subject = ValidationStep.new(verify_with: verifier)
+      test_value = "verify me"
+      verifier.expect(:call, nil, [test_value, []])
+      subject.check(value: test_value)
+    end
+
+    test "If the verifier returns :stop the chain will be halted" do
+      verifier = ->(value, errors) { false }
+      middle = ValidationStep.new(verify_with: verifier)
+      tail = MiniTest::Mock.new
+      test_value = "verify me"
+      @subject >> middle >> tail
+      @subject.check(value: test_value)
+      # There is no official way to check that something wasn't called in
+      # MiniTest, so we'll just have to assume that since verify passes, then
+      # check wasn't called in tail
+      tail.verify
+    end
+
+    test "It should return an array of errors found" do
+      head = ValidationStep.new(verify_with: ->(value, errors) { errors << 1 })
+      tail = ValidationStep.new(verify_with: ->(value, errors) { errors << 2 })
+      head >> tail
+      assert(head.check(value: "Oh! Mrs. Mogs") == [1, 2])
+    end
+  end
+end

data/test/validation_step_value_test.rb

@@ -0,0 +1,15 @@
+require "test_helper"
+require "validation_chain_test_helper"
+
+include ValidationChainTestHelper
+
+describe "Value Validation Step" do
+
+  describe "should be able to return an instance that verifies values" do
+
+    it "should not return any errors for a valid value, which includes nil" do
+      value = nil
+      assert_chain_verifies type: :value, test_value: value, outcome: true 
+    end
+  end
+end

data/test/validator_set_test.rb

@@ -0,0 +1,49 @@
+require "test_helper"
+require "easy_json_matcher/validator_set.rb"
+
+module EasyJSONMatcher
+
+  describe ValidatorSet do
+
+    it "should hold other validators" do
+      test_val = Object.new
+      subject = ValidatorSet.new validators: { test:  test_val }
+      subject.validators.values.include?(test_val).must_be :==, true
+    end
+
+    it "should return true if all its validators validate their candidates" do
+      mock_validators = { key1: mock_validator, key2: mock_validator }
+      subject = ValidatorSet.new validators: mock_validators
+      subject.check(value: {}).must_be :empty?
+    end
+
+    it "should return false if any of its validators find an invalid value" do
+      mock_validators = {
+        key1: mock_validator(validity: true),
+        key2: mock_validator(validity: false)
+      }
+      subject = ValidatorSet.new validators: mock_validators
+      subject.check(value: { key1: "test", key2: "test" }).wont_be :empty?
+    end
+
+    it "should return error messages in a Array" do
+      subject = ValidatorSet.new validators: { invalid: mock_validator }
+      assert(subject.check(value: {}).is_a?(Array))
+    end
+
+    it "should return the error messages for all its validators" do
+      error_validators = {
+        a: mock_validator(validity: false, error_message:  "a"),
+        b: mock_validator(validity: false, error_message:  "b")
+      }
+      subject = ValidatorSet.new(validators: error_validators)
+      expected_error_message = [{ a: ["a"], b: ["b"] }]
+      assert_equal(expected_error_message, subject.check(value: {}))
+    end
+
+    def mock_validator(validity: true, error_message: nil)
+      mock = MiniTest::Mock.new
+      mock.expect(:check, validity ? [] : [error_message], [Object])
+    end
+  end
+end

data/test/validator_test.rb

@@ -0,0 +1,44 @@
+require "test_helper"
+
+Validator = EasyJSONMatcher::Validator
+
+describe Validator do
+
+  describe "#valid?" do
+
+    before do
+      @v_step = Minitest::Mock.new
+      @subject = Validator.new(validate_with: @v_step)
+    end
+
+    it "should use a ValidationStep chain to verify candidates" do
+      @v_step.expect(:check, {}, [Hash])
+      @subject.valid? candidate: Hash.new.to_json
+      @v_step.verify
+    end
+
+    it "should return false if any errors are generated" do
+      @v_step.expect(:check, { a: 1, b: 2,c: 3 }, [Hash])
+      @subject.valid?(candidate: Hash.new.to_json).must_be :==, false
+    end
+
+    it "should return true if no errors are generated" do
+      @v_step.expect(:check, {}, [Hash])
+      @subject.valid?(candidate: Hash.new.to_json).must_be :==, true
+    end
+  end
+
+  describe "#validate" do
+
+    before do
+      @v_step = Minitest::Mock.new
+      @subject = Validator.new(validate_with: @v_step)
+    end
+
+    it "should call check on its verifier" do
+      @v_step.expect(:check, Hash.new, [Hash])
+      test_value = { a: 1, b: 2, c: 3 }.to_json
+      @subject.validate(candidate: test_value)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_json_matcher
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - WJD Hamilton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-01 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies: []
 description: Test your JSON output in Ruby, with a DSL that makes reasoning about
   your JSON very straightforward. See the Homepage for docs.
@@ -21,41 +21,61 @@ files:
 - MIT-LICENSE
 - Rakefile
 - lib/easy_json_matcher.rb
+- lib/easy_json_matcher.rb~
+- lib/easy_json_matcher/array_content_validator.rb
+- lib/easy_json_matcher/array_generator.rb
 - lib/easy_json_matcher/array_validator.rb
-- lib/easy_json_matcher/boolean_validator.rb
+- lib/easy_json_matcher/attribute_generator.rb
+- lib/easy_json_matcher/attribute_type_methods.rb
+- lib/easy_json_matcher/coercion_error.rb
 - lib/easy_json_matcher/content_wrapper.rb
-- lib/easy_json_matcher/date_validator.rb
+- lib/easy_json_matcher/easy_json_matcher_error.rb
 - lib/easy_json_matcher/exceptions.rb
+- lib/easy_json_matcher/json_coercer.rb
 - lib/easy_json_matcher/node.rb
-- lib/easy_json_matcher/node.rb~
-- lib/easy_json_matcher/number_validator.rb
-- lib/easy_json_matcher/object_validator.rb
+- lib/easy_json_matcher/node_generator.rb
 - lib/easy_json_matcher/schema_generator.rb
-- lib/easy_json_matcher/schema_generator.rb~
 - lib/easy_json_matcher/schema_library.rb
-- lib/easy_json_matcher/string_validator.rb
-- lib/easy_json_matcher/validation_error.rb
+- lib/easy_json_matcher/unknown_validation_step_error.rb
+- lib/easy_json_matcher/validation_chain_factory.rb
+- lib/easy_json_matcher/validation_rules.rb
+- lib/easy_json_matcher/validation_step.rb
 - lib/easy_json_matcher/validator.rb
-- lib/easy_json_matcher/validator.rb~
-- lib/easy_json_matcher/validator_factory.rb
-- lib/easy_json_matcher/value_validator.rb
+- lib/easy_json_matcher/validator_set.rb
 - lib/easy_json_matcher/version.rb
-- lib/easy_json_matcher/version.rb~
 - lib/tasks/jsonapi_matcher_tasks.rake
+- test/array_content_validator_test.rb
 - test/custom_validations_test.rb
-- test/custom_validations_test.rb~
-- test/easy_json_matcher_test.rb
-- test/easy_json_matcher_test.rb~
-- test/error_messages_test.rb
 - test/global_validation_options_test.rb
 - test/json_api_home.txt
+- test/json_coercer_test.rb
 - test/managing_schemas_test.rb
+- test/node_test.rb
+- test/primitives_boolean_test.rb
+- test/primitives_date_test.rb
+- test/primitives_number_test.rb
+- test/primitives_object_test.rb
+- test/primitives_string_test.rb
+- test/primtives_value_test.rb
 - test/required_validation_test.rb
-- test/reset_test.rb
-- test/reset_test.rb~
+- test/schema_generator_test.rb
 - test/strict_mode_test.rb
 - test/test_helper.rb
 - test/validating_arrays_test.rb
+- test/validation_chain_factory_test.rb
+- test/validation_chain_test_helper.rb
+- test/validation_step_array_test.rb
+- test/validation_step_boolean_test.rb
+- test/validation_step_date_test.rb
+- test/validation_step_not_required_test.rb
+- test/validation_step_number_test.rb
+- test/validation_step_object_test.rb
+- test/validation_step_required_test.rb
+- test/validation_step_string_test.rb
+- test/validation_step_test.rb
+- test/validation_step_value_test.rb
+- test/validator_set_test.rb
+- test/validator_test.rb
 homepage: https://github.com/wjdhamilton/easy-json-matcher
 licenses:
 - MIT
@@ -81,17 +101,35 @@ signing_key:
 specification_version: 4
 summary: Easily test your JSON output with templates and Schemas
 test_files:
+- test/array_content_validator_test.rb
 - test/custom_validations_test.rb
-- test/custom_validations_test.rb~
-- test/easy_json_matcher_test.rb
-- test/easy_json_matcher_test.rb~
-- test/error_messages_test.rb
 - test/global_validation_options_test.rb
 - test/json_api_home.txt
+- test/json_coercer_test.rb
 - test/managing_schemas_test.rb
+- test/node_test.rb
+- test/primitives_boolean_test.rb
+- test/primitives_date_test.rb
+- test/primitives_number_test.rb
+- test/primitives_object_test.rb
+- test/primitives_string_test.rb
+- test/primtives_value_test.rb
 - test/required_validation_test.rb
-- test/reset_test.rb
-- test/reset_test.rb~
+- test/schema_generator_test.rb
 - test/strict_mode_test.rb
 - test/test_helper.rb
 - test/validating_arrays_test.rb
+- test/validation_chain_factory_test.rb
+- test/validation_chain_test_helper.rb
+- test/validation_step_array_test.rb
+- test/validation_step_boolean_test.rb
+- test/validation_step_date_test.rb
+- test/validation_step_not_required_test.rb
+- test/validation_step_number_test.rb
+- test/validation_step_object_test.rb
+- test/validation_step_required_test.rb
+- test/validation_step_string_test.rb
+- test/validation_step_test.rb
+- test/validation_step_value_test.rb
+- test/validator_set_test.rb
+- test/validator_test.rb

data/lib/easy_json_matcher/boolean_validator.rb

@@ -1,14 +0,0 @@
-require 'easy_json_matcher/validator'
-module EasyJSONMatcher
-  class BooleanValidator < Validator
-
-    def _validate
-      errors << "#{content} is not a Boolean" unless _content_is_boolean?
-    end
-
-    def _content_is_boolean?
-      clazz = content.class
-      (clazz == TrueClass) || (clazz == FalseClass)
-    end
-  end
-end

data/lib/easy_json_matcher/date_validator.rb

@@ -1,44 +0,0 @@
-require 'easy_json_matcher/validator'
-module EasyJSONMatcher
-  class DateValidator < Validator
-
-    attr_reader :string_validator, :date_format
-    DEFAULT_DATE_FORMAT = "%Y-%m-%d"
-
-    def initialize(opts = {})
-      super(opts)
-      @date_format = opts[:format]
-      @string_validator = _create_validator(type: :string)
-    end
-
-    def _validate
-      _validate_string
-      _validate_date
-    end
-
-    def _content_is_a_string?
-      string_validator.valid? content
-    end
-
-    def _content_is_a_date?
-      require 'date'
-      begin
-        Date.strptime(content, date_format)
-      rescue ArgumentError
-        false
-      end
-    end
-
-    def date_format
-      @date_format || DEFAULT_DATE_FORMAT
-    end
-
-    def _validate_string
-      errors << "#{content} must be provided as a String for Date validation" unless _content_is_a_string?
-    end
-
-    def _validate_date
-      errors << "#{content} is not a Date" unless _content_is_a_date?
-    end
-  end
-end

data/lib/easy_json_matcher/node.rb~

@@ -1,121 +0,0 @@
-require 'easy_json_matcher/validator_factory'
-require 'json'
-require 'easy_json_matcher/content_wrapper'
-module EasyJSONMatcher
-  class Node < Validator
-    include ContentWrapper
-
-    attr_reader :validators, :validity, :strict
-
-    def initialize(opts: {})
-      super(options: opts)
-      @validators = []
-      @validity = true
-    end
-
-    def add_validator(validator)
-      validators << validator
-    end
-
-    def _post_initialise(options)
-      @strict = options[:strict]
-    end
-
-    def _validate
-      _validate_strict_keyset
-      validators.each do |val|
-        @validity = false unless _use_validator val
-      end
-    end
-
-    def reset!
-      errors.clear
-      validators.each(&:reset!)
-    end
-
-    def _validate_strict_keyset
-      _validate_keyset if strict
-    end
-
-    def _validate_keyset
-      unexpected_keys = keys - _expected_keys
-      errors << "#{unexpected_keys} found in addition to expected keys" unless unexpected_keys.empty?
-    end
-
-    def _expected_keys
-      validators.each_with_object([]) do |validator, keyset|
-        keyset << validator.key
-      end
-    end
-
-    def _use_validator(validator)
-      validator.valid? self
-    end
-
-    def _get_content_for(key)
-      content[key]
-    end
-
-    def _get_validator_for(key)
-      validators[key]
-    end
-
-    def _set_content(candidate)
-      @content = _is_root? ? _prep_root_content(candidate) : candidate[key]
-    end
-
-    def _is_root?
-      key.nil?
-    end
-
-    def get_errors
-      child_errors = _collect_child_errors
-      _wrap_errors(child_errors)
-    end
-
-    def _collect_child_errors
-      validators.each_with_object({}) do |val, container|
-        container.merge!(val.get_errors)
-      end
-    end
-
-    def _wrap_errors(child_errors)
-      _add_local_errors_to child_errors
-      unless _is_root?
-        _wrap_child_errors(child_errors)
-      else
-        _root_errors(child_errors)
-      end
-    end
-
-    def _add_local_errors_to(child_errors)
-      child_errors.merge!({node_errors_: errors}) unless errors.empty?
-    end
-
-    def _wrap_child_errors(child_errors)
-      errors_wrapper = {}
-      errors_wrapper[key] = child_errors
-      errors_wrapper
-    end
-
-    def _root_errors(child_errors)
-      errors.length > 0 ? {root: errors} : child_errors
-    end
-
-    def _prep_root_content(candidate)
-       candidate.is_a?(String) ? _parse_and_verify_json(candidate) : candidate
-    end
-
-    def _parse_and_verify_json(json)
-      begin
-        JSON.parse(json)
-      rescue JSON::ParserError
-        errors << '#{json} is not a valid JSON String'
-      end
-    end
-
-    def _no_errors?
-      validity && errors.empty?
-    end
-  end
-end

data/lib/easy_json_matcher/number_validator.rb

@@ -1,22 +0,0 @@
-# Asserts that a value is a double-precision floating point number in javascript format
-require 'easy_json_matcher/validator'
-module EasyJSONMatcher
-
-  class NumberValidator < Validator
-
-    def _validate
-      errors << "#{content} is not a Number" unless _content_is_a_number?
-    end
-
-    def _content_is_a_number?
-      begin
-        Kernel::Float(content)
-        true
-      rescue ArgumentError
-        false
-      rescue TypeError
-        false
-      end
-    end
-  end
-end

data/lib/easy_json_matcher/object_validator.rb

@@ -1,12 +0,0 @@
-require 'easy_json_matcher/validator'
-module EasyJSONMatcher
-  class ObjectValidator < Validator
-    def _validate
-      _content_is_object?
-    end
-
-    def _content_is_object?
-      errors << "#{content} is not an Object" unless content.is_a? Hash
-    end
-  end
-end