druid-s 1.0.0

data/lib/druid/elements.rb

@@ -0,0 +1,55 @@
+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.to_sym] if type
+        tag_to_class[tag_name.to_sym] || Druid::Elements::Element
+      end
+    end
+  end
+end
+
+require 'druid/elements/element'
+require 'druid/elements/ordered_list'
+require 'druid/elements/unordered_list'
+require 'druid/elements/table'
+require 'druid/elements/table_row'
+require 'druid/elements/select_list'
+require 'druid/elements/link'
+require 'druid/elements/button'
+require 'druid/elements/check_box'
+require 'druid/elements/radio_button'
+require 'druid/elements/text_field'
+require 'druid/elements/div'
+require 'druid/elements/table_cell'
+require 'druid/elements/image'
+require 'druid/elements/span'
+require 'druid/elements/hidden_field'
+require 'druid/elements/list_item'
+require 'druid/elements/text_area'
+require 'druid/elements/form'
+require 'druid/elements/option'
+require 'druid/elements/heading'
+require 'druid/elements/paragraph'
+require 'druid/elements/file_field'
+require 'druid/elements/label'
+require 'druid/elements/area'
+require 'druid/elements/canvas'
+require 'druid/elements/media'
+require 'druid/elements/audio'
+require 'druid/elements/video'
+require 'druid/elements/bold'
+require 'druid/elements/italic'

data/lib/druid/javascript/angularjs.rb

@@ -0,0 +1,12 @@
+module Druid
+  module Javascript
+    module AngularJS
+      #
+      # return the number of pending ajax requests
+      #
+      def self.pending_requests
+        'return angular.element(document.body).injector().get(\'$http\').pendingRequests.length;'
+      end
+    end
+  end
+end

data/lib/druid/javascript/jquery.rb

@@ -0,0 +1,12 @@
+module Druid
+  module Javascript
+    module JQuery
+      #
+      # return the number of pending ajax requests
+      #
+      def self.pending_requests
+        'return jQuery.active'
+      end
+    end
+  end
+end

data/lib/druid/javascript/prototype.rb

@@ -0,0 +1,12 @@
+module Druid
+  module Javascript
+    module Prototype
+      #
+      # return the number of pending ajax requests
+      #
+      def self.pending_requests
+        'return Ajax.activeRequestCount'
+      end
+    end
+  end
+end

data/lib/druid/javascript/yui.rb

@@ -0,0 +1,19 @@
+module Druid
+  module Javascript
+
+    module YUI
+      #
+      # return the number of pending ajax requests
+      #
+      def self.pending_requests
+         "var inProgress=0
+         for(var i=0; i < YAHOO.util.Connect._transaction_id; i++) {
+           if(YAHOO.util.Connect.isCallInProgress(i))
+             inProgress++;
+         }
+         return inProgress;"
+      end
+    end
+
+  end
+end

data/lib/druid/javascript_framework_facade.rb

@@ -0,0 +1,76 @@
+require 'druid/javascript/jquery'
+require 'druid/javascript/prototype'
+require 'druid/javascript/yui'
+require 'druid/javascript/angularjs'
+
+module Druid
+  #
+  # Provide hooks into different common Javascript Frameworks.
+  # Currently this module only supports jQuery and Prototype but it
+  # has ability for you to plug your own framework into it and
+  # therefore have it work with this gem. You do this by calling the
+  # #add_framework method. The module you provide must implement the
+  # necessary methods. Please look at the jQuery or Prototype
+  # implementations to determine the necessary methods
+  #
+  module JavascriptFrameworkFacade
+
+    class << self
+      #
+      # Set the framework to use
+      #
+      # @param [Symbol] the framework to use. :jquery and :prototype, :yui,
+      # and :angularjs are supported
+      #
+      def framework=(framework)
+        initialize_script_builder unless @builder
+        raise unknown_framework(framework) unless @builder[framework]
+        @framework = framework
+      end
+
+      def add_framework(key, value)
+        raise invalid_framework unless value.respond_to? :pending_requests
+        initialize_script_builder unless @builder
+        @builder[key] = value
+      end
+
+      #
+      # Get the framework that will be used
+      #
+      def framework
+        @framework
+      end
+
+      def script_builder
+        initialize_script_builder unless @builder
+        @builder[@framework]
+      end
+
+      #
+      # get the javascript to determine number of pending requests
+      #
+      def pending_requests
+        script_builder.pending_requests
+      end
+
+      private
+
+      def initialize_script_builder
+        @builder = {
+          :jquery => Druid::Javascript::JQuery,
+          :prototype => Druid::Javascript::Prototype,
+          :yui => Druid::Javascript::YUI,
+          :angularjs => Druid::Javascript::AngularJS
+        }
+      end
+
+      def unknown_framework(framework)
+        "You specified the Javascript framework #{framework} and it is unknown to the system"
+      end
+
+      def invalid_framework
+        "The Javascript framework you provided does not implement the necessary methods"
+      end
+    end
+  end
+end

data/lib/druid/locator_generator.rb

@@ -0,0 +1,181 @@
+module Druid
+  module LocatorGenerator
+
+    BASIC_ELEMENTS = %i(
+        abbr
+        address
+        animate
+        animate_motion
+        animate_transform
+        article
+        as
+        aside
+        base
+        bdi
+        bdo
+        blockquote
+        body
+        br
+        caption
+        circle
+        cite
+        code
+        col
+        colgroup
+        command
+        cursor
+        data
+        datalist
+        dd
+        defs
+        del
+        desc
+        details
+        dfn
+        dialog
+        discard
+        dl
+        dt
+        ellipse
+        em
+        embed
+        fieldset
+        figcaption
+        figure
+        font
+        footer
+        foreign_object
+        g
+        head
+        header
+        hgroup
+        hr
+        html
+        ins
+        kbd
+        keygen
+        legend
+        line
+        linear_gradient
+        main
+        map
+        mark
+        marker
+        menu
+        menuitem
+        mesh_gradient
+        mesh_patch
+        mesh_row
+        meta
+        metadata
+        meter
+        mpath
+        nav
+        noscript
+        object
+        optgroup
+        output
+        p
+        param
+        path
+        pattern
+        polygon
+        polyline
+        pre
+        progress
+        q
+        radial_gradient
+        rect
+        rp
+        rt
+        ruby
+        s
+        samp
+        script
+        section
+        set
+        small
+        source
+        stop
+        strong
+        style
+        sub
+        summary
+        sup
+        switch
+        symbol
+        template
+        text_path
+        thread
+        time
+        title
+        track
+        tspan
+        u
+        use
+        var
+        view
+        wbr
+    )
+
+
+    ADVANCED_ELEMENTS = %i(
+        text_field
+        hidden_field
+        text_area
+        select_list
+        link
+        checkbox
+        radio_button
+        button
+        div
+        span
+        table
+        cell
+        row
+        image
+        form
+        list_item
+        ordered_list
+        unordered_list
+        h1
+        h2
+        h3
+        h4
+        h5
+        h6
+        paragraph
+        label
+        file_field
+        area
+        canvas
+        audio
+        video
+        b
+        i
+        svg
+    )
+
+    def self.generate_locators(target)
+       ADVANCED_ELEMENTS.each do |tag|
+         target.send(:define_method, "#{tag.to_s}_element") do |*identifier|
+           self.send "#{tag.to_s}_for", locator(identifier).clone
+         end
+
+         target.send(:define_method, "#{tag.to_s}_elements") do |*identifier|
+           self.send "#{tag.to_s}s_for", identifier[0] ? identifier[0].clone : {}
+         end
+       end
+
+       BASIC_ELEMENTS.each do |tag|
+         target.send(:define_method, "#{tag.to_s}_element") do |*identifier|
+           self.send :element_for, tag, locator(identifier)
+         end
+
+         target.send(:define_method, "#{tag.to_s}_elements") do |*identifier|
+           self.send(:elements_for, tag, identifier[0] ? identifier[0] : {})
+         end
+       end
+    end
+  end
+end

data/lib/druid/nested_elements.rb

@@ -0,0 +1,56 @@
+require 'druid/locator_generator'
+
+module Druid
+  module NestedElements
+
+    def self.included(cls)
+      Druid::LocatorGenerator.generate_locators(cls)
+    end
+
+    private
+
+    def locator(identifier)
+      identifier[0] ? identifier[0] : {:index => 0}
+    end
+
+    # [:text_field,
+    #  :hidden_field,
+    #  :text_area,
+    #  :select_list,
+    #  :link,
+    #  :checkbox,
+    #  :radio_button,
+    #  :button,
+    #  :div,
+    #  :span,
+    #  :table,
+    #  :cell,
+    #  :image,
+    #  :form,
+    #  :list_item,
+    #  :unordered_list,
+    #  :ordered_list,
+    #  :h1,
+    #  :h2,
+    #  :h3,
+    #  :h4,
+    #  :h5,
+    #  :h6,
+    #  :paragraph,
+    #  :label,
+    #  :file_field,
+    #  :area,
+    #  :canvas,
+    #  :audio,
+    #  :video].each do |tag|
+    #    define_method("#{tag.to_s}_element") do |*identifier|
+    #      self.send "#{tag.to_s}_for", locator(identifier)
+    #    end
+    #
+    #    define_method("#{tag.to_s}_elements") do |*identifier|
+    #      self.send "#{tag.to_s}s_for", locator(identifier)
+    #    end
+    #  end
+
+  end
+end

data/lib/druid/page_factory.rb

@@ -0,0 +1,115 @@
+require 'page_navigation'
+
+module Druid
+  #
+  # Module to facilitate to creating of page objects in step definitions.  You
+  # can make the methods below available to all of your step definitions by adding
+  # this module to World.  This idea was first discussed in Alister Scott's blog
+  # entry http://watirmelon.com/2011/06/07/removing-local-page-references-from-cucumber-steps/.
+  #
+  # @example Making the PageFactory available to your step definitions
+  #   World Druid::PageFactory
+  #
+  # @example Visiting a page for the first time in a Scenario
+  #   visit_page MyPageObject do |page|
+  #     page.name = 'Tim'
+  #   end
+  #
+  # @example using a page that has already been visited in a Scenario
+  #   on_page MyPageObject do |page|
+  #     page.name.should == 'Tim'
+  #   end
+  #
+  # If you plan to use the navigate_to method you will need to ensure you setup the possible
+  # routes ahead of time. You must always have a default route in order for this to work. Here
+  # is an example of how you define routes:
+  #
+  # @example Example routes defined in env.rb
+  #  Druid::PageFactory.routes = {
+  #    :default => [[PageOne,:method1], [PageTwoA,:method2], [PageThree,:method3],
+  #    :another_route => [[PageOne,:method1,"arg1"], [PageTwoB,:method2b], [PageThree,:method3]]
+  #   }
+  # Notice the first entry of :another_route is passing an argument
+  # to the method
+  # You must also call the navigation_method on each page.
+  module PageFactory
+    include PageNavigation
+    # attr_accessor :page
+    #
+    # Create and navigate to a page object.  The navigation will only work if the
+    # 'page_url' method was call on the page object.
+    #
+    # @param [PageObject, String] a class that has included the
+    # Druid module or a string containing the name of the class
+    # @param Hash values that is pass through to page class a
+    # available in the @params instance variable
+    # @param an optional block to be called
+    # @return [PageObject] the newly created page object
+    #
+    def visit_page(page_class, params={:using_params => {}}, &block)
+      on_page page_class, params, true, &block
+    end
+
+    # Support 'visit' for readability of usage
+    alias_method :visit, :visit_page
+    #
+    # Create a page object.
+    #
+    # @param [PageObject, String] a class that has included the Druid module or a string containing the name of the class
+    # @param  Hash values that is pass through to page class a
+    # available in the @params instance variable.
+    # @param [Bool] should the page be visited?  default is false.
+    # @param an optional block to be called
+    # @return [PageObject] the newly created page object
+    #
+    def on_page(page_class, params={:using_params => {}}, visit=false, &block)
+      page_class = class_from_string(page_class) if page_class.is_a? String
+      return super(page_class, params, visit, &block) unless page_class.ancestors.include? Druid
+      merged = page_class.params.merge(params[:using_params])
+      page_class.instance_variable_set("@merged_params", merged) unless merged.empty?
+      @current_page = page_class.new(@driver, visit)
+      block.call @current_page if block
+      @current_page
+    end
+
+    # Support 'on' for readability of usage
+    alias_method :on, :on_page
+
+    #
+    # Create a page object if and only if the current page is the same page to be created
+    #
+    # @example
+    #  original:
+    #   on_page(NewProduct).save if @current_page.class == NewProduct
+    #   on_page(EditProduct).save if @current_page.class == EditProduct
+    #  new:
+    #   if_page NewProduct do |page|
+    #      page.save
+    #   end
+    #   if_page EditProduct do |page|
+    #      page.update
+    #   end
+    # @param [PageObject, String] a class that has included the Druid module or a string containing the name of the class
+    # @param Hash values that is pass through to page class a
+    # available in the @params instance variable
+    # @param [block] an optional block to be called
+    # @return [PageObject] the newly created page object
+    def if_page(page_class, params={:using_params => {}}, &block)
+      page_class = class_from_string(page_class) if page_class.is_a? String
+      return @current_page unless @current_page.class == page_class
+      on_page(page_class, params, false, &block)
+    end
+
+    # support 'if' for readability of usage
+    alias_method :if, :if_page
+
+    private
+
+    def class_from_string(str)
+      str.split('::').inject(Object) do |mod, class_name|
+        mod.const_get(class_name)
+      end
+    end
+
+  end
+end

data/lib/druid/page_populator.rb

@@ -0,0 +1,104 @@
+module Druid
+  module PagePopulator
+    #
+    # This method will populate all matched page TextFields,
+    # TextAreas, SelectLists, FileFields, Checkboxes, and Radio Buttons from the
+    # Hash passed as an argument.  The way it find an element is by
+    # matching the Hash key to the name you provided when declaring
+    # the element on your page.
+    #
+    # Checkbox and Radio Button values must be true or false.
+    #
+    # @example
+    #   class ExamplePage
+    #     include PageObject
+    #
+    #     text_field(:username, :id => 'username_id')
+    #     checkbox(:active, :id => 'active_id')
+    #   end
+    #
+    #   ...
+    #
+    #   @browser = Watir::Browser.new :firefox
+    #   example_page = ExamplePage.new(@browser)
+    #   example_page.populate_page_with :username => 'a name', :active => true
+    #
+    # @param data [Hash] the data to use to populate this page.  The key
+    # can be either a string or a symbol.  The value must be a string
+    # for TextField, TextArea, SelectList and FileField must be true or
+    # false for a Checkbox or RadioButton.
+    #
+    def populate_page_with(data)
+      data.to_h.each do |key, value|
+        populate_section(key, value) if value.respond_to?(:to_h)
+        populate_value(self, key, value)
+      end
+    end
+
+    private
+
+    def populate_section(section, data)
+      return unless self.respond_to? section
+      data.to_h.each do |key, value|
+        populate_value(self.send(section), key, value)
+      end
+    end
+
+    def populate_value(receiver, key, value)
+      populate_checkbox(receiver, key, value) if is_checkbox?(receiver, key) and is_enabled?(receiver, key)
+      populate_radiobuttongroup(receiver, key, value) if is_radiobuttongroup?(receiver, key)
+      populate_radiobutton(receiver, key, value) if is_radiobutton?(receiver, key) and is_enabled?(receiver, key)
+      populate_select_list(receiver, key, value) if is_select_list?(receiver, key)
+      populate_text(receiver, key, value) if is_text?(receiver, key) and is_enabled?(receiver, key)
+    end
+
+    def populate_text(receiver, key, value)
+      receiver.send "#{key}=", value
+    end
+
+    def populate_checkbox(receiver, key, value)
+      return receiver.send "check_#{key}" if value
+      return receiver.send "uncheck_#{key}"
+    end
+
+    def populate_radiobutton(receiver, key, value)
+      return receiver.send "select_#{key}" if value
+    end
+
+    def populate_radiobuttongroup(receiver, key, value)
+      return receiver.send "select_#{key}", value
+    end
+
+    def populate_select_list(receiver, key, value)
+      receiver.send "#{key}=", value
+    end
+
+    def is_text?(receiver, key)
+      return false if is_select_list?(receiver, key)
+      receiver.respond_to?("#{key}=".to_sym)
+    end
+
+    def is_checkbox?(receiver, key)
+      receiver.respond_to?("check_#{key}".to_sym)
+    end
+
+    def is_radiobutton?(receiver, key)
+      receiver.respond_to?("select_#{key}".to_sym)
+    end
+
+    def is_radiobuttongroup?(receiver, key)
+      receiver.respond_to?("select_#{key}".to_sym) and receiver.respond_to?("#{key}_values")
+    end
+
+    def is_select_list?(receiver, key)
+      receiver.respond_to?("#{key}_options".to_sym)
+    end
+
+    def is_enabled?(receiver, key)
+      return false if is_radiobuttongroup?(receiver, key)
+      return true if (receiver.send "#{key}_element").tag_name == "textarea"
+      element = receiver.send("#{key}_element")
+      element.enabled? and element.present?
+    end
+  end
+end

data/lib/druid/section_collection.rb

@@ -0,0 +1,17 @@
+module Druid
+  class SectionCollection < Array
+
+    def find_by values_hash
+      find do |section|
+        values_hash.all? { |key, value| value === section.public_send(key) }
+      end
+    end
+
+    def select_by values_hash
+      matches = select do |section|
+        values_hash.all? { |key, value| value === section.public_send(key) }
+      end
+      self.class[*matches]
+    end
+  end
+end

data/lib/druid/version.rb

@@ -0,0 +1,3 @@
+module Druid
+  VERSION = "1.0.0"
+end