capybara-paparazzi 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e89cf9a779d19b87c627cd39e5c1f3af6ffec94d
-  data.tar.gz: 868eaf3ec57b1ce4b66362e47bbb2d5314607192
+  metadata.gz: c0918db30feaee777aadd6602accd23680e163f3
+  data.tar.gz: 795c8f76228172eab0178ae0d652e791a9fd367a
 SHA512:
-  metadata.gz: 5e74bb486bb34ffeed96221f450854bf42e4540f777a3c70aa433468de4c8b7c65e80191c159793943ca80eab3e06e1dc502982feb9117fd7365bcabd2ec418d
-  data.tar.gz: 47e943d68d50a492271f101a8dc01a9e97c3c524a96cd8802865b32c525e30767614dd393730ad8c8663c074bad5f4f5af7532a821de135acf6ee23b1a844036
+  metadata.gz: 3018f50429374e6233042df23f6a9d733d32f6328c5ba160815c6eec9cfe674070041ee3787f635d68c034de24198ccaaaf78ad0861ac6e6d475005a4a3c84b9
+  data.tar.gz: b04c98c66a138a672304a5634e866b93ee1177e38d2c9cf568d6b4f98b070e45c2d02da32fe2fc797202fc85becdd2d23bb179b1b8efa1e6195d70c893b6ee51

data/README.md

@@ -87,13 +87,13 @@ Here's a fairly complete list of things you can do:
 
 ```ruby
 Capybara::Paparazzi.config do |config|
-  config.js_var_name = 'MY_DIV' # Name of the div used to draw the fold line.
+  config.js_var_name = 'MY_FOLD_DIV' # Name of the div used to draw the fold line.
   config.js_var_style.merge!(color: 'red', fontWeight: 'bold')
   config.screenshot_sizes = [ config.screenshot_sizes.first, (config.screenshot_sizes.last + [ :EXTRA_DATA ]) ]
   config.file_dir = '../screenshots'
   # config.js_setup_script = ->(shooter){ ... }
   config.js_resize_script = ->(shooter, height) {
-    "#{shooter.js_var_name}.style.height = '#{height}px'; MY_DIV.textContent = #{shooter.screenshot_size.inspect.to_json}; MY_DIV.style.fontSize = '#{height/4}px';"
+    "#{shooter.js_var_name}.style.height = '#{height}px'; MY_FOLD_DIV.textContent = #{shooter.screenshot_size.inspect.to_json}; MY_FOLD_DIV.style.fontSize = '#{height/4}px';"
   }
   # config.js_cleanup_script = ->(shooter){}
   config.before_save_callback = ->(shooter) {
@@ -106,7 +106,31 @@ end
 
 For the default settings, see [shooter.rb](https://github.com/sbull/capybara-paparazzi/blob/master/lib/capybara/paparazzi/shooter.rb).
 
-### Manual screenshots
+### Skipping Screenshots
+
+Many test flows might have common steps that are just plain redundant
+to keep capturing. Disabling Capybara::Paparazzi for those flows could
+be useful. Here's how:
+```ruby
+without_snapshots do
+  visit root_path # <-- your stuff
+end
+```
+
+`without_snapshots` is also known as `without_paparazzi`.
+
+You can also disable Capybara::Paparazzi in scenarios by calling
+
+    turn_snapshots_off
+
+(aka `turn_paparazzi_off`), but then you'll have to turn it back on
+for future scenarios by calling
+
+    turn_snapshots_on
+
+(aka `turn_paparazzi_on`).
+
+### Manual Screenshots
 
 Try as it might, Capybara::Paparazzi could miss some photos that you
 want it to take, particularly if you're using javascript to change
@@ -128,7 +152,13 @@ phone, tablet, and desktop browser dimensions. The most important
 feature is the width. The height is used to draw the "fold" line - the
 default sizes attempt to take into account the browser chrome that
 gets added to the top and bottom of browser windows, which results in
-a shorter view than the actual device height.
+a shorter view than the actual device height. As indicated above,
+you can change the screenshot sizes with
+
+    config.screenshot_sizes = [ [ 1920, 1080, 'my big', 'screen' ] ]
+
+The first 2 values in the array are width and height, but the whole array
+is made available for use in customized configuration scripts.
 
 ## Tips & Tricks
 
@@ -165,10 +195,14 @@ Here's a simple approach that could work for you:
 
 ## TODO
 
-The photo-capturing triggers may be incomplete, and enhancements may be
+- The photo-capturing triggers may be incomplete, and enhancements may be
 needed to be sure to capture everything. Currently, `visit` and `click`
 are the primary triggers.
 
+- Development has only been done with Poltergeist on an Ubuntu
+virtual machine, but the intent is to work with other drivers & setups.
+So feedback on that would be appreciated.
+
 ## Related Projects
 
 - [Capybara](https://github.com/jnicklas/capybara)
@@ -205,7 +239,7 @@ Some useful one-liners for the above:
 
 In `capybara-paparazzi` repository:
 
-    gem uninstall capybara-paparazzi && gem build capybara-paparazzi.gemspec && gem install ./capybara-paparazzi-0.0.1.new.gem Successfully uninstalled capybara-paparazzi-0.0.1.new
+    gem uninstall capybara-paparazzi && gem build capybara-paparazzi.gemspec && gem install ./capybara-paparazzi-0.0.1.new.gem
 
 In your project:
 

data/lib/capybara-paparazzi.rb

@@ -35,6 +35,20 @@ module Capybara::Paparazzi
       end
     end
 
+    def without_snapshots(driver, &block)
+      Capybara::Paparazzi::Shooter.without_snapshots(driver) do
+        yield
+      end
+    end
+
+    def turn_off(driver)
+      Capybara::Paparazzi::Shooter.turn_off(driver)
+    end
+
+    def turn_on(driver)
+      Capybara::Paparazzi::Shooter.turn_on(driver)
+    end
+
   end # ClassMethods
 
   extend ClassMethods

data/lib/capybara/paparazzi/driver.rb

@@ -1,5 +1,9 @@
 module Capybara::Paparazzi::Driver
 
+  def capybara_paparazzi_settings
+    @capybara_paparazzi_settings ||= {}
+  end
+
   def visit(*args)
     response = super(*args)
     Capybara::Paparazzi.take_snapshots(self, :visit, args)

data/lib/capybara/paparazzi/dsl.rb

@@ -4,9 +4,28 @@ module Capybara::Paparazzi::DSL
     Capybara::Paparazzi.take_snapshots_if_following(page.driver, :manual, args)
   end
 
+  def turn_paparazzi_off
+    Capybara::Paparazzi.turn_off(page.driver)
+  end
+
+  def turn_paparazzi_on
+    Capybara::Paparazzi.turn_on(page.driver)
+  end
+
+  def without_paparazzi(&block)
+    Capybara::Paparazzi.without_snapshots(page.driver) do
+      yield
+    end
+  end
+
   def self.included(mod)
-    unless mod.method_defined?(:take_snapshots)
-      mod.send(:alias_method, :take_snapshots, :paparazzi_take_snapshots)
+    [
+     [ :paparazzi_take_snapshots, :take_snapshots ],
+     [ :without_paparazzi, :without_snapshots ],
+     [ :turn_paparazzi_off, :turn_snapshots_off ],
+     [ :turn_paparazzi_on, :turn_snapshots_on ],
+    ].each do |meth, aka|
+      mod.send(:alias_method, aka, meth) unless mod.method_defined?(aka)
     end
   end
 

data/lib/capybara/paparazzi/shooter.rb

@@ -14,17 +14,18 @@ class Capybara::Paparazzi::Shooter
     left: '0',
     width: '100%',
     zIndex: 999999,
-    borderBottom: '1px solid red',
+    background: 'none',
+    borderBottom: '3px dashed red',
   }.freeze
 
   CONFIG_VARS = {
-    js_var_name: 'THE_FOLD',
+    js_var_name: 'CAPYBARA_PAPARAZZI_FOLD',
     js_var_style: {}.merge(DEFAULT_FOLD_STYLE),
     screenshot_sizes: ([] + DEFAULT_SCREENSHOT_SIZES),
     file_dir: 'screenshots',
     js_setup_script: ->(shooter) {
       var_name = shooter.js_var_name
-      script = "if (!window.#{var_name}) { #{var_name} = document.createElement('DIV');"
+      script = "if (!window.#{var_name}) { #{var_name} = document.createElement('DIV'); #{var_name}.className = '#{var_name}';"
       shooter.js_var_style.each do |prop_name, prop_val|
         script += "#{var_name}.style.#{prop_name} = #{prop_val.to_json};"
       end
@@ -59,7 +60,40 @@ class Capybara::Paparazzi::Shooter
 
     def take_snapshots(driver, event_details=nil)
       # TODO: Be smarter. One shooter per driver, but avoid memory leaks (be mindful of Guard, etc.).
-      new(driver, event_details).take_snapshots
+      unless driver.capybara_paparazzi_settings[:block_disabled] || driver.capybara_paparazzi_settings[:manually_disabled]
+        new(driver, event_details).take_snapshots
+      end
+    end
+
+    def without_snapshots(driver, &block)
+      is_paparazzi = is_paparazzi?(driver)
+      if is_paparazzi
+        old_val = driver.capybara_paparazzi_settings[:block_disabled]
+        driver.capybara_paparazzi_settings[:block_disabled] = true
+      end
+      begin
+        yield
+      ensure
+        if is_paparazzi
+          driver.capybara_paparazzi_settings[:block_disabled] = old_val
+        end
+      end
+    end
+
+    def turn_off(driver)
+      if is_paparazzi?(driver)
+        driver.capybara_paparazzi_settings[:manually_disabled] = true
+      end
+    end
+
+    def turn_on(driver)
+      if is_paparazzi?(driver)
+        driver.capybara_paparazzi_settings[:manually_disabled] = false
+      end
+    end
+
+    def is_paparazzi?(driver)
+      driver.is_a?(Capybara::Paparazzi::Driver)
     end
 
     def next_suffix_for_path!(path)
@@ -125,6 +159,20 @@ class Capybara::Paparazzi::Shooter
   end
 
   def resize_window(width, height)
+    driver_resize_window(width, height)
+    execute_resize_script(height)
+  end
+
+
+  private
+
+  def set_path_and_suffix
+    path, suffix = path_and_suffix_for_url(driver.current_url)
+    self.path = path
+    self.suffix = suffix
+  end
+
+  def driver_resize_window(width, height)
     begin
       if driver.respond_to?(:resize) # Poltergeist
         driver.resize(width, height)
@@ -135,17 +183,8 @@ class Capybara::Paparazzi::Shooter
       end
     rescue => e
       log("Error while resizing window: #{e}")
+      raise
     end
-    execute_resize_script(height)
-  end
-
-
-  private
-
-  def set_path_and_suffix
-    path, suffix = path_and_suffix_for_url(driver.current_url)
-    self.path = path
-    self.suffix = suffix
   end
 
   def execute_setup_script
@@ -161,12 +200,30 @@ class Capybara::Paparazzi::Shooter
       end
     rescue => e
       log("#{e.message}\nJavascript: #{script_text}")
+      raise
     end
   end
 
   def save_snapshots
-    screenshot_sizes.each do |w_h_rest|
-      save_snapshot(w_h_rest)
+    # In some cases, using screen sizes other than the default
+    # can cause failures in Poltergeist, when using the default
+    # screen size does not. So be sure to always reset to the
+    # original screen size to ensure test behavior consistent with
+    # the non-Capybara::Paparazzi tests.
+    # Example error:
+    # Firing a click at co-ordinates [703, 654] failed. Poltergeist detected another element with CSS selector '' at this position. It may be overlapping the element you are trying to interact with. If you don't care about overlapping elements, try using node.trigger('click').
+
+    begin
+      orig_width, orig_height = driver.evaluate_script("[window.innerWidth, window.innerHeight]")
+      screenshot_sizes.each do |w_h_rest|
+        save_snapshot(w_h_rest)
+      end
+    ensure
+      begin
+        driver_resize_window(orig_width, orig_height)
+      rescue => e
+        log("Error restoring original window size to #{orig_width}x#{orig_height}: #{e}")
+      end
     end
   end
 

data/lib/capybara/paparazzi/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Paparazzi
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-paparazzi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Steven Bull
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2014-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler