capybara-paparazzi 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e37b4dd76d939ff8af81d07dffd57b8bec00451
-  data.tar.gz: f0b32e133aae2070f4c533b645eca45b9de6dfe1
+  metadata.gz: e89cf9a779d19b87c627cd39e5c1f3af6ffec94d
+  data.tar.gz: 868eaf3ec57b1ce4b66362e47bbb2d5314607192
 SHA512:
-  metadata.gz: 875d8f5a8f55c4c79435cd577fde4da551fda8a42b1b56f83bc1419ff3bea67b12100eb088fc13b7ccc5a95706a6a4945c7116efdabb575c2cc563b5772e6557
-  data.tar.gz: e15368acf07fe259bf8f7e7330a385e2cea4f83b1ff6ef5f594a48800f358b78cd9444230986c23f064ed5a6092d21de9e81c90a4e010954edc40473899b5204
+  metadata.gz: 5e74bb486bb34ffeed96221f450854bf42e4540f777a3c70aa433468de4c8b7c65e80191c159793943ca80eab3e06e1dc502982feb9117fd7365bcabd2ec418d
+  data.tar.gz: 47e943d68d50a492271f101a8dc01a9e97c3c524a96cd8802865b32c525e30767614dd393730ad8c8663c074bad5f4f5af7532a821de135acf6ee23b1a844036

data/README.md

@@ -17,6 +17,7 @@ mind.
 
 A few driving principles of Capybara::Paparazzi:
 
+- **Responsive**: It can take screenshots in whatever sizes you want.
 - **Unobtrusive**: You shouldn't need to edit your feature test scenarios
   to get screenshots.
 - **Easy**: Simple to set up, and out-of-the-box settings should get you far.
@@ -105,6 +106,21 @@ end
 
 For the default settings, see [shooter.rb](https://github.com/sbull/capybara-paparazzi/blob/master/lib/capybara/paparazzi/shooter.rb).
 
+### 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
+the page without navigating to a different page. You can call
+
+    take_snapshots
+
+in your scenarios to manually capture the page.
+(`take_snapshots` is also known as `paparazzi_take_snapshots`,
+in case you use something else that defines `take_snapshots` differently.)
+
+You can leave these calls in your code even when you're not using
+`#follow`, and they will be no-ops.
+
 ### Screenshot Sizes
 
 Capybara::Paparazzi uses default screen sizes to represent common
@@ -121,8 +137,14 @@ a shorter view than the actual device height.
 Use an environment variable to turn screenshots on or off.
 You probably don't want them running all the time, and only
 need them on occasion:
-
-    Capybara::Paparazzi.follow(Capybara.default_driver, Capybara.javascript_driver) if ENV['CAPYBARA_PAPARAZZI_ENABLED']
+```ruby
+if ENV['CAPYBARA_PAPARAZZI_DIR'].present?
+  Capybara::Paparazzi.config do |config|
+    config.file_dir = ENV['CAPYBARA_PAPARAZZI_DIR']
+    config.follow(Capybara.default_driver, Capybara.javascript_driver)
+  end
+end
+```
 
 ### Driver Setup
 
@@ -141,10 +163,50 @@ Here's a simple approach that could work for you:
   1. `require 'capybara/poltergeist'`
   2. `Capybara.javascript_driver = :poltergeist`
 
+## TODO
+
+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.
+
+## Related Projects
+
+- [Capybara](https://github.com/jnicklas/capybara)
+- [Capybara::Animate](https://github.com/cpb/capybara-animate) - makes animated .gifs of scenarios.
+- [capybara-screenshot](https://github.com/mattheworiordan/capybara-screenshot) - takes screenshots of failing scenarios.
+- [Headless](https://github.com/leonid-shevtsov/headless) - has ways to capture screenshots and video.
+
 ## Contributing
 
+### Generic Github Instructions
+
 1. Fork it
 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 new Pull Request
+
+### Working on a Gem
+
+You can read up on how to develop a local gem on
+[rubygems.org](http://guides.rubygems.org/make-your-own-gem/).
+
+Here's the TL;DR:
+
+1. Make your edits.
+2. Update the version (lib/capybara/paparazzi/version.rb), say to `0.0.1.new`.
+3. `gem build capybara-paparazzi.gemspec`
+4. `gem install ./capybara-paparazzi-0.0.1.new.gem`
+5. In your project that uses Capybara::Paparazzi:
+  1. Update your Gemfile to say `gem 'capybara-paparazzi', '0.0.1.new'
+  2. `bundle install`
+
+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
+
+In your project:
+
+    rm vendor/cache/capybara-paparazzi-0.0.1.new.gem && bundle

data/lib/capybara-paparazzi.rb

@@ -1,6 +1,7 @@
 require 'capybara'
 
 require 'capybara/paparazzi/version'
+require 'capybara/paparazzi/dsl'
 require 'capybara/paparazzi/shooter'
 require 'capybara/paparazzi/driver'
 require 'capybara/paparazzi/element'
@@ -24,8 +25,14 @@ module Capybara::Paparazzi
       @used_drivers ||= {}
     end
 
-    def take_snapshots(driver, event_details=nil)
-      Capybara::Paparazzi::Shooter.take_snapshots(driver, event_details)
+    def take_snapshots(driver, event, args)
+      Capybara::Paparazzi::Shooter.take_snapshots(driver, { event: event, args: args })
+    end
+
+    def take_snapshots_if_following(driver, event, args)
+      if driver.is_a?(Capybara::Paparazzi::Driver)
+        take_snapshots(driver, event, args)
+      end
     end
 
   end # ClassMethods
@@ -33,6 +40,10 @@ module Capybara::Paparazzi
   extend ClassMethods
 end
 
+module Capybara::DSL
+  include Capybara::Paparazzi::DSL
+end
+
 class Capybara::Node::Element
   include Capybara::Paparazzi::Element
 end

data/lib/capybara/paparazzi/driver.rb

@@ -1,14 +1,9 @@
 module Capybara::Paparazzi::Driver
 
-  # TODO: go_back, go_forward
-
   def visit(*args)
-    super(*args)
-    take_snapshots(:visit, args)
-  end
-
-  def take_snapshots(method, args)
-    Capybara::Paparazzi.take_snapshots(self, { method: method, args: args })
+    response = super(*args)
+    Capybara::Paparazzi.take_snapshots(self, :visit, args)
+    response
   end
 
 end

data/lib/capybara/paparazzi/dsl.rb

@@ -0,0 +1,13 @@
+module Capybara::Paparazzi::DSL
+
+  def paparazzi_take_snapshots(*args)
+    Capybara::Paparazzi.take_snapshots_if_following(page.driver, :manual, args)
+  end
+
+  def self.included(mod)
+    unless mod.method_defined?(:take_snapshots)
+      mod.send(:alias_method, :take_snapshots, :paparazzi_take_snapshots)
+    end
+  end
+
+end

data/lib/capybara/paparazzi/element.rb

@@ -2,9 +2,7 @@ module Capybara::Paparazzi::Element
 
   def click_with_paparazzi(*args)
     response = click_without_paparazzi(*args)
-    if session.driver.respond_to?(:take_snapshots)
-      session.driver.take_snapshots(:click, args)
-    end
+    Capybara::Paparazzi.take_snapshots_if_following(session.driver, :click, args)
     response
   end
 

data/lib/capybara/paparazzi/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-paparazzi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Steven Bull
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-27 00:00:00.000000000 Z
+date: 2014-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +70,7 @@ files:
 - capybara-paparazzi.gemspec
 - lib/capybara-paparazzi.rb
 - lib/capybara/paparazzi/driver.rb
+- lib/capybara/paparazzi/dsl.rb
 - lib/capybara/paparazzi/element.rb
 - lib/capybara/paparazzi/session.rb
 - lib/capybara/paparazzi/shooter.rb