serial-spec 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9848c116a4381a807460081064dc65beca99630a
-  data.tar.gz: 31a670e4ab9f242257189a50368b0f87a7c133ca
+  metadata.gz: 042a2b062a70b8573348c2c0081eddf69e1394c0
+  data.tar.gz: 82c1fe7170df02c00c5208c92448c5bc41bab959
 SHA512:
-  metadata.gz: 0a6f00d831f94fe3b7c5d7da43e36528e8e9dbfe1f7584536db7ad23af39d55bca90e4c035aab911e125301e06ff337fe521f3146dfc16afaaa7aa124064571c
-  data.tar.gz: f9545df060cc2f81db1d93e7daa920ae18fe15a44b6e23da87cba2c2ed1a2f3d333f024946a4495f4ab21bcab9db740765a31611d42c770e5b75f0280c2770c1
+  metadata.gz: 7a3e5711246fa8f02e5b48e86e37712c0efc45e1459a38c4e9fae3c2cdb1f8bb5e2b9366182a9e0cbd0aad9bb66c2b8f9705ccb662a814c8e538814bc5359716
+  data.tar.gz: 1bad6f37298e3aed3943f586a18afa436cf32a6a64f2cc33557a992bbf862325f3b33e01ad38e42ebdeb65e7a7bf7e550fbab2c542d92fc2388417896a59f646

data/README.md

@@ -2,7 +2,7 @@
 
 SerialSpec is designed provide some simple matchers and macros overlaying a simple `rack/test` setup for testing json apis more effectively.
 
-## Usage
+## Basic Usage
 
 ```ruby
 require "spec_helper"
@@ -18,20 +18,6 @@ RSpec.describe "test" do
 end
 ```
 
-## Testing architecture
-
-SerialSpec is assuming that you are:
-
-1. setting up preconditions
-2. executing 1 request
-3. inspecting the response
-
-If you need more requests you should be using mocks and stubs.
-
-### "But I need more than one request?"
-
-SerialSpec, unlike rails' out of the box request testing system is closer to a controller test, than rails' request test, which is more kin to an integration test.  Some people recommend using actual requests for performing things like login, auth vs mocking.  However, this library doesn't subscribe to that pattern.  If you aren't ok with that, you should look elsewhere.
-
 ## Contributing
 
 1. Fork it ( https://github.com/blakechambers/serial-spec/fork )

data/lib/serial_spec.rb

@@ -15,9 +15,16 @@ module SerialSpec
   include ItExpects
   include RequestResponse
   include RequestResponse::Helpers
+
   if defined?(ActiveModel::Serializer)
     require "serial_spec/request_response/provide_matcher"
     include RequestResponse::ProvideMatcher
+
+    if defined?(::RSpec) and
+       defined?(::RSpec::Core::Version::STRING) and
+       Gem::Version.new(::RSpec::Core::Version::STRING) >= Gem::Version.new("3.2.0")
+      require "serial_spec/request_response/include_provide_matcher"
+    end
   end
 
   SERIAL_VALID_VERBS = %w{GET POST PUT PATCH DELETE OPTIONS HEAD}
@@ -33,8 +40,15 @@ module SerialSpec
         if request_str.split(/\s+/).count == 2
           request_method_string, request_path_str = request_str.split(/\s+/)
           if SERIAL_VALID_VERBS.include?(request_method_string)
-            request_method request_method_string
-            request_path   request_path_str
+            # Prefer preference to blocks, chances are the blocks need to be
+            # executed at a lower level
+            unless request_opts[:request_method] and request_opts[:request_method].instance_of?(InheritableAccessors::InheritableOptionAccessor::LetOption)
+              request_method request_method_string
+            end
+
+            unless request_opts[:request_path] and request_opts[:request_path].instance_of?(InheritableAccessors::InheritableOptionAccessor::LetOption)
+              request_path   request_path_str
+            end
           end
         end
 

data/lib/serial_spec/parsed_body.rb

@@ -4,57 +4,126 @@ require "active_support/core_ext/hash/indifferent_access"
 module SerialSpec
 
   class ParsedBody
+    class MissingSelectorError < StandardError ; end
+    class NotAnEnumerableObject < StandardError ; end
 
-    attr_reader :raw_body
-    attr_reader :selector
+    include Enumerable
 
-    def initialize(body)
-      @selector = []
-      @raw_body = JSON.parse(body)
+    attr_accessor :raw_body
+    attr_accessor :selector
+    attr_reader   :body
+
+    def initialize(raw_body=nil, options={})
+      @selector = options[:selector] || []
+      @raw_body = raw_body
     end
 
-    def self.add_selector(*methuds)
-      methuds.each do |methud|
-        class_eval <<-METHOD
-          def #{methud.to_s}(*args)
-            selector.push([#{methud.to_sym}, args])
-            self
-          end
-        METHOD
-      end
+    def body
+      @body ||= JSON.parse(raw_body)
     end
 
-    add_selector :first, :last, :[]
+    def each(&block)
+      current_obj = clone.execute
+      raise NotAnEnumerableObject unless current_obj.kind_of?(Hash) or current_obj.kind_of?(Array)
+
+
+
+      if current_obj.kind_of?(Array)
+        current_obj.each_with_index do |item, i|
+          yield(
+            clone.tap do |b|
+              b.selector.push([:[], i])
+            end
+          )
+        end
+      else
+        current_obj.each do |key, value|
+          yield(
+            key,
+            clone.tap do |b|
+              b.selector.push([:[], key])
+            end
+          )
+        end
+      end
+    end
 
     def [](*args)
-      selector.push([:[], *args])
-      self
+      clone.tap do |b|
+        b.selector.push([:[], *args])
+      end
     end
 
     def first(*args)
-      selector.push([:first])
-      self
+      clone.tap do |b|
+        b.selector.push([:first])
+      end
     end
 
     def last(*args)
-      selector.push([:last])
-      self
+      clone.tap do |b|
+        b.selector.push([:last])
+      end
     end
 
     def execute
       copy = selector.clone
       selector.clear
-      copy.inject(raw_body) do |remainder, method_and_args|
-        begin
+      current_selector = []
+
+      failure = catch(:failed) do
+
+        return copy.inject(body) do |remainder, method_and_args|
+          current_selector << method_and_args
           methud, *args = method_and_args
+
+          if [:first, :last].include?(methud) || args.first.kind_of?(Fixnum)
+            throw(:failed, [:expected_array, remainder, current_selector, method_and_args]) unless remainder.kind_of?(Array)
+          else
+            throw(:failed, [:expected_object, remainder, current_selector, method_and_args]) unless remainder.kind_of?(Hash)
+          end
+
           if remainder.kind_of?(Hash)
             remainder.with_indifferent_access.send methud, *args
           else
             remainder.send methud, *args
           end
-        rescue NoMethodError => ex
-          raise ArgumentError, "could not find '#{methud.inspect}' \nfor:\n '#{remainder.inspect}' \nin\n #{raw_body}"
+
         end
+
+      end
+
+      if failure.kind_of?(Array)
+        raise MissingSelectorError, failed_message(*failure)
+      end
+    end
+
+  private ###############################
+
+    def initialize_copy(other)
+      @selector = other.selector.clone
+      @raw_body = other.raw_body
+    end
+
+    def formatted_selector(selector)
+      output = ""
+
+      selector.each do |item|
+        if item.first == :[]
+          output << "[#{item.last.inspect}]"
+        else
+          output << "[#{item.first.inspect}]"
+        end
+      end
+      output
+    end
+
+    def failed_message(msg, remainder, selector, current_selector)
+      case msg
+      when :expected_object
+        "expected an object to have #{formatted_selector([current_selector])}, but found #{remainder.class}:\"#{remainder}\" at #{formatted_selector(selector[0..-2])}"
+      when :expected_array
+        "expected an array at \"#{formatted_selector(selector[0..-2])}\", but found #{remainder.class}:'#{remainder}'"
       end
     end
 

data/lib/serial_spec/request_response.rb

@@ -1,5 +1,6 @@
 require "rack/test"
 require "inheritable_accessors/inheritable_hash_accessor"
+require "inheritable_accessors/inheritable_option_accessor"
 require "serial_spec/request_response/helpers"
 
 module SerialSpec
@@ -7,15 +8,15 @@ module SerialSpec
     extend ActiveSupport::Concern
     include Rack::Test::Methods
     include InheritableAccessors::InheritableHashAccessor
+    include InheritableAccessors::InheritableOptionAccessor
     include Helpers
 
     included do
-      include ::SerialSpec::RequestResponse::DSL
-      extend  ::SerialSpec::RequestResponse::DSL
-
       inheritable_hash_accessor :request_opts
       inheritable_hash_accessor :request_params
       inheritable_hash_accessor :request_envs
+
+      inheritable_option_accessor :request_path, :request_method, for: :request_opts
     end
 
     def perform_request!
@@ -25,30 +26,5 @@ module SerialSpec
       current_session.send :process_request, request_path, env
     end
 
-    module DSL
-
-      def request_path(new_path=nil)
-        if new_path
-          request_opts[:path] = new_path
-        else
-          path = request_opts[:path]
-          return path if path
-          raise "You must configure a path"
-        end
-      end
-
-      # GET, POST, PUT, DELETE, OPTIONS, HEAD
-      def request_method(new_method=nil)
-        if new_method
-          request_opts[:method] = new_method
-        else
-          methud = request_opts[:method]
-          return methud if methud
-          raise "You must configure a request method"
-        end
-      end
-
-    end
-
   end
-end
+end

data/lib/serial_spec/request_response/include_provide_matcher.rb

@@ -0,0 +1,7 @@
+RSpec::Matchers.define :include_a_provided do |expected|
+  match do |actual_list|
+    actual_list.detect do |actual|
+      SerialSpec::RequestResponse::ProvideMatcher::Provide.new(expected).matches?(actual)
+    end
+  end
+end

data/lib/serial_spec/request_response/provide_matcher.rb

@@ -13,7 +13,6 @@ module SerialSpec
         class SerializerNotFound < StandardError ; end
 
         attr_reader :as_serializer
-        attr_reader :with_root
         attr_reader :expected
         attr_reader :actual
 
@@ -22,11 +21,14 @@ module SerialSpec
         def initialize(expected,options={})
           @expected       = expected
           @as_serializer  = options[:as]
-          @with_root      = options[:with_root]
+
+          if @as_serializer and not @as_serializer.instance_methods.include?(:serializable_hash)
+            raise ArgumentError, 'must be an active model serializer'
+          end
         end
 
         def actual_to_hash(actual)
-          if actual.kind_of? SerialSpec::ParsedBody 
+          if actual.kind_of? SerialSpec::ParsedBody
             strip_hypermedia(actual.execute)
           else
             strip_hypermedia(actual)
@@ -35,23 +37,23 @@ module SerialSpec
 
         def resource_serializer
           if as_serializer
-            as_serializer.new(expected, root: with_root)
+            as_serializer.new(expected, root: nil)
           else
             unless expected.respond_to?(:active_model_serializer)
               throw(:failed, :serializer_not_specified_on_class)
             end
-            expected.active_model_serializer.new(expected,root: with_root)
+            expected.active_model_serializer.new(expected, root: nil)
           end
         end
 
         def collection_serializer
           if as_serializer
-            ActiveModel::ArraySerializer.new(expected,serializer: as_serializer, root: with_root )
+            ActiveModel::ArraySerializer.new(expected, serializer: as_serializer, root: nil )
           else
-            ActiveModel::ArraySerializer.new(expected, root: with_root)
+            ActiveModel::ArraySerializer.new(expected, root: nil)
           end
         end
-        
+
         # to_json first to normalize hash and all it's members
         # the parse into JSON to compare to ParsedBody hash
         def expected_to_hash
@@ -65,7 +67,7 @@ module SerialSpec
 
        def normalize_data(data)
           if data.kind_of?(Array)
-            data.each_with_index do |el,index|
+            data.each_with_index do |el, index|
               data[index] = normalize_data(el)
             end
           elsif data.kind_of?(Hash)
@@ -74,17 +76,18 @@ module SerialSpec
         end
 
        def strip_hypermedia(actual)
-         actual.delete_if {|k,v| HYPERMEDIA_ATTRIBUTES.include?(k) }
+         (actual || {}).delete_if {|k,v| HYPERMEDIA_ATTRIBUTES.include?(k) }
        end
 
        def matches?(actual)
-
          failure = catch(:failed) do
+
            unless actual.kind_of?(Hash) || actual.kind_of?(Array) || actual.kind_of?(ParsedBody)
              throw(:failed, :response_not_valid)
            end
-           @actual    = actual_to_hash(actual) 
-           @expected  = expected_to_hash 
+
+           @actual    = actual_to_hash(actual)
+           @expected  = expected_to_hash
 
            if @actual == @expected
              #noop - specs pass
@@ -92,17 +95,17 @@ module SerialSpec
              throw(:failed, :response_and_model_dont_match)
            end
          end
-         @failure_message = failed_message(failure) if failure 
+         @failure_message = failed_message(failure) if failure
          !failure
        end
 
         # when rspec asserts eq
         alias == matches?
 
-        def failed_message(msg) 
+        def failed_message(msg)
           case msg
           when :response_and_model_dont_match
-            "Actual and Expected do not match.\nActual   #{actual}\nExpected #{expected}" 
+            "Actual and Expected do not match.\nActual   #{actual}\nExpected #{expected}"
           when :serializer_not_specified_on_class
             "'active_model_serializer' not implemented on expected, see ehttp://bit.ly/18TdmXs"
           when :response_not_valid

data/lib/serial_spec/version.rb

@@ -1,3 +1,3 @@
 module SerialSpec
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/serial-spec.gemspec

@@ -18,6 +18,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "inheritable_accessors", ">= 0.1.1"
+  spec.add_runtime_dependency "inheritable_accessors", ">= 0.1.2"
   spec.add_runtime_dependency "activesupport",         ">= 3.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serial-spec
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Blake Chambers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-26 00:00:00.000000000 Z
+date: 2015-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inheritable_accessors
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -63,6 +63,7 @@ files:
 - lib/serial_spec/parsed_body.rb
 - lib/serial_spec/request_response.rb
 - lib/serial_spec/request_response/helpers.rb
+- lib/serial_spec/request_response/include_provide_matcher.rb
 - lib/serial_spec/request_response/provide_matcher.rb
 - lib/serial_spec/version.rb
 - serial-spec.gemspec