watir-page-helper 1.0.3

data/script/generate

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+require 'erb'
+
+def path_to_template name
+  File.join Dir.pwd, "script/templates/#{name}.erb"
+end
+
+def with_template name
+  template_content = File.read path_to_template(name)
+  template = ERB.new template_content, 0, "%<>"
+  yield template
+end
+
+simple_elements = %w{h1 h2 h3 h4 h5 h6 div span p}
+texty_elements = simple_elements + %w{dl dd dt form li}
+clicky_elements = %w{link button}
+setty_elements = %w{text_field}
+non_extended_elements = %w{table image frame}
+
+with_template 'test.html' do |template|
+  File.open 'features/support/test.html', 'w' do |f|
+    f.puts template.result(binding)
+  end
+end
+
+with_template 'simple_element.feature' do |template|
+  simple_elements.each do |element|
+    File.open "features/simple_elements/#{element}.feature", 'w' do |f|
+      f.puts template.result(binding)
+    end
+  end
+end
+
+with_template 'generated.rb' do |template|
+  File.open 'lib/watir-page-helper/generated.rb', 'w' do |f|
+    f.puts template.result(binding)
+  end
+end

data/script/templates/generated.rb.erb

@@ -0,0 +1,90 @@
+module WatirPageHelper
+  module ClassMethods
+% texty_elements.each do |element|
+
+    # Generates two <%= element %> methods to:
+    # * return the text from a <%= element %>;
+    # * return the <%= element %> element.
+    #
+    # @param [Symbol] name The name of the <%= element %> element (used to generate the methods)
+    # @param [optional, Hash] identifier A set of key, value pairs to identify the element
+    # @param block
+    # @return [Nil]
+    #
+    # @example Specify a <%= element %> to generate methods
+    # <%= element %> :my_element, :id => "my_element"
+    # page.my_element.should == "My Element Text"
+    # page.my_element_<%= element %>.exist?.should be_true
+    def <%= element %> name, identifier=nil, &block
+      define_method(name) do
+        self.send("#{name}_<%= element %>").text
+      end
+      create_element_getter "#{name}_<%= element %>", identifier, __method__, block
+    end
+% end
+% clicky_elements.each do |element|
+
+    # Generates two <%= element %> methods to:
+    # * click a <%= element %>;
+    # * return the <%= element %> element.
+    #
+    # @param [Symbol] name The name of the <%= element %> element (used to generate the methods)
+    # @param [optional, Hash] identifier A set of key, value pairs to identify the element
+    # @param block
+    # @return [Nil]
+    #
+    # @example Specify a <%= element %> to generate methods
+    # <%= element %> :info, :text => "Information"
+    # page.info
+    # page.info_<%= element %>.exist?.should be_true
+    def <%= element %> name, identifier=nil, &block
+      define_method(name) do
+        self.send("#{name}_<%= element %>").click
+      end
+      create_element_getter "#{name}_<%= element %>", identifier, __method__, block
+    end
+% end
+% setty_elements.each do |element|
+
+    # Generates three <%= element %> methods to:
+    # * set a <%= element %>;
+    # * get a <%= element %>'s value; and
+    # * return the <%= element %> element.
+    #
+    # @param [Symbol] name The name of the <%= element %> element (used to generate the methods)
+    # @param [optional, Hash] identifier A set of key, value pairs to identify the element
+    # @param block
+    # @return [Nil]
+    #
+    # @example Specify a <%= element %> to generate methods
+    # <%= element %> first_name, :name => "firstname"
+    # page.first_name = "Finley" #set
+    # page.first_name.should == "Finley" #check
+    # page.first_name_<%= element %>.exists?.should be_true #object
+    def <%= element %> name, identifier=nil, &block
+      define_method(name) do
+        self.send("#{name}_<%= element %>").value
+      end
+      define_method("#{name}=") do |value|
+        self.send("#{name}_<%= element %>").set value
+      end
+      create_element_getter "#{name}_<%= element %>", identifier, __method__, block
+    end
+% end
+% non_extended_elements.each do |element|
+
+    # Generates a <%= element %> method to return a <%= element %> element.
+    # @param [Symbol] name The name of the <%= element %> element (used to generate the method)
+    # @param [optional, Hash] identifier A set of key, value pairs to identify the element
+    # @param block
+    # @return [Nil]
+    #
+    # @example Specify a <%= element %> to generate a method
+    #   table :my_element, :id => 'my_element'
+    #   page.my_element.exists?.should be_true
+    def <%= element %> name, identifier=nil, &block
+      create_element_getter "#{name}", identifier, __method__, block
+    end
+% end
+  end
+end

data/script/templates/simple_element.feature.erb

@@ -0,0 +1,27 @@
+Feature: <%= element %>
+  As a web developer
+  I want to locate <%= element %> elements
+  So that I can write tests that make assertions about their content
+
+  Background:
+    When I define a page class as:
+    """
+    class PageWith<%= element.upcase %> < BasePageClass
+      include WatirPageHelper
+      <%= element %> :element, :id => '<%= element %>_identifier'
+    end
+    """
+
+  Scenario: <%= element %> element is located
+    Then I should be able to locate the element with the following code:
+    """
+    page = PageWith<%= element.upcase %>.new true
+    page.element_<%= element %>.exists?.should be_true
+    """
+
+  Scenario: <%= element %> text is extracted
+    Then I should be able to execute the following assertion:
+    """
+    page = PageWith<%= element.upcase %>.new true
+    page.element.should == '<%= element %> expected content'
+    """

data/script/templates/test.html.erb

@@ -0,0 +1,10 @@
+<html>
+<head>
+</head>
+<body>
+% simple_elements.each do |element|
+  <<%= element %>><%= element %> unexpected content</<%= element %>>
+  <<%= element %> id="<%= element %>_identifier"><%= element %> expected content</<%= element %>>
+% end
+</body>
+</html>

data/spec/example1.rb

@@ -0,0 +1,19 @@
+require 'watir-webdriver'
+require 'watir-page-helper/commands'
+
+class MyPage < WatirPageHelper::Page
+  direct_url "http://www.google.com"
+  expected_element :text_field, :name => "q"
+  expected_title "Google"
+  text_field :search_box, :name => "q"
+  button :search, :name => "btnG"
+end
+
+include WatirPageHelper::Commands
+
+WatirPageHelper.create
+visit MyPage do |page|
+  page.search_box = "Watirmelon"
+  page.search
+end
+WatirPageHelper.close

data/spec/example2.rb

@@ -0,0 +1,12 @@
+$: << File.dirname(__FILE__)
+require 'watir-webdriver'
+require 'watir-page-helper/commands'
+
+include WatirPageHelper::Commands
+
+WatirPageHelper.create
+visit :my_page do |page|
+  page.search_box = "Watirmelon"
+  page.search
+end
+WatirPageHelper.close

data/spec/helper.rb

@@ -0,0 +1,12 @@
+require 'rspec'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'watir-page-helper'
+require 'watir-page-helper/commands'
+require 'watir-webdriver'
+
+module CommonPage
+  include WatirPageHelper
+  direct_url "file://#{File.expand_path(File.dirname(__FILE__))}/test.html"
+end

data/spec/iframe.html

@@ -0,0 +1,9 @@
+<html>
+<head>
+    <title>HTML Document Title</title>
+</head>
+<body>
+
+ <a href="">Link in an iFrame</a>
+</body>
+</html>

data/spec/pages.rb

@@ -0,0 +1,118 @@
+class BaseTestPage < WatirPageHelper::Page
+  TEST_URL = "file://#{File.expand_path(File.dirname(__FILE__))}/test.html"
+  direct_url TEST_URL
+end
+
+class PageIncorrectTitle < BaseTestPage
+  expected_title "not expected"
+end
+
+class PageIncorrectTitleRegExp < BaseTestPage
+  expected_title /.*not expected.*/
+end
+
+class PageCorrectTitle  < BaseTestPage
+  expected_title "HTML Document Title"
+end
+
+class PageCorrectTitleRegExp < BaseTestPage
+  expected_title /^HTML Document Title$/
+end
+
+class PageExpectElement < BaseTestPage
+  expected_element :text_field, :name => "firstname"
+end
+
+class PageExpectNonElement < BaseTestPage
+  expected_element(:text_field, {:name => "doesntexist"}, 1)
+end
+
+class PageTextFields < BaseTestPage
+  text_field :first_name, :name => "firstname"
+end
+
+class PageSelectList < BaseTestPage
+  select_list :cars, :name => "cars"
+end
+
+class PageCheckbox < BaseTestPage
+  checkbox :agree, :name => "agree"
+end
+
+class PageRadioButton < BaseTestPage
+  radio :medium, :value => "Medium"
+end
+
+class PageButton < BaseTestPage
+  button :submit, :value => "Submit"
+end
+
+class PageLink < BaseTestPage
+  link :info, :text => "Information Link"
+end
+
+class PageTable < BaseTestPage
+  table :test_table, :id => "myTable"
+  row :test_table_row_1
+  cell :test_table_row_1_cell_1
+end
+
+class PageDiv < BaseTestPage
+  div :information, :id => "myDiv"
+end
+
+class PageNestedDiv < BaseTestPage
+  div :my_nice_div, :id => 'myNiceDiv'
+  div(:my_unnamed_div) { |page| page.my_nice_div_div.div }
+  span(:my_unnamed_span) { |page| page.my_nice_div_div.span }
+end
+
+class PageNestedNoParams < BaseTestPage
+  div :my_nice_div, :id => 'myNiceDiv'
+  div(:my_unnamed_div) { my_nice_div_div.div }
+  span(:my_unnamed_span) { my_nice_div_div.span }
+end
+
+class PageSpan < BaseTestPage
+  span :background, :id => "mySpan"
+end
+
+class PageParagraph < BaseTestPage
+  p :paragraph, :id => "myP"
+end
+
+class PageDlDtDd < BaseTestPage
+  dl :definition_list, :id => "myDl"
+  dt(:definition_type) { | page | page.definition_list_dl.dt }
+  dd(:definition_data) { | page | page.definition_list_dl.dd }
+end
+
+class PageForm < BaseTestPage
+  form :main_form, :name => "myForm"
+end
+
+class PageImage < BaseTestPage
+  image :succulent_image, :id => "myImage"
+end
+
+class PageLi < BaseTestPage
+  li :blue_item, :id => "blueLi"
+end
+
+class PageHeadings < BaseTestPage
+  h1 :heading_one, :id => "myh1"
+  h2 :heading_two, :id => "myh2"
+  h3 :heading_three, :id => "myh3"
+  h4 :heading_four, :id => "myh4"
+  h5 :heading_five, :id => "myh5"
+  h6 :heading_six, :id => "myh6"
+end
+
+class PageIFrame < BaseTestPage
+  frame :iframe, :id => "myiframe"
+  link(:ilink) { |page|  page.iframe.link(:text => 'Link in an iFrame') }
+end
+
+class PageFileField < BaseTestPage
+  file_field :upload, :id => 'upload'
+end

data/spec/test.html

@@ -0,0 +1,103 @@
+<html>
+<head>
+    <title>HTML Document Title</title>
+</head>
+<body>
+<a href="">Information Link</a>
+<div style="color:#00FF00" id="myDiv">
+  <h3>This is a header</h3>
+  <p id="myP">This is a paragraph.</p>
+</div>
+<span id="mySpan">Some background text in a span.</span><br />
+<div id="myNiceDiv">
+    <div>This div is unnamed and inside myNiceDiv.</div>
+    <span>This span is unnamed and inside myNiceDiv.</span>
+</div>
+<dl id="myDl">
+  <dt>Succulents</dt>
+    <dd>- water-retaining plants adapted to arid climates or soil conditions.</dd>
+  <dt>Cactus</dt>
+    <dd>- plants who distinctive appearance is a result of adaptations to conserve water in dry and/or hot environments.</dd>
+</dl>
+
+<form action="" name="myForm">
+    First name: <label>
+    <input type="text" name="firstname"/>
+</label><br/>
+    Last name: <label>
+    <input type="text" name="lastname"/>
+</label><br/>
+    Car model: <label>
+    <select name="cars">
+        <option value="Honda">Honda</option>
+        <option value="Mazda">Mazda</option>
+        <option value="Toyota">Toyota</option>
+    </select>
+</label><br/>
+    Do you agree?: <label>
+    <input type="checkbox" name="agree">
+</label>I agree<br/>
+    <label>
+        <input type="radio" name="group1" value="High">
+    </label>High<br>
+    <label>
+        <input type="radio" name="group1" value="Medium">
+    </label>Medium<br>
+    <label>
+        <input type="radio" name="group1" value="Low">
+    </label>Low<br/>
+    <input type="file" id="upload"/>
+    <input type="submit" value="Submit"/>
+</form>
+<table id="myTable" border="6">
+    <tr>
+        <td>
+            Test Table Col 1
+        </td>
+        <td>
+            Test Table Col 2
+        </td>
+    </tr>
+</table>
+<table id="mySecondTable" border="6">
+    <tr>
+        <td>
+            Test Table 2 Col 1
+        </td>
+        <td>
+            Test Table 2 Col 2
+        </td>
+    </tr>
+</table>
+<br>
+<ol id="myOl">
+    <li id="greenLi">
+        Green
+    </li>
+    <li id="redLi">
+        Red
+    </li>
+    <li id=blueLi>
+        Blue
+    </li>
+</ol>
+<br>
+<h1 id="myh1">Heading One</h1>
+<h2 id="myh2">Heading Two</h2>
+<h3 id="myh3">Heading Three</h3>
+<h4 id="myh4">Heading Four</h4>
+<h5 id="myh5">Heading Five</h5>
+<h6 id="myh6">Heading Six</h6>
+<br>
+<img src="test.png" alt="Succulents" id="myImage" />
+
+<html>
+<body>
+<p>TEST IFRAME ISSUES</p>
+<iframe src="iframe.html" id="myiframe" width="100%" height="200px">
+</iframe>
+</body>
+</html>
+
+</body>
+</html>