parfait 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 093767b0830d5bd17b0a1f3e67a646aec8f45a48
-  data.tar.gz: 66528f64042e6e9ccbe7a4ba5666a18f0a513506
+  metadata.gz: 42406d24ef33024391424ff2dbe5662cf0890351
+  data.tar.gz: edb42479dfe0f87dfd5239215fbb9090ffef65c5
 SHA512:
-  metadata.gz: 25a38de727f4bbe2a7ac4db1cb9c4663b82be2a6cecfdaab7ce260f122039f791816a15034839db4b1c1420e298ff9812fb60b633184a63db9c5c7f6089a4987
-  data.tar.gz: 187cfc2da14a076745c8d90905974e4518a014df37273b7e24057442fc6485cf8a7e3c313d4ac72b957d9c737370afec3d6955a5867cb8fb201fdcdd9f4cbf37
+  metadata.gz: b6fc62cca06729ab2c63b748092dbf6f4425bee63f05372fc80df8950b271e53ca034d9cce64be1602ebcaf8e0a1367bfa798e33f19556de598aea728901ef42
+  data.tar.gz: 3b027546091718d787475eca2b63ba772d55cdab4c4c8b1a8b02b13f0a3412000ffa6601ed7ea3020af7c3c325971520f66c6d6a62b0e2fee2e275a58e48b222

data/lib/parfait/application.rb

@@ -1,6 +1,6 @@
 module Parfait
 
-  class Application
+  class Application < ParfaitArtifact
  
     # List of all defined applications 
     @@all = Hash.new
@@ -141,7 +141,10 @@ module Parfait
     def page(requested_name)
       page = @pages[requested_name] 
       if page
-        # Confirm that we are on the requested page
+        # Confirm that we are in the requested application
+        if is_present_defined?
+          raise "Cannot navigate to page \"#{requested_name}\" because application presence check failed" unless present()
+        end
 
         # Pass the browser through to any subsequently called methods
         Thread.current[:parfait_region] = Thread.current[:parfait_browser]

data/lib/parfait/artifact.rb

@@ -0,0 +1,117 @@
+module Parfait
+
+  class ParfaitArtifact
+
+    # Constructor for the ParfaitArtifact.
+    #
+    # *Options*
+    #
+    # This method does not take any parameters.
+    #
+    # No example provided because this method will not be called explicitly.
+    # It will strictly be inherited by the Application, Page, Region, and
+    # Control classes.
+    #
+    def initialize(opts = {})
+      @check_method = nil
+      @present_method = nil
+    end
+
+
+    # Define the presence check method for a given ParfaitArtifact
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def add_check(&block)
+      @check_method = block
+      add_generic_present() unless @present_method 
+    end
+
+
+    # Check if the ParfaitArtifact is present
+    #
+    # *Options*
+    #
+    # This method does not take any parameters.
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def check(opts = {})
+      @check_method.call(opts)
+    end
+
+
+    # Define the present directive for a given ParfaitArtifact
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def add_present(&block)
+      @present_method = block
+    end
+
+
+    # Is the ParfaitArtifact present?
+    #
+    # *Options*
+    #
+    # This method does not take any parameters.
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def present(opts = {})
+      @present_method.call(opts)
+    end
+
+
+    # Method description
+    #
+    # Depends on check
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def add_generic_present()
+      add_present { |opts|
+        check(opts)
+      }
+    end
+
+
+    # Is the present method defined for this Artifact?
+    #
+    # Depends on check
+    #
+    # *Options*
+    #
+    # This method takes no parameters
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def is_present_defined?()
+      if @present_method
+        return true
+      else
+        return false
+      end
+    end
+
+  end
+end
+

data/lib/parfait/control.rb

@@ -1,6 +1,6 @@
 module Parfait
 
-  class Control
+  class Control < ParfaitArtifact
   
     attr_reader :name,
       :aliases
@@ -129,6 +129,22 @@ module Parfait
     end
 
 
+    # Method description
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def verify_control_presence(directive_name)
+      if is_present_defined?
+        raise "Cannot call \"#{directive_name}\" directive because presence check for control \"#{@name}\" failed" unless present()
+      end
+    end
+
+
     # Method description
     #
     # *Options*
@@ -139,6 +155,7 @@ module Parfait
     #
     #   $$$ Need an example $$$
     def get(opts = {})
+      verify_control_presence("get")
       return @get_method.call(opts)
     end
 
@@ -153,6 +170,7 @@ module Parfait
     #
     #   $$$ Need an example $$$
     def set(value,opts = {})
+      verify_control_presence("set")
       @set_method.call(value,opts)
     end
 
@@ -167,6 +185,7 @@ module Parfait
     #
     #   $$$ Need an example $$$
     def retrieve(opts = {})
+      verify_control_presence("retrieve")
       return @retrieve_method.call(opts)
     end
 
@@ -181,6 +200,7 @@ module Parfait
     #
     #   $$$ Need an example $$$
     def update(value,opts = {})
+      verify_control_presence("update")
       @update_method.call(value,opts)
     end
 
@@ -195,6 +215,7 @@ module Parfait
     #
     #   $$$ Need an example $$$
     def confirm(value,opts = {})
+      verify_control_presence("confirm")
       return @confirm_method.call(value,opts)
     end
 
@@ -209,6 +230,7 @@ module Parfait
     #
     #   $$$ Need an example $$$
     def verify(value,opts = {})
+      verify_control_presence("verify")
       @verify_method.call(value,opts)
     end
  
@@ -223,6 +245,7 @@ module Parfait
     #
     #   $$$ Need an example $$$
     def goto(opts = {})
+      verify_control_presence("goto")
       return @goto_method.call(opts)
     end
 
@@ -237,6 +260,7 @@ module Parfait
     #
     #   $$$ Need an example $$$
     def navigate(opts = {})
+      verify_control_presence("navigate")
       return @navigate_method.call(opts)
     end
 
@@ -402,8 +426,8 @@ module Parfait
     #
     #   $$$ Need an example $$$
     def add_generic_retrieve()
-      add_retrieve { 
-        get()
+      add_retrieve { |opts|
+        get(opts)
       }
     end
 

data/lib/parfait/page.rb

@@ -1,6 +1,6 @@
 module Parfait
 
-  class Page
+  class Page < ParfaitArtifact
 
     attr_reader :name,
       :aliases
@@ -130,12 +130,18 @@ module Parfait
     def region(opts = {})
       region = @regions[opts.first[0]] 
       if region
+
+        # Confirm that we are on the expected page
+        if is_present_defined?
+          raise "Cannot navigate to region \"#{opts.first[0]}\" because page presence check failed" unless present()
+        end
+
         # Apply the filter method
         region.filter(opts.first[1])
 
         return region
       else
-        raise "Invalid region name requested: \"#{requested_name}\""
+        raise "Invalid region name requested: \"#{opts.first[0]}\""
       end
     end
     
@@ -250,7 +256,11 @@ module Parfait
     def control(requested_name)
       control = @controls[requested_name] 
       if control
-        # Confirm that the requested control is present
+
+        # Confirm that we are on the expected page
+        if is_present_defined?
+          raise "Cannot navigate to control \"#{requested_name}\" because page presence check failed" unless present()
+        end
 
         return control
       else

data/lib/parfait/region.rb

@@ -1,6 +1,6 @@
 module Parfait
 
-  class Region
+  class Region < ParfaitArtifact
   
     attr_reader :name,
       :aliases
@@ -249,6 +249,12 @@ module Parfait
     def region(opts = {})
       region = @regions[opts.first[0]] 
       if region
+
+        # Confirm that we are in the expected region
+        if is_present_defined?
+          raise "Cannot navigate to region \"#{opts.first[0]}\" because region presence check failed" unless present()
+        end
+
         # Apply the filter method
         region.filter(opts.first[1])
 
@@ -312,7 +318,11 @@ module Parfait
     def control(requested_name)
       control = @controls[requested_name] 
       if control
-        # Confirm that the requested control is present
+        # Confirm that we are in the expected region
+        if is_present_defined?
+          raise "Cannot navigate to control \"#{requested_name}\" because region presence check failed" unless present()
+        end
+
 
         return control
       else

data/lib/parfait.rb

@@ -1,4 +1,5 @@
 require 'watir-webdriver'
+require 'parfait/artifact'
 require 'parfait/application'
 require 'parfait/page'
 require 'parfait/region'
@@ -16,7 +17,7 @@ module Parfait
   PAGES = Hash.new
 
 
-  # Configure the logging routine to be used by Parfait
+  # Configure the logging routine to be used by Parfait for this thread.
   #
   # The routine you store here can be invoked by Parfait.log
   #
@@ -51,294 +52,6 @@ module Parfait
   end
 
 
-  # Define a new page to Parfait
-  #
-  # *Options*
-  #
-  # +name+:: specifies the name of the page
-  # +aliases+:: is an array of aliases for the page
-  #
-  # Note that the type of these values does not matter as long as they are used consistently throughout.  All examples provided with Parfait use strings.
-  #
-  # *Example*
-  #
-  #   edit_user = Parfait.add_page(
-  #     :name => "Edit User",
-  #     :alias => "New User", "User New", "User Edit"
-  #   )
-  def Parfait.add_page(opts = {})
-    o = {
-      :name => :notspecified,
-      :aliases => :notspecified
-    }.merge(opts)
-    name = o[:name]
-    aliases = o[:aliases]
-    
-    new_page = Parfait::Page.new(name)
-      
-    Parfait::PAGES[name] = new_page
-    unless aliases == :notspecified
-      aliases.each { |an_alias|
-        Parfait::PAGES[an_alias] = new_page
-      }  
-    end
-    
-    return new_page
-  end
-
-  
-  # Retrieve a page object by name or alias
-  #
-  # Intended for internal use only
-  #
-  # *Options*
-  #
-  # +name+:: specifies the name or alias of the page
-  #
-  # *Example*
-  #
-  #   Parfait.get_page("User New")
-  def Parfait.get_page(name)
-    page_name = Parfait::PAGES[name] 
-    if page_name
-      return page_name
-    else
-      raise "Parfait::get_page called for invalid page name \"#{page_name}\""
-    end
-  end
-      
-
-  # Set the value for a specified control on a specified page
-  #
-  # Parfait.set is only intended to be invoked from page directive routines, like retrieve, update, confirm, and verify.  It does not invoke the logger.
-  #
-  # *Options*
-  #
-  # Parfait.set takes a hash as a parameter with the +:onpage+ key specifying the page to be manipulated.  Users can utilize additional keys as they wish.  A simple invocation of Parfait.set might contain an additional key matching the label of a control on that page and providing a value to set in that control.
-  #
-  # *Example*
-  #
-  #   Parfait.set(:onpage => "Login", :username => "enrico_palazzo")
-  def Parfait.set(opts = {})
-    o = {
-      :onpage => :nopage
-    }.merge(opts)
-
-    if o[:onpage] == :nopage
-      raise "Parfait::set must be called with \":onpage\" specified."
-    end
-
-    # Find the specified control and invoke its set method
-    action_taken = false
-    page = Parfait::get_page(o[:onpage])
-    opts.each { |label,value|
-      control = page.get_control(label)
-      unless control == nil
-        control.set(opts)
-        action_taken = true
-      end
-    }
-    unless action_taken
-      raise "No valid control was passed to Parfait::set"
-    end
-  end
-  
-  
-  # Retreive the value from a specified control on a specified page and return it
-  #
-  # *Options*
-  #
-  # The Parfait.retrieve directive takes a hash as a parameter with an +:onpage+ key specifying the current page.  The system-generated Parfait.retrieve directive will also take a +:data+ key specfying the control on that page from which data should be retrieved.  Users can override the system-generated directive and use any keys they wish. 
-  #
-  # The system-generated retrieve directive does not invoke the logger.
-  #
-  # *Example*
-  #
-  #   my_ssn = Parfait.retrieve(:onpage => "User Data", :data => :ssn)
-  def Parfait.retrieve(opts = {})
-    o = {
-      :onpage => :nopage
-    }.merge(opts)
-
-    if o[:onpage] == :nopage
-      raise "Parfait::retrieve must be called with \":onpage\" specified."
-    end
-
-    # Find the specified control and invoke its retrieve method
-    action_taken = false
-    page = Parfait::get_page(o[:onpage])
-    opts.each { |label,value|
-      if label == :data
-        control = page.get_control(value)
-        unless control == nil
-          return control.retrieve(opts)
-          action_taken = true
-        end
-      end
-    }
-    unless action_taken
-      raise "No valid control was passed to Parfait::retrieve"
-    end  
-  end
-
-  
-  # Update the value of a specified control on a specified page.  
-  #
-  # *Options*
-  #
-  # The Parfait.update directive takes a hash as a parameter with an +:onpage+ key specifying the current page.  The system-generated Parfait.update directive will also take a key matching the label of a control on that page and providing a value to set in that control.  Users can override the system-generated directive and use any keys they wish. 
-  #
-  # The system-generated update directive will log both the original value and the newly updated value.  It is assumed that users overriding the system-generated functionality will do the same.
-  #
-  # *Example*
-  #
-  #   Parfait.update(:onpage => "Configure Settings", :time_zone => "Eastern Time (US & Canada)")
-  def Parfait.update(opts = {})
-    o = {
-      :onpage => :nopage
-    }.merge(opts)
-
-    if o[:onpage] == :nopage
-      raise "Parfait::update must be called with \":onpage\" specified."
-    end
-
-    # Find the specified control and invoke its update method
-    retval = nil
-    action_taken = false
-    page = Parfait::get_page(o[:onpage])
-    opts.each { |label,value|
-      control = page.get_control(label)
-      unless control == nil
-        retval = control.update(opts)
-        action_taken = true
-      end
-    }  
-    unless action_taken
-      raise "No valid control was passed to Parfait::update"
-    end
-    retval
-  end
-    
-  
-  # Verify the value of a specified control on a specified page, returning +true+ if it matches the provided value and raising an exception if it does not.
-  #
-  # *Options*
-  #
-  # The Parfait.verify directive takes a hash as a parameter with an +:onpage+ key specifying the current page.  The system-generated Parfait.verify directive will also take a key matching the label of a control on that page and providing a value against which to verify the current value of that control.  Users can override the system-generated directive and use any keys they wish. 
-  #
-  # The system-generated verify directive will log the successfully verified value.  It is assumed that users overriding the system-generated functionality will do the same.
-  #
-  # *Example*
-  #
-  #   Parfait.verify(:onpage => "Edit User", :social_security_number => "123-45-6789")
-  def Parfait.verify(opts = {})
-    o = {
-      :onpage => :nopage
-    }.merge(opts)
-
-    if o[:onpage] == :nopage
-      raise "Parfait::verify must be called with \":onpage\" specified."
-    end
-
-    page = Parfait::get_page(o[:onpage])
-
-    if opts.size == 1 #If no other parameters were passed, run the page test
-      if page.page_test()
-        Parfait.log("Verified that browser is on page \"#{page.name}\"",:style => :h2)
-      else
-        raise  "Parfait expected browser to be on page #{page.name}, but it wasn\'t"
-      end
-    else
-      # Find the specified control and invoke its verify method
-      action_taken  = false
-      opts.each { |label,value|
-        control = page.get_control(label)
-        unless control == nil
-          control.verify(opts)
-          action_taken = true
-        end
-      }
-      unless action_taken
-        raise "No valid control was passed to Parfait::verify"
-      end  
-    end  
-    true
-  end
-
-  
-  # Confirm the value of a specified control on a specified page, returning +true+ if it matches the provided value and returning +false+ otherwise.
-  #
-  # *Options*
-  #
-  # The Parfait.confirm directive takes a hash as a parameter with an +:onpage+ key specifying the current page.  The system-generated Parfait.confirm directive will also take a key matching the label of a control on that page and providing a value against which to test the current value of that control.  Users can override the system-generated directive and use any keys they wish. 
-  #
-  # The system-generated confirm directive does not invoke the logger.
-  #
-  # *Example*
-  #
-  #   Parfait.confirm(:onpage => "Edit User", :gender => "female")
-  def Parfait.confirm(opts = {})
-    o = {
-      :onpage => :nopage
-    }.merge(opts)
-
-    if o[:onpage] == :nopage
-      raise "Parfait::confirm must be called with \":onpage\" specified."
-    end
-
-    page = Parfait::get_page(o[:onpage])
-
-    retval = false
-    if opts.size == 1 #If no other parameters were passed, run the page test
-      return page.page_test()
-    else
-      # Find the specified control and invoke its confirm method
-      action_taken = false
-      opts.each { |label,value|
-        control = page.get_control(label)
-        unless control == nil
-          retval = control.confirm(opts)
-          action_taken = true
-        end
-      }  
-      if action_taken
-        return retval
-      else
-        raise "No valid control was passed to Parfait::confirm"
-      end  
-    end
-  end
-
-
-  # Method description
-  #
-  # *Options*
-  #
-  # +option+:: specifies something
-  #
-  # *Example*
-  #
-  #   $$$ Need an example $$$
-  def Parfait.navigate(opts = {})
-    o = {
-      :onpage => :nopage,
-      :to => :nodestination
-    }.merge(opts)
-  
-    if o[:to] == :nodestination
-      raise "Parfait::navigate must be called with a destination (\":to\") specified."
-    end
-
-    if o[:onpage] == :nopage
-      #Only a target was specified
-      page = Parfait::get_page("All Pages")
-    else
-      page = Parfait::get_page(o[:onpage])
-    end
-    page.navigate(opts)
-  end
-
-
   # Set the browser object (for the current thread) for Parfait to use
   #
   # *Options*

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parfait
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Jeremy Rotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-08 00:00:00.000000000 Z
+date: 2015-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -33,6 +33,7 @@ extra_rdoc_files: []
 files:
 - lib/parfait.rb
 - lib/parfait/application.rb
+- lib/parfait/artifact.rb
 - lib/parfait/control.rb
 - lib/parfait/page.rb
 - lib/parfait/region.rb