bbq 0.0.4 → 0.1.0

data/.travis.yml

@@ -1,5 +1,7 @@
 script: bundle exec rake test
 rvm:
+  - 1.9.3
   - 1.9.2
   - 1.8.7
   - ree
+  - rbx-19mode

data/CHANGELOG

@@ -1,12 +1,35 @@
-0.0.3
+0.1.0 / 2013-01-06
+==================
 
-* Added support and tests for Sinatra
-* Added Bbq.app and Bbq.app=
+  * Extracted Rails' URL helpers inclusion to separate module
+  * Include only Capybara::Session::DSL_METHODS in TestUser, not the whole Capybara::DSL
+  * Added Capybara sessions pool
+  * Moved Test::User default options to separate method
+  * Added Test::Client for testing REST APIs
+  * Renamed bbq/test.rb to bbq/test_unit.rb. You may want to fix your test_helper.
+  * Moved require bbq/test_user to generated test_user.rb. You may want to update your existing test_user.rb.
+	* Fixed Capybara 'within' scope for RSpec flavour
 
-0.0.2
+0.0.4 / 2011-10-19
+==================
 
-* ...
+  * Make bbq work with capybara 1.0 and 1.1
+  * rails is development dependency
 
-0.0.1
+0.0.3 / 2011-07-14
+==================
 
-* ...
+  * Added support and tests for Sinatra
+  * Added Bbq.app and Bbq.app=
+
+0.0.2 / 2011-07-01
+==================
+
+  * Extracted Bbq::TestUser::Eyes module
+  * Added :within option to TestUser methods
+  * Fix tests for ree and ruby187
+
+0.0.1 / 2011-04-20
+==================
+
+  * BBQ introduced to the wild world!

data/README.md

@@ -3,7 +3,7 @@ Warning & disclaimer
 
 This gem is currently under development. We're targeting most popular use cases - Rails & Rack applications (ex. Sinatra). However the philosophy behind it is not limited to Rails nor web applications in general. There is even example usage with EventMachine. Feel free to modify it for your own needs.
 
-[![Build Status](https://secure.travis-ci.org/drugpl/bbq.png)](http://travis-ci.org/drugpl/bbq)
+[![Build Status](https://secure.travis-ci.org/drugpl/bbq.png)](http://travis-ci.org/drugpl/bbq) [![Dependency Status](https://gemnasium.com/drugpl/bbq.png)](https://gemnasium.com/drugpl/bbq)
 
 BBQ
 ===
@@ -42,7 +42,7 @@ First, add BBQ to your apps Gemfile:
 
 ```ruby
 # Gemfile
-gem "bbq", "~> 0.0.2"
+gem "bbq", :git => "git://github.com/drugpl/bbq"
 ```
 
 Run install generator:
@@ -54,7 +54,7 @@ rails generate bbq:install
 Require BBQ in test/test_helper.rb (in case of Test::Unit):
 
 ```ruby
-require "bbq/test"
+require "bbq/test_unit"
 ```
 
 Require BBQ in spec/spec_helper.rb (in case of RSpec):
@@ -99,9 +99,14 @@ module Roundtrip
       click_on "Add update"
     end
 
+    def open_application
+      visit '/'
+    end
+
     module TicketReporter
       def open_tickets_listing
-        visit tickets_path
+        open_application
+        click_link 'Tickets'
       end
 
       def open_ticket(summary, description)
@@ -119,8 +124,13 @@ module Roundtrip
     end
 
     module TicketManager
+      def open_administration
+        visit '/admin'
+      end
+
       def open_tickets_listing
-        visit admin_tickets_path
+        open_administration
+        click_link 'Tickets'
       end
 
       def close_ticket(summary, comment = nil)
@@ -174,6 +184,67 @@ class AdminTicketsTest < Bbq::TestCase
 end
 ```
 
+Testing REST APIs
+================
+
+Bbq provides `Bbq::TestClient`, similar to `Bbq::TestUser`, but intended for testing APIs.
+It's a thin wrapper around `Rack::Test` which allows you to send requests and run assertions
+against responses.
+
+```ruby
+class ApiTest < Bbq::TestCase
+  background do
+    headers = {'HTTP_ACCEPT' => 'application/json'}
+    @client = TestClient.new(:headers => headers)
+  end
+
+  scenario "admin can browse all user tickets" do
+    @client.get "/unicorn" do |response|
+      assert_equal 200, response.status
+      assert_equal "pink", response.body["unicorn"]["color"]
+    end
+    @client.post "/ponies", { :name => "Miracle" } do |response|
+      assert_equal 200, response.status
+    end
+  end
+end
+```
+
+Rails' URL Helpers
+================
+
+Using url helpers from Rails in integration tests is not recommended.
+Testing routes is part of integration test, so you should actually use only
+
+```ruby
+  visit '/'
+```
+
+in your integration test. Use links and buttons in order to get to other pages in your app.
+
+If you really need url helpers in your test user, just include them in your TestUser class:
+
+```ruby
+require 'bbq/rails/routes'
+
+module Roundtrip
+  class TestUser < Bbq::TestUser
+    include Bbq::Rails::Routes
+  end
+end
+```
+or just
+
+```ruby
+module Roundtrip
+  class TestUser < Bbq::TestUser
+    include ::ActionDispatch::Routing::UrlFor
+    include ::Rails.application.routes.url_helpers
+    include ::ActionDispatch::Routing::RouteSet::MountedHelpers unless ::Rails.version < "3.1"
+  end
+end
+```
+
 Deal with Devise
 ================
 
@@ -202,28 +273,18 @@ Caveats
 <h2>Timeout::Error</h2>
 
 If you simulate multiple users in your tests and spawn multiple browsers with selenium it might
-be a good idea to use `Mongrel` instead of `Webrick` to create application server.
-We have experienced some problems with `Webrick` that lead to `Timeout::Error` exception
+be a good idea to use Thin instead of Webrick to create application server.
+We have experienced some problems with Webrick that lead to `Timeout::Error` exception
 when user/browser that was inactive for some time (due to other users/browsers
 activities) was requested to execute an action.
 
-Put this code into a file loaded before running any acceptance scenario like:
-`test/test_helper.rb` or `spec/spec_helper.rb`:
-
-```ruby
-Capybara.server do |app, port|
-  require 'rack/handler/mongrel'
-  Rack::Handler::Mongrel.run(app, :Port => port)
-end
-```
-
-Add `mongrel` to your `Gemfile`:
+Capybara will use Thin instead of Webrick when it's available, so you only need to add Thin to you Gemfile:
 
 ```ruby
 # In test group if you want it to
 # be used only in tests and not in your development mode
 # ex. when running 'rails s'
-gem 'mongrel', "1.2.0.pre2", :require => false
+gem 'thin', :require => false
 ```
 
 Development environment

data/bbq.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "capybara",  "~> 1.0"
+  s.add_dependency "activesupport",  ">= 2.0"
 
   s.add_development_dependency "sqlite3",     "~> 1.3.3"
   s.add_development_dependency "rake",        "~> 0.8.7"

data/lib/bbq.rb

@@ -1,21 +1,17 @@
 require 'pathname'
 
 module Bbq
-  def self.root
-    @root ||= Pathname.new(File.expand_path(File.join(File.dirname(__FILE__), '..')))
-  end
-
-  def self.rails?
-    defined?(::Rails)
-  end
+  class << self
+    def root
+      @root ||= Pathname.new(File.expand_path(File.join(File.dirname(__FILE__), '..')))
+    end
 
-  def self.app
-    Capybara.app
-  end
+    def rails?
+      defined?(::Rails)
+    end
 
-  def self.app=(new_app)
-    Capybara.app=(new_app)
+    attr_accessor :app
   end
 end
 
-require 'bbq/railtie' if Bbq.rails?
+require 'bbq/railtie' if Bbq.rails?

data/lib/bbq/devise.rb

@@ -5,6 +5,11 @@ if defined?(Devise)
     module Devise
       attr_accessor :devise_authentication_key, :email, :password, :scope
 
+      def self.included(klass)
+        require 'bbq/rails/routes'
+        klass.send(:include, Bbq::Rails::Routes)
+      end
+
       def initialize_devise
         @devise_initialized ||= begin
           self.devise_authentication_key = ::Devise.authentication_keys.first

data/lib/bbq/rails/routes.rb

@@ -0,0 +1,13 @@
+module Bbq
+  module Rails
+    module Routes
+      def self.included(klass)
+        klass.send(:include, ::ActionDispatch::Routing::UrlFor)
+        klass.send(:include, ::Rails.application.routes.url_helpers)
+        unless ::Rails.version < "3.1"
+          klass.send(:include, ::ActionDispatch::Routing::RouteSet::MountedHelpers) 
+        end
+      end
+    end
+  end
+end

data/lib/bbq/railtie.rb

@@ -2,6 +2,10 @@ require 'rails/generators'
 
 module Bbq
   class Railtie < Rails::Railtie
+    initializer "bqq.set_app" do
+      Bbq.app = Rails.application
+    end
+
     rake_tasks do
       load Bbq.root.join("lib/tasks/bbq.rake")
     end

data/lib/bbq/roles.rb

@@ -0,0 +1,12 @@
+require 'bbq/util'
+
+module Bbq
+  module Roles
+    def roles(*names)
+      names.each do |name|
+        module_obj = Bbq::Util.find_module(name, self)
+        self.extend(module_obj)
+      end
+    end
+  end
+end

data/lib/bbq/rspec.rb

@@ -1,5 +1,6 @@
+require 'bbq'
+require 'bbq/session'
 require 'rspec/core'
-require 'bbq/test_user'
 require 'capybara/rspec/matchers'
 
 module Bbq
@@ -13,45 +14,51 @@ module Bbq
   end
 
   module RSpecMatchers
-    class TestUserEyes
-      def initialize(negative, *args)
-        @args, @negative = args, negative
-      end
-
-      def matches?(actual)
-        @negative ? actual.not_see?(*@args) : actual.see?(*@args)
-      end
+    extend RSpec::Matchers::DSL
 
-      def failure_message_for_should
-        "expected to #{@negative ? negative_description : positive_description}"
+    matcher :see do |text|
+      chain :within do |locator|
+        @locator = locator
       end
 
-      def failure_message_for_should_not
-        "expected to #{@negative ? positive_description : negative_description}"
+      match_for_should do |page|
+        if @locator
+          page.within(@locator) do
+            page.see? text
+          end
+        else
+          page.see? text
+        end
       end
 
-      def description
-        @negative ? negative_description : positive_description
+      match_for_should_not do |page|
+        if @locator
+          page.within(@locator) do
+            page.not_see? text
+          end
+        else
+          page.not_see? text
+        end
       end
 
-      protected
-
-      def negative_description
-        "not see any of the following: #{@args.join(', ')}"
+      failure_message_for_should do |page|
+        body = if @locator
+          page.find(@locator).text
+        else
+          page.body
+        end
+        "expected to see #{text} in #{body}"
       end
 
-      def positive_description
-        "see all of the following: #{@args.join(', ')}"
+      failure_message_for_should_not do |page|
+        body = if @locator
+          page.find(@locator).text
+        else
+          page.body
+        end
+        "expected not to see #{text} in #{body}"
       end
     end
-
-    def see(*args)
-      TestUserEyes.new(false, *args)
-    end
-
-    def not_see(*args)
-      TestUserEyes.new(true, *args)
-    end
   end
 
   class TestUser
@@ -60,15 +67,11 @@ module Bbq
     include Bbq::RSpecMatchers
 
     def see!(*args)
-      args.each do |arg|
-        page.should have_content(arg)
-      end
+      see?(*args).should be_true
     end
 
     def not_see!(*args)
-      args.each do |arg|
-        page.should have_no_content(arg)
-      end
+      not_see?(*args).should be_true
     end
   end
 end
@@ -87,4 +90,8 @@ RSpec.configuration.include Bbq::RSpecFeature, :type => :acceptance
 RSpec.configure do |config|
   config.include Capybara::RSpecMatchers, :type => :acceptance
   config.include Bbq::RSpecMatchers, :type => :acceptance
+
+  config.after :each, :type => :acceptance do
+    Bbq::Session.pool.release
+  end
 end

data/lib/bbq/session.rb

@@ -0,0 +1,60 @@
+module Bbq
+  module Session
+    extend self
+
+    def next(options = {})
+      driver = options.delete(:driver)
+      pool   = options.delete(:pool)
+
+      if pool
+        pool.next(driver)
+      else
+        create(driver)
+      end
+    end
+
+    def create(driver)
+      Capybara::Session.new(driver, Bbq.app)
+    end
+
+    def pool
+      @pool ||= Pool.new
+    end
+
+    class Pool
+      attr_accessor :idle, :taken
+
+      def initialize
+        @idle   = []
+        @taken  = []
+      end
+
+      def next(driver)
+        take_idle(driver) || create(driver)
+      end
+
+      def release
+        taken.each(&:reset!)
+        idle.concat(taken)
+        taken.clear
+      end
+
+      private
+
+      def take_idle(driver)
+        idle.find { |s| s.mode == driver }.tap do |session|
+          if session
+            idle.delete(session)
+            taken.push(session)
+          end
+        end
+      end
+
+      def create(driver)
+        Bbq::Session.create(driver).tap do |session|
+          taken.push(session)
+        end
+      end
+    end
+  end
+end