mobilify 1.1.1 → 1.2.0

data/README.md

@@ -1,10 +1,12 @@
 # Mobilify
 [![Gem Version](https://badge.fury.io/rb/mobilify.png)](http://badge.fury.io/rb/mobilify)
 
-Mobilify allows you to create one page object and write one test for your web application, but execute different methods as part of that test given the context. Just change context when initializing your object.
+Invoke one page-object method name but execute different definitions of that method based on the page-object's context. 
+
+We use it at [Manta](www.manta.com) to keep the number of test scripts low while testing against multiple versions of the same feature (legacy version, new desktop version, new mobile version, etc).
 
 ## Usage
-To Mobilify your page objects, ```include Mobilify``` in the page class. For each method requiring a mobile replacement, create an element (or method) definition with your context prepended to the original's name (like `mobile_`).
+To contextualize your page objects, ```include Mobilify``` in the page class. For each method requiring a contextual replacement, create an element (or method) definition with your context prepended to the original's name (like `mobile_` or `legacy_`).
 
 ```ruby
 # method
@@ -20,66 +22,50 @@ Mobilify will replace called methods with their contextual counterparts if two c
 my_page = Page.new(@browser, :context => :mobile)
 ```
 
-To navigate to your page object during initialization, pass the key-value pair ```:visit => true``` to the constructor.
+Mobilify also supports multiple contexts per page-object instance, invoking the first applicable context it matches in a given array.
+
 ```ruby
-# visiting
-my_page = Page.new(@browser, :visit => true)
-my_page = Page.new(@browser, :visit => true, :context => :mobile)
+# multiple context constructor
+my_page = Page.new(@browser, :context => [:legacy, :mobile])
 ```
 
 #### Example
 
-You're testing a responsive page with a link to your registration form. But you can only identify the link with XPath, and the XPath changes between your desktop-sized application and your mobile-sized application.
+I want to test a login page, but my there are basically three versions of the same page in some cycle of development. There's legacy code, new responsive code at the desktop size, and new responsive code at the mobile size. All three have different identifiers for the login form.
+
+I'll use Mobilify to write one script and test all browsers and environments.
 
 ```ruby
-# spec/page.rb
-require 'mobilify'
+# login.rb
+require "mobilify"
 
-class Page
+class Login
   include Mobilify
   
-  page_url "http://my-page.com"
+  text_field(:user, :id => "email")
+  text_field(:mobile_user, :id => "xs-email")
+  text_field(:legacy_user, :id => "member-email")
   
-  link(:to_registration, :xpath => '//xpath/to/desktop/register/link')
-  link(:mobile_to_registration, :xpath => '//xpath/to/mobile/register/link')
-end
-```
-
-```ruby 
-# spec/spec_helper.rb
-require 'watir-webdriver'
-require 'webdriver-user-agent'
-
-RSpec.configure do |config|
+  text_field(:password, :id => "password")
+  text_field(:mobile_password, :id => "xs-password")
+  text_field(:legacy_password, :id => "member-password")
   
-  config.before :all do
-    case ENV['BROWSER']
-    when 'desktop'
-      @browser = Watir::Browser.new :firefox
-      @my_context = :desktop
-    when 'mobile'
-      driver = Webdriver::UserAgent.driver(:browser => :firefox, :agent => :iphone)
-      @browser = Watir::Browser.new driver
-      @my_context = :mobile
-    end
-  end
+  button(:submit, :id => "submit")
 end
 ```
 
 ```ruby
-# spec/registration_link_spec.rb
-require 'spec_helper'
-require 'page'
-
-describe Page do
-  let(:page) { Page.new(@browser, :context => @my_context, :visit => true) }
-  
-  describe "#to_registration" do
-    it "takes me to the registration form" do
-      page.to_registration
-      @browser.url.should == "http://my-page.com/registration"
-    end
-  end
+# login_spec.rb
+require "rspec-given"
+require "support/login"
+
+describe "logging in" do
+  Given(:login) { Login.new(@browser, :context => [:mobile, :legacy]) }
+  When { login.goto }
+  When { login.user = "member@example.com" }
+  When { login.password = "password123" }
+  When { login.submit }
+  Then { ... }
 end
 ```
 

data/lib/mobilify.rb

@@ -1,3 +1,4 @@
+require 'mobilify/version'
 require 'page-object'
 
 module Mobilify
@@ -6,7 +7,7 @@ module Mobilify
   def initialize(browser, opts = {})
     super(browser, opts[:visit] || false)
     @context = opts[:context]
-    mobilify! if context?
+    mobilify! if @context
   end
 
   def self.included(klass)
@@ -17,20 +18,23 @@ module Mobilify
     @context
   end
 
-  private
-
   def mobilify!
-    context = @context.to_s
-
-    methods.
-      select { |m| m.to_s.start_with? "#{context}_" }.
-      select { |m| respond_to? m.to_s.gsub("#{context}_", '') }.
-      map { |m| self.method(m) }.each do |method|
-        (class << self; self; end).class_eval do
-          define_method(method.name.to_s.gsub("#{context}_", ''), method)
+    match = false
+    (contexts = []) << @context
+
+    contexts.flatten.each do |c|
+      next if match
+      context = c.to_s
+      methods.
+        select { |m| m.to_s.start_with? "#{context}_" }.
+        select { |m| respond_to? m.to_s.gsub("#{context}_", '') }.
+        map { |m| self.method(m) }.each do |method|
+          (class << self; self; end).class_eval do
+            define_method(method.name.to_s.gsub("#{context}_", ''), method)
+            match = true
+          end
         end
-      end
+    end
   end
-end
 
-require 'mobilify/version'
+end

data/lib/mobilify/version.rb

@@ -1,3 +1,3 @@
 module Mobilify
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/mobilify.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Mobilify::VERSION
   spec.authors       = ["Johnson Denen"]
   spec.email         = ["jdenen@manta.com"]
-  spec.description   = %q{switch seamlessly between page-object methods when testing your web app in different contexts}
-  spec.summary       = %q{switch seamlessly between page-object methods when testing your web app in different contexts}
+  spec.description   = %q{page-object methods invoked with one call but defined contextually}
+  spec.summary       = %q{page-object methods invoked with one call but defined contextually}
   spec.homepage      = "http://github.com/jdenen/mobilify"
   spec.license       = "MIT"
 
@@ -24,5 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "watir-webdriver"
   spec.add_development_dependency "webdriver-user-agent"
-  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-given"
 end

data/spec/multiple_context_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Mobilify do
+  after :each do
+    @browser.close
+  end
+
+  describe "uses default method when given contexts do not apply" do
+    Given(:desktop) { KhanAcademy.new(desktop_browser, { :visit => true, :context => [:no_match, :wrong] }) }
+    Then { desktop.login_element.inspect.should include("log-in-link ellipsis highlight") }
+  end
+
+  describe "uses only applicable context given" do
+    context "when applicable context is first in the array" do
+      Given(:mobile) { KhanAcademy.new(mobile_browser, { :visit => true, :context => [:mobile, :wrong] }) }
+      Then { mobile.login_element.inspect.should include("simple-button big-button") }
+    end
+
+    context "when applicable context is second in the array" do
+      Given(:mobile) { KhanAcademy.new(mobile_browser, { :visit => true, :context => [:wrong, :mobile] }) }
+      Then { mobile.login_element.inspect.should include("simple-button big-button") }
+    end
+  end
+
+  describe "uses first context given when multiple applicable contexts are given" do
+    Given(:mobile) { KhanAcademy.new(mobile_browser, { :visit => true, :context => [:mobile, :ignored] }) }
+    Then { mobile.login_element.inspect.should include("simple-button big-button") }
+  end
+end

data/spec/page_object_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Mobilify do
+
+  describe "includes PageObject when included" do
+    Given { class Page; end }
+    When { Page.send :include, Mobilify }
+    Then { Page.included_modules[1].should == PageObject }
+  end
+
+end

data/spec/simple_context_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Mobilify do
+  after :each do
+    @browser.close
+  end
+
+  describe "uses default method when no context is given" do
+    Given(:desktop) { KhanAcademy.new(desktop_browser, { :visit => true }) }
+    Then { desktop.login_element.inspect.should include("log-in-link ellipsis highlight") }
+  end
+
+  describe "uses default method when non-applicable context is given" do
+    Given(:desktop) { KhanAcademy.new(desktop_browser, { :visit => true, :context => :wrong }) }
+    Then { desktop.login_element.inspect.should include("log-in-link ellipsis highlight") }
+  end
+
+  describe "uses contextual method for the given context" do
+    Given(:mobile) { KhanAcademy.new(mobile_browser, { :context => :mobile, :visit => true }) }
+    Then { mobile.login_element.inspect.should include("simple-button big-button") }
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rspec'
+require 'rspec-given'
+require 'watir-webdriver'
+require 'webdriver-user-agent'
+require './lib/mobilify'
+require 'support/khan_academy'
+
+def desktop_browser
+  @browser = Watir::Browser.new :firefox
+end
+
+def mobile_browser
+  device = Webdriver::UserAgent.driver(:browser => :firefox, :agent => :iphone)
+  @browser = Watir::Browser.new device
+end

data/spec/support/khan_academy.rb

@@ -0,0 +1,12 @@
+require "./lib/mobilify"
+
+class KhanAcademy
+  include Mobilify
+
+  page_url "http://www.khanacademy.org"
+
+  link(:login, :class => "log-in-link ellipsis highlight")
+  link(:mobile_login, :class => "simple-button big-button")
+  link(:ignored_login, :class => "simple-button primary big-button")
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobilify
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-30 00:00:00.000000000 Z
+date: 2014-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: page-object
@@ -92,7 +92,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -107,8 +107,23 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: switch seamlessly between page-object methods when testing your web app
-  in different contexts
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: page-object methods invoked with one call but defined contextually
 email:
 - jdenen@manta.com
 executables: []
@@ -120,16 +135,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- features/desktop_link.feature
-- features/mobile_link.feature
-- features/step_definitions/link_steps.rb
-- features/step_definitions/navigation_step.rb
-- features/support/env.rb
-- features/support/hooks.rb
-- features/support/manta_page.rb
 - lib/mobilify.rb
 - lib/mobilify/version.rb
 - mobilify.gemspec
+- spec/multiple_context_spec.rb
+- spec/page_object_spec.rb
+- spec/simple_context_spec.rb
+- spec/spec_helper.rb
+- spec/support/khan_academy.rb
 homepage: http://github.com/jdenen/mobilify
 licenses:
 - MIT
@@ -154,13 +167,10 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: switch seamlessly between page-object methods when testing your web app in
-  different contexts
+summary: page-object methods invoked with one call but defined contextually
 test_files:
-- features/desktop_link.feature
-- features/mobile_link.feature
-- features/step_definitions/link_steps.rb
-- features/step_definitions/navigation_step.rb
-- features/support/env.rb
-- features/support/hooks.rb
-- features/support/manta_page.rb
+- spec/multiple_context_spec.rb
+- spec/page_object_spec.rb
+- spec/simple_context_spec.rb
+- spec/spec_helper.rb
+- spec/support/khan_academy.rb

data/features/desktop_link.feature

@@ -1,20 +0,0 @@
-Feature: Desktop Link
-  To use one spec/feature per functionality
-  Testers will need to use normal page-object functionality on the desktop
-
-  Background:
-    Given I am using Firefox
-    And I navigate to a Manta profile
-
-  Scenario: Finding a link
-    When I query the map link
-    Then I should receive true
-
-  Scenario: Grabbing a link
-    When I ask for the map link element
-    Then I should receive the desktop link element
-
-  Scenario: Clicking a link
-    When I click the map link
-    Then I should land on the map page
-

data/features/mobile_link.feature

@@ -1,20 +0,0 @@
-Feature: Mobile Link
-  To use one spec/feature per functionality
-  Testers will need to use mobilified page-object functionality on mobile devices
-
-  Background:
-    Given I am using a mobile device
-    And I navigate to a Manta profile
-
-  Scenario: Finding a link
-    When I query the map link
-    Then I should receive true
-
-  Scenario: Grabbing a link
-    When I ask for the map link element
-    Then I should receive the mobile link element
-
-  Scenario: Clicking a link
-    When I click the map link
-    Then I should land on the map page
-

data/features/step_definitions/link_steps.rb

@@ -1,27 +0,0 @@
-When /^I query the map link$/ do
-  @query = @page.map?
-end
-
-When /^I ask for the map link element$/ do
-  @element = @page.map_element
-end
-
-When /^I click the map link$/ do
-  @page.map
-end
-
-Then /^I should receive true$/ do
-  @query.should == true
-end
-
-Then /^I should receive the desktop link element$/ do
-  @element.inspect.should include(':xpath=>"//div[@class=\'panel-body\']//a[contains(@href, \'/cmap/\')]"')
-end
-
-Then /^I should receive the mobile link element$/ do
-  @element.inspect.should include(':xpath=>"//div[@class=\'col-xs-6\']/a[contains(@href, \'/cmap/\')]"')
-end
-
-Then /^I should land on the map page$/ do
-  @page.current_url.should include('/cmap/')
-end

data/features/step_definitions/navigation_step.rb

@@ -1,14 +0,0 @@
-Given /^I am using Firefox$/ do
-  @browser = Watir::Browser.new
-  @agent = :desktop
-end
-
-Given /^I am using a mobile device$/ do
-  driver = Webdriver::UserAgent.driver(:browser => :firefox, :agent => :iphone)
-  @browser = Watir::Browser.new driver
-  @agent = :mobile
-end
-
-Given /^I navigate to a Manta profile$/ do
-  @page = MantaPage.new(@browser, :context => @agent, :visit => true)
-end

data/features/support/env.rb

@@ -1,6 +0,0 @@
-require 'rspec'
-require 'rspec-given'
-require 'watir-webdriver'
-require 'webdriver-user-agent'
-
-$:.unshift(File.dirname(File.expand_path('lib')))

data/features/support/hooks.rb

@@ -1,3 +0,0 @@
-After do
-  @browser.close
-end

data/features/support/manta_page.rb

@@ -1,10 +0,0 @@
-require 'mobilify'
-
-class MantaPage
-  include Mobilify
-
-  page_url "http://www.manta.com/c/mm2fqg7"
-
-  link(:map, :xpath => "//div[@class='panel-body']//a[contains(@href, '/cmap/')]")
-  link(:mobile_map, :xpath => "//div[@class='col-xs-6']/a[contains(@href, '/cmap/')]")
-end