test-factory 0.3.8 → 0.3.9

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzU4MWU4YjViOTQ0MmYwMTZkYjljNzZiZjlkYTE0NTg4YWMwMWE4Ng==
+    MGUwYjI5N2E3MjM1YmVlZmQ2NzMzYTRkY2JiODA2ZjIxY2U3NjEwYQ==
   data.tar.gz: !binary |-
-    ZWY4MDQzYmEzZjQyMDQzYTJiY2UyODg1ZjllYmUwYjM2NTYzMmJlZQ==
+    ZTFiZWRjOThjNzc0MzQ3ZTMyNzQyYmM2YWJiZGQ2Zjk3NmUzODgyMg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MDMzYWZlNjZjYjhhYjE5NDVlYmIxMWZhMTgzYTMyZjc5ZjUxYTgzYzNhMzM0
-    ZWZiOGMyNDljYzUzYjcyY2Q5YjM5MWNiMjNkMWNjYmJmM2U3MDc1MmNkNjNk
-    MWY5ZTY2YTdiYmIyM2Y5NGQ0YTBmMDY2ZmFmNDE5ODllMTlkNGU=
+    MzkzYjA2NjYwNDk5NTZmNDg5ZTc2YTgxMWY1NWExYjUyYTcyOWRjYzUxNWJh
+    YzkxYjkzODk3NDZhMDEzMGZlM2I1MzEzMDZjOTBmMzE3MjczOTRiN2IyNTRk
+    ZmZhZTRkODMzYjhlMzQwYWY2ZDFlZmNkNmZlNmU5YmUzYzE1NzY=
   data.tar.gz: !binary |-
-    ZDFmNGUwYjZjNTFmN2ZkNDg3M2QzMzU1MGIzY2I3N2ZjMDY5MDM1ODUwYmQ1
-    NDVkOTkyYWI2YWUyOTA3YjhmMDYwZDA4NjA1ZmI3YWYxZGQ0MWRjZTljMzM1
-    MGRhNWM3ZWMxYzljYmVkYzRiYmMwYTJiYzQ0ZDVlNmJjNjliNjg=
+    MTRhM2Y5ZjkyY2ZkMmQ5ZWE1ODI1NmM2MTFjZTc0ODUzZjY1MjNjZTg4NjBl
+    ZDI2YzYwMzFjODZkYzZkNTg0MTEzNWM2ZWE4ZjUxMTUwOGUxNmMwNTAxYmZh
+    NGRmMTJkYzFiOThhMzIzZGE0MTY2ZTEyMDkwZDQ1ZTgyNmRhOTQ=

data/README.md

@@ -213,7 +213,7 @@ follow them probably [smells](http://en.wikipedia.org/wiki/Code_smell), and shou
 
 ```
 
-*  Updates to a data object's instance variables are handled *only* by the `set_options` method, *not* explicitly.
+*  Except in very rare cases, updates to a data object's instance variables should be handled *only* by the `set_options` method, *not* explicitly.
 
 ```ruby
 # This is good

data/lib/test-factory.rb

@@ -13,4 +13,5 @@
 # limitations under the License.
 
 require 'watir-webdriver'
+require "#{File.dirname(__FILE__)}/test-factory/foundry.rb"
 Dir["#{File.dirname(__FILE__)}/test-factory/*.rb"].each {|f| require f }

data/lib/test-factory/collections_factory.rb

@@ -24,6 +24,7 @@ class CollectionsFactory < Array
   end
 
   # Defines the class of objects contained in the collection
+  #
   def self.contains klass
 
     # Creates a method called "add" that will create the specified data
@@ -39,6 +40,17 @@ class CollectionsFactory < Array
 
   end
 
+  # Makes a "deep copy" of the Collection. See the #data_object_copy
+  # method description in the DataObject class for more information.
+  #
+  def copy
+    new_collection = self.class.new(@browser)
+    self.each do |item|
+      new_collection << item.data_object_copy
+    end
+    new_collection
+  end
+
 end
 
 class CollectionFactory < CollectionsFactory

data/lib/test-factory/data_factory.rb

@@ -34,7 +34,8 @@ module DataFactory
   # E.g., your collection class is called "DataObjectCollection", so, inside your
   # parent object's defaults, you'd set the instance variable like this:
   #
-  # data_objects: collection('DataObject')
+  # @example
+  #   data_objects: collection('DataObject')
   #
   def collection(name)
     Kernel.const_get("#{name}Collection").new(@browser)
@@ -52,7 +53,6 @@ module DataFactory
   # @param elements [Array] the list of items that are required.
   #
   # @example
-  #
   #   requires :site, :assignment, :document_id
   #
   def requires(*elements)
@@ -72,7 +72,7 @@ module DataFactory
 
   # Transform for use with data object instance variables
   # that refer to checkboxes or radio buttons. Instead of returning a boolean value, it returns
-  # the symbols :set or :clear -- This can be useful because those symbols can then in turn
+  # the symbols +:set+ or +:clear+ -- This can be useful because those symbols can then in turn
   # be passed directly as methods for updating or validating the checkbox later.
   #
   # @param checkbox [Watir::CheckBox] The checkbox on the page that you want to inspect
@@ -88,51 +88,47 @@ module DataFactory
   # (as Symbols).
   #
   # This method has a number of requirements:
+  #
   # 1) The field name and the instance variable name in your data object
-  #    must be identical. For this reason, this method can only
-  #    be used in your data objects' create methods.
+  # must be identical. For this reason, this method can only
+  # be used in your data objects' create methods.
+  #
   # 2) Your checkbox and radio button data object instance variables are
-  #    either nil, :set, or :clear. Any other values will not be handled
-  #    correctly.
+  # either +nil+, +:set+, or +:clear+. Any other values will not be handled
+  # correctly.
+  #
   # 3) Since the listed fields get filled out in random order, be sure that
-  #    this is okay in the context of your page--in other words, if field A
-  #    needs to be specified before field B then having them both in your
-  #    fill_out step would be inappropriate.
+  # this is okay in the context of your page--in other words, if field A
+  # needs to be specified before field B then having them both in your
+  # fill_out step would be inappropriate.
+  #
   # 4) This method supports text fields, select lists, check boxes, and
-  #    radio buttons, but only if their element definitions don't take a
-  #    parameter. Please use the #fill_out_item with elements that do need
-  #    a parameter defined.
+  # radio buttons, but only if their element definitions don't take a
+  # parameter. Please use the +#fill_out_item+ with elements that do need
+  # a parameter defined.
   #
   # @example
-  #
   #   on PageClass do |page|
   #     fill_out page, :text_field_name, :radio_name, :select_list_name, :checkbox_name
   #   end
   #
   def fill_out(page, *fields)
-    watir_methods=[ lambda{|p, f| p.send(f).fit(instance_variable_get "@#{f}") },
-                    lambda{|p, f| p.send(f).pick!(instance_variable_get "@#{f}") } ]
-    fields.shuffle.each do |field|
-      x = page.send(field).class.to_s=='Watir::Select' ? 1 : 0
-      watir_methods[x].call(page, field)
-    end
+    fill_out_item(nil, page, *fields)
   end
 
   # Same as #fill_out, but used with methods that take a
   # parameter to identify the target element...
   #
   # @example
-  #
   #   on PageClass do |page|
   #     fill_out_item 'Joe Schmoe', page, :text_field_name, :radio_name, :select_list_name, :checkbox_name
   #   end
   #
   def fill_out_item(name, page, *fields)
-    watir_methods=[ lambda{|n, p, f| p.send(f, n).fit(instance_variable_get "@#{f}") },
-                    lambda{|n, p, f| p.send(f, n).pick!(instance_variable_get "@#{f}") } ]
     fields.shuffle.each do |field|
-      x = page.send(field, name).class.to_s=='Watir::Select' ? 1 : 0
-      watir_methods[x].call(name, page, field)
+      lmnt = page.send(*[field, name].compact)
+      var = instance_variable_get "@#{field}"
+      lmnt.class.to_s == 'Watir::Select' ?  lmnt.pick!(var) :  lmnt.fit(var)
     end
   end
 
@@ -148,16 +144,16 @@ module DataFactory
   # 1) Retrieve and store the select list's value
   # 2) Specify a custom value to select
   #
-  # Enter: #get_or_select!
+  # Enter: +#get_or_select!+
   #
   # Assuming you just want to store the default value, then your
   # Data Object's instance variable for the field will--initially--be
-  # nil. In that case, #get_or_select! will grab the select list's
+  # nil. In that case, +#get_or_select!+ will grab the select list's
   # current value and store it in your instance variable.
   #
   # On the other hand, if you want to update that field with your
   # custom value, then your instance variable will not be nil, so
-  # #get_or_select! will take that value and use it to update the
+  # +#get_or_select!+ will take that value and use it to update the
   # select list.
   #
   # Note that this method *only* works with select lists that take
@@ -172,7 +168,6 @@ module DataFactory
   # @param select_list [Watir::Select] The relevant select list element on the page
   #
   # @example
-  #
   #   get_or_select! :@num_resubmissions, page.num_resubmissions
   #
   def get_or_select!(inst_var_sym, select_list)
@@ -197,7 +192,6 @@ module DataFactory
   # of the instance variable.
   #
   # @example
-  #
   #   @open[:day] = get_or_select(@open[:day], page.open_day)
   #
   def get_or_select(hash_inst_var, select_list)

data/lib/test-factory/data_object.rb

@@ -0,0 +1,50 @@
+# Copyright 2012-2013 The rSmart Group, Inc.
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# The Superclass for all of your data objects.
+class DataObject
+
+  include Foundry
+  include DataFactory
+
+  # Since Data Objects are not "Marshallable", and they generally
+  # contain lots of types of data in their instance variables,
+  # we have this method. This will create and return a 'deep copy' of
+  # the data object as well as any and all nested data objects
+  # and collections it contains.
+  #
+  # Please note that this method will fail if you are putting
+  # Data Objects into Arrays or Hashes instead
+  # of into Collection classes
+  #
+  def data_object_copy
+    opts = {}
+    self.instance_variables.each do |var|
+      key = var.to_s.gsub('@','').to_sym
+      orig_val = instance_variable_get var
+      opts[key] = case
+                    when orig_val.kind_of?(CollectionsFactory)
+                      orig_val.copy
+                    when orig_val.instance_of?(Array) || orig_val.instance_of?(Hash)
+                      Marshal::load(Marshal.dump(orig_val))
+                    when orig_val.kind_of?(DataObject)
+                      orig_val.data_object_copy
+                    else
+                      orig_val
+                  end
+    end
+    self.class.new(@browser, opts)
+  end
+
+end

data/lib/test-factory/foundry.rb

@@ -32,9 +32,9 @@ module Foundry
   # @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
-    @current_page
+    current_page = page_class.new @browser, visit
+    block.call current_page if block
+    current_page
   end
   alias_method :on_page, :on
 

data/test-factory.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'test-factory'
-  s.version = '0.3.8'
+  s.version = '0.3.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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-factory
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.9
 platform: ruby
 authors:
 - Abraham Heward
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-23 00:00:00.000000000 Z
+date: 2013-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: watir-webdriver
@@ -38,6 +38,7 @@ files:
 - lib/test-factory/collections_factory.rb
 - lib/test-factory/core_ext.rb
 - lib/test-factory/data_factory.rb
+- lib/test-factory/data_object.rb
 - lib/test-factory/date_factory.rb
 - lib/test-factory/foundry.rb
 - lib/test-factory/gem_ext.rb