capybara-slow_finder_errors 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ac8ff324327298695ce17961339c03d8c47649a
+  data.tar.gz: d255a4751b415d6d49d661c76025fd10805b2cd6
+SHA512:
+  metadata.gz: 6a6fba191388f26e7a2ab41db205d7150e606cfbeb0ad3a4ee5544a30e2e9cc1cd15c2f9853a3bad74b9d10a2ca01ca8d75cf318be51e57cd09ec95b2bcdc4ac
+  data.tar.gz: 016d49c366165d7d2b7272acf7eea1cea53ac242f5ffddda2e0bf9b85eb78fe91f6b7257e681cc48ae20ac623ed4e3db8050814e9441d2b328ce2634954791ec

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nick Gauthier
+
+MIT License
+
+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,100 @@
+# Capybara::SlowFinderErrors
+
+Raises an error when you use a capybara finder and it times out.
+
+The goal of this gem is to aid in discovering errors in capybara usage to help speed up your test suite.
+
+## Example
+
+If you do:
+
+```ruby
+refute page.has_content?("An Error Occurred")
+```
+
+To make sure there's no error on the page, the full timeout will be reached because `has_content?` waits for the content to appear. The correct usage is:
+
+```ruby
+assert page.has_no_content?("An Error Occurred")
+```
+
+Which would evaluate quickly.
+
+This gem will raise a `Capybara::SlowFinderError` whenever the first situation occurs. In fact, it raises the error any time a Capybara synchronized piece of code reaches a timeout.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capybara-slow_finder_errors'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capybara-slow_finder_errors
+
+## Usage
+
+Run your test suite as usual. If you have any slow finders, you'll get a stack trace like this:
+
+```
+Capybara::SlowFinderError (Capybara::SlowFinderError)
+/path/to/capybara-slow_finder_errors/lib/capybara/slow_finder_errors.rb:11:in `rescue in synchronize_with_timeout_error'
+/path/to/capybara-slow_finder_errors/lib/capybara/slow_finder_errors.rb:7:in `synchronize_with_timeout_error'
+./features/support/signed_in_user.rb:31:in `signed_in?'
+./features/support/user_helper.rb:59:in `sign_in_as'
+features/configuring_a_project.feature:6:in `Given I am signed in as "herbert@awesomestartup.com"'
+
+execution expired (Timeout::Error)
+/path/to/.gems/gems/poltergeist-1.5.1/lib/capybara/poltergeist/web_socket_server.rb:72:in `select'
+/path/to/.gems/gems/poltergeist-1.5.1/lib/capybara/poltergeist/web_socket_server.rb:72:in `receive'
+/path/to/.gems/gems/poltergeist-1.5.1/lib/capybara/poltergeist/web_socket_server.rb:85:in `send'
+/path/to/.gems/gems/poltergeist-1.5.1/lib/capybara/poltergeist/server.rb:33:in `send'
+/path/to/.gems/gems/poltergeist-1.5.1/lib/capybara/poltergeist/browser.rb:270:in `command'
+/path/to/.gems/gems/poltergeist-1.5.1/lib/capybara/poltergeist/browser.rb:106:in `evaluate'
+/path/to/.gems/gems/poltergeist-1.5.1/lib/capybara/poltergeist/driver.rb:130:in `evaluate_script'
+/path/to/.gems/gems/capybara-2.4.4/lib/capybara/session.rb:527:in `evaluate_script'
+...
+```
+
+If you look at the lines below the gem's trace, you'll see that the slow finder is in `signed_in_user.rb` on line 31 in the `signed_in?` method. Just follow those traces and clean up your code!
+
+## Common Fixes
+
+This section will hopefully grow as people contribute common situations and fixes.
+
+### Inverted Finder
+
+Replace `refute page.has_content?("abc")` with `assert page.has_no_content?("abc")`.
+
+### Boolean Finder
+
+A method that returns a boolean shouldn't use a waiting finder. So:
+
+```ruby
+def signed_in?
+  page.has_content?("Sign out")
+end
+```
+
+Returns true if they are signed in, but it waits a full timeout before returning false. Instead, perform a waiting finder for content that is always present (to ensure the page is loaded) then use a quick finder that doesn't wait:
+
+```ruby
+def signed_in?
+  page.has_content?("Dashboard")
+  page.all('a', :text => 'Home').any?
+end
+```
+
+## Contributing
+
+1. Fork it `https://github.com/ngauthier/capybara-slow_finder_errors/fork`
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/capybara-slow_finder_errors.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "capybara-slow_finder_errors"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Nick Gauthier"]
+  spec.email         = ["ngauthier@gmail.com"]
+  spec.summary       = %q{Raises an error when you use a Capybara finder improperly}
+  spec.description   = %q{If you use a finder that reaches capybara's timeout, and error is raised.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "capybara", "~> 2.0"
+end

data/lib/capybara/slow_finder_errors.rb

@@ -0,0 +1,19 @@
+require 'capybara'
+module Capybara
+  class SlowFinderError < CapybaraError; end
+
+  module Node
+    class Base
+      def synchronize_with_timeout_error(seconds=Capybara.default_wait_time, options = {}, &block)
+        start_time = Time.now
+        synchronize_without_timeout_error(seconds, options, &block)
+      rescue Capybara::ElementNotFound => e
+        if Time.now-start_time > seconds
+          raise SlowFinderError
+        end
+      end
+      alias_method :synchronize_without_timeout_error, :synchronize
+      alias_method :synchronize, :synchronize_with_timeout_error
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: capybara-slow_finder_errors
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Gauthier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: If you use a finder that reaches capybara's timeout, and error is raised.
+email:
+- ngauthier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capybara-slow_finder_errors.gemspec
+- lib/capybara/slow_finder_errors.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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.1
+signing_key: 
+specification_version: 4
+summary: Raises an error when you use a Capybara finder improperly
+test_files: []