mobilify 1.2.0 → 1.2.1

data/changes.md

@@ -0,0 +1,6 @@
+# Change Log
+
+### v1.2.1 (Nov 17, 2014)
+* `Mobilify#context` returns the page object instance's contexts (as an array)
+* `Mobilify#context?` is an alias of `Mobilify#context`
+

data/lib/mobilify.rb

@@ -4,37 +4,73 @@ require 'page-object'
 module Mobilify
   include PageObject
 
+  #
+  # Build page object with context(s) for method replacement
+  #
   def initialize(browser, opts = {})
     super(browser, opts[:visit] || false)
-    @context = opts[:context]
+    @context = set_context opts[:context]
     mobilify! if @context
   end
 
-  def self.included(klass)
+  #
+  # Returns context(s) passed to page object instance construction
+  #
+  # @return [Array]
+  #
+  def context
+    @context
+  end
+  alias :context? :context
+
+  private
+
+  #
+  # Include page-object too
+  #
+  def self.included klass
     klass.send :include, PageObject
   end
 
-  def context?
-    @context
+  #
+  # Format given context(s) to Mobilify's liking
+  #
+  def set_context config
+    return nil if config.nil?
+    config.kind_of?(Array) ? config.flatten.map(&:to_sym) : [config].map(&:to_sym)
   end
 
+  #
+  # Iterate over contexts for method replacement
+  #
   def mobilify!
-    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
+    @context.each_with_object([]) do |c, array|
+      next unless array.flatten.empty?
+      array << match_and_replace(c.to_s)
     end
   end
 
+  #
+  # Method replacement
+  #
+  def match_and_replace context
+    get_contextual_match(context).map { |m| self.method(m) }.each do |method|
+      replace! method, context
+    end
+  end
+
+  #
+  # Find page object methods matching the given context
+  #
+  def get_contextual_match context
+    methods.select{ |m| m.to_s.start_with? "#{context}_" }.select{ |m| respond_to? m.to_s.gsub("#{context}_","") }
+  end
+
+  #
+  # Redefine contextually matching method as original method
+  #
+  def replace! method, context
+    (class << self; self; end).class_eval{ define_method(method.name.to_s.gsub("#{context}_",""), method) }
+  end
+  
 end

data/lib/mobilify/version.rb

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

data/spec/mobilify_spec.rb

@@ -0,0 +1,159 @@
+require 'rspec'
+require 'support/page'
+
+describe Mobilify do
+  before :all do
+    @browser = Watir::Browser.new
+    @mobilify = ->(context = nil){ Page.new @browser, context: context }
+  end
+  
+  it "includes PageObject" do
+    expect(Page.included_modules[1]).to eq PageObject
+  end
+
+  context "when given no context" do
+    it "does not perform method replacement" do
+      page = @mobilify.call
+      expect(page.login_element.inspect).to include("log-in-link ellipsis highlight")
+    end
+  end
+
+  context "when given a single context" do
+    it "does not perform method replacement for an invalid context" do
+      page = @mobilify.call 'wrong'
+      expect(page.login_element.inspect).to include("log-in-link ellipsis highlight")
+    end
+
+    it "does not perform method replacement without an original method" do
+      page = @mobilify.call 'other'
+      expect(page.other_button_element.inspect).to include("other-button-class")
+    end
+
+    it "does not perform method replacement without the correct context" do
+      page = @mobilify.call 'mobile'
+      expect(page.other_button_element.inspect).to include("other-button-class")
+    end
+
+    it "performs method replacement for a valid context" do
+      page = @mobilify.call 'mobile'
+      expect(page.login_element.inspect).to include("simple-button big-button")
+    end
+  end
+
+  context "when given multiple contexts" do
+    it "does not perform method replacement for invalid contexts" do
+      page = @mobilify.call ['no_match', 'wrong']
+      expect(page.login_element.inspect).to include("log-in-link ellipsis highlight")
+    end
+
+    context "and the first context matches" do
+      it "performs method replacement with the first matching context" do
+        page = @mobilify.call ['mobile', 'wrong']
+        expect(page.login_element.inspect).to include("simple-button big-button")        
+      end
+
+      it "does not perform method replacement with the second matching context" do
+        page = @mobilify.call ['mobile', 'desktop']
+        expect(page.login_element.inspect).to include("simple-button big-button")                
+      end
+    end
+
+    context "and the second context matches" do
+      it "performs method replacement with the second context" do
+        page = @mobilify.call ['wrong', 'mobile']
+        expect(page.login_element.inspect).to include("simple-button big-button")                
+      end
+    end
+
+    context "and the first and last contexts match" do
+      it "performs method replacement with the first matching context" do
+        page = @mobilify.call ['mobile', 'wrong', 'ignore', 'nothing', 'desktop']
+        expect(page.login_element.inspect).to include("simple-button big-button")
+      end
+    end
+  end
+
+  describe "#initialize" do
+    context "without context" do
+      it "returns the page object instance" do
+        expect(@mobilify.call).to be_a Page
+      end
+    end
+    
+    context "with context" do
+      it "returns the page object instance" do
+        expect(@mobilify.call 'mobile').to be_a Page
+      end
+    end
+  end
+
+  describe "#context" do
+    it "returns nil when for context" do
+      page = @mobilify.call
+      expect(page.context).to be_nil
+    end
+
+    it "returns an array for one context" do
+      page = @mobilify.call 'desktop'
+      expect(page.context).to eq [:desktop]
+    end
+
+    it "returns an array for multiple contexts" do
+      page = @mobilify.call ['one', 'two', 'three']
+      expect(page.context).to eq [:one, :two, :three]
+    end
+
+    it "can be called as #context?" do
+      page = @mobilify.call 'desktop'
+      expect(page.context?).to eq [:desktop]
+    end
+  end
+
+  describe "#set_context" do
+    let(:page){ @mobilify.call }
+    
+    it "returns nil when given nil" do
+      expect(page.send :set_context, nil).to be_nil
+    end
+
+    context "when given a single context" do
+      it "converts context into an array" do
+        expect(page.send :set_context, :one).to eq [:one]
+      end
+
+      it "converts strings to symbols" do
+        expect(page.send :set_context, "one").to eq [:one]
+      end
+
+      it "flattens a single-element array" do
+        expect(page.send :set_context, [:one]).to eq [:one]
+      end
+    end
+
+    context "when given multiple contexts" do
+      it "converts strings to symbols" do
+        expect(page.send :set_context, ["one", "two"]).to eq [:one, :two]
+      end
+
+      it "flattens multiple arrays" do
+        expect(page.send :set_context, [[:one, :two], [:three, :four]]).to eq [:one, :two, :three, :four]
+      end
+    end
+  end
+
+  describe "#get_contextual_match" do
+    let(:page){ @mobilify.call }
+    
+    it "returns an array" do
+      expect(page.send :get_contextual_match, "one").to be_an Array
+    end
+
+    it "returns an empty array with invalid context" do
+      expect(page.send :get_contextual_match, "one").to be_empty
+    end
+
+    it "returns three-item array with valid context" do
+      expect(page.send(:get_contextual_match, "mobile").size).to eq 3
+    end
+  end
+end

data/spec/support/page.rb

@@ -0,0 +1,12 @@
+require 'mobilify'
+
+class Page
+  include Mobilify
+
+  link(:login, class: "log-in-link ellipsis highlight")
+  link(:desktop_login, class: "log-in-link ellipsis highlight")
+  link(:mobile_login, class: "simple-button big-button")
+
+  button(:other_button, class: "other-button-class")
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobilify
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-21 00:00:00.000000000 Z
+date: 2014-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: page-object
@@ -135,14 +135,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- changes.md
 - 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
+- spec/mobilify_spec.rb
+- spec/support/page.rb
 homepage: http://github.com/jdenen/mobilify
 licenses:
 - MIT
@@ -164,13 +162,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.23.2
 signing_key: 
 specification_version: 3
 summary: page-object methods invoked with one call but defined contextually
 test_files:
-- spec/multiple_context_spec.rb
-- spec/page_object_spec.rb
-- spec/simple_context_spec.rb
-- spec/spec_helper.rb
-- spec/support/khan_academy.rb
+- spec/mobilify_spec.rb
+- spec/support/page.rb
+has_rdoc: 

data/spec/multiple_context_spec.rb

@@ -1,29 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,12 +0,0 @@
-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
-