rschema 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 795f0dd37dcc401fea7ff046c45d0ff3d80c033f
-  data.tar.gz: 714901909ddda803bbe48b334985792e5e7e1498
+  metadata.gz: 9a5600f4f1f9cbe2d7743bd360a7005fa6b01da7
+  data.tar.gz: af415074e5917d934775f1d1c96b9afea39539f4
 SHA512:
-  metadata.gz: c1c2cb7fd88e82014f772610481550d9bd97c9134edd3899d0798ec4d67bbcf5eaa9f474b4114d20a9ca22d620b1d7a69b3743e6e10a6310267134eb093b42d7
-  data.tar.gz: 1c1987c9651e704228723d0c2765e9655589f94d180c64afc3cf4923383adf05be6c2e1beb246fab15dc650c544d75dc062e7e52c7308b7c44a978021c011983
+  metadata.gz: 6683829451d8153d46d7e66aac10939a27191ba47664103b8f33d35f937298755325d389857c1df065d0a0b3f7658825ef33a02d2a1d4da096d42f9df4ec62c6
+  data.tar.gz: 164aaf435884ae2fdbd6ffc84c779dbb922a328527b1e392316934bde24cfedfed272cf35d3505d2241bf3d4256da6261ae2444bc96d75dc00847b9b12715708

data/lib/rschema.rb

@@ -4,16 +4,27 @@ 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
+  ErrorDetails = Struct.new(:failing_value, :reason, :key_path) do
+    def initialize(failing_value, reason, key_path = [])
+      super(failing_value, reason, key_path)
+    end
+
+    def to_s
+      prefix = (key_path.empty? ?  'The root value' : "The value at #{key_path.inspect}")
+      "#{prefix} #{reason}: #{failing_value.inspect}"
+    end
+
+    def extend_key_path(key)
+      key_path.unshift(key)
+      self
+    end
   end
 
   def self.schema(&block)
     DSL.instance_exec(&block)
   end
 
-  def self.validation_errors(schema, value)
+  def self.validation_error(schema, value)
     _, error = walk(schema, value)
     error
   end
@@ -27,6 +38,10 @@ module RSchema
     end
   end
 
+  def self.validate(schema, value)
+    validation_error(schema, value).nil?
+  end
+
   def self.coerce(schema, value)
     walk(schema, value, CoercionMapper)
   end
@@ -141,17 +156,17 @@ module RSchema
   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')
+        return RSchema::ErrorDetails.new(value, '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
+        break error.extend_key_path('.keys') if error
 
         # walk value
         v_walked, error = RSchema.walk(value_subschema, v, mapper)
-        break RSchema::ErrorDetails.new({k => error.details}) if error
+        break error.extend_key_path(k) if error
 
         accum[k_walked] = v_walked
         accum
@@ -161,11 +176,11 @@ module RSchema
 
   GenericSetSchema = Struct.new(:subschema) do
     def schema_walk(value, mapper)
-      return RSchema::ErrorDetails.new('is not a Set') if not value.is_a?(Set)
+      return RSchema::ErrorDetails.new(value, '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 + ": " + subvalue.to_s])) if error
+        break error.extend_key_path('.values') if error
 
         accum << subvalue_walked
         accum
@@ -178,7 +193,7 @@ module RSchema
       if block.call(value)
         value
       else
-        RSchema::ErrorDetails.new('fails predicate' + (name ? ": #{name}" : ''))
+        RSchema::ErrorDetails.new(value, 'fails predicate' + (name ? ": #{name}" : ''))
       end
     end
   end
@@ -207,7 +222,7 @@ module RSchema
       if value_set.include?(value_walked)
         value_walked
       else
-        RSchema::ErrorDetails.new("#{value_walked} is not a valid enum member")
+        RSchema::ErrorDetails.new(value_walked, "#{value_walked} is not a valid enum member")
       end
     end
   end
@@ -217,7 +232,7 @@ module RSchema
       if value.is_a?(TrueClass) || value.is_a?(FalseClass)
         value
       else
-        RSchema::ErrorDetails.new('is not a boolean')
+        RSchema::ErrorDetails.new(value, 'is not a boolean')
       end
     end
   end
@@ -228,7 +243,7 @@ class Class
     if value.is_a?(self)
       value
     else
-      RSchema::ErrorDetails.new("is not a #{self.name}, is a #{value.class.name}")
+      RSchema::ErrorDetails.new(value, "is not a #{self.name}, is a #{value.class.name}")
     end
   end
 end
@@ -238,14 +253,14 @@ class Array
     fixed_size = (size != 1)
 
     if not value.is_a?(Array)
-      RSchema::ErrorDetails.new("is not an Array")
+      RSchema::ErrorDetails.new(value, 'is not an Array')
     elsif fixed_size && value.size != size
-      RSchema::ErrorDetails.new("does not have #{size} elements")
+      RSchema::ErrorDetails.new(value, "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
+        break error.extend_key_path(idx) if error
         subvalue_walked
       end
     end
@@ -254,7 +269,7 @@ end
 
 class Hash
   def schema_walk(value, mapper)
-    return RSchema::ErrorDetails.new('is not a Hash') if not value.is_a?(Hash)
+    return RSchema::ErrorDetails.new(value, 'is not a Hash') if not value.is_a?(Hash)
 
     # extract details from the schema
     required_keys = Set.new
@@ -271,19 +286,19 @@ class Hash
     # 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})
+      return RSchema::ErrorDetails.new(value, "has extraneous keys: #{extraneous.inspect}")
     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})
+      return RSchema::ErrorDetails.new(value, "is missing required keys: #{missing_requireds.inspect}")
     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
+      break error.extend_key_path(k) if error
       accum[k] = subvalue_walked
       accum
     end

data/lib/rschema/version.rb

@@ -1,3 +1,3 @@
 module RSchema
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rschema
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tom Dalling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2015-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -54,7 +68,7 @@ dependencies:
         version: '0'
 description: |2
       Schema-based validation and coercion for Ruby data structures. Heavily inspired
-      by (read: stolen from) [Prismatic/schema][] for Clojure.
+      by (read: stolen from) Prismatic/schema for Clojure.
 email:
 - tom@tomdalling.com
 executables: []