schemacop 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb096c541a2c7681a8e46331b266f0e6d93e8946
-  data.tar.gz: 2aead692c31d0eea58cc0bcc5f239cb03edcf322
+  metadata.gz: 553c564f36cf2b16bd1bc72f48f75abcaef6d66e
+  data.tar.gz: 9546f609f7e8e58db4012efd82ca4dee1ae21788
 SHA512:
-  metadata.gz: 156d68d30297a571819a9bc9c4e2ca2fe7e10bfcbe01c79d13393de506a4b27e4e6d1faf07021cda33a05ebcf7b8cefb046efcbf325e3fd248ad272271d5ce6a
-  data.tar.gz: 7057102772faed1465753810c013b3a8ea29f0c78d03128af0f6920dce56492de7835571716ba083a4bb48c9edece13ef0f3e364b25575753937855c2209e6b1
+  metadata.gz: c033fe31d11708a6f499869d9736b4b42081c02860270e48776ac86e9181f0522668dd3fa18ab80f31f2621453a3ac32493fab6e2da1502d61d028a58a621f25
+  data.tar.gz: 219c873fbeac36c803011553d34a88d073da8c30b61119cf0647f8fc3347cc736f8ad4306411a23173a79043592c4a697b3f984134cc91a0ac5f7c02b37817f1

data/CHANGELOG.md

@@ -10,6 +10,19 @@
 ### Changes
 -->
 
+## 2.2.0 (2017-05-17)
+
+### Changes
+
+* Handle `ActiveSupport::HashWithIndifferentAccess` objects gracefully when
+  performing the validation. This allows the user to specify the schema using
+  a mixture of symbols and strings, but during the validation of a
+  `HashWithIndifferentAccess` it transparently converts the keys, both in the
+  schema and in the hash, to symbols.
+
+  In the event that a key is defined both in the string and symbol version,
+  Schemacop expects a Ruby hash and will throw a ValidationError otherwise.
+
 ## 2.1.0 (2017-05-16)
 
 ### New features

data/README.md

@@ -226,8 +226,8 @@ option `min` is supported by the `:string` validator (covered later).
 
 ### Field Line
 
-Inside a Type Line of type `:hash` or `Hash`, you may specify an arbitrary
-number of field lines (one for each key-value pair you want to be in the hash).
+Inside a Type Line of type `:hash`, you may specify an arbitrary number of field
+lines (one for each key-value pair you want to be in the hash).
 
 Field Lines start with one of the following six identifiers: `req`, `req?`,
 `req!`, `opt`, `opt?` or `opt!`:
@@ -273,6 +273,36 @@ end
 You might find the notation cumbersome, and you'd be right to say so. Luckily
 there are plenty of short forms available which we will see below.
 
+#### Handling hashes with indifferent access
+
+Schemacop has special handling for objects of the class
+`ActiveSupport::HashWithIndifferentAccess`: You may specify the keys as symbols
+or strings, and Schemacop will handle the conversion necessary for proper
+validation internally. Note that if you define the same key as string and
+symbol, it will throw a `ValidationError` [exception](#exceptions) when asked to
+validate a hash with indifferent access.
+
+Thus, the following two schema definitions are equivalent when validating a hash
+with indifferent access:
+
+```ruby
+Schema.new do
+  type :hash do
+    req :name do
+      type :string
+    end
+  end
+end
+
+Schema.new do
+  type :hash do
+    req 'name' do
+      type :string
+    end
+  end
+end
+```
+
 ## Types
 
 Types are defined via their validators, which is a class under `validator/`.
@@ -317,7 +347,7 @@ The following types are supported by Schemacop by default:
   - TODO no lookahead for different arrays, see
     validator_array_test#test_multiple_arrays
 
-* `:hash` accepts a Ruby Hash.
+* `:hash` accepts a Ruby Hash or an `ActiveSupport::HashWithIndifferentAccess`.
 
   - accepts a block with an arbitrary number of Field Lines.
 

data/Rakefile

@@ -18,11 +18,15 @@ task :gemspec do
     spec.add_development_dependency 'rake'
     spec.add_development_dependency 'ci_reporter', '~> 2.0'
     spec.add_development_dependency 'ci_reporter_minitest'
-    spec.add_development_dependency 'activesupport'
     spec.add_development_dependency 'haml'
     spec.add_development_dependency 'yard'
     spec.add_development_dependency 'rubocop', '0.35.1'
     spec.add_development_dependency 'redcarpet'
+
+    # This lower bound for ActiveSupport is not necessarily true. Schemacop
+    # needs access to ActiveSupport::HashWithIndifferentAccess and expects
+    # behavior of that as in version 5 of ActiveSupport.
+    spec.add_dependency 'activesupport', '>= 4.0', '< 6'
   end
 
   File.open('schemacop.gemspec', 'w') { |f| f.write(gemspec.to_ruby.strip) }

data/VERSION

@@ -1 +1 @@
-2.1.0
+2.2.0

data/doc/Schemacop.html

@@ -109,7 +109,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/ArrayValidator.html

@@ -319,7 +319,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:25 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/BooleanValidator.html

@@ -135,7 +135,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:25 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/Collector.html

@@ -525,7 +525,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/Exceptions.html

@@ -105,7 +105,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/Exceptions/InvalidSchemaError.html

@@ -114,7 +114,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/Exceptions/ValidationError.html

@@ -114,7 +114,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/FieldNode.html

@@ -399,7 +399,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/FloatValidator.html

@@ -148,7 +148,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:25 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/HashValidator.html

@@ -226,7 +226,20 @@
 13
 14
 15
-16</pre>
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/schemacop/validator/hash_validator.rb', line 5</span>
@@ -234,8 +247,21 @@
 <span class='kw'>def</span> <span class='id identifier rubyid_validate'>validate</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='id identifier rubyid_collector'>collector</span><span class='rparen'>)</span>
   <span class='kw'>super</span>
 
-  <span class='id identifier rubyid_allowed_fields'>allowed_fields</span> <span class='op'>=</span> <span class='ivar'>@fields</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span>
-  <span class='id identifier rubyid_obsolete_keys'>obsolete_keys</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span> <span class='op'>-</span> <span class='id identifier rubyid_allowed_fields'>allowed_fields</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>ActiveSupport</span><span class='op'>::</span><span class='const'>HashWithIndifferentAccess</span>
+    <span class='id identifier rubyid_allowed_fields'>allowed_fields</span> <span class='op'>=</span> <span class='ivar'>@fields</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='op'>|</span> <span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='op'>:</span> <span class='id identifier rubyid_k'>k</span> <span class='rbrace'>}</span>
+    <span class='id identifier rubyid_data_keys'>data_keys</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='op'>|</span> <span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='op'>:</span> <span class='id identifier rubyid_k'>k</span> <span class='rbrace'>}</span>
+
+    <span class='comment'># If the same key is specified in the schema as string and symbol, we
+</span>    <span class='comment'># definitely expect a Ruby hash and not one with indifferent access
+</span>    <span class='kw'>if</span> <span class='ivar'>@fields</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>!=</span> <span class='const'>Set</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_allowed_fields'>allowed_fields</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span>
+      <span class='id identifier rubyid_fail'>fail</span> <span class='const'><span class='object_link'><a href="Exceptions.html" title="Schemacop::Exceptions (module)">Exceptions</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Exceptions/ValidationError.html" title="Schemacop::Exceptions::ValidationError (class)">ValidationError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Hash expected, but got ActiveSupport::HashWithIndifferentAccess.</span><span class='tstring_end'>&#39;</span></span>
+    <span class='kw'>end</span>
+  <span class='kw'>else</span>
+    <span class='id identifier rubyid_allowed_fields'>allowed_fields</span> <span class='op'>=</span> <span class='ivar'>@fields</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span>
+    <span class='id identifier rubyid_data_keys'>data_keys</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span>
+  <span class='kw'>end</span>
+
+  <span class='id identifier rubyid_obsolete_keys'>obsolete_keys</span> <span class='op'>=</span> <span class='id identifier rubyid_data_keys'>data_keys</span> <span class='op'>-</span> <span class='id identifier rubyid_allowed_fields'>allowed_fields</span>
 
   <span class='id identifier rubyid_collector'>collector</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Obsolete keys: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_obsolete_keys'>obsolete_keys</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>.</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_obsolete_keys'>obsolete_keys</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span>
 
@@ -253,7 +279,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:25 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/IntegerValidator.html

@@ -148,7 +148,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:25 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/NilValidator.html

@@ -135,7 +135,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/Node.html

@@ -1416,7 +1416,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/NodeResolver.html

@@ -232,7 +232,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/NodeSupportingField.html

@@ -580,7 +580,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/NodeSupportingType.html

@@ -604,7 +604,7 @@ as it formerly was the case in the constructor.</p>
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/NodeWithBlock.html

@@ -279,7 +279,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/NumberValidator.html

@@ -222,7 +222,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:25 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/ObjectValidator.html

@@ -278,7 +278,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:25 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/RootNode.html

@@ -161,7 +161,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/Schema.html

@@ -687,7 +687,7 @@ this exception is thrown.</p>
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/StringValidator.html

@@ -285,7 +285,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:25 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/SymbolValidator.html

@@ -135,7 +135,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:25 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/ScopedEnv.html

@@ -341,7 +341,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/_index.html

@@ -347,7 +347,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/file.README.html

@@ -280,8 +280,8 @@ option <code>min</code> is supported by the <code>:string</code> validator (cove
 
 <h3>Field Line</h3>
 
-<p>Inside a Type Line of type <code>:hash</code> or <code>Hash</code>, you may specify an arbitrary
-number of field lines (one for each key-value pair you want to be in the hash).</p>
+<p>Inside a Type Line of type <code>:hash</code>, you may specify an arbitrary number of field
+lines (one for each key-value pair you want to be in the hash).</p>
 
 <p>Field Lines start with one of the following six identifiers: <code>req</code>, <code>req?</code>,
 <code>req!</code>, <code>opt</code>, <code>opt?</code> or <code>opt!</code>:</p>
@@ -327,6 +327,35 @@ non-nil field of type Integer or Date under the key <code>:age</code>.</p>
 <p>You might find the notation cumbersome, and you&#39;d be right to say so. Luckily
 there are plenty of short forms available which we will see below.</p>
 
+<h4>Handling hashes with indifferent access</h4>
+
+<p>Schemacop has special handling for objects of the class
+<code>ActiveSupport::HashWithIndifferentAccess</code>: You may specify the keys as symbols
+or strings, and Schemacop will handle the conversion necessary for proper
+validation internally. Note that if you define the same key as string and
+symbol, it will throw a <code>ValidationError</code> <a href="#exceptions">exception</a> when asked to
+validate a hash with indifferent access.</p>
+
+<p>Thus, the following two schema definitions are equivalent when validating a hash
+with indifferent access:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='const'>Schema</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_type'>type</span> <span class='symbol'>:hash</span> <span class='kw'>do</span>
+    <span class='id identifier rubyid_req'>req</span> <span class='symbol'>:name</span> <span class='kw'>do</span>
+      <span class='id identifier rubyid_type'>type</span> <span class='symbol'>:string</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+
+<span class='const'>Schema</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_type'>type</span> <span class='symbol'>:hash</span> <span class='kw'>do</span>
+    <span class='id identifier rubyid_req'>req</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>name</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>do</span>
+      <span class='id identifier rubyid_type'>type</span> <span class='symbol'>:string</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+</code></pre>
+
 <h2>Types</h2>
 
 <p>Types are defined via their validators, which is a class under <code>validator/</code>.
@@ -374,7 +403,7 @@ own validation (e.g. through the option <code>check</code>).</li>
 <li>TODO no lookahead for different arrays, see
 validator_array_test#test_multiple_arrays</li>
 </ul></li>
-<li><p><code>:hash</code> accepts a Ruby Hash.</p>
+<li><p><code>:hash</code> accepts a Ruby Hash or an <code>ActiveSupport::HashWithIndifferentAccess</code>.</p>
 
 <ul>
 <li>accepts a block with an arbitrary number of Field Lines.</li>
@@ -590,7 +619,7 @@ to <a href="http://www.subgit.com/">SubGit</a> for their great open source licen
 </div></div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/index.html

@@ -280,8 +280,8 @@ option <code>min</code> is supported by the <code>:string</code> validator (cove
 
 <h3>Field Line</h3>
 
-<p>Inside a Type Line of type <code>:hash</code> or <code>Hash</code>, you may specify an arbitrary
-number of field lines (one for each key-value pair you want to be in the hash).</p>
+<p>Inside a Type Line of type <code>:hash</code>, you may specify an arbitrary number of field
+lines (one for each key-value pair you want to be in the hash).</p>
 
 <p>Field Lines start with one of the following six identifiers: <code>req</code>, <code>req?</code>,
 <code>req!</code>, <code>opt</code>, <code>opt?</code> or <code>opt!</code>:</p>
@@ -327,6 +327,35 @@ non-nil field of type Integer or Date under the key <code>:age</code>.</p>
 <p>You might find the notation cumbersome, and you&#39;d be right to say so. Luckily
 there are plenty of short forms available which we will see below.</p>
 
+<h4>Handling hashes with indifferent access</h4>
+
+<p>Schemacop has special handling for objects of the class
+<code>ActiveSupport::HashWithIndifferentAccess</code>: You may specify the keys as symbols
+or strings, and Schemacop will handle the conversion necessary for proper
+validation internally. Note that if you define the same key as string and
+symbol, it will throw a <code>ValidationError</code> <a href="#exceptions">exception</a> when asked to
+validate a hash with indifferent access.</p>
+
+<p>Thus, the following two schema definitions are equivalent when validating a hash
+with indifferent access:</p>
+
+<pre class="code ruby"><code class="ruby"><span class='const'>Schema</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_type'>type</span> <span class='symbol'>:hash</span> <span class='kw'>do</span>
+    <span class='id identifier rubyid_req'>req</span> <span class='symbol'>:name</span> <span class='kw'>do</span>
+      <span class='id identifier rubyid_type'>type</span> <span class='symbol'>:string</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+
+<span class='const'>Schema</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span>
+  <span class='id identifier rubyid_type'>type</span> <span class='symbol'>:hash</span> <span class='kw'>do</span>
+    <span class='id identifier rubyid_req'>req</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>name</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>do</span>
+      <span class='id identifier rubyid_type'>type</span> <span class='symbol'>:string</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+</code></pre>
+
 <h2>Types</h2>
 
 <p>Types are defined via their validators, which is a class under <code>validator/</code>.
@@ -374,7 +403,7 @@ own validation (e.g. through the option <code>check</code>).</li>
 <li>TODO no lookahead for different arrays, see
 validator_array_test#test_multiple_arrays</li>
 </ul></li>
-<li><p><code>:hash</code> accepts a Ruby Hash.</p>
+<li><p><code>:hash</code> accepts a Ruby Hash or an <code>ActiveSupport::HashWithIndifferentAccess</code>.</p>
 
 <ul>
 <li>accepts a block with an arbitrary number of Field Lines.</li>
@@ -590,7 +619,7 @@ to <a href="http://www.subgit.com/">SubGit</a> for their great open source licen
 </div></div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/top-level-namespace.html

@@ -102,7 +102,7 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Wed May 17 10:53:58 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/lib/schemacop.rb

@@ -3,6 +3,7 @@ end
 
 require 'set'
 require 'active_support/core_ext/class/attribute'
+require 'active_support/hash_with_indifferent_access'
 
 require 'schemacop/scoped_env'
 require 'schemacop/exceptions'

data/lib/schemacop/validator/hash_validator.rb

@@ -5,8 +5,21 @@ module Schemacop
     def validate(data, collector)
       super
 
-      allowed_fields = @fields.keys
-      obsolete_keys = data.keys - allowed_fields
+      if data.is_a? ActiveSupport::HashWithIndifferentAccess
+        allowed_fields = @fields.keys.map { |k| k.is_a?(String) ? k.to_sym : k }
+        data_keys = data.keys.map { |k| k.is_a?(String) ? k.to_sym : k }
+
+        # If the same key is specified in the schema as string and symbol, we
+        # definitely expect a Ruby hash and not one with indifferent access
+        if @fields.keys.length != Set.new(allowed_fields).length
+          fail Exceptions::ValidationError, 'Hash expected, but got ActiveSupport::HashWithIndifferentAccess.'
+        end
+      else
+        allowed_fields = @fields.keys
+        data_keys = data.keys
+      end
+
+      obsolete_keys = data_keys - allowed_fields
 
       collector.error "Obsolete keys: #{obsolete_keys.inspect}." if obsolete_keys.any?
 

data/schemacop.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: schemacop 2.1.0 ruby lib
+# stub: schemacop 2.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "schemacop".freeze
-  s.version = "2.1.0"
+  s.version = "2.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Sitrox".freeze]
-  s.date = "2017-05-16"
+  s.date = "2017-05-17"
   s.files = [".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, ".travis.yml".freeze, ".yardopts".freeze, "CHANGELOG.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "RUBY_VERSION".freeze, "Rakefile".freeze, "VERSION".freeze, "doc/Schemacop.html".freeze, "doc/Schemacop/ArrayValidator.html".freeze, "doc/Schemacop/BooleanValidator.html".freeze, "doc/Schemacop/Collector.html".freeze, "doc/Schemacop/Exceptions.html".freeze, "doc/Schemacop/Exceptions/InvalidSchemaError.html".freeze, "doc/Schemacop/Exceptions/ValidationError.html".freeze, "doc/Schemacop/FieldNode.html".freeze, "doc/Schemacop/FloatValidator.html".freeze, "doc/Schemacop/HashValidator.html".freeze, "doc/Schemacop/IntegerValidator.html".freeze, "doc/Schemacop/NilValidator.html".freeze, "doc/Schemacop/Node.html".freeze, "doc/Schemacop/NodeResolver.html".freeze, "doc/Schemacop/NodeSupportingField.html".freeze, "doc/Schemacop/NodeSupportingType.html".freeze, "doc/Schemacop/NodeWithBlock.html".freeze, "doc/Schemacop/NumberValidator.html".freeze, "doc/Schemacop/ObjectValidator.html".freeze, "doc/Schemacop/RootNode.html".freeze, "doc/Schemacop/Schema.html".freeze, "doc/Schemacop/StringValidator.html".freeze, "doc/Schemacop/SymbolValidator.html".freeze, "doc/ScopedEnv.html".freeze, "doc/_index.html".freeze, "doc/class_list.html".freeze, "doc/css/common.css".freeze, "doc/css/full_list.css".freeze, "doc/css/style.css".freeze, "doc/file.README.html".freeze, "doc/file_list.html".freeze, "doc/frames.html".freeze, "doc/index.html".freeze, "doc/inheritance.graphml".freeze, "doc/inheritance.pdf".freeze, "doc/js/app.js".freeze, "doc/js/full_list.js".freeze, "doc/js/jquery.js".freeze, "doc/method_list.html".freeze, "doc/top-level-namespace.html".freeze, "lib/schemacop.rb".freeze, "lib/schemacop/collector.rb".freeze, "lib/schemacop/exceptions.rb".freeze, "lib/schemacop/field_node.rb".freeze, "lib/schemacop/node.rb".freeze, "lib/schemacop/node_resolver.rb".freeze, "lib/schemacop/node_supporting_field.rb".freeze, "lib/schemacop/node_supporting_type.rb".freeze, "lib/schemacop/node_with_block.rb".freeze, "lib/schemacop/root_node.rb".freeze, "lib/schemacop/schema.rb".freeze, "lib/schemacop/scoped_env.rb".freeze, "lib/schemacop/validator/array_validator.rb".freeze, "lib/schemacop/validator/boolean_validator.rb".freeze, "lib/schemacop/validator/float_validator.rb".freeze, "lib/schemacop/validator/hash_validator.rb".freeze, "lib/schemacop/validator/integer_validator.rb".freeze, "lib/schemacop/validator/nil_validator.rb".freeze, "lib/schemacop/validator/number_validator.rb".freeze, "lib/schemacop/validator/object_validator.rb".freeze, "lib/schemacop/validator/string_validator.rb".freeze, "lib/schemacop/validator/symbol_validator.rb".freeze, "schemacop.gemspec".freeze, "test/custom_check_test.rb".freeze, "test/custom_if_test.rb".freeze, "test/nil_dis_allow_test.rb".freeze, "test/short_forms_test.rb".freeze, "test/test_helper.rb".freeze, "test/types_test.rb".freeze, "test/validator_array_test.rb".freeze, "test/validator_boolean_test.rb".freeze, "test/validator_float_test.rb".freeze, "test/validator_hash_test.rb".freeze, "test/validator_integer_test.rb".freeze, "test/validator_nil_test.rb".freeze, "test/validator_number_test.rb".freeze, "test/validator_object_test.rb".freeze, "test/validator_string_test.rb".freeze, "test/validator_symbol_test.rb".freeze]
   s.homepage = "https://github.com/sitrox/schemacop".freeze
   s.licenses = ["MIT".freeze]
@@ -24,31 +24,31 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rake>.freeze, [">= 0"])
       s.add_development_dependency(%q<ci_reporter>.freeze, ["~> 2.0"])
       s.add_development_dependency(%q<ci_reporter_minitest>.freeze, [">= 0"])
-      s.add_development_dependency(%q<activesupport>.freeze, [">= 0"])
       s.add_development_dependency(%q<haml>.freeze, [">= 0"])
       s.add_development_dependency(%q<yard>.freeze, [">= 0"])
       s.add_development_dependency(%q<rubocop>.freeze, ["= 0.35.1"])
       s.add_development_dependency(%q<redcarpet>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>.freeze, ["< 6", ">= 4.0"])
     else
       s.add_dependency(%q<bundler>.freeze, ["~> 1.3"])
       s.add_dependency(%q<rake>.freeze, [">= 0"])
       s.add_dependency(%q<ci_reporter>.freeze, ["~> 2.0"])
       s.add_dependency(%q<ci_reporter_minitest>.freeze, [">= 0"])
-      s.add_dependency(%q<activesupport>.freeze, [">= 0"])
       s.add_dependency(%q<haml>.freeze, [">= 0"])
       s.add_dependency(%q<yard>.freeze, [">= 0"])
       s.add_dependency(%q<rubocop>.freeze, ["= 0.35.1"])
       s.add_dependency(%q<redcarpet>.freeze, [">= 0"])
+      s.add_dependency(%q<activesupport>.freeze, ["< 6", ">= 4.0"])
     end
   else
     s.add_dependency(%q<bundler>.freeze, ["~> 1.3"])
     s.add_dependency(%q<rake>.freeze, [">= 0"])
     s.add_dependency(%q<ci_reporter>.freeze, ["~> 2.0"])
     s.add_dependency(%q<ci_reporter_minitest>.freeze, [">= 0"])
-    s.add_dependency(%q<activesupport>.freeze, [">= 0"])
     s.add_dependency(%q<haml>.freeze, [">= 0"])
     s.add_dependency(%q<yard>.freeze, [">= 0"])
     s.add_dependency(%q<rubocop>.freeze, ["= 0.35.1"])
     s.add_dependency(%q<redcarpet>.freeze, [">= 0"])
+    s.add_dependency(%q<activesupport>.freeze, ["< 6", ">= 4.0"])
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schemacop
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Sitrox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-16 00:00:00.000000000 Z
+date: 2017-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +122,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: 
 email: 
 executables: []