capybara-timeout_reporter 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03703999c0f4fd8d190a040d1841e44a3f4e854d
-  data.tar.gz: 3d0933e28205bdfd4d893d343a84ad99cdbea023
+  metadata.gz: 62b6f37fe93057ed0c1681182ec3fb4e532856c4
+  data.tar.gz: 80f921a198fea2ceb8c738732aa9804c4f471ed4
 SHA512:
-  metadata.gz: 1c8d91abedf02fa191b066c11dda154072c3c3bba5199a30c98a68d2a618e9498fe9e56eac98979fc3f4b5302b20ee6aeef8b69f641fc7e3297075daf1da259c
-  data.tar.gz: 5fcfbc394e8b8c63e993c095fc678d4d3f8992d5e4ee8c1b7bc61ec91d07f4035dd0bc01dbf78a8da7e605965fe2c7c74a41b7c8246279b3ea09615798176c7e
+  metadata.gz: c677a85c395346f16872102ec32fbc755c7e9de6ec035db9495d9a020b656e2749011d84cc0ba84517d83e022b5a3de419a60ac1f5e33ec2c76a796a84e3a1a8
+  data.tar.gz: d8142a55529e44ad4419e8f34454e60d0276b48037847dfa52486607ac3111ea56ac2dfd4df5c37ae2b8f81787a4f622b4cdf18e88f49239d363da6081e22132

data/README.md

@@ -1,10 +1,78 @@
 # Capybara::TimeoutReporter
 
+[![Gem Version](https://badge.fury.io/rb/capybara-timeout_reporter.svg)](http://badge.fury.io/rb/capybara-timeout_reporter)
+
 Speed up your Capybara tests by detecting and fixing finders that reach sync timeout.
 
+# Description
+
+Capybara gem is very popular in ruby community for browser-based UI test automation of web apps. Capybara has quite powerful [synchronization mechanism](https://github.com/jnicklas/capybara#asynchronous-javascript-ajax-and-friends) built in, which allows you to write tests that wait automatically until AJAX requests are completed, elements become visible, etc. However, very often engineers do not keep this Capybara feature in mind and write code like this:
+
+```
+# this line will be executing for 'Capybara.default_wait_time' seconds
+refute page.has_css?('.some-non-existent-class')
+```
+
+Or like this:
+
+```
+if page.has_css?('.some_class')
+  # no timeout occured in this case
+else
+  # "has_css?(...)" will be executing for 'Capybara.default_wait_time' seconds in this case
+end
+```   
+
+Wrong usage of Capybara makes your tests slow!
+
+capybara-timeout_reporter gem helps you to detect all places where your finders are reaching a timeout and report them. 
+
+
+# Installation
+
+```
+gem install capybara-timeout_reporter
+```
+or if you're using bundler, add this line to Gemfile:
+
+```
+gem 'capybara-timeout_reporter
+```
+
+# Usage
+
+Just load it after capybara gem:
+
+```
+require 'capybara'
+# load timeout_reporter after capybara
+require 'capybara/timeout_reporter'
+```
+
+## Basic usage
+
+Default beviour, in case of Capybara sync timeout the following warning will be printed into STDOUT:
+
+```
+[WARNING] Capybara find timed out after <number_of_seconds> seconds in </path/to/file.rb>:<line_number> 
+```
+
+## Advanced usage
+
+```
+# somewhere in your test_helper.rb, spec_helper.rb, evn.rb, etc.
+Capybara::TimeoutReporter.on_timeout = Proc.new do |timeout_value, src_line|
+  # do whatever you want, for example:
+  # - raise an exception, if you want to make this strict 
+  # - add an entry to test report, if you have one
+  # - write to a log file
+  # - collect all timeouts and then report a total time wasted
+end
+```
+
 ## Contributing
 
-1. Fork it `https://github.com/vgiroguk/capybara-timeout_reporter/fork`
+1. Fork it `https://github.com/vgrigoruk/capybara-timeout_reporter/fork`
 2. Create your feature branch (`git checkout -b new-feature`)
 3. Commit your changes (`git commit -am 'Added feature'`)
 4. Push to the branch (`git push origin new-feature`)

data/capybara-timeout_reporter.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "capybara-timeout_reporter"
-  spec.version       = "0.0.2"
+  spec.version       = "0.0.3"
   spec.authors       = ["Vitalii Grygoruk"]
   spec.email         = ["vitaliy[dot]grigoruk[at]gmail[dot]com"]
   spec.summary       = %q{Detecting and reporting capybara sync timeouts}

data/lib/capybara/timeout_reporter.rb

@@ -8,10 +8,10 @@ module Capybara
 
     class << self
       attr_accessor :on_timeout
-    end
 
-    def self.on_timeout=(proc)
-      @on_timeout = proc
+      def on_timeout=(proc)
+        @on_timeout = proc
+      end
     end
   end
 
@@ -22,7 +22,7 @@ module Capybara
         synchronize_without_warning(seconds, options, &block)
       rescue Capybara::ElementNotFound => e
         if Time.now-start_time > seconds
-          trace_line = Thread.current.backtrace.find { |l| !l.include?('gems/capybara')}
+          trace_line = Thread.current.backtrace.find { |l| !l.include?('gems/capybara') }
           src_line = trace_line.match(/(.*):.*/).captures.first
           Capybara::TimeoutReporter.on_timeout.call(seconds, src_line)
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capybara-timeout_reporter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Vitalii Grygoruk