xpect 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad2edb079c70798c80c0398f9f5dfde24caf52e476e59ba304e88f300f3698f0
+  data.tar.gz: f3e8745d6ca091aea1d78ccc75a637161c4551d959547dbd3757195e856df8e8
+SHA512:
+  metadata.gz: 1a93009cb346efe42a2ee5c47a44bf266b47a1a49026fe109407cf211e660092a0993e797a0380d297fa79a02ccf2725eca58164efae61a890acdc3660c2afba
+  data.tar.gz: e2995f11148208b697d8ff2fd5854f69a3c95f9315af4cb24b35aedc31d3415db63d30890092e83efc925d129203f797c49c316c75a4f9b7211f27071b86b6e9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea/
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at travis.douce@stitchfix.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in xpect.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    xpect (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.1.0)
+    diff-lcs (1.3)
+    rake (10.4.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  xpect!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Travis Douce
+
+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,639 @@
+# Xpect
+
+A Ruby Hash specification to ensure unstructured data is structured the way you expect it.
+
+## Design Goal
+
+The design goal is write specifications in terms of the object that is being validated. For example, I want to write a
+specification as a `Hash`, as opposed to a DSL, when validating a `Hash`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xpect'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xpect
+
+## Usage
+
+Verify that `Hash`es are the structure you expect at the on-set, as opposed to finding out a `Hash` isn't structured
+the way you intended deep in a function body. This can be useful for various reasons, such as:
+  * HTTP responses
+  * RabbitMQ payloads
+  * Argument Hashes
+  * Or, anywhere that needs to ensure `Hash`es (or JSON, just parse it first) conform to a particular structure
+
+```ruby
+def some_function(hash_payload)
+  spec = {
+    person: {
+      name: {
+        first: Xpect::Matchers.truthy,
+        last: Xpect::Matchers.truthy,
+        middle: Xpect::Matchers.anything,
+      },
+      footwear: lambda {|v| ['flip flops', 'flip flops and socks', 'hiking boots'].include?(v) },
+      state: 'GA',
+      age: lambda {|v| v >= 0 }
+    }
+  }
+  
+  Xpect::Spect.validate!(spec: spec, data: hash_payload)
+  # Continue processing data knowing that the Hash contains valid data.
+end
+
+```
+
+## `.conform!` vs `.validate!`
+
+`.validate!` ensures the data (i.e. the `Hash`) adheres to the structure according to the spec (i.e. validates the data).
+If the data is valid then it returns the data it was given. `.conform!` validates the data according to the spec, just like
+`.validate!`, but it returns only the data specified in the spec. Both functions raise a `Xpect::FailedSpec` if the data
+does not adhere to the structure of the spec.
+
+### `.validate!`
+
+```ruby
+spec = {
+  name: 'Andre 3000',
+  age: lambda {|v| v > 40 }
+}
+
+# Passes
+validated_data = Xpect::Spect.validate!(
+  spec: spec,
+  data: {
+    name: 'Andre 3000',
+    age: 47,
+    footwear: 'flip flops and socks'
+  }
+)
+
+puts validated_data
+# {
+#  name: 'Andre 3000',
+#  age: 47,
+#  foot_wear: 'flip flops and socks'
+# }
+
+# Fails and raises Xpect::FailedSpec
+Xpect::Spect.validate!(
+  spec: spec,
+  data: {
+    name: 'Andre 3000',
+    age: 4, # Not greater than 40 as specified in spec
+    footwear: 'flip flops and socks'
+  }
+)
+```
+
+### `.conform!`
+
+```ruby
+spec = {
+  name: 'Andre 3000',
+  age: lambda {|v| v > 40 }
+}
+
+# Passes
+conformed_data = Xpect::Spect.conform!(
+  spec: spec,
+  data: {
+    name: 'Andre 3000',
+    age: 47,
+    footwear: 'flip flops and socks'
+  }
+)
+
+puts conformed_data
+# {
+#  name: 'Andre 3000',
+#  age: 47,
+# }
+
+# Fails and raises Xpect::FailedSpec
+Xpect::Spect.conform!(
+  spec: spec,
+  data: {
+    name: 'Andre 3000',
+    age: 4, # Not greater than 40 as specified in spec
+    footwear: 'flip flops and socks'
+  }
+)
+```
+
+## `Hash` values
+
+### `truthy`
+
+```ruby
+spec = { name: Xpect::Matchers.truthy }
+
+# Passes
+Xpect::Spect.validate!(spec: spec, data: { name: 'Andre 3000'})
+
+# Fails
+Xpect::Spect.validate!(spec: spec, data: { name: false})
+```
+
+### `falsy`
+
+```ruby
+spec = { name: Xpect::Matchers.falsy }
+
+# Passes
+Xpect::Spect.validate!(spec: spec, data: { name: ''})
+
+# Fails
+Xpect::Spect.validate!(spec: spec, data: { name: 'Andre 3000'})
+```
+
+### `anything`
+
+```ruby
+spec = { name: Xpect::Matchers.anything }
+
+# Passes
+Xpect::Spect.validate!(spec: spec, data: { name: nil})
+Xpect::Spect.validate!(spec: spec, data: { name: 'Andre 3000'})
+
+# Fails
+Xpect::Spect.validate!(spec: spec, data: {})
+```
+
+### `nil`
+
+```ruby
+spec = { name: Xpect::Matchers.nil }
+
+# Passes
+Xpect::Spect.validate!(spec: spec, data: { name: nil})
+
+# Fails
+Xpect::Spect.validate!(spec: spec, data: { name: 'Andre 3000'})
+```
+
+### Custom
+
+```ruby
+spec = { name: lambda {|v| ['Andre 3000', 'Big Boi'].include?(v) } }
+
+# Passes
+Xpect::Spect.validate!(spec: spec, data: { name: 'Big Boi'})
+Xpect::Spect.validate!(spec: spec, data: { name: 'Andre'})
+
+# Fails
+Xpect::Spect.validate!(spec: spec, data: { name: 'Back Street Boys'})
+```
+
+### `Pred`
+
+```ruby
+spec = {
+  name: Xpect::Pred.new(
+    pred: lambda {|v| ['Andre 3000', 'Big Boi'].include?(v) }
+  )
+}
+
+# Passes
+Xpect::Spect.validate!(spec: spec, data: { name: 'Big Boi'})
+Xpect::Spect.validate!(spec: spec, data: { name: 'Andre'})
+
+# Fails
+Xpect::Spect.validate!(spec: spec, data: { name: 'Back Street Boys'})
+```
+
+Providing a default value
+
+```ruby
+spec = {
+  name: Xpect::Pred.new(
+    pred: lambda {|v| ['Andre 3000', 'Big Boi'].include?(v) },
+    default: 'Dr. Seuss'
+  )
+}
+
+# Passes
+Xpect::Spect.validate!(spec: spec, data: { name: 'Big Boi'})
+Xpect::Spect.validate!(spec: spec, data: { name: 'Andre'})
+validated_data = Xpect::Spect.validate!(spec: spec, data: {})
+
+puts validated_data
+# { name: 'Dr. Seuss' }
+
+# Fails
+Xpect::Spect.validate!(spec: spec, data: { name: 'Back Street Boys'})
+```
+
+### Arrays
+
+Exact item comparison
+
+```ruby
+spec = {
+  people: [
+    {
+      name: 'Andre 3000',
+      footwear: 'flip flops'
+    },
+    {
+      name: 'Big Boi',
+      footwear: 'flip flops and socks'
+    }
+  ]
+}
+
+# Passes
+Xpect::Spect.validate!(
+  spec: spec,
+  data: {
+    people: [
+      {
+        name: 'Andre 3000',
+        footwear: 'flip flops'
+      },
+      {
+        name: 'Big Boi',
+        footwear: 'flip flops and socks'
+      }
+    ]
+  }
+)
+
+# Passes
+Xpect::Spect.validate!(
+  spec: spec,
+  data: {
+    people: [
+      {
+        name: 'Andre 3000',
+        footwear: 'flip flops'
+      },
+      {
+        name: 'Big Boi',
+        footwear: 'flip flops and socks'
+      },
+      {
+        name: 'CeeLo Green',
+        footwear: 'boots'
+      }
+    ]
+  }
+)
+
+# Fails - missing second item in array in spec
+Xpect::Spect.validate!(
+  spec: spec,
+  data: {
+    people: [
+      {
+        name: 'Andre 3000',
+        footwear: 'flip flops'
+      }
+    ]
+  }
+)
+```
+
+Ensuring every item in Array meets specification
+
+```ruby
+spec = {
+  people: Xpect::Every.new(
+    {
+      name: Xpect::Matchers.truthy,
+      footwear: lambda {|v| ['flip flops', 'flip flops and socks'].include?(v) }
+    }
+  )
+}
+
+# Passes
+Xpect::Spect.validate!(
+  spec: spec,
+  data: {
+    people: [
+      {
+        name: 'Andre 3000',
+        footwear: 'flip flops'
+      },
+      {
+        name: 'Big Boi',
+        footwear: 'flip flops and socks'
+      }
+    ]
+  }
+)
+
+# Passes
+Xpect::Spect.validate!(
+  spec: spec,
+  data: {
+    people: [
+      {
+        name: 'Andre 3000',
+        footwear: 'flip flops'
+      },
+      {
+        name: 'Big Boi',
+        footwear: 'flip flops and socks'
+      },
+      {
+        name: 'CeeLo Green',
+        footwear: 'flip flops'
+      }
+    ]
+  }
+)
+
+# Fails
+Xpect::Spect.validate!(
+  spec: spec,
+  data: {
+    people: [
+      {
+        name: 'Andre 3000',
+        footwear: 'flip flops'
+      },
+      {
+        name: 'Big Boi',
+        footwear: 'flip flops and socks'
+      },
+      {
+        name: 'Travis',
+        footwear: 'Hiking Boots' # footwear does not adhere to specification
+      }
+    ]
+  }
+)
+````
+
+## `Hash` keys
+
+Requiring keys
+
+```ruby
+spec = {
+  person: Xpect::Keys.new(
+    required: {
+      name: 'Andre 3000',
+      footwear: lambda {|v| ['flip flops', 'socks'].include?(v) }
+    }
+  ),
+}
+
+# Passes
+Xpect::Spect.validate!(
+  spec: spec,
+  data: {
+    person: {
+      name: 'Andre 3000',
+      footwear: 'socks',
+      age: 45
+    }
+  }
+)
+
+# Fails
+Xpect::Spect.validate!(
+  spec: spec,
+  data: {
+    person: { 
+      footwear: 'socks',
+      age: 45  # Missing the `name` key as specified in spec
+    }
+  }
+)
+```
+
+Optional keys
+
+```ruby
+spec = {
+  person: Xpect::Keys.new(
+    required: {
+      name: 'Andre 3000',
+      footwear: lambda {|v| ['flip flops', 'socks'].include?(v) }
+    },
+    optional: {
+      style: 'ice cold'
+    }
+  ),
+}
+
+# Passes
+Xpect::Spect.validate!(
+  spec: spec,
+  data: {
+    person: {
+      name: 'Andre 3000',
+      footwear: 'socks',
+      age: 45
+    }
+  }
+)
+
+Xpect::Spect.validate!(
+  spec: spec,
+  data: {
+    person: {
+      name: 'Andre 3000',
+      footwear: 'socks',
+      age: 45,
+      style: 'ice cold'
+    }
+  }
+)
+
+# Fails
+Xpect::Spect.validate!(
+  spec: spec,
+  data: {
+    person: {
+      footwear: 'socks',
+      age: 45,
+      style: 'too hot for the hot tub' # Does not meet specification
+    }
+  }
+)
+```
+
+## Highly Nested Hashes
+
+```ruby
+spec = {
+  people: Xpect::Every.new(
+    {
+      name: Xpect::Matchers.truthy,
+      footwear: lambda {|v| ['flip flops', 'flip flops and socks'].include?(v) },
+      things: [
+        1,
+        2,
+        3,
+        {a: 'a'},
+        [
+          'one',
+          'two',
+          Xpect::Pred.new(
+            pred: lambda {|v| v == 'three'},
+            default: 'my-default'
+          )
+        ]
+      ],
+      other: Xpect::Keys.new(
+        required: {
+          b: 'b',
+          c: 'c',
+          f: [
+            4,
+            5,
+            6,
+            lambda {|v| v > 8},
+          ],
+          g: Xpect::Every.new(
+            {
+              id: lambda {|v| v > 100}
+            }
+          )
+        },
+        optional: {d: 'd', e: 'e'}
+      )
+    }
+  ),
+}
+
+# Passes
+conformed_data = Xpect::Spect.conform!(
+  spec: spec,
+  data: {
+    people: [
+      {
+        name: 'Andre 3000',
+        footwear: 'flip flops',
+        not_required_by_spec: 'not_required_by_spec',
+        things: [
+          1,
+          2,
+          3,
+          {a: 'a'},
+          [
+            'one',
+            'two'
+          ]
+        ],
+        other: {
+          b: 'b',
+          c: 'c',
+          e: 'e',
+          f: [
+            4,
+            5,
+            6,
+            9
+          ],
+          g: [
+            {
+              id: 101,
+            },
+            {
+              id: 102
+            }
+          ],
+          not_required_by_spec: [1, 2, 3, 4]
+        }
+      }
+    ]
+  }
+)
+
+puts conformed_data
+# {
+#  :people => [
+#    {
+#      :name => "Andre 3000",
+#      :footwear => "flip flops",
+#      :things => [1, 2, 3, {:a => "a"}, ["one", "two", "my-default"]],
+#      :other => {:b => "b", :c => "c", :f => [4, 5, 6, 9], :g => [{:id=>101}, {:id => 102}], :e => "e"}
+#    }
+#  ]
+# }
+
+# Fails
+Xpect::Spect.conform!(
+  spec: spec,
+  data: {
+    people: [
+      {
+        name: 'Andre 3000',
+        footwear: 'flip flops',
+        not_required_by_spec: 'not_required_by_spec',
+        things: [
+          1,
+          2,
+          3,
+          {a: 'a'},
+          [
+            'one',
+            'two'
+          ]
+        ],
+        other: {
+          b: 'b',
+          c: 'c',
+          e: 'e',
+          f: [
+            4,
+            5,
+            6,
+            9
+          ],
+          g: [
+            {
+              id: 101,
+
+            },
+            {
+              id: 2 # Not greater than 100 as specified in spec
+            }
+          ],
+          not_required_by_spec: [1, 2, 3, 4]
+        }
+      }
+    ]
+  }
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tdouce/xpect. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Xpect project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tdouce/xpect/blob/master/CODE_OF_CONDUCT.md).
+
+## TODOs
+* Fix paths in tests or provide a better way to communicate where failure happended
+* Add unit tests for
+  * Keys and arrays
+  * Every
+  * Type
+    * Then remove A LOT of tests in spect_spec.rb

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xpect"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/xpect/equality_helpers.rb

@@ -0,0 +1,15 @@
+module Xpect
+  class EqualityHelpers
+    def self.equal?(val_1, val_2, path)
+      unless val_1 == val_2
+        raise FailedSpec, "'#{ val_1 }' is not equal to '#{ val_2 }' at '#{ path }'"
+      end
+    end
+
+    def self.equal_with_proc?(fn, val, path)
+      unless fn.call(val)
+        raise FailedSpec, "'#{ val }' does not meet expectation at '#{ path }'"
+      end
+    end
+  end
+end

data/lib/xpect/every.rb

@@ -0,0 +1,14 @@
+module Xpect
+  # TODO: Add tests
+  class Every
+    def initialize(item_spec)
+      @item_spec = item_spec
+    end
+
+    def conform!(data:, path: [])
+      data.map do |val|
+        Xpect::Type.process(@item_spec, @item_spec, val, path)
+      end
+    end
+  end
+end

data/lib/xpect/failed_spec.rb

@@ -0,0 +1,3 @@
+module Xpect
+  class FailedSpec < StandardError; end
+end

data/lib/xpect/keys.rb

@@ -0,0 +1,53 @@
+module Xpect
+  class Keys
+    def initialize(required: {}, optional: {})
+      raise "required must be a Hash" unless required.is_a?(Hash) && optional.is_a?(Hash)
+
+      @optional = optional
+      @required = required
+    end
+
+    def conform!(value:, path: [])
+      required = process_required(value, path)
+      process_optional(required, value, path)
+    end
+
+    private
+
+    def process_optional(init, value, path)
+      @optional.reduce(init) do |memo, (key, val)|
+        if val.is_a?(Keys)
+          memo[key] = val.conform!(value: value[key], path: path)
+        else
+          if value.has_key?(key)
+            data_value = value.fetch(key)
+            memo[key] = Xpect::Type.process(val, val, data_value, path)
+          end
+        end
+
+        memo
+      end
+    end
+
+    def process_required(value, path)
+      @required.reduce({}) do |memo, (key, val)|
+        if val.is_a?(Keys)
+          memo[key] = val.conform!(value: value[key], path: path)
+        else
+          if value.has_key?(key)
+            data_value = value.fetch(key)
+            memo[key] = Xpect::Type.process(val, val, data_value, path)
+          else
+            if val.is_a?(Pred) && val.default
+              memo[key] = val.default
+            else
+              raise FailedSpec, "does not include '#{ key }' at '#{ path }'"
+            end
+          end
+        end
+
+        memo
+      end
+    end
+  end
+end

data/lib/xpect/matchers.rb

@@ -0,0 +1,49 @@
+module Xpect
+  class Matchers
+    def self.anything
+      lambda {|_| true }
+    end
+
+    def self.nil
+      lambda do |val|
+        unless val.nil?
+          raise_error("'#{ val }' is not nil.")
+        end
+
+        true
+      end
+    end
+
+    def self.falsy
+      lambda do |val|
+        if val.is_a?(Integer) || val.is_a?(Float)
+          raise_error("'#{ val }' is not falsy.")
+        end
+
+        if val.nil? || val.empty?
+          return true
+        end
+
+        raise_error("'#{ val }' is not falsy.")
+      end
+    end
+
+    def self.truthy
+      lambda do |val|
+        if val.is_a?(Integer) || val.is_a?(Float)
+          return true
+        end
+
+        if val.nil? || val.empty?
+          raise_error("'#{ val }' is not truthy.")
+        end
+
+        true
+      end
+    end
+
+    def self.raise_error(msg)
+      raise FailedSpec, msg
+    end
+  end
+end

data/lib/xpect/pred.rb

@@ -0,0 +1,37 @@
+require 'xpect/failed_spec'
+
+module Xpect
+  class Pred
+    attr_reader :default
+
+    def initialize(pred:, error_msg: nil, default: nil)
+      unless pred.is_a?(Proc)
+        raise "pred must be a Proc"
+      end
+
+      @pred = pred
+      @error_msg = error_msg
+      @default = default
+    end
+
+    def conform!(value:, path: nil)
+      return @default if @default && value.nil?
+
+      if value.nil?
+        raise FailedSpec, "the value at path '#{ path }' is missing"
+      end
+
+      unless @pred.call(value)
+        error_msg = if @error_msg
+                      "'#{ value }' does not meet spec for '#{ path }': '#{ @error_msg }'"
+                    else
+                      "'#{ value }' does not meet spec for '#{ path }'"
+                    end
+
+        raise FailedSpec, error_msg
+      end
+
+      value
+    end
+  end
+end

data/lib/xpect/spect.rb

@@ -0,0 +1,44 @@
+module Xpect
+  class Spect
+    def self.conform!(spec:, data:, path: [])
+      new.conform!(spec: spec, data: data, path: path)
+    end
+
+    def self.validate!(spec:, data:)
+      new.validate!(spec: spec, data: data)
+    end
+
+    # 1) Raise exception if spec isn't satisfied
+    # 2) Return original data
+    def validate!(spec:, data:)
+      call(spec: spec, data: data, init: data)
+    end
+
+    # 1) Raise exception if spec isn't satisfied
+    # 2) Return data as it adheres to the spec
+    def conform!(spec:, data:, path: [])
+      call(spec: spec, data: data, path: path)
+    end
+
+    private
+
+    def call(spec:, data:, path: [], init: {})
+      spec.reduce(init) do |memo, (key, value)|
+
+        unless data.is_a?(Hash)
+          raise(FailedSpec, "'#{ data }' is not equal to '#{ value }'")
+        end
+
+        path = path << key
+        data_value = data[key]
+        memo[key] = if !value.is_a?(Hash)
+                      Xpect::Type.process(value, value, data_value, path)
+                    else
+                      call(spec: spec[key], data: data_value, path: path)
+                    end
+
+        memo
+      end
+    end
+  end
+end

data/lib/xpect/type.rb

@@ -0,0 +1,32 @@
+module Xpect
+  class Type
+    def self.process_array(iterable, data, path)
+      iterable.map.with_index do |spc, idx|
+        Type.process(spc, spc, data[idx], path)
+      end
+    end
+
+    def self.process(case_item, spec, val, path)
+      case case_item
+        when Xpect::Every
+          case_item.conform!(data: val, path: path)
+        when Array
+          unless val.is_a?(Array)
+            raise(FailedSpec, "'#{ val }' must be an array")
+          end
+
+          Type.process_array(spec, val, path)
+        when Hash
+          Xpect::Spect.conform!(spec: spec, data: val, path: path)
+        when Xpect::Pred, Xpect::Keys
+          spec.conform!(value: val, path: path)
+        when Proc
+          Xpect::EqualityHelpers.equal_with_proc?(spec, val, path)
+          val
+        else
+          Xpect::EqualityHelpers.equal?(spec, val, path)
+          val
+      end
+    end
+  end
+end

data/lib/xpect/version.rb

@@ -0,0 +1,3 @@
+module Xpect
+  VERSION = "0.1.0"
+end

data/lib/xpect.rb

@@ -0,0 +1,9 @@
+require 'xpect/version'
+require 'xpect/matchers'
+require 'xpect/failed_spec'
+require 'xpect/pred'
+require 'xpect/keys'
+require 'xpect/equality_helpers'
+require 'xpect/type'
+require 'xpect/every'
+require 'xpect/spect'

data/xpect.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "xpect/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "xpect"
+  spec.version       = Xpect::VERSION
+  spec.authors       = ["Travis Douce"]
+  spec.email         = ["travisdouce@gmail.com"]
+
+  spec.summary       = %q{Specs for Hashes.}
+  spec.description   = %q{Specs for Hashes in the terms of Hashes.}
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: xpect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Travis Douce
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !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: byebug
+  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'
+description: Specs for Hashes in the terms of Hashes.
+email:
+- travisdouce@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xpect.rb
+- lib/xpect/equality_helpers.rb
+- lib/xpect/every.rb
+- lib/xpect/failed_spec.rb
+- lib/xpect/keys.rb
+- lib/xpect/matchers.rb
+- lib/xpect/pred.rb
+- lib/xpect/spect.rb
+- lib/xpect/type.rb
+- lib/xpect/version.rb
+- xpect.gemspec
+homepage: 
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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.7.4
+signing_key: 
+specification_version: 4
+summary: Specs for Hashes.
+test_files: []