json_schema_power_validator 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06fcc8aa4f8d7fc45dbdddd8a35c74e937a1479a
-  data.tar.gz: f031b1619b76312287ea55d848b9a4ea7a22f188
+  metadata.gz: 217f235573a81f3d22ebb64633f775e1fbe3a9f9
+  data.tar.gz: a0b7ac78f8beac81d279b74729b555299c279bec
 SHA512:
-  metadata.gz: 474b829ca277ef7da0aef946331d326222b8194ff37e584a794fadb3ffe1380ff94595af97074a2d9bccca1548096d09bf58758d132c2b58f8a87b131f3be8b7
-  data.tar.gz: cbde5b9b928923862f11e97c69d8dbb9cc7d1f23d46f02f29775097ff304a7c42578edfa9249b9e6168a6d5a8e863c8f3c2b6aabd7b0c35331153f599269afa6
+  metadata.gz: 260a86c6ffa094e83778a21349db4697f55d942b6954dda5e3bcc9b7f1cb03fc1e445e3aa9656d36ebd05940b6cae6805e5af5f56f13289c5fa9179f6fda2641
+  data.tar.gz: fd07b1aa717066dba3b93fb87220e01b3634c957e8ed236f84a860eab3ab6fefebb6417139c97a7759f35f63c56f90928a8ad7a20d37ed015550718d447d884d

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/bundle/
+.DS_Store

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in json_schema_spec.gemspec
 gemspec
+
+group :test do
+  gem 'test-unit'
+end

data/README.md

@@ -1,8 +1,8 @@
 # JsonSchema::PowerValidator
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/json_schema_power_validator`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Test JSON Schema itself with contexts.
+After preparation of schema and test suite, you can test schema response.
+It'll display each results with json format.
 
 ## Installation
 
@@ -22,62 +22,39 @@ Or install it yourself as:
 
 ## Usage
 
-```json
-{
-	"id": "https://github.com/timakin/json_schema_power_validator/schema/sample.json",
-	"$schema": "http://json-schema.org/draft-04/schema#",
-	"description": "Test schema for example",
-	"definitions": {
-		"positiveInt": {
-			"type": "integer",
-			"minimum": 0
-		},
-		"name": {
-			"type": "string",
-			"minimumLength": 4,
-			"maximumLength": 12
-		}
-	},
-	"type": "object",
-	"properties": {
-		"id": {
-			"$ref": "#/definitions/positiveInt"
-		},
-		"username": {
-			"$ref": "#/definitions/name"
-		}
-	}
-}
-```
+Prepare json schema you'd like to test and test suite.
+A test suite must be written on the fixed format.
+The suite must include parameters:
+
+- examples 			- Array of test cases, and each of them should include following parameters
+	- context 		- Title of each test
+	- description - Detail of the test
+	- expect			- Expectation of a result of test (it must be "valid"/"invalid")
+	- values 			- Parameters that'll be used as test values.
+
+The below json is the example of test suite on the above format.
 
 ```json
 {
-	"id": "https://github.com/timakin/json_schema_power_validator/schema/suite/sample.json",
-	"description": "Schema PowerValidator for example.json",
 	"examples": [
 		{
 			"context": "Success",
 			"description": "Success Case",
 			"expect": "valid",
 			"values": {
-				"id": 1,
-				"username": "timakin"
+				  "id": 1234,
+				  "name": "timakin",
+				  ...
 			}
 		},
 		{ ... },
-		{
-			"context": "Fail",
-			"description": "fail",
-			"expect": "valid",
-			"values": {
-				"id": -100,
-				"username": "tim"
-			}
-		}
+		{ ... }
 	]
 }
 ```
 
+With the suite, you can get a detail error message, and check whether the results are all clear or not.
+
 ```ruby
 require 'json_schema_power_validator'
 
@@ -90,11 +67,11 @@ validated_schema.get_result
 #			"description": "Success Case",
 #			"result": "success"
 #		},
-#		{ ... }
+#		{ ... },
 #		{
 #			"context": "Fail",
-#			"description": "fail"
-#			"reason": "Invalid parameter: id should satisfy the condition minimumLength"
+#			"description": "Failed Case",
+#			"result": "The property '#/id' did not have a minimum value of 0, inclusively"
 #		}
 #	]
 #}
@@ -109,6 +86,16 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## Test
+
+To run test:
+
+```
+$ cd /path/to/repository
+$ bundle install --path vendor/bundle
+$ bundle exec ruby spec/json_schema_power_validator_spec.rb
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/timakin/json_schema_power_validator/fork )

data/lib/json_schema_power_validator.rb

@@ -1,4 +1,5 @@
 require "json_schema_power_validator/version"
+require "json_schema_power_validator/errors/parse_suite_error"
 require "json-schema"
 
 module JsonSchema
@@ -22,6 +23,8 @@ module JsonSchema
     private
 
     def validate
+      verify_suite_parameters
+
       @suites["examples"].each do |suite|
         begin
           JSON::Validator.validate!(@schema, suite["values"])
@@ -30,9 +33,24 @@ module JsonSchema
           suite["expect"] == "invalid" ? @raw_results.push("Success") : @raw_results.push($!.message)
         end
       end
+
       get_result_by_json
     end
 
+    def verify_suite_parameters
+      unless @suites["examples"]
+        raise ParseSuiteError.new("examples for a test suite is undefined, or format is invalid.")
+      end
+      
+      @suites["examples"].each do |suite|
+        ["context", "description", "expect", "values"].each do |param|
+          if suite[param].nil?
+            raise ParseSuiteError.new("#{param} for a test suite is undefined.")
+          end          
+        end
+      end
+    end
+
     def get_result_by_json
       @raw_results.each_with_index { |result, index| 
         @result_json << {

data/lib/json_schema_power_validator/errors/parse_suite_error.rb

@@ -0,0 +1,4 @@
+module JsonSchema
+  class ParseSuiteError < StandardError
+  end
+end

data/lib/json_schema_power_validator/version.rb

@@ -1,3 +1,3 @@
 module JsonSchema
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_schema_power_validator
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - timakin
@@ -68,6 +68,7 @@ files:
 - bin/setup
 - json_schema_power_validator.gemspec
 - lib/json_schema_power_validator.rb
+- lib/json_schema_power_validator/errors/parse_suite_error.rb
 - lib/json_schema_power_validator/version.rb
 homepage: https://github.com/timakin/json_schema_power_validator
 licenses: