test-factory 0.1.9 → 0.1.10

data/README.md

@@ -172,63 +172,63 @@ Design Pattern
 The TestFactory was written assuming the following guiding principles. Any code that does not
 follow them probably [smells](http://en.wikipedia.org/wiki/Code_smell), and should be refactored.
 
-1.  Page Classes contain methods relating to interactions with page elements only--meaning
-    the getting or setting of values, or the clicking of links or buttons. Any more
-    complicated page interactions are handled in the Data Object classes, or in the test
-    step definitions.
-2.  Data Objects represent definable data structure entities in the system being tested.
-    As data, they fit into the [CRUD Model](http://en.wikipedia.org/wiki/Create,_read,_update_and_delete)
-    and thus have methods that correspond to those basic functions.
-3.  Data Objects have a single method for each of the CRUD functions, and additional
-    custom methods are avoided without compelling arguments for their inclusion in the class.
-4.  When a Data Object is executing its `edit` method, first the data in the
-    system under test is updated, then the data object's instance variables
-    are updated--using DataFactory's `set_options`.
-5.  Site navigation is handled using conditional methods (meaning they only navigate if
-    necessary) inside the Data Object--and preferably inside the data object's CRUD methods
-    themselves--unless there are specific reasons to explicitly navigate in a step
-    definition. This keeps step definitions from being unnecessarily cluttered.
-6.  Specifying non-default test variables for data objects is done using key/value hash
-    pairs that are parameters of the data object's CRUD methods. It is _not_
-    done by explicitly assigning values to the instance variables. Examples:
-    ```ruby
-    # During object creation, following the name of the class
-    @data_object = make DataObject, :attrib1 => "Custom Value 1", :attrib2 => "Custom Value 2" # etc...
-
-    # When an object is edited (using Ruby v1.9.3's Hash syntax is optional)
-    @data_object.edit attrib1: "Updated Value 1", attrib2: "Updated Value 2"
-
-    # This is frowned upon because it can easily lead to
-    # the data object and the data in the test site being
-    # out of sync, leading to a false negative test result:
-    @data_object.attrib1="Another Value"
-
-    ```
-7.  Updates to a data object's instance variables is handled *only* by the `set_options` method, *not* explicitly.
-    ```ruby
-    # This is good
-    def edit opts={}
-      #...
-      page.element.fit opts[:value]
-      #...
-      update_options(opts)
-    end
+*  Page Classes contain methods relating to interactions with page elements only--meaning
+   the getting or setting of values, or the clicking of links or buttons. Any more
+   complicated page interactions are handled in the Data Object classes, or in the test
+   step definitions.
+*  Data Objects represent definable data structure entities in the system being tested.
+   As data, they fit into the [CRUD Model](http://en.wikipedia.org/wiki/Create,_read,_update_and_delete)
+   and thus have methods that correspond to those basic functions.
+*  Data Objects have a single method for each of the CRUD functions, and additional
+   custom methods are avoided, unless there are _compelling_ arguments for their inclusion in the class.
+*  When a Data Object is executing its `edit` method, first the data in the
+   system under test is updated, then the data object's instance variables
+   are updated--using DataFactory's `set_options`.
+*  Site navigation is handled using conditional methods (meaning they only navigate if
+   necessary) inside the Data Object--and preferably inside the data object's CRUD methods
+   themselves--unless there are specific reasons to explicitly navigate in a step
+   definition. This keeps step definitions from being unnecessarily cluttered.
+*  Specifying non-default test variables for data objects is done using key/value hash
+   pairs that are parameters of the data object's CRUD methods. It is _not_
+   done by explicitly assigning values to the instance variables. Examples:
+```ruby
+# During object creation, following the name of the class
+@data_object = make DataObject, :attrib1 => "Custom Value 1", :attrib2 => "Custom Value 2" # etc...
 
-    # This is not good
-    def edit opts={}
-      #...
-      page.element.fit opts[:value]
-      #...
-      @value=opts[:value] unless @value==opts[:value]
-    end
-    ```
-8.  The setting of random values for select lists in a data object is determined by passing
-    the symbol `:random` in the instance variable or as the value in the key/value pair
-    passed in an `#edit` method's `opts` parameter. The `#create` and `#edit` methods will
-    handle the necessary logic. The purpose is to prevent the need for custom randomizing
-    CRUD methods in the data object.
-9.  See the gem_ext.rb file's discussion of the Watir `#fit` method for additional
-    design pattern rules to follow.
+# When an object is edited (using Ruby v1.9.3's Hash syntax is optional)
+@data_object.edit attrib1: "Updated Value 1", attrib2: "Updated Value 2"
+
+# This is frowned upon because it can easily lead to
+# the data object and the data in the test site being
+# out of sync, leading to a false negative test result:
+@data_object.attrib1="Another Value"
+
+```
+*  Updates to a data object's instance variables is handled *only* by the `set_options` method, *not* explicitly.
+```ruby
+# This is good
+def edit opts={}
+  #...
+  page.element.fit opts[:value]
+  #...
+  update_options(opts)
+end
+
+# This is not good
+def edit opts={}
+  #...
+  page.element.fit opts[:value]
+  #...
+  @value=opts[:value] unless @value==opts[:value]
+end
+```
+*  The setting of random values for select lists in a data object is determined by passing
+   the symbol `:random` in the instance variable, or as the value in the key/value pair
+   passed in an `#edit` method's `opts` parameter. The `#create` and `#edit` methods will
+   handle the necessary logic. The purpose is to prevent the need for custom randomizing
+   CRUD methods in the data object.
+*  See the gem_ext.rb file's discussion of the Watir `#fit` method for additional
+   design pattern rules to follow.
 
 Notice
 ------

data/lib/test-factory/gem_ext.rb

@@ -14,9 +14,17 @@
 # Proper use of the +#fit+ method requires following a particular coding
 # pattern, however:
 #
-# 1. In your Page Classes, define your text fields, select lists, radio buttons, and checkboxes directly. Do not define +#select+, +#set+ and/or +#clear+ actions there.
-# 2. Your data object's instance variables for radio buttons and checkboxes, when not +nil+, should have the values of +:set+ or +:clear+. If they *need* to be something else, then define a Hash transform method to easily convert the custom values back to +:set+ or +:clear+, then pass that transform to the +#fit+ method.
-# 3. Always remember to end your +#edit+ methods with the +#set_options()+ method (a.k.a. +#update_options+), from the DataFactory module. It automatically takes care of updating your data object's instance variables with any new values.
+# * In your Page Classes, define your text field, select list, radio button, and
+#   checkbox elements directly. Do not define +#select+, +#set+ and/or +#clear+
+#   actions there.
+# * Your data object's instance variables for radio buttons and checkboxes, when
+#   not +nil+, should have the values of +:set+ or +:clear+. If they *need* to be
+#   something else, then define a Hash transform method to easily convert the
+#   custom values back to +:set+ or +:clear+, then pass that transform to the +#fit+ method.
+# * Always remember to end your +#edit+ methods with the +#set_options()+
+#   method (a.k.a. +#update_options+), from the DataFactory module. It
+#   automatically takes care of updating your data object's instance variables
+#   with any new values.
 #
 # ==Example
 #

data/test-factory.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'test-factory'
-  s.version = '0.1.9'
+  s.version = '0.1.10'
   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.1.9
+  version: 0.1.10
   prerelease: 
 platform: ruby
 authors:
@@ -48,6 +48,7 @@ files:
 - lib/test-factory.rb
 - README.md
 - test-factory-0.1.8.gem
+- test-factory-0.1.9.gem
 - test-factory.gemspec
 homepage: https://github.com/rSmart
 licenses: []