Contents

module Celerity
  # This class is the superclass for the iterator classes (Buttons, Links, Spans etc.)
  # It would normally only be accessed by the iterator methods (Browser#spans, Browser#links, ...).
  class ElementCollections
    include Enumerable
    
    # @api internal
    def initialize(container, how = nil, what = nil)
      @container = container
      @object = (how == :object ? what : nil)
      @length = length
    end
   
    # @return [Fixnum] The number of elements in this collection.
    def length
      if @object
        @object.length
      else
        @elements ||= ElementLocator.new(@container.object, element_class).elements_by_idents
        @elements.size
      end
    end
    alias_method :size, :length
    
    # @yield [element] Iterate through the elements in this collection.
    def each
      if @elements
        @elements.each { |e| yield(element_class.new(@container, :object, e)) }
        @length
      else
        0.upto(@length - 1) { |i| yield iterator_object(i) }
      end
    end
    
    # Get the element at the given index.
    # NB! This is 1-indexed to keep compatibility with Watir. Subject to change.
    #
    # @return [Celerity::Element]
    def [](n)
      @elements ? element_class.new(@container, :object, @elements[n-1]) : iterator_object(n-1)
    end
    
    def to_s
      map { |e| e.to_s }.join("\n")
    end
    
    private

    def iterator_object(i)
      element_class.new(@container, :index, i+1)
    end
  
  end # ElementCollections
end # Celerity

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
celerity-0.0.4	lib/celerity/element_collections.rb