json_spec 0.3.0 → 0.4.0

data/README.md

@@ -18,7 +18,7 @@ Please help write documentation!
 
 Continuous Integration
 ----------------------
-[![Build Status](https://travis-ci.org/collectiveidea/json_spec.png)](http://travis-ci.org/collectiveidea/json_spec)
+[![Build Status](https://secure.travis-ci.org/collectiveidea/json_spec.png)](http://travis-ci.org/collectiveidea/json_spec)
 
 RSpec
 --------------

data/lib/json_spec/cucumber.rb

@@ -7,7 +7,7 @@ After do
 end
 
 When /^(?:I )?keep the (?:JSON|json)(?: response)?(?: at "(.*)")? as "(.*)"$/ do |path, key|
-  JsonSpec.memorize(key, path ? json_at_path(last_json, path) : last_json)
+  JsonSpec.memorize(key, normalize_json(last_json, path))
 end
 
 Then /^the (?:JSON|json)(?: response)?(?: at "(.*)")? should( not)? be:$/ do |path, negative, json|

data/lib/json_spec/helpers.rb

@@ -2,39 +2,43 @@ module JsonSpec
   module Helpers
     extend self
 
-    def json_at_path(json, path)
-      pretty_json_value(ruby_at_json_path(json, path))
+    def parse_json(json, path = nil)
+      ruby = JSON.parse(%([#{json}])).first
+      value_at_json_path(ruby, path)
+    rescue JSON::ParserError
+      JSON.parse(json)
+    end
+
+    def normalize_json(json, path = nil)
+      ruby = parse_json(json, path)
+      generate_normalized_json(ruby)
     end
 
-    def pretty_json_value(ruby)
+    def generate_normalized_json(ruby)
       case ruby
       when Hash, Array then JSON.pretty_generate(ruby)
       else ruby.to_json
       end
     end
 
-    def ruby_at_json_path(json, path)
-      json_path_to_keys(path).inject(parse_json_value(json)) do |value, key|
-        case value
-        when Hash, Array then value.fetch(key){ missing_json_path!(path) }
-        else missing_json_path!(path)
+    private
+      def value_at_json_path(ruby, path)
+        return ruby unless path
+
+        json_path_to_keys(path).inject(ruby) do |value, key|
+          case value
+          when Hash, Array then value.fetch(key){ missing_json_path!(path) }
+          else missing_json_path!(path)
+          end
         end
       end
-    end
-
-    def json_path_to_keys(path)
-      path.to_s.gsub(/(?:^\/|\/$)/, "").split("/").map{|k| k =~ /^\d+$/ ? k.to_i : k }
-    end
 
-    def parse_json_value(json)
-      JSON.parse(%({"root":#{json}}))["root"]
-    rescue JSON::ParserError
-      # Re-raise more appropriate parsing error
-      JSON.parse(json)
-    end
+      def json_path_to_keys(path)
+        path.split("/").map{|k| k =~ /^\d+$/ ? k.to_i : k }
+      end
 
-    def missing_json_path!(path)
-      raise JsonSpec::MissingPathError.new(path)
-    end
+      def missing_json_path!(path)
+        raise JsonSpec::MissingPathError.new(path)
+      end
   end
 end

data/lib/json_spec/matchers.rb

@@ -36,8 +36,7 @@ RSpec::Matchers.define :be_json_eql do |expected_json|
   end
 
   def scrub(json, path = nil)
-    ruby = path ? ruby_at_json_path(json, path) : parse_json_value(json)
-    pretty_json_value(exclude_keys(ruby)).chomp + "\n"
+    generate_normalized_json(exclude_keys(parse_json(json, path))).chomp + "\n"
   end
 
   def exclude_keys(ruby)
@@ -67,7 +66,7 @@ RSpec::Matchers.define :have_json_path do |path|
 
   match do |json|
     begin
-      ruby_at_json_path(json, path)
+      parse_json(json, path)
       true
     rescue JsonSpec::MissingPathError
       false
@@ -87,8 +86,7 @@ RSpec::Matchers.define :have_json_type do |klass|
   include JsonSpec::Helpers
 
   match do |json|
-    ruby = @path ? ruby_at_json_path(json, @path) : parse_json_value(json)
-    ruby.is_a?(klass)
+    parse_json(json, @path).is_a?(klass)
   end
 
   chain :at_path do |path|
@@ -112,7 +110,7 @@ RSpec::Matchers.define :have_json_size do |expected_size|
   include JsonSpec::Helpers
 
   match do |json|
-    ruby = @path ? ruby_at_json_path(json, @path) : parse_json_value(json)
+    ruby = parse_json(json, @path)
     actual_size = ruby.is_a?(Enumerable) ? ruby.size : 1
     actual_size == expected_size
   end

data/lib/json_spec/version.rb

@@ -1,3 +1,3 @@
 module JsonSpec
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/json_spec/helpers_spec.rb

@@ -0,0 +1,74 @@
+require "spec_helper"
+
+describe JsonSpec::Helpers do
+  include described_class
+
+  context "parse_json" do
+    it "parses JSON documents" do
+      parse_json(%({"json":["spec"]})).should == {"json" => ["spec"]}
+    end
+
+    it "parses JSON values" do
+      parse_json(%("json_spec")).should == "json_spec"
+    end
+
+    it "raises a parser error for invalid JSON" do
+      expect{ parse_json("json_spec") }.to raise_error(JSON::ParserError)
+    end
+
+    it "parses at a path if given" do
+      json = %({"json":["spec"]})
+      parse_json(json, "json").should == ["spec"]
+      parse_json(json, "json/0").should == "spec"
+    end
+
+    it "raises an error for a missing path" do
+      json = %({"json":["spec"]})
+      %w(spec json/1).each do |path|
+        expect{ parse_json(json, path) }.to raise_error(JsonSpec::MissingPathError)
+      end
+    end
+  end
+
+  context "normalize_json" do
+    it "normalizes a JSON document" do
+      normalized = <<-JSON
+{
+  "json": [
+    "spec"
+  ]
+}
+      JSON
+      normalize_json(%({"json":["spec"]})).should == normalized.chomp
+    end
+
+    it "normalizes at a path" do
+      normalize_json(%({"json":["spec"]}), "json/0").should == %("spec")
+    end
+
+    it "accepts a JSON value" do
+      normalize_json(%("json_spec")).should == %("json_spec")
+    end
+
+    it "normalizes JSON values" do
+      normalize_json(%(1e+1)).should == %(10.0)
+    end
+  end
+
+  context "generate_normalized_json" do
+    it "generates a normalized JSON document" do
+      normalized = <<-JSON
+{
+  "json": [
+    "spec"
+  ]
+}
+      JSON
+      generate_normalized_json({"json" => ["spec"]}).should == normalized.chomp
+    end
+
+    it "generates a normalized JSON value" do
+      generate_normalized_json(nil).should == %(null)
+    end
+  end
+end

data/spec/json_spec/matchers_spec.rb

@@ -18,6 +18,14 @@ describe "Matchers:" do
       %(["json","spec"]).should_not be_json_eql(%(["spec","json"]))
     end
 
+    it "matches valid JSON values, yet invalid JSON documents" do
+      %("json_spec").should be_json_eql(%("json_spec"))
+    end
+
+    it "matches at a path" do
+      %({"json":["spec"]}).should be_json_eql(%("spec")).at_path("json/0")
+    end
+
     it "ignores excluded-by-default hash keys" do
       JsonSpec.excluded_keys.should_not be_empty
 
@@ -45,9 +53,13 @@ describe "Matchers:" do
       %({"one":1}).should_not be_json_eql(%({"one":1.0}))
     end
 
+    it "matches different looking, JSON-equivalent values" do
+      %({"ten":10.0}).should be_json_eql(%({"ten":1e+1}))
+    end
+
     it "excludes extra hash keys per matcher" do
       JsonSpec.excluded_keys = %w(ignore)
-      %({"id":1,"json":"spec","ignore":"please"}).should be_json_eql(%({"id":"2","json":"spec","ignore":"this"})).excluding("id")
+      %({"id":1,"json":"spec","ignore":"please"}).should be_json_eql(%({"id":2,"json":"spec","ignore":"this"})).excluding("id")
     end
 
     it "excludes extra hash keys given as symbols" do
@@ -57,7 +69,7 @@ describe "Matchers:" do
 
     it "includes globally-excluded hash keys per matcher" do
       JsonSpec.excluded_keys = %w(id ignore)
-      %({"id":1,"json":"spec","ignore":"please"}).should_not be_json_eql(%({"id":"2","json":"spec","ignore":"this"})).including("id")
+      %({"id":1,"json":"spec","ignore":"please"}).should_not be_json_eql(%({"id":2,"json":"spec","ignore":"this"})).including("id")
     end
 
     it "includes globally-included hash keys given as symbols" do
@@ -82,6 +94,10 @@ describe "Matchers:" do
     it "counts null hash values" do
       %({"one":1,"two":null,"three":3}).should have_json_size(3)
     end
+
+    it "matches at a path" do
+      %({"one":[1,2,3]}).should have_json_size(3).at_path("one")
+    end
   end
 
   context "have_json_path" do
@@ -105,4 +121,58 @@ describe "Matchers:" do
       %({"one":[1,2,{"three":4}]}).should have_json_path("one/2/three")
     end
   end
+
+  context "have_json_type" do
+    it "matches hashes" do
+      %({}).should have_json_type(Hash)
+    end
+
+    it "matches arrays" do
+      %([]).should have_json_type(Array)
+    end
+
+    it "matches at a path" do
+      %({"root":[]}).should have_json_type(Array).at_path("root")
+    end
+
+    it "matches strings" do
+      %(["json_spec"]).should have_json_type(String).at_path("0")
+    end
+
+    it "matches a valid JSON value, yet invalid JSON document" do
+      %("json_spec").should have_json_type(String)
+    end
+
+    it "matches empty strings" do
+      %("").should have_json_type(String)
+    end
+
+    it "matches integers" do
+      %(10).should have_json_type(Integer)
+    end
+
+    it "matches floats" do
+      %(10.0).should have_json_type(Float)
+      %(1e+1).should have_json_type(Float)
+    end
+
+    it "matches ancestor classes" do
+      %(10).should have_json_type(Numeric)
+      %(10.0).should have_json_type(Numeric)
+    end
+
+    context "somewhat uselessly" do
+      it "matches true" do
+        %(true).should have_json_type(TrueClass)
+      end
+
+      it "matches false" do
+        %(false).should have_json_type(FalseClass)
+      end
+
+      it "matches null" do
+        %(null).should have_json_type(NilClass)
+      end
+    end
+  end
 end

data/spec/json_spec/memory_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe JsonSpec::Memory do
+  it "has a memory" do
+    JsonSpec.memory.should == {}
+  end
+
+  it "memorizes strings" do
+    JsonSpec.memorize("key", "value")
+    JsonSpec.memory.should == {"key" => "value"}
+  end
+
+  it "regurgitates unremembered strings" do
+    JsonSpec.remember("foo%{bar}").should == "foo%{bar}"
+  end
+
+  it "remembers strings" do
+    JsonSpec.memorize("bar", "baz")
+    JsonSpec.remember("foo%{bar}").should == "foobaz"
+  end
+
+  it "forgets" do
+    JsonSpec.memorize("key", "value")
+    JsonSpec.forget
+    JsonSpec.memory.should == {}
+  end
+end

metadata

@@ -1,93 +1,68 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: json_spec
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 0
-  version: 0.3.0
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Steve Richert
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-08 00:00:00 -04:00
+date: 2011-07-09 00:00:00.000000000 -04:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2155974100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2155974100
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2155973600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2155973600
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2155973140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 0
-        - 9
-        version: "0.9"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: cucumber
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2155973140
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &2155972680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: *2155972680
 description: Easily handle JSON in RSpec and Cucumber
-email: 
+email:
 - steve.richert@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -111,44 +86,36 @@ files:
 - lib/json_spec/memory.rb
 - lib/json_spec/version.rb
 - spec/json_spec/configuration_spec.rb
+- spec/json_spec/helpers_spec.rb
 - spec/json_spec/matchers_spec.rb
-- spec/json_spec_spec.rb
+- spec/json_spec/memory_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: https://github.com/collectiveidea/json_spec
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: json_spec
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Easily handle JSON in RSpec and Cucumber
-test_files: 
+test_files:
 - features/equivalence.feature
 - features/memory.feature
 - features/paths.feature
@@ -157,6 +124,7 @@ test_files:
 - features/support/env.rb
 - features/types.feature
 - spec/json_spec/configuration_spec.rb
+- spec/json_spec/helpers_spec.rb
 - spec/json_spec/matchers_spec.rb
-- spec/json_spec_spec.rb
+- spec/json_spec/memory_spec.rb
 - spec/spec_helper.rb

data/spec/json_spec_spec.rb

@@ -1,5 +0,0 @@
-require "spec_helper"
-
-describe JsonSpec do
-  it "is awesome"
-end