jsontest 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 86fd405580154f153393a0b56f41fe40e9b924f0adff461d99a6b5750535e9dc
+  data.tar.gz: bca245249d098f4ed747715366a9cd0ea1b073b04b104e67af0fdcf404640594
+SHA512:
+  metadata.gz: e4679a1d08234e627f32f2a468c915e37fbd92efa0b7f9135d3c785d5c40aea0c7634304c10f2340bf6b28b266d5b9213818ac3bd8b07df79fccb6a871d7e8c1
+  data.tar.gz: 2658206af8504222888eb3993399622d159b760ed292ca6814872719718708e09e77d299d59b276810fa328f523e284b0e139a5f40daa7145dab13a35a1ff655

data/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+Gemfile.lock
+gemfiles/*.lock
+pkg

data/.travis.yml

@@ -0,0 +1,21 @@
+after_success:
+  - bundle exec codeclimate-test-reporter
+branches:
+  only:
+    - master
+gemfile:
+  - gemfiles/rspec2.gemfile
+  - gemfiles/rspec3.gemfile
+language: ruby
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: "2.0"
+    - rvm: "2.1"
+rvm:
+  - "2.0"
+  - "2.1"
+  - "2.2.7"
+  - "2.3.4"
+  - "2.4.1"
+  - ruby-head

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## Unreleased (master)
+
+- Added Changelog
+- Fix RSpec warnings for uninitialized instance variables on matchers [#78](https://github.com/collectiveidea/jsontest/pull/78)
+
+## Version 1.1.4
+
+- Raise error when checking a size of a json ruby value of nil [#82](https://github.com/collectiveidea/jsontest/pull/82)

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "codeclimate-test-reporter", "~> 1.0.0"
+  gem "cucumber", "~> 1.3"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright © 2018 Steve Richert, Michiel Boekhoff
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,343 @@
+# jsontest
+
+This is a fork of json_spec, including new features and fixes.
+
+Easily handle JSON in RSpec and Cucumber
+
+[![Gem Version](https://img.shields.io/gem/v/jsontest.svg?style=flat)](http://rubygems.org/gems/jsontest)
+[![Build Status](https://travis-ci.com/michielboekhoff/jsontest.svg?branch=master)](https://travis-ci.com/michielboekhoff/jsontest)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9db6abab1cc9ecfd5812/maintainability)](https://codeclimate.com/github/michielboekhoff/jsontest/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/9db6abab1cc9ecfd5812/test_coverage)](https://codeclimate.com/github/michielboekhoff/jsontest/test_coverage)
+
+## RSpec
+
+jsontest defines five new RSpec matchers:
+
+* `be_json_eql`
+* `include_json`
+* `have_json_path`
+* `have_json_type`
+* `have_json_size`
+
+The new matchers could be used in RSpec as follows:
+
+```ruby
+describe User do
+  let(:user){ User.create!(first_name: "Steve", last_name: "Richert") }
+
+  context "#to_json" do
+    it "includes names" do
+      names = %({"first_name":"Steve","last_name":"Richert"})
+      user.to_json.should be_json_eql(names).excluding("friends")
+    end
+
+    it "includes the ID" do
+      user.to_json.should have_json_path("id")
+      user.to_json.should have_json_type(Integer).at_path("id")
+    end
+
+    it "includes friends" do
+      user.to_json.should have_json_size(0).at_path("friends")
+
+      friend = User.create!(first_name: "Catie", last_name: "Richert")
+      user.friends << friend
+
+      user.to_json.should have_json_size(1).at_path("friends")
+      user.to_json.should include_json(friend.to_json)
+    end
+  end
+end
+```
+
+jsontest also provides some useful helpers for RSpec tests:
+
+* `parse_json`
+* `normalize_json`
+* `generate_normalized_json`
+* `load_json`
+
+To start using them add an include them in your RSpec configuration:
+
+```ruby
+RSpec.configure do |config|
+  config.include JsonTest::Helpers
+end
+```
+
+You can find usage examples for the helpers in [`spec/jsontest/helpers_spec.rb`](https://github.com/collectiveidea/jsontest/blob/master/spec/jsontest/helpers_spec.rb)
+
+### Exclusions
+
+jsontest ignores certain hash keys by default when comparing JSON:
+
+* `id`
+* `created_at`
+* `updated_at`
+
+It's oftentimes helpful when evaluating JSON representations of newly-created ActiveRecord records
+so that the new ID and timestamps don't have to be known. These exclusions are globally
+customizeable:
+
+```ruby
+JsonTest.configure do
+  exclude_keys "created_at", "updated_at"
+end
+```
+
+Now, the `id` key will be included in jsontest's comparisons. Keys can also be excluded/included
+per matcher by chaining the `excluding` or `including` methods (as shown above) which will add or
+subtract from the globally excluded keys, respectively.
+
+### Paths
+
+Each of jsontest's matchers deal with JSON "paths." These are simple strings of "/" separated
+hash keys and array indexes. For instance, with the following JSON:
+
+    {
+      "first_name": "Steve",
+      "last_name": "Richert",
+      "friends": [
+        {
+          "first_name": "Catie",
+          "last_name": "Richert"
+        }
+      ]
+    }
+
+We could access the first friend's first name with the path `"friends/0/first_name"`.
+
+## Cucumber
+
+jsontest provides Cucumber steps that utilize its RSpec matchers and that's where jsontest really
+shines. This is perfect for testing your app's JSON API.
+
+In order to use the Cucumber steps, in your `env.rb` you must:
+
+```ruby
+require "jsontest/cucumber"
+```
+
+You also need to define a `last_json` method. If you're using Capybara, it could be as simple as:
+
+```ruby
+def last_json
+  page.source
+end
+```
+
+Now, you can use the jsontest steps in your features:
+
+```cucumber
+Feature: User API
+  Background:
+    Given the following users exist:
+      | id | first_name | last_name |
+      | 1  | Steve      | Richert   |
+      | 2  | Catie      | Richert   |
+    And "Steve Richert" is friends with "Catie Richert"
+
+  Scenario: Index action
+    When I visit "/users.json"
+    Then the JSON response should have 2 users
+    And the JSON response at "0/id" should be 1
+    And the JSON response at "1/id" should be 2
+
+  Scenario: Show action
+    When I visit "/users/1.json"
+    Then the JSON response at "first_name" should be "Steve"
+    And the JSON response at "last_name" should be "Richert"
+    And the JSON response should have "created_at"
+    And the JSON response at "created_at" should be a string
+    And the JSON response at "friends" should be:
+      """
+      [
+        {
+          "id": 2,
+          "first_name": "Catie",
+          "last_name": "Richert"
+        }
+      ]
+      """
+```
+
+The background steps above aren't provided by jsontest and the "visit" steps are provided by
+Capybara. The remaining steps, jsontest provides. They're versatile and can be used in plenty of
+different formats:
+
+```cucumber
+Then the JSON should be:
+  """
+  {
+    "key": "value"
+  }
+  """
+Then the JSON at "path" should be:
+  """
+  [
+    "entry",
+    "entry"
+  ]
+  """
+
+Then the JSON should be {"key":"value"}
+Then the JSON at "path" should be {"key":"value"}
+Then the JSON should be ["entry","entry"]
+Then the JSON at "path" should be ["entry","entry"]
+Then the JSON at "path" should be "string"
+Then the JSON at "path" should be 10
+Then the JSON at "path" should be 10.0
+Then the JSON at "path" should be 1e+1
+Then the JSON at "path" should be true
+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
+Then the JSON at "path" should be an array
+Then the JSON at "path" should be a float
+
+Then the JSON should have 1 entry
+Then the JSON at "path" should have 2 entries
+Then the JSON should have 3 keys
+Then the JSON should have 4 whatevers
+```
+
+_All instances of "should" above could be followed by "not" and all instances of "JSON" could be downcased and/or followed by "response."_
+
+### Table Format
+
+Another step exists that uses Cucumber's table formatting and wraps two of the above steps:
+
+```cucumber
+Then the JSON should have the following:
+  | path/0 | {"key":"value"}   |
+  | path/1 | ["entry","entry"] |
+```
+
+Any number of rows can be given. The step above is equivalent to:
+
+```cucumber
+Then the JSON at "path/0" should be {"key":"value"}
+And the JSON at "path/1" should be ["entry","entry"]
+```
+
+If only one column is given:
+
+```cucumber
+Then the JSON should have the following:
+  | path/0 |
+  | path/1 |
+```
+
+This is equivalent to:
+
+```cucumber
+Then the JSON should have "path/0"
+And the JSON should have "path/1"
+```
+
+### JSON Memory
+
+There's one more Cucumber step that jsontest provides which hasn't been used above. It's used to
+memorize JSON for reuse in later steps. You can "keep" all or a portion of the JSON by giving a
+name by which to remember it.
+
+```cucumber
+Feature: User API
+  Scenario: Index action includes full user JSON
+    Given the following user exists:
+      | id | first_name | last_name |
+      | 1  | Steve      | Richert   |
+    And I visit "/users/1.json"
+    And I keep the JSON response as "USER_1"
+    When I visit "/users.json"
+    Then the JSON response should be:
+      """
+      [
+        %{USER_1}
+      ]
+      """
+```
+
+You can memorize JSON at a path:
+
+```cucumber
+Given I keep the JSON response at "first_name" as "FIRST_NAME"
+```
+
+You can remember JSON at a path:
+
+```cucumber
+Then the JSON response at "0/first_name" should be:
+  """
+  %{FIRST_NAME}
+  """
+```
+
+You can also remember JSON inline:
+
+```cucumber
+Then the JSON response at "0/first_name" should be %{FIRST_NAME}
+```
+
+### More
+
+Check out the [specs](https://github.com/collectiveidea/jsontest/blob/master/spec)
+and [features](https://github.com/collectiveidea/jsontest/blob/master/features) to see all the
+various ways you can use jsontest.
+
+## Contributing
+
+If you come across any issues, please [tell us](https://github.com/collectiveidea/jsontest/issues).
+Pull requests (with tests) are appreciated. No pull request is too small. Please help with:
+
+* Reporting bugs
+* Suggesting features
+* Writing or improving documentation
+* Fixing typos
+* Cleaning whitespace
+* Refactoring code
+* Adding tests
+* Closing [issues](https://github.com/collectiveidea/jsontest/issues)
+
+If you report a bug and don't include a fix, please include a failing test.
+
+## Copyright
+
+Copyright © 2011 Steve Richert
+
+See [LICENSE](https://github.com/collectiveidea/jsontest/blob/master/LICENSE) for details.

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "cucumber/rake/task"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = "--warnings"
+end
+
+Cucumber::Rake::Task.new(:cucumber) do |task|
+  task.cucumber_opts = "--tags ~@fail"
+end
+
+Cucumber::Rake::Task.new(:negative_cucumber) do |task|
+  task.cucumber_opts = "--tags @fail --wip"
+end
+
+task test: [:spec, :cucumber, :negative_cucumber]
+task default: :test

data/features/equivalence.feature

@@ -0,0 +1,286 @@
+Feature: Equivalence
+  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": "jsontest",
+        "true": true,
+        "updated_at": "2011-07-08 02:28:50"
+      }
+      """
+
+  Scenario: Identical JSON
+    When I get the JSON
+    Then the JSON should be:
+      """
+      {
+        "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": "jsontest",
+        "true": true,
+        "updated_at": "2011-07-08 02:28:50"
+      }
+      """
+
+  Scenario: Reverse order
+    When I get the JSON
+    Then the JSON should be:
+      """
+      {
+        "updated_at": "2011-07-08 02:28:50",
+        "true": true,
+        "string": "jsontest",
+        "null": null,
+        "negative": -10,
+        "integer": 10,
+        "id": 1,
+        "hash": {
+          "json": "spec"
+        },
+        "float": 10.0,
+        "false": false,
+        "empty_hash": {
+        },
+        "empty_array": [
+
+        ],
+        "created_at": "2011-07-08 02:27:34",
+        "array": [
+          "json",
+          "spec"
+        ]
+      }
+      """
+
+  Scenario: Excluding keys
+    When I get the JSON
+    Then the JSON should be:
+      """
+      {
+        "array": [
+          "json",
+          "spec"
+        ],
+        "empty_array": [
+
+        ],
+        "empty_hash": {
+        },
+        "false": false,
+        "float": 10.0,
+        "hash": {
+          "json": "spec"
+        },
+        "integer": 10,
+        "negative": -10,
+        "null": null,
+        "string": "jsontest",
+        "true": true
+      }
+      """
+
+  Scenario: String
+    When I get the JSON
+    Then the JSON at "string" should be "jsontest"
+    And the JSON at "string" should be:
+      """
+      "jsontest"
+      """
+
+  Scenario: Integer
+    When I get the JSON
+    Then the JSON at "integer" should be 10
+    And the JSON at "integer" should be:
+      """
+      10
+      """
+
+  Scenario: Negative integer
+    When I get the JSON
+    Then the JSON at "negative" should be -10
+    And the JSON at "negative" should be:
+      """
+      -10
+      """
+
+  Scenario: Float
+    When I get the JSON
+    Then the JSON at "float" should be 10.0
+    And the JSON at "float" should be 10.0e0
+    And the JSON at "float" should be 10.0e+0
+    And the JSON at "float" should be 10.0e-0
+    And the JSON at "float" should be 10e0
+    And the JSON at "float" should be 10e+0
+    And the JSON at "float" should be 10e-0
+    And the JSON at "float" should be 1.0e1
+    And the JSON at "float" should be 1.0e+1
+    And the JSON at "float" should be 1e1
+    And the JSON at "float" should be 1e+1
+    And the JSON at "float" should be 100.0e-1
+    And the JSON at "float" should be 100e-1
+    And the JSON at "float" should be:
+      """
+      10.0
+      """
+
+  Scenario: Array
+    When I get the JSON
+    Then the JSON at "array" should be ["json","spec"]
+    And the JSON at "array/0" should be "json"
+    And the JSON at "array/1" should be "spec"
+    And the JSON at "array" should be:
+      """
+      [
+        "json",
+        "spec"
+      ]
+      """
+
+  Scenario: Empty array
+    When I get the JSON
+    Then the JSON at "empty_array" should be []
+    And the JSON at "empty_array" should be:
+      """
+      [
+
+      ]
+      """
+
+  Scenario: Hash
+    When I get the JSON
+    Then the JSON at "hash" should be {"json":"spec"}
+    And the JSON at "hash/json" should be "spec"
+    And the JSON at "hash" should be:
+      """
+      {
+        "json": "spec"
+      }
+      """
+
+  Scenario: Empty hash
+    When I get the JSON
+    Then the JSON at "empty_hash" should be {}
+    And the JSON at "empty_hash" should be:
+      """
+      {
+      }
+      """
+
+  Scenario: True
+    When I get the JSON
+    Then the JSON at "true" should be true
+    And the JSON at "true" should be:
+      """
+      true
+      """
+
+  Scenario: False
+    When I get the JSON
+    Then the JSON at "false" should be false
+    And the JSON at "false" should be:
+      """
+      false
+      """
+
+  Scenario: Null
+    When I get the JSON
+    Then the JSON at "null" should be null
+    And the JSON at "null" should be:
+      """
+      null
+      """
+
+  Scenario: Excluded value
+    When I get the JSON
+    Then the JSON at "created_at" should be "2011-07-08 02:27:34"
+    And the JSON at "id" should be 1
+    And the JSON at "updated_at" should be "2011-07-08 02:28:50"
+
+  Scenario: Table format
+    When I get the JSON
+    Then the JSON should have the following:
+      | array       | ["json","spec"]       |
+      | array/0     | "json"                |
+      | array/1     | "spec"                |
+      | created_at  | "2011-07-08 02:27:34" |
+      | empty_array | []                    |
+      | empty_hash  | {}                    |
+      | false       | false                 |
+      | float       | 10.0                  |
+      | hash        | {"json":"spec"}       |
+      | hash/json   | "spec"                |
+      | id          | 1                     |
+      | integer     | 10                    |
+      | negative    | -10                   |
+      | null        | null                  |
+      | string      | "jsontest"           |
+      | true        | true                  |
+      | updated_at  | "2011-07-08 02:28:50" |
+    And the JSON at "array" should have the following:
+      | 0 | "json" |
+      | 1 | "spec" |
+    And the JSON at "hash" should have the following:
+      | json | "spec" |
+
+  @fail
+  Scenario: Table format can fail equivalence
+    When I get the JSON
+    Then the JSON should have the following:
+      | array       | ["bad","garbage"]     |
+      | array/0     | "json"                |
+      | array/1     | "spec"                |
+      | created_at  | "2011-07-08 02:27:34" |
+      | empty_array | []                    |
+      | empty_hash  | {}                    |
+      | false       | false                 |
+      | float       | 10.0                  |
+      | hash        | {"json":"spec"}       |
+      | hash/json   | "spec"                |
+      | id          | 1                     |
+      | integer     | 10                    |
+      | negative    | -10                   |
+      | null        | null                  |
+      | string      | "jsontest"           |
+      | true        | true                  |
+      | updated_at  | "2011-07-08 02:28:50" |
+    And the JSON at "array" should have the following:
+      | should | "fail" |
+      | 1      | "spec" |
+    And the JSON at "hash" should have the following:
+      | random | "junk" |