schemacop 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c25bec9da7704ee8d22967b1e23fd75c51e05843
-  data.tar.gz: 860bb199cc9a1c6aab7f3d332ba48365af4a5c89
+  metadata.gz: 461a65a27019c789e45d30f6d5be819c214a0b0a
+  data.tar.gz: ee57b67c3b810a9602e6914e151f86dba6d8b55f
 SHA512:
-  metadata.gz: 96f03301ad940846d477707f67fd86c74724d8aae5b762097422e70f489da642a1252b25a891054716955df7f21726fb60b0114e11881768fed44f8796398a89
-  data.tar.gz: fb672cc70bde3f7a8eb5c9afbdd1116a5d2ef15dd87a6bbb005d31e060dccece88ade022f9872114d4fb85f682dca120040822e29781b5be0e350b4c9f267b96
+  metadata.gz: b380fbdc36ab0a3ddda2b646128d6f300303ca4181765a84b32c1f499d5b081dcdaf88b8bb6b58325174c08f759c4308aa793c04cef53ad39638de4052eb6a7f
+  data.tar.gz: 8424d9820513500bd7616fcc5d13b80793b1d4e773c19255820cf40f7097e53ec194e306fc2fa9f3ea36482677602b2e89f7d75d26802deb4d7e60c59556f47e

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Change log
+
+## master (unreleased)
+
+### New features
+
+### Bug fixes
+
+### Changes
+
+## 1.0.1 (2016-06-07)
+
+### Bug fixes
+
+* Fixed bug which didn't allow unspecified hash contents
+* Fixed bug which didn't allow mixed array type specifications
+
+## 1.0.0 (2016-06-06)
+
+* Initial stable release

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/doc/Schemacop.html

@@ -199,7 +199,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jun  6 18:27:25 2016 by
+  Generated on Tue Jun  7 10:37:13 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/Schemacop/Exceptions.html

@@ -106,7 +106,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jun  6 18:27:25 2016 by
+  Generated on Tue Jun  7 10:37:14 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/Schemacop/Exceptions/Base.html

@@ -118,7 +118,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jun  6 18:27:25 2016 by
+  Generated on Tue Jun  7 10:37:14 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/Schemacop/Exceptions/InvalidSchema.html

@@ -132,7 +132,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jun  6 18:27:25 2016 by
+  Generated on Tue Jun  7 10:37:14 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/Schemacop/Exceptions/Validation.html

@@ -133,7 +133,7 @@ schema definition.</p>
 </div>
 
     <div id="footer">
-  Generated on Mon Jun  6 18:27:25 2016 by
+  Generated on Tue Jun  7 10:37:14 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/Schemacop/Validator.html

@@ -108,11 +108,11 @@
           
         </dt>
         <dd><pre class="code"><span class='lbrace'>{</span>
-  <span class='label'>hash:</span>             <span class='lbracket'>[</span><span class='const'>Hash</span><span class='rbracket'>]</span><span class='comma'>,</span>
-  <span class='label'>array:</span>            <span class='lbracket'>[</span><span class='const'>Array</span><span class='rbracket'>]</span><span class='comma'>,</span>
-  <span class='label'>string:</span>           <span class='lbracket'>[</span><span class='const'>String</span><span class='rbracket'>]</span><span class='comma'>,</span>
-  <span class='label'>integer:</span>          <span class='lbracket'>[</span><span class='const'>Integer</span><span class='rbracket'>]</span><span class='comma'>,</span>
-  <span class='label'>boolean:</span>          <span class='lbracket'>[</span><span class='const'>TrueClass</span><span class='comma'>,</span> <span class='const'>FalseClass</span><span class='rbracket'>]</span>
+  <span class='label'>hash:</span>    <span class='lbracket'>[</span><span class='const'>Hash</span><span class='rbracket'>]</span><span class='comma'>,</span>
+  <span class='label'>array:</span>   <span class='lbracket'>[</span><span class='const'>Array</span><span class='rbracket'>]</span><span class='comma'>,</span>
+  <span class='label'>string:</span>  <span class='lbracket'>[</span><span class='const'>String</span><span class='rbracket'>]</span><span class='comma'>,</span>
+  <span class='label'>integer:</span> <span class='lbracket'>[</span><span class='const'>Integer</span><span class='rbracket'>]</span><span class='comma'>,</span>
+  <span class='label'>boolean:</span> <span class='lbracket'>[</span><span class='const'>TrueClass</span><span class='comma'>,</span> <span class='const'>FalseClass</span><span class='rbracket'>]</span>
 <span class='rbrace'>}</span></pre></dd>
       
     </dl>
@@ -245,7 +245,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jun  6 18:27:25 2016 by
+  Generated on Tue Jun  7 10:37:14 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/_index.html

@@ -168,7 +168,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jun  6 18:27:25 2016 by
+  Generated on Tue Jun  7 10:37:13 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/file.README.html

@@ -393,7 +393,7 @@ concerning their name and the structure of their README file.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Mon Jun  6 18:27:25 2016 by
+  Generated on Tue Jun  7 10:37:13 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/index.html

@@ -393,7 +393,7 @@ concerning their name and the structure of their README file.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Mon Jun  6 18:27:25 2016 by
+  Generated on Tue Jun  7 10:37:13 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/doc/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon Jun  6 18:27:25 2016 by
+  Generated on Tue Jun  7 10:37:13 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/lib/schemacop/validator.rb

@@ -1,11 +1,11 @@
 module Schemacop
   class Validator
     TYPE_ALIASES = {
-      hash:             [Hash],
-      array:            [Array],
-      string:           [String],
-      integer:          [Integer],
-      boolean:          [TrueClass, FalseClass]
+      hash:    [Hash],
+      array:   [Array],
+      string:  [String],
+      integer: [Integer],
+      boolean: [TrueClass, FalseClass]
     }
 
     # Validates `data` against `schema` and throws an exception on missmatch.
@@ -25,42 +25,47 @@ module Schemacop
     end
 
     def prepare_schema(schema)
-      schema = { types: schema } unless schema.is_a? Hash
+      schema = { types: schema } unless schema.is_a?(Hash)
 
       if schema.include?(:type)
-        schema[:types] = schema.delete :type
+        schema[:types] = schema.delete(:type)
       else
         schema[:types] = :array unless schema[:array].nil?
         schema[:types] = :hash  unless schema[:hash].nil?
       end
 
       schema[:types] = [*schema[:types]]
+      schema[:types].map! do |type|
+        alias_type = TYPE_ALIASES.select { |_, v| v.include?(type) }.keys.first
+        type = alias_type unless alias_type.nil?
+        type
+      end
+
       schema[:types].each do |type|
         if type == :hash
-          if schema.include? :fields
-            schema[:hash] = schema.delete :fields
+          if schema.include?(:fields)
+            schema[:hash] = schema.delete(:fields)
           end
 
-          if schema[type].is_a? Hash
-            schema[type].each do |key, value|
-              schema[type][key] = prepare_schema value
+          schema[:hash] = schema[:hash] || {}
+          if schema[:hash].is_a?(Hash)
+            schema[:hash].each do |key, value|
+              schema[:hash][key] = prepare_schema(value)
             end
           end
         end
 
-        if type == :array
-          schema[:array] = prepare_schema schema[:array]
-        end
+        schema[:array] = prepare_schema(schema[:array]) if type == :array
       end
 
       schema
     end
 
     def assign_data_type(type)
-      if type.is_a? Symbol
+      if type.is_a?(Symbol)
         fail Exceptions::InvalidSchema, "Type alias #{type} is not supported." if TYPE_ALIASES[type].nil?
         TYPE_ALIASES[type]
-      elsif type.is_a? String
+      elsif type.is_a?(String)
         type.to_s.classify.safe_constantize
       else
         type
@@ -86,7 +91,7 @@ module Schemacop
         end
       end
 
-      unless supported_types.any? { |t| data.is_a?(t) }
+      if schema[:types].present? && !supported_types.any? { |t| data.is_a?(t) }
         fail Exceptions::Validation, "Property at path #{path} must be of type #{supported_types.inspect}."
       end
 
@@ -94,8 +99,7 @@ module Schemacop
       # Check for allowed values
       # ---------------------------------------------------------------
       if schema[:allowed_values] && !schema[:allowed_values].include?(data)
-        fail Exceptions::Validation,
-             "Value #{data.inspect} of property at path #{path} is not valid. Valid are: #{schema[:allowed_values].inspect}."
+        fail Exceptions::Validation, "Value #{data.inspect} of property at path #{path} is not valid. Valid are: #{schema[:allowed_values].inspect}."
       end
 
       # ---------------------------------------------------------------
@@ -108,11 +112,13 @@ module Schemacop
           fail Exceptions::InvalidSchema, "Missing schema entry :hash at path #{path}."
         end
 
-        data_keys = data.keys.collect(&:to_s)
         schema_keys = schema[:hash].keys.collect(&:to_s)
+        unless schema_keys.empty?
+          data_keys = data.keys.collect(&:to_s)
 
-        unless (obsolete_keys = data_keys - schema_keys).empty?
-          fail Exceptions::Validation, "Obsolete keys at path #{path}: #{obsolete_keys.inspect}."
+          unless (obsolete_keys = data_keys - schema_keys).empty?
+            fail Exceptions::Validation, "Obsolete keys at path #{path}: #{obsolete_keys.inspect}."
+          end
         end
 
         schema[:hash].each do |sub_key, sub_schema|
@@ -125,12 +131,12 @@ module Schemacop
               fail Exceptions::Validation, "Property at path #{path}.#{sub_key} can't be null."
             end
           else
-            validate_branch "#{path}.#{sub_key}", sub_schema, data[sub_key]
+            validate_branch("#{path}.#{sub_key}", sub_schema, data[sub_key])
           end
         end
-      elsif schema[:types].include? :array
+      elsif schema[:types].include?(:array)
         data.each_with_index do |value, index|
-          validate_branch "#{path}[#{index}]", schema[:array], value
+          validate_branch("#{path}[#{index}]", schema[:array], value)
         end
       end
     end

data/schemacop.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: schemacop 1.0.0 ruby lib
+# stub: schemacop 1.0.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "schemacop"
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sitrox"]
-  s.date = "2016-06-06"
-  s.files = [".gitignore", ".releaser_config", ".rubocop.yml", ".travis.yml", ".yardopts", "Gemfile", "LICENSE", "README.md", "RUBY_VERSION", "Rakefile", "VERSION", "doc/Schemacop.html", "doc/Schemacop/Exceptions.html", "doc/Schemacop/Exceptions/Base.html", "doc/Schemacop/Exceptions/InvalidSchema.html", "doc/Schemacop/Exceptions/Validation.html", "doc/Schemacop/Validator.html", "doc/_index.html", "doc/class_list.html", "doc/css/common.css", "doc/css/full_list.css", "doc/css/style.css", "doc/file.README.html", "doc/file_list.html", "doc/frames.html", "doc/index.html", "doc/js/app.js", "doc/js/full_list.js", "doc/js/jquery.js", "doc/method_list.html", "doc/top-level-namespace.html", "lib/schemacop.rb", "lib/schemacop/exceptions.rb", "lib/schemacop/validator.rb", "schemacop.gemspec", "test/schemacop_validator_test.rb"]
+  s.date = "2016-06-07"
+  s.files = [".gitignore", ".releaser_config", ".rubocop.yml", ".travis.yml", ".yardopts", "CHANGELOG.md", "Gemfile", "LICENSE", "README.md", "RUBY_VERSION", "Rakefile", "VERSION", "doc/Schemacop.html", "doc/Schemacop/Exceptions.html", "doc/Schemacop/Exceptions/Base.html", "doc/Schemacop/Exceptions/InvalidSchema.html", "doc/Schemacop/Exceptions/Validation.html", "doc/Schemacop/Validator.html", "doc/_index.html", "doc/class_list.html", "doc/css/common.css", "doc/css/full_list.css", "doc/css/style.css", "doc/file.README.html", "doc/file_list.html", "doc/frames.html", "doc/index.html", "doc/js/app.js", "doc/js/full_list.js", "doc/js/jquery.js", "doc/method_list.html", "doc/top-level-namespace.html", "lib/schemacop.rb", "lib/schemacop/exceptions.rb", "lib/schemacop/validator.rb", "schemacop.gemspec", "test/schemacop_validator_test.rb"]
   s.require_paths = ["lib"]
   s.rubygems_version = "2.1.11"
   s.summary = "Schemacop validates ruby structures consisting of nested hashes and arrays against simple schema definitions."

data/test/schemacop_validator_test.rb

@@ -10,10 +10,13 @@ class SchemacopValidatorTest < Minitest::Test
 
   def test_short_type_schema
     assert_schema({ type: :array, array: :string }, %w(Hello world))
+    assert_schema({ type: [Array], array: :string }, %w(Hello world))
     assert_schema({ array: :string }, %w(Hello world))
     assert_schema({ hash: { first_name: :string, last_name: :string } }, first_name: 'John', last_name: 'Doe')
 
-    assert_schema_failure({ type: :array }, %w(Hello world))
+    assert_schema_failure({ type: :array, array: :integer }, %w(Hello world))
+    assert_schema_failure({ type: Array, array: :string }, [1, 2, 3])
+    assert_schema_failure({ type: [Array], array: :integer }, %w(Hello world))
   end
 
   def test_many_types_schema
@@ -50,6 +53,63 @@ class SchemacopValidatorTest < Minitest::Test
     assert_schema(schema_rules, id: 'XYZ', name: 'John Doe', meta: { groups: [1, 2, 3], birthday: Date.today })
   end
 
+  def test_hash_without_specification
+    schema_rules = {
+      type: :hash
+    }
+
+    assert_schema(schema_rules, user: 'hello')
+    assert_schema(schema_rules, user: :world)
+    assert_schema(schema_rules, user: 123)
+  end
+
+  def test_array_without_specification
+    schema_rules = {
+      type: :array
+    }
+
+    assert_schema(schema_rules, [1, 'hello', :world])
+    assert_schema(schema_rules, [])
+  end
+
+  def test_hash_attributes_without_specification
+    schema_rules = {
+      type: :hash,
+      hash: {
+        user: { type: :hash, null: true }
+      }
+    }
+
+    assert_schema(schema_rules, user: { foo: :bar })
+    assert_schema(schema_rules, user: nil)
+  end
+
+  def test_array_in_hash_without_specification
+    schema_rules = {
+      type: Hash,
+      hash: {
+        types: { type: :array, null: true }
+      }
+    }
+
+    assert_schema(schema_rules, types: ['test', 1, :hello])
+    assert_schema(schema_rules, types: [])
+    assert_schema(schema_rules, types: nil)
+  end
+
+  def test_array_in_hash_with_multiple_types
+    schema_rules = {
+      type: :hash,
+      hash: {
+        types: { type: Array, array: [Integer, String] }
+      }
+    }
+
+    assert_schema(schema_rules, types: ['test', 1])
+    assert_schema(schema_rules, types: [])
+    assert_schema_failure(schema_rules, types: ['test', 1, :hello_world])
+  end
+
   def test_nested_hash_schema
     schema_rules = {
       type: :hash,
@@ -77,13 +137,13 @@ class SchemacopValidatorTest < Minitest::Test
       }
     }
 
-    assert_schema schema_rules, name: 'John Doe'
-    assert_schema schema_rules, name: ''
-    assert_schema schema_rules, name: nil
+    assert_schema(schema_rules, name: 'John Doe')
+    assert_schema(schema_rules, name: '')
+    assert_schema(schema_rules, name: nil)
 
-    assert_schema_failure schema_rules, name: 123
-    assert_schema_failure schema_rules, name: true
-    assert_schema_failure schema_rules, name: []
+    assert_schema_failure(schema_rules, name: 123)
+    assert_schema_failure(schema_rules, name: true)
+    assert_schema_failure(schema_rules, name: [])
   end
 
   def test_array_hash_old_schema
@@ -98,13 +158,13 @@ class SchemacopValidatorTest < Minitest::Test
       }
     }
 
-    assert_schema schema_rules, [{ name: 'John', required: true }, { name: 'Alex', required: false }]
+    assert_schema(schema_rules, [{ name: 'John', required: true }, { name: 'Alex', required: false }])
 
-    assert_schema_failure schema_rules, name: 'John Doe'
-    assert_schema_failure schema_rules, [{ name: 'John Doe' }]
-    assert_schema_failure schema_rules, [{ required: true }]
-    assert_schema_failure schema_rules, [{ name: 0, required: true }]
-    assert_schema_failure schema_rules, [{ name: 'John Doe', required: 'string' }]
+    assert_schema_failure(schema_rules, name: 'John Doe')
+    assert_schema_failure(schema_rules, [{ name: 'John Doe' }])
+    assert_schema_failure(schema_rules, [{ required: true }])
+    assert_schema_failure(schema_rules, [{ name: 0, required: true }])
+    assert_schema_failure(schema_rules, [{ name: 'John Doe', required: 'string' }])
   end
 
   def test_fields_array_old_schema
@@ -120,12 +180,12 @@ class SchemacopValidatorTest < Minitest::Test
       }
     }
 
-    assert_schema schema_rules, ids: []
-    assert_schema schema_rules, ids: [1, 2, 3]
+    assert_schema(schema_rules, ids: [])
+    assert_schema(schema_rules, ids: [1, 2, 3])
 
-    assert_schema_failure schema_rules, ids: [1, '2']
-    assert_schema_failure schema_rules, ids: '3'
-    assert_schema_failure schema_rules, ids: nil
+    assert_schema_failure(schema_rules, ids: [1, '2'])
+    assert_schema_failure(schema_rules, ids: '3')
+    assert_schema_failure(schema_rules, ids: nil)
   end
 
   def test_validate_fields_old_schema
@@ -140,14 +200,14 @@ class SchemacopValidatorTest < Minitest::Test
       }
     }
 
-    assert_schema schema_rules, name: 'John', id: 2, ids: [1, 2, 3], currency: 'CHF'
-    assert_schema schema_rules, name: nil, id: 2, ids: [1, 2, 3], currency: 'CHF'
-    assert_schema schema_rules, name: nil, age: 2, id: 2, ids: nil, currency: 'CHF'
-    assert_schema schema_rules, name: nil, id: 2, ids: nil, currency: 'CHF'
+    assert_schema(schema_rules, name: 'John', id: 2, ids: [1, 2, 3], currency: 'CHF')
+    assert_schema(schema_rules, name: nil, id: 2, ids: [1, 2, 3], currency: 'CHF')
+    assert_schema(schema_rules, name: nil, age: 2, id: 2, ids: nil, currency: 'CHF')
+    assert_schema(schema_rules, name: nil, id: 2, ids: nil, currency: 'CHF')
 
-    assert_schema_failure schema_rules, id: 2, ids: [1, 2, 3], currency: 'CHF'
-    assert_schema_failure schema_rules, name: nil, id: nil, ids: [1, 2, 3], currency: 'CHF'
-    assert_schema_failure schema_rules, name: nil, id: 2, ids: [1, 2, 3], currency: 'JPN'
+    assert_schema_failure(schema_rules, id: 2, ids: [1, 2, 3], currency: 'CHF')
+    assert_schema_failure(schema_rules, name: nil, id: nil, ids: [1, 2, 3], currency: 'CHF')
+    assert_schema_failure(schema_rules, name: nil, id: 2, ids: [1, 2, 3], currency: 'JPN')
   end
 
   def test_nested_old_schema

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schemacop
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Sitrox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-06 00:00:00.000000000 Z
+date: 2016-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -147,6 +147,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md