hashema 0.0.0

data/License.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Ben Christel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# hashema
+
+Hashema lets you validate JSONable objects (hashes and arrays) against a schema, and assert their validity in your RSpec examples.
+
+## Validating an object against a schema
+
+The API of `Hashema::Validator` consists of an initializer and two instance methods: `valid?` and `failure_message`. The initializer takes an object to validate and a schema, in that order. `valid?` will return `true` iff the object conforms to the schema. If `valid?` is `false`, `failure_message` will return a description of the failure.
+
+```ruby
+validator = Hashema::Validator.new(
+  # the object to validate
+  { blog:
+    { url: 'http://www.blagoblag.com',
+      posts: [
+        { title: 'hello',
+          permalink: '/hello',
+          comment_count: 1
+        },
+        { title: 'test',
+          permalink: '/test',
+          comment_count: 0
+        }
+      ]
+    }
+  },
+
+  # the schema
+  { blog:
+    { url: /^https?:\/\//,
+      posts: [
+        { title: String,
+          permalink: /^\/[a-zA-Z0-9_\-\+\/]+$/,
+          comment_count: Numeric
+        }
+      ]
+    }
+  }
+)
+
+validator.valid? # true
+```
+
+## RSpec matcher usage
+
+```ruby
+expect(datum).to conform_to_schema schema
+```

data/lib/hashema.rb

@@ -0,0 +1,7 @@
+require 'hashema/validator'
+
+begin
+  require 'rspec'
+  require 'hashema/conform_to_schema'
+rescue LoadError => e
+end

data/lib/hashema/conform_to_schema.rb

@@ -0,0 +1,14 @@
+RSpec::Matchers.define :conform_to_schema do |schema|
+  match do |actual|
+    @validator = Hashema::Validator.new(actual, schema)
+    @validator.valid?
+  end
+
+  def failure_message
+    @validator.failure_message
+  end
+
+  def failure_message_when_negated
+    "expected\n#{actual.inspect}\nnot to match schema\n#{schema.inspect}"
+  end
+end

data/lib/hashema/validator.rb

@@ -0,0 +1,73 @@
+module Hashema
+  class Validator
+    def initialize(actual, schema)
+      @actual = actual
+      @schema = schema
+      match! @actual, @schema
+    end
+
+    def valid?
+      !!@match
+    end
+
+    def failure_message
+      @mismatch
+    end
+
+    private
+
+    def match!(actual, schema, path=[])
+      @match = begin
+        if schema.is_a? Hash
+          match_hash! actual, schema, path
+        elsif schema.is_a? Array and schema.length == 1
+          match_array! actual, schema, path
+        elsif schema.is_a? Array and schema.length > 1
+          match_alternatives! actual, schema, path
+        else
+          match_with_triple_equals! actual, schema, path
+        end
+      end
+    end
+
+    def match_hash!(actual, schema, path)
+      recording_mismatches actual, schema, path do
+        schema.keys.sort == actual.keys.sort and
+        actual.all? do |key, value|
+          match! value, schema[key], path + [key]
+        end
+      end
+    end
+
+    def match_array!(actual, schema, path)
+      recording_mismatches actual, schema, path do
+        actual.is_a? Array and
+        actual.each_with_index.all? { |elem, i| match! elem, schema[0], path + [i] }
+      end
+    end
+
+    def match_alternatives!(actual, alternatives, path)
+      recording_mismatches actual, alternatives, path, true do
+        alternatives.any? do |alternative|
+          match! actual, alternative, path
+        end
+      end
+    end
+
+    def match_with_triple_equals!(actual, expected, path)
+      recording_mismatches actual, expected, path do
+        expected === actual
+      end
+    end
+
+    def recording_mismatches(actual, schema, path, overwrite=false)
+      if yield
+        true
+      else
+        mismatch = "expected /#{path.join("/")} to match\n#{schema.inspect}\nbut got\n#{actual.inspect}"
+        @mismatch = mismatch if !@mismatch || overwrite
+        false
+      end
+    end
+  end
+end

data/lib/hashema/version.rb

@@ -0,0 +1,5 @@
+module Hashema
+  module Version
+    STRING = '0.0.0'
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: hashema
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Ben Christel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Assert that JSONable objects conform to a schema
+email: 
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- lib/hashema.rb
+- lib/hashema/conform_to_schema.rb
+- lib/hashema/validator.rb
+- lib/hashema/version.rb
+- License.txt
+- README.md
+homepage: http://github.com/benchristel/hashema
+licenses:
+- MIT
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: hashema-0.0.0
+test_files: []