parfait 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42406d24ef33024391424ff2dbe5662cf0890351
-  data.tar.gz: edb42479dfe0f87dfd5239215fbb9090ffef65c5
+  metadata.gz: 6ff8e6fb73203bae5fb8b29221e8036e767d6756
+  data.tar.gz: 5d6768bc076105db4c642d6cbc3fc8324226a4cb
 SHA512:
-  metadata.gz: b6fc62cca06729ab2c63b748092dbf6f4425bee63f05372fc80df8950b271e53ca034d9cce64be1602ebcaf8e0a1367bfa798e33f19556de598aea728901ef42
-  data.tar.gz: 3b027546091718d787475eca2b63ba772d55cdab4c4c8b1a8b02b13f0a3412000ffa6601ed7ea3020af7c3c325971520f66c6d6a62b0e2fee2e275a58e48b222
+  metadata.gz: a01841f001507aa28b88ddfccc9354fa39c6e83b6a9b5b9388622dde4f70b100b7c9a74a6e3e2df3bf401872798c03fde690d423ad63e18ede57b2c02c36ce4c
+  data.tar.gz: 19bf23e43506aeade6863e1fc0b50047a25e92baa2c772be9bff8100f6acf2efae4b74491cff3c440cb2b621df57321bb5cbf031382bf0b64915dee5710605d3

data/lib/parfait/application.rb

@@ -34,6 +34,7 @@ module Parfait
 
       @pages = Hash.new
       @@all[@name] = self
+      super
     end
 
 
@@ -142,9 +143,7 @@ module Parfait
       page = @pages[requested_name] 
       if 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
+        verify_presence "Cannot navigate to page \"#{requested_name}\" because application presence check failed"
 
         # Pass the browser through to any subsequently called methods
         Thread.current[:parfait_region] = Thread.current[:parfait_browser]

data/lib/parfait/artifact.rb

@@ -22,11 +22,14 @@ module Parfait
     #
     # *Options*
     #
-    # +option+:: specifies something
+    # +block+:: specifies the code block to be executed as the check method. This block should return true or false.
     #
     # *Example*
     #
-    #   $$$ Need an example $$$
+    #   sample_page.add_check {
+    #     Parfait::browser.h1(:text => "Parfait Example Page").present?
+    #   }
+    #
     def add_check(&block)
       @check_method = block
       add_generic_present() unless @present_method 
@@ -37,11 +40,12 @@ module Parfait
     #
     # *Options*
     #
-    # This method does not take any parameters.
+    # This method takes a hash of parameters, as defined by the +check+ code block
     #
     # *Example*
     #
-    #   $$$ Need an example $$$
+    #   myapp.page("My Page").check
+    #
     def check(opts = {})
       @check_method.call(opts)
     end
@@ -51,11 +55,16 @@ module Parfait
     #
     # *Options*
     #
-    # +option+:: specifies something
+    # +block+:: specifies the code block to be executed as the present method. This block should return true or false.
+    #
+    # For consistency, it is recommended that the check method be defined with +add_check+, which will set up the present directive automatically.
     #
     # *Example*
     #
-    #   $$$ Need an example $$$
+    #   sample_page.add_present {
+    #     Parfait::browser.h1(:text => "Parfait Example Page").present?
+    #   }
+    #
     def add_present(&block)
       @present_method = block
     end
@@ -65,27 +74,27 @@ module Parfait
     #
     # *Options*
     #
-    # This method does not take any parameters.
+    # This method takes a hash of parameters, as defined by the +present+ code block
     #
     # *Example*
     #
-    #   $$$ Need an example $$$
+    #   myapp.page("My Page").check
+    #
     def present(opts = {})
       @present_method.call(opts)
     end
 
 
-    # Method description
-    #
-    # Depends on check
+    # Define the secondary +present+ directive based on the user-defined primary +check+ directive
     #
     # *Options*
     #
-    # +option+:: specifies something
+    # None
     #
     # *Example*
     #
-    #   $$$ Need an example $$$
+    #   No example provided - this will be called under the covers when a +check+ directive is defined
+    #
     def add_generic_present()
       add_present { |opts|
         check(opts)
@@ -95,15 +104,14 @@ module Parfait
 
     # Is the present method defined for this Artifact?
     #
-    # Depends on check
-    #
     # *Options*
     #
     # This method takes no parameters
     #
     # *Example*
     #
-    #   $$$ Need an example $$$
+    #   myapp.page("My Page").is_present_defined?
+    #
     def is_present_defined?()
       if @present_method
         return true
@@ -112,6 +120,31 @@ module Parfait
       end
     end
 
+
+    # Verify the presence of this Artifact
+    #
+    # Raises an exception with the specified check if this artifact is not present
+    #
+    # *Options*
+    #
+    # +error_string+:: specifies the string to display if the check fails
+    #
+    # *Example*
+    #
+    #   class Control
+    #     def get(opts = {})
+    #       verify_presence "Cannot call get directive because presence check for control \"#{@name}\" failed"
+    #       return @get_method.call(opts)
+    #     end
+    #   end
+    def verify_presence(error_string)
+      if is_present_defined?
+        unless present()
+          raise error_string
+        end
+      end
+    end
+
   end
 end
 

data/lib/parfait/control.rb

@@ -60,6 +60,7 @@ module Parfait
           raise "Parfait::Control requires each alias in the array to be a string" unless my_alias.is_a?(String)
         end
       end
+      super
     end
 
 
@@ -139,9 +140,7 @@ module Parfait
     #
     #   $$$ 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
+      verify_presence "Cannot call \"#{directive_name}\" directive because presence check for control \"#{@name}\" failed"
     end
 
 

data/lib/parfait/page.rb

@@ -40,6 +40,7 @@ module Parfait
       @controls = Hash.new
       @regions = Hash.new
       @page_test = nil
+      super
     end
 
   
@@ -132,9 +133,7 @@ module Parfait
       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
+        verify_presence "Cannot navigate to region \"#{opts.first[0]}\" because page presence check failed"
 
         # Apply the filter method
         region.filter(opts.first[1])
@@ -258,9 +257,7 @@ module Parfait
       if control
 
         # 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
+        verify_presence "Cannot navigate to control \"#{requested_name}\" because page presence check failed"
 
         return control
       else

data/lib/parfait/region.rb

@@ -43,7 +43,7 @@ module Parfait
     #   )
     #   
     def initialize(opts = {})
-    o = {
+      o = {
         :name => nil,
         :aliases => []
       }.merge(opts)
@@ -68,6 +68,7 @@ module Parfait
           raise "Parfait::Region requires each alias in the array to be a string" unless my_alias.is_a?(String)
         end
       end
+      super
     end
 
 
@@ -251,9 +252,7 @@ module Parfait
       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
+        verify_presence "Cannot navigate to region \"#{opts.first[0]}\" because region presence check failed"
 
         # Apply the filter method
         region.filter(opts.first[1])
@@ -319,9 +318,7 @@ module Parfait
       control = @controls[requested_name] 
       if control
         # 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
+        verify_presence "Cannot navigate to control \"#{requested_name}\" because region presence check failed"
 
 
         return control

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parfait
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Jeremy Rotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-20 00:00:00.000000000 Z
+date: 2016-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest