hash_police 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad058f96fd412a77400f8cf0a3d034394bd7cd88
-  data.tar.gz: 5d09df0ade02fc80b6b52706e59a26c22a013b0f
+  metadata.gz: f65798cbb95f63baf5b4f55050286e2851afee7e
+  data.tar.gz: 3593e76d36b0ad927a599326674e9e586ab15baa
 SHA512:
-  metadata.gz: 030915243afc73a524f67166afbb1d5f440cd8cd1e539a1b37d30f541fb9bb038f4ed4ec0954beb00e18be6133a61217a2143c38a3e126ec5c40251f8b8209ae
-  data.tar.gz: 3687760e41798d3e768503a1432eacdc7887bd2654971bc737cf18991e39c1848b9040175d0f628fb8797c69566f2c2bce7def80162ae219fb95a23951605ba7
+  metadata.gz: d12c3d9b8750e6c56a5eb82614fe57a65c062da82a1c3228bc4c11b2267b770b673b39fc412dca63a90cba9789f8c8acfec9fdd3d7fdded8ebc4d4e7b4861cd8
+  data.tar.gz: 0493195b05a025b247ae87b09b437af736a7236b0da1e161845f9440e1b962bd7e2ed453e9a5154cb25ce5c3fd4ebfc72caf1609e6ef541a41ef45da3e623d6a

data/README.md

@@ -17,43 +17,60 @@ Or install it yourself as:
 
 ## Usage
 
-        rule = {
-          :name => "a string",
-          :age => 28,
-          :favorites => [ "a string" ],
-          :locations => [
-            { :name => "string", :duration => 3 }
-          ]
-        }
-
-        valid = {
-          :name => "Jack",
-          :age => 28,
-          :favorites => [ "sport", "music" ],
-          :locations => [
-            { :name => "Taiwan", :duration => 25 },
-            { :name => "US", :duration => 5 }
-          ]
-        }
-
-        invalid = {
-          :name => [],
-          :age => "not a number",
-          :locations => [
-            { :name => "Taiwan", :duration => 25 },
-            { :name => 23 }
-          ]
-        }
-
-        police = HashPolice::Police.new(rule)
-
-        result = police.check(valid)
-        result.passed? # => true
-        result.error_messages # => ""
-
-        result = police.check(invalid)
-        result.passed? # => false
-        result.error_messages # => "`name`: expect String, got Array; `favorites`: missing; `locations.1.name`: expect String, got Array; `locations.1.duration`: missing"
+```ruby
+rule = {
+  :name => "a string",
+  :age => 28,
+  :favorites => [ "a string" ],
+  :locations => [
+    { :name => "string", :duration => 3 }
+  ]
+}
+
+valid = {
+  :name => "Jack",
+  :age => 28,
+  :favorites => [ "sport", "music" ],
+  :locations => [
+    { :name => "Taiwan", :duration => 25 },
+    { :name => "US", :duration => 5 }
+  ]
+}
+
+invalid = {
+  :name => [],
+  :age => "not a number",
+  :locations => [
+    { :name => "Taiwan", :duration => 25 },
+    { :name => 23 }
+  ]
+}
+
+police = HashPolice::Police.new(rule)
+
+result = police.check(valid)
+result.passed? # => true
+result.error_messages # => ""
+
+result = police.check(invalid)
+result.passed? # => false
+result.error_messages #=> "`name`: expect String, got Array; `favorites`: missing; `locations.1.name`: expect String, got Array; `locations.1.duration`: missing"
+```
+
+## RSpec matcher:
+
+`HashPolice` provides a RSpec matcher `have_the_same_hash_format_as` checking the formats of two hashes.
+
+```ruby
+  require 'hash_police/rspec_matcher'
+
+  it "should be able to use the matcher `have_the_same_hash_format_as`" do
+    expected = { 'str' => '', 'an_arr' => [ 1 ] }
+    to_be_checked = { 'str' => 'hola', :an_arr => [1,3,4] }
+
+    expect(to_be_checked).to have_the_same_hash_format_as(expected)
+  end
+```
 
 ## Contributing
 

data/lib/hash_police/police.rb

@@ -1,4 +1,5 @@
 require "hash_police/check_result"
+require 'json'
 
 module HashPolice
   class Police

data/lib/hash_police/rspec_matcher.rb

@@ -0,0 +1,13 @@
+RSpec::Matchers.define :have_the_same_hash_format_as do |expected|
+  result = nil
+ 
+  match do |actual|
+    police = HashPolice::Police.new(expected)
+    result = police.check(actual)
+    result.passed?
+  end
+ 
+  failure_message do |actual|
+    result.error_messages
+  end
+end

data/lib/hash_police/version.rb

@@ -1,3 +1,3 @@
 module HashPolice
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/hash_police/check_result_spec.rb

@@ -1,4 +1,4 @@
-require "hash_police/check_result"
+require "hash_police"
 
 describe HashPolice::CheckResult do
   let(:context_key) { "the-key" }

data/spec/hash_police/matcher_spec.rb

@@ -0,0 +1,11 @@
+require 'hash_police'
+require 'hash_police/rspec_matcher'
+
+describe 'Matcher' do
+  it "should be able to use the matcher `have_the_same_hash_format_as`" do
+    expected = { 'str' => '', 'an_arr' => [ 1 ] }
+    to_be_checked = { 'str' => 'hola', :an_arr => [1,3,4] }
+
+    expect(to_be_checked).to have_the_same_hash_format_as(expected)
+  end
+end

data/spec/hash_police/police_spec.rb

@@ -1,4 +1,4 @@
-require "hash_police/police"
+require "hash_police"
 require "json"
 
 describe HashPolice::Police do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_police
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Yang-Hsing Lin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-14 00:00:00.000000000 Z
+date: 2014-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,8 +69,10 @@ files:
 - lib/hash_police.rb
 - lib/hash_police/check_result.rb
 - lib/hash_police/police.rb
+- lib/hash_police/rspec_matcher.rb
 - lib/hash_police/version.rb
 - spec/hash_police/check_result_spec.rb
+- spec/hash_police/matcher_spec.rb
 - spec/hash_police/police_spec.rb
 homepage: ''
 licenses:
@@ -92,10 +94,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: a gem to check whether given to hashes are of the same format
 test_files:
 - spec/hash_police/check_result_spec.rb
+- spec/hash_police/matcher_spec.rb
 - spec/hash_police/police_spec.rb