easy_json_matcher 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4a01a086ab4017866d0ada74af47467a6daa903
-  data.tar.gz: 84a4731a80838262adc023b7150771998edcbe15
+  metadata.gz: 8247cb3e9791930357fc71b2adccd2207722d96c
+  data.tar.gz: a016110a42e4c8b82b0b58e06b9c0a858d20af14
 SHA512:
-  metadata.gz: 0aab586ee4777ef78bff7e762f8342898a4768b914426a2528b55bab53ca894091846eeec79556d56fcd2bc73f927000262825513c4bb33a364ca07ed5301b96
-  data.tar.gz: 8cbe1988516116eea04c3482a7e6b15061e6a0c1f2cd416b175a40dd98bed9902e190fe2531d7a839ba622bba10c897cf9bad87a65bcc63270308d4f55a39c52
+  metadata.gz: ac9579c176287786a0f09bfe575f9362aa9d3ab723cf8ad6a94c18f546be62ec7f7cb08c1e9052f888129c0547ff8c2c82706e6c52042eb6ebe490acea22549c
+  data.tar.gz: 79cf3770d9f3898dfec75acfff000133e88f2e636e7a9f2ec802fd9386995aad72c73c39836d6584518213b52f2060916a29f0eb570e508ae7857c071be24ecf

data/lib/easy_json_matcher/schema_generator.rb

@@ -14,7 +14,7 @@ module EasyJSONMatcher
       yield self if block_given?
     end
 
-    def has_attribute(key:, opts: {})
+    def has_attribute(key:, opts: {}, custom_validator: nil)
       node.add_validator(_create_validator(key, opts))
     end
 

data/lib/easy_json_matcher/validator.rb

@@ -1,12 +1,13 @@
 module EasyJSONMatcher
   class Validator
 
-    attr_reader :content, :required, :errors
+    attr_reader :content, :required, :errors, :custom_validator
     attr_accessor :key
 
     def initialize(options: {})
       @key = options[:key]
       @required = options[:required]
+      @custom_validator = options[:custom_validator]
       @errors = []
       _post_initialise(options)
     end
@@ -24,6 +25,7 @@ module EasyJSONMatcher
       else
         _validate #Hook
       end
+      _run_custom_validator if custom_validator
       _no_errors?
     end
 
@@ -83,6 +85,16 @@ module EasyJSONMatcher
       ValidatorFactory.get_instance(type: type, opts: opts)
     end
 
+    def _custom_validator?
+      custom_validator
+    end
+
+    def _run_custom_validator
+      if error_message = custom_validator.call(content)
+        errors << error_message
+      end
+    end
+
     def _no_errors?
       errors.empty?
     end

data/lib/easy_json_matcher/validator.rb~

@@ -0,0 +1,99 @@
+module EasyJSONMatcher
+  class Validator
+
+    attr_reader :content, :required, :errors, :custom_validator
+    attr_accessor :key
+
+    def initialize(options: {})
+      @key = options[:key]
+      @required = options[:required]
+      @custom_validator = options[:custom_validator]
+      @errors = []
+      _post_initialise(options)
+    end
+
+    # Hook. Allows further setup to be carried out by subclasses
+    def _post_initialise(options); end
+
+    def valid?(candidate)
+      if key
+        return false unless _check_content_type(candidate)
+      end
+      _set_content(candidate) #Hook
+      if content.nil?
+         _check_required?
+      else
+        _validate #Hook
+      end
+      _run_custom_validator if custom_validator
+      _no_errors?
+    end
+
+    # Hook. Overriden in Node
+    def reset!
+      errors.clear
+    end
+
+    # Hook
+    # Protected method that Validators use to implement their validation logic.
+    # Called by #valid?
+    def _validate
+      raise NotImplementedError.new "Validators must override _validate"
+    end
+
+    # Hook
+    # Protected method that Validators use to set their content from the candidate.
+    def _set_content(candidate)
+      @content = key ? candidate[key] : candidate
+    end
+
+    # Hook.
+    # This method returns the errors that this validator has found in the candidate.
+    def get_errors
+      error_message = {}
+      error_message[key.to_sym] = errors
+      error_message
+    end
+
+    # This method makees sure that the candidate behaves like a Hash, and not a
+    # value or an array.
+    def _check_content_type(candidate)
+      # TODO perhaps this should raise an error instead of returning false?
+      # if the value that has arrived at this point doesn't behave like a Hash then it
+      # is in the wrong place.
+      begin
+        candidate[key]
+      rescue TypeError
+        return false
+      end
+      true
+    end
+
+    def _check_required?
+      if required
+        errors << "Value was not present"
+        return true
+      else
+        return false
+      end
+    end
+
+    def _create_validator(type:, opts: {})
+      ValidatorFactory.get_instance(type: type, opts: opts)
+    end
+
+    def _custom_validator?
+      custom_validator
+    end
+
+    def _run_custom_validator
+      if error_message = custom_validator.call(content)
+        errors << error_message
+      end
+    end
+
+    def _no_errors?
+      errors.empty?
+    end
+  end
+end

data/lib/easy_json_matcher/version.rb

@@ -1,3 +1,3 @@
-module JsonapiMatcher
-  VERSION = "0.1.1".freeze
+module EasyJSONMatcher
+  VERSION = "0.2.1".freeze
 end

data/lib/easy_json_matcher/version.rb~

@@ -0,0 +1,3 @@
+module EasyJSONMatcher
+  VERSION = "0.2.1".freeze
+end

data/test/custom_validations_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class CustomValidationsTest < ActiveSupport::TestCase
+
+  test 'As a user, I want to be able to specify custom validations' do
+    test_schema = EasyJSONMatcher::SchemaGenerator.new do |s|
+      s.has_string key: :a_string, opts: { custom_validator: ->(candidate) { "String did not say 'hi'" unless candidate == 'hi' } }
+    end.generate_schema
+
+    should_not_validate = {
+      a_string: 'go away'
+    }.to_json
+
+    assert_not(test_schema.valid? should_not_validate)
+
+    should_validate = {
+      a_string: 'hi'
+    }.to_json
+
+
+    test_schema.reset!
+
+    assert(test_schema.valid?(should_validate), test_schema.get_errors)
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_json_matcher
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - WJD Hamilton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-23 00:00:00.000000000 Z
+date: 2016-04-01 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.
@@ -34,10 +34,13 @@ files:
 - lib/easy_json_matcher/string_validator.rb
 - lib/easy_json_matcher/validation_error.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/version.rb
+- lib/easy_json_matcher/version.rb~
 - lib/tasks/jsonapi_matcher_tasks.rake
+- test/custom_validations_test.rb
 - test/easy_json_matcher_test.rb
 - test/error_messages_test.rb
 - test/global_validation_options_test.rb
@@ -73,6 +76,7 @@ signing_key:
 specification_version: 4
 summary: Easily test your JSON output with templates and Schemas
 test_files:
+- test/custom_validations_test.rb
 - test/easy_json_matcher_test.rb
 - test/error_messages_test.rb
 - test/global_validation_options_test.rb