pouch 0.0.1 → 0.1.0

data/lib/pouch/version.rb

@@ -1,3 +1,3 @@
 module Pouch
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/pouch.rb

@@ -1,5 +1,81 @@
 require "pouch/version"
 
 module Pouch
-  # Your code goes here...
+
+  class ContextualReplacementError < StandardError; end
+  
+  def self.included base
+    base.extend self
+  end
+
+  def initialize browser, start = false, opts = {}
+    if start.is_a?(Hash) && opts.empty?
+      opts = start
+      start = false
+    end
+    
+    @browser = browser
+    @context = standardize opts[:context] if opts[:context]
+    visit if self.respond_to?(:visit) && start
+    contextualize_methods
+  end
+
+  def browser
+    @browser
+  end
+
+  def context
+    @context
+  end
+
+  def page_url= str
+    define_method :visit do
+      self.browser.goto str
+    end
+  end
+
+  def element tag, name, identifier, *args, &block
+    define_method name do
+      return browser.element_for tag, identifier unless block_given?
+      block.call browser.send('element_for', tag, identifier), *args
+    end
+  end
+
+  private
+
+  def contextualize_methods
+    return unless context
+    context.each_with_object([]) do |ctxt, array|
+      next unless array.flatten.empty?
+      array << match_and_replace(ctxt)
+    end
+  end
+
+  def match_and_replace context
+    get_match(context).map{ |mthd| self.method mthd }.each{ |mthd| replace_method mthd, context }
+  end
+
+  def get_match context
+    methods.select{ |mthd| mthd.to_s.start_with? "#{context}_" }.each_with_object([]) do |mthd, array|
+      unless respond_to? mthd.to_s.gsub("#{context}_", "")
+        raise ContextualReplacementError, "#{self.class} defined no standard method for replacement '#{mthd}'"
+      end
+      array << mthd
+    end
+  end
+
+  def replace_method method, context
+    (class << self; self; end).class_eval{ define_method method.name.to_s.gsub("#{context}_",""), method }
+  end
+
+  def standardize context
+    context.map!{ |c| standardize c } if context.kind_of? Array
+      
+    if [Array, String, Symbol].include? context.class
+      [context].flatten.map(&:to_s)
+    else
+      raise "Cannot define Pouch context as #{context.class}"
+    end
+  end
+  
 end

data/pouch.gemspec

@@ -18,6 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "watir-webdriver", "~> 0.6.11"
+
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
 end

data/spec/pouch_spec.rb

@@ -0,0 +1,168 @@
+require 'spec_helper'
+
+describe Pouch do
+  
+  describe ".included" do
+    class Page; end
+    
+    it "extends Pouch onto the base class" do
+      expect(Page).to receive(:extend).with(Pouch)
+      Page.send(:include, Pouch)
+    end
+  end
+
+  describe "#initialize" do
+    class Page2; include Pouch; end
+    
+    it "creates @browser variable" do
+      obj = Page2.new 'webdriver'
+      expect(obj.instance_variable_get :@browser).to eq 'webdriver'
+    end
+        
+    context "when instance does not respond to #visit" do
+      it "doesn't navigate to page_url if start=true" do
+        driver = double 'webdriver'
+        expect(driver).to_not receive(:goto).with('url')
+        Page2.new driver, true, context: 'test'
+      end
+
+      it "doesn't navigate to page_url if start=false" do
+        driver = double 'webdriver'
+        expect(driver).to_not receive(:goto).with('url')
+        Page2.new driver, false
+      end
+    end
+
+    context "when instance responds to #visit" do
+      it "doesn't navigate to page_url if start=false" do
+        Page2.send :page_url=, 'url'
+        driver = double 'webdriver'
+        expect(driver).to_not receive(:goto)
+        Page2.new driver, false
+      end
+
+      it "navigates to page_url if start=true" do
+        driver = double 'webdriver'
+        expect(driver).to receive(:goto).with('url')
+        Page2.new driver, true, context: 'test'
+      end
+    end
+
+    context "with context" do
+      obj = ->(context){ Page2.new 'webdriver', context: context }
+      
+      it "defines @context with String argument" do
+        expect(obj.call('my_context').instance_variable_get :@context).to eq ['my_context']
+      end
+
+      it "defines @context with Array argument" do
+        expect(obj.call(['my_context']).instance_variable_get :@context).to eq ['my_context']
+      end
+
+      it "defines @context with Symbol argument" do
+        expect(obj.call(:my_context).instance_variable_get :@context).to eq ['my_context']
+      end
+      
+      it "defines @context with two Strings" do
+        expect(obj.call(['one', 'two']).instance_variable_get :@context).to eq ['one', 'two']
+      end
+
+      it "defines @context with two Arrays" do
+        expect(obj.call([['one'], ['two']]).instance_variable_get :@context).to eq ['one', 'two']
+      end
+
+      it "defines @context with two Symbols" do
+        expect(obj.call([:one, :two]).instance_variable_get :@context).to eq ['one', 'two']
+      end
+
+      it "defines @context with one String and one Array" do
+        expect(obj.call(['one', [:two]]).instance_variable_get :@context).to eq ['one', 'two']
+      end
+
+      it "defines @context with combination of Array, String, and Symbol" do
+        given = [:one, 'two', [:three, [:four, 'five'], :six], 'seven', ['eight', [['nine', [:ten]]]]]
+        expected = ['one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine', 'ten']
+        expect(obj.call(given).instance_variable_get :@context).to eq expected
+      end
+
+      it "raises StandardError with Hash argument" do
+        expect{ obj.call({}) }.to raise_error(StandardError, /Hash/)
+      end
+
+      it "raises StandardError if one argument is a Number" do
+        expect{ obj.call(['one', 2]) }.to raise_error(StandardError, /Fixnum/)
+      end
+    end
+  end
+
+  class Page3
+    include Pouch
+    element(:a, :generic, id: 'generic')
+    element(:a, :blocked, id: 'blocked'){ |link| link.href }
+    element(:a, :different_generic, id: 'generic-diff')
+    element(:a, :different_blocked, id: 'blocked-diff'){ |link| link.href }
+    element(:a, :what_replacement, id: 'no-match')
+  end
+
+  describe "#browser" do
+    it "returns the browser instance" do
+      obj = Page3.new 'webdriver'
+      expect(obj.browser).to eq 'webdriver'
+    end
+  end
+
+  describe "#context" do
+    it "returns the page object context" do
+      obj = Page3.new 'webdriver', context: ['one', :two, ['three']]
+      expect(obj.context).to eq ['one', 'two', 'three']
+    end
+  end
+
+  describe "#element" do
+    let(:browser){ double 'webdriver' }
+    let(:element){ double 'html_link' }
+    let(:page){ Page3.new browser }
+    let(:diff){ Page3.new browser, context: 'different' }
+    let(:what){ Page3.new browser, context: 'what' }
+
+    it "returns the link element by default" do
+      expect(browser).to receive(:element_for).with(:a, id:'generic').and_return(element)
+      expect(page.generic).to eq element
+    end
+
+    it "returns an element that can be clicked" do
+      expect(browser).to receive(:element_for).with(:a, id:'generic').and_return(element)
+      expect(element).to receive(:click)
+      page.generic.click
+    end
+
+    it "returns the result of the definition block" do
+      expect(browser).to receive(:element_for).with(:a, id:'blocked').and_return(element)
+      expect(element).to receive(:href).and_return("www.test.com")
+      expect(page.blocked).to eq "www.test.com"
+    end
+
+    context "with context" do
+      it "uses the replacement method" do
+        expect(browser).to receive(:element_for).with(:a, id:'generic-diff').and_return(element)
+        expect(diff.generic).to eq element
+      end
+
+      it "uses the replacement method with definition block" do
+        expect(browser).to receive(:element_for).with(:a, id:'blocked-diff').and_return(element)
+        expect(element).to receive(:href).and_return("www.diff.com")
+        expect(diff.blocked).to eq "www.diff.com"
+      end
+
+      it "uses the standard method when context matches no replacement" do
+        expect(browser).to receive(:element_for).with(:a, id:'generic').and_return(element)
+        expect(Page3.new(browser, context: 'test').generic).to eq element
+      end
+
+      it "throws an error with replacement but no standard method" do
+        expect{ what.replacement }.to raise_error Pouch::ContextualReplacementError, /Page3 defined no standard method for replacement/
+      end
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.expand_path '../../lib', __FILE__)
+
+require 'pouch'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.order = 'default'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pouch
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-21 00:00:00.000000000 Z
+date: 2014-11-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: watir-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.11
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -43,6 +59,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: A flexible page object DSL for responsive UI testing via automated browsers
   and devices
 email:
@@ -59,6 +91,8 @@ files:
 - lib/pouch.rb
 - lib/pouch/version.rb
 - pouch.gemspec
+- spec/pouch_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/jdenen/pouch
 licenses:
 - MIT
@@ -84,5 +118,7 @@ rubygems_version: 1.8.23.2
 signing_key: 
 specification_version: 3
 summary: A flexible page object DSL for responsive UI testing
-test_files: []
+test_files:
+- spec/pouch_spec.rb
+- spec/spec_helper.rb
 has_rdoc: