test-factory 0.0.8 → 0.0.9

data/Gemfile.lock

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

data/lib/test-factory/page_factory.rb

@@ -1,3 +1,6 @@
+# The PageFactory class provides a set of methods that allow the rapid creation of page element definitions--known
+# colloquially as "page objects". These elements are defined using Watir syntax. Please see www.watir.com if you are
+# not familiar with Watir.
 class PageFactory
 
   # As the PageFactory will be the superclass for all your page classes, having this initialize
@@ -10,7 +13,8 @@ class PageFactory
   end
 
   # Catches any "missing" methods and passes them to the browser object--which means
-  # that Watir will take care of parsing them.
+  # that Watir will take care of parsing them, so the assumption is that the method being
+  # passed is a valid method for the browser object.
   def method_missing sym, *args, &block
     @browser.send sym, *args, &block
   end
@@ -61,8 +65,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 }
-    #   action(:select_style) { |stylename, b| b.div(:text=>/#{Regexp.escape(stylename)}/).link(:text=>"Select").click }
+    #   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|
@@ -70,6 +74,44 @@ class PageFactory
       end
     end
 
+    # Use this for links that are safe to define by their text string.
+    # This method will return two methods for interacting with the link:
+    # one that refers to the link itself, and one that clicks on it.
+    # Since it's assumed that the most common thing done with a link is to click it,
+    # the method for clicking it will be named according to the text of the link,
+    # and the method for the link itself will have "_link" 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.
+    #
+    # @example
+    #   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.frm.link(:text=>link_text).click }
+    end
+
+    # Use this for buttons that are safe to define by their value attribute.
+    # This method will return two methods for interacting with the button:
+    # one that refers to the button itself, and one that clicks on it.
+    # Since it's assumed that the most common thing done with a button is to click it,
+    # the method for clicking it will be named according to the value of the button,
+    # 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.
+    #
+    # @example
+    #   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.frm.button(:value=>button_text).click }
+    end
+
+    # A helper method that converts the passed string into snake case. See the StringFactory
+    # module for more info.
+    def damballa(text)
+      StringFactory::damballa(text)
+    end
+
   end
 
-end # PageMaker
+end # PageFactory

data/lib/test-factory/string_factory.rb

@@ -118,4 +118,14 @@ module StringFactory
     "#"+("%06x" % (rand * 0xffffff)).upcase
   end
 
+  # Converts a string to a symbol made up of snake case. Spaces and dashes are changed to underscore. Special characters are removed.
+  # @example
+  #   damballa("A String of Fun Stuff (for you)") => :a_string_of_fun_stuff_for_you
+  def self.damballa(text)
+    text.gsub(/([+=|\\\.~@#'"\?`!\{\}\[\]\$%\^&\*\(\)])/, "").
+        gsub(/([-\/\ ])/,"_").
+        downcase.
+        to_sym
+  end
+
 end

data/test-factory.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'test-factory'
-  s.version = '0.0.8'
+  s.version = '0.0.9'
   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.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-30 00:00:00.000000000 Z
+date: 2012-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: watir-webdriver