capybara-paparazzi 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0918db30feaee777aadd6602accd23680e163f3
-  data.tar.gz: 795c8f76228172eab0178ae0d652e791a9fd367a
+  metadata.gz: fff1e15a40ceebe2d581d6132e1b9d4b1ad4c101
+  data.tar.gz: fec0f04b14a119d04e71c7c2603131e5ff34adbe
 SHA512:
-  metadata.gz: 3018f50429374e6233042df23f6a9d733d32f6328c5ba160815c6eec9cfe674070041ee3787f635d68c034de24198ccaaaf78ad0861ac6e6d475005a4a3c84b9
-  data.tar.gz: b04c98c66a138a672304a5634e866b93ee1177e38d2c9cf568d6b4f98b070e45c2d02da32fe2fc797202fc85becdd2d23bb179b1b8efa1e6195d70c893b6ee51
+  metadata.gz: bd6528b34e4230b5000be4013d167b80eb2ef60036b38a4e2a549e06c50833a2b289ba0bcde9ac9e0619cb4ad8d1cd770df1b34f0c14f4f6c1da80efef05d4b6
+  data.tar.gz: a6656aea3c0fc0084c50d32e9954ab94ec9e4bb20aba510febbc3bc6bb355180a60ee3ec7bf0ef52ee7aa31c9db598fb863d62459d8a9cb8ce42dcb6d72f8884

data/README.md

@@ -13,7 +13,7 @@ Capybara::Paparazzi hooks into Capybara's feature tests and takes
 pictures at significant user actions (like visiting a page, clicking
 buttons, etc.). It relies on a driver that supports saving screenshots
 and executing javascript, and was originally built with Poltergeist in
-mind.
+mind (due to its headless nature).
 
 A few driving principles of Capybara::Paparazzi:
 
@@ -91,6 +91,11 @@ Capybara::Paparazzi.config do |config|
   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.make_fewer_directories = true
+  # config.make_shorter_filenames = true
+  config.path_and_suffix_generator = ->(shooter, url) {
+    shooter.path_and_suffix_for_url(url).collect{|p| p.split('/').last }
+  }
   # config.js_setup_script = ->(shooter){ ... }
   config.js_resize_script = ->(shooter, height) {
     "#{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';"
@@ -160,6 +165,30 @@ you can change the screenshot sizes with
 The first 2 values in the array are width and height, but the whole array
 is made available for use in customized configuration scripts.
 
+### Filenames
+
+By default, a new directory is created to contain the screenshots for
+each distinct URL. There are a few ways to change this if it's not to
+your liking:
+
+1. Use `config.make_fewer_directories = true`, which will skip the last
+   directory level and put screenshots for multiple pages in the same
+   directory.
+
+2. Use `config.make_shorter_filenames = true`, which causes the basenames
+   of the files not to include a representation of the full path
+   (the full path in the basename makes it easier to understand when
+   copied/moved outside of the screenshots directory tree).
+
+3. Override `config.path_and_suffix_generator = ->(shooter, url) {...}`,
+   to return `[path, suffix]` (`suffix` indicates repeated screenshots
+   of the same url).
+
+4. Use `config.before_save_callback = ->(shooter) {...}` to change
+   `shooter.filename`, in which you can access `shooter.screenshot_size`
+   and other attributes.
+
+
 ## Tips & Tricks
 
 ### Turning Capybara::Paparazzi On and Off
@@ -199,9 +228,21 @@ Here's a simple approach that could work for you:
 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.
+### Compatibility
+
+Original development was done in the following environment:
+- capybara 2.2.1
+- poltergeist 1.5.1
+- phantomjs 1.9.7
+- ruby 2.0.0
+- ubuntu 12.04
+
+Capybara::Paparazzi should work with other drivers and platforms.
+It is known to work on OSX, using both poltergeist and
+[webkit](https://github.com/thoughtbot/capybara-webkit) as drivers.
+
+Please open a github issue if you discover a problem with another
+platform or driver.
 
 ## Related Projects
 

data/lib/capybara/paparazzi/shooter.rb

@@ -23,6 +23,11 @@ class Capybara::Paparazzi::Shooter
     js_var_style: {}.merge(DEFAULT_FOLD_STYLE),
     screenshot_sizes: ([] + DEFAULT_SCREENSHOT_SIZES),
     file_dir: 'screenshots',
+    make_fewer_directories: false,
+    make_shorter_filenames: false,
+    path_and_suffix_generator: ->(shooter, url) {
+      shooter.path_and_suffix_for_url(url)
+    },
     js_setup_script: ->(shooter) {
       var_name = shooter.js_var_name
       script = "if (!window.#{var_name}) { #{var_name} = document.createElement('DIV'); #{var_name}.className = '#{var_name}';"
@@ -102,7 +107,7 @@ class Capybara::Paparazzi::Shooter
       num = @path_nums[path]
       @path_nums[path] = num.to_i + 1
       if num
-        suffix = ".#{num}"
+        suffix = "-#{num}"
         if @path_nums[path+suffix]
           suffix = next_suffix_for_path!(path)
         end
@@ -120,7 +125,6 @@ class Capybara::Paparazzi::Shooter
   attr_accessor :driver, :event_details
   attr_accessor :path, :suffix
   attr_accessor :do_shot, :screenshot_size, :filename
-  attr_accessor :before_save_callback
 
   attr_accessor(*CONFIG_VARS.keys)
   # def cv; @cv ||= self.class.config[:cv]; end
@@ -163,11 +167,31 @@ class Capybara::Paparazzi::Shooter
     execute_resize_script(height)
   end
 
+  def path_and_suffix_for_url(url)
+    path = URI.parse(url).path
+    path[0] = '' # remove the leading '/'
+    path[-1] = '' if path[-1] == '/' # remove the trailing '/'
+    path = 'index' if path.empty?
+    base = path.gsub('/','-')
+    if make_fewer_directories
+      unless make_shorter_filenames
+        path = path.sub(/[^\/]*$/, '') + base
+      end
+    else
+      path += '/'
+      unless make_shorter_filenames
+        path += base
+      end
+    end
+    suffix = next_suffix_for_path!(path)
+    [ path, suffix ]
+  end
+
 
   private
 
   def set_path_and_suffix
-    path, suffix = path_and_suffix_for_url(driver.current_url)
+    path, suffix = path_and_suffix_generator.call(self, driver.current_url)
     self.path = path
     self.suffix = suffix
   end
@@ -230,7 +254,10 @@ class Capybara::Paparazzi::Shooter
   def save_snapshot(width_height_rest)
     @do_shot = true
     @screenshot_size = ([] + width_height_rest)
-    @filename = "#{file_dir}#{path}#{suffix}-#{width}.png"
+
+    @filename = "#{file_dir}/#{path}"
+    @filename += '-' unless @filename[-1] == '/'
+    @filename += "#{width}#{suffix}.png"
 
     resize_window(width, height)
 
@@ -257,13 +284,6 @@ class Capybara::Paparazzi::Shooter
     [ filename, { full: true } ]
   end
 
-  def path_and_suffix_for_url(url)
-    path = URI.parse(url).path
-    path += 'index' if path[-1] == '/'
-    suffix = next_suffix_for_path!(path)
-    [ path, suffix ]
-  end
-
   def next_suffix_for_path!(path)
     self.class.next_suffix_for_path!(path)
   end

data/lib/capybara/paparazzi/version.rb

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

metadata

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