json_spec 0.7.0 → 0.8.0

data/.travis.yml

@@ -1,10 +1,8 @@
 rvm:
-  - 1.8.6
   - 1.8.7
   - 1.9.2
+  - 1.9.3
   - ruby-head
-  - rbx
-  - jruby
 only:
   - master
 notifications:

data/README.md

@@ -1,5 +1,6 @@
-json_spec
+json_spec [![Build Status](https://secure.travis-ci.org/collectiveidea/json_spec.png)](http://travis-ci.org/collectiveidea/json_spec) [![Dependency Status](https://gemnasium.com/collectiveidea/json_spec.png)](https://gemnasium.com/collectiveidea/json_spec)
 ========
+
 Easily handle JSON in RSpec and Cucumber
 
 Installation
@@ -16,10 +17,6 @@ Please help write documentation!
 
 [http://rdoc.info/gems/json_spec](http://rdoc.info/gems/json_spec)
 
-Continuous Integration
-----------------------
-[![Build Status](https://secure.travis-ci.org/collectiveidea/json_spec.png)](http://travis-ci.org/collectiveidea/json_spec)
-
 RSpec
 --------------
 json_spec defines five new RSpec matchers:
@@ -56,6 +53,20 @@ The new matchers could be used in RSpec as follows:
       end
     end
 
+Also json_spec provides some useful helpers for RSpec tests:
+
+* `parse_json`
+* `normalize_json`
+* `generate_normalized_json`
+
+To start using them add include statement in your Rspec.configure at spec_helper.rb file:
+
+    RSpec.configure do |config|
+      config.include JsonSpec::Helpers
+    end
+
+Examples of usage this methods you can find in spec/json_spec/helpers_spec.rb
+
 ### Exclusions
 
 json_spec ignores certain hash keys by default when comparing JSON:

data/json_spec.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "multi_json", "~> 1.0.0"
+  s.add_dependency "multi_json", "~> 1.0"
   s.add_dependency "rspec", "~> 2.0"
 
   s.add_development_dependency "rake", "~> 0.9"
-  s.add_development_dependency "cucumber", "~> 1.0"
+  s.add_development_dependency "cucumber", "~> 1.1", ">= 1.1.1"
 end

data/lib/json_spec.rb

@@ -2,8 +2,8 @@ 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/matchers"
 require "json_spec/memory"
 
 module JsonSpec

data/lib/json_spec/cucumber.rb

@@ -1,6 +1,6 @@
 require File.expand_path("../../json_spec", __FILE__)
 
-World(JsonSpec::Helpers)
+World(JsonSpec::Helpers, JsonSpec::Matchers)
 
 After do
   JsonSpec.forget
@@ -47,9 +47,9 @@ Then /^the (?:JSON|json)(?: response)?(?: at "(.*)")? should have the following:
     path = [base, path].compact.join("/")
 
     if value
-      Then %(the JSON at "#{path}" should be:), value
+      step %(the JSON at "#{path}" should be:), value
     else
-      Then %(the JSON should have "#{path}")
+      step %(the JSON should have "#{path}")
     end
   end
 end

data/lib/json_spec/matchers.rb

@@ -1,161 +1,214 @@
 require "json"
 require "rspec"
 
-RSpec::Matchers.define :be_json_eql do |expected_json|
-  include JsonSpec::Helpers
-  include JsonSpec::Exclusion
-
-  diffable
-
-  match do |actual_json|
-    @actual, @expected = scrub(actual_json, @path), [scrub(expected_json)]
-    @actual == @expected.first
-  end
-
-  chain :at_path do |path|
-    @path = path
-  end
-
-  chain :excluding do |*keys|
-    excluded_keys.merge(keys.map{|k| k.to_s })
-  end
-
-  chain :including do |*keys|
-    excluded_keys.subtract(keys.map{|k| k.to_s })
-  end
-
-  failure_message_for_should do
-    message = "Expected equivalent JSON"
-    message << %( at path "#{@path}") if @path
-    message
-  end
-
-  failure_message_for_should_not do
-    message = "Expected inequivalent JSON"
-    message << %( at path "#{@path}") if @path
-    message
-  end
-
-  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
-
-  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
+module JsonSpec
+  module Matchers
+    class BeJsonEql
+      include JsonSpec::Helpers
+      include JsonSpec::Exclusion
+
+      attr_reader :expected, :actual
+
+      def diffable?
+        true
+      end
+
+      def initialize(expected_json)
+        @expected_json = expected_json
+      end
+
+      def matches?(actual_json)
+        @actual, @expected = scrub(actual_json, @path), scrub(@expected_json)
+        @actual == @expected
+      end
+
+      def at_path(path)
+        @path = path
+        self
+      end
+
+      def excluding(*keys)
+        excluded_keys.merge(keys.map{|k| k.to_s })
+        self
+      end
+
+      def including(*keys)
+        excluded_keys.subtract(keys.map{|k| k.to_s })
+        self
+      end
+
+      def failure_message_for_should
+        message = "Expected equivalent JSON"
+        message << %( at path "#{@path}") if @path
+        message
+      end
+
+      def failure_message_for_should_not
+        message = "Expected inequivalent JSON"
+        message << %( at path "#{@path}") if @path
+        message
+      end
+
+      private
+        def scrub(json, path = nil)
+          generate_normalized_json(exclude_keys(parse_json(json, path))).chomp + "\n"
+        end
     end
-  end
-
-  chain :at_path do |path|
-    @path = path
-  end
-
-  chain :excluding do |*keys|
-    excluded_keys.merge(*keys.map{|k| k.to_s })
-  end
-
-  chain :including do |*keys|
-    excluded_keys.subtract(keys.map{|k| k.to_s })
-  end
-
-  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
-
-RSpec::Matchers.define :have_json_path do |path|
-  include JsonSpec::Helpers
 
-  match do |json|
-    begin
-      parse_json(json, path)
-      true
-    rescue JsonSpec::MissingPathError
-      false
+    class IncludeJson
+      include JsonSpec::Helpers
+      include JsonSpec::Exclusion
+
+      def initialize(expected_json)
+        @expected_json = expected_json
+      end
+
+      def matches?(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 at_path(path)
+        @path = path
+        self
+      end
+
+      def excluding(*keys)
+        excluded_keys.merge(keys.map{|k| k.to_s })
+        self
+      end
+
+      def including(*keys)
+        excluded_keys.subtract(keys.map{|k| k.to_s })
+        self
+      end
+
+      def failure_message_for_should
+        message = "Expected included JSON"
+        message << %( at path "#{@path}") if @path
+        message
+      end
+
+      def failure_message_for_should_not
+        message = "Expected excluded JSON"
+        message << %( at path "#{@path}") if @path
+        message
+      end
     end
-  end
 
-  failure_message_for_should do
-    %(Expected JSON path "#{path}")
-  end
+    class HaveJsonPath
+      include JsonSpec::Helpers
+
+      def initialize(path)
+        @path = path
+      end
+
+      def matches?(json)
+        begin
+          parse_json(json, @path)
+          true
+        rescue JsonSpec::MissingPathError
+          false
+        end
+      end
+
+      def failure_message_for_should
+        %(Expected JSON path "#{@path}")
+      end
+
+      def failure_message_for_should_not
+        %(Expected no JSON path "#{@path}")
+      end
+    end
 
-  failure_message_for_should_not do
-    %(Expected no JSON path "#{path}")
-  end
-end
+    class HaveJsonType
+      include JsonSpec::Helpers
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def matches?(json)
+        @ruby = parse_json(json, @path)
+        @ruby.is_a?(@klass)
+      end
+
+      def at_path(path)
+        @path = path
+        self
+      end
+
+      def failure_message_for_should
+        message = "Expected JSON value type to be #{@klass}, got #{@ruby.class}"
+        message << %( at path "#{@path}") if @path
+        message
+      end
+
+      def failure_message_for_should_not
+        message = "Expected JSON value type to not be #{@klass}, got #{@ruby.class}"
+        message << %( at path "#{@path}") if @path
+        message
+      end
+    end
 
-RSpec::Matchers.define :have_json_type do |klass|
-  include JsonSpec::Helpers
+    class HaveJsonSize
+      include JsonSpec::Helpers
+
+      def initialize(size)
+        @expected = size
+      end
+
+      def matches?(json)
+        ruby = parse_json(json, @path)
+        @actual = ruby.is_a?(Enumerable) ? ruby.size : 1
+        @actual == @expected
+      end
+
+      def at_path(path)
+        @path = path
+        self
+      end
+
+      def failure_message_for_should
+        message = "Expected JSON value size to be #{@expected}, got #{@actual}"
+        message << %( at path "#{@path}") if @path
+        message
+      end
+
+      def failure_message_for_should_not
+        message = "Expected JSON value size to not be #{@expected}, got #{@actual}"
+        message << %( at path "#{@path}") if @path
+        message
+      end
+    end
 
-  match do |json|
-    @json = json
-    actual.is_a?(klass)
-  end
+    def be_json_eql(json)
+      JsonSpec::Matchers::BeJsonEql.new(json)
+    end
 
-  chain :at_path do |path|
-    @path = path
-  end
+    def include_json(json)
+      JsonSpec::Matchers::IncludeJson.new(json)
+    end
 
-  failure_message_for_should do
-    message = "Expected JSON value type to be #{klass}, got #{actual.class}"
-    message << %( at path "#{@path}") if @path
-    message
-  end
+    def have_json_path(path)
+      JsonSpec::Matchers::HaveJsonPath.new(path)
+    end
 
-  failure_message_for_should_not do
-    message = "Expected JSON value type to not be #{klass}, got #{actual.class}"
-    message << %( at path "#{@path}") if @path
-    message
-  end
+    def have_json_type(klass)
+      JsonSpec::Matchers::HaveJsonType.new(klass)
+    end
 
-  def actual
-    parse_json(@json, @path)
+    def have_json_size(size)
+      JsonSpec::Matchers::HaveJsonSize.new(size)
+    end
   end
 end
 
-RSpec::Matchers.define :have_json_size do |expected_size|
-  include JsonSpec::Helpers
-
-  match do |json|
-    @json = json
-    actual_size == expected_size
-  end
-
-  chain :at_path do |path|
-    @path = path
-  end
-
-  failure_message_for_should do
-    message = "Expected JSON value size to be #{expected_size}, got #{actual_size}"
-    message << %( at path "#{@path}") if @path
-    message
-  end
-
-  failure_message_for_should_not do
-    message = "Expected JSON value size to not be #{expected_size}, got #{actual_size}"
-    message << %( at path "#{@path}") if @path
-    message
-  end
-
-  def actual_size
-    ruby = parse_json(@json, @path)
-    ruby.is_a?(Enumerable) ? ruby.size : 1
-  end
+RSpec.configure do |config|
+  config.include JsonSpec::Matchers
 end

data/lib/json_spec/version.rb

@@ -1,3 +1,3 @@
 module JsonSpec
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,67 +1,100 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: json_spec
-version: !ruby/object:Gem::Version
-  version: 0.7.0
+version: !ruby/object:Gem::Version 
+  hash: 63
   prerelease: 
+  segments: 
+  - 0
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
-authors:
+authors: 
 - Steve Richert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-19 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-01-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: multi_json
-  requirement: &70258292680600 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
   type: :runtime
-  prerelease: false
-  version_requirements: *70258292680600
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &70258292680100 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
   type: :runtime
-  prerelease: false
-  version_requirements: *70258292680100
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &70258292710600 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.9'
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
   type: :development
-  prerelease: false
-  version_requirements: *70258292710600
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: cucumber
-  requirement: &70258292710140 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 1
+        - 1
+        version: 1.1.1
   type: :development
-  prerelease: false
-  version_requirements: *70258292710140
+  version_requirements: *id004
 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
@@ -93,29 +126,38 @@ files:
 - spec/spec_helper.rb
 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
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: json_spec
-rubygems_version: 1.8.8
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Easily handle JSON in RSpec and Cucumber
-test_files:
+test_files: 
 - features/equivalence.feature
 - features/inclusion.feature
 - features/memory.feature