persistent_selenium 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 John Bintz
+
+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,50 @@
+Now you can keep that precious browser window open when doing continuous integration testing.
+Save seconds, and sanity, with every test re-run!
+
+Also, the browser stays open at its last state so you can inspect it and more easily
+fix your tests and/or code.
+
+Start an instance:
+
+``` bash
+persistent_selenium [ --port 9854 ] [ --browser firefox ]
+```
+
+Tell Capybara to use it:
+
+```
+# features/support/env.rb
+
+require 'persistent_selenium/driver'
+Capybara.default_driver = :persistent_selenium
+```
+
+If you're using Cucumber, you can also install that hook:
+
+``` bash
+persistent_selenium install
+```
+
+Should work just the same as if you used the standard Capybara Selenium driver, except for
+these two differences:
+
+* The browser starts up first thing and sticks around, so you don't pay the startup/shutdown
+  penalty with each test run.
+* The last page you were on before your tests passed/failed stays there, so you can inspect it
+  and adjust your tests.
+
+The browser's cache is disabled, and cookies are reset before the next test runs, so you still get the state
+cleared out before your next set of tests.
+
+### Under the hood
+
+It's DRb, which mostly Just Works (tm), and has a little reshuffling of the default Capybara Selenium driver's code.
+
+#### When DRb doesn't Just Work (tm)
+
+You're most likely using `all` and invoking an action on one of the nodes within, I'd wager. If you need to find a node
+to perform an action on, it's best to stick with `find`, since it's less likely that node will go out of
+ObjectSpace that quickly. If you need to examine the document for particular properties, and `all` seems like
+the best way to do it, instead try parsing the document body with Nokogiri and using its finders.
+That way, all your node searching will be done on the client end.
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/persistent_selenium

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path('../../lib', __FILE__)
+
+require 'persistent_selenium/cli'
+
+GC.disable
+PersistentSelenium::CLI.start

data/lib/persistent_selenium/browser.rb

@@ -0,0 +1,102 @@
+require 'capybara'
+require 'capybara/selenium/driver'
+require 'base64'
+
+module PersistentSelenium
+  class Browser < Capybara::Selenium::Driver
+    def initialize(browser_type)
+      @browser_type = browser_type
+      @__found_elements__ = []
+    end
+
+    def browser
+      case @browser_type
+      when :firefox
+        profile = Selenium::WebDriver::Firefox::Profile.new
+        profile['browser.cache.disk.enable'] = false
+        profile['browser.cache.memory.enable'] = false
+        profile['browser.cache.offline.enable'] = false
+        profile['network.http.use-cache'] = false
+
+        options = { :profile => profile }
+      when :chrome
+        options = { :switches => %w{--disk-cache-size=1 --media-cache-size=1} }
+      end
+
+      @browser ||= Selenium::WebDriver.for(@browser_type, options)
+    end
+
+    def options
+      {}
+    end
+
+    def visit(path)
+      if !path[/^http/]
+        path = @app_host + path
+      end
+
+      browser.navigate.to(path)
+    end
+
+    def set_app_host(host)
+      @app_host = host.dup
+      load_splash_page
+    end
+
+    def load_splash_page
+      browser.navigate.to("data:text/html;base64,#{Base64.encode64(starting_page)}")
+    end
+
+    def reset!
+      if @browser
+        begin
+          @browser.manage.delete_all_cookies
+        rescue Selenium::WebDriver::Error::UnhandledError => e
+          # delete_all_cookies fails when we've previously gone
+          # to about:blank, so we rescue this error and do nothing
+          # instead.
+        end
+      end
+    end
+
+    def starting_page
+      <<-HTML
+<html>
+  <head>
+    <title>Persistent Selenium -- Starting up...</title>
+    <style>
+      body {
+        background: #444;
+      }
+
+      * {
+        font-family: Verdana, Helvetica, sans-serif;
+      }
+
+      td {
+        background: #ccc;
+        width: 50%;
+        text-align: center;
+
+        border: solid #333 1px;
+        border-radius: 5px;
+        padding: 10px;
+      }
+    </style>
+  </head>
+  <body>
+    <table width="100%" height="100%" cellpadding="0" cellspacing="0">
+      <tr>
+        <td>
+          <h1>Persistent Selenium</h1>
+          <h2>Starting up...</h2>
+        </td>
+      </tr>
+    </table>
+  </body>
+</html>
+      HTML
+    end
+  end
+end
+

data/lib/persistent_selenium/cli.rb

@@ -0,0 +1,44 @@
+require 'thor'
+require 'persistent_selenium'
+
+module PersistentSelenium
+  class CLI < Thor
+    include Thor::Actions
+
+    def self.source_root
+      File.expand_path('../../../skel', __FILE__)
+    end
+
+    desc "start", "Start the server"
+    method_options :port => PersistentSelenium.port, :browser => PersistentSelenium.browser
+    def start
+      require 'persistent_selenium/browser'
+      require 'drb'
+
+      PersistentSelenium.configure do |c|
+        c.port = options[:port]
+        c.browser = options[:browser]
+      end
+
+      puts "Starting persistent_selenium on #{PersistentSelenium.port} with #{PersistentSelenium.browser}"
+
+      @browser = Browser.new(PersistentSelenium.browser)
+      @browser.browser
+
+      DRb.start_service PersistentSelenium.url, @browser
+
+      trap('TERM') { exit }
+      trap('INT') { exit }
+
+      DRb.thread.join
+    end
+
+    desc "install", "Install Cucumber hook for using persistent selenium"
+    def install
+      directory '.', '.'
+    end
+
+    default_task :start
+  end
+end
+

data/lib/persistent_selenium/driver.rb

@@ -0,0 +1,26 @@
+require 'persistent_selenium'
+require 'capybara/selenium/driver'
+
+# make sure these classes exist on this end
+[ Selenium::WebDriver::Error::StaleElementReferenceError, Selenium::WebDriver::Error::UnhandledError, Selenium::WebDriver::Error::ElementNotVisibleError ]
+
+Before do
+  if Capybara.current_driver == :persistent_selenium
+    Capybara.server_port ||= '3001'
+    Capybara.app_host ||= "http://localhost:#{Capybara.server_port}"
+  end
+end
+
+Capybara.register_driver :persistent_selenium do |app|
+  require 'drb'
+
+  DRb.start_service
+  browser = DRbObject.new nil, PersistentSelenium.url
+
+  server = Capybara::Server.new(app)
+  server.boot
+
+  browser.set_app_host(Capybara.app_host)
+  browser
+end
+

data/lib/persistent_selenium/version.rb

@@ -0,0 +1,3 @@
+module PersistentSelenium
+  VERSION = "0.0.1"
+end

data/lib/persistent_selenium.rb

@@ -0,0 +1,23 @@
+require "persistent_selenium/version"
+
+module PersistentSelenium
+  class << self
+    attr_writer :port, :browser
+
+    def port
+      @port ||= 9854
+    end
+
+    def browser
+      @browser ||= :firefox
+    end
+
+    def url
+      "druby://localhost:#{port}"
+    end
+
+    def configure
+      yield self
+    end
+  end
+end

data/persistent_selenium.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/persistent_selenium/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["John Bintz"]
+  gem.email         = ["john@coswellproductions.com"]
+  gem.description   = %q{Keep your Selenium browser open while you use Capybara to talk to it. Save seconds and sanity.}
+  gem.summary       = %q{Keep your Selenium browser open while you use Capybara to talk to it. Save seconds and sanity.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "persistent_selenium"
+  gem.require_paths = ["lib"]
+  gem.version       = PersistentSelenium::VERSION
+end

data/skel/features/support/persistent_selenium.rb

@@ -0,0 +1,11 @@
+# get the driver ready for use
+require 'persistent_selenium/driver'
+
+# set it for all tests
+# Capybara.default_driver = Capybara.javascript_driver = :persistent_selenium
+#
+# or, set it via the ENV, with it being the default
+# Before do
+#   Capybara.default_driver = Capybara.javascript_driver = (ENV['DRIVER'] || 'persistent_selenium').to_sym
+# end
+

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: persistent_selenium
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- John Bintz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-09 00:00:00.000000000 Z
+dependencies: []
+description: Keep your Selenium browser open while you use Capybara to talk to it.
+  Save seconds and sanity.
+email:
+- john@coswellproductions.com
+executables:
+- persistent_selenium
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/persistent_selenium
+- lib/persistent_selenium.rb
+- lib/persistent_selenium/browser.rb
+- lib/persistent_selenium/cli.rb
+- lib/persistent_selenium/driver.rb
+- lib/persistent_selenium/version.rb
+- persistent_selenium.gemspec
+- skel/features/support/persistent_selenium.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Keep your Selenium browser open while you use Capybara to talk to it. Save
+  seconds and sanity.
+test_files: []