druid-ts 0.0.1 → 1.1.0

data/lib/druid/elements.rb

@@ -1,3 +1,27 @@
+module Druid
+  module Elements
+    class << self
+
+      def type_to_class
+        @type_to_class ||= {}
+      end
+
+      # method to return the collection of tag_name class mappings
+      def tag_to_class
+        @tag_to_class ||= {}
+      end
+
+      #
+      # method to return the element for a tag_name
+      #
+      def element_class_for(tag_name, type=nil)
+        return type_to_class[type] if type
+        tag_to_class[tag_name.to_sym] || Druid::Elements::Element
+      end
+    end
+  end
+end
+
 require 'druid/elements/element.rb'
 require 'druid/elements/ordered_list.rb'
 require 'druid/elements/unordered_list.rb'
@@ -17,3 +41,7 @@ require 'druid/elements/hidden_field.rb'
 require 'druid/elements/list_item.rb'
 require 'druid/elements/text_area.rb'
 require 'druid/elements/form.rb'
+require 'druid/elements/option.rb'
+require 'druid/elements/heading.rb'
+require 'druid/elements/paragraph.rb'
+require 'druid/elements/file_field.rb'

data/lib/druid/elements/button.rb

@@ -3,9 +3,14 @@ module Druid
     class Button < Element
 
       def self.finders
-        super + [:text]
+        super + [:value, :text, :src, :alt]
       end
 
     end
+
+    Druid::Elements.type_to_class[:submit] = Druid::Elements::Button
+    Druid::Elements.type_to_class[:image] = Druid::Elements::Button
+    Druid::Elements.type_to_class[:button] = Druid::Elements::Button
+    Druid::Elements.type_to_class[:reset] = Druid::Elements::Button
   end
 end

data/lib/druid/elements/check_box.rb

@@ -2,6 +2,32 @@ module Druid
   module Elements
     class CheckBox < Element
 
+      def self.finders
+        super + [:value]
+      end
+
+      #
+      # Check the checkbox
+      #
+      def check
+        element.set
+      end
+
+      #
+      # Uncheck the CheckBox
+      #
+      def uncheck
+        element.clear
+      end
+
+      #
+      # Return true if checkbox is checked
+      #
+      def checked?
+        element.set?
+      end
     end
+
+    Druid::Elements.type_to_class[:checkbox] = Druid::Elements::CheckBox
   end
 end

data/lib/druid/elements/div.rb

@@ -3,8 +3,10 @@ module Druid
     class Div < Element
 
       def self.finders
-        [:class, :id, :index, :xpath]
+        [:class, :id, :text, :index, :xpath]
       end
     end
+
+    Druid::Elements.tag_to_class[:div] = Druid::Elements::Div
   end
 end

data/lib/druid/elements/element.rb

@@ -1,18 +1,23 @@
+require 'druid/nested_elements'
+require 'druid/assist'
 module Druid
   module Elements
     #
     # Contains functionality that is common across all elements
     #
     class Element
+      include Druid::NestedElements
+      include Druid::Assist
+
       attr_accessor :element
+      attr_accessor :driver
 
       def initialize(element)
         @element = element
+        @driver = @element
       end
 
-      # def self.identifier_for identifier
-      #   identifier_for_element identifier, finders, mapping
-      # end
+      # @private
       def self.identifier_for identifier
         if have_to_build_xpath(identifier)
           how = :xpath
@@ -30,7 +35,7 @@ module Druid
       end
 
       def self.have_to_build_xpath(identifier)
-        ['table', 'span', 'div', 'td', 'li', 'ol', 'ul'].include? identifier[:tag_name] and identifier[:name]
+        ['table', 'span', 'div', 'td', 'li', 'ol', 'ul', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'p'].include? identifier[:tag_name] and identifier[:name]
       end
 
       def self.build_xpath_for identifier
@@ -97,6 +102,11 @@ module Druid
         {}
       end
 
+      #
+      # Get the text for the element
+      #
+      # @return [String]
+      #
       def text
         element.text
       end
@@ -105,25 +115,180 @@ module Druid
         element.exist?
       end
 
+      def enabled?
+        element.enabled?
+      end
+
       def visible?
         element.visible?
       end
 
+      #
+      # Get the value of this element
+      #
+      # @return [String]
+      #
       def value
         element.value
       end
 
+      #
+      # compare this element to another to determine if they are equal
+      # @return [Boolean]
+      #
+      def ==(other)
+        element == other.element
+      end
+
+      #
+      # Get the tag name of this element
+      #
+      # @return [String]
+      #
       def tag_name
         element.tag_name
       end
 
-      def attribute_value(attribute_name)
+      #
+      # Get the value of the given attribute of the element
+      # @param [String]
+      # @return [String, nil]
+      #
+      def attribute(attribute_name)
         element.attribute_value attribute_name
       end
 
+      #
+      # Click this element
+      #
       def click
         element.click
       end
+
+      #
+      # get the value of the given CSS property
+      #
+      def style(property)
+        element.style property
+      end
+
+      def inspect
+        element.inspect
+      end
+
+      #
+      # Send keystrokes to this element
+      #
+      # @param [String, Symbol, Array]
+      #
+      # Examples:
+      #
+      #  element.send_keys "foo"                    #=> value: 'foo'
+      #  element.send_keys "tet", :arrow_left, "s"  #=> value: 'test'
+      #  element.send_keys [:control, 'a'], :space  #=> value: ' '
+      #
+      def send_keys(*args)
+        element.send_keys(*args)
+      end
+
+      #
+      # clear the contents of the element
+      #
+      def clear
+        element.clear
+      end
+
+      #
+      # double click this element
+      #
+      def double_click
+        element.double_click
+      end
+
+      #
+      # right click this element
+      #
+      def right_click
+        element.right_click
+      end
+
+      #
+      # Fire the provided event on the current element
+      #
+      def fire_event(event_name)
+        element.fire_event(event_name)
+      end
+
+      def focus
+        element.focus
+      end
+
+      #
+      # Returns parent element of current element.
+      def parent
+        parent = element.parent
+        type = element.type if parent.tag_name.to_sym == :input
+        cls = Druid::Elements.element_class_for(parent.tag_name, type)
+        cls.new(parent)
+      end
+
+      #
+      # Waits until the element is present
+      #
+      # @param [Integer] (default to:5) seconds to wait before timing out
+      #
+      def when_present(timeout=5)
+        element.wait_until_present(timeout)
+        self
+      end
+
+      #
+      # Waits until the element is visible
+      #
+      # @param [Interger] (default to:5) seconds to wait before timing out
+      #
+      def when_visible(timeout=5)
+        Watir::Wait.until(timeout, "Element was not visible in #{timeout} seconds") do
+          visible?
+        end
+        self
+      end
+
+      #
+      # Waits until the element is not visible
+      #
+      # @param [Integer] (default to:5) seconds to wait before timing out
+      #
+      def when_not_visible(timeout=5)
+        Watir::Wait.while(timeout, "Element still visible after #{timeout} seconds") do
+          visible?
+        end
+        self
+      end
+
+      #
+      # Waits until the block returns true
+      #
+      # @param [Integer] (default to:5) seconds to wait before timing out
+      #
+      def wait_until(timeout=5, message=nil, &block)
+        Watir::Wait.until(timeout, message, &block)
+      end
+
+      # @private
+      # delegate calls to driver element
+      def method_missing(m, *args, &block)
+        puts "*** DEPRECATION WARNING"
+        puts "*** You are calling a method named #{m}."
+        puts "*** This method does not exist in druid so it is being passed to the driver."
+        puts "*** This feature will be removed in the near future."
+        puts "*** Please change your code to call the correct druid method."
+        puts "*** If you are using functionality that does not exist in druid please request it be added."
+        unless element.respond_to?(m)
+          raise NoMethodError, "undefined method `#{m}` for #{element.inspect}:#{element.class}"
+        end
+        element.__send__(m, *args, &block)
+      end
     end
   end
 end

data/lib/druid/elements/file_field.rb

@@ -0,0 +1,18 @@
+module Druid
+  module Elements
+    class FileField < Element
+      def self.finders
+        super + [:title]
+      end
+
+      #
+      # Set the value of the FileField
+      #
+      def value=(new_value)
+        element.set(new_value)
+      end
+    end
+
+    Druid::Elements.type_to_class[:file] = Druid::Elements::FileField
+  end
+end

data/lib/druid/elements/form.rb

@@ -2,6 +2,17 @@ module Druid
   module Elements
     class Form < Element
 
+      def self.finders
+        super + [:action]
+      end
+      #
+      # Submit the form
+      #
+      def submit
+        element.submit
+      end
     end
+
+    Druid::Elements.tag_to_class[:form] = Druid::Elements::Form
   end
 end

data/lib/druid/elements/heading.rb

@@ -0,0 +1,14 @@
+module Druid
+  module Elements
+     class Heading < Element
+
+     end
+
+     Druid::Elements.tag_to_class[:h1] = Druid::Elements::Heading
+     Druid::Elements.tag_to_class[:h2] = Druid::Elements::Heading
+     Druid::Elements.tag_to_class[:h3] = Druid::Elements::Heading
+     Druid::Elements.tag_to_class[:h4] = Druid::Elements::Heading
+     Druid::Elements.tag_to_class[:h5] = Druid::Elements::Heading
+     Druid::Elements.tag_to_class[:h6] = Druid::Elements::Heading
+  end
+end

data/lib/druid/elements/hidden_field.rb

@@ -1,11 +1,21 @@
 module Druid
   module Elements
     class HiddenField < Element
-      
+
+      def click
+        raise "click is not available on hidden field element with watir"
+      end
+
       def self.finders
-        super + [:tag_name, :text, :css]
+        super + [:tag_name, :text, :value]
+      end
+
+      def self.mapping
+        super.merge({:css => :tag_name})
       end
 
     end
+
+    Druid::Elements.type_to_class[:hidden] = Druid::Elements::HiddenField
   end
 end

data/lib/druid/elements/image.rb

@@ -2,6 +2,19 @@ module Druid
   module Elements
     class Image < Element
 
+      def self.finders
+        super + [:alt, :src]
+      end
+
+      def width
+        element.width
+      end
+
+      def height
+        element.height
+      end
     end
+
+    Druid::Elements.tag_to_class[:img] = Druid::Elements::Image
   end
 end

data/lib/druid/elements/link.rb

@@ -12,5 +12,7 @@ module Druid
          super.merge({:link => :text, :link_text => :text})
       end
     end
+
+    Druid::Elements.tag_to_class[:a] = Druid::Elements::Link
   end
 end

data/lib/druid/elements/list_item.rb

@@ -1,7 +1,9 @@
 module Druid
   module Elements
     class ListItem < Element
-  
+
     end
+
+    Druid::Elements.tag_to_class[:li] = Druid::Elements::ListItem
   end
 end

data/lib/druid/elements/option.rb

@@ -0,0 +1,9 @@
+module Druid
+  module Elements
+    class Option < Element
+
+    end
+
+    Druid::Elements.tag_to_class[:option] = Druid::Elements::Option
+  end
+end