Moved *all* the matchers from RSpecApi

* Added include_content_type matcher
* Added have_prev_page_link matcher
* Added be_valid_json matcher
* Added be_a_jsonp matcher
* Added be_sorted matcher
* Added be_filtered matcher
* Added have_attributes matcher
* Added run_if, to execute matchers conditionally
* Make sorted/filtered matchers pending if given an empty array

Author: claudiob

Gemfile.lock

@@ -1,21 +1,31 @@
 PATH
   remote: .
   specs:
-    rspec-api-matchers (0.0.1)
+    rspec-api-matchers (0.1.0)
+      activesupport
       rack
       rspec
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (4.0.1)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
     coveralls (0.7.0)
       multi_json (~> 1.3)
       rest-client
       simplecov (>= 0.7)
       term-ansicolor
       thor
     diff-lcs (1.2.4)
+    i18n (0.6.5)
     mime-types (2.0)
+    minitest (4.7.5)
     multi_json (1.8.2)
     rack (1.5.2)
     rake (10.1.0)
@@ -25,7 +35,7 @@ GEM
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.6)
+    rspec-core (2.14.7)
     rspec-expectations (2.14.3)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.4)
@@ -36,7 +46,10 @@ GEM
     term-ansicolor (1.2.2)
       tins (~> 0.8)
     thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
     tins (0.12.0)
+    tzinfo (0.3.38)
 
 PLATFORMS
   ruby

HISTORY.md

@@ -1 +1,18 @@
-v0.0.1  - 2013/10/29 Extracted `match_status` from RSpecApi
+v0.1.0  - 2013/11/03
+--------------------
+
+* Added include_content_type matcher
+* Added have_prev_page_link matcher
+* Added be_valid_json matcher
+* Added be_a_jsonp matcher
+* Added be_sorted matcher
+* Added be_filtered matcher
+* Added have_attributes matcher
+* Added run_if, to execute matchers conditionally
+* Make sorted/filtered matchers pending if given an empty array
+
+
+v0.0.1  - 2013/10/29
+--------------------
+
+*   Extracted `match_status` from RSpecApi

README.md

@@ -24,6 +24,11 @@ Available matchers
     expect(response).to have_status(:ok)
     expect(response).to include_content_type(:json)
     expect(response).to have_prev_page_link
+    expect(response).to be_valid_json(Array)
+    expect(response).to be_a_jsonp('alert')
+    expect(response).to be_sorted(by: :id, verse: :desc)
+    expect(response).to be_filtered(10, by: :id)
+    expect(response).to have_attributes(id: {value: 1.2}, url: {type: {string: :url}})
 
 How to contribute
 =================

TODO.md

@@ -0,0 +1,4 @@
+* Use `default_color` or `fixed_color` for "should not expect to"
+* Extract a common matcher class for "expect not_to" (`does_not_match?`)
+* Improve example description
+* Warn if the app declares matchers with the same name, like `be_filtered_by`

lib/rspec-api/dsl/be_a_jsonp.rb

@@ -0,0 +1,24 @@
+require 'rspec-api/matchers/jsonp'
+
+module RSpecApi
+  module Matchers
+    # Convert RSpecAPI::Matchers classes into RSpec-compatible matchers, e.g.:
+    # makes RSpecApi::Matchers::Status available as expect(...).to match_status
+    module DSL
+      # Passes if response body is in JSONP format
+      #
+      # @note
+      #
+      # A JSONP should actually return application/javascript...
+      #
+      # @example
+      #
+      #   # Passes if the body is a JSON wrapped in a callback
+      #   body = 'alert([{"website":"http://www.example.com","flag":null}])'
+      #   expect(OpenStruct.new body: body).to be_a_jsonp(:alert)
+      def be_a_jsonp(callback = nil)
+        RSpecApi::Matchers::Jsonp.new(callback)
+      end
+    end
+  end
+end

lib/rspec-api/dsl/be_filtered.rb

@@ -0,0 +1,24 @@
+require 'rspec-api/matchers/filter'
+
+module RSpecApi
+  module Matchers
+    # Convert RSpecAPI::Matchers classes into RSpec-compatible matchers, e.g.:
+    # makes RSpecApi::Matchers::Status available as expect(...).to match_status
+    module DSL
+      # Passes if response body is filtered by +options[:by]+ comparing with +options[:comparing_with]+
+      #
+      # @example
+      #
+      #   # Passes if the body only contains ID = 1
+      #   body = '[{"id": 1}, {"id": 1}, {"id": 1}]'
+      #   expect(OpenStruct.new body: body).to be_filtered(1, by: :id)
+      #
+      #   # Passes if the body only contains ID < 10
+      #   body = '[{"id": 1}, {"id": 6}, {"id": 3}]'
+      #   expect(OpenStruct.new body: body).to be_filtered(10, by: :id, comparing_with: :<)
+      def be_filtered(value = nil, options = {})
+        RSpecApi::Matchers::Filter.new value, options
+      end
+    end
+  end
+end

lib/rspec-api/dsl/be_sorted.rb

@@ -0,0 +1,24 @@
+require 'rspec-api/matchers/sort'
+
+module RSpecApi
+  module Matchers
+    # Convert RSpecAPI::Matchers classes into RSpec-compatible matchers, e.g.:
+    # makes RSpecApi::Matchers::Status available as expect(...).to match_status
+    module DSL
+      # Passes if response body is sorted by +options[:by]+ with +options[:verse]+
+      #
+      # @example
+      #
+      #   # Passes if the body is sorted by ascending IDs
+      #   body = '[{"id": 1}, {"id": 2}, {"id": 3}]'
+      #   expect(OpenStruct.new body: body).to be_sorted(by: :id)
+      #
+      #   # Passes if the body is sorted by descending timestamps
+      #   body = '[{"t": "2013-10-29T18:09:43Z"}, {"t": "2009-01-12T18:09:43Z"}]'
+      #   expect(OpenStruct.new body: body).to be_sorted(by: :t, verse: :desc)
+      def be_sorted(options = {})
+        RSpecApi::Matchers::Sort.new options
+      end
+    end
+  end
+end

lib/rspec-api/dsl/be_valid_json.rb

@@ -0,0 +1,29 @@
+require 'rspec-api/matchers/json'
+
+module RSpecApi
+  module Matchers
+    # Convert RSpecAPI::Matchers classes into RSpec-compatible matchers, e.g.:
+    # makes RSpecApi::Matchers::Status available as expect(...).to match_status
+    module DSL
+      # Passes if response body is JSON. Optionally check if Array or Hash.
+      # Skips if  if response body is JSON. Optionally check if Array or Hash.
+      #
+      # @example
+      #
+      #   # Passes if the body is valid JSON
+      #   body = '{"id": 1}'
+      #   expect(OpenStruct.new body: body).to be_valid_json
+      #
+      #   # Passes if the body is a valid JSON-marshalled Hash
+      #   body = '{"id": 1}'
+      #   expect(OpenStruct.new body: body).to be_valid_json(Hash)
+      #
+      #   # Passes if the body is a valid JSON-marshalled Array
+      #   body = '[{"id": 1}, {"id": 2}]'
+      #   expect(OpenStruct.new body: body).to be_valid_json(Array)
+      def be_valid_json(type = nil)
+        RSpecApi::Matchers::Json.new(type)
+      end
+    end
+  end
+end

lib/rspec-api/dsl/have_attributes.rb

@@ -0,0 +1,37 @@
+require 'rspec-api/matchers/attributes'
+
+module RSpecApi
+  module Matchers
+    # Convert RSpecAPI::Matchers classes into RSpec-compatible matchers, e.g.:
+    # makes RSpecApi::Matchers::Status available as expect(...).to match_status
+    module DSL
+      # Passes if response body is an object or array of objects with +key+.
+      #
+      # @example
+      #
+      #   # Passes if the body is an object with key :id
+      #   body = '{"id": 1, "url": "http://www.example.com"}'
+      #   expect(OpenStruct.new body: body).to have_attributes(:id)
+      #
+      #   # Passes if the body is an object with key :id and value 1
+      #   body = '{"id": 1, "url": "http://www.example.com"}'
+      #   expect(OpenStruct.new body: body).to have_attributes(id: {value: 1})
+      #
+      #   # Passes if the body is an array of objects, all with key :id
+      #   body = '{"id": 1, "name": ""}, {"id": 2}]'
+      #   expect(OpenStruct.new body: body).to have_attributes(:id)
+      #
+      #   # Passes if the body is an array of object with key :id and odd values
+      #   body = '{"id": 1, "name": ""}, {"id": 3}], {"id": 5}]'
+      #   expect(OpenStruct.new body: body).to have_attributes(id: {value: -> v {v.odd?}})
+
+      # TODO: add &block options
+      def have_attributes(attributes = {})
+        RSpecApi::Matchers::Attributes.new attributes
+      end
+      # alias have_attribute have_attributes
+      # alias have_keys have_attributes
+      # alias have_key have_attributes
+    end
+  end
+end

lib/rspec-api/dsl/have_prev_page_link.rb

@@ -0,0 +1,20 @@
+require 'rspec-api/matchers/prev_page_link'
+
+module RSpecApi
+  module Matchers
+    # Convert RSpecAPI::Matchers classes into RSpec-compatible matchers, e.g.:
+    # makes RSpecApi::Matchers::Status available as expect(...).to match_status
+    module DSL
+      # Passes if response includes the pagination Link rel=prev in the headers
+      #
+      # @example
+      #
+      #   # Passes if the headers specify the pagination link for Prev
+      #   headers = {'Link' => '<https://example.com/1>; rel="prev"'}
+      #   expect(OpenStruct.new headers: headers).to have_prev_page_link
+      def have_prev_page_link
+        RSpecApi::Matchers::PrevPageLink.new
+      end
+    end
+  end
+end