testcentricity_web 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e54ba7e42445d011bd7dea0f1b649cd321372fc
-  data.tar.gz: ad5c8500dc061fd7b2b05714050eee4af2864e9e
+  metadata.gz: f8114408f91a111679a8117c65384050040eacf8
+  data.tar.gz: 80bf1711744152b92dbe5394cf520431d1feca99
 SHA512:
-  metadata.gz: 9c521cefa82fb5f8c8c8f7ae0c8ce1059e229563d3d6c74c7ad77fd1ae40ca7f062299637c4f749ccf40aee4741d45ec6ab7292f3962f7952c18fba72874d03c
-  data.tar.gz: 81b34a198714f609103cee5f2643ead09b1efd008ed7180fd1f0c04373ef2d0804c77ef0c9c52e36a91476c83c46797e1f42c16a904816a5d1ea3f2a96c1d3c9
+  metadata.gz: fca8c04fa90c2d8122a5729ca1cb5e5f7afde04621f2afda77a2b0529169adfb655e8545999209bbc52c656c3418d894cee234bfe221cd216d45c7d8f8a8da78
+  data.tar.gz: 7e65e2d4cf450772d12f2b78583ba042f3f9449278b2680e2e02a694706721a61e231c49e10a319be49145bf174cc831d2674c9e64a4e5b326f2ec5ed9edc422

data/.gitignore

@@ -7,6 +7,8 @@ Thumbs.db
 .settings
 .project
 .idea/workspace.xml
+.idea/.rakeTasks
+*.iml
 
 doc/*
 .yardoc/*
@@ -15,5 +17,11 @@ coverage
 .bundle
 .ruby-version
 .ruby-gemset
+/my_templates
 
 Gemfile.lock
+
+
+.idea/testcentricity_web.iml
+
+.idea/.rakeTasks

data/LICENSE.txt

@@ -6,10 +6,10 @@ Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
 1. Redistributions of source code must retain the above copyright notice,
-this list of conditions and the following disclaimer.
+this list of conditions, and the following disclaimer.
 
 2. Redistributions in binary form must reproduce the above copyright
-notice, this list of conditions and the following disclaimer in the
+notice, this list of conditions, and the following disclaimer in the
 documentation and/or other materials provided with the distribution.
 
 3. Neither the name of the copyright holder nor the names of its contributors

data/README.md

@@ -1,10 +1,9 @@
-# TestcentricityWeb
+# TestCentricityWeb
 
-The TestCentricity™ core generic framework for desktop and responsive mobile web site testing implements a Page Object
-and Data Object Model DSL, for use with Capybara and selenium-webdriver. It supports testing against locally hosted
-desktop browsers (Firefox, Chrome, Safari, IE, or Edge), locally hosted emulated mobile browsers (using Firefox),
-"headless" (using Poltergeist), or on cloud hosted desktop or mobile web browsers using the BrowserStack, Sauce Labs,
-or CrossBrowserTesting services.
+The TestCentricity™ core generic framework for desktop and mobile web site testing implements a Page Object and Data Object Model DSL for
+use with Cucumber, Capybara, and selenium-webdriver. It supports testing against locally hosted desktop browsers (Firefox, Chrome, Safari,
+IE, or Edge), locally hosted emulated iOS and Android mobile browsers (using Firefox), a "headless" browser (using Poltergeist and PhantomJS),
+or on cloud hosted desktop or mobile web browsers using the BrowserStack, Sauce Labs, or CrossBrowserTesting services.
 
 
 ## Installation
@@ -43,8 +42,8 @@ If you are using RSpec instead, you need to require the following in your *env.r
     
 ###Selenium WebDriver
 
-If you choose to not connect to selenium-webdriver using the ***WebDriverConnect.initialize_web_driver*** method, or if you need to 
-directly call methods in selenium-webdriver, you will also need to require the following in your *env.rb* file:
+If you choose to not connect to selenium-webdriver using the ***WebDriverConnect.initialize_web_driver*** method, or if you need to directly
+call methods in selenium-webdriver, you will also need to require the following in your *env.rb* file:
 
     require 'selenium-webdriver'
 
@@ -52,9 +51,23 @@ directly call methods in selenium-webdriver, you will also need to require the f
 
 ##Usage
 
-###Defining a Page Object
+### Page Objects
 
-You define new **Page Objects** as shown below:
+The **Page Object Model** is a test automation pattern that aims to create an abstraction of your web app's User Interface that can be used
+in tests. A **Page Object** is an object that represents a single page in your AUT (Application Under Test). **Page Objects** encapsulate the
+implementation details of a web page and expose an API that supports interaction with, and validation of UI elements on the page.
+
+**Page Objects** makes it easier to maintain automated tests, because changes to page UI elements are only changed in one location - in the
+**Page Object** class definition. By adopting a **Page Object Model**, Cucumber Feature files and step definitions are no longer required to
+hold specific information about a page's UI objects, thus minimizing maintenance requirements. If any element on a page changes (URL path,
+text field attributes, button captions, etc.), maintenance is performed in the **Page Object** class definition only, typically with no need
+to update the affected feature file, scenarios, or step definitions.
+
+
+####Defining a Page Object
+
+Your **Page Object** class definitions should be contained within individual *.rb* files in the ***features/support/pages*** folder of your
+test automation project. You define new **Page Objects** as shown below:
 
     class LoginPage < TestCentricity::PageObject
       trait(:page_name)       { 'Login' }
@@ -70,9 +83,9 @@ You define new **Page Objects** as shown below:
     end
 
 
-###Adding UI Elements to your Page Object
+####Adding UI Elements to your Page Object
 
-Your Page Object's **UI Elements** are added as shown below:
+**UI Elements** are added to your **Page Object** class definition as shown below:
 
     class LoginPage < TestCentricity::PageObject
       trait(:page_name)       { 'Login' }
@@ -86,32 +99,20 @@ Your Page Object's **UI Elements** are added as shown below:
       checkbox  :remember_checkbox,    "rememberUser']"
       label     :error_message_label,  'div#statusBar.login-error'
     end
-
-
-###Instantiating your Page Objects
-
-There are several ways to instantiate your **Page Objects**. One common implementation is shown below:
-
-    module WorldPages
-      def login_page
-        @login_page ||= LoginPage.new
-      end
     
-      def home_page
-        @home_page ||= HomePage.new
-      end
-    end
-
-Once instantiated, you can interact with the **UI Elements** in your **Page Objects**. An example is shown below:
+Once your **Page Objects** have been instantiated, you can interact with the **UI Elements** in your **Page Objects**. An example is shown
+below:
 
     login_page.user_id_field.set('snicklefritz')
     login_page.password_field.set('Pa55w0rd')
     login_page.login_button.click
 
 
-###Adding Methods to your Page Object
+####Adding Methods to your Page Object
 
-You can add high level methods for interacting with the UI to hide implementation details, as shown below:
+It is good practice for your Cucumber step definitions to call high level methods in your your **Page Object** instead of directly accessing
+and interacting with a page object's UI elements. You can add high level methods to your **Page Object** class definition for interacting with
+the UI to hide implementation details, as shown below:
 
     class LoginPage < TestCentricity::PageObject
       trait(:page_name)       { 'Login' }
@@ -144,18 +145,28 @@ Once your **Page Objects** have been instantiated, you can call your methods as
     
 
 
-###Defining a PageSection Object
+### PageSection Objects
+
+A **PageSection Object** is a collection of **UI Elements** that may appear in multiple locations on a page, or on multiple pages in a web
+app. It is a collection of **UI Elements** that represent a conceptual area of functionality, like a navigation bar, a search capability,
+or a menu. **UI Elements** and functional behavior are confined to the scope of a **PageSection Object**.
+
+A **PageSection Object** may contain other **PageSection Objects**.
+
 
-You define new **PageSection Objects** as shown below:
+####Defining a PageSection Object
+
+Your **PageSection** class definitions should be contained within individual *.rb* files in the ***features/support/sections*** folder of
+your test automation project. You define new **PageSection Objects** as shown below:
 
     class SearchForm < TestCentricity::PageSection
       trait(:section_locator)    { "//form[@id='gnav-search']" }
     end
 
 
-###Adding UI Elements to your PageSection Object
+####Adding UI Elements to your PageSection Object
 
-Your PageSection Object's **UI Elements** are added as shown below:
+**UI Elements** are added to your **PageSection** class definition as shown below:
 
     class SearchForm < TestCentricity::PageSection
       trait(:section_locator)    { "//form[@id='gnav-search']" }
@@ -166,9 +177,9 @@ Your PageSection Object's **UI Elements** are added as shown below:
     end
 
 
-###Adding Methods to your PageSection Object
+####Adding Methods to your PageSection Object
 
-You can add high level methods to your PageSection Objects, as shown below:
+You can add high level methods to your **PageSection** class definition, as shown below:
 
     class SearchForm < TestCentricity::PageSection
       trait(:section_locator)    { "//form[@id='gnav-search']" }
@@ -184,9 +195,9 @@ You can add high level methods to your PageSection Objects, as shown below:
     end
 
 
-###Adding PageSection Objects to your Page Object
+####Adding PageSection Objects to your Page Object
 
-Your Page Object's **PageSection Objects** are added as shown below:
+You add a **PageSection Object** to its associated **Page Object** as shown below:
 
     class HomePage < TestCentricity::PageObject
       trait(:page_name)       { 'Home' }
@@ -203,9 +214,76 @@ Once your **Page Object** has been instantiated, you can call its **PageSection*
     
     
 
+###Instantiating your Page Objects
+
+Before you can call the methods in your **Page Objects** and **PageSection Objects**, you must instantiate the **Page Objects** of your
+web application, as well as create instance variables which can be used when calling a **Page Objects** methods from your step definitions.
+There are several ways to instantiate your **Page Objects**.
+
+One common implementation is shown below:
+
+    module WorldPages
+      def login_page
+        @login_page ||= LoginPage.new
+      end
+    
+      def home_page
+        @home_page ||= HomePage.new
+      end
+    
+      def registration_page
+        @registration_page ||= RegistrationPage.new
+      end
+    end
+        
+    World(WorldPages)
+
+The **WorldPages** module above can be defined in your *env.rb* file, or you can define it in a separate *world_pages.rb* file in the
+***features/support*** folder.
+
+While this approach is effective for small web applications with only a few pages (and hence few **Page Objects**), it quickly becomes
+cumbersome to manage if your web application has dozens of **Page Objects** that need to be instantiated and managed.
+
+####Using the PageManager
+
+The **PageManager** class provides methods for supporting the instantiation and management of **Page Objects**. In the code example below,
+the **page_objects** method contains a hash table of your **Page Object** instance variables and their associated **Page Object** classes
+to be instantiated by **PageManager**:
+    
+    module WorldPages
+      def page_objects
+        { :login_page                 => LoginPage,
+          :home_page                  => HomePage,
+          :registration_page          => RegistrationPage,
+          :products_grid_page         => ProductsCollectionPage,
+          :product_detail_page        => ProductDetailPage,
+          :shopping_basket_page       => ShoppingBasketPage,
+          :payment_method_page        => PaymentMethodPage,
+          :confirm_purchase_page      => PurchaseConfirmationPage,
+          :my_account_page            => MyAccountPage,
+          :my_order_history_page      => MyOrderHistoryPage,
+          :my_ship_to_addresses_page  => MyShipToAddressesPage
+        }
+      end
+    end
+    
+    World(WorldPages)
+    
+The **WorldPages** module above should be defined in the *world_pages.rb* file in the ***features/support*** folder.
+
+Include the code below in your *env.rb* file to ensure that your **Page Objects** are instantiated before your Cucumber scenarios are
+executed:
+    
+    include WorldPages
+    WorldPages.instantiate_page_objects
+    
+
+
+
+
 ## Copyright and License
 
-TestCentricity(tm) Framework is Copyright (c) 2014-2016, Tony Mrozinski.
+TestCentricity™ Framework is Copyright (c) 2014-2016, Tony Mrozinski.
 All rights reserved.
 
 

data/lib/testcentricity_web.rb

@@ -1,5 +1,4 @@
 require 'capybara/cucumber'
-require 'rspec/expectations'
 require 'test/unit'
 require 'capybara/poltergeist'
 require 'testcentricity_web/world_extensions'
@@ -32,23 +31,37 @@ module TestCentricity
       end
     end
 
+    # Have all PageObjects been registered?
+    #
+    # @return [Boolean] true if all PageObjects have been registered
+    # @example
+    #   TestCentricity::PageManager.loaded?
+    #
     def self.loaded?
       not @page_objects.empty?
     end
 
-    def self.pages
-      @page_objects
-    end
-
     def self.find_page(page_name)
       (page_name.is_a? String) ? page_id = page_name.gsub(/\s+/, "").downcase.to_sym : page_id = page_name
       @page_objects[page_id]
     end
 
+    # Get the currently active PageObject
+    #
+    # @return [PageObject]
+    # @example
+    #   active_page = TestCentricity::PageManager.current_page
+    #
     def self.current_page
       @current_page
     end
 
+    # Sets the currently active PageObject
+    #
+    # @param page [PageObject] Reference to the active PageObject
+    # @example
+    #   TestCentricity::PageManager.set_current_page(product_search_page)
+    #
     def self.set_current_page(page)
       @current_page = page
     end
@@ -62,12 +75,14 @@ module TestCentricity
       @data_objects[data_type] = data_class unless @data_objects.has_key?(data_type)
     end
 
+    # Have all DataObjects been registered?
+    #
+    # @return [Boolean] true if all DataObjects have been registered
+    # @example
+    #   TestCentricity::DataManager.loaded?
+    #
     def self.loaded?
       not @data_objects.empty?
     end
-
-    def self.data_objects
-      @data_objects
-    end
   end
 end

data/lib/testcentricity_web/page_objects_helper.rb

@@ -4,7 +4,6 @@ module TestCentricity
   class PageObject
     include Capybara::DSL
     include Capybara::Node::Matchers
-    include RSpec::Matchers
     include Test::Unit::Assertions
 
     # Define a trait for this page object.

data/lib/testcentricity_web/page_sections_helper.rb

@@ -4,7 +4,6 @@ module TestCentricity
   class PageSection
     include Capybara::DSL
     include Capybara::Node::Matchers
-    include RSpec::Matchers
     include Test::Unit::Assertions
 
     attr_reader   :locator, :context

data/lib/testcentricity_web/version.rb

@@ -1,3 +1,3 @@
 module TestCentricityWeb
-  VERSION = '0.5.6'
+  VERSION = '0.5.7'
 end

data/testcentricity_web.gemspec

@@ -12,10 +12,11 @@ Gem::Specification.new do |spec|
   spec.email         = ['test_automation@icloud.com']
   spec.summary       = %q{A Page Object and Data Object Model Framework for desktop and responsive mobile web testing}
   spec.description = %q{
-    TestCentricity™ core generic framework for desktop and responsive mobile web site testing implements a Page Object
-    Model DSL, for use with Capybara and selenium-webdriver. Supports testing against locally hosted desktop browsers
-    (Firefox, Chrome, Safari, IE, or Edge), locally hosted emulated mobile browsers (using Firefox), "headless" (using
-    Poltergeist), or on cloud hosted browsers using the BrowserStack, Sauce Labs, or CrossBrowserTesting services.}
+    TestCentricity™ core generic framework for desktop and mobile web site testing implements a Page Object Model DSL,
+    for use with Cucumber, Capybara, and selenium-webdriver. Supports testing against locally hosted desktop browsers
+    (Firefox, Chrome, Safari, IE, or Edge), locally hosted emulated iOS and Android mobile browsers (using Firefox), a
+    "headless" browser (using Poltergeist and PhantomJS), or on cloud hosted browsers using the BrowserStack, Sauce Labs,
+    or CrossBrowserTesting services.}
   spec.homepage      = ''
   spec.license       = 'BSD3'
 
@@ -28,8 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
 
   spec.add_dependency 'capybara', ['>= 2.1', '< 3.0']
-  spec.add_dependency 'rspec-expectations'
-  spec.add_dependency 'rspec'
   spec.add_dependency 'test-unit'
   spec.add_dependency 'poltergeist'
   spec.add_dependency 'selenium-webdriver', '>= 2.50.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testcentricity_web
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - A.J. Mrozinski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-17 00:00:00.000000000 Z
+date: 2016-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,34 +58,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-expectations
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -172,10 +144,11 @@ dependencies:
         version: 1.1.1
 description: |2-
 
-      TestCentricity™ core generic framework for desktop and responsive mobile web site testing implements a Page Object
-      Model DSL, for use with Capybara and selenium-webdriver. Supports testing against locally hosted desktop browsers
-      (Firefox, Chrome, Safari, IE, or Edge), locally hosted emulated mobile browsers (using Firefox), "headless" (using
-      Poltergeist), or on cloud hosted browsers using the BrowserStack, Sauce Labs, or CrossBrowserTesting services.
+      TestCentricity™ core generic framework for desktop and mobile web site testing implements a Page Object Model DSL,
+      for use with Cucumber, Capybara, and selenium-webdriver. Supports testing against locally hosted desktop browsers
+      (Firefox, Chrome, Safari, IE, or Edge), locally hosted emulated iOS and Android mobile browsers (using Firefox), a
+      "headless" browser (using Poltergeist and PhantomJS), or on cloud hosted browsers using the BrowserStack, Sauce Labs,
+      or CrossBrowserTesting services.
 email:
 - test_automation@icloud.com
 executables: []
@@ -184,11 +157,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".idea/.name"
-- ".idea/.rakeTasks"
 - ".idea/encodings.xml"
 - ".idea/misc.xml"
 - ".idea/modules.xml"
-- ".idea/testcentricity_web.iml"
 - ".idea/vcs.xml"
 - Gemfile
 - LICENSE.txt