hashape 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b37fe671e0f57877e73dd909a3cb44d102c2756dfffe18256dca966c606f7747
+  data.tar.gz: bd68bd8c108a93c2f31547cb54bda91e9828c88a94c04ed9abf650e5ee90806e
+SHA512:
+  metadata.gz: be6614d94f50efeaa8616f002728da224f64d6c2ec8a77f906fd8a5a1bd3a9ceb9b0330c129a9291095fb8ef63cae55a08147b94750235552252e6b9f04f82de
+  data.tar.gz: c0f58ee27cfce42b168a93c68a614059dd0971f952cabb66117eb3d14e5ddcc341056d2ccf1a3c472b9b268d5af71a5fed090405db1650b0be008e9a24020e9c

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hashape.gemspec
+gemspec
+
+gem "simplecov", "~> 0.16.1"

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    hashape (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    docile (1.3.2)
+    json (2.2.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.1)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  hashape!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.16.1)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Aaron Christiansen
+
+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,29 @@
+# Hashape
+
+Hashape is a **lightweight library for testing the structure of hashes**. It
+supports deep nesting and a variety of different methods of matching types or
+values (called _specifiers_).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hashape'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hashape
+
+## Usage
+
+TODO: Write usage instructions here
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/hashape.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hashape"
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hashape'
+  spec.version       = Hashape::VERSION
+  spec.authors       = ['Aaron Christiansen']
+  spec.email         = ['aaronc20000@gmail.com']
+
+  spec.summary       = 'Easy validation of deeply-nested hashes'
+  spec.homepage      = 'https://github.com/AaronC81/hashape'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/hashape.rb

@@ -0,0 +1,108 @@
+##
+# Provides utilities for checking the shape of deeply-nested hashes, such as
+# for validating JSON.
+module Hashape
+  ##
+  # The library version.
+  VERSION = '1.0.0'
+
+  ##
+  # Specifiers which can provide additional typing to shapes.
+  module Specifiers
+    ##
+    # The basic specifier. You should probably never use this.
+    class Specifier
+      attr_reader :spec
+
+      ##
+      # A shorthand for constructing an instance of any specifier.
+      # @param [*] spec The type spec for this specifier to match against.
+      # @return [Specifier] A new specifier.
+      def self.[](spec)
+        Specifier.new(spec)
+      end
+
+      ##
+      # Creates a new specifier.
+      # @param [*] spec The type spec for this specifier to match against.
+      # @return [Specifier] A new specifier.
+      def initialize(spec)
+        @spec = spec
+      end
+    end
+
+    ##
+    # Allows a type spec to also be nil.
+    class Optional < Specifier
+      def ===(v)
+        v.nil? || self.spec === v
+      end
+    end
+
+    ##
+    # Given a list of type specs, allows the value to match any one of those
+    # type specs.
+    class OneOf < Specifier
+      def ===(v)
+        raise 'spec for OneOf must be an array' unless self.spec.is_a?(Array)
+        self.spec.any? { |s| s === v }
+      end
+    end
+
+    ##
+    # Requires that the value be an enumerable, where each item matches the
+    # given type spec.
+    class Many < Specifier
+      def ===(v)
+        v.is_a?(Enumerable) && v.all? { |i| self.spec === i }
+      end
+    end
+  end
+
+  ##
+  # A template hash representing how a hash should be structured, allowing
+  # other hashes to be validated against it.
+  class Shape
+    attr_reader :shape
+
+    ##
+    # Create a new shape.
+    # @param [Hash] shape The template hash.
+    # @return [Shape] The new shape.
+    def initialize(shape)
+      @shape = shape
+    end
+
+    ##
+    # Returns a boolean indicating whether the given hash matches the template
+    # hash which this shape was constructed with.
+    # @param [Hash] subject The hash to compare the template hash against.
+    # @return [TrueClass|FalseClass] A boolean indicating whether the subject
+    #   hash matches the template hash.
+    def matches?(subject)
+      subject.all? do |k, v|
+        if v.is_a?(Hash) && shape[k].is_a?(Hash)
+          Shape.new(shape[k]).matches?(v)
+        else
+          shape[k] === v
+        end
+      end
+    end
+
+    ##
+    # Calls #matches? and raises a RuntimeError if it does not return true.
+    # @param [Hash] subject The hash to compare the template hash against.
+    def matches!(subject)
+      raise unless matches?(subject)
+      nil
+    end
+  end
+
+  ##
+  # Create a new shape.
+  # @param [Hash] shape The template hash.
+  # @return [Shape] The new shape. 
+  def self.shape(shape)
+    Shape.new(shape)
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: hashape
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aaron Christiansen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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'
+- !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'
+description: 
+email:
+- aaronc20000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- hashape.gemspec
+- lib/hashape.rb
+homepage: https://github.com/AaronC81/hashape
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Easy validation of deeply-nested hashes
+test_files: []