mediawiki_selenium 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c254febdd9a19e2c569107e857d55ce498eb774
-  data.tar.gz: 14379d05b00662b9974b440c260a9895322ac04f
+  metadata.gz: 67af225480dde4d5ac5bacbe01d631d2334859ec
+  data.tar.gz: 28454c89b3d8f8550953e18fe9b7762a0333d669
 SHA512:
-  metadata.gz: 2c80c8502e39c4ba821f7a5f1e215b49f1856780b21ea31973466aff10f8dd3c3b27bc90173f0b34e58c04f4b2c9ff51473ee34e56a41e01766becdc9be2b111
-  data.tar.gz: 05af65d9ae63e8d4be00884a1c0a018a38e54646df0f7b6534c6fc94eb5bd5f2d3b8fac9745f93824240636ae41755fe161874e011654e542dc9b991efafee29
+  metadata.gz: bbcef005071dba80b554fc05c2a61a9fb20a1fb00cafd576fb9cacfb6debe2aae41caf3d571983a1b367c7f693d640998507d3d786051e34e0854f2e032498db
+  data.tar.gz: a98d7297808c1d75ec7ee16c46d7763e14609e9ce6d43f1298ba641452dd536e5612322b925a2dc7fc6388313334a71302fc86a89da7197534175f957d8fb27d

data/.yardopts

@@ -1,2 +1,5 @@
+--readme README.md
+--charset utf-8
 --title "MediaWiki Selenium"
 --markup markdown
+'lib/**/*.rb' - '*.md'

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.0.1'
+    gem 'mediawiki_selenium', '~> 1.0.2'
 
 Install the gem and its dependencies by running `bundle install`. (If
 [Bundler](http://bundler.io/) is not yet installed, install it with
@@ -97,16 +97,30 @@ To run a single scenario, give the line number as well.
 
     bundle exec cucumber feature/some.feature:11
 
-The set of default configuration to use (see "Getting started") is specified
-by the `MEDIAWIKI_ENVIRONMENT` environment variable, which should be defined
-somewhere in your shell profile. For example, if you're using
-[Mediawiki-Vagrant](http://www.mediawiki.org/wiki/MediaWiki-Vagrant) for your
-development and executing tests on the host OS, the environment name would be
-`mw-vagrant-host`.
+The set of default configuration to use (see "Getting started") can be
+specified by the `MEDIAWIKI_ENVIRONMENT` environment variable, defined
+somewhere in your shell profile. If no value is set, an entry called `default`
+is loaded.
 
-    export MEDIAWIKI_ENVIRONMENT=mw-vagrant-host # Linux/Unix/Mac
-    set MEDIAWIKI_URL=mw-vagrant-host # Windows Command Prompt
-    $env:MEDIAWIKI_URL="mw-vagrant-host" # Windows PowerShell
+For example, if your `environments.yml` file looked something like this.
+
+    mw-vagrant-host: &default
+      mediawiki_url: http://127.0.0.1:8080/wiki/
+      # ...
+
+    mw-vagrant-guest:
+      mediawiki_url: http://127.0.0.1/wiki/
+      # ...
+
+    beta:
+      mediawiki_url: http://en.wikipedia.beta.wmflabs.org/wiki/
+      # ...
+
+    default: *default
+
+Defining `MEDIAWIKI_ENVIRONMENT=beta` in your shell would tell MW-Selenium to
+use the configuration for `beta` above. Leaving it unset would use the entry
+called `default` which in this case points to `mw-vagrant-host`.
 
 Firefox is the default browser, but you can specify a different one by setting
 `BROWSER`.
@@ -185,6 +199,11 @@ See https://www.mediawiki.org/wiki/Gerrit
 
 ## Release notes
 
+### 1.0.2 2015-03-26
+* Fixed double yield bug in `PageFactory#on`
+* Implemented loading of a `default` configuration from `environments.yml`
+* Improved readme with configuration examples
+
 ### 1.0.1 2015-03-05
 * Fixed regex pattern in shared "I am logged in" step
 

data/lib/mediawiki_selenium/environment.rb

@@ -19,8 +19,17 @@ module MediawikiSelenium
   #       mediawiki_user: Selenium_user
   #
   # Which default set to use is determined by the value of the
-  # `MEDIAWIKI_ENVIRONMENT` environment variable. (See {load} and
-  # {load_default}.)
+  # `MEDIAWIKI_ENVIRONMENT` environment variable, or an entry called "default"
+  # if none is set. (See {load} and {load_default}.) The easiest way to
+  # designate such a default set is to use a YAML anchor like so.
+  #
+  #     beta: &default
+  #       mediawiki_url: http://en.wikipedia.beta.wmflabs.org/wiki/
+  #       mediawiki_user: Selenium_user
+  #     test2:
+  #       mediawiki_url: http://test2.wikipedia.org/wiki/
+  #       mediawiki_user: Selenium_user
+  #     default: *default
   #
   # Any additional configuration specified via environment variables overrides
   # what is specified in the YAML file. For example, the following would use
@@ -85,7 +94,7 @@ module MediawikiSelenium
       # @see load
       #
       def load_default
-        load(ENV['MEDIAWIKI_ENVIRONMENT'], ENV)
+        load(ENV['MEDIAWIKI_ENVIRONMENT'] || 'default', ENV)
       end
     end
 

data/lib/mediawiki_selenium/page_factory.rb

@@ -16,7 +16,7 @@ module MediawikiSelenium
     def on_page(page_class, params = { using_params: {} }, visit = false)
       @browser = browser if visit
 
-      super(page_class, params, false).tap do |page|
+      super(page_class, params, false) do |page|
         if page.respond_to?(:goto)
           wiki_url = method(:wiki_url)
 
@@ -33,6 +33,5 @@ module MediawikiSelenium
 
     # @see #on_page
     alias on on_page
-
   end
 end

data/lib/mediawiki_selenium/version.rb

@@ -1,3 +1,3 @@
 module MediawikiSelenium
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/spec/environment_spec.rb

@@ -69,6 +69,14 @@ module MediawikiSelenium
         expect(Environment).to receive(:load).with('foo', ENV)
         subject
       end
+
+      context 'where MEDIAWIKI_ENVIRONMENT is not defined' do
+        it 'looks for a "default" environment' do
+          expect(ENV).to receive(:[]).with('MEDIAWIKI_ENVIRONMENT').and_return(nil)
+          expect(Environment).to receive(:load).with('default', ENV)
+          subject
+        end
+      end
     end
 
     describe '#==' do

data/spec/page_factory_spec.rb

@@ -12,8 +12,27 @@ module MediawikiSelenium
     describe '#on_page' do
       subject { env.on_page(page_class, { using_params: {} }, visit) }
 
+      let(:page_class) { Class.new { include ::PageObject } }
+      let(:visit) { false }
+
       let(:browser) { double('Watir::Browser') }
 
+      it 'returns a new page object' do
+        page = double('PageObject')
+        expect(page_class).to receive(:new).and_return(page)
+        expect(subject).to be(page)
+      end
+
+      context 'when given a block' do
+        it 'yields it only once with a new page object' do
+          page = double('PageObject')
+          allow(page_class).to receive(:new).and_return(page)
+
+          expect { |block| env.on_page(page_class, &block) }.to yield_control.once
+          expect { |block| env.on_page(page_class, &block) }.to yield_with_args(page)
+        end
+      end
+
       context 'when told to visit a page' do
         let(:visit) { true }
         let(:config) { { mediawiki_url: 'http://an.example/wiki/' } }

data/templates/tests/browser/environments.yml

@@ -14,7 +14,7 @@
 #   export MEDIAWIKI_USER=Selenium_user2
 #   bundle exec cucumber
 #
-mw-vagrant-host:
+mw-vagrant-host: &default
   mediawiki_url: http://127.0.0.1:8080/wiki/
   mediawiki_user: Selenium_user
   mediawiki_password: vagrant
@@ -33,3 +33,5 @@ test2:
   mediawiki_url: http://test2.wikipedia.org/wiki/
   mediawiki_user: Selenium_user
   # mediawiki_password: SET THIS IN THE ENVIRONMENT!
+
+default: *default

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki_selenium
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Chris McMahon
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-05 00:00:00.000000000 Z
+date: 2015-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber