rschema 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 662ddf40b94f44cf6f4bc714fe44346621974aa8
+  data.tar.gz: 03728273b1dec3e5cf5ed7be62bd5e59a6d1a299
+SHA512:
+  metadata.gz: dec3b9214d875a3f0f1673fd4f230e007c3f330750d10fd436c51a912385212edd909eb102e125722090350ff8cc1bba695e28bd6bb040e8cbae8fa2f71c77e3
+  data.tar.gz: 5d422ebd5d992205ce437b20233a8575b5cc0f2e8a69d0ab23f74b55ca7292316c1ddfb0ba709f8d1b6a43e259067c9dd045f3c1d2b1106baf9001dccd221724

data/LICENSE.txt

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,267 @@
+# RSchema
+
+Schema-based validation and coercion for Ruby data structures. Heavily inspired
+by (read: stolen from) [Prismatic/schema][] for Clojure.
+
+Meet RSchema
+------------
+
+A "schema" is a data structure that describes the _shape_ of data.
+Schemas are generally just plain old hashes, arrays, and classes.
+
+```ruby
+post_schema = {
+  title: String,
+  tags: [Symbol],
+  body: String
+}
+```
+
+Schemas can be used to validate data. That is, they can check whether
+data is in the correct shape:
+
+```ruby
+RSchema.validate!(post_schema, {
+  title: "You won't beleive how this developer foo'd her bar",
+  tags: [:foos, :bars, :unbeleivable],
+  body: '<p>blah blah</p>'
+}) # ok
+```
+
+What is a schema?
+-----------------
+
+Schemas are Ruby data structures. The simplest type of schema is just a class:
+
+```ruby
+schema = Integer
+RSchema.validate!(schema, 5)       # ok
+RSchema.validate!(schema, 'hello') # !!! raises RSchema::ValidationError !!!
+```
+
+Then there are composite schemas, which are schemas composed of subschemas.
+Arrays are composite schemas:
+
+```ruby
+schema = [Integer]
+RSchema.validate!(schema, [10, 11, 12])   # ok
+RSchema.validate!(schema, [10, 11, '12']) # !!! raises RSchema::ValidationError !!!
+```
+
+And so are hashes:
+
+```ruby
+schema = { fname: String, age: Integer }
+RSchema.validate!(schema, { fname: 'Jane', age: 27 }) # ok
+RSchema.validate!(schema, { fname: 'Johnny' })        # !!! raises RSchema::ValidationError !!!
+```
+
+While schemas are just plain old Ruby data structures, RSchema also provides
+an extensible DSL for constructing more complicated schemas:
+
+```ruby
+schema = RSchema.schema {{
+  fname: predicate { |n| n.is_a?(String) && n.size > 0 },
+  favourite_foods: set_of(Symbol),
+  children_by_age: hash_of(Integer => String)
+}}
+
+RSchema.validate!(schema, {
+  fname: 'Johnny',
+  favourite_foods: Set.new([:bacon, :cheese, :onion]),
+  children_by_age: {
+    7 => 'Jenny',
+    5 => 'Simon'
+  }
+}) # ok
+```
+
+Array Schemas
+-------------
+
+There are two types of array schemas. When the array schema has a single
+element, it is a variable-length array schema:
+
+```ruby
+schema = [Symbol]
+RSchema.validate!(schema, [:a, :b, :c]) # ok
+RSchema.validate!(schema, [:a])         # ok
+RSchema.validate!(schema, [])           # ok
+```
+
+Otherwise, it is a fixed-length array schema
+
+```ruby
+schema = [Integer, String]
+RSchema.validate!(schema, [10, 'hello'])          # ok
+RSchema.validate!(schema, [10, 'hello', 'world']) # !!! raises RSchema::ValidationError !!!
+RSchema.validate!(schema, [10])                   # !!! raises RSchema::ValidationError !!!
+```
+
+Hash Schemas
+------------
+
+Hash schemas map constant keys to subschema values:
+
+```ruby
+schema = { fname: String }
+RSchema.validate!(schema, { fname: 'William' }) # ok
+```
+
+Keys can be optional:
+
+```ruby
+schema = RSchema.schema {{
+  :fname => String,
+  _?(:age) => Integer
+}}
+RSchema.validate!(schema, { fname: 'Lucy', age: 21 }) # ok
+RSchema.validate!(schema, { fname: 'Tom' })           # ok
+```
+
+There is also another type of hash schema that represents hashes with variable
+keys:
+
+```ruby
+schema = RSchema.schema { hash_of(String => Integer) }
+RSchema.validate!(schema, { 'hello' => 1, 'world' => 2 }) # ok
+RSchema.validate!(schema, { 'hello' => 1 })               # ok
+RSchema.validate!(schema, {})                             # ok
+```
+
+Other Schema Types
+------------------
+
+RSchema provides a few other schema types through its DSL:
+
+```ruby
+# predicate
+predicate_schema = RSchema.schema do
+  predicate('even') { |x| x.even? }
+end
+RSchema.validate!(predicate_schema, 4) # ok
+RSchema.validate!(predicate_schema, 5) # !!! raises RSchema::ValidationError !!!
+
+# maybe
+maybe_schema = RSchema.schema do
+  maybe(Integer)
+end
+RSchema.validate!(maybe_schema, 5)   # ok
+RSchema.validate!(maybe_schema, nil) # ok
+
+# enum
+enum_schema = RSchema.schema do
+  enum([:a, :b, :c])
+end
+RSchema.validate!(enum_schema, :a) # ok
+RSchema.validate!(enum_schema, :z) # !!! raises RSchema::ValidationError !!!
+```
+
+Coercion
+--------
+
+RSchema is capable of coercing invalid values into valid ones, in some
+situations. Here are some examples:
+
+```ruby
+RSchema.coerce!(Symbol, "hello") #=> :hello
+RSchema.coerce!(String, :hello)  #=> "hello"
+RSchema.coerce!(Integer, "5")    #=> 5
+RSchema.coerce!(Integer, "cat")  # !!! raises RSchema::ValidationError !!!
+RSchema.coerce!(Set, [1, 2, 3])  #=> <Set: {1, 2, 3}>
+
+schema = RSchema.schema {{
+  fname: String,
+  favourite_foods: set_of(Symbol)
+}}
+
+value = {
+  fname: 'Peggy',
+  favourite_foods: ['berries', 'cake']
+}
+
+RSchema.coerce!(schema, value)
+  #=> { fname: "Peggy", favourite_foods: <Set: #{:berries, :cake}> }
+```
+
+Extending the DSL
+-----------------
+
+The RSchema DSL can be extended by adding methods to the `RSchema::DSL` module:
+
+```ruby
+module RSchema::DSL
+  def self.positive_and_even(type)
+    predicate { |x| x > 0 && x.even? }
+  end
+end
+
+schema = RSchema.schema { positive_and_even }
+RSchema.validate!(schema, 6)  # ok
+RSchema.validate!(schema, -6) # !!! raises RSchema::ValidationError !!!
+```
+
+Custom Schema Types
+-------------------
+
+Any Ruby object can be a schema, as long as it implements the `schema_walk`
+method.  Here is a schema called `Coordinate`, which is an x/y pair of `Float`s
+in an array:
+
+```ruby
+# make the schema type class
+class CoordinateSchema
+  def schema_walk(value, mapper)
+    # validate `value`
+    return RSchema::ErrorDetails.new('is not an Array') unless value.is_a?(Array)
+    return RSchema::ErrorDetails.new('does not have two elements') unless value.size == 2
+
+    # walk the subschemas/subvalues
+    x, x_error = RSchema.walk(Float, value[0], mapper)
+    y, y_error = RSchema.walk(Float, value[1], mapper)
+
+    # look for subschema errors, and propagate them if found
+    return RSchema::ErrorDetails.new({ x: x_error.details }) if x_error
+    return RSchema::ErrorDetails.new({ y: y_error.details }) if y_error
+
+    # return the valid value
+    [x, y]
+  end
+end
+
+# add some DSL
+module RSchema::DSL
+  def self.coordinate
+    CoordinateSchema.new
+  end
+end
+
+# use the custom schema type (coercion works too)
+schema = RSchema.schema { coordinate }
+RSchema.validate!(schema, [1.0, 2.0]) # ok
+RSchema.validate!(schema, [1, 2])     # !!! raises RSchema::ValidationError !!!
+RSchema.coerce!(schema, ["1", "2"])   #=> [1.0, 2.0]
+```
+
+The `schema_walk` method receives two arguments:
+
+ - `value`: the value that is being validated against this schema
+ - `mapper`: not usually used by the schema, but must be passed to
+   `RSchema.walk`.
+
+The `schema_walk` method has three responsibilities:
+
+ 1. It must validate the given value. If the value is invalid, the method must
+    return an `RSchema::ErrorDetails` object. If the value is valid, it must
+    return the valid value after walking all subvalues.
+
+ 2. For composite schemas, it must walk subvalues by calling `RSchema.walk`.
+    The example above walks two subvalues (`value[0]` and `value[1]`) with the
+    `Float` schema.
+
+ 3. It must propagate any `RSchema::ErrorDetails` objects returned from walking
+    the subvalues. Walking subvalues with `RSchema.walk` may return an error,
+    in which case the `rschema_walk` method must also return an error.
+
+[Prismatic/schema]: https://github.com/Prismatic/schema
+

data/lib/rschema.rb

@@ -0,0 +1,278 @@
+require 'set'
+
+module RSchema
+  InvalidSchemaError = Class.new(StandardError)
+  ValidationError = Class.new(StandardError)
+  OptionalHashKey = Struct.new(:key)
+  ErrorDetails = Struct.new(:details) do
+    def to_s; inspect; end
+    def inspect; details.inspect; end
+  end
+
+  def self.schema(&block)
+    DSL.instance_exec(&block)
+  end
+
+  def self.validation_errors(schema, value)
+    _, error = walk(schema, value)
+    error
+  end
+
+  def self.validate!(schema, value)
+    result, error = walk(schema, value)
+    if error.nil?
+      result
+    else
+      raise(ValidationError, error)
+    end
+  end
+
+  def self.coerce(schema, value)
+    walk(schema, value, CoercionMapper)
+  end
+
+  def self.coerce!(schema, value)
+    result, error = walk(schema, value, CoercionMapper)
+    if error.nil?
+      result
+    else
+      raise(ValidationError, error)
+    end
+  end
+
+  def self.walk(schema, value, mapper = nil)
+    raise(InvalidSchemaError, schema) unless schema.respond_to?(:schema_walk)
+    value = mapper.prewalk(schema, value) if mapper
+    value = schema.schema_walk(value, mapper)
+    value = mapper.postwalk(schema, value) if mapper
+
+    if value.is_a?(RSchema::ErrorDetails)
+      [nil, value]
+    else
+      [value, nil]
+    end
+  end
+
+  module DSL
+    def self._?(key)
+      OptionalHashKey.new(key)
+    end
+
+    def self.hash_of(subschemas_hash)
+      raise InvalidSchemaError unless subschemas_hash.size == 1
+      GenericHashSchema.new(subschemas_hash.keys.first, subschemas_hash.values.first)
+    end
+
+    def self.set_of(subschema)
+      GenericSetSchema.new(subschema)
+    end
+
+    def self.predicate(name = nil, &block)
+      raise InvalidSchemaError unless block
+      PredicateSchema.new(name, block)
+    end
+
+    def self.maybe(subschema)
+      raise InvalidSchemaError unless subschema
+      MaybeSchema.new(subschema)
+    end
+
+    def self.enum(possible_values, subschema = nil)
+      raise InvalidSchemaError unless possible_values && possible_values.size > 0
+      EnumSchema.new(Set.new(possible_values), subschema)
+    end
+  end
+
+  module CoercionMapper
+    def self.prewalk(schema, value)
+      if schema == Integer && value.is_a?(String)
+        try_convert(value) { Integer(value) }
+      elsif schema == Float && value.is_a?(String)
+        try_convert(value) { Float(value) }
+      elsif schema == Float && value.is_a?(Integer)
+        value.to_f
+      elsif schema == Symbol && value.is_a?(String)
+        value.to_sym
+      elsif schema == String && value.is_a?(Symbol)
+        value.to_s
+      elsif schema == Array && value.is_a?(Set)
+        value.to_a
+      elsif (schema == Set || schema.is_a?(GenericSetSchema)) && value.is_a?(Array)
+        Set.new(value)
+      elsif(schema.is_a?(Hash) && value.is_a?(Hash))
+        coerce_hash(schema, value)
+      else
+        value
+      end
+    end
+
+    def self.postwalk(schema, value)
+      value
+    end
+
+    def self.try_convert(x)
+      yield x
+    rescue
+      x
+    end
+
+    def self.coerce_hash(schema, value)
+      symbol_keys = Set.new(schema.keys.select{ |k| k.is_a?(Symbol) }.map(&:to_s))
+      value.reduce({}) do |accum, (k, v)|
+        # convert string keys to symbol keys, if needed
+        if k.is_a?(String) && symbol_keys.include?(k)
+          k = k.to_sym
+        end
+
+        # strip out keys that don't exist in the schema
+        if schema.has_key?(k)
+          accum[k] = v
+        end
+
+        accum
+      end
+    end
+  end
+
+  GenericHashSchema = Struct.new(:key_subschema, :value_subschema) do
+    def schema_walk(value, mapper)
+      if not value.is_a?(Hash)
+        return RSchema::ErrorDetails.new('is not a Hash')
+      end
+
+      value.reduce({}) do |accum, (k, v)|
+        # walk key
+        k_walked, error = RSchema.walk(key_subschema, k, mapper)
+        break RSchema::ErrorDetails.new({'has invalid key, where' => error.details}) if error
+
+        # walk value
+        v_walked, error = RSchema.walk(value_subschema, v, mapper)
+        break RSchema::ErrorDetails.new({k => error.details}) if error
+
+        accum[k_walked] = v_walked
+        accum
+      end
+    end
+  end
+
+  GenericSetSchema = Struct.new(:subschema) do
+    def schema_walk(value, mapper)
+      return RSchema::ErrorDetails.new('is not a Set') if not value.is_a?(Set)
+
+      value.reduce(Set.new) do |accum, subvalue|
+        subvalue_walked, error = RSchema.walk(subschema, subvalue, mapper)
+        break RSchema::ErrorDetails.new(Set.new([error.details])) if error
+
+        accum << subvalue_walked
+        accum
+      end
+    end
+  end
+
+  PredicateSchema = Struct.new(:name, :block) do
+    def schema_walk(value, mapper)
+      if block.call(value)
+        value
+      else
+        RSchema::ErrorDetails.new('fails predicate' + (name ? ": #{name}" : ''))
+      end
+    end
+  end
+
+  MaybeSchema = Struct.new(:subschema) do
+    def schema_walk(value, mapper)
+      if value.nil?
+        value
+      else
+        subvalue_walked, error = RSchema.walk(subschema, value, mapper)
+        error || subvalue_walked
+      end
+    end
+  end
+
+  EnumSchema = Struct.new(:value_set, :subschema) do
+    def schema_walk(value, mapper)
+      value_walked = if subschema
+        v, error = RSchema.walk(subschema, value, mapper)
+        return error if error
+        v
+      else
+        value
+      end
+
+      if value_set.include?(value_walked)
+        value_walked
+      else
+        RSchema::ErrorDetails.new("#{value_walked} is not a valid enum member")
+      end
+    end
+  end
+end
+
+class Class
+  def schema_walk(value, mapper)
+    if value.is_a?(self)
+      value
+    else
+      RSchema::ErrorDetails.new("is not a #{self}")
+    end
+  end
+end
+
+class Array
+  def schema_walk(value, mapper)
+    fixed_size = (size != 1)
+
+    if not value.is_a?(Array)
+      RSchema::ErrorDetails.new("is not an Array")
+    elsif fixed_size && value.size != size
+      RSchema::ErrorDetails.new("does not have #{size} elements")
+    else
+      value.each.with_index.map do |subvalue, idx|
+        subschema = (fixed_size ? self[idx] : first)
+        subvalue_walked, error = RSchema.walk(subschema, subvalue, mapper)
+        break RSchema::ErrorDetails.new({ idx => error.details }) if error
+        subvalue_walked
+      end
+    end
+  end
+end
+
+class Hash
+  def schema_walk(value, mapper)
+    return RSchema::ErrorDetails.new('is not a Hash') if not value.is_a?(Hash)
+
+    # extract details from the schema
+    required_keys = Set.new
+    all_subschemas = {}
+    each do |(k, subschema)|
+      if k.is_a?(RSchema::OptionalHashKey)
+        all_subschemas[k.key] = subschema
+      else
+        required_keys << k
+        all_subschemas[k] = subschema
+      end
+    end
+
+    # check for extra keys that shouldn't be there
+    extraneous = value.keys.reject{ |k| all_subschemas.has_key?(k) }
+    if extraneous.size > 0
+      return RSchema::ErrorDetails.new({"has extraneous keys" => extraneous})
+    end
+
+    # check for required keys that are missing
+    missing_requireds = required_keys.reject{ |k| value.has_key?(k) }
+    if missing_requireds.size > 0
+      return RSchema::ErrorDetails.new({"is missing required keys" => missing_requireds})
+    end
+
+    # walk the subvalues
+    value.reduce({}) do |accum, (k, subvalue)|
+      subvalue_walked, error = RSchema.walk(all_subschemas[k], subvalue, mapper)
+      break RSchema::ErrorDetails.new({ k => error.details }) if error
+      accum[k] = subvalue_walked
+      accum
+    end
+  end
+end
+

data/lib/rschema/rails_interop.rb

@@ -0,0 +1,19 @@
+module RSchema
+  module RailsInterop
+    ParamSchemaValidationError = Class.new(StandardError)
+
+    module ControllerMethods
+      def params_for_schema!(schema_arg = nil, &block)
+        schema = schema_arg || RSchema.schema(&block)
+        value = self.params
+        coerced, error = RSchema.coerce(schema, value)
+        if error
+          raise ParamSchemaValidationError.new(schema: schema, params: value, error: e)    
+        else
+          coerced
+        end
+      end
+    end
+
+  end
+end

data/lib/rschema/version.rb

@@ -0,0 +1,3 @@
+module RSchema
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rschema
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Dalling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |2
+      Schema-based validation and coercion for Ruby data structures. Heavily inspired
+      by (read: stolen from) [Prismatic/schema][] for Clojure.
+email:
+- tom@tomdalling.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/rschema.rb
+- lib/rschema/rails_interop.rb
+- lib/rschema/version.rb
+homepage: http://www.tomdalling.com/rschema
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: Schema-based validation and coercion for Ruby data structures
+test_files: []