test-factory 0.4.3 → 0.4.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDg0Nzk0MDdiOGIyMDAzNjlmMTA1NTUxYTlhN2ViMTViNDRjODMzOQ==
+    Y2IzNTk5NjIwMTI3ZDRiMzcyZmE1MDcxZDg1MTVjODZjMWRmODRkYQ==
   data.tar.gz: !binary |-
-    YWU1ZTk0YmJlMmVkMzU1MzIwNTVlNzMzNDJhOWFiYjE0ZTQ5OTkwMQ==
+    NDM0ZTRlYmI0ZmI5NDAzYTk0YWViMmM3NWE5NTk0MGQzY2I3YzFmOQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OWI1NTgxMmZkOWU5OTMyNWY5N2I0YjQ5Y2RkZTNlMWMzOTQwOTI2NmY3YjYz
-    OGQzMTU2NzJhMjdkN2U4NTJiMmZiMmMxNTY0MjVmYWFiZmNlZjIzNGY1MGJk
-    MDMwZmVlM2M1NWE3NmYwY2M5Yjk0ODNkMWQ4MzI1ZjZmYTdjMGU=
+    ZmE2NDVmMGY4NTAzZWIzMTFhZjZlN2FlNWQxNTUwOTJhMzU2YjJkOGQ2NTk4
+    ZGYwMDE0NTg0ZjBhZDBkNGU0MTdlYWM3NDBlNGU1NGJjZjNhYTNhY2NhNGNm
+    YzY5OGEyZjg2ODU2OTExZWZhODRhYzM5NDFlODVlMWZjYWE3ODY=
   data.tar.gz: !binary |-
-    ZWU4N2NjYTQzOGM0NDA4MTU4YTBiOWRlZmE1OWQ2NTE3NjgyODg5YTg0MDcx
-    ZDIwYWQ5ZDgxNjFiZjlhZDkyZjkyMzNhMTdmYTU0ZmE1NjcyNzhlOTJmYTdi
-    NThjN2QzZjEwYmQ3ZTZmMzdhMDgwNWExODQ4NDFkMzM0ZjRmMGM=
+    MjI4ODUxNDcwZWE5YjJjZjllN2ZmYzAzOGUyZjk3NTIxMWRlOTA2ZDNhOGEy
+    OGE3YTYxMjM0MTVkNTVmM2RlYjhhMTQyYjI0ZmFjMzc0MDY3ZDY4NzcwNWUz
+    NGUwZGFmZTMyODBhODE3MzllZTc5ZWM2NDQwMzRkMTA5NWI4ODQ=

data/lib/test-factory/collections_factory.rb

@@ -1,4 +1,4 @@
-# Copyright 2012-2013 The rSmart Group, Inc.
+# Copyright 2012-2014 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.
@@ -51,6 +51,16 @@ class CollectionsFactory < Array
     new_collection
   end
 
+  # Used in conjunction with the Parent object containing
+  # the collection.
+  #
+  # The parent sends updated information to the collection(s)
+  # using #notify_collections
+  #
+  def notify_members *updates
+    self.each { |member| member.update_from_parent *updates }
+  end
+
 end
 
 # Just an alias class name.

data/lib/test-factory/core_ext.rb

@@ -1,4 +1,4 @@
-# Copyright 2012-2013 The rSmart Group, Inc.
+# Copyright 2012-2014 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.

data/lib/test-factory/data_factory.rb

@@ -1,4 +1,4 @@
-# Copyright 2012-2013 The rSmart Group, Inc.
+# Copyright 2012-2014 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.
@@ -12,16 +12,58 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Provides a set of tools used to create your Data Object classes.
-module DataFactory
+# The Superclass for all of your data objects.
+class DataFactory
+
+  include Foundry
+
+  # 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)
+                      begin
+                        Marshal::load(Marshal.dump(orig_val))
+                      rescue TypeError
+                        raise %{\nKey: #{key.inspect}\nValue: #{orig_val.inspect}\nClass: #{orig_val.class}\n\nThe copying of the Data Object has thrown a TypeError,\nwhich means the object detailed above is not "Marshallable".\nThe most likely cause is that you have put\na Data Object inside an\nArray or Hash.\nIf possible, put the Data Object into a Collection.\n\n}
+                      end
+                    when orig_val.kind_of?(DataFactory)
+                      orig_val.data_object_copy
+                    else
+                      orig_val
+                  end
+    end
+    self.class.new(@browser, opts)
+  end
 
   # Add this to the bottom of your Data Object's initialize method.
-  # Converts the contents of the hash into the class's instance variables.
+  # This method does 2 things:
+  # 1) Converts the contents of the hash into the class's instance variables.
+  # 2) Grabs the names of your collection class instance variables and stores
+  #    them in an Array. This is to allow for the data object class to send
+  #    any needed updates to its children. See #notify_coolections for more
+  #    details.
   # @param hash [Hash] Contains all options required for creating the needed Data Object
   #
   def set_options(hash)
+    @collections = []
     hash.each do |key, value|
       instance_variable_set("@#{key}", value)
+      @collections << key if value.kind_of?(CollectionsFactory)
     end
   end
   alias update_options set_options
@@ -253,6 +295,20 @@ module DataFactory
     end
   end
 
+  # Define this method in your data object when
+  # it has a parent, and that parent
+  # may periodically need to send
+  # it updated information about itself.
+  #
+  def update_from_parent(update)
+    raise %{
+    This method must be implemented in your data object
+    class if you plan to pass updates from a
+    parent object to the members of its
+    collections.
+           }
+  end
+
   # =======
   private
   # =======
@@ -274,4 +330,33 @@ module DataFactory
     end
   end
 
+  # Use this method in conjunction with your nested
+  # collection classes. The collections will notify
+  # their members about the passed parameters.
+  #
+  # Note: You must write a custom #update_from_parent
+  # method in your data object that will know what to
+  # do with the parameter(s) passed to it.
+  #
+  def notify_collections *updates
+    @collections.each {|coll| instance_variable_get("@#{coll}").notify_members *updates }
+  end
+
+end
+
+# An alias, for backwards compatibility...
+class DataObject < DataFactory
+
+  warn %{
+         Welcome to version 0.4.5!
+
+         Please update all your Data Object classes to
+         inherit from DataFactory
+         instead of DataObject.
+
+         Note that in the future this warning will be going
+         away. You'll just get an error, so
+         be sure you update your project soon!
+  }
+
 end

data/lib/test-factory/date_factory.rb

@@ -1,4 +1,4 @@
-# Copyright 2012-2013 The rSmart Group, Inc.
+# Copyright 2012-2014 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.

data/lib/test-factory/foundry.rb

@@ -1,4 +1,4 @@
-# Copyright 2012-2013 The rSmart Group, Inc.
+# Copyright 2012-2014 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.

data/lib/test-factory/gem_ext.rb

@@ -1,4 +1,4 @@
-# Copyright 2012-2013 The rSmart Group, Inc.
+# Copyright 2012-2014 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.

data/lib/test-factory/page_factory.rb

@@ -1,4 +1,4 @@
-# Copyright 2012-2013 The rSmart Group, Inc.
+# Copyright 2012-2014 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.

data/lib/test-factory/string_factory.rb

@@ -1,6 +1,6 @@
 # coding: UTF-8
 
-# Copyright 2012-2013 The rSmart Group, Inc.
+# Copyright 2012-2014 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.
@@ -20,7 +20,8 @@ module StringFactory
   # A random string creator that draws from all printable ASCII characters
   # from 33 to 128. Default length is 10 characters.
   # @param length [Integer] The count of characters in the string
-  # @param s [String] Typically this will be left blank, but if included, any string created will be prepended with s. Note that the string length will still be as specified
+  # @param s [String] Typically this will be left blank, but if included, any string created will be prepended with s. Note that the string length will
+  # be longer by the size of the pre-pended string.
   #
   def random_string(length=10, s="")
     length.enum_for(:times).inject(s) { s << rand(93) + 33 }
@@ -29,7 +30,8 @@ module StringFactory
   # A random string creator that draws from all printable ASCII and High ASCII characters
   # from 33 to 256. Default length is 10 characters.
   # @param length [Integer] The count of characters in the string
-  # @param s [String] Typically this will be left blank, but if included, any string created will be prepended with s. Note that the string length will still be as specified
+  # @param s [String] Typically this will be left blank, but if included, any string created will be prepended with s. Note that the string length will be
+  # longer by the length of the pre-pended string.
   #
   def random_high_ascii(length=10, s="")
     length.enum_for(:times).inject(s) { s << rand(223) + 33 }

data/lib/test-factory.rb

@@ -1,4 +1,4 @@
-# Copyright 2012-2013 The rSmart Group, Inc.
+# Copyright 2012-2014 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.

data/test-factory.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'test-factory'
-  s.version = '0.4.3'
+  s.version = '0.4.5'
   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.4.3
+  version: 0.4.5
 platform: ruby
 authors:
 - Abraham Heward
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-12 00:00:00.000000000 Z
+date: 2014-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: watir-webdriver
@@ -38,7 +38,6 @@ 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

data/lib/test-factory/data_object.rb

@@ -1,53 +0,0 @@
-# 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 DataObjectFactory
-
-  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
-
-# Empty alias class
-class DataObject < DataObjectFactory; end