frameworks-capybara 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,6 +1,40 @@
 = frameworks-capybara
 
-Description goes here.
+Gem to simplify the configuration of Capybara when using multiple drivers, also exposes other useful utility methods.
+
+Although utilising Capybara's API to run tests is extremely simple the configuration and setup of the tool can be a little confusing, particularly if you want to avoid ending up with a spaghetti like env.rb file
+
+The principle behind this gem is to factor out all the common setup code for registering Capybara drivers and allow the user to pass all configuration options through Cucumber's command line interface (and typically using cucumber.yml to make this even easier).
+
+Below are the current drivers that can be registered:
+
+* Selenium-Webdriver (Selenium2) - LOCAL: This can be used to drive 'in-browser' tests runnong on your local machine in IE, Firefox and Chrome (and any other browsers as and when they are added into the Selenium-Webdriver project)
+
+
+* Selenium-Webdriver (Selenium2) - REMOTE: This can be used to drive 'in-browser' tests on a remote macine, this could be another macine on your local network which is running a Selenium-Webdriver server or indeed a cloud service such as 'Sauce Labs'
+
+* Celerity: This can be used to drive 'headless' tests.  Celerity is a ruby wrapper for HTMLUnit and as such provides support for Javascript, though this is commonly quite fragile.
+
+To be added in the near future:
+
+* Mechanize-Caybara: There is a Caybara driver for mechanize which has recent;y surfaced on Github.  Many people still enjoy using Mechanize as despite its lack of support for Javascrit, it offers a much faster 'headless' option over Celerity.  Once we have tested this driver and checked its robustness we will add an option to use it via this gem.
+
+How to use this gem in your project:
+
+In your env.rb simply add:
+  
+ require 'frameworks/capybara' 
+
+The following environment variables can be set to configure your tests:
+
+  ENVIRONMENT - this must be one of either 'sandbox', 'int', 'test', 'stage', 'live'
+  BROWSER - this must be one of either 'ie', 'firefox', 'chrome', 'headless', 'remote'
+  PROXY_URL - url of proxy if required e.g. 'http://proxyhost:80'
+  PLATFORM - used when specifying remote test on a grid that provides a choice of platforms, this must be one of either 'WINDOWS' or 'LINUX'
+  REMOTE_BROWSER - used when specifying remote test, must be one of either 'ie', 'firefox', 'chrome', 'headless', 'remote'
+  REMOTE_BROWSER_PROXY - used when specifying remote test, sets proxy on remote browser (Firefox only at present, other browsers must have proxies set appropriately on remote machine)
+  REMOTE_URL - URL of remote Selenium-Webdriver server e.g. http://yourremotehost:4444/wd/hub
+  FIREFOX_PROFILE - specify a firefox profile to use when running in-browser tests (local or remote)
 
 == Contributing to frameworks-capybara
  

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/frameworks-capybara.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{frameworks-capybara}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["mcrmfc"]
@@ -25,14 +25,15 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "frameworks-capybara.gemspec",
-    "lib/frameworks-capybara.rb",
+    "lib/frameworks/capybara.rb",
+    "lib/frameworks/cucumber.rb",
     "test/helper.rb",
     "test/test_frameworks-capybara.rb"
   ]
   s.homepage = %q{http://github.com/mcrmfc/frameworks-capybara}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.0}
+  s.rubygems_version = %q{1.4.2}
   s.summary = %q{gem to aid setup of Capybara for testing bbc sites}
   s.test_files = [
     "test/helper.rb",

data/lib/{frameworks-capybara.rb → frameworks/capybara.rb}

@@ -15,9 +15,9 @@ class CapybaraSetup
     when 'headless' then
       @driver = register_celerity_driver(false,ENV['PROXY_URL'])
     when 'remote' then
-      @driver = register_remote_driver(ENV['PROXY_URL'], ENV['REMOTE_BROWSER_PROXY'], ENV['PLATFORM'],ENV['BROWSER_VM'],ENV['REMOTE_URL'], ENV['FIREFOX_PROFILE'])
+      @driver = register_remote_driver(ENV['PROXY_URL'], ENV['REMOTE_BROWSER_PROXY'], ENV['PLATFORM'],ENV['REMOTE_BROWSER'],ENV['REMOTE_URL'], ENV['FIREFOX_PROFILE'])
     else
-      @driver = register_selenium_driver
+      @driver = register_selenium_driver(ENV['BROWSER'], ENV['FIREFOX_PROFILE'])
     end
   end
 
@@ -35,10 +35,10 @@ class CapybaraSetup
 
     #if running  remote test check for correct env variables
     if(ENV['BROWSER']=='remote')
-      env_vars_remote = [ENV['PLATFORM'],ENV['REMOTE_URL'], ENV['BROWSER_VM']]
+      env_vars_remote = [ENV['PLATFORM'],ENV['REMOTE_URL'], ENV['REMOTE_BROWSER']]
       env_vars_remote.each{ |var|
         if(var==nil)
-          abort 'Please ensure the following environment variables are set PLATFORM, REMOTE_URL, BROWSER_VM (browser to use on remote machine), PROXY_URL (if required) and REMOTE_BROWSER_PROXY (if required)'
+          abort 'Please ensure the following environment variables are set PLATFORM, REMOTE_URL, REMOTE_BROWSER (browser to use on remote machine), PROXY_URL (if required) and REMOTE_BROWSER_PROXY (if required)'
         end
       }
     end
@@ -68,15 +68,19 @@ class CapybaraSetup
 
   def register_celerity_driver (js_enabled, proxy)
     Capybara.register_driver :celerity do |app|
+      #remove http:// from proxy URL for Celerity
+      if(proxy)
+        proxy = proxy.gsub(/http:\/\//,'')
+      end
       Capybara::Driver::Celerity.new(app, {:javascript_enabled=>js_enabled,:proxy=>proxy})
     end
     :celerity
   end
 
-  def register_selenium_driver
+  def register_selenium_driver (browser, ff_profile)
     Capybara.register_driver :selenium do |app|
       #need to convert string to label to set browser for Selenium - hence .intern
-      Capybara::Driver::Selenium.new(app,:browser => ENV['BROWSER'].intern)
+      Capybara::Driver::Selenium.new(app,:browser => browser.intern, :profile => ff_profile)
     end
     :selenium
   end

data/lib/frameworks/cucumber.rb

@@ -0,0 +1,28 @@
+require 'frameworks/capybara'
+
+module Frameworks
+  module EnvHelper
+    WWW_PREFIX = 'http://www.'
+    BBC_DOMAIN = '.bbc.co.uk'
+    SANDBOX = 'http://pal.sandbox.dev'
+
+    def generate_base_url 
+      if(ENV['ENVIRONMENT']=='sandbox')
+        @base_url = SANDBOX + BBC_DOMAIN 
+      else
+        @base_url = WWW_PREFIX + ENV['ENVIRONMENT'] + BBC_DOMAIN
+      end
+    end
+
+  end
+end
+
+#Set Capybara Driver - using frameworks-capybara gem 
+Capybara.default_driver = CapybaraSetup.new.driver
+
+World(Frameworks::EnvHelper)
+
+Before do
+ generate_base_url
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: frameworks-capybara
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - mcrmfc
@@ -20,7 +20,7 @@ default_executable:
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -29,12 +29,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id001
-  name: shoulda
+  requirement: *id001
   prerelease: false
+  name: shoulda
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -45,12 +45,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  version_requirements: *id002
-  name: bundler
+  requirement: *id002
   prerelease: false
+  name: bundler
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -61,12 +61,12 @@ dependencies:
         - 5
         - 2
         version: 1.5.2
-  version_requirements: *id003
-  name: jeweler
+  requirement: *id003
   prerelease: false
+  name: jeweler
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -75,12 +75,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id004
-  name: rcov
+  requirement: *id004
   prerelease: false
+  name: rcov
 - !ruby/object:Gem::Dependency 
   type: :runtime
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -89,9 +89,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id005
-  name: capybara
+  requirement: *id005
   prerelease: false
+  name: capybara
 description: gem ti aid setup of Capybara for testing bbc sites
 email: mcrobbins@gmail.com
 executables: []
@@ -110,7 +110,8 @@ files:
 - Rakefile
 - VERSION
 - frameworks-capybara.gemspec
-- lib/frameworks-capybara.rb
+- lib/frameworks/capybara.rb
+- lib/frameworks/cucumber.rb
 - test/helper.rb
 - test/test_frameworks-capybara.rb
 has_rdoc: true
@@ -143,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.0
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: gem to aid setup of Capybara for testing bbc sites