capybara_turbolinks 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 48092d0f36c8e4258b4460f8bd945430555df9ab
+  data.tar.gz: 857cb2e29975c63c0201375eb1cd7c68f1f93f0b
+SHA512:
+  metadata.gz: baacb03171c79a8a5a7c9836061ad6a6fcd2af4fd034da77ff1651b1e93489e2c921992ed1016de196b289241f78bae3de1fc81738483b44a79bc2d09d2b8ecb
+  data.tar.gz: a535afd2859d72d549db5c256d5795823a3d07592ceec334a0c4b69e1e37c0c3070402206d3c3505b71ab86f20a785836e5a36763bf68b8d4980d74a96cdf303

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capybara_turbolinks.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Brendan Asselstine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# Capybara Turbolinks
+
+Extends Capybara with methods that mitigate race conditions introduced by Turbolinks caching.
+
+Turbolinks is a page loading mechanism introduced in Rails 4.  It's default behaviour is to cache pages on the client side, so that page loading appears extremely fast.  This caching (and Turbolinks itself) can be problematic; the shopify team decided to [disable caching entirely](https://github.com/rails/turbolinks/issues/551).  We decided to keep the page caching, because it was so fast.  However, we experienced race conditions in our integration tests. 
+
+From a Capybara and integration test point of view, the caching is problematic because it loads the page twice; once with the cached page, and a second time with the actual page from the server.
+
+This causes issues with integration tests that block until they see certain page content or selectors, because the integration tests continue before the *actual* page has been loaded from the server.
+
+This gem's solution is to add a small amount of JavaScript code in the test environment that adds and removes classes to the body tag that correspond to the Turbolinks page lifecycle.  This allows us to use Capybara #has_css? to block until we have detected that the Turbolinks request is complete.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capybara_turbolinks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capybara_turbolinks
+
+## Usage
+
+This gem extends Capybara by adding two additional methods:
+
+```ruby
+Capybara::Node::Actions#click_turbolink
+```
+
+and
+
+```ruby
+Capybara::Node::Element#turboclick
+``` 
+  
+When you are clicking a link that triggers turbolinks, you will need to use one of the above methods.  For example:
+
+```ruby
+  visit root_path
+  click_turbolink 'View all deals'
+```
+
+Or when you are finding an element to click on:
+
+```ruby
+  visit root_path
+  find('a.all-deals').turboclick
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Loft47/capybara_turbolinks.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/assets/javascripts/capybara_turbolinks.coffee.erb

@@ -0,0 +1,7 @@
+<% if Rails.env.test? %>
+$(document).on 'page:fetch', ->
+  $('body').removeClass('page--complete').addClass('page--fetch')
+
+$(document).on 'page:partial-load, page:load', ->
+  $('body').removeClass('page--fetch').addClass('page--complete')
+<% end %>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capybara_turbolinks"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capybara_turbolinks.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capybara_turbolinks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capybara_turbolinks"
+  spec.version       = CapybaraTurbolinks::VERSION
+  spec.authors       = ["Brendan Asselstine"]
+  spec.email         = ["mail.asselstine@gmail.com"]
+
+  spec.summary       = %q{Extends Capybara to elegantly handle Turbolinks}
+  spec.description   = %q{This gem will help you ensure that your Capybara tests wait for Turbolinks to finish page loads.}
+  spec.homepage      = "http://github.com/Loft47/capybara_turbolinks" 
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "capybara", ">= 2.4" 
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/capybara_turbolinks.rb

@@ -0,0 +1,3 @@
+require "capybara_turbolinks/version"
+require 'capybara_turbolinks/capybara'
+require 'capybara_turbolinks/engine' if defined?(Rails)

data/lib/capybara_turbolinks/capybara.rb

@@ -0,0 +1,45 @@
+require 'capybara'
+
+module CapybaraTurbolinks 
+  FETCH_CSS_SELECTOR='body.page--fetch'
+  COMPLETE_CSS_SELECTOR='body.page--complete'
+
+  module ::Capybara
+    module Node
+      module Actions 
+        class_eval do
+          def click_turbolink(*args)
+            click_link(*args)
+            has_css? FETCH_CSS_SELECTOR
+            has_css? COMPLETE_CSS_SELECTOR 
+          end
+        end
+      end
+      class Element < Base
+        class_eval do 
+          def turboclick 
+            click
+            session.has_css? FETCH_CSS_SELECTOR
+            session.has_css? COMPLETE_CSS_SELECTOR
+          end
+        end
+      end
+    end
+    class Session
+      class_eval do
+        define_method :click_turbolink do |*args, &block|
+          @touched = true
+          current_scope.send(:click_turbolink, *args, &block)
+        end
+      end
+    end
+    module DSL
+      class_eval do
+        define_method :click_turbolink do |*args, &block|
+          page.send :click_turbolink, *args, &block
+        end
+      end
+    end
+  end
+end
+

data/lib/capybara_turbolinks/engine.rb

@@ -0,0 +1,5 @@
+module CapybaraTurbolinks
+  # Your code goes here...
+  class Engine < Rails::Engine
+  end
+end

data/lib/capybara_turbolinks/version.rb

@@ -0,0 +1,3 @@
+module CapybaraTurbolinks
+  VERSION = "0.1.4"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: capybara_turbolinks
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Brendan Asselstine
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem will help you ensure that your Capybara tests wait for Turbolinks
+  to finish page loads.
+email:
+- mail.asselstine@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/capybara_turbolinks.coffee.erb
+- bin/console
+- bin/setup
+- capybara_turbolinks.gemspec
+- lib/capybara_turbolinks.rb
+- lib/capybara_turbolinks/capybara.rb
+- lib/capybara_turbolinks/engine.rb
+- lib/capybara_turbolinks/version.rb
+homepage: http://github.com/Loft47/capybara_turbolinks
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Extends Capybara to elegantly handle Turbolinks
+test_files: []