hashape 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b37fe671e0f57877e73dd909a3cb44d102c2756dfffe18256dca966c606f7747
-  data.tar.gz: bd68bd8c108a93c2f31547cb54bda91e9828c88a94c04ed9abf650e5ee90806e
+  metadata.gz: e35dfd6e8729b87cdfa05e269c7f49a91e30226164cd9389f01af772065d0d06
+  data.tar.gz: b28498ce41057dd4c993798438c90b5e98e67ab7619e0f4da2d29da279c8d837
 SHA512:
-  metadata.gz: be6614d94f50efeaa8616f002728da224f64d6c2ec8a77f906fd8a5a1bd3a9ceb9b0330c129a9291095fb8ef63cae55a08147b94750235552252e6b9f04f82de
-  data.tar.gz: c0f58ee27cfce42b168a93c68a614059dd0971f952cabb66117eb3d14e5ddcc341056d2ccf1a3c472b9b268d5af71a5fed090405db1650b0be008e9a24020e9c
+  metadata.gz: 3768ff18d9b09f28904b3a7567d5b8b0fb6c673afff7519446a43be0e70e588e76134ab20533416c3301c29046b6aef2d6f4428c1ce8e5bfd2a355c24a522888
+  data.tar.gz: 269ebb1c077e3fef044402c7cac58af93c2d3b73ed1218920350370c882f06973b20891dd569019a156cc92c5e8a8a1508a5db29b1eb04316d1cde5e884a69c7

data/Gemfile

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

data/README.md

@@ -22,7 +22,73 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First, you can define your shape using `Hashape.shape`, which returns an
+instance of `Hashape::Shape`.
+Each key must be given a specifier, which can be one of the following:
+
+  - A type
+  - Simple values (e.g. strings, booleans, numbers)
+  - Another hash
+  - Regular expressions
+  - An instance of any class in `Hashape::Specifiers`
+
+(Fundamentally, comparisons are done using `===` with your specifier on the left
+hand side, so anything which supports this will work.)
+
+You can then check that a given hash matches this shape using either 
+`Shape#matches?`, which returns a boolean, or `Shape#matches!`, which raises an
+exception if the shape does not match.
+
+Here's an example of checking that a hash has a `:name` key which is a string,
+and a `:success` key which must be true:
+
+```
+require 'hashape'
+include Hashape
+
+shape = Shape.new({
+  name: String,
+  success: true
+})
+
+p shape.matches?({
+  name: 'Aaron',
+  success: true
+}) #=> true
+
+p shape.matches?({
+  name: 'Aaron',
+  success: false
+}) #=> false
+
+shape.matches!({
+  name: 3,
+  success: true
+}) #=> ShapeMatchError (key name with value 3 does not match spec String)
+```
+
+Extra specifiers, which are within the `Hashape::Specifiers` module, give you 
+a bit more flexibility. They wrap another specifier (or an array of them) to
+alter their behaviour. (Note that you can nest specifiers.) For example:
+
+```
+require 'hashape'
+include Hashape
+include Hashape::Specifiers
+
+# Note: for all specifiers, Name[...] is a shortcut for Name.new(...).
+
+shape = Shape.new({
+  data: Optional[String]
+})
+shape.matches?({ data: "Hello!" }) #=> true
+shape.matches?({ }) #=> true
+shape.matches?({ data: 3 }) #=> false
+
+shape = Shape.new({
+  data: OneOf[[String, Integer]]
+})
+```
 
 ## License
 

data/hashape.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.16.1"
 end

data/lib/hashape.rb

@@ -4,7 +4,7 @@
 module Hashape
   ##
   # The library version.
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 
   ##
   # Specifiers which can provide additional typing to shapes.
@@ -19,7 +19,7 @@ module Hashape
       # @param [*] spec The type spec for this specifier to match against.
       # @return [Specifier] A new specifier.
       def self.[](spec)
-        Specifier.new(spec)
+        self.new(spec)
       end
 
       ##
@@ -59,6 +59,11 @@ module Hashape
     end
   end
 
+  ##
+  # Raised when Shape#matches! fails.
+  class ShapeMatchError < StandardError
+  end
+
   ##
   # A template hash representing how a hash should be structured, allowing
   # other hashes to be validated against it.
@@ -80,21 +85,27 @@ module Hashape
     # @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
+      matches!(subject)
+      true
+    rescue ShapeMatchError
+      false
     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
+      shape.each do |k, spec|
+        v = subject[k]
+        if v.is_a?(Hash) && spec.is_a?(Hash)
+          Shape.new(spec).matches!(v)
+        else
+          unless spec === v
+            raise ShapeMatchError,
+              "key #{k} with value #{v} does not match spec #{spec}" \
+          end
+        end
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hashape
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Aaron Christiansen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-16 00:00:00.000000000 Z
+date: 2019-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
 description: 
 email:
 - aaronc20000@gmail.com