transactional_capybara 0.1.0.pre.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1734358fb0654defcb9c353940bf2e34ab7da006
-  data.tar.gz: caa82834cde32a345c9fd643b037d30e26d333f9
+  metadata.gz: b47fe9a7d758b60e2a61d02a9efc54683c04c958
+  data.tar.gz: 2fad7e2694272847292391264521c9edac1ec55b
 SHA512:
-  metadata.gz: 20c099399240513932b8814c8d5f18a40c77c59066768329014e4bef6592daeed2381c8f38a14832e109df98588b490017d372748d605b7890ced743578f02cf
-  data.tar.gz: 6a21b2f64c446f345ba7d2ecc5a43ed2ca1232c373c5a35ab45cc078e9e988af29a5637a28353c6a360a0560924d77cd32e7d32523468b39ccaccf573ba11fa1
+  metadata.gz: 489e7e2d50f51dcb9d15fe8eb9198d2b09c71b394157e704ecbe9360e8070b63f8890f60834f9889ec560ced5fe84881610b7b35cf19a4be325d391272597672
+  data.tar.gz: d2fd46c45b0cc39fa8acfe71b538be2988cd9fa956571693378936e4a9a7f319462245122927b3eb074eea7296bbb25527743ca1cb46b31a21a129b880949c01

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/.ruby-version

@@ -1 +1 @@
-2.2.2
+2.3.1

data/.travis.yml

@@ -4,6 +4,7 @@ rvm:
   - "2.0"
   - "2.1"
   - "2.2"
+  - "2.3.1"
 before_install:
   - "/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -ac -screen 0 1280x1024x16"
   - "export DISPLAY=:99.0"
@@ -12,4 +13,4 @@ before_script:
   - psql -c 'create database transactional_capybara_test;' -U postgres
   - "cp spec/{.travis.,}config.yml"
 script: bundle exec rake test:all
-sudo: false
+cache: bundler

data/Gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: .
+  specs:
+    transactional_capybara (0.1.0.pre.3)
+      capybara
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+    activerecord (4.2.4)
+      activemodel (= 4.2.4)
+      activesupport (= 4.2.4)
+      arel (~> 6.0)
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    capybara (2.4.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    capybara-webkit (1.6.0)
+      capybara (>= 2.3.0, < 2.5.0)
+      json
+    childprocess (0.5.6)
+      ffi (~> 1.0, >= 1.0.11)
+    cliver (0.3.2)
+    diff-lcs (1.2.5)
+    ffi (1.9.10)
+    i18n (0.7.0)
+    json (1.8.3)
+    mime-types (2.6.1)
+    mini_portile (0.6.2)
+    minitest (5.8.0)
+    multi_json (1.11.2)
+    mysql2 (0.3.20)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    pg (0.18.2)
+    poltergeist (1.6.0)
+      capybara (~> 2.1)
+      cliver (~> 0.3.1)
+      multi_json (~> 1.0)
+      websocket-driver (>= 0.2.0)
+    rack (1.6.4)
+    rack-protection (1.5.3)
+      rack
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.1)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubyzip (1.1.7)
+    selenium-webdriver (2.47.1)
+      childprocess (~> 0.5)
+      multi_json (~> 1.0)
+      rubyzip (~> 1.0)
+      websocket (~> 1.0)
+    sinatra (1.4.6)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    sqlite3 (1.3.10)
+    thread_safe (0.3.5)
+    tilt (2.0.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    websocket (1.2.2)
+    websocket-driver (0.6.2)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  bundler (~> 1.3)
+  capybara-webkit
+  mysql2
+  pg
+  poltergeist
+  rake
+  rspec
+  selenium-webdriver
+  sinatra
+  sqlite3
+  transactional_capybara!
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -1,12 +1,16 @@
 # Database Transactions 💜 Capybara
 
-You want your specs to use transactions for speed 🐎🐎🐎.
+[![Build Status]](https://travis-ci.org/iangreenleaf/transactional_capybara)
 
-But as soon as you try it with Capybara, things go wrong 💻💥.
+You want your specs to use transactions for speed 🐎🐎🐎
+
+But as soon as you try it with Capybara, things go wrong 💻💥
 
 Don't flip tables.
 Use this instead.
 
+For a detailed explanation of how this works, refer to the [introductory blog post].
+
 ## Setup ##
 
 Add it to your Gemfile, of course:
@@ -47,6 +51,50 @@ after :each do
 end
 ```
 
+## Manually waiting for AJAX ##
+
+You might have situations where you need to wait for AJAX calls to complete at times other than teardown.
+For example, you might have a pattern like this if you access models directly for either setup or verification of results:
+
+```ruby
+visit "/page-that-fires-ajax"
+Model.where(whatever).first
+```
+
+This can still fail!
+The ideal solution is to avoid direct database manipulation in integration tests.
+However, if you insist on doing this, you can stay safe by waiting for AJAX to complete before continuing:
+
+```ruby
+visit "/page-that-fires-ajax"
+TransactionalCapybara::AjaxHelpers.wait_for_ajax(page)
+Model.where(whatever).first
+```
+
+If you'd like the helper more easily accessible, just mix the `AjaxHelpers` module into your test suite.
+In RSpec, you can do this in the config block:
+
+```ruby
+RSpec.configure do |config|
+  config.include TransactionalCapybara::AjaxHelpers
+end
+```
+Or in any example group:
+
+```ruby
+describe "awesome web stuff" do
+  include TransactionalCapybara::AjaxHelpers
+end
+```
+
+Now the helper is easily available:
+
+```ruby
+visit "/page-that-fires-ajax"
+wait_for_ajax
+Model.where(whatever).first
+```
+
 ## DatabaseCleaner ##
 
 For this gem to be able to help with AJAX, it needs to be invoked *before* DatabaseCleaner rolls back the transaction.
@@ -99,6 +147,8 @@ Right now this gem automatically fixes the following things:
  * jQuery
  * Angular
 
+Tested on Capybara 2.4.x, may not work on other major versions.
+
 Don't see something you want?
 I'd love a pull request, or even just a friendly inquiry!
 
@@ -106,9 +156,9 @@ I'd love a pull request, or even just a friendly inquiry!
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Make your changes. Don't forget to add a test!
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Think about how I'm a bad person for not writing any tests yet
 6. Create new Pull Request
 
 ### Running the tests ###
@@ -119,3 +169,6 @@ DB=sqlite rspec spec
 ```
 
 You can run the specs with other databases as well, but you will have to create the databases and users manually first.
+
+[Build Status]: https://travis-ci.org/iangreenleaf/transactional_capybara.svg?branch=master
+[introductory blog post]: http://technotes.iangreenleaf.com/posts/the-one-true-guide-to-database-transactions-with-capybara.html

data/Rakefile

@@ -11,7 +11,7 @@ namespace :test do
     db_config = YAML.load_file(File.join(File.dirname(__FILE__), "spec/config.yml"))
     db_config["database"].keys.each do |db_name|
       ENV['DB'] = db_name
-      %w[selenium webkit].each do |driver|
+      %w[selenium webkit poltergeist].each do |driver|
         ENV['DRIVER'] = driver
         puts ENV.to_hash.slice 'DRIVER', 'DB'
         Rake::Task['test:rspec'].reenable
@@ -19,4 +19,19 @@ namespace :test do
       end
     end
   end
+
+  desc "Run the test server for manual debugging"
+  task :server do
+    db_type = ENV['DB'] || 'sqlite'
+    db_config = YAML.load_file(File.join(File.dirname(__FILE__), "spec/config.yml"))
+    db = db_config["database"][db_type]
+    require 'active_record'
+    ActiveRecord::Base.establish_connection(db)
+    load File.join(File.dirname(__FILE__), "spec/support/schema.rb")
+    require_relative './spec/support/server'
+    require_relative './spec/support/model'
+    TestValue.create! content: "This is a server response"
+    AjaxServer.should_return_from_ajax = true
+    AjaxServer.run!
+  end
 end

data/lib/transactional_capybara/ajax_helpers.rb

@@ -20,14 +20,11 @@ module TransactionalCapybara
       end
 
       def finished_ajax_requests?
-        (
-          angular_requests
-          + jquery_requests
-        ).zero?
+        ( angular_requests + jquery_requests ).zero?
       end
 
       # TODO: timeout each individual session
-      def wait_until(timeout=Capybara.default_wait_time)
+      def wait_until(timeout=default_timeout)
         Timeout.timeout(timeout) do
           until yield
             sleep(0.01)
@@ -44,6 +41,16 @@ module TransactionalCapybara
         Capybara.send :session_pool
       end
 
+      # Handle Capybara.default_wait_time deprecation
+      # https://github.com/jnicklas/capybara/pull/1502
+      def default_timeout
+        @default_timeout ||= begin
+          Capybara.respond_to?(:default_max_wait_time) ?
+            Capybara.default_max_wait_time :
+            Capybara.default_wait_time
+        end
+      end
+
       # Another hack, to see if Capybara sessions have been used
       def is_session_touched?(session)
          session.instance_variable_get(:@touched)
@@ -54,12 +61,12 @@ module TransactionalCapybara
       end
 
       def angular?
-        run_js("!!window.angular") && run_js("angular.element('[ng-app]').length") > 0
+        run_js("!!window.angular") && run_js("!!document.querySelector('[ng-app]')")
       end
 
       def angular_requests
         if angular?
-          run_js("angular.element('[ng-app]').injector().get('$http').pendingRequests.length")
+          run_js("angular.element(document.querySelector('[ng-app]')).injector().get('$http').pendingRequests.length")
         else
           0
         end

data/lib/transactional_capybara/version.rb

@@ -1,3 +1,3 @@
 module TransactionalCapybara
-  VERSION = "0.1.0.pre.3"
+  VERSION = "0.1.0"
 end

data/spec/ajax_spec.rb

@@ -9,9 +9,10 @@ RSpec.describe "server with AJAX", type: :feature, js: true do
     TestValue.create! content: @expected_message
   end
 
-  it "waits for AJAX" do
-    visit "/page_with_ajax"
+  it "waits for AJAX from jQuery" do
+    visit "/ajax/jquery"
     expect(page).to have_content("Hello")
+    click_link "Do AJAX"
     Thread.fork do
       sleep 0.5
       AjaxServer.should_return_from_ajax = true
@@ -21,10 +22,40 @@ RSpec.describe "server with AJAX", type: :feature, js: true do
     expect(find(".message").text).to eq(@expected_message)
   end
 
+  it "waits for AJAX from Angular" do
+    visit "/ajax/angular"
+    expect(page).to have_content("Hello")
+    click_link "Do AJAX"
+    Thread.fork do
+      sleep 0.5
+      AjaxServer.should_return_from_ajax = true
+    end
+    expect(find(".message").text).not_to eq(@expected_message)
+    TransactionalCapybara::AjaxHelpers.wait_for_ajax(page)
+    expect(find(".message").text).to eq(@expected_message)
+  end
+
+  context "mixed in" do
+    include TransactionalCapybara::AjaxHelpers
+    it "provides wait_for_ajax helper" do
+      visit "/ajax/jquery"
+      expect(page).to have_content("Hello")
+      click_link "Do AJAX"
+      Thread.fork do
+        sleep 0.5
+        AjaxServer.should_return_from_ajax = true
+      end
+      expect(find(".message").text).not_to eq(@expected_message)
+      wait_for_ajax
+      expect(find(".message").text).to eq(@expected_message)
+    end
+  end
+
   context "after hook", check_result_after: true do
     it "automatically waits for AJAX" do
-      visit "/page_with_ajax"
+      visit "/ajax/jquery"
       expect(page).to have_content("Hello")
+      click_link "Do AJAX"
       Thread.fork do
         sleep 0.5
         AjaxServer.should_return_from_ajax = true
@@ -35,8 +66,9 @@ RSpec.describe "server with AJAX", type: :feature, js: true do
 
   it "waits on all sessions" do
     using_session :foo do
-      visit "/page_with_ajax"
+      visit "/ajax/jquery"
       expect(page).to have_content("Hello")
+      click_link "Do AJAX"
     end
 
     using_session :bar do
@@ -57,8 +89,9 @@ RSpec.describe "server with AJAX", type: :feature, js: true do
     AjaxServer.should_return_from_ajax = false
 
     using_session :bar do
-      visit "/page_with_ajax"
+      visit "/ajax/jquery"
       expect(page).to have_content("Hello")
+      click_link "Do AJAX"
     end
 
     Thread.fork do
@@ -71,4 +104,18 @@ RSpec.describe "server with AJAX", type: :feature, js: true do
       expect(find(".message").text).to eq(@expected_message)
     end
   end
+
+  it "uses Capybara.default_max_wait_time if available" do
+    allow(Capybara).to receive(:default_max_wait_time).and_return(5)
+    expect(Capybara).to receive(:default_max_wait_time).at_least(:once)
+
+    TransactionalCapybara::AjaxHelpers.wait_for_ajax(page)
+  end
+
+  it "fallbacks on deprecated Capybara.default_wait_time" do
+    allow(Capybara).to receive(:respond_to?).with(:default_max_wait_time).and_return(false)
+    expect(Capybara).to receive(:default_wait_time).at_least(:once)
+
+    TransactionalCapybara::AjaxHelpers.wait_for_ajax(page)
+  end
 end

data/spec/spec_helper.rb

@@ -8,6 +8,7 @@ ActiveRecord::Base.establish_connection(db)
 load File.join(File.dirname(__FILE__), "support/schema.rb")
 
 require 'capybara/rspec'
+require 'capybara/poltergeist'
 require 'capybara-webkit'
 
 capybara_driver = ENV['DRIVER'] || 'selenium'

data/spec/support/server.rb

@@ -3,17 +3,23 @@ require 'tilt/erb'
 require_relative 'model'
 
 class AjaxServer < Sinatra::Base
+  set :public_folder, File.dirname(__FILE__) + '/vendor'
+
   cattr_accessor :should_return_from_ajax
 
   get "/boring_page" do
     erb "Hi", layout: :basic
   end
 
-  get "/page_with_ajax" do
-    erb :page_with_ajax, layout: :basic
+  get "/ajax/jquery" do
+    erb :jquery, layout: :basic
+  end
+
+  get "/ajax/angular" do
+    erb :angular, layout: :basic
   end
 
-  get "/ajax_endpoint" do
+  get "/ajax/endpoint" do
     until AjaxServer.should_return_from_ajax do
       sleep 0.01
     end