hash_police 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f65798cbb95f63baf5b4f55050286e2851afee7e
-  data.tar.gz: 3593e76d36b0ad927a599326674e9e586ab15baa
+SHA256:
+  metadata.gz: 24ca713c2b5c7674966ed42c6d012f6c66a61b82cc0691a7ef5b827f1043d7fc
+  data.tar.gz: 95ef82b51da21bc0af612ab7faab6218dbed5a1ec8aebee5c95b4457de7b1e06
 SHA512:
-  metadata.gz: d12c3d9b8750e6c56a5eb82614fe57a65c062da82a1c3228bc4c11b2267b770b673b39fc412dca63a90cba9789f8c8acfec9fdd3d7fdded8ebc4d4e7b4861cd8
-  data.tar.gz: 0493195b05a025b247ae87b09b437af736a7236b0da1e161845f9440e1b962bd7e2ed453e9a5154cb25ce5c3fd4ebfc72caf1609e6ef541a41ef45da3e623d6a
+  metadata.gz: f08b0e1e80b925f645fb26ba9e24f19c38b13f886a6237aa4e6779e441941e137f0585da10c991304d0db822f200e5d3d619b937e229d82eeb3f229cf2efe34b
+  data.tar.gz: '08f59271fd3f1ebbcbc2e07113e26e524e2c327c8bcffd342b22c0335cb049ecbf99654dd3366dc920fc9223ffabbb34b8c4646587d114b3e7444ce17d9ac509'

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.3.0
+script:
+  - bundle install
+  - rspec

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+
+0.0.4 / 2014-11-12
+==================
+
+* Add RSpec matcher
+* Implement basic matching APIs

data/README.md

@@ -1,3 +1,6 @@
+[![Build Status](https://travis-ci.org/mz026/hash_police.svg?branch=master)](https://travis-ci.org/mz026/hash_police)
+[![Code Climate](https://codeclimate.com/github/mz026/hash_police/badges/gpa.svg)](https://codeclimate.com/github/mz026/hash_police)
+
 # HashPolice
 A gem to check whether given to hashes are of the same format
 

data/TODO.md

@@ -0,0 +1,3 @@
+# TODOs
+
+* add an option to treat symbol-key and string-key differently

data/lib/hash_police/check_result.rb

@@ -33,4 +33,8 @@ class HashPolice::CheckResult
   def passed?
     all_errors.empty?
   end
+
+  def invalid_by_proc
+    @errors << "`#{context_key}` is invalid given Proc fucntion"
+  end
 end

data/lib/hash_police/police.rb

@@ -12,6 +12,11 @@ module HashPolice
 
     def check target
       result = CheckResult.new(context_key)
+      if rule.kind_of?(Proc) && ! rule.call(target)
+        result.invalid_by_proc
+        return result
+      end
+
       unless type_matched?(rule, target)
         result.differ_type(:expect => rule.class, :got => target.class)
         return result
@@ -47,6 +52,9 @@ module HashPolice
     private
     def type_matched? rule, target
       return true if bool?(rule) && bool?(target)
+      if rule.kind_of?(Proc)
+        return !!rule.call(target)
+      end
       rule.class == target.class
     end
 
@@ -59,8 +67,10 @@ module HashPolice
     end
 
     def stringify_keys hash
-      JSON.parse(hash.to_json, :quirks_mode => true)
+      hash.reduce({}) do |memo,(k,v)|
+        memo[k.to_s] = v
+        memo
+      end
     end
-
   end
 end

data/lib/hash_police/rspec_matcher.rb

@@ -1,12 +1,12 @@
 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

data/lib/hash_police/version.rb

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

data/spec/hash_police/check_result_spec.rb

@@ -14,14 +14,14 @@ describe HashPolice::CheckResult do
     context "when without children" do
       it "returns plain reason" do
         result.differ_type(:expect => String, :got => Fixnum)
-        result.error_messages.should == "`the-key`: expect String, got Fixnum"
+        expect(result.error_messages).to eq("`the-key`: expect String, got Fixnum")
       end
     end
 
     context "when with children" do
       it "returns message with children's ones" do
         children = [1,2,3].map do |i|
-          child = HashPolice::CheckResult.new("key-#{i}") 
+          child = HashPolice::CheckResult.new("key-#{i}")
           result.concat(child)
           child
         end
@@ -29,42 +29,42 @@ describe HashPolice::CheckResult do
         children[1].differ_type(:expect => String, :got => Fixnum)
         children[2].missing
 
-        result.error_messages.should == "`key-2`: expect String, got Fixnum\n`key-3`: missing"
+        expect(result.error_messages)
+          .to eq( "`key-2`: expect String, got Fixnum\n`key-3`: missing")
       end
     end
-
   end
 
   describe "#missing(key = nil)" do
     it "adds missing message to errors" do
       result.missing
 
-      result.error_messages.should == "`#{context_key}`: missing"
+      expect(result.error_messages).to eq("`#{context_key}`: missing")
     end
 
     it "assigns missing key if given" do
       result.missing("the-key")
 
-      result.error_messages.should == "`the-key`: missing"
+      expect(result.error_messages).to eq("`the-key`: missing")
     end
   end
 
   describe "#differ_type(:expect => Class1, :got => Class2)" do
     it "adds message to error_messages" do
       result.differ_type(:expect => String, :got => Array)
-      result.error_messages.should == "`#{context_key}`: expect String, got Array"
+      expect(result.error_messages).to eq("`#{context_key}`: expect String, got Array")
     end
   end
 
   describe "passed?" do
     it "returns true if all_errors empty" do
-      result.passed?.should == true
+      expect(result).to be_passed
     end
 
     it "returns false if all_errors not empty" do
       result.missing
 
-      result.passed?.should == false
+      expect(result).not_to be_passed
     end
   end
 
@@ -74,4 +74,11 @@ describe HashPolice::CheckResult do
       result.concat(child)
     end
   end
+
+  describe "#invalid_by_proc" do
+    it "adds message to error_messages" do
+      result.invalid_by_proc
+      expect(result.error_messages).to eq("`#{context_key}` is invalid given Proc fucntion")
+    end
+  end
 end

data/spec/hash_police/police_spec.rb

@@ -15,17 +15,36 @@ describe HashPolice::Police do
     let(:result) { double(:result, :concat => nil ) }
 
     before(:each) do
-      HashPolice::CheckResult.stub(:new).and_return(result)
+      allow(HashPolice::CheckResult).to receive(:new).and_return(result)
     end
 
     context "when rule is scalar value" do
       it "passes if a string" do
-        HashPolice::CheckResult.stub(:new => double)
+        allow(HashPolice::CheckResult).to receive(:new).and_return(double)
         police.check "another string"
       end
 
       it "failed if type not match" do
-        result.should_receive(:differ_type).with(:expect => String, :got => Fixnum)
+        expect(result).to receive(:differ_type).with(:expect => String, :got => Fixnum)
+        police.check 12345
+      end
+    end
+
+    context "when rule is scalar value and rule is kind of Proc" do
+      let(:rule) { lambda { |str| str.nil? || str.kind_of?(String) } }
+
+      it "passes if a string" do
+        allow(HashPolice::CheckResult).to receive(:new).and_return(double)
+        police.check('yo')
+      end
+
+      it "passes if a nil" do
+        allow(HashPolice::CheckResult).to receive(:new).and_return(double)
+        police.check(nil)
+      end
+
+      it "fails if lambda return false" do
+        expect(result).to receive(:invalid_by_proc)
         police.check 12345
       end
     end
@@ -36,9 +55,9 @@ describe HashPolice::Police do
       let(:nested_result2) { double(:nested_result2) }
 
       before(:each) do
-        HashPolice::CheckResult.stub(:new).and_return(result, 
-                                                      nested_result1,
-                                                      nested_result2)
+        allow(HashPolice::CheckResult).to receive(:new).and_return(result,
+                                                                   nested_result1,
+                                                                   nested_result2)
       end
 
       it "passes if target is an of the same type" do
@@ -46,14 +65,14 @@ describe HashPolice::Police do
       end
 
       it "failed if target is not an array" do
-        result.should_receive(:differ_type).with(:expect => Array, :got => Fixnum)
+        expect(result).to receive(:differ_type).with(:expect => Array, :got => Fixnum)
         police.check 12345
       end
 
       it "faild if not all elements are of the same type" do
-        result.should_receive(:concat).with(nested_result1)
-        result.should_receive(:concat).with(nested_result2)
-        nested_result2.should_receive(:differ_type).with(:expect => Fixnum, :got => String)
+        expect(result).to receive(:concat).with(nested_result1)
+        expect(result).to receive(:concat).with(nested_result2)
+        expect(nested_result2).to receive(:differ_type).with(:expect => Fixnum, :got => String)
 
         police.check [ 123, "string" ]
       end
@@ -75,11 +94,11 @@ describe HashPolice::Police do
       let(:result_key) { double(:result_key) }
 
       before(:each) do
-        HashPolice::CheckResult.stub(:new).and_return(result, 
-                                                      result_name,
-                                                      result_married,
-                                                      result_nested,
-                                                      result_key)
+        allow(HashPolice::CheckResult).to receive(:new).and_return(result,
+                                                                   result_name,
+                                                                   result_married,
+                                                                   result_nested,
+                                                                   result_key)
       end
 
       it "passes if all keys are matched" do
@@ -93,26 +112,28 @@ describe HashPolice::Police do
       end
 
       it "failed if missing key" do
-        HashPolice::CheckResult.stub(:new).and_return(result, 
-                                                      result_married,
-                                                      result_nested,
-                                                      result_key)
+        allow(HashPolice::CheckResult).to receive(:new).and_return(result,
+                                                                   result_married,
+                                                                   result_nested,
+                                                                   result_key)
+
         target.delete :name
-        result.should_receive(:missing).with("name")
+        expect(result).to receive(:missing).with("name")
 
         police.check(target)
       end
 
       it "failed if expect string but nil" do
         target[:nested] = { :key => nil }
-        result_key.should_receive(:differ_type).with(:expect => String, :got => NilClass)
+        expect(result_key).to receive(:differ_type).with(:expect => String, :got => NilClass)
 
         police.check(target)
       end
 
       it "failed if nested key missing" do
         target[:nested] = {}
-        result_nested.should_receive(:missing).with("nested.key")
+
+        expect(result_nested).to receive(:missing).with("nested.key")
 
         police.check(target)
       end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: hash_police
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Yang-Hsing Lin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-18 00:00:00.000000000 Z
+date: 2018-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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: a gem to check whether given to hashes are of the same format
@@ -59,12 +59,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - hash_police.gemspec
 - lib/hash_police.rb
 - lib/hash_police/check_result.rb
@@ -84,17 +87,17 @@ 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.4.2
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: a gem to check whether given to hashes are of the same format