rspec-cramp 0.1.1 → 0.1.2

data/README.md

@@ -3,19 +3,22 @@ A set of rspec matchers and helpers that make it easier to write specs for [cram
 Quick start
 -----------
 
-	gem install rspec-cramp
+	> gem install rspec-cramp
 	
 
 
 	require 'rspec/cramp'
 
+	# Decorate your spec with :cramp => true
 	describe HelloWorld, :cramp => true do
+
+	  # You need to define this method
 	  def app
-	    HelloWorld
+	    HelloWorld # Here goes your cramp application, action or http routes.
 	  end
 
+	  # Matching on status code.
 	  it "should respond to a GET request" do
-	    # Various ways to match a response code.
 	    get("/").should respond_with :status => :ok         # Matches responses from 200 to 299.
 	    get("/").should respond_with :status => 200         # Matches only 200.
 	    get("/").should respond_with :status => "200"       # Same as above.
@@ -23,19 +26,45 @@ Quick start
 	    get("/").should_not respond_with :status => :error  # Matches any HTTP error.
 	  end
 
+	  # Matching on response body.
 	  it "should respond with text starting with 'Hello'" do
 	    get("/").should respond_with :body => /^Hello.*/
 	  end
-
 	  it "should respond with 'Hello, world!'" do
 	    get("/").should respond_with :body => "Hello, world!"
 	  end
-  
+
+	  # Matching on response headers.
 	  it "should respond with html" do
 	    get("/").should respond_with :headers => {"Content-Type" => "text/html"}
 	    get("/").should_not respond_with :headers => {"Content-Type" => "text/plain"}
 	    get("/").should_not respond_with :headers => {"Unexpected-Header" => /.*/}
 	  end
+
+	  # Matching using lambdas.
+	  it "should match my sophisticated custom matchers" do
+	    # Entire headers.
+	    status_check = lambda {|status| status.between?(200, 299)}
+	    body_check = lambda {|body| body =~ /.*el.*/}
+	    headers_check = lambda {|headers| true} # Any headers will do.
+	    get("/").should respond_with :status => status_check, :body => body_check, :headers => headers_check
+	    # Header value.
+	    get("/").should respond_with :headers => {"Content-Type" => lambda {|value| value == "text/html"}}
+	    get("/").should_not respond_with :headers => {"Content-Type" => lambda {|value| value == "text/plain"}}
+	  end
+
+	  # Supports POST/GET/PUT/DELETE and you don't have to use the matcher.
+	  it "should work without a matcher" do
+	    get "/"
+	    post "/"
+	    put "/"
+	    delete "/"
+	  end
+
+	  # Request params & custom headers.
+	  it "should accept my params" do
+	    post("/", :params => {:text => "whatever"}, :headers => {"Custom-Header" => "blah"})
+	  end
 	end
 	
 The matcher is fairly flexible, supports regular expressions and also works with multipart responses (more than one `Cramp::Action.render`), SSE and so on. I'll create more examples and docs but for the time being, pls. take a look at the code and [examples](https://github.com/bilus/rspec-cramp/tree/master/spec/examples).
@@ -47,11 +76,15 @@ Project status
 
 **IMPORTANT:** This is work in progress. 
 
-1. There are still some things I'll take care of soon (esp. better failure messages).
-2. I extracted the code from one of my projects and rewrote the matchers from scratch test-first. Still, after the weekend I plan to actually use it to replace the 'legacy' matchers in my project; this will probably uncover some bugs and may make me add more functionality. *UPDATE: I'm working on it right now.*
+There are still some things I'll take care of soon (esp. better failure messages).
 
 If you have any comments regarding the code as it is now (I know it's a bit messy), please feel free to tweet [@MartinBilski](http://twitter.com/#!/MartinBilski)
 
+Contributors
+------------
+
+[Ivan Fomichev](https://github.com/codeholic)
+
 Notes
 ----
 

data/lib/rspec/cramp/matchers/respond_with.rb

@@ -7,6 +7,8 @@ RSpec::Matchers.define :respond_with do |options = {}|
     response.matching?(options)
   end
   
+  # TODO Better message for cases such as: specify { get("/").should respond_with :status => :ok }.
+  
   failure_message_for_should do
     @actual_response.last_failure_message_for_should
   end

data/lib/rspec/cramp/mock_response.rb

@@ -14,8 +14,7 @@ module RSpec
           stopping = false
           deferred_body = @body
           chunks = []
-          deferred_body.each do |chunk|
-            chunks << chunk unless stopping
+          check = lambda do
             if chunks.count >= max_chunks
               @body = chunks
               stopping = true
@@ -23,6 +22,11 @@ module RSpec
               EM.next_tick { EM.stop }
             end            
           end
+          check.call
+          deferred_body.each do |chunk|
+            chunks << chunk unless stopping
+            check.call
+          end
         end
       end
 
@@ -117,8 +121,13 @@ module RSpec
       end
 
       def matching_headers?(expected_header)
-        expected_header.nil? || 
-        (matching_header_keys?(expected_header) && matching_header_values?(expected_header))
+        if expected_header.nil?
+          true
+        elsif expected_header.is_a? Proc
+          matching_response_element?(:headers, @headers, expected_header)
+        else
+          matching_header_keys?(expected_header) && matching_header_values?(expected_header)
+        end
       end
 
       def matching_body?(expected_body)

data/spec/examples/basic_spec.rb

@@ -1,13 +1,16 @@
 require File.join(File.dirname(__FILE__), "../spec_helper")
 require File.join(File.dirname(__FILE__), "sample_actions")
 
+# Decorate your spec with :cramp => true
 describe HelloWorld, :cramp => true do
+  
+  # You need to define this method
   def app
-    HelloWorld
+    HelloWorld # Here goes your cramp application, action or http routes.
   end
 
+  # Matching on status code.
   it "should respond to a GET request" do
-    # Variaus ways to match a response code.
     get("/").should respond_with :status => :ok         # Matches responses from 200 to 299.
     get("/").should respond_with :status => 200         # Matches only 200.
     get("/").should respond_with :status => "200"       # Same as above.
@@ -15,17 +18,43 @@ describe HelloWorld, :cramp => true do
     get("/").should_not respond_with :status => :error  # Matches any HTTP error.
   end
 
+  # Matching on response body.
   it "should respond with text starting with 'Hello'" do
     get("/").should respond_with :body => /^Hello.*/
   end
-
   it "should respond with 'Hello, world!'" do
     get("/").should respond_with :body => "Hello, world!"
   end
   
+  # Matching on response headers.
   it "should respond with html" do
     get("/").should respond_with :headers => {"Content-Type" => "text/html"}
     get("/").should_not respond_with :headers => {"Content-Type" => "text/plain"}
     get("/").should_not respond_with :headers => {"Unexpected-Header" => /.*/}
   end
+  
+  # Matching using lambdas.
+  it "should match my sophisticated custom matchers" do
+    # Entire headers.
+    status_check = lambda {|status| status.between?(200, 299)}
+    body_check = lambda {|body| body =~ /.*el.*/}
+    headers_check = lambda {|headers| true} # Any headers will do.
+    get("/").should respond_with :status => status_check, :body => body_check, :headers => headers_check
+    # Header value.
+    get("/").should respond_with :headers => {"Content-Type" => lambda {|value| value == "text/html"}}
+    get("/").should_not respond_with :headers => {"Content-Type" => lambda {|value| value == "text/plain"}}
+  end
+  
+  # Supports POST/GET/PUT/DELETE and you don't have to use the matcher.
+  it "should work without a matcher" do
+    get "/"
+    post "/"
+    put "/"
+    delete "/"
+  end
+  
+  # Request params & custom headers.
+  it "should accept my params" do
+    post("/", :params => {:text => "whatever"}, :headers => {"Custom-Header" => "blah"})
+  end
 end

data/spec/rspec_cramp_spec.rb

@@ -91,6 +91,10 @@ module Cramp
       end
     end
     
+    class SseNoRenderAction < Cramp::Action
+      self.transport = :sse
+    end
+
     class RequestHeaders < Cramp::Action
       on_start :render_request_headers
       def render_request_headers
@@ -127,10 +131,11 @@ module Cramp
         add('/raise_on_start').to RaiseOnStart
         add('/raise_on_finish').to RaiseOnFinish
         add('/sse').to SseAction
-        add('/get_only').request_method('GET').to SuccessfulResponse
-        add('/post_only').request_method('POST').to SuccessfulResponse
-        add('/put_only').request_method('PUT').to SuccessfulResponse
-        add('/delete_only').request_method('DELETE').to SuccessfulResponse
+        add('/sse_no_render').to SseNoRenderAction
+        get('/get_only').to SuccessfulResponse
+        post('/post_only').to SuccessfulResponse
+        put('/put_only').to SuccessfulResponse
+        delete('/delete_only').to SuccessfulResponse
         add('/request_headers').to RequestHeaders
         add('/request_params').to RequestParams
       end
@@ -160,7 +165,6 @@ module Cramp
           end
         end
         
-        # TODO Rewrite the repetitive code below using data-based spec generation.
         describe "exact match on response status" do
           it "should match successful response" do
             send(method, "/200").should respond_with :status => 200
@@ -255,6 +259,21 @@ module Cramp
           it "should not match iff the header isn't there" do
             send(method, "/custom_header").should_not respond_with :headers => {/Non\-Existent\-One/i => /^QWERTY$/}
           end
+        end  
+        
+        describe "lambda match on entire header " do
+          it "should match when true" do
+            match_headers = lambda do |headers|
+              headers.find {|(k, v)| k == "Extra-Header" && v == "ABCD"}
+            end
+            send(method, "/custom_header").should respond_with :headers => match_headers
+          end
+          it "should not match when false" do
+            match_headers = lambda do |headers|
+              headers.find {|(k, v)| k == "Non-Existent-One" && v == "QWERTY"}
+            end
+            send(method, "/custom_header").should_not respond_with :headers => match_headers
+          end
         end
         
         # FIXME How to handle a situation where nothing is rendered? get reads the body...
@@ -345,6 +364,11 @@ module Cramp
             send(method, "/sse", :max_chunks => 2).should respond_with :chunks => [/^data: Hello 1.*/, /^data: Hello 2.*/]
             send(method, "/sse", :max_chunks => 2).should_not respond_with :chunks => [/.*Incorrect 1.*/, /.*Incorrect 2.*/]
           end
+
+          it "should not wait for body if it is skipped explicitly" do
+            lambda { send(method, "/sse_no_render", :max_chunks => 0) }.should_not raise_error Timeout::Error
+            send(method, "/sse_no_render", :max_chunks => 0).should respond_with :status => 200, :body => ""
+          end
         end
         
         it "should correctly handle exception in the callbacks" do
@@ -385,7 +409,6 @@ module Cramp
         end
       end
       
-      # TODO Add method-specific paths to http routes and write specs.
       describe "GET request" do
         it_should_behave_like "async_request", :get 
         
@@ -437,9 +460,8 @@ module Cramp
         routes
       end
       
-      # TODO Only basic matching here because respond_with matcher uses the same method. 
-      # It should be the other way around, i.e. all the tests should be here but I hate to rewrite the specs now.
-      # Anyway, we need more tests here.
+      # Note: Only basic specs here because respond_with matcher uses the same code and is extensively tested.
+       
       it "should support expectations on response status" do
         get("/200") do |response|
           response.should be_matching :status => 200
@@ -488,4 +510,4 @@ module Cramp
        end
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 require "rubygems"
-require "cramp"
-require "rspec"
+require "bundler/setup"
+
 require "http_router"
 
 $:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))