mediawiki_selenium 1.0.0.pre.1 → 1.0.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cfb45e7cecfe3d24690b4bc3b0577b523a32f0c
-  data.tar.gz: da0ddd70c32a9e191f88eb28091295b115a36621
+  metadata.gz: 93a8424d3894106aa9575f18912096df4d6bda83
+  data.tar.gz: 226dbf63109a48e9ede7a3d2346a7356e697782b
 SHA512:
-  metadata.gz: ba624b67027eeec05822cd82927f4849859f07d43302d416965ef8be9f3541b010d332ef19668ec07b87d9d57288cbfa6e4ea61309c04ea5c683abddc999d24e
-  data.tar.gz: 231504b0c5ae4b35f307b0544c67e56b6c07fb9e4cdc2050a3b089e54db445c80c047ed0f55ad850ce9584e54f3f4ed86720b25ed49d3c9175b44c8d1f533a17
+  metadata.gz: 81739dccd7bedc37d73e438b4d58bf301580e5d0d6ae3d4fbb7d7da2221c92e3be1ddfd5d68a2461cbada9d999f078d0f0c65120ebf841708a97b54c3ac1a83a
+  data.tar.gz: dbcb5db3ae8620ed8ff25279440ea3f381e0cfd4f7b378c7b5c75069ba15c71a94f0bea73670db0b45f393e4980e358ca6903895fba3fd6de9696ca862886270

data/README.md

@@ -44,6 +44,11 @@ Install the gem and its dependencies by running `bundle install`. (If
 `gem install bundler`, or `sudo gem install bundler` if you're using a
 system wide Ruby.)
 
+## Upgrading
+
+Please read the included `UPGRADE.md` for documentation on how to upgrade from
+one major release to another.
+
 ## Getting Started
 
 Once the gem is installed, run `mediawiki-selenium-init` in your project's

data/UPGRADE.md

@@ -0,0 +1,115 @@
+# Upgrading from pre-1.0 releases to 1.0.0 and above
+
+## Update your `Gemfile`
+
+First, update the `Gemfile` in your project's root directory to specify the
+new version.
+
+    gem 'mediawiki_selenium', '~> 1.0.0.pre.2'
+
+## Upgrade gems and dependencies
+
+Now run `bundle install` to update your project's gem dependencies and
+`Gemfile.lock`.
+
+## Run the initialization script
+
+Version 1.0 now includes an initialization script that can help with the setup
+of new and existing test suites. Run the script in your project's root
+directory via Bundler.
+
+    bundle exec mediawiki-selenium-init
+
+Two important files will be created if they don't already exist. The first is
+an `environments.yml` configuration file that describes the environments in
+which you intend your test suite to run. For details on how it should be
+configured, consult the "Getting Started" section of the `README`.
+
+The second file, `tests/browser/features/support/env.rb`, is for bootstrapping
+the Cucumber environment. Since you're working with an existing test suite,
+you may run into a conflict here. Just make sure that your `env.rb` contains
+the following before anything else.
+
+    require 'mediawiki_selenium'
+    require 'mediawiki_selenium/support'
+    require 'mediawiki_selenium/step_definitions'
+
+## Convert page object URLs
+
+Convert all page object URLs so that they're defined relative to the root of
+any given wiki and no longer rely on the now deprecated `URL` module. In other
+words, change page object classes like the following.
+
+    class MainPage
+      include PageObject
+      include URL
+    
+      page_url URL.url('Main_Page')
+
+      # ...
+    end
+
+To something like this.
+
+    class MainPage
+      include PageObject
+    
+      page_url 'Main_Page'
+
+      # ...
+    end
+
+## Refactor direct use of `ENV`
+
+Change all references to `ENV` to use the appropriate `Environment` method.
+
+For example, change things like:
+
+    Given(/^I am logged in to the primary wiki domain$/) do
+      visit(LoginPage).login_with(ENV["MEDIAWIKI_USER"], ENV["MEDIAWIKI_PASSWORD"])
+    end
+
+To something like:
+
+    Given(/^I am logged in to the primary wiki domain$/) do
+      visit(LoginPage).login_with(user, password)
+    end
+
+More esoteric configuration that isn't accessible via a method of
+`Environment` can still be read via `Environment#lookup` and `Environment#[]`.
+
+Change something like the following:
+
+    Then(/^the default language should reflect my browser language$/) do
+      on(PreferencesPage) do |page|
+        expect(page.language_preference).to eq(ENV['BROWSER_LANGUAGE'])
+      end
+    end
+
+To something like:
+
+    Then(/^the default language should reflect my browser language$/) do
+      on(PreferencesPage) do |page|
+        expect(page.language_preference).to eq(env[:browser_language])
+        # or
+        expect(page.language_preference).to eq(lookup(:browser_language))
+      end
+    end
+
+## Remove direct references to `@browser`
+
+All references to `@browser` should use `Environment#browser` instead, since
+the latter will automatically configure and launch the browser the first time
+it's needed.
+
+For example:
+
+    When(/^I am viewing Topic page$/) do
+      on(FlowPage).wait_until { @browser.url =~ /Topic/ }
+    end
+
+Would be changed to:
+
+    When(/^I am viewing Topic page$/) do
+      on(FlowPage).wait_until { browser.url =~ /Topic/ }
+    end

data/lib/mediawiki_selenium/step_definitions/login_steps.rb

@@ -9,6 +9,8 @@ mediawiki_selenium top-level directory and at
 https://git.wikimedia.org/blob/mediawiki%2Fselenium/HEAD/CREDITS.
 =end
 
-Given(/^I am logged in$/) do
-  visit(LoginPage).login_with(ENV["MEDIAWIKI_USER"], ENV["MEDIAWIKI_PASSWORD"])
+Given(/^I am logged in(?: as (\w+))$/) do |user|
+  as_user(user) do |user, password|
+    visit(LoginPage).login_with(user, password)
+  end
 end

data/lib/mediawiki_selenium/step_definitions/resource_loader_steps.rb

@@ -10,7 +10,7 @@ https://git.wikimedia.org/blob/mediawiki%2Fselenium/HEAD/CREDITS.
 =end
 
 Then(/^page has no ResourceLoader errors$/) do
-  @browser.execute_script("
+  result = browser.execute_script(<<-end)
 return (function() {
     // Returns a string listing problem modules,
     // or empty string if all OK (or not a MediaWiki page).
@@ -41,5 +41,7 @@ return (function() {
     }
     return ret;
 }) ();
-").should == ""
+  end
+
+  expect(result).to eq('')
 end

data/lib/mediawiki_selenium/step_definitions/upload_file_steps.rb

@@ -4,9 +4,9 @@ When(/^upload bogus file (.+)$/) do |file_name|
   path = "#{Dir.tmpdir}/#{file_name}"
 
   system("touch #{path}")
-  if @browser.driver.browser == :chrome
-    @browser.execute_script "document.getElementsByName('file')[0].removeAttribute('class');"
-    @browser.execute_script "document.getElementsByName('file')[0].removeAttribute('style');"
+  if browser.driver.browser == :chrome
+    browser.execute_script "document.getElementsByName('file')[0].removeAttribute('class');"
+    browser.execute_script "document.getElementsByName('file')[0].removeAttribute('style');"
   end
 
   on(UploadPage).select_file = path
@@ -20,9 +20,9 @@ When(/^upload file (.+)$/) do |file_name|
   require "chunky_png"
   ChunkyPNG::Image.new(Random.new.rand(255), Random.new.rand(255), Random.new.rand(255)).save path
 
-  if @browser.driver.browser == :chrome
-    @browser.execute_script "document.getElementsByName('file')[0].removeAttribute('class');"
-    @browser.execute_script "document.getElementsByName('file')[0].removeAttribute('style');"
+  if browser.driver.browser == :chrome
+    browser.execute_script "document.getElementsByName('file')[0].removeAttribute('class');"
+    browser.execute_script "document.getElementsByName('file')[0].removeAttribute('style');"
   end
 
   on(UploadPage).select_file = path

data/lib/mediawiki_selenium/support.rb

@@ -1,3 +1,4 @@
 require "mediawiki_selenium/support/env"
 require "mediawiki_selenium/support/hooks"
+require "mediawiki_selenium/support/pages"
 require "mediawiki_selenium/support/sauce"

data/lib/mediawiki_selenium/support/pages/login_page.rb

@@ -20,7 +20,6 @@ class LoginPage
   def login_with(username, password, wait_for_logout_element = true)
     self.username_element.when_present.send_keys(username)
     self.password_element.when_present.send_keys(password)
-    login_element.fire_event("onfocus")
     login_element.when_present.click
     logout_element.when_present(10) if wait_for_logout_element
   end

data/lib/mediawiki_selenium/version.rb

@@ -10,5 +10,5 @@ https://git.wikimedia.org/blob/mediawiki%2Fselenium/HEAD/CREDITS.
 =end
 
 module MediawikiSelenium
-  VERSION = "1.0.0.pre.1"
+  VERSION = "1.0.0.pre.2"
 end

data/templates/tests/browser/features/support/env.rb

@@ -1,6 +1,4 @@
 require "mediawiki_selenium"
 
-require "mediawiki_selenium/support/env"
-require "mediawiki_selenium/support/hooks"
-require "mediawiki_selenium/support/pages"
+require "mediawiki_selenium/support"
 require "mediawiki_selenium/step_definitions"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki_selenium
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.1
+  version: 1.0.0.pre.2
 platform: ruby
 authors:
 - Chris McMahon
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-17 00:00:00.000000000 Z
+date: 2015-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -334,6 +334,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- UPGRADE.md
 - bin/mediawiki-selenium-init
 - lib/mediawiki_selenium.rb
 - lib/mediawiki_selenium/browser_factory.rb