watir 1.6.2 → 1.6.5

data/lib/watir/element_collections.rb

@@ -1,82 +1,98 @@
-module Watir
-  # this class is the super class for the iterator classes (buttons, links, spans etc
-  # it would normally only be accessed by the iterator methods (spans, links etc) of IE
-  class ElementCollections
-    include Enumerable
-    
-    # Super class for all the iteractor classes
-    #   * container - an instance of an IE object
-    def initialize(container)
-      @container = container
-      @page_container = container.page_container
-      @length = length # defined by subclasses
-      
-      # set up the items we want to display when the show method is used
-      set_show_items
-    end
-    
-    private
-    def set_show_items
-      @show_attributes = AttributeLengthPairs.new("id", 20)
-      @show_attributes.add("name", 20)
-    end
-    
-    public
-    def get_length_of_input_objects(object_type)
-      object_types =
-      if object_type.kind_of? Array
-        object_type
-      else
-        [object_type]
-      end
-      
-      length = 0
-      objects = @container.document.getElementsByTagName("INPUT")
-      if objects.length > 0
-        objects.each do |o|
-          length += 1 if object_types.include?(o.invoke("type").downcase)
-        end
-      end
-      return length
-    end
-    
-    # iterate through each of the elements in the collection in turn
-    def each
-      0.upto(@length-1) { |i| yield iterator_object(i) }
-    end
-    
-    # allows access to a specific item in the collection
-    def [](n)
-      return iterator_object(n-1)
-    end
-    
-    # this method is the way to show the objects, normally used from irb
-    def show
-      s = "index".ljust(6)
-      @show_attributes.each do |attribute_length_pair|
-        s += attribute_length_pair.attribute.ljust(attribute_length_pair.length)
-      end
-      
-      index = 1
-      self.each do |o|
-        s += "\n"
-        s += index.to_s.ljust(6)
-        @show_attributes.each do |attribute_length_pair|
-          begin
-            s += eval('o.ole_object.invoke("#{attribute_length_pair.attribute}")').to_s.ljust(attribute_length_pair.length)
-          rescue => e
-            s += " ".ljust(attribute_length_pair.length)
-          end
-        end
-        index += 1
-      end
-      puts s
-    end
-    
-    # this method creates an object of the correct type that the iterators use
-    private
-    def iterator_object(i)
-      element_class.new(@container, :index, i + 1)
-    end
-  end
+module Watir
+  # this class is the super class for the iterator classes (buttons, links, spans etc
+  # it would normally only be accessed by the iterator methods (spans, links etc) of IE
+  class ElementCollections
+    include Enumerable
+    
+    # Super class for all the iteractor classes
+    #   * container - an instance of an IE object
+    def initialize(container)
+      @container = container
+      @page_container = container.page_container
+      @length = length # defined by subclasses
+      
+      # set up the items we want to display when the show method is used
+      set_show_items
+    end
+    
+    private
+    def set_show_items
+      @show_attributes = AttributeLengthPairs.new("id", 20)
+      @show_attributes.add("name", 20)
+    end
+    
+    public
+    def get_length_of_input_objects(object_type)
+      object_types =
+      if object_type.kind_of? Array
+        object_type
+      else
+        [object_type]
+      end
+      
+      length = 0
+      objects = @container.document.getElementsByTagName("INPUT")
+      if objects.length > 0
+        objects.each do |o|
+          length += 1 if object_types.include?(o.invoke("type").downcase)
+        end
+      end
+      return length
+    end
+    
+    # iterate through each of the elements in the collection in turn
+    def each
+      0.upto(@length-1) { |i| yield iterator_object(i) }
+    end
+    
+    # allows access to a specific item in the collection
+    def [](n)
+      return iterator_object(n-1)
+    end
+
+    def first
+      iterator_object(0)
+    end
+
+    def last
+      iterator_object(length - 1)
+    end
+
+    # this method is the way to show the objects, normally used from irb
+    def show
+      s = "index".ljust(6)
+      @show_attributes.each do |attribute_length_pair|
+        s += attribute_length_pair.attribute.ljust(attribute_length_pair.length)
+      end
+      
+      index = 1
+      self.each do |o|
+        s += "\n"
+        s += index.to_s.ljust(6)
+        @show_attributes.each do |attribute_length_pair|
+          begin
+            s += eval('o.ole_object.invoke("#{attribute_length_pair.attribute}")').to_s.ljust(attribute_length_pair.length)
+          rescue => e
+            s += " ".ljust(attribute_length_pair.length)
+          end
+        end
+        index += 1
+      end
+      puts s
+    end
+    
+    def to_s
+      map { |e| e.to_s }.join("\n")
+    end
+
+    def inspect
+      '#<%s:0x%x length=%s container=%s>' % [self.class, hash*2, @length.inspect, @container.inspect]
+    end
+
+    # this method creates an object of the correct type that the iterators use
+    private
+    def iterator_object(i)
+      element_class.new(@container, :index, i + 1)
+    end
+  end
 end

data/lib/watir/form.rb

@@ -1,171 +1,171 @@
-module Watir
-
-  # Forms
-  
-  module FormAccess
-    def name
-      @ole_object.getAttributeNode('name').value
-    end
-    def action
-      @ole_object.action
-    end
-    def method
-      @ole_object.invoke('method')
-    end
-    def id
-      @ole_object.invoke('id')
-    end
-  end
-  
-  # wraps around a form OLE object
-  class FormWrapper
-    include FormAccess
-    def initialize ole_object
-      @ole_object = ole_object
-    end
-  end
-  
-  #   Form Factory object
-  class Form < Element
-    include FormAccess
-    include Container
-    
-    attr_accessor :form, :ole_object
-    
-    #   * container   - the containing object, normally an instance of IE
-    #   * how         - symbol - how we access the form (:name, :id, :index, :action, :method)
-    #   * what        - what we use to access the form
-    def initialize(container, how, what)
-      set_container container
-      @how = how
-      @what = what
-      
-      log "Get form how is #{@how}  what is #{@what} "
-      
-      # Get form using xpath.
-      if @how == :xpath
-        @ole_object = @container.element_by_xpath(@what)
-      else
-        count = 1
-        doc = @container.document
-        doc.forms.each do |thisForm|
-          next unless @ole_object == nil
-          
-          wrapped = FormWrapper.new(thisForm)
-          @ole_object =
-          case @how
-          when :name, :id, :method, :action
-            @what.matches(wrapped.send(@how)) ? thisForm : nil
-          when :index
-            count == @what ? thisForm : nil
-          else
-            raise MissingWayOfFindingObjectException, "#{how} is an unknown way of finding a form (#{what})"
-          end
-          count += 1
-        end
-      end
-      super(@ole_object)
-      
-      copy_test_config container
-    end
-    
-    def exists?
-      @ole_object ? true : false
-    end
-    alias :exist? :exists?
-    
-    def assert_exists
-      unless exists?
-        raise UnknownFormException, 
-          "Unable to locate a form using #{@how} and #{@what}" 
-      end
-    end
-    
-    # Submit the data -- equivalent to pressing Enter or Return to submit a form.
-    def submit 
-      assert_exists
-      @ole_object.invoke('submit')
-      @container.wait
-    end
-    
-    def ole_inner_elements
-      assert_exists
-      @ole_object.elements
-    end
-    private :ole_inner_elements
-    
-    def document
-      return @ole_object
-    end
-    
-    def wait(no_sleep=false)
-      @container.wait(no_sleep)
-    end
-    
-    # This method is responsible for setting and clearing the colored highlighting on the specified form.
-    # use :set  to set the highlight
-    #   :clear  to clear the highlight
-    def highlight(set_or_clear, element, count)
-      
-      if set_or_clear == :set
-        begin
-          original_color = element.style.backgroundColor
-          original_color = "" if original_color==nil
-          element.style.backgroundColor = activeObjectHighLightColor
-        rescue => e
-          puts e
-          puts e.backtrace.join("\n")
-          original_color = ""
-        end
-        @original_styles[count] = original_color
-      else
-        begin
-          element.style.backgroundColor = @original_styles[ count]
-        rescue => e
-          puts e
-          # we could be here for a number of reasons...
-        ensure
-        end
-      end
-    end
-    private :highlight
-    
-    # causes the object to flash. Normally used in IRB when creating scripts
-    # Default is 10
-    def flash number=10
-      @original_styles = {}
-      number.times do
-        count = 0
-        @ole_object.elements.each do |element|
-          highlight(:set, element, count)
-          count += 1
-        end
-        sleep 0.05
-        count = 0
-        @ole_object.elements.each do |element|
-          highlight(:clear, element, count)
-          count += 1
-        end
-        sleep 0.05
-      end
-    end
-    
-  end # class Form
-  
-end
-
-module Watir
-  class Forms < ElementCollections
-    def element_class; Form; end
-    def element_tag; 'FORM'; end
-    def length
-      @container.document.getElementsByTagName("FORM").length
-    end
-  end
-
-  module Container
-    def forms
-      Forms.new(self)
-    end
-  end
+module Watir
+
+  # Forms
+  
+  module FormAccess
+    def name
+      @ole_object.getAttributeNode('name').value
+    end
+    def action
+      @ole_object.action
+    end
+    def method
+      @ole_object.invoke('method')
+    end
+    def id
+      @ole_object.invoke('id')
+    end
+  end
+  
+  # wraps around a form OLE object
+  class FormWrapper
+    include FormAccess
+    def initialize ole_object
+      @ole_object = ole_object
+    end
+  end
+  
+  #   Form Factory object
+  class Form < Element
+    include FormAccess
+    include Container
+    
+    attr_accessor :form, :ole_object
+    
+    #   * container   - the containing object, normally an instance of IE
+    #   * how         - symbol - how we access the form (:name, :id, :index, :action, :method)
+    #   * what        - what we use to access the form
+    def initialize(container, how, what)
+      set_container container
+      @how = how
+      @what = what
+      
+      log "Get form how is #{@how}  what is #{@what} "
+      
+      # Get form using xpath.
+      if @how == :xpath
+        @ole_object = @container.element_by_xpath(@what)
+      else
+        count = 1
+        doc = @container.document
+        doc.forms.each do |thisForm|
+          next unless @ole_object == nil
+          
+          wrapped = FormWrapper.new(thisForm)
+          @ole_object =
+          case @how
+          when :name, :id, :method, :action
+            @what.matches(wrapped.send(@how)) ? thisForm : nil
+          when :index
+            count == @what ? thisForm : nil
+          else
+            raise MissingWayOfFindingObjectException, "#{how} is an unknown way of finding a form (#{what})"
+          end
+          count += 1
+        end
+      end
+      super(@ole_object)
+      
+      copy_test_config container
+    end
+    
+    def exists?
+      @ole_object ? true : false
+    end
+    alias :exist? :exists?
+    
+    def assert_exists
+      unless exists?
+        raise UnknownFormException, 
+          "Unable to locate a form using #{@how} and #{@what}" 
+      end
+    end
+    
+    # Submit the data -- equivalent to pressing Enter or Return to submit a form.
+    def submit 
+      assert_exists
+      @ole_object.invoke('submit')
+      @container.wait
+    end
+    
+    def ole_inner_elements
+      assert_exists
+      @ole_object.elements
+    end
+    private :ole_inner_elements
+    
+    def document
+      return @ole_object
+    end
+    
+    def wait(no_sleep=false)
+      @container.wait(no_sleep)
+    end
+    
+    # This method is responsible for setting and clearing the colored highlighting on the specified form.
+    # use :set  to set the highlight
+    #   :clear  to clear the highlight
+    def highlight(set_or_clear, element, count)
+      
+      if set_or_clear == :set
+        begin
+          original_color = element.style.backgroundColor
+          original_color = "" if original_color==nil
+          element.style.backgroundColor = activeObjectHighLightColor
+        rescue => e
+          puts e
+          puts e.backtrace.join("\n")
+          original_color = ""
+        end
+        @original_styles[count] = original_color
+      else
+        begin
+          element.style.backgroundColor = @original_styles[ count]
+        rescue => e
+          puts e
+          # we could be here for a number of reasons...
+        ensure
+        end
+      end
+    end
+    private :highlight
+    
+    # causes the object to flash. Normally used in IRB when creating scripts
+    # Default is 10
+    def flash number=10
+      @original_styles = {}
+      number.times do
+        count = 0
+        @ole_object.elements.each do |element|
+          highlight(:set, element, count)
+          count += 1
+        end
+        sleep 0.05
+        count = 0
+        @ole_object.elements.each do |element|
+          highlight(:clear, element, count)
+          count += 1
+        end
+        sleep 0.05
+      end
+    end
+    
+  end # class Form
+  
+end
+
+module Watir
+  class Forms < ElementCollections
+    def element_class; Form; end
+    def element_tag; 'FORM'; end
+    def length
+      @container.document.getElementsByTagName("FORM").length
+    end
+  end
+
+  module Container
+    def forms
+      Forms.new(self)
+    end
+  end
 end