gless 1.0.2 → 1.1.2

data/Changelog.txt

@@ -0,0 +1,3 @@
+- 1.1.0: 29 Jan 2013: By default, "element"s now ignore non-visible
+  elements on the page; use { :invisible => true } to get the old
+  behaviour.

data/examples/test_github/lib/pages/test_github/search_page.rb

@@ -3,8 +3,8 @@
 module TestGithub
   class SearchPage < TestGithub::BasePage
 
-    element :search_input  , :text_field , :class => 'text'  , :validator => true
-    element :search_button , :button     , :text => 'Search' , :validator => true
+    element :search_input  , :text_field , :class => 'search-page-input' , :validator => true
+    element :search_button , :button     , :text => 'Search'             , :validator => true
 
     url %r{^:base_url/search}
 

data/lib/gless/config.rb

@@ -44,7 +44,8 @@ module Gless
     end
 
     # Get an element from the configuration.  Takes an arbitrary
-    # number of arguments; each is taken to be a hash key.
+    # number of arguments; each is taken to be a hash key.  With no
+    # arguments, returns the whole configuration.
     #
     # @example
     #
@@ -53,11 +54,13 @@ module Gless
     # @return [Object] what's left after following each key; could be
     #   basically anything.
     def get( *args )
+      if args.empty?
+        return @config
+      end
+
       return get_sub_tree( @config, *args )
     end
 
-    # Merge arbitrary data back in to the configuration; used to
-    # overwrite values that were pulled out of files or whatever.
     def merge(hash)
       @config.merge!(hash)
     end

data/lib/gless/session.rb

@@ -105,24 +105,21 @@ module Gless
 
       log.debug "Session: check if we've changed pages: #{@browser.title}, #{@browser.url}, #{@previous_url}, #{@current_page}, #{@acceptable_pages}"
 
-      # Changed URL means we've changed pages.  Our current page no
-      # longer being in the acceptable pages list means we *should*
-      # have changed pages. So we check both.
-      if @browser.url == @previous_url && @acceptable_pages.member?( @current_page )
+      # Changed URL means we've changed pages, probably by surprise
+      # since desired page changes happen in Gless::WrapWatir#click
+      if @browser.url == @previous_url
         log.debug "Session: doesn't look like we've moved."
       else
-        # See if we're on one of the acceptable pages; wait until we
-        # are for "timeout" seconds.
+        # See if we're on one of the acceptable pages.  We do no
+        # significant waiting because Gless::WrapWatir#click should
+        # have handeled that.
         good_page=false
         new_page=nil
-        @timeout.times do
-          if @acceptable_pages.nil?
-            # If we haven't gone anywhere yet, anything is good
-            good_page = true
-            new_page = @pages[@current_page]
-            break
-          end
-
+        if @acceptable_pages.nil?
+          # If we haven't gone anywhere yet, anything is good
+          good_page = true
+          new_page = @pages[@current_page]
+        else
           @acceptable_pages.each do |page|
             log.debug "Session: Checking our current url, #{@browser.url}, for a match in #{page.name}: #{@pages[page].match_url(@browser.url)}"
             if @pages[page].match_url(@browser.url)
@@ -130,20 +127,19 @@ module Gless
               @current_page = page
               new_page = @pages[page]
               log.debug "Session: we seem to be on #{page.name} at #{@browser.url}"
-              break
             end
           end
-
-          if good_page
-            break
-          end
-          sleep 1
         end
 
         good_page.should be_true, "Current URL is #{@browser.url}, which doesn't match any of the acceptable pages: #{@acceptable_pages}"
 
-        log.debug "Session: checking for arrival at #{new_page.class.name}"
-        new_page.arrived?.should be_true
+        # While this is very thorough, it slows things down quite a
+        # bit, and should mostly be covered by
+        # Gless::WrapWatir#click ; leaving here in case we decide we
+        # need it later.
+        #
+        # log.debug "Session: checking for arrival at #{new_page.class.name}"
+        # new_page.arrived?.should be_true
 
         url=@browser.url
         log.debug "Session: refreshed browser URL: #{url}"
@@ -154,6 +150,8 @@ module Gless
         @previous_url = url
       end
 
+      # End of page checking code.
+
       cpage = @pages[@current_page]
 
       if m.inspect =~ /(password|login)/i or args.inspect =~ /(password|login)/i
@@ -264,15 +262,18 @@ module Gless
           sleep opts[:interval]
         end
       rescue Exception => e
-        self.log.debug "Session: long_wait: Had an exception #{e}"
+        self.log.warn "Session: long_wait: Had an exception #{e}"
         if self.get_config :global, :debug
           self.log.debug "Session: long_wait: Had an exception in debug mode: #{e.inspect}"
           self.log.debug "Session: long_wait: Had an exception in debug mode: #{e.message}"
           self.log.debug "Session: long_wait: Had an exception in debug mode: #{e.backtrace.join("\n")}"
 
-          self.log.debug "Session: long_wait: Had an exception, and you're in debug mode, so giving you a debugger."
+          self.log.debug "Session: long_wait: Had an exception, and you're in debug mode, so giving you a debugger.  Use 'continue' to proceed."
           debugger
         end
+
+        self.log.debug "Session: long_wait: Retrying after exception."
+        retry
       end
 
       return false
@@ -314,6 +315,97 @@ module Gless
       end
     end
 
+    # Does the heavy lifting of moving between pages when an element
+    # has a new page destination.  Mostly used by Gless::WrapWatir
+    #
+    # Note that this attempts to click on the button (or do whatever
+    # else the passed block does) many times in an attempt to get to
+    # the right page.  If multiple attempts are a problem, you
+    # should circumvent this method; {WrapWatir#click_once} exists
+    # for this purpose.
+    #
+    # @param [Class, Symbol, Array] newpage The page(s) that we
+    #   could be moving to; same idea as {acceptable_pages=}
+    #
+    # @yield A required Proc/code block that contains the action to
+    #   take to attempt to change pages (i.e. clicking on a button
+    #   or whatever).  May be run multiple times, as the whole point
+    #   here is to keep trying until it works.
+    #
+    # @return (Boolean, String) Returns both whether it managed to
+    #   get to the page in question and, if not, what sort of errors
+    #   were seen.
+    def change_pages click_destination
+      self.acceptable_pages = click_destination
+
+      log.debug "Session: change_pages: checking to see if we have changed pages: #{@browser.title}, #{@current_page}, #{@acceptable_pages}"
+
+      good_page = false
+      error_message = ''
+      new_page = nil
+
+      # See if we're on one of the acceptable pages; wait until we
+      # are for "timeout" seconds.
+      @timeout.times do
+        self.log.debug "Session: change_pages: yielding to passed block."
+        yield
+        self.log.debug "Session: change_pages: done yielding to passed block."
+
+        if @acceptable_pages.member?( @current_page )
+          good_page = true
+          break
+        else
+          if @acceptable_pages.nil?
+            # If we haven't gone anywhere yet, anything is good
+            log.debug "Session: change_pages: no acceptable pages, so accepting the current page."
+            good_page    = true
+            new_page = @pages[@current_page]
+            break
+          end
+
+          url=@browser.url
+          log.debug "Session: change_pages: refreshed browser URL: #{url}"
+
+          @acceptable_pages.each do |page|
+            log.debug "Session: change_pages: Checking our current url, #{url}, for a match in #{page.name}: #{@pages[page].match_url(url)}"
+            if @pages[page].match_url(url) and @pages[page].arrived? == true
+              good_page    = true
+              @current_page = page
+              new_page = @pages[page]
+              log.debug "Session: change_pages: we seem to be on #{page.name} at #{url}"
+            end
+          end
+
+          if not new_page.match_url(url)
+            good_page = false
+            error_message = "Current URL is #{url}, which doesn't match that expected for any of the acceptable pages: #{@acceptable_pages}"
+            next
+          end
+
+          log.debug "Session: change_pages: checking for arrival at #{new_page.class.name}"
+          if not new_page.arrived?
+            good_page = false
+            error_message = "The current page, at #{url}, doesn't have all of the elements for any of the acceptable pages: #{@acceptable_pages}"
+            next
+          end
+
+          if good_page == true
+            break
+          else
+            sleep 1
+          end
+        end
+      end
+
+      if good_page
+        log.info "Session: change_pages: We have successfully moved to page #{new_page.class.name}"
+
+        @previous_url = url
+      end
+
+      return good_page, error_message
+    end
+
   end
 
 end

data/lib/gless/wrap_watir.rb

@@ -18,10 +18,24 @@ module Gless
   # This shouldn't ever need to be used by a user; it's done
   # automatically by the +element+ class method.
   class Gless::WrapWatir
+    require 'rspec'
     include RSpec::Matchers
 
     # Sets up the wrapping.
     #
+    # As a special case, note that the selectors can include a :proc
+    # element, in which case this is taken to be a Proc that takes
+    # the browser as an argument.  This is used for cases where
+    # finding the element has to happen at runtime or is
+    # particularily complicated.  In this case the rest of the
+    # selectors should include notes the element for debugging
+    # purposes.  An example of such an element:
+    #
+    #    Gless::WrapWatir.new(@browser, @session, :input, { :custom => "the first input under the div for tab #{tab} with the id 'task_name'", :proc => Proc.new { |browser| browser.div( :id  => "tabs-#{tab}" ).input( :id => 'task_name' ) } }, false )
+    #
+    # The wrapper only considers *visible* matching elements, unless
+    # the selectors include ":invisible => true".
+    #
     # @param [Gless::Browser] browser
     # @param [Gless::Session] session
     # @param [Symbol] orig_type The type of the element; normally
@@ -42,34 +56,139 @@ module Gless
       @session = session
       @orig_type = orig_type
       @orig_selector_args = orig_selector_args
-      @elem = @browser.send(@orig_type, @orig_selector_args)
       @num_retries = 3
       @wait_time = 30
       @click_destination = click_destination
     end
 
+    # Finds the element in question; deals with the fact that the
+    # selector could actually be a Proc.
+    #
+    # Has no parameters because it uses @orig_type and
+    # @orig_selector_args.  If @orig_selector_args has a :proc
+    # element, runs that with the browser as an argument, otherwise
+    # just passes those variables to the Watir browser as normal.
+    def find_elem
+      tries=0
+      begin
+        # Do we want to return more than on element?
+        multiples = false
+
+        if @orig_selector_args.has_key? :proc
+          # If it's a Proc, it can handle its own visibility checking
+          return @orig_selector_args[:proc].call @browser
+        else
+          # We want all the relevant elements, so force that if it's
+          # not what was asked for
+          type = @orig_type.to_s
+          if type =~ %r{s$}
+            multiples=true
+          else
+            if Watir::Container.method_defined?(type + 's')
+              type = type + 's'
+            elsif Watir::Container.method_defined?(type + 'es')
+              type = type + 'es'
+            end
+          end
+          @session.log.debug "WrapWatir: find_elem: elements type: #{type}"
+          elems = @browser.send(type, @orig_selector_args)
+        end
+
+        @session.log.debug "WrapWatir: find_elem: elements identified by #{trimmed_selectors.inspect} initial version: #{elems.inspect}"
+
+        if elems.nil? or elems.length == 0
+          @session.log.debug "WrapWatir: find_elem: can't find any element identified by #{trimmed_selectors.inspect}"
+          # Generally, watir-webdriver code expects *something*
+          # back, and uses .present? to see if it's really there, so
+          # we get the singleton to satisfy that need.
+          return @browser.send(@orig_type, @orig_selector_args)
+        end
+
+        # We got something unexpected; just give it back
+        if ! elems.is_a?(Watir::ElementCollection)
+          @session.log.debug "WrapWatir: find_elem: elements aren't a collection; returning them"
+          return elems
+        end
+
+        if multiples
+          # We're OK returning the whole set
+          @session.log.debug "WrapWatir: find_elem: multiples were requested; returning #{elems.inspect}"
+          return elems
+        elsif elems.length == 1
+          # It's not a collection; just return it.
+          @session.log.debug "WrapWatir: find_elem: only one item found; returning #{elems[0].inspect}"
+          return elems[0]
+        else
+          unless @orig_selector_args.has_key? :invisible and @orig_selector_args[:invisible]
+            if trimmed_selectors.inspect !~ /password/i
+              @session.log.debug "WrapWatir: find_elem: elements identified by #{trimmed_selectors.inspect} before visibility selection: #{elems.inspect}"
+            end
+
+            # Find only visible elements
+            elem = elems.find { |x| x.present? and x.visible? }
+
+            if elem.nil?
+              # If there *are* no visible ones, take what we've got
+              elem = elems[0]
+            end
+
+            if trimmed_selectors.inspect !~ /password/i
+              @session.log.debug "WrapWatir: find_elem: element identified by #{trimmed_selectors.inspect} after visibility selection: #{elem.inspect}"
+            end
+
+            return elem
+          end
+        end
+      rescue Exception => e
+        @session.log.warn "WrapWatir: find_elem: Had an exception #{e}"
+        if @session.get_config :global, :debug
+          @session.log.debug "WrapWatir: find_elem: Had an exception in debug mode: #{e.inspect}"
+          @session.log.debug "WrapWatir: find_elem: Had an exception in debug mode: #{e.message}"
+          @session.log.debug "WrapWatir: find_elem: Had an exception in debug mode: #{e.backtrace.join("\n")}"
+
+          @session.log.debug "WrapWatir: find_elem: Had an exception, and you're in debug mode, so giving you a debugger. Use 'continue' to proceed."
+          debugger
+        end
+
+        if tries < 3
+          @session.log.debug "WrapWatir: find_elem: Retrying after exception."
+          retry
+        else
+          @session.log.debug "WrapWatir: find_elem: Giving up after exception."
+        end
+        tries += 1
+      end
+    end
+
+    # Pulls any procs out of the selectors for debugging purposes
+    def trimmed_selectors
+      @orig_selector_args.reject { |k,v| k == :proc }
+    end
+
     # Passes everything through to the underlying Watir object, but
     # with logging.
     def method_missing(m, *args, &block)
       wrapper_logging(m, args)
-      @elem.send(m, *args, &block)
+      find_elem.send(m, *args, &block)
     end
 
     # Used to log all pass through behaviours.  In debug mode,
     # displays details about what method was passed through, and the
     # nature of the element in question.
     def wrapper_logging(m, args)
-      if @orig_selector_args.inspect =~ /password/i
+      elem = find_elem
+
+      if trimmed_selectors.inspect =~ /password/i
         @session.log.debug "WrapWatir: Doing something with passwords, redacted."
       else
         if @session.get_config :global, :debug
           @session.log.add_to_replay_log( @browser, @session )
         end
 
-        @session.log.debug "WrapWatir: Calling #{m} with arguments #{args.inspect} on a #{@elem.class.name} element identified by: #{@orig_selector_args.inspect}"
+        @session.log.debug "WrapWatir: Calling #{m} with arguments #{args.inspect} on a #{elem.class.name} element identified by: #{trimmed_selectors.inspect}"
 
-        if @elem.present? && @elem.class.name == 'Watir::HTMLElement'
-          @session.log.warn "FIXME: You have been lazy and said that something is of type 'element'; its actual type is  #{@elem.to_subtype.class.name}; the element is identified by #{@orig_selector_args.inspect}"
+        if elem.present? && elem.class.name == 'Watir::HTMLElement'
+          @session.log.warn "FIXME: You have been lazy and said that something is of type 'element'; its actual type is  #{elem.to_subtype.class.name}; the element is identified by #{trimmed_selectors.inspect}"
         end
       end
     end
@@ -77,14 +196,55 @@ module Gless
     # A wrapper around Watir's click; handles the changing of
     # acceptable pages (i.e. click_destination processing, see
     # {Gless::BasePage} and {Gless::Session} for more details).
-    def click
+    #
+    # Unconditionally clicks once, without any error handling; if
+    # you want to try to execute a page transition no matter what,
+    # just use +click+
+    def click_once
+      elem = find_elem
+
       if @click_destination
-        @session.log.debug "WrapWatir: A #{@elem.class.name} element identified by: #{@orig_selector_args.inspect} has a special destination when clicked, #{@click_destination}"
+        @session.log.debug "WrapWatir: A #{elem.class.name} element identified by: #{trimmed_selectors.inspect} has a special destination when clicked, #{@click_destination}"
         @session.acceptable_pages = @click_destination
       end
       wrapper_logging('click', nil)
-      @session.log.debug "WrapWatir: Calling click on a #{@elem.class.name} element identified by: #{@orig_selector_args.inspect}"
-      @elem.click
+      @session.log.debug "WrapWatir: Calling click on a #{elem.class.name} element identified by: #{trimmed_selectors.inspect}"
+      elem.click
+    end
+
+    # A wrapper around Watir's click; handles the changing of
+    # acceptable pages (i.e. click_destination processing, see
+    # {Gless::BasePage} and {Gless::Session} for more details).
+    #
+    # If you've clicked on an element with a click_destination, it
+    # then calls {Gless::Session#change_pages} to do the actual page
+    # transition.  As such, it may actually click several times,
+    # it will keep trying until it works; if that's not what you're
+    # looking for, use click_once
+    def click
+      elem = find_elem
+
+      if @click_destination
+        @session.log.debug "WrapWatir: click: A #{elem.class.name} element identified by: #{trimmed_selectors.inspect} has a special destination when clicked, #{@click_destination}"
+        change_pages_out, change_pages_message = @session.change_pages( @click_destination ) do
+          wrapper_logging('click', nil)
+          @session.log.debug "WrapWatir: click: Calling click on a #{elem.class.name} element identified by: #{trimmed_selectors.inspect}"
+          if elem.exists?
+            elem.click
+          end
+          if block_given?
+            yield
+          end
+        end
+        # If the return value isn't true, use it as the message to
+        # print.
+        @session.log.debug "WrapWatir: click: change pages results: #{change_pages_out}, #{change_pages_message}"
+        change_pages_out.should be_true, change_pages_message
+      else
+        wrapper_logging('click', nil)
+        @session.log.debug "WrapWatir: click: Calling click on a #{elem.class.name} element identified by: #{trimmed_selectors.inspect}"
+        elem.click
+      end
     end
 
     # Used by +set+, see description there.
@@ -109,55 +269,55 @@ module Gless
     # such try.
     def set(*args)
       wrapper_logging('set', args)
+      elem = find_elem
 
       # Double-check text fields
-      if @elem.class.name == 'Watir::TextField'
+      if elem.class.name == 'Watir::TextField'
         set_text = args[0]
-        @elem.set(set_text)
+        @session.log.debug "WrapWatir: set: setting text on #{elem.inspect}/#{elem.html} to #{set_text}"
+        elem.set(set_text)
 
         @num_retries.times do |x|
           @session.log.debug "WrapWatir: Checking that text entry worked"
-          @elem = @browser.send(@orig_type, @orig_selector_args)
-          if @elem.value == set_text
+          if elem.value == set_text
             break
           else
             @session.log.debug "WrapWatir: It did not; sleeping for #{@wait_time} seconds"
             sleep @wait_time
             @session.log.debug "WrapWatir: Retrying."
             wrapper_logging('set', set_text)
-            @elem.set(set_text)
+            elem.set(set_text)
           end
         end
-        @elem.value.should == set_text
+        elem.value.to_s.should == set_text.to_s
         @session.log.debug "WrapWatir: The text entry worked"
 
         return self
 
         # Double-check radio buttons
-      elsif @elem.class.name == 'Watir::Radio'
+      elsif elem.class.name == 'Watir::Radio'
         wrapper_logging('set', [])
-        @elem.set
+        elem.set
 
         @num_retries.times do |x|
           @session.log.debug "WrapWatir: Checking that the radio selection worked"
-          @elem = @browser.send(@orig_type, @orig_selector_args)
-          if @elem.set? == true
+          if elem.set? == true
             break
           else
             @session.log.debug "WrapWatir: It did not; sleeping for #{@wait_time} seconds"
             sleep @wait_time
             @session.log.debug "WrapWatir: Retrying."
             wrapper_logging('set', [])
-            @elem.set
+            elem.set
           end
         end
-        @elem.set?.should be_true
+        elem.set?.should be_true
         @session.log.debug "WrapWatir: The radio set worked"
 
         return self
 
       else
-        @elem.set(*args)
+        elem.set(*args)
       end
     end
   end

data/lib/gless.rb

@@ -6,7 +6,7 @@
 # project.
 module Gless
   # The current version number.
-  VERSION = '1.0.2'
+  VERSION = '1.1.2'
 
   # Sets up the config, logger and browser instances, the ordering
   # of which is slightly tricky.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gless
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-08 00:00:00.000000000 Z
+date: 2013-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -119,6 +119,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rvmrc
+- Changelog.txt
 - README.md
 - Rakefile
 - TODO