test-factory 0.0.9.1 → 0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    test-factory (0.0.9.1)
+    test-factory (0.1.0)
       watir-webdriver (>= 0.6.1)
 
 GEM

data/README.md

@@ -39,11 +39,11 @@ class BasePage < PageFactory
   class << self
 
     def header_elements
-      element(:main_menu) { |b| b.link(title: "Main Menu") }
+      element(:main_menu_link) { |b| b.link(title: "Main Menu") }
       element(:logout) { |b| b.button(value: "Logout") }
       element(:administration) { |b| b.link(title: "Administration") }
 
-      action(:main_menu) { |p| p.main_menu.click }
+      action(:main_menu) { |p| p.main_menu_link.click }
       action(:provide_feedback) { |b| b.link(title: "Provide Feedback").click }
       action(:administration) { |p| p.administration.click }
     end

data/lib/test-factory/data_factory.rb

@@ -43,6 +43,8 @@ module DataFactory
   # data object, it will get the value from the UI and set the data object's
   # variable to that value. Note that this only supports select lists that allow
   # a single selection.
+  # @param var [instance variable] The instance variable that will either be set or be used to update the page
+  # @param select_list [Watir::Select] The relevant select list element on the page
   #
   # @example
   #

data/lib/test-factory/foundry.rb

@@ -14,6 +14,7 @@ module Foundry
   # method when you are already on the site page you want to interact with.
   # @param page_class [Class] the name of the page class that you want to instantiate
   # @param visit [TrueClass, FalseClass] Essentially you will never have to specify this explicitly
+  # @param &block [C] this is the block of code that you want to run while on the given page
   def on page_class, visit=false, &block
     @current_page = page_class.new @browser, visit
     block.call @current_page if block

data/lib/test-factory/page_factory.rb

@@ -22,7 +22,7 @@ class PageFactory
   class << self
 
     # Define this in a page class and when you use the "visit" method to instantiate the class
-    # it will enter the URL the browser's address bar.
+    # it will enter the URL in the browser's address bar.
     def page_url url
       define_method 'goto' do
         @browser.goto url
@@ -31,6 +31,7 @@ class PageFactory
 
     # Define this in a page class and when that class is instantiated it will wait until that
     # element appears on the page before continuing with the script.
+    # @param element_name [Symbol] The method name of the element that must be present on the page
     def expected_element element_name, timeout=30
       define_method 'expected_element' do
         self.send(element_name).wait_until_present timeout
@@ -40,6 +41,7 @@ class PageFactory
     # Define this in a page class and when the class is instantiated it will verify that
     # the browser's title matches the expected title. If there isn't a match, it raises an
     # error and halts the script.
+    # @param expected_title [String] The exact text that is expected to appear in the Browser title when the page loads
     def expected_title expected_title
       define_method 'has_expected_title?' do
         has_expected_title = expected_title.kind_of?(Regexp) ? expected_title =~ @browser.title : expected_title == @browser.title
@@ -49,6 +51,7 @@ class PageFactory
 
     # The basic building block of the page object classes.
     # Use in conjunction with Watir to define all elements on a given page that are important to validate.
+    # @param element_name [Symbol] The name you're giving to the element on the page.
     #
     # @example
     #   element(:title) { |b| b.text_field(:id=>"title-id") }
@@ -65,8 +68,8 @@ class PageFactory
     # Methods that take one or more parameters can be built with this as well.
     #
     # @example
-    #   action(:continue) { |b| b.frm.button(:value=>"Continue").click } #=> Creates a #continue method that clicks the Continue button
-    #   action(:select_style) { |stylename, b| b.div(:text=>/#{Regexp.escape(stylename)}/).link(:text=>"Select").click } #=> #select_style(stylename)
+    #   action(:continue) { |b| b.frm.button(:value=>"Continue").click } => Creates a #continue method that clicks the Continue button
+    #   action(:select_style) { |stylename, b| b.div(:text=>/#{Regexp.escape(stylename)}/).link(:text=>"Select").click } => #select_style(stylename)
     #
     def action method_name, &block
       define_method method_name.to_s do |*thing|
@@ -84,7 +87,7 @@ class PageFactory
     # And spaces and dashes are converted to underscores.
     #
     # @example
-    #   link("Click Me For Fun!") #=> Creates the methods #click_me_for_fun and #click_me_for_fun_link
+    #   link("Click Me For Fun!") => Creates the methods #click_me_for_fun and #click_me_for_fun_link
     def link(link_text)
       element(damballa(link_text+"_link")) { |b| b.link(:text=>link_text) }
       action(damballa(link_text)) { |b| b.link(:text=>link_text).click }
@@ -98,9 +101,10 @@ class PageFactory
     # and the method for the button itself will have "_button" appended to it. Any special
     # characters are stripped from the string. Capital letters are made lower case.
     # And spaces and dashes are converted to underscores.
+    # @param button_text [String] The contents of the button's value tag in the HTML
     #
     # @example
-    #   button("Click Me For Fun!") #=> Creates the methods #click_me_for_fun and #click_me_for_fun_button
+    #   button("Click Me For Fun!") => Creates the methods #click_me_for_fun and #click_me_for_fun_button
     def button(button_text)
       element(damballa(button_text+"_button")) { |b| b.button(:value=>button_text) }
       action(damballa(button_text)) { |b| b.button(:value=>button_text).click }

data/lib/test-factory/string_factory.rb

@@ -119,6 +119,7 @@ module StringFactory
   end
 
   # Converts a string to a symbol made up of snake case. Spaces and dashes are changed to underscore. Special characters are removed.
+  # @param text [String] The text to be converted to snake case.
   # @example
   #   damballa("A String of Fun Stuff (for you)") => :a_string_of_fun_stuff_for_you
   def self.damballa(text)

data/test-factory.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'test-factory'
-  s.version = '0.0.9.1'
+  s.version = '0.1.0'
   s.summary = %q{rSmart's framework for creating automated testing scripts}
   s.description = %q{This gem provides a set of modules and methods to help quickly and DRYly create a test automation framework using Ruby and Watir (or watir-webdriver).}
   s.files = Dir.glob("**/**/**")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test-factory
 version: !ruby/object:Gem::Version
-  version: 0.0.9.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-13 00:00:00.000000000 Z
+date: 2013-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: watir-webdriver