test-factory 0.0.5 → 0.0.6

data/Gemfile.lock

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

data/README.md

@@ -8,6 +8,12 @@ This gem contains the basic framework for [dryly](http://en.wikipedia.org/wiki/D
 
 Use it to abstract away from the underlying [Watir](http://www.watir.com) code and create your own [DSL](http://en.wikipedia.org/wiki/Domain_specific_language).
 
+With TestFactory you have the ability to...
+
+1. Easily instantiate pages in a consistent manner
+2. Concisely describe elements on a page, keeping it DRY by avoiding repetition of element identifiers
+3. Provide higher-level methods that use the elements to perform user-0oriented functions
+
 Tremendous thanks is due to [Alister Scott](http://watirmelon.com), whose [custom page object code](https://github.com/alisterscott/wmf-custom-page-object) for the Wikimedia Foundation provided the inspiration for this gem.
 
 How to Start
@@ -135,7 +141,6 @@ on MyPage do |page|
   # Very contrived example. You should be using your favorite verification framework here:
   page.description==@my_thing.description ? puts "Passed" : puts "Failed"
 end
-
 ```
 
 Notice

data/lib/test-factory/page_factory.rb

@@ -41,6 +41,9 @@ 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.
+    #
+    # @example
+    #   element(:title) { |b| b.frm.text_field(:id=>"title-id") }
     def element element_name
       raise "#{element_name} is being defined twice in #{self}!" if self.instance_methods.include?(element_name.to_sym)
       define_method element_name.to_s do
@@ -50,6 +53,15 @@ class PageFactory
     alias :value :element
 
     # The basic building block for interacting with elements on a page, such as links and buttons.
+    #
+    # @example
+    #   action(:continue) { |b| b.frm.button(:value=>"Continue").click }
+    #
+    # This can also be used to create methods that take parameters. Like so...
+    #
+    # @example
+    #   action(:select_style) { |stylename, b| b.div(:text=>/#{Regexp.escape(stylename)}/).link(:text=>"Select").click }
+    #
     def action method_name, &block
       define_method method_name.to_s do |*thing|
         Proc.new(&block).call *thing, self

data/test-factory.gemspec

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