json_spec 0.5.0 → 0.6.0

data/.travis.yml

@@ -3,3 +3,9 @@ rvm:
   - 1.8.7
   - 1.9.2
   - ruby-head
+  - rbx
+  - jruby
+only:
+  - master
+notifications:
+  disabled: true

data/README.md

@@ -22,9 +22,10 @@ Continuous Integration
 
 RSpec
 --------------
-json_spec defines four new RSpec matchers:
+json_spec defines five new RSpec matchers:
 
 * `be_json_eql`
+* `include_json`
 * `have_json_path`
 * `have_json_type`
 * `have_json_size`
@@ -50,6 +51,7 @@ The new matchers could be used in RSpec as follows:
           json.should have_json_size(0).at_path("friends")
           user.friends << User.create!(:first_name => "Catie", :last_name => "Richert")
           json.should have_json_size(1).at_path("friends")
+          json.should include_json(%({"first_name":"Catie","last_name":"Richert"}))
         end
       end
     end
@@ -170,6 +172,39 @@ different formats:
     Then the JSON at "path" should be false
     Then the JSON at "path" should be null
 
+    Then the JSON should include:
+      """
+      {
+        "key": "value"
+      }
+      """
+    Then the JSON at "path" should include:
+      """
+      [
+        "entry",
+        "entry"
+      ]
+      """
+
+    Then the JSON should include {"key":"value"}
+    Then the JSON at "path" should include {"key":"value"}
+    Then the JSON should include ["entry","entry"]
+    Then the JSON at "path" should include ["entry","entry"]
+    Then the JSON should include "string"
+    Then the JSON at "path" should include "string"
+    Then the JSON should include 10
+    Then the JSON at "path" should include 10
+    Then the JSON should include 10.0
+    Then the JSON at "path" should include 10.0
+    Then the JSON should include 1e+1
+    Then the JSON at "path" should include 1e+1
+    Then the JSON should include true
+    Then the JSON at "path" should include true
+    Then the JSON should include false
+    Then the JSON at "path" should include false
+    Then the JSON should include null
+    Then the JSON at "path" should include null
+
     Then the JSON should have "path"
 
     Then the JSON should be a hash

data/features/inclusion.feature

@@ -0,0 +1,154 @@
+Feature: Inclusion
+  Background:
+    Given the JSON is:
+      """
+      {
+        "array": [
+          "json",
+          "spec"
+        ],
+        "created_at": "2011-07-08 02:27:34",
+        "empty_array": [
+
+        ],
+        "empty_hash": {
+        },
+        "false": false,
+        "float": 10.0,
+        "hash": {
+          "json": "spec"
+        },
+        "id": 1,
+        "integer": 10,
+        "negative": -10,
+        "null": null,
+        "string": "json_spec",
+        "true": true,
+        "updated_at": "2011-07-08 02:28:50",
+        "nested": {
+          "id": 2,
+          "key": "value"
+        }
+      }
+      """
+
+  Scenario: String
+    When I get the JSON
+    Then the JSON should include "json_spec"
+    And the JSON should include:
+      """
+      "json_spec"
+      """
+
+  Scenario: Integer
+    When I get the JSON
+    Then the JSON should include 10
+    And the JSON should include:
+      """
+      10
+      """
+
+  Scenario: Negative integer
+    When I get the JSON
+    Then the JSON should include -10
+    And the JSON should include:
+      """
+      -10
+      """
+
+  Scenario: Float
+    When I get the JSON
+    Then the JSON should include 10.0
+    And the JSON should include 10.0e0
+    And the JSON should include 10.0e+0
+    And the JSON should include 10.0e-0
+    And the JSON should include 10e0
+    And the JSON should include 10e+0
+    And the JSON should include 10e-0
+    And the JSON should include 1.0e1
+    And the JSON should include 1.0e+1
+    And the JSON should include 1e1
+    And the JSON should include 1e+1
+    And the JSON should include 100.0e-1
+    And the JSON should include 100e-1
+    And the JSON should include:
+      """
+      10.0
+      """
+
+  Scenario: Array
+    When I get the JSON
+    Then the JSON should include ["json","spec"]
+    And the JSON at "array" should include "json"
+    And the JSON at "array" should include "spec"
+    And the JSON should include:
+      """
+      [
+        "json",
+        "spec"
+      ]
+      """
+
+  Scenario: Empty array
+    When I get the JSON
+    Then the JSON should include []
+    And the JSON should include:
+      """
+      [
+
+      ]
+      """
+
+  Scenario: Hash
+    When I get the JSON
+    Then the JSON should include {"json":"spec"}
+    And the JSON at "hash" should include "spec"
+    And the JSON should include:
+      """
+      {
+        "json": "spec"
+      }
+      """
+
+  Scenario: Empty hash
+    When I get the JSON
+    Then the JSON should include {}
+    And the JSON should include:
+      """
+      {
+      }
+      """
+
+  Scenario: True
+    When I get the JSON
+    Then the JSON should include true
+    And the JSON should include:
+      """
+      true
+      """
+
+  Scenario: False
+    When I get the JSON
+    Then the JSON should include false
+    And the JSON should include:
+      """
+      false
+      """
+
+  Scenario: Null
+    When I get the JSON
+    Then the JSON should include null
+    And the JSON should include:
+      """
+      null
+      """
+
+  Scenario: Excluded value
+    When I get the JSON
+    Then the JSON should include "2011-07-08 02:27:34"
+    And the JSON should include 1
+    And the JSON should include "2011-07-08 02:28:50"
+
+  Scenario: Nested exclusions
+    When I get the JSON
+    Then the JSON should include {"key":"value"}

data/features/memory.feature

@@ -182,3 +182,40 @@ Feature: Memory
         "true": true
       }
       """
+
+  Scenario: Table format
+    When I keep the JSON at "string" as "STRING"
+    And I keep the JSON at "integer" as "INTEGER"
+    And I keep the JSON at "float" as "FLOAT"
+    And I keep the JSON at "array" as "ARRAY"
+    And I keep the JSON at "hash" as "HASH"
+    And I keep the JSON at "true" as "TRUE"
+    And I keep the JSON at "false" as "FALSE"
+    And I keep the JSON at "null" as "NULL"
+    Then the JSON should have the following:
+      | string  | %{STRING}  |
+      | integer | %{INTEGER} |
+      | float   | %{FLOAT}   |
+      | array   | %{ARRAY}   |
+      | hash    | %{HASH}    |
+      | true    | %{TRUE}    |
+      | false   | %{FALSE}   |
+      | null    | %{NULL}    |
+
+  Scenario: Inclusion
+    When I keep the JSON at "string" as "STRING"
+    And I keep the JSON at "integer" as "INTEGER"
+    And I keep the JSON at "float" as "FLOAT"
+    And I keep the JSON at "array" as "ARRAY"
+    And I keep the JSON at "hash" as "HASH"
+    And I keep the JSON at "true" as "TRUE"
+    And I keep the JSON at "false" as "FALSE"
+    And I keep the JSON at "null" as "NULL"
+    Then the JSON should include %{STRING}
+    And the JSON should include %{INTEGER}
+    And the JSON should include %{FLOAT}
+    And the JSON should include %{ARRAY}
+    And the JSON should include %{HASH}
+    And the JSON should include %{TRUE}
+    And the JSON should include %{FALSE}
+    And the JSON should include %{NULL}

data/lib/json_spec.rb

@@ -1,6 +1,7 @@
 require "json_spec/version"
 require "json_spec/errors"
 require "json_spec/configuration"
+require "json_spec/exclusion"
 require "json_spec/matchers"
 require "json_spec/helpers"
 require "json_spec/memory"

data/lib/json_spec/cucumber.rb

@@ -26,6 +26,22 @@ Then /^the (?:JSON|json)(?: response)?(?: at "(.*)")? should( not)? be (".*"|\-?
   end
 end
 
+Then /^the (?:JSON|json)(?: response)?(?: at "(.*)")? should( not)? include:$/ do |path, negative, json|
+  if negative
+    last_json.should_not include_json(JsonSpec.remember(json)).at_path(path)
+  else
+    last_json.should include_json(JsonSpec.remember(json)).at_path(path)
+  end
+end
+
+Then /^the (?:JSON|json)(?: response)?(?: at "(.*)")? should( not)? include (".*"|\-?\d+(?:\.\d+)?(?:[eE][\+\-]?\d+)?|\[.*\]|%?\{.*\}|true|false|null)$/ do |path, negative, value|
+  if negative
+    last_json.should_not include_json(JsonSpec.remember(value)).at_path(path)
+  else
+    last_json.should include_json(JsonSpec.remember(value)).at_path(path)
+  end
+end
+
 Then /^the (?:JSON|json)(?: response)?(?: at "(.*)")? should have the following:$/ do |base, table|
   table.rows.each do |path, value|
     path = [base, path].compact.join("/")

data/lib/json_spec/exclusion.rb

@@ -0,0 +1,26 @@
+module JsonSpec
+  module Exclusion
+    extend self
+
+    def exclude_keys(ruby)
+      case ruby
+      when Hash
+        ruby.sort.inject({}) do |hash, (key, value)|
+          hash[key] = exclude_keys(value) unless exclude_key?(key)
+          hash
+        end
+      when Array
+        ruby.map{|v| exclude_keys(v) }
+      else ruby
+      end
+    end
+
+    def exclude_key?(key)
+      excluded_keys.include?(key)
+    end
+
+    def excluded_keys
+      @excluded_keys ||= Set.new(JsonSpec.excluded_keys)
+    end
+  end
+end

data/lib/json_spec/matchers.rb

@@ -3,6 +3,7 @@ require "rspec"
 
 RSpec::Matchers.define :be_json_eql do |expected_json|
   include JsonSpec::Helpers
+  include JsonSpec::Exclusion
 
   diffable
 
@@ -38,26 +39,44 @@ RSpec::Matchers.define :be_json_eql do |expected_json|
   def scrub(json, path = nil)
     generate_normalized_json(exclude_keys(parse_json(json, path))).chomp + "\n"
   end
+end
+
+RSpec::Matchers.define :include_json do |expected_json|
+  include JsonSpec::Helpers
+  include JsonSpec::Exclusion
 
-  def exclude_keys(ruby)
-    case ruby
-    when Hash
-      ruby.sort.inject({}) do |hash, (key, value)|
-        hash[key] = exclude_keys(value) unless exclude_key?(key)
-        hash
-      end
-    when Array
-      ruby.map{|v| exclude_keys(v) }
-    else ruby
+  match do |actual_json|
+    actual = parse_json(actual_json, @path)
+    expected = exclude_keys(parse_json(expected_json))
+    case actual
+    when Hash then actual.values.map{|v| exclude_keys(v) }.include?(expected)
+    when Array then actual.map{|e| exclude_keys(e) }.include?(expected)
+    else false
     end
   end
 
-  def exclude_key?(key)
-    excluded_keys.include?(key)
+  chain :at_path do |path|
+    @path = path
+  end
+
+  chain :excluding do |*keys|
+    excluded_keys.add(*keys.map{|k| k.to_s })
+  end
+
+  chain :including do |*keys|
+    excluded_keys.subtract(keys.map{|k| k.to_s })
   end
 
-  def excluded_keys
-    @excluded_keys ||= Set.new(JsonSpec.excluded_keys)
+  failure_message_for_should do
+    message = "Expected included JSON"
+    message << %( at path "#{@path}") if @path
+    message
+  end
+
+  failure_message_for_should_not do
+    message = "Expected excluded JSON"
+    message << %( at path "#{@path}") if @path
+    message
   end
 end
 

data/lib/json_spec/version.rb

@@ -1,3 +1,3 @@
 module JsonSpec
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/spec/json_spec/matchers_spec.rb

@@ -78,6 +78,60 @@ describe "Matchers:" do
     end
   end
 
+  context "include_json" do
+    it "matches included array elements" do
+      json = %(["one",1,1.0,true,false,null])
+      json.should include_json(%("one"))
+      json.should include_json(%(1))
+      json.should include_json(%(1.0))
+      json.should include_json(%(true))
+      json.should include_json(%(false))
+      json.should include_json(%(null))
+    end
+
+    it "matches an array included in an array" do
+      json = %([[1,2,3],[4,5,6]])
+      json.should include_json(%([1,2,3]))
+      json.should include_json(%([4,5,6]))
+    end
+
+    it "matches a hash included in an array" do
+      json = %([{"one":1},{"two":2}])
+      json.should include_json(%({"one":1}))
+      json.should include_json(%({"two":2}))
+    end
+
+    it "matches include hash values" do
+      json = %({"string":"one","integer":1,"float":1.0,"true":true,"false":false,"null":null})
+      json.should include_json(%("one"))
+      json.should include_json(%(1))
+      json.should include_json(%(1.0))
+      json.should include_json(%(true))
+      json.should include_json(%(false))
+      json.should include_json(%(null))
+    end
+
+    it "matches a hash included in a hash" do
+      json = %({"one":{"two":3},"four":{"five":6}})
+      json.should include_json(%({"two":3}))
+      json.should include_json(%({"five":6}))
+    end
+
+    it "matches an array included in a hash" do
+      json = %({"one":[2,3],"four":[5,6]})
+      json.should include_json(%([2,3]))
+      json.should include_json(%([5,6]))
+    end
+
+    it "matches at a path" do
+      %({"one":{"two":[3,4]}}).should include_json(%([3,4])).at_path("one")
+    end
+
+    it "ignores excluded keys" do
+      %([{"id":1,"two":3}]).should include_json(%({"two":3}))
+    end
+  end
+
   context "have_json_size" do
     it "counts array entries" do
       %([1,2,3]).should have_json_size(3)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_spec
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-10 00:00:00.000000000 -04:00
+date: 2011-07-20 00:00:00.000000000 -04:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2156046080 !ruby/object:Gem::Requirement
+  requirement: &70202465651180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156046080
+  version_requirements: *70202465651180
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156045580 !ruby/object:Gem::Requirement
+  requirement: &70202465650680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156045580
+  version_requirements: *70202465650680
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156045120 !ruby/object:Gem::Requirement
+  requirement: &70202465650220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *2156045120
+  version_requirements: *70202465650220
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &2156044660 !ruby/object:Gem::Requirement
+  requirement: &70202465649760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,7 +55,7 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *2156044660
+  version_requirements: *70202465649760
 description: Easily handle JSON in RSpec and Cucumber
 email:
 - steve.richert@gmail.com
@@ -70,6 +70,7 @@ files:
 - README.md
 - Rakefile
 - features/equivalence.feature
+- features/inclusion.feature
 - features/memory.feature
 - features/paths.feature
 - features/sizes.feature
@@ -81,6 +82,7 @@ files:
 - lib/json_spec/configuration.rb
 - lib/json_spec/cucumber.rb
 - lib/json_spec/errors.rb
+- lib/json_spec/exclusion.rb
 - lib/json_spec/helpers.rb
 - lib/json_spec/matchers.rb
 - lib/json_spec/memory.rb
@@ -117,6 +119,7 @@ specification_version: 3
 summary: Easily handle JSON in RSpec and Cucumber
 test_files:
 - features/equivalence.feature
+- features/inclusion.feature
 - features/memory.feature
 - features/paths.feature
 - features/sizes.feature