jsontest 1.0.0

data/features/paths.feature

@@ -0,0 +1,74 @@
+Feature: Paths
+  Background:
+    Given the JSON is:
+      """
+      {
+        "array": [
+          {
+            "one": 1,
+            "two": 2
+          },
+          {
+            "four": 4,
+            "three": 3
+          }
+        ],
+        "hash": {
+          "even": [
+            6,
+            8
+          ],
+          "odd": [
+            5,
+            7
+          ]
+        },
+        "id": null
+      }
+      """
+
+  Scenario: Base paths
+    When I get the JSON
+    Then the JSON should have "array"
+    And the JSON should have "hash"
+    And the JSON should have "id"
+
+  Scenario: Nested paths
+    When I get the JSON
+    Then the JSON should have "array/0"
+    And the JSON should have "array/1"
+    And the JSON should have "hash/even"
+    And the JSON should have "hash/odd"
+
+  Scenario: Deeply nested paths
+    When I get the JSON
+    Then the JSON should have "array/0/one"
+    And the JSON should have "array/0/two"
+    And the JSON should have "array/1/four"
+    And the JSON should have "array/1/three"
+    And the JSON should have "hash/even/0"
+    And the JSON should have "hash/even/1"
+    And the JSON should have "hash/odd/0"
+    And the JSON should have "hash/odd/1"
+
+  Scenario: Ignored paths
+    When I get the JSON
+    Then the JSON should have "id"
+
+  Scenario: Table format
+    When I get the JSON
+    Then the JSON should have the following:
+      | array         |
+      | hash          |
+      | array/0       |
+      | array/1       |
+      | hash/even     |
+      | hash/odd      |
+      | array/0/one   |
+      | array/0/two   |
+      | array/1/four  |
+      | array/1/three |
+      | hash/even/0   |
+      | hash/even/1   |
+      | hash/odd/0    |
+      | hash/odd/1    |

data/features/sizes.feature

@@ -0,0 +1,38 @@
+Feature: Sizes
+  Background:
+    Given the JSON is:
+      """
+      {
+        "id": null,
+        "one": [
+          1
+        ],
+        "three": [
+          1,
+          2,
+          3
+        ],
+        "two": [
+          1,
+          2
+        ],
+        "zero": [
+
+        ]
+      }
+      """
+
+  Scenario: Hash
+    When I get the JSON
+    Then the JSON should have 5 keys
+    And the JSON should have 5 values
+
+  Scenario: Empty array
+    When I get the JSON
+    Then the JSON at "zero" should have 0 entries
+
+  Scenario: Array
+    When I get the JSON
+    Then the JSON at "one" should have 1 entry
+    And the JSON at "two" should have 2 values
+    And the JSON at "three" should have 3 numbers

data/features/step_definitions/steps.rb

@@ -0,0 +1,7 @@
+Given "the JSON is:" do |json|
+  @json = json
+end
+
+When "I get the JSON" do
+  @last_json = @json
+end

data/features/support/env.rb

@@ -0,0 +1,9 @@
+$: << File.expand_path("../../../lib", __FILE__)
+
+require "jsontest/cucumber"
+
+JsonTest.directory = File.expand_path("../../../spec/support/files", __FILE__)
+
+def last_json
+  @last_json.to_s
+end

data/features/types.feature

@@ -0,0 +1,24 @@
+Feature: Types
+  Scenario: All types
+    Given the JSON is:
+      """
+      {
+        "array": [],
+        "false": true,
+        "float": 10.0,
+        "hash": {},
+        "integer": 10,
+        "string": "jsontest",
+        "true": true
+      }
+      """
+    When I get the JSON
+    Then the JSON should be a hash
+    And the JSON at "array" should be an array
+    And the JSON at "false" should be a boolean
+    And the JSON at "float" should be a float
+    And the JSON at "hash" should be a hash
+    And the JSON at "hash" should be an object
+    And the JSON at "integer" should be an integer
+    And the JSON at "string" should be a string
+    And the JSON at "true" should be a boolean

data/gemfiles/rspec2.gemfile

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

data/gemfiles/rspec3.gemfile

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

data/jsontest.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.name    = "jsontest"
+  gem.version = "1.0.0"
+
+  gem.authors     = ["Steve Richert", "Michiel Boekhoff"]
+  gem.email       = ["steve.richert@gmail.com", "michielalexanderb@gmail.com"]
+  gem.summary     = "Easily test JSON in RSpec and Cucumber"
+  gem.description = "RSpec matchers and Cucumber steps for testing JSON content"
+  gem.homepage    = "https://github.com/michielboekhoff/jsontest"
+  gem.license     = "MIT"
+
+  gem.add_dependency "multi_json", "~> 1.0"
+  gem.add_dependency "rspec", ">= 2.0", "< 4.0"
+
+  gem.add_development_dependency "bundler", "~> 1.0"
+  gem.add_development_dependency "rake", "~> 10.0"
+
+  gem.files      = `git ls-files`.split($\)
+  gem.test_files = gem.files.grep(/^(features|spec)/)
+end

data/lib/jsontest.rb

@@ -0,0 +1,14 @@
+require "json"
+require "rspec"
+require "jsontest/errors"
+require "jsontest/configuration"
+require "jsontest/exclusion"
+require "jsontest/helpers"
+require "jsontest/messages"
+require "jsontest/matchers"
+require "jsontest/memory"
+
+module JsonTest
+  extend Configuration
+  extend Memory
+end

data/lib/jsontest/configuration.rb

@@ -0,0 +1,30 @@
+require "set"
+
+module JsonTest
+  module Configuration
+    DEFAULT_EXCLUDED_KEYS = %w(id created_at updated_at)
+
+    attr_accessor :directory
+
+    def configure(&block)
+      instance_eval(&block)
+    end
+
+    def excluded_keys
+      @excluded_keys ||= DEFAULT_EXCLUDED_KEYS
+    end
+
+    def excluded_keys=(keys)
+      @excluded_keys = keys.map(&:to_s).uniq
+    end
+
+    def exclude_keys(*keys)
+      self.excluded_keys = keys
+    end
+
+
+    def reset
+      instance_variables.each { |ivar| remove_instance_variable(ivar) }
+    end
+  end
+end

data/lib/jsontest/cucumber.rb

@@ -0,0 +1,95 @@
+require File.expand_path("../../jsontest", __FILE__)
+
+World(JsonTest::Helpers, JsonTest::Matchers)
+
+After do
+  JsonTest.forget
+end
+
+When /^(?:I )?keep the (?:JSON|json)(?: response)?(?: at "(.*)")? as "(.*)"$/ do |path, key|
+  JsonTest.memorize(key, normalize_json(last_json, path))
+end
+
+Then /^the (?:JSON|json)(?: response)?(?: at "(.*)")? should( not)? be:$/ do |path, negative, json|
+  if negative
+    last_json.should_not be_json_eql(JsonTest.remember(json)).at_path(path)
+  else
+    last_json.should be_json_eql(JsonTest.remember(json)).at_path(path)
+  end
+end
+
+Then /^the (?:JSON|json)(?: response)?(?: at "(.*)")? should( not)? be file "(.+)"$/ do |path, negative, file_path|
+  if negative
+    last_json.should_not be_json_eql.to_file(file_path).at_path(path)
+  else
+    last_json.should be_json_eql.to_file(file_path).at_path(path)
+  end
+end
+
+Then /^the (?:JSON|json)(?: response)?(?: at "(.*)")? should( not)? be (".*"|\-?\d+(?:\.\d+)?(?:[eE][\+\-]?\d+)?|\[.*\]|%?\{.*\}|true|false|null)$/ do |path, negative, value|
+  if negative
+    last_json.should_not be_json_eql(JsonTest.remember(value)).at_path(path)
+  else
+    last_json.should be_json_eql(JsonTest.remember(value)).at_path(path)
+  end
+end
+
+Then /^the (?:JSON|json)(?: response)?(?: at "(.*)")? should( not)? include:$/ do |path, negative, json|
+  if negative
+    last_json.should_not include_json(JsonTest.remember(json)).at_path(path)
+  else
+    last_json.should include_json(JsonTest.remember(json)).at_path(path)
+  end
+end
+
+Then /^the (?:JSON|json)(?: response)?(?: at "(.*)")? should( not)? include file "(.+)"$/ do |path, negative, file_path|
+  if negative
+    last_json.should_not include_json.from_file(file_path).at_path(path)
+  else
+    last_json.should include_json.from_file(file_path).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(JsonTest.remember(value)).at_path(path)
+  else
+    last_json.should include_json(JsonTest.remember(value)).at_path(path)
+  end
+end
+
+Then /^the (?:JSON|json)(?: response)?(?: at "(.*)")? should have the following:$/ do |base, table|
+  table.raw.each do |path, value|
+    path = [base, path].compact.join("/")
+
+    if value
+      step %(the JSON at "#{path}" should be:), value
+    else
+      step %(the JSON should have "#{path}")
+    end
+  end
+end
+
+Then /^the (?:JSON|json)(?: response)? should( not)? have "(.*)"$/ do |negative, path|
+  if negative
+    last_json.should_not have_json_path(path)
+  else
+    last_json.should have_json_path(path)
+  end
+end
+
+Then /^the (?:JSON|json)(?: response)?(?: at "(.*)")? should( not)? be an? (.*)$/ do |path, negative, type|
+  if negative
+    last_json.should_not have_json_type(type).at_path(path)
+  else
+    last_json.should have_json_type(type).at_path(path)
+  end
+end
+
+Then /^the (?:JSON|json)(?: response)?(?: at "(.*)")? should( not)? have (\d+)/ do |path, negative, size|
+  if negative
+    last_json.should_not have_json_size(size.to_i).at_path(path)
+  else
+    last_json.should have_json_size(size.to_i).at_path(path)
+  end
+end

data/lib/jsontest/errors.rb

@@ -0,0 +1,46 @@
+module JsonTest
+  class Error < StandardError
+  end
+
+  class MissingPath < Error
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def to_s
+      %(Missing JSON path "#{path}")
+    end
+  end
+
+  class MissingDirectory < Error
+    def to_s
+      "No JsonTest.directory set"
+    end
+  end
+
+  class MissingFile < Error
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def to_s
+      "No JSON file at #{path}"
+    end
+  end
+
+  class EnumerableExpected < Error
+    attr_reader :actual_value
+
+    def initialize(actual_value)
+      @actual_value = actual_value
+    end
+
+    def to_s
+      "Enumerable expected, got #{actual_value.inspect}"
+    end
+  end
+end

data/lib/jsontest/exclusion.rb

@@ -0,0 +1,26 @@
+module JsonTest
+  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(JsonTest.excluded_keys)
+    end
+  end
+end

data/lib/jsontest/helpers.rb

@@ -0,0 +1,62 @@
+require "multi_json"
+
+module JsonTest
+  module Helpers
+    extend self
+
+    def parse_json(json, path = nil)
+      ruby = MultiJson.decode("[#{json}]").first
+      value_at_json_path(ruby, path)
+    rescue MultiJson::DecodeError
+      MultiJson.decode(json)
+    end
+
+    def normalize_json(json, path = nil)
+      ruby = parse_json(json, path)
+      generate_normalized_json(ruby)
+    end
+
+    def generate_normalized_json(ruby)
+      case ruby
+      when Hash, Array then JSON.pretty_generate(ruby)
+      else ruby.to_json
+      end
+    end
+
+    def load_json(relative_path)
+      missing_json_directory! if JsonTest.directory.nil?
+      path = File.join(JsonTest.directory, relative_path)
+      missing_json_file!(path) unless File.exist?(path)
+      File.read(path)
+    end
+
+    private
+      def value_at_json_path(ruby, path)
+        return ruby unless path
+
+        path.split("/").inject(ruby) do |value, key|
+          case value
+          when Hash
+            value.fetch(key){ missing_json_path!(path) }
+          when Array
+            missing_json_path!(path) unless key =~ /^\d+$/
+            value.fetch(key.to_i){ missing_json_path!(path) }
+          else
+            missing_json_path!(path)
+          end
+        end
+      end
+
+      def missing_json_path!(path)
+        raise JsonTest::MissingPath.new(path)
+      end
+
+      def missing_json_directory!
+        raise JsonTest::MissingDirectory
+      end
+
+      def missing_json_file!(path)
+        raise JsonTest::MissingFile.new(path)
+      end
+  end
+end