hash_schema 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 772c753165bbc1e83ce3c65fe5b45bb49ec3365c
-  data.tar.gz: 625cddb7219d5a8e04157d3710382d4e01725f52
+  metadata.gz: b87caa584dee8275eeb175b5fe4b8d36107db062
+  data.tar.gz: 9d03b279577309ed4af1cfa41ba785fc03941641
 SHA512:
-  metadata.gz: 90439941e93b65e6880ec0683d23c20466264a13eca95c566eb680dc43e25f5f83abe14a0f53e72046350cb9b701e452d2fbf530bb4d47c51421488983f73f54
-  data.tar.gz: abdc89cc5ef3026d536f7656be1060f6a109ab3a999a37d4b2618ff88f81a1a1e13ba5e17df5828e90b9e4346f1a90ef92f8df16517667edec85475698676dd0
+  metadata.gz: e608f9f48ae0fd3ff26f58c081b45677a49fb9763fc723d81e4d4f6cfaf76086caead85c9a3d00f8e5783c71e11e0732a10f340fb0391be5578413fbbb1c43b7
+  data.tar.gz: 0c01d4c2e02eaa7d2fb02b1756ddb666281fc0d1d5580e45585da54518e4cc81950f060d93fe81b35a811c571026983323d7ff94cb3e7d2d4f4fa69d500785ad

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+cache:
+  bundler: true
+sudo: false
+branches:
+  only: master

data/README.md

@@ -18,22 +18,110 @@ Or install it yourself as:
 
 ## Usage
 
+### What it is / isn't for
+
+It is for:
+
+- validating structure
+    - e.g. a hash contains keys `greetings` and `name`, and `name` is an inner hash that contains `give`, `family` and `other`
+        - { "greetings": "Hello", "name": { "given": "John", "family": "Doe", "other": "" } }
+- validating data type
+    - e.g. { "offset": [7, 8] }, where `offset` has to be an array of numbers
+- validating constants
+    - e.g. some value has to be set to `true`
+
+It is **not** for:
+
+- validating dependency
+    - e.g. key A has to exist if key B exists
+
+[Jump down to see detailed example](#demo)
+
 ### Defined schemas
 
-* StringSchema
-* NumberSchema
-* BooleanSchema
-* EnumSchema
-* OptionalSchema
-* OrSchema
-* ArraySchema
-* **HashSchema**
+#### StringSchema
+
+- `.new`
+    - takes no arguments
+- `#validate` :: (String|\*) -> (*Null*|error)
+
+#### NumberSchema
+
+- `.new`
+    - takes no arguments
+- `#validate` :: (Number|\*) -> (*Null*|error)
+
+#### BooleanSchema
+
+- `.new`
+    - takes no arguments
+- `#validate` :: (Boolean|\*) -> (*Null*|error)
+
+#### EnumSchema
+
+- `.new`
+    - takes literal constants, e.g. 123, "456", false, true...
+- `#validate` :: (\*) -> (*Null*|error)
+    - An inclusion check is performed
 
-### API
+#### OptionalSchema
+
+- `.new`
+    - takes a Schema or literal constant
+- `#validate` :: (Void|\*) -> (*Null*|error)
+    - `Void.new` is the internal representation of `Nothing`
+    - if anything other than `Void.new` is given
+        - it is delegated to the Schema, if a Schema was given when initializing
+        - it performs equality check, if initialized with anything other than a Schema
+
+#### OrSchema
+
+- `.new`
+    - takes multiple Schemas
+- `#validate` :: (\*) -> (*Null*|error)
+    - it passes if any of the given Schema passes
+    - it errors if all of the given Schema end up with error
+
+#### ArraySchema
+
+- `.new`
+    - takes one Schemas
+- `#validate` :: (Array|\*) -> (**Array**|error)
+    - it errors if the arugment passed to `#validate` is not an array
+    - it maps the Schema validation over the elements in the array
+    - it returns the mapped-over array
+
+#### HashSchema
+
+- `.new`
+    - takes keywords, see `#1`
+    - other than Schemas, you can also specify literal constants like in `#2`
+    - you can specify `strict` mode if you want to see errors for not specified keys
+    - if you have the key `strict` in your data hash, see `#3`
+
+```ruby
+#1
+HashSchema.new(a: NumberSchema.new, b: BooleanSchema.new, c: StringSchema.new)
+
+#2
+HashSchema.new(strict: true,
+  number: 1,
+  boolean: true,
+  string: 'string',
+  ampm_array: ArraySchema.new(EnumSchema.new('am', 'pm'))
+)
+
+#3
+HashSchema.new(strict: true,
+  schema_hash: {
+    strict: 'I am strict'
+  }
+)
+```
 
-- `#valdiate` :: Hash -> Hash
-- `#pretty_validate` :: Hash -> String **(*)**
-- `#interpret` :: Hash -> [String]
+- `#valdiate` :: (Hash|\*) -> (**Hash**|error)
+- `#pretty_validate` :: (Hash|\*) -> String **(*)**
+- `#interpret` :: (Hash|\*) -> [String]
 
 **(*)** `#pretty_validate` is just a `JSON.pretty_generate` wrapper of `#validate`
 

data/lib/hash_schema.rb

@@ -86,19 +86,65 @@ module HashSchema
     end
 
     def validate(data)
+      empty_error = true
+      last_error = nil
       chain.each do |schema|
-        if data.is_a?(Array) && schema.is_a?(ArraySchema) || data.is_a?(Hash) && schema.is_a?(HashSchema)
-          return schema.validate(data)
-        end
-        return if schema.validate(data).nil?
+        next unless schema_matches_data_type(schema, data)
+        last_error = schema.validate(data)
+        empty_error = recursive_empty_error?(last_error)
+        break if empty_error
+      end
+      if empty_error
+        last_error
+      else
+        error(data)
       end
-      error(data)
     end
 
     def expectation
       *names, name = chain.map(&:expectation)
       names.join(', ') << " or #{name}"
     end
+
+    private
+
+    def recursive_empty_error?(error)
+      case error
+      when NilClass
+        true
+      when String
+        false
+      when Hash, Array
+        recursive_flat_error_values(error).empty?
+      else
+        false
+      end
+    end
+
+    def schema_matches_data_type(schema, data)
+      case schema
+      when ArraySchema
+        data.is_a? Array
+      when HashSchema
+        data.is_a? Hash
+      else
+        true
+      end
+    end
+
+    def recursive_flat_error_values(error_object)
+      if error_object.is_a? Hash
+        error_object.values.flat_map do |value|
+          recursive_flat_error_values(value)
+        end.compact
+      elsif error_object.is_a? Array
+        error_object.flat_map do |value|
+          recursive_flat_error_values(value)
+        end.compact
+      else
+        error_object
+      end
+    end
   end
 
   class StringSchema < Schema

data/lib/hash_schema/version.rb

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

data/spec/hash_schema_spec.rb

@@ -113,6 +113,9 @@ describe HashSchema do
         HashSchema::NumberSchema.new,
         HashSchema::StringSchema.new,
         HashSchema::ArraySchema.new(HashSchema::StringSchema.new),
+        HashSchema::ArraySchema.new(HashSchema::NumberSchema.new),
+        HashSchema::ArraySchema.new(HashSchema::HashSchema.new(stringy: HashSchema::StringSchema.new)),
+        HashSchema::HashSchema.new(boolean: HashSchema::BooleanSchema),
         HashSchema::HashSchema.new
       )
     end
@@ -131,7 +134,25 @@ describe HashSchema do
       end
 
       it 'delegates to given HashSchema for hash' do
-        expect(multitype.validate({})).to be_a(Hash)
+        expect(multitype.validate(boolean: true)).to be_a(Hash)
+      end
+
+      it 'delegates to more than one inner ArraySchema' do
+        validation_result = multitype.validate([1, 2, 3])
+        expect(validation_result).to be_a(Array)
+        expect(validation_result.compact).to be_empty
+      end
+
+      it 'delegates to more than one inner HashSchema' do
+        validation_result = multitype.validate(boolean: 5)
+        expect(validation_result).to be_a(Hash)
+        expect(validation_result.values.compact).to be_empty
+      end
+
+      it 'recurses into hashes and arrays' do
+        validation_result = multitype.validate([ { stringy: 'hello' } ])
+        expect(validation_result).to be_a(Array)
+        expect(validation_result).to eq [ { stringy: nil } ]
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Po Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-06 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -91,6 +91,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -120,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Validate Hash against Schema