remarkable_rails 3.0.5 → 3.0.6

data/CHANGELOG

@@ -1,6 +1,23 @@
-[TODO] Port views matchers from rspec to Remarkable to provide I18n.
-
-# v3.0.0
+* Added set_cookies matcher [#51]
+
+* Add a helper to declare that a XmlHttpRequest should be performed:
+
+    describe :get => :show do
+      xhr!
+
+* Macro stubs now supports blocks too [#50]
+
+    expects :human_attribute_name, :on => Project, :with => :title do |attr|
+      attr.to_s.humanize
+    end
+
+* :to option in set_session and set_the_flash now accepts Regexp [#46]
+
+* render_template now works with partials [#43]
+
+* Added to support for routing example group (inside spec/routing) [#26]
+
+# v3.0
 
 [ENHANCEMENT] redirect_to and render_template were ported from rspec-rails to
 remarkable to provide I18n. The second was also extended to deal with :with,

data/lib/remarkable_rails/action_controller/macro_stubs.rb

@@ -62,15 +62,20 @@ module Remarkable
     #
     # You don't have to play with proc all the time. You can call mock_models which
     # creates a class method that simply returns a proc and a instance method that
-    # do the actual mock. In other words, it creates:
-    #
-    #    def self.mock_project
-    #      proc { mock_project }
-    #    end
+    # do the actual mock.
+    #
+    #   describe ProjectsController do
+    #     mock_models :project
+    #
+    # And it creates:
+    #
+    #   def self.mock_project
+    #     proc { mock_project }
+    #   end
     #
-    #    def mock_project(stubs={})
-    #      @project ||= mock_model(Project, stubs)
-    #    end
+    #   def mock_project(stubs={})
+    #     @project ||= mock_model(Project, stubs)
+    #   end
     #
     # Then you can replace those lines:
     #
@@ -84,13 +89,12 @@ module Remarkable
     #
     # = Give me more!
     #
-    # If you need to specify the describe description, you can also do:
+    # If you need to set the example group description, you can also call <tt>get</tt>,
+    # <tt>post</tt>, <tt>put</tt> and <tt>delete</tt> methods:
     #
     #   describe 'my description' do
     #     get :show, :id => 37
     #
-    # Which is the same as above.
-    #
     # Things start to get even better when we start to talk about nested resources.
     # After our ProjectsController is created, we want to create a TasksController:
     #
@@ -112,9 +116,8 @@ module Remarkable
     # As you noticed, you can define parameters that will be available to all requests,
     # using the method <tt>params</tt>.
     #
-    # Finally, if you used expects chain like above, but need to write a spec by
-    # hand you can invoke the action and expectations with run_expectations!,
-    # run_stubs! and run_action!. Examples:
+    # Finally if you need to write a spec by hand, you can invoke the action and
+    # expectations with run_action!, run_expectations! and run_stubs!. Examples:
     #
     #   describe :get => :new do
     #     expects :new, :on => Project, :returns => mock_project
@@ -127,8 +130,8 @@ module Remarkable
     #
     # = Performance!
     #
-    # Remarkable comes with a new way to speed up your tests. It perform the action
-    # inside a before(:all), so you can do:
+    # Remarkable comes with a new way to speed up your tests. It performs the
+    # action inside a before(:all), so you can do:
     #
     #   describe "responding to GET show" do
     #     get! :show, :id => 37
@@ -141,17 +144,16 @@ module Remarkable
     #
     #   describe :get! => :show, :id => 37
     #
-    # The action will be performed just once before asserting the assignment and
-    # the template. If any error happens while performing the action rspec will
-    # output an error but ALL the examples inside the example group (describe) won't
-    # be run.
+    # The action will be performed just once before running the macros. If any
+    # error happens while performing the action, rspec will output an error
+    # but ALL the examples inside the example group (describe) won't be run.
     #
-    # By now, the bang methods works only when integrate_views are true and this is
-    # when you must have the bigger performance gain.
+    # By now, the bang methods works only when integrate_views is true and this
+    # is when you must see a bigger performance gain.
     #
-    # This comes with some rspec and rspec rails tweakings. So if you want to do
-    # something before the action is performed (stubs something or log someone in
-    # session), you have to do it giving a block to the action method:
+    # This feature comes with some rspec and rspec rails tweakings. So if you want
+    # to do something before the action is performed (stubs something or log
+    # someone in session), you have to do it giving a block to the action method:
     #
     #   get! :show, :id => 37 do
     #     login_as(mock_user)
@@ -171,13 +173,15 @@ module Remarkable
       def self.included(base) #:nodoc:
         base.extend ClassMethods
         base.class_inheritable_reader :expects_chain, :default_action, :default_mime,
-                                      :default_verb, :default_params, :before_all_block
+                                      :default_verb, :default_params, :default_xhr,
+                                      :before_all_block
       end
 
       module ClassMethods
 
         # Creates a chain that will be evaluated as stub or expectation. The
-        # first parameter is the method expected.
+        # first parameter is the method expected. Also, a block can be given
+        # to calculate the returned value. See examples below.
         #
         # == Options
         #
@@ -195,10 +199,14 @@ module Remarkable
         #
         # == Example
         #
-        #   expects :new, :on => Project, :returns => :mock_project, :times => 2
+        #   expects :new, :on => Project, :returns => :mock_project, :times => 2
+        #
+        #   expects :human_attribute_name, :on => Project, :with => :title do |attr|
+        #     attr.to_s.humanize
+        #   end
         #
-        def expects(*args)
-          write_inheritable_array(:expects_chain, [args])
+        def expects(*args, &block)
+          write_inheritable_array(:expects_chain, [args << block])
         end
 
         # The mime type of the request. The value given will be called transformed
@@ -227,6 +235,18 @@ module Remarkable
         #
         def params(params)
           write_inheritable_hash(:default_params, params)
+        end
+
+        # Sets the request to perform a XmlHttpRequest.
+        #
+        # == Examples
+        #
+        #   describe TasksController do
+        #     xhr!
+        #   end
+        #
+        def xhr!(bool=true)
+          write_inheritable_attribute(:default_xhr, bool)
         end
 
         [:get, :post, :put, :delete].each do |verb|
@@ -413,7 +433,7 @@ module Remarkable
         def evaluate_expectation_chain(use_expectations=true) #:nodoc:
           return if self.expects_chain.nil?
 
-          self.expects_chain.each do |method, default_options|
+          self.expects_chain.each do |method, default_options, block|
             options = default_options.dup
 
             # Those are used both in expectations and stubs
@@ -423,16 +443,18 @@ module Remarkable
             raise ScriptError, "You have to give me :on as an option when calling :expects." if object.nil?
 
             if use_expectations
-              with  = evaluate_value(options.delete(:with))
-              times = options.delete(:times) || 1
-
               chain = object.should_receive(method)
-              chain = chain.with(with) if with
-              chain = chain.exactly(times).times
+              chain = chain.with(evaluate_value(options.delete(:with))) if options.key?(:with)
+              chain = chain.exactly(options.delete(:times) || 1).times
             else
               chain = object.stub!(method)
+            end
+
+            chain = if block
+              chain.and_return(&block)
+            else
+              chain.and_return(return_value)
             end
-            chain = chain.and_return(return_value)
           end
         end
 
@@ -456,10 +478,11 @@ module Remarkable
         #
         # The first parameter is if you want to run expectations or stubs. You
         # can also supply the verb (get, post, put or delete), which action to
-        # call, parameters and the mime type. If any of those parameters are
-        # supplied, they override the current definition.
+        # call, parameters, the mime type and if a xhr should be performed. If
+        # any of those parameters are supplied, they override the current
+        # definition.
         #
-        def run_action!(use_expectations=true, verb=nil, action=nil, params=nil, mime=nil)
+        def run_action!(use_expectations=true, verb=nil, action=nil, params=nil, mime=nil, xhr=nil)
           return false if controller.send(:performed?)
 
           evaluate_expectation_chain(use_expectations)
@@ -467,11 +490,13 @@ module Remarkable
           mime   ||= default_mime
           verb   ||= default_verb
           action ||= default_action
-          params ||= default_params
+          params ||= default_params
+          xhr    ||= default_xhr
 
           raise ScriptError, "No action was performed or declared." unless verb && action
 
-          request.env["HTTP_ACCEPT"] ||= mime.to_s if mime
+          request.env["HTTP_ACCEPT"] ||= mime.to_s                if mime
+          request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest' if xhr
           send(verb, action, params)
         end
 

data/lib/remarkable_rails/action_controller/matchers/set_cookies_matcher.rb

@@ -0,0 +1,76 @@
+require File.join(File.dirname(__FILE__), 'set_cookies_matcher') 
+
+module Remarkable
+  module ActionController
+    module Matchers
+      class SetCookiesMatcher < SetSessionMatcher #:nodoc:
+
+        # For cookies to work properly, we have:
+        #
+        # On Rails 2.1.2 and 2.2.2:
+        #
+        #   1. Wrap :to values in an array;
+        #   2. When :to is false or nil, make it be an empty array;
+        #   3. Convert all keys to string.
+        #
+        # On Rails 2.3.2:
+        #
+        #   1. Convert :to values to string, unless it's nil
+        #   2. Convert all keys to string.
+        #
+        before_assert do
+          if @subject.request.env.key?("rack.input")
+            @options[:to] = @options[:to].to_s if @options.key?(:to) && !@options[:to].nil?
+          else
+            @options[:to] = @options[:to] ? [@options[:to]] : [] if @options.key?(:to)
+          end
+
+          @keys.collect!(&:to_s)
+        end
+
+        protected
+          def session
+            @subject ? (@subject.response.cookies || {}) : {}
+          end
+
+          def interpolation_options
+            { :cookies_inspect => session.symbolize_keys!.inspect }
+          end
+
+      end
+
+      # Ensures that the given cookie keys were set. If you want to check that
+      # a cookie is not being set, just do:
+      #
+      #   should_not_set_cookies :user
+      #
+      # If you want to assure that a cookie is being set to nil, do instead:
+      #
+      #   should_set_cookies :user, :to => nil
+      #
+      # Note: this method is also aliased as <tt>set_cookie</tt>.
+      #
+      # == Options
+      #
+      # * <tt>:to</tt> - The value to compare the session key.
+      #   It accepts procs and be also given as a block (see examples below).
+      #
+      # == Examples
+      #
+      #   should_set_cookies :user_id, :user
+      #   should_set_cookies :user_id, :to => 2
+      #   should_set_cookies :user, :to => proc{ users(:first) }
+      #   should_set_cookies(:user){ users(:first) }
+      #
+      #   it { should set_cookies(:user_id, :user) }
+      #   it { should set_cookies(:user_id, :to => 2) }
+      #   it { should set_cookies(:user, :to => users(:first)) }
+      #
+      def set_cookies(*args, &block)
+        SetCookiesMatcher.new(*args, &block).spec(self)
+      end
+      alias :set_cookie :set_cookies
+
+    end
+  end
+end

data/lib/remarkable_rails/action_controller/matchers/set_session_matcher.rb

@@ -34,7 +34,7 @@ module Remarkable
             assert_contains(session.values, @options[:to])
           end
 
-          def assigned_value?
+          def assigned_value?
             session.key?(@key)
           end
 
@@ -74,14 +74,14 @@ module Remarkable
 
       end
 
-      # Ensures that a session keys were set. If you want to check that a variable
-      # is not being set, please do:
+      # Ensures that the given session keys were set. If you want to check that
+      # a variable is not being set, just do:
       #
-      #   should_not_set_session(:user)
+      #   should_not_set_session :user
       #
       # If you want to assure that a variable is being set to nil, do instead:
       #
-      #   should_set_session(:user).to(nil)
+      #   should_set_session :user, :to => nil
       #
       # == Options
       #

data/lib/remarkable_rails/action_controller/matchers/set_the_flash_matcher.rb

@@ -16,18 +16,19 @@ module Remarkable
 
       end
 
-      # Ensures that a session keys were set. If you want to check that a flash
-      # is not being set, please do:
+      # Ensures that a flash message is being set. If you want to check that a
+      # flash is not being set, just do:
       #
-      #   should_not_set_the_flash(:user)
+      #   should_not_set_the_flash :user
       #
       # If you want to assure that a flash is being set to nil, do instead:
       #
-      #   should_set_the_flash(:user).to(nil)
+      #   should_set_the_flash :user, :to => nil
       #
       # == Options
       #
-      # * <tt>:to</tt> - The value to compare the flash key. It accepts procs and can also be given as a block (see examples below)
+      # * <tt>:to</tt> - The value to compare the flash key.
+      #   It accepts procs and can also be given as a block (see examples below)
       #
       # == Examples
       #

data/locale/en.yml

@@ -2,7 +2,7 @@ en:
   remarkable:
     action_controller:
       responding: "responding to #{{verb}} {{action}}"
-      mime_type: "with {{format}}"
+      mime_type: "with {{format}}"
 
       assign_to:
         description: "assign {{names}}"
@@ -12,13 +12,13 @@ en:
           is_equal_value: "assign {{name}} to be equal to {{with}}, got {{assign_inspect}}"
         optionals:
           with_kind_of:
-            positive: "with kind of {{value}}"
+            positive: "with kind of {{value}}"
 
       filter_params:
         description: "filter {{params}} parameters from log"
         expectations:
           respond_to_filter_params: "controller to respond to filter_parameters (controller is not filtering any parameter)"
-          is_filtered: "{{param}} to be filtered, got no filtering"
+          is_filtered: "{{param}} to be filtered, got no filtering"
 
       redirect_to:
         description: "redirect to {{expected}}"
@@ -28,7 +28,7 @@ en:
           url_matches: "redirect to {{expected}}, got redirect to {{actual}}"
         optionals:
           with:
-            positive: "with status {{inspect}}"
+            positive: "with status {{inspect}}"
 
       render_template:
         description: "render"
@@ -50,7 +50,7 @@ en:
           body:
             positive: "with body {{inspect}}"
           content_type:
-            positive: "with content type {{inspect}}"
+            positive: "with content type {{inspect}}"
 
       respond_with:
         description: "respond"
@@ -64,13 +64,25 @@ en:
           body:
             positive: "with body {{inspect}}"
           content_type:
-            positive: "with content type {{inspect}}"
+            positive: "with content type {{inspect}}"
 
       route:
         description: "route {{method}} {{path}} to/from {{options}}"
         expectations:
           map_to_path: "to map {{options}} to {{method}} {{path}}, got {{actual}}"
-          generate_params: "to generate params {{options}} from {{method}} {{path}}, got {{actual}}"
+          generate_params: "to generate params {{options}} from {{method}} {{path}}, got {{actual}}"
+
+      set_cookies:
+        description: "set cookies {{keys}}"
+        expectations:
+          is_not_empty: "any cookie to be set, got {{cookies_inspect}}"
+          contains_value: "any cookie to be set to {{to}}, got {{cookies_inspect}}"
+          assigned_value: "cookie {{key}} to be set, got {{cookies_inspect}}"
+          is_equal_value: "cookie {{key}} to be set to {{to}}, got {{cookies_inspect}}"
+        optionals:
+          to:
+            positive: "to {{inspect}}"
+            negative: "to {{inspect}}"
 
       set_session:
         description: "set session variable {{keys}}"
@@ -82,6 +94,7 @@ en:
         optionals:
           to:
             positive: "to {{inspect}}"
+            negative: "to {{inspect}}"
 
       set_the_flash:
         description: "set the flash message {{keys}}"
@@ -92,4 +105,6 @@ en:
           is_equal_value: "flash message {{key}} to be set to {{to}}, got {{flash_inspect}}"
         optionals:
           to:
-            positive: "to {{inspect}}"
+            positive: "to {{inspect}}"
+            negative: "to {{inspect}}"
+

data/spec/action_controller/macro_stubs_spec.rb

@@ -154,10 +154,18 @@ describe 'MacroStubs' do
 
     [:delete, :delete!].each do |method|
 
-      describe method => :destroy, :id => 37 do
-        expects :find,    :on => Task,     :with => '37', :returns => mock_task
-        expects :destroy, :on => mock_task
-
+      describe method => :destroy, :id => '37' do
+        expects :find,    :on => Task, :with => '37', :returns => mock_task
+        expects :destroy, :on => mock_task
+        expects :title,   :on => mock_task, :with => false do |boolean|
+          if boolean
+            'This should not appear'
+          else
+            'My favourite task'
+          end
+        end
+
+        xhr!
         subject { controller }
 
         should_assign_to :task
@@ -166,7 +174,7 @@ describe 'MacroStubs' do
 
         should_set_the_flash
         should_set_the_flash :notice
-        should_set_the_flash :notice, :to => 'Task deleted.'
+        should_set_the_flash :notice, :to => %{"My favourite task" was removed}
 
         should_set_session
         should_set_session :last_task_id
@@ -187,6 +195,11 @@ describe 'MacroStubs' do
 
         it 'should provide a description based on parameters given in describe' do
           self.class.description.should =~ /responding to #DELETE destroy$/
+        end
+
+        it 'should perform a XmlHttpRequest' do
+          run_action!
+          request.env['HTTP_X_REQUESTED_WITH'].should == 'XMLHttpRequest'
         end
       end
 

data/spec/action_controller/set_cookies_matcher_spec.rb

@@ -0,0 +1,150 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe 'set_cookies' do
+  include FunctionalBuilder
+
+  describe 'messages' do
+    before(:each) do
+      @matcher = set_cookies(:user).to(1)
+    end
+
+    it 'should contain a description message' do
+      @matcher = set_cookies(:user)
+      @matcher.description.should == 'set cookies user'
+
+      @matcher.to(1)
+      @matcher.description.should == 'set cookies user to 1'
+    end
+
+    it 'should set is_not_empty? message' do
+      build_response
+      @matcher = set_cookies
+      @matcher.matches?(@controller)
+      @matcher.failure_message.should == 'Expected any cookie to be set, got {}'
+    end
+
+    it 'should set assigned_value? message' do
+      build_response
+      @matcher = set_cookies(:user)
+      @matcher.matches?(@controller)
+      @matcher.failure_message.should == 'Expected cookie user to be set, got {}'
+    end
+
+    if RAILS_VERSION =~ /^2.1/ || RAILS_VERSION =~ /^2.2/
+      it 'should set contains_value? message' do
+        build_response { cookies[:user] = 10 }
+        @matcher = set_cookies.to(1)
+        @matcher.matches?(@controller)
+        @matcher.failure_message.should == 'Expected any cookie to be set to [1], got {:user=>[10]}'
+      end
+
+      it 'should set is_equal_value? message' do
+        build_response { cookies[:user] = 2 }
+        @matcher.matches?(@controller)
+        @matcher.failure_message.should == 'Expected cookie user to be set to [1], got {:user=>[2]}'
+      end
+    else
+      it 'should set contains_value? message' do
+        build_response { cookies[:user] = 10 }
+        @matcher = set_cookies.to(1)
+        @matcher.matches?(@controller)
+        @matcher.failure_message.should == 'Expected any cookie to be set to "1", got {:user=>"10"}'
+      end
+
+      it 'should set is_equal_value? message' do
+        build_response { cookies[:user] = 2 }
+        @matcher.matches?(@controller)
+        @matcher.failure_message.should == 'Expected cookie user to be set to "1", got {:user=>"2"}'
+      end
+    end
+  end
+
+  describe 'matcher' do
+    before(:each) do
+     build_response {
+        cookies[:user]    = 'jose'
+        cookies[:address] = 'Avenue'
+        cookies[:true]    = true
+        cookies[:false]   = false
+        cookies[:nil]     = nil
+      }
+    end
+
+    it { should set_cookies }
+    it { should set_cookies.to('jose') }
+    it { should set_cookies(:user) }
+    it { should set_cookies(:user).to('jose') }
+
+    it { should_not set_cookies.to('joseph') }
+    it { should_not set_cookies(:post) }
+    it { should_not set_cookies(:user).to('joseph') }
+
+    it { should set_cookies(:user){ 'jose' } }
+    it { should set_cookies(:user, :to => proc{ 'jose' }) }
+
+    it { should_not set_cookies(:user).to(nil) }
+    it { should_not set_cookies(:user){ 'joseph' } }
+    it { should_not set_cookies(:user, :to => proc{ 'joseph' }) }
+
+    it { should set_cookies(:true) }
+    it { should set_cookies(:true).to(true) }
+    it { should_not set_cookies(:true).to(false) }
+
+    it { should set_cookies(:false) }
+    it { should set_cookies(:false).to(false) }
+    it { should_not set_cookies(:false).to(true) }
+
+    it { should set_cookies(:nil) }
+    it { should set_cookies(:nil).to(nil) }
+    it { should_not set_cookies(:nil).to(true) }
+  end
+
+  describe 'macro' do
+    before(:each) do
+     build_response {
+        cookies[:user]    = 'jose'
+        cookies[:address] = 'Avenue'
+        cookies[:true]    = true
+        cookies[:false]   = false
+        cookies[:nil]     = nil
+      }
+    end
+
+    should_set_cookies
+    should_set_cookies :to => 'jose'
+    should_set_cookies :user
+    should_set_cookies :user, :to => 'jose'
+
+    should_not_set_cookies :to => 'joseph'
+    should_not_set_cookies :post
+    should_not_set_cookies :user, :to => 'joseph'
+
+    should_set_cookies(:user){ 'jose' }
+    should_set_cookies :user, :to => proc{ 'jose' }
+
+    should_not_set_cookies :user, :to => nil
+    should_not_set_cookies(:user){ 'joseph' }
+    should_not_set_cookies :user, :to => proc{ 'joseph' }
+
+    should_set_cookies :true
+    should_set_cookies :true, :to => true
+    should_not_set_cookies :true, :to => false
+
+    should_set_cookies :false
+    should_set_cookies :false, :to => false
+    should_not_set_cookies :false, :to => true
+
+    should_set_cookies :nil
+    should_set_cookies :nil, :to => nil
+    should_not_set_cookies :nil, :to => true
+  end
+
+  describe 'with no parameter' do
+    before(:each) { build_response }
+
+    should_not_set_cookies
+    it { should_not set_cookies }
+  end
+
+  generate_macro_stubs_specs_for(:set_cookies)
+end

data/spec/application/tasks_controller.rb

@@ -23,7 +23,7 @@ class TasksController < ApplicationController
     @task = Task.find(params[:id])
     @task.destroy
 
-    flash[:notice]         = 'Task deleted.'
+    flash[:notice]         = "#{@task.title(false).inspect} was removed"
     session[:last_task_id] = 37
 
     respond_to do |format|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: remarkable_rails
 version: !ruby/object:Gem::Version 
-  version: 3.0.5
+  version: 3.0.6
 platform: ruby
 authors: 
 - Carlos Brando
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-20 00:00:00 +02:00
+date: 2009-04-22 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,7 +31,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 3.0.5
+        version: 3.0.6
     version: 
 - !ruby/object:Gem::Dependency 
   name: remarkable_activerecord
@@ -41,7 +41,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 3.0.5
+        version: 3.0.6
     version: 
 description: "Remarkable Rails: collection of matchers and macros with I18n for Rails"
 email: 
@@ -74,6 +74,7 @@ files:
 - lib/remarkable_rails/action_controller/matchers/assign_to_matcher.rb
 - lib/remarkable_rails/action_controller/matchers/filter_params_matcher.rb
 - lib/remarkable_rails/action_controller/matchers/redirect_to_matcher.rb
+- lib/remarkable_rails/action_controller/matchers/set_cookies_matcher.rb
 - lib/remarkable_rails/action_controller/matchers/render_template_matcher.rb
 - lib/remarkable_rails/action_view.rb
 - lib/remarkable_rails/action_controller.rb
@@ -121,6 +122,7 @@ test_files:
 - spec/action_controller
 - spec/action_controller/macro_stubs_spec.rb
 - spec/action_controller/assign_to_matcher_spec.rb
+- spec/action_controller/set_cookies_matcher_spec.rb
 - spec/action_controller/set_session_matcher_spec.rb
 - spec/action_controller/redirect_to_matcher_spec.rb
 - spec/action_controller/route_matcher_spec.rb