parfait 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c35819f92d949b909c2178dacdff7caa9fe40c4
+  data.tar.gz: d8dceab268f4ab11dd69a518810ebd5c006b4659
+SHA512:
+  metadata.gz: 049efbccf79d1f8eea86d5206a431f2c78381c81f8f58f1fadfe4c9bc5f3ddec58ce84b7ad0a36a0afc4df6d56614abb6b0a01a9c3a4a8f6b9dcab7252074587
+  data.tar.gz: b4ced0aeac0417e23d60966408b74e5e1e18964371e20b9f46b98e9c5acb8914df2669afa752f90434aa86e8bfe02e11cb1a520c1a10ebf0e2c61bd864bac31b

data/lib/parfait/application.rb

@@ -0,0 +1,140 @@
+module Parfait
+
+  class Application
+  
+    # Define an application
+    #
+    # *Options*
+    #
+    # Takes a hash as input where the current options are:
+    # +name+:: specifies the name of the application
+    # - +:browser+ optionally specifies the browser object used in the current thread.  Storing this value will allow the browser object to be retrieved via +Parfait.browser+ invocation when defining +get+ and +set+ routines for controls.
+    #
+    # *Example*
+    #
+    #   mybrowser = Watir::Browser.new()
+    #   Parfait::Application.new(
+    #     :name => "Blog",
+    #     :browser => mybrowser
+    #   )
+    #
+    def initialize(opts = {})
+      o = {
+        :name => nil,
+        :browser => nil
+      }.merge(opts)
+
+      @name = o[:name]
+      raise "Application name must be specified" unless @name
+
+      set_browser(o[:browser])
+
+      @pages = Hash.new
+    end
+
+  
+    # Set the browser object for the current thread.  
+    #
+    # *Options*
+    #
+    # none
+    #
+    # *Example*
+    #
+    #   b = Watir::browser.new
+    #   myapplication.set_browser(b)
+    # 
+    def set_browser(browser)
+      Thread.current[:parfait_browser] = browser 
+      unless Thread.current[:parfait_browser] == nil or 
+             Thread.current[:parfait_browser].is_a?(Watir::Browser)
+        raise "Parfait browser parameter must be a Watir Browser object"
+      end
+    end
+
+  
+    # Get the browser object used by the current thread.  
+    #
+    # This will be particularly useful when defining directives for a Parfait::Control.
+    #
+    # *Options*
+    #
+    # none
+    #
+    # *Example*
+    #
+    #   mycontrol.add_get{ |opts|
+    #     Parfait::browser.text_field(:id => "body").when_present.value
+    #   }
+    def browser()
+      #If the browser is non-nil, then it passed validation in the configure method
+      unless Thread.current[:parfait_browser]
+        raise "Parfait: browser requested, but it is undefined"
+      end
+      Thread.current[:parfait_browser]
+    end
+
+  
+    # Add a page to this Application
+    #
+    # *Options*
+    #
+    # +page+:: specifies a Parfait::Page object
+    #
+    # *Example*
+    #
+    #   blog_posts = Parfait::Page.new(:name => "Blog Posts")
+    #   blogapp.add_page(blog_posts)
+    #
+    def add_page(page)
+
+      if page
+        if page.is_a?(Parfait::Page)
+          @pages[page.name] = page
+          if page.aliases
+            page.aliases.each do |my_alias|
+              @pages[my_alias] = page
+            end
+          end
+        else
+          raise "Page must be a Parfait::Page when being adding to an application"
+        end
+      else
+        raise "Page must be specified when adding a page to an application"
+      end
+      self
+    end
+
+
+    # Retrieve a page object by name or alias.
+    #
+    # Under the covers, if there is an existence directive defined for this
+    # page, it will be run on the current browser to confirm that we are 
+    # indeed on it.
+    #
+    # *Options*
+    #
+    # +name+:: specifies the name or alias of the page
+    #
+    # *Example*
+    #
+    #   myapp.page("Login Page")
+    def page(requested_name)
+      page = @pages[requested_name] 
+      if page
+        # Confirm that we are on the requested page
+
+        # Pass the browser through to any subsequently called methods
+        Thread.current[:parfait_region] = Thread.current[:parfait_browser]
+
+        return page
+      else
+        raise "Invalid page name requested: \"#{requested_name}\""
+      end
+    end
+      
+
+  
+  end
+
+end

data/lib/parfait/control.rb

@@ -0,0 +1,413 @@
+module Parfait
+
+  class Control
+  
+    attr_reader :name,
+      :aliases
+  
+    # Create a new control object
+    #
+    # *Options*
+    #
+    # +name+:: the name used to identify this control
+    # +logtext+:: the text to be used when referring to this control in logs
+    # +aliases+:: specifies an array of aliases for the control
+    #
+    # *Example*
+    #
+    #   newcontrol = Parfait::Control.new(
+    #     :name => "User ID",
+    #     :logtext = "user ID"
+    #   )
+    def initialize(opts = {})
+    o = {
+        :name => nil,
+        :logtext => nil,
+        :aliases => []
+      }.merge(opts)
+      @name = o[:name]
+      @aliases = o[:aliases]
+      @logtext = o[:logtext]
+
+      @set_method = nil
+      @get_method = nil
+      @update_method = nil
+      @retrieve_method = nil
+      @verify_method = nil
+      @confirm_method = nil
+      @goto_method = nil
+      @navigate_method = nil
+
+      if @name
+        unless @name.is_a?(String)
+          raise "Name must be a String when adding a control"
+        end
+      else
+        raise "Name must be specified when adding a control"
+      end
+      if @logtext
+        unless @logtext.is_a?(String)
+          raise "Logtext must be a String when adding a control"
+        end
+      else
+        raise "Logtext must be specified when adding a control" 
+      end
+      if @aliases
+        unless @aliases.is_a?(Array)
+          raise "Parfait::Control requires aliases to be an array"
+        end
+        @aliases.each do |my_alias|
+          raise "Parfait::Control requires each alias in the array to be a string" unless my_alias.is_a?(String)
+        end
+      end
+    end
+
+
+    # Method description
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def get(opts = {})
+      return @get_method.call(opts)
+    end
+
+  
+    # Set the value for this control
+    #
+    # *Options*
+    #
+    # +value+:: specifies the value that this control will be set to
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def set(value,opts = {})
+      @set_method.call(value,opts)
+    end
+
+  
+    # Method description
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def retrieve(opts = {})
+      return @retrieve_method.call(opts)
+    end
+
+  
+    # Method description
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def update(value,opts = {})
+      @update_method.call(value,opts)
+    end
+
+  
+    # Method description
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def confirm(value,opts = {})
+      return @confirm_method.call(value,opts)
+    end
+
+  
+    # Method description
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def verify(value,opts = {})
+      @verify_method.call(value,opts)
+    end
+ 
+ 
+    # Method description
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def goto(opts = {})
+      return @goto_method.call(opts)
+    end
+
+  
+    # Method description
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def navigate(opts = {})
+      return @navigate_method.call(opts)
+    end
+
+  
+    # Method description
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def add_get(&block)
+      @get_method = block
+  
+      add_generic_retrieve() unless @retrieve_method
+      add_generic_confirm() unless @confirm_method
+      add_generic_verify() unless @verify_method
+      if @set_method != nil
+        add_generic_update unless @update_method
+      end 
+    end
+
+  
+    # Method description
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def add_set(&block)
+      @set_method = block
+    
+      if @get_method != nil
+        add_generic_update() unless @update_method
+      end 
+    end
+
+  
+    # Method description
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def add_update(&block)
+      @update_method = block
+    end
+
+
+    # Method description
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def add_retrieve(&block)
+      @retrieve_method = block
+    end
+
+
+    # Method description
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def add_verify(&block)
+      @verify_method = block
+    end
+
+
+    # Method description
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def add_confirm(&block)
+      @confirm_method = block
+    end
+ 
+
+    # Method description
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def add_goto(&block)
+      @goto_method = block
+      add_generic_navigate() unless @navigate_method
+    end
+
+  
+    # Method description
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def add_navigate(&block)
+      @navigate_method = block
+    end
+
+
+    # Method description
+    #
+    # Depends on get, retrieve, set 
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def add_generic_update()
+      add_update { |value,opts|
+        new_value = value
+        found_value = retrieve()
+        if new_value == found_value
+          capital_text = @logtext
+          capital_text[0] = capital_text[0].capitalize
+          Parfait.log("#{capital_text} is already set to \"#{new_value}\"")
+        else
+          Parfait.log("Entering #{@logtext}: \"#{new_value}\" (was \"#{found_value}\")")
+          set(new_value,opts)
+        end
+      }
+    end
+
+  
+    # Method description
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def add_generic_retrieve()
+      add_retrieve { 
+        get()
+      }
+    end
+
+ 
+    # Method description
+    #
+    # Depends on get, retrieve 
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def add_generic_verify()
+      add_verify { |value,opts|
+        found_value = retrieve()
+        if value == found_value
+          Parfait.log("Verified #{@logtext} to be \"#{value}\"")
+        else
+          raise "Expected #{@logtext} to be \"#{value}\", but found \"#{found_value}\" instead"
+        end
+        true
+      }    
+    end
+ 
+ 
+    # Method description
+    #
+    # Depends on get, retrieve 
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def add_generic_confirm()
+      add_confirm { |value,opts|
+        retval = false
+        found_value = retrieve()
+        if value == found_value
+          retval = true
+        end
+        retval
+      }        
+    end
+ 
+ 
+    # Method description
+    #
+    # Depends on goto
+    #
+    # *Options*
+    #
+    # +option+:: specifies something
+    #
+    # *Example*
+    #
+    #   $$$ Need an example $$$
+    def add_generic_navigate()
+      add_navigate { |opts|
+        Parfait.log("Navigating to #{@logtext}")
+        goto(opts)
+      }
+    end
+
+  
+  end
+
+end