hash_schema 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3b7349c659a2350aa25c7458299b28585588c51
-  data.tar.gz: 8fd0f8a09a4efc41f210c8a249248a1ea3d209d1
+  metadata.gz: 772c753165bbc1e83ce3c65fe5b45bb49ec3365c
+  data.tar.gz: 625cddb7219d5a8e04157d3710382d4e01725f52
 SHA512:
-  metadata.gz: cf3e54beb99430de451ac85d7c1094fceec8e10c1096c55eefa740a75fbbdd816d1d627ef9cd722797786d307bf53892fb669f8b5e5e970f4c186e65c61812c9
-  data.tar.gz: cda472ff701fc474a1846e31c0ed90f14a9b3486fbfa34415d4fbb7b14a8ba769da48f84adde52361494ead9fb1a52fee36253e160a3359250b700969065d413
+  metadata.gz: 90439941e93b65e6880ec0683d23c20466264a13eca95c566eb680dc43e25f5f83abe14a0f53e72046350cb9b701e452d2fbf530bb4d47c51421488983f73f54
+  data.tar.gz: abdc89cc5ef3026d536f7656be1060f6a109ab3a999a37d4b2618ff88f81a1a1e13ba5e17df5828e90b9e4346f1a90ef92f8df16517667edec85475698676dd0

data/README.md

@@ -1,4 +1,4 @@
-# HashSchema
+# HashSchema [![Gem Version](https://badge.fury.io/rb/hash_schema.svg)](http://badge.fury.io/rb/hash_schema)
 
 A ruby gem that validates Hash against some schema, works for hashes created from loading json and yml files, and suchlike
 
@@ -18,7 +18,172 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Defined schemas
+
+* StringSchema
+* NumberSchema
+* BooleanSchema
+* EnumSchema
+* OptionalSchema
+* OrSchema
+* ArraySchema
+* **HashSchema**
+
+### API
+
+- `#valdiate` :: Hash -> Hash
+- `#pretty_validate` :: Hash -> String **(*)**
+- `#interpret` :: Hash -> [String]
+
+**(*)** `#pretty_validate` is just a `JSON.pretty_generate` wrapper of `#validate`
+
+*See below for more details*
+
+### Demo
+
+*Demo Setup*
+
+```ruby
+require 'json'
+require 'hash_schema'
+
+class Test
+  include HashSchema
+
+  Definition = HashSchema.new(
+    string_good: StringSchema.new,
+    string_bad: StringSchema.new,
+    number_good: NumberSchema.new,
+    number_bad: NumberSchema.new,
+    boolean_good: BooleanSchema.new,
+    boolean_bad: BooleanSchema.new,
+    enum_good1: EnumSchema.new('z', 0),
+    enum_good2: EnumSchema.new('z', 0),
+    enum_bad: EnumSchema.new('z', 0),
+    optional_good: OptionalSchema.new(1),
+    optional_bad: OptionalSchema.new(1),
+    optional_key_missing: OptionalSchema.new(1),
+    mandatory_key_missing: 'value',
+    or_good1: OrSchema.new(StringSchema.new, NumberSchema.new),
+    or_good2: OrSchema.new(StringSchema.new, NumberSchema.new),
+    or_bad: OrSchema.new(StringSchema.new, NumberSchema.new),
+    array_good: ArraySchema.new(NumberSchema.new),
+    array_bad: ArraySchema.new(NumberSchema.new),
+    object_array_good: ArraySchema.new(HashSchema.new(x: NumberSchema.new, y: NumberSchema.new)),
+    object_array_bad: ArraySchema.new(HashSchema.new(x: NumberSchema.new, y: NumberSchema.new)),
+    object_array_missing: ArraySchema.new(HashSchema.new(x: NumberSchema.new, y: NumberSchema.new)),
+    nested_hash: HashSchema.new(string: 'xyz', number: 987, boolean: true),
+    nested_hash_missing: HashSchema.new
+  )
+end
+
+data = {
+  string_good: '123',
+  string_bad: 123,
+  number_good: 456,
+  number_bad: '456',
+  boolean_good: true,
+  boolean_bad: 'false',
+  enum_good1: 'z',
+  enum_good2: 0,
+  enum_bad: 'a',
+  optional_good: 1,
+  optional_bad: 2,
+  or_good1: 'abc',
+  or_good2: 123,
+  or_bad: false,
+  array_good: [0.5, 3.1, 4.2, 8],
+  array_bad: [nil, 'a', false],
+  object_array_good: [{ x: 0.5, y: 0.3 }, { x: 4, y: 3 }],
+  object_array_bad: [{ x: 3 }, { y: 4 }],
+  nested_hash: {}
+}
+```
+
+*Demo output*
+
+```ruby
+puts Test::Definition.pretty_validate(data) # outputs the following
+```
+
+    {
+      "string_good": null,
+      "string_bad": "Expected String but got 123",
+      "number_good": null,
+      "number_bad": "Expected Number but got \"456\"",
+      "boolean_good": null,
+      "boolean_bad": "Expected Boolean but got \"false\"",
+      "enum_good1": null,
+      "enum_good2": null,
+      "enum_bad": "Expected \"z\" or 0 but got \"a\"",
+      "optional_good": null,
+      "optional_bad": "Expected 1 but got 2",
+      "optional_key_missing": null,
+      "mandatory_key_missing": "Expected \"value\" but got Nothing",
+      "or_good1": null,
+      "or_good2": null,
+      "or_bad": "Expected String or Number but got false",
+      "array_good": [
+        null,
+        null,
+        null,
+        null
+      ],
+      "array_bad": [
+        "Expected Number but got nil",
+        "Expected Number but got \"a\"",
+        "Expected Number but got false"
+      ],
+      "object_array_good": [
+        {
+          "x": null,
+          "y": null
+        },
+        {
+          "x": null,
+          "y": null
+        }
+      ],
+      "object_array_bad": [
+        {
+          "x": null,
+          "y": "Expected Number but got Nothing"
+        },
+        {
+          "x": "Expected Number but got Nothing",
+          "y": null
+        }
+      ],
+      "object_array_missing": "Expected [Hash] but got Nothing",
+      "nested_hash": {
+        "string": "Expected \"xyz\" but got Nothing",
+        "number": "Expected 987 but got Nothing",
+        "boolean": "Expected true but got Nothing"
+      },
+      "nested_hash_missing": "Expected Hash but got Nothing"
+    }
+
+```ruby
+puts Test::Definition.interpret(data) # outputs the following
+```
+
+    root:{} > .string_bad > Expected String but got 123
+    root:{} > .number_bad > Expected Number but got "456"
+    root:{} > .boolean_bad > Expected Boolean but got "false"
+    root:{} > .enum_bad > Expected "z" or 0 but got "a"
+    root:{} > .optional_bad > Expected 1 but got 2
+    root:{} > .mandatory_key_missing > Expected "value" but got Nothing
+    root:{} > .or_bad > Expected String or Number but got false
+    root:{} > array_bad:[] > #0 > Expected Number but got nil
+    root:{} > array_bad:[] > #1 > Expected Number but got "a"
+    root:{} > array_bad:[] > #2 > Expected Number but got false
+    root:{} > object_array_bad:[] > #0:{} > .y > Expected Number but got Nothing
+    root:{} > object_array_bad:[] > #1:{} > .x > Expected Number but got Nothing
+    root:{} > .object_array_missing > Expected [Hash] but got Nothing
+    root:{} > nested_hash:{} > .string > Expected "xyz" but got Nothing
+    root:{} > nested_hash:{} > .number > Expected 987 but got Nothing
+    root:{} > nested_hash:{} > .boolean > Expected true but got Nothing
+    root:{} > .nested_hash_missing > Expected Hash but got Nothing
 
 ## Contributing
 

data/hash_schema.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.0"
+
   spec.add_development_dependency "bump"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "byebug"

data/lib/hash_schema/version.rb

@@ -1,3 +1,3 @@
 module HashSchema
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Po Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-03 00:00:00.000000000 Z
+date: 2014-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -112,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="