rspec-api-matchers 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 480e18da2657efd7c3645a753ce1cc105c8bd4d4
-  data.tar.gz: fb4600f19714aa5eb6f0a49b4e45bcc05be3d1ca
+  metadata.gz: 52d99afa65e3dc027e30e06fe06e5abdb6ca7b77
+  data.tar.gz: 670f2f96336bf3b7ffdd41434f7a756fc358da4c
 SHA512:
-  metadata.gz: dfc14d736db8c6d4f9c059d32ab0012c579c585a2b903ae2cf8920211be1ed95f5b42c07e4d56a710c8357df97d50fb7539ee8ea97d05bc030f2c8846adca79b
-  data.tar.gz: 12d82522d32fb0154b6e5e7c20464a2c01e47b4adb863a2475db3aa0ca8a584db430afb1ba84556240b8ab76398bf2b1a911f88d9b2196578f5a42137e7850a7
+  metadata.gz: 76fcda35ccae07f245892ec5773f20dc43c875714cf2bda6f7f44efdcafafc98e493739b2d4e0c7056d91f3aabe1055397d95c3e278ec3bc11983e345fa397db
+  data.tar.gz: 8e71adfec9954e778684d3ecce2ac4bce83c9319cb7a5f0acd7dfaf9efa6363d8ddc60101d646aa43a30c08ee5b8869cd9d4069ac4ed525e3eab927d68ff01dc

data/README.md

@@ -18,13 +18,20 @@ Install
 Add `gem 'rspec-api-matchers'` to your `Gemfile` and run `bundle`.
 Or install yourself by running `gem install rspec-api-matchers`.
 
+Version changes respect [Semantic Versioning](http://semver.org).
+To ensure `bundle update` won't cause problems in your repository,
+always indicate the patch version until version 1.0.0 is released, e.g.:
+
+    gem 'rspec-api-matchers', '~> 0.5.0'
+
+
 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_collection
     expect(response).to be_a_jsonp('alert')
     expect(response).to be_sorted(by: :id, verse: :desc)
     expect(response).to be_filtered(10, by: :id)

data/lib/rspec-api/dsl/be_a_collection.rb

@@ -0,0 +1,24 @@
+require 'rspec-api/matchers/collection'
+
+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 a collection
+      #
+      # @example
+      #
+      #   # Passes if the body is a collection
+      #   body = '[{"id": 1}]'
+      #   expect(OpenStruct.new body: body).to be_a_collection
+      #
+      #   # Passes if the body is not a collection
+      #   body = '{"id": 1}'
+      #   expect(OpenStruct.new body: body).not_to be_a_collection
+      def be_a_collection
+        RSpecApi::Matchers::Collection.new
+      end
+    end
+  end
+end

data/lib/rspec-api/dsl/include_content_type.rb

@@ -15,6 +15,7 @@ module RSpecApi
       def include_content_type(type = nil)
         content_type = case type
         when :json then 'application/json; charset=utf-8'
+        when :any then %r{}
         end
         RSpecApi::Matchers::ContentType.new(content_type)
       end

data/lib/rspec-api/matchers.rb

@@ -3,10 +3,9 @@ require 'rspec-api/dsl/include_content_type'
 require 'rspec-api/dsl/have_prev_page_link'
 require 'rspec-api/dsl/be_a_jsonp'
 require 'rspec-api/dsl/be_sorted'
-require 'rspec-api/dsl/be_valid_json'
+require 'rspec-api/dsl/be_a_collection'
 require 'rspec-api/dsl/be_filtered'
 require 'rspec-api/dsl/have_attributes'
-require 'rspec-api/dsl/run_if' # should be the last, for metaprogramming
 
 require 'rspec/matchers'
 

data/lib/rspec-api/matchers/attributes.rb

@@ -20,7 +20,7 @@ module RSpecApi
         # can just check them when there are no query params)... of course
         # unless the query params is ?fields=id,name
         # if json.is_a?(Array) and json.empty?
-        #   raise RSpec::Core::Pending::PendingDeclaredInExample.new "You are testing if an array is sorted, but the array is empty. Try with more fixtures"
+        #   raise RSpec::Core::Pending::PendingDeclaredInExample.new "You are testing if an array has attributes, but the array is empty. Try with more fixtures"
         # end
         has_attributes? json, @attributes
       rescue JSON::ParserError, JSON::GeneratorError

data/lib/rspec-api/matchers/{json.rb → collection.rb}

@@ -2,16 +2,12 @@ require 'json'
 
 module RSpecApi
   module Matchers
-    class Json
-      def initialize(type)
-        @type = type
-        @desc = " #{@type}" if @type
-      end
+    class Collection
 
       def matches?(response)
         @body = response.body
         json = parse_json_of @body
-        @type ? json.is_a?(@type) : true
+        json.is_a?(Array)
       end
       alias == matches?
 
@@ -20,11 +16,11 @@ module RSpecApi
       end
 
       def failure_message_for_should_not
-        "expected body not to #{description}, but it was"
+        "expected body not to #{description}, but got #{@body}"
       end
 
       def description
-        %Q(be a valid JSON#{@desc})
+        %Q(be a collection)
       end
 
     private

data/lib/rspec-api/matchers/content_type.rb

@@ -7,7 +7,7 @@ module RSpecApi
 
       def matches?(response)
         @headers = response.headers
-        @headers['Content-Type'] == @content_type if @headers.key? 'Content-Type'
+        @content_type.match @headers['Content-Type'] if @headers.key? 'Content-Type'
       end
 
       def failure_message_for_should
@@ -21,10 +21,6 @@ module RSpecApi
       def description
         %Q{include 'Content-Type': '#{@content_type}'}
       end
-
-      def description_for_run_if
-        %Q{include any specific 'Content-Type'}
-      end
     end
   end
 end

data/lib/rspec-api/matchers/filter.rb

@@ -6,15 +6,19 @@ module RSpecApi
       def initialize(value, options = {})
         @value = value
         @field = options[:by]
-        @comparing_with = options.fetch :comparing_with, Proc.new{|x,y| x == y}
+        @comparing_with = options[:comparing_with]
       end
 
       def matches?(response)
-        @desc = " by #{@field}#{@comparing_with}#{@value}"
+        @desc = " by #{@field}#{@comparing_with || '='}#{@value}"
         @body = response.body
         array = extract_json_from @body
         array.all? do |item| # TODO: Don't always use string
-          @comparing_with.call @value, item[@field.to_s].to_s
+          if @comparing_with
+            @comparing_with.call @value, item[@field.to_s].to_s
+          else
+            @value.to_s == item[@field.to_s].to_s
+          end
         end
       end
       alias == matches?
@@ -38,11 +42,11 @@ module RSpecApi
       def extract_json_from(something)
         array = JSON without_callbacks(something)
         if array.is_a?(Array) and array.empty?
-          raise RSpec::Core::Pending::PendingDeclaredInExample.new "You are testing if an array is sorted, but the array is empty. Try with more fixtures"
+          raise RSpec::Core::Pending::PendingDeclaredInExample.new "You are testing if an array is filtered, but the array is empty. Try with more fixtures"
         end
         array
       rescue JSON::ParserError, JSON::GeneratorError
-        nil
+        raise RSpec::Core::Pending::PendingDeclaredInExample.new "You are testing if an array is filtered, but the array is empty. Try with more fixtures"
       end
 
       def without_callbacks(something)

data/lib/rspec-api/matchers/prev_page_link.rb

@@ -18,10 +18,6 @@ module RSpecApi
       def description
         %Q{include a 'Link' to the previous page}
       end
-
-      def description_for_run_if
-        %Q{include any specific pagination 'Link'}
-      end
     end
   end
 end

data/lib/rspec-api/matchers/sort.rb

@@ -15,7 +15,7 @@ module RSpecApi
         if @field.nil?
           true
         else
-          @desc = " by #{'descending ' if @reverse}#{@field}"
+          @desc = " by #{'descending ' if @reverse}#{@field}" # TODO: use arrows
           @body = response.body
           array = extract_array of: @field, from: @body # what if this fails?
           is_sorted? array, @reverse
@@ -53,7 +53,7 @@ module RSpecApi
         end
         array.map{|item| item[options[:of].to_s]} # what if it's not an array of hashes?
       rescue JSON::ParserError, JSON::GeneratorError
-        nil
+        raise RSpec::Core::Pending::PendingDeclaredInExample.new "You are testing if an array is sorted, but the array is empty. Try with more fixtures"
       end
 
       def without_callbacks(something)

data/lib/rspec-api/matchers/version.rb

@@ -1,5 +1,5 @@
 module RSpecApi
   module Matchers
-    VERSION = '0.1.0'
+    VERSION = '0.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-api-matchers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - claudiob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-03 00:00:00.000000000 Z
+date: 2013-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -101,22 +101,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/rspec-api/dsl/be_a_collection.rb
 - lib/rspec-api/dsl/be_a_jsonp.rb
 - lib/rspec-api/dsl/be_filtered.rb
 - lib/rspec-api/dsl/be_sorted.rb
-- lib/rspec-api/dsl/be_valid_json.rb
 - lib/rspec-api/dsl/have_attributes.rb
 - lib/rspec-api/dsl/have_prev_page_link.rb
 - lib/rspec-api/dsl/have_status.rb
 - lib/rspec-api/dsl/include_content_type.rb
-- lib/rspec-api/dsl/run_if.rb
 - lib/rspec-api/matchers/attributes.rb
+- lib/rspec-api/matchers/collection.rb
 - lib/rspec-api/matchers/content_type.rb
 - lib/rspec-api/matchers/filter.rb
-- lib/rspec-api/matchers/json.rb
 - lib/rspec-api/matchers/jsonp.rb
 - lib/rspec-api/matchers/prev_page_link.rb
-- lib/rspec-api/matchers/run_if.rb
 - lib/rspec-api/matchers/sort.rb
 - lib/rspec-api/matchers/status.rb
 - lib/rspec-api/matchers/version.rb

data/lib/rspec-api/dsl/be_valid_json.rb

@@ -1,29 +0,0 @@
-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

data/lib/rspec-api/dsl/run_if.rb

@@ -1,24 +0,0 @@
-require 'rspec-api/matchers/run_if'
-
-module RSpecApi
-  module Matchers
-    module DSL
-      # Creates a +method_name+_if method for each DSL method
-      #
-      # @example
-      #
-      # def have_prev_page_link_if(condition, *args)
-      #   RSpecApi::Matchers::RunIf.new condition, have_prev_page_link(*args)
-      # end
-      RSpecApi::Matchers::DSL.instance_methods.each do |method|
-        define_method("#{method}_if") do |condition, *args|
-          run_if condition, send(method, *args)
-        end
-      end
-
-      def run_if(run, matcher)
-        RSpecApi::Matchers::RunIf.new run, matcher
-      end
-    end
-  end
-end

data/lib/rspec-api/matchers/run_if.rb

@@ -1,39 +0,0 @@
-module RSpecApi
-  module Matchers
-    class RunIf
-      def initialize(run, matcher)
-        @run = run
-        @matcher = matcher
-      end
-
-      def matches?(response)
-        !@run || @matcher.matches?(response)
-      end
-      alias == matches?
-
-      def does_not_match?(response)
-        !@run || !matches?(response)
-      end
-
-      def failure_message_for_should
-        @matcher.failure_message_for_should
-      end
-
-      def failure_message_for_should_not
-        @matcher.failure_message_for_should_not
-      end
-
-      def description
-        if @run
-          @matcher.description
-        else
-          if @matcher.respond_to? :description_for_run_if
-            %Q{not be expected to #{@matcher.description_for_run_if}}
-          else
-            %Q{not be expected to #{@matcher.description}}
-          end
-        end
-      end
-    end
-  end
-end