mediawiki_selenium 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8f3fa288a782f710160f5423dc60a37b0b66ed8
-  data.tar.gz: 3d7880126514583ae129b91d2d02514e1555adb2
+  metadata.gz: 726360dc3c099dde3ad6827c181be19adbfa5e54
+  data.tar.gz: f6e3f6a52f72b471183508046d9b59f48af103bd
 SHA512:
-  metadata.gz: 6d98d2abdd75a93fef9374de705f0fabec8523418a31e413ce6fe2a8d773e9eedd9a3ffb5ebad8411ed219773e02783d68236797a81c0ac9790e08e9a1960fb7
-  data.tar.gz: 4a80cbbb66bdd9a019b9514cadc42225d88a0563e6e15bacfcd7ea3f8ad3af075ee55b42ca8d8f008fd696e07919c90a54d2dfa385930c657c6310044426da1e
+  metadata.gz: fb1180596eb74635fa300f438453f691d69dcdc31cb880e01e1eaf863416c68f20f9291aaf294ddfd876f8a96eae6399361fcc35ddbbcdbbd9ea39c3d1d49ae2
+  data.tar.gz: 44e1fb0e9c836131336baf5015fa8875c48cd2b293b6db05aa832db1a5b9233370070d73b550bb9914992f50063d3fccd06f198fb8e239f52b0c2ae67a279f4c

data/README.md

@@ -37,7 +37,7 @@ Create a `Gemfile` in the root of your MediaWiki-related project that
 specifies the version of `mediawiki_selenium` you wish to use (typically the
 latest version).
 
-    gem 'mediawiki_selenium', '~> 1.2.0'
+    gem 'mediawiki_selenium', '~> 1.3.0'
 
 Install the gem and its dependencies by running `bundle install`. (If
 [Bundler](http://bundler.io/) is not yet installed, install it with
@@ -69,7 +69,7 @@ for local development, or against at least the [Beta Cluster](http://www.mediawi
 for continuous integration.
 
 For details on how environment configuration is loaded and used by step
-definitions, see the documentation for `MediawikiSelenium::Environment`.
+definitions, see the documentation for {MediawikiSelenium::Environment}.
 
 ## Writing Tests
 
@@ -79,8 +79,8 @@ you'll find some helpful [high-level documentation](http://www.mediawiki.org/wik
 to get you started.
 
 To see exactly which methods are available from within step definitions, see
-the documentation for `MediawikiSelenium::Environment`,
-`MediawikiSelenium::ApiHelper`, and `MediawikiSelenium::PageFactory`.
+the documentation for {MediawikiSelenium::Environment},
+{MediawikiSelenium::ApiHelper}, and {MediawikiSelenium::PageFactory}.
 
 ## Running Tests
 
@@ -199,6 +199,11 @@ See https://www.mediawiki.org/wiki/Gerrit
 
 ## Release notes
 
+### 1.3.0 2015-06-10
+* Added {Mediawiki::Environment#override} for overriding environment
+  configuration at runtime
+* Removed deprecated `APIPage` page object and updated upgrade docs
+
 ### 1.2.1 2015-06-02
 * Fixed issue with inconsistent JSON output in Raita logger when using
   scenario outlines

data/UPGRADE.md

@@ -5,7 +5,7 @@
 First, update the `Gemfile` in your project's root directory to specify the
 new version.
 
-    gem 'mediawiki_selenium', '~> 1.2.0'
+    gem 'mediawiki_selenium', '~> 1.3.0'
 
 ## Upgrade gems and dependencies
 
@@ -113,3 +113,20 @@ Would be changed to:
     When(/^I am viewing Topic page$/) do
       on(FlowPage).wait_until { browser.url =~ /Topic/ }
     end
+
+## Refactor use of deprecated `APIPage`
+
+API requests should be made directly using {MediawikiSelenium::ApiHelper#api}
+which returns an instance of [MediawikiApi::Client](https://doc.wikimedia.org/rubygems/mediawiki-ruby-api/).
+
+For example:
+
+    Given(/^the "(.*)" article contains "(.*)"$/) do |title, text|
+      on(APIPage).create(title, text)
+    end
+
+Would be changed to:
+
+    Given(/^the "(.*)" article contains "(.*)"$/) do |title, text|
+      api.create_page(title, text)
+    end

data/lib/mediawiki_selenium/browser_factory/base.rb

@@ -71,6 +71,7 @@ module MediawikiSelenium
         @browser_name = browser_name
         @bindings = {}
         @browser_cache = {}
+        @overrides = {}
       end
 
       # Returns a unique set of all the binding keys.
@@ -146,6 +147,8 @@ module MediawikiSelenium
       # @return [Hash]
       #
       def browser_options(config)
+        config = config.merge(@overrides)
+
         options = default_browser_options.tap do |default_options|
           bindings.each do |(names, bindings_for_option)|
             bindings_for_option.each do |binding|
@@ -183,10 +186,19 @@ module MediawikiSelenium
         new_browser(browser_options(config))
       end
 
+      # Always use the given configuration when setting up a new browser,
+      # regardless of what has been previously configured.
+      #
+      # @param config [Hash] Configuration overrides.
+      #
+      def override(config)
+        @overrides.merge!(config)
+      end
+
       # Executes additional teardown tasks.
       #
-      # @param env [Environment] Environment.
-      # @param status [Symbol] Status of the executed scenario.
+      # @param _env [Environment] Environment.
+      # @param _status [Symbol] Status of the executed scenario.
       #
       def teardown(_env, _status)
         # abstract

data/lib/mediawiki_selenium/support/pages.rb

@@ -1,4 +1,3 @@
-require 'mediawiki_selenium/support/pages/api_page'
 require 'mediawiki_selenium/support/pages/login_page'
 require 'mediawiki_selenium/support/pages/random_page'
 require 'mediawiki_selenium/support/pages/reset_preferences_page'

data/lib/mediawiki_selenium/version.rb

@@ -1,3 +1,3 @@
 module MediawikiSelenium
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 end

data/spec/browser_factory/base_spec.rb

@@ -211,5 +211,29 @@ module MediawikiSelenium::BrowserFactory
         end
       end
     end
+
+    describe '#override' do
+      subject { factory.override(overrides) }
+
+      before do
+        allow(Selenium::WebDriver::Remote::Capabilities).to receive(browser_name)
+      end
+
+      it 'always uses the given configuration when setting up a new browser' do
+        # Set up a binding that will accept :foo configuration
+        @foo = nil
+        factory.configure(:foo) { |foo| @foo = foo }
+
+        # Override with config { foo: 'y' }
+        factory.override(foo: 'y')
+
+        # Invoke the binding with `browser_options` and config { foo: 'x' }
+        factory.browser_options(foo: 'x')
+
+        # The configuration hook should have been invoked with the overriden
+        # value
+        expect(@foo).to eq('y')
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki_selenium
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Chris McMahon
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-02 00:00:00.000000000 Z
+date: 2015-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -357,7 +357,6 @@ files:
 - lib/mediawiki_selenium/support/modules/api_helper.rb
 - lib/mediawiki_selenium/support/modules/strict_pending.rb
 - lib/mediawiki_selenium/support/pages.rb
-- lib/mediawiki_selenium/support/pages/api_page.rb
 - lib/mediawiki_selenium/support/pages/login_page.rb
 - lib/mediawiki_selenium/support/pages/random_page.rb
 - lib/mediawiki_selenium/support/pages/reset_preferences_page.rb

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

@@ -1,27 +0,0 @@
-require 'page-object'
-require 'mediawiki_api'
-
-class APIPage
-  include PageObject
-
-  def client
-    return @client if defined?(@client)
-
-    unless ENV['MEDIAWIKI_API_URL']
-      raise 'Environment variable MEDIAWIKI_API_URL must be set in order to use the API'
-    end
-
-    @client = MediawikiApi::Client.new(ENV['MEDIAWIKI_API_URL'])
-    @client.log_in ENV['MEDIAWIKI_USER'], ENV['MEDIAWIKI_PASSWORD']
-
-    @client
-  end
-
-  def create(title, content)
-    client.create_page title, content
-  end
-
-  def protect(title, reason)
-    client.protect_page title, reason
-  end
-end