oki-celerity 0.8.1.dev

data/lib/celerity/input_element.rb

@@ -0,0 +1,25 @@
+module Celerity
+  class InputElement < Element
+    include ClickableElement
+    include DisabledElement
+
+    ATTRIBUTES = BASE_ATTRIBUTES | [:type, :name, :value, :checked, :disabled, :readonly, :size, :maxlength,
+                                    :src, :alt, :usemap, :ismap, :tabindex, :accesskey, :onfocus, :onblur,
+                                    :onselect, :onchange, :accept, :align]
+
+    def readonly?
+      assert_exists
+      @object.hasAttribute 'readonly'
+    end
+
+    private
+
+    def assert_not_readonly
+      if readonly?
+        raise ObjectReadOnlyException,
+          "InputElement #{identifier_string} is read only."
+      end
+    end
+
+  end
+end

data/lib/celerity/javascript_debugger.rb

@@ -0,0 +1,32 @@
+module Celerity
+  class JavascriptDebugger
+    include Java::net.sourceforge.htmlunit.corejs.javascript.debug.Debugger
+
+    def handleCompilationDone(ctx, script, source)
+      p debug_info_for(script).merge(:source_code => source)
+    end
+
+    def getFrame(ctx, script)
+      p debug_info_for(script)
+    end
+
+    private
+
+    def string_for_context(ctx)
+      ctx.toString
+    end
+
+    def string_for_script(script)
+      script.toString
+    end
+
+    def debug_info_for(script)
+      {
+        :source        => "#{script.getSourceName}:#{script.getLineNumbers.to_a.join(",")}",
+        :function_name => script.getFunctionName,
+        :params        => (0...script.getParamAndVarCount).map { |idx| script.getParamOrVarName(idx) },
+        :function?     => script.isFunction,
+      }
+    end
+  end
+end

data/lib/celerity/listener.rb

@@ -0,0 +1,143 @@
+module Celerity
+
+  #
+  # This class is used to wrap some of the listeners available from HtmlUnit's WebClient.
+  #
+
+  class Listener
+    include com.gargoylesoftware.htmlunit.AlertHandler
+    include com.gargoylesoftware.htmlunit.ConfirmHandler
+    include com.gargoylesoftware.htmlunit.PromptHandler
+    include com.gargoylesoftware.htmlunit.html.HTMLParserListener
+    include com.gargoylesoftware.htmlunit.IncorrectnessListener
+    include com.gargoylesoftware.htmlunit.StatusHandler
+    include com.gargoylesoftware.htmlunit.WebWindowListener
+    include com.gargoylesoftware.htmlunit.attachment.AttachmentHandler
+
+    def initialize(webclient)
+      @webclient = webclient
+      @procs = Hash.new { |h, k| h[k] = [] }
+    end
+
+    #
+    # Add a listener block for one of the available types.
+    # @see Celerity::Browser#add_listener
+    #
+
+    def add_listener(type, &block)
+      case type
+      when :status
+        @webclient.setStatusHandler(self)
+      when :alert
+        @webclient.setAlertHandler(self)
+      when :attachment
+        @webclient.setAttachmentHandler(self)
+      when :web_window_event
+        @webclient.addWebWindowListener(self)
+      when :html_parser
+        @webclient.setHTMLParserListener(self)
+      when :incorrectness
+        @webclient.setIncorrectnessListener(self)
+      when :confirm
+        @webclient.setConfirmHandler(self)
+      when :prompt
+        @webclient.setPromptHandler(self)
+      else
+        raise ArgumentError, "unknown listener type #{type.inspect}"
+      end
+
+      @procs[type] << block
+    end
+
+    def remove_listener(type, proc_or_index)
+      unless @procs.has_key?(type)
+        raise ArgumentError, "unknown listener type #{type.inspect}"
+      end
+
+      procs = @procs[type]
+
+      case proc_or_index
+      when Fixnum
+        procs.delete_at proc_or_index
+      when Proc
+        procs.delete proc_or_index
+      else
+        raise TypeError, "must give proc or index"
+      end
+    end
+
+    #
+    # interface StatusHandler
+    #
+
+    def statusMessageChanged(page, message)
+      @procs[:status].each { |handler| handler.call(page, message) }
+    end
+
+    #
+    # interface AlertHandler
+    #
+
+    def handleAlert(page, message)
+      @procs[:alert].each { |handler| handler.call(page, message) }
+    end
+
+    #
+    # interface ConfirmHandler
+    #
+    # The returned value is determined by the last registered :confirm listener proc.
+    # If it is nil, return true, otherwise return that value as a boolean.
+    #
+    # @see Browser#confirm
+    #
+
+    def handleConfirm(page, message)
+      val = @procs[:confirm].map { |handler| handler.call(page, message) }.last
+      val.nil? || !!val
+    end
+
+    #
+    # interface AttachmentHandler
+    #
+
+    def handleAttachment(page)
+      @procs[:attachment].each { |handler| handler.call(page) }
+    end
+
+    #
+    # interface PromptHandler
+    #
+
+    def handlePrompt(page, message)
+      @procs[:prompt].each { |handler| handler.call(page, message) }
+    end
+
+    #
+    # interface WebWindowListener
+    #
+
+    def webWindowClosed(web_window_event)
+      @procs[:web_window_event].each { |handler| handler.call(web_window_event) }
+    end
+    alias_method :webWindowOpened, :webWindowClosed
+    alias_method :webWindowContentChanged, :webWindowClosed
+
+    #
+    # interface HTMLParserListener
+    #
+
+    def error(message, url, line, column, key)
+      @procs[:html_parser].each { |handler| handler.call(message, url, line, column, key) }
+    end
+    alias_method :warning, :error
+
+    #
+    # interface IncorrectnessListener
+    #
+
+    def notify(message, origin)
+      @procs[:incorrectness].each { |handler| handler.call(message, origin) }
+    end
+
+  end # Listener
+end # Celerity

data/lib/celerity/short_inspect.rb

@@ -0,0 +1,20 @@
+module Celerity
+  module ShortInspect
+
+    def short_inspect(opts)
+      if excluded_ivars = opts[:exclude]
+        ivars = (instance_variables - excluded_ivars)
+      elsif included_ivars = opts[:include]
+        ivars = included_ivars
+      else
+        raise ArgumentError, "unknown arg: #{opts.inspect}"
+      end
+
+      ivars.map! { |ivar| "#{ivar}=#{instance_variable_get(ivar).inspect}" }
+      '#<%s:0x%s %s>' % [self.class.name, self.hash.to_s(16), ivars.join(" ")]
+    end
+
+
+
+  end
+end

data/lib/celerity/util.rb

@@ -0,0 +1,129 @@
+module Celerity
+  module Util
+    module_function
+
+    HtmlUnit2CelerityElement = {
+      HtmlUnit::Html::HtmlAnchor                => Celerity::Link,
+      HtmlUnit::Html::HtmlArea                  => Celerity::Area,
+      HtmlUnit::Html::HtmlButton                => Celerity::Button,
+      HtmlUnit::Html::HtmlSubmitInput           => Celerity::Button,
+      HtmlUnit::Html::HtmlResetInput            => Celerity::Button,
+      HtmlUnit::Html::HtmlImageInput            => Celerity::Button,
+      HtmlUnit::Html::HtmlButtonInput           => Celerity::Button,
+      HtmlUnit::Html::HtmlCaption               => Celerity::Button, # ?
+      HtmlUnit::Html::HtmlCheckBoxInput         => Celerity::CheckBox,
+      HtmlUnit::Html::HtmlDefinitionDescription => Celerity::Dd,
+      HtmlUnit::Html::HtmlDefinitionList        => Celerity::Dl,
+      HtmlUnit::Html::HtmlDefinitionTerm        => Celerity::Dt,
+      HtmlUnit::Html::HtmlDeletedText           => Celerity::Del,
+      HtmlUnit::Html::HtmlDivision              => Celerity::Div,
+      HtmlUnit::Html::HtmlFileInput             => Celerity::FileField,
+      HtmlUnit::Html::HtmlForm                  => Celerity::Form,
+      HtmlUnit::Html::HtmlFrame                 => Celerity::Frame,
+      HtmlUnit::Html::HtmlHeading1              => Celerity::H1,
+      HtmlUnit::Html::HtmlHeading2              => Celerity::H2,
+      HtmlUnit::Html::HtmlHeading3              => Celerity::H3,
+      HtmlUnit::Html::HtmlHeading4              => Celerity::H4,
+      HtmlUnit::Html::HtmlHeading5              => Celerity::H5,
+      HtmlUnit::Html::HtmlHeading6              => Celerity::H6,
+      HtmlUnit::Html::HtmlHiddenInput           => Celerity::Hidden,
+      HtmlUnit::Html::HtmlImage                 => Celerity::Image,
+      HtmlUnit::Html::HtmlLabel                 => Celerity::Label,
+      HtmlUnit::Html::HtmlListItem              => Celerity::Li,
+      HtmlUnit::Html::HtmlMap                   => Celerity::Map,
+      HtmlUnit::Html::HtmlOption                => Celerity::Option,
+      HtmlUnit::Html::HtmlOrderedList           => Celerity::Ol,
+      HtmlUnit::Html::HtmlParagraph             => Celerity::P,
+      HtmlUnit::Html::HtmlPasswordInput         => Celerity::TextField,
+      HtmlUnit::Html::HtmlPreformattedText      => Celerity::Pre,
+      HtmlUnit::Html::HtmlRadioButtonInput      => Celerity::Radio,
+      HtmlUnit::Html::HtmlSelect                => Celerity::SelectList,
+      HtmlUnit::Html::HtmlSpan                  => Celerity::Span,
+      HtmlUnit::Html::HtmlTable                 => Celerity::Table,
+      HtmlUnit::Html::HtmlTableBody             => Celerity::TableBody,
+      HtmlUnit::Html::HtmlTableCell             => Celerity::TableCell,
+      HtmlUnit::Html::HtmlTableDataCell         => Celerity::TableCell,
+      HtmlUnit::Html::HtmlTableFooter           => Celerity::TableFooter,
+      HtmlUnit::Html::HtmlTableHeader           => Celerity::TableHeader,
+      HtmlUnit::Html::HtmlTableRow              => Celerity::TableRow,
+      HtmlUnit::Html::HtmlTextArea              => Celerity::TextField,
+      HtmlUnit::Html::HtmlTextInput             => Celerity::TextField,
+      HtmlUnit::Html::HtmlUnorderedList         => Celerity::Ul,
+      HtmlUnit::Html::HtmlInsertedText          => Celerity::Ins
+    }
+
+    def htmlunit2celerity(klass)
+      HtmlUnit2CelerityElement[klass]
+    end
+
+    #
+    # HtmlUnit will recognize most common file types, but custom ones can be added here.
+    # Used for FileField uploads.
+    #
+
+    ContentTypes = {
+      ".bmp" => "image/x-ms-bmp",
+      ".doc" => "application/msword",
+      ".odg" => "application/vnd.oasis.opendocument.graphics",
+      ".odp" => "application/vnd.oasis.opendocument.presentation",
+      ".ods" => "application/vnd.oasis.opendocument.spreadsheet",
+      ".odt" => "application/vnd.oasis.opendocument.text",
+      ".ppt" => "application/vnd.ms-powerpoint",
+      ".xls" => "application/vnd.ms-excel",
+    }
+
+    def content_type_for(path)
+      if ct = java.net.URLConnection.getFileNameMap.getContentTypeFor(path)
+        return ct
+      else
+        ContentTypes[File.extname(path).downcase]
+      end
+    end
+
+    def normalize_text(string)
+      string.gsub("\302\240", ' '). # non-breaking space 00A0
+             gsub(/\n|\t/, '').     # get rid of newlines/tabs
+             strip
+    end
+
+    def logger_for(package_string)
+      java.util.logging.Logger.getLogger(package_string)
+    end
+
+    # number of spaces that separate the property from the value in the create_string method
+    TO_S_SIZE = 14
+
+    def create_string(element)
+      ret = []
+
+      unless (tag = element.getTagName).empty?
+        ret << "tag:".ljust(TO_S_SIZE) + tag
+      end
+
+      element.getAttributes.each do |attribute|
+        ret << "  #{attribute.getName}:".ljust(TO_S_SIZE + 2) + attribute.getValue.to_s
+      end
+
+      unless (text = element.asText).empty?
+        ret << "  text:".ljust(TO_S_SIZE + 2) + element.asText
+      end
+
+      ret.join("\n")
+    end
+
+    #
+    # Used internally.
+    #
+    # @param [String] string The string to match against.
+    # @param [Regexp, String, #to_s] what The match we're looking for.
+    # @return [Fixnum, true, false, nil]
+    #
+    # @api private
+    #
+
+    def matches?(string, what)
+      Regexp === what ? string.strip =~ what : string == what.to_s
+    end
+
+  end
+end

data/lib/celerity/version.rb

@@ -0,0 +1,3 @@
+module Celerity
+  VERSION = "0.8.1.dev"
+end

data/lib/celerity/viewer_connection.rb

@@ -0,0 +1,89 @@
+module Celerity
+  class ViewerConnection
+
+    #
+    # Create a new connection to the given host/port
+    #
+
+    def self.create(host, port)
+      # if the connection fails, we won't spend time loading json
+      socket = TCPSocket.new(host, port)
+      require "json"
+      new(socket)
+    end
+
+    def initialize(socket)
+      @socket = socket
+    end
+
+    #
+    # Tells the viewer to render the given HTML, with the given URL as base url.
+    #
+
+    def render_html(html, url)
+      send_data('method' => 'page_changed', 'html' => html, 'url' => url)
+    end
+
+    #
+    # Tells the viewer to save a screenshot of the current page to the given path.
+    # May not be available on all viewers.
+    #
+
+    def save(path)
+      send_data('method' => 'save', 'path' => path)
+    end
+
+
+    #
+    # Tells the viewer to dump the render tree to the given path.
+    # Only available in the Qt viewer.
+    #
+
+    def save_render_tree(path)
+      send_data('method' => 'save_render_tree', 'path' => path)
+    end
+
+    #
+    # Get the currently rendered page as a Base64-encoded PNG image.
+    # Only available in the Qt viewer.
+    #
+
+    def image_data
+      send_data('method' => 'image_data')
+      data = read_data
+      data['image'] || data['error']
+    end
+
+    #
+    # Close the connection.
+    #
+
+    def close
+      @socket.close rescue nil
+    end
+
+    private
+
+    def send_data(msg)
+      json = msg.to_json
+      data = "Content-Length: #{json.size}\n\n#{json}"
+      @socket.write data
+      @socket.flush
+
+      nil
+    end
+
+    def read_data
+      buf = ''
+      until buf =~ /\n\n\z/ || @socket.eof? || @socket.closed?
+        buf << @socket.read(1).to_s
+      end
+
+      return if buf.empty?
+
+      length = buf[/Content-Length: (\d+)/, 1].to_i
+      JSON.parse @socket.read(length)
+    end
+
+  end
+end

data/lib/celerity/watir_compatibility.rb

@@ -0,0 +1,70 @@
+module Celerity
+  class Browser
+    class << self
+
+      # Added for Watir compatibility - not in use by Celerity
+      attr_accessor :speed, :attach_timeout, :visible
+      # Added for Watir compatibility - not in use by Celerity
+      alias_method :start_window, :start
+      # Added for Watir compatibility - not in use by Celerity
+      def each; end
+    end
+
+    # Added for Watir compatibility - not in use by Celerity
+    attr_accessor :visible
+
+    # Added for Watir compatibility - not in use by Celerity
+    def bring_to_front; true; end
+    # Added for Watir compatibility - not in use by Celerity
+    def speed=(s); s end
+  end
+
+
+  module ClickableElement
+    alias_method :click_no_wait,    :click
+  end
+
+  module Container
+    alias_method :checkbox,         :check_box
+    alias_method :checkBox,         :check_box
+    alias_method :body,             :tbody
+    alias_method :bodies,           :tbodies
+  end
+
+  class Element
+    alias_method :exists,           :exists?
+    alias_method :innerText,        :text
+    alias_method :inner_text,       :text
+  end
+
+  class Image
+    alias_method :hasLoaded?,       :loaded?
+    alias_method :fileSize,         :file_size
+    alias_method :fileCreatedDate,  :file_created_date
+  end
+
+   class Link
+     alias_method :click_no_wait,   :click
+   end
+
+  class RadioCheckCommon
+    alias_method :isSet?,           :set?
+    alias_method :getState,         :set?
+  end
+
+  class SelectList
+    alias_method :getSelectedItems, :selected_options
+    alias_method :getAllContents,   :options
+    alias_method :clearSelection,   :clear
+    alias_method :includes?,        :include?
+  end
+
+  class TextField
+    alias_method :dragContentsTo,   :drag_contents_to
+    alias_method :getContents,      :value
+
+    def requires_typing; end
+  end
+end
+
+Celerity::IE = Celerity::Browser

data/lib/celerity/xpath_support.rb

@@ -0,0 +1,52 @@
+module Celerity
+
+  #
+  # Module to search by xpath
+  #
+
+  module XpathSupport
+
+    #
+    # Get the first element found matching the given XPath.
+    #
+    # @param [String] xpath
+    # @return [Celerity::Element] An element subclass (or Element if none is found)
+    #
+
+    def element_by_xpath(xpath)
+      assert_exists
+      obj = @page.getFirstByXPath(xpath)
+      element_from_dom_node(obj)
+    end
+
+    #
+    # Get all the elements matching the given XPath.
+    #
+    # @param [String] xpath
+    # @return [Array<Celerity::Element>] array of elements
+    #
+
+    def elements_by_xpath(xpath)
+      assert_exists
+      objects = @page.getByXPath(xpath)
+      # should use an ElementCollection here?
+      objects.map { |o| element_from_dom_node(o) }.compact
+    end
+
+    #
+    # Convert the given HtmlUnit DomNode to a Celerity object
+    #
+
+    def element_from_dom_node(obj)
+      element_class = Util.htmlunit2celerity(obj.class) || Element
+      element = element_class.new(self, :object, obj)
+
+      element.extend(ClickableElement) unless element.is_a?(ClickableElement)
+
+      element
+    end
+
+
+  end
+
+end

data/lib/celerity.rb

@@ -0,0 +1,77 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+raise "Celerity only works on JRuby at the moment." unless RUBY_PLATFORM =~ /java/
+
+require "java"
+require "logger"
+require "uri"
+require "pp"
+require "timeout"
+require "time"
+require "socket"
+require "fileutils"
+require "thread"
+
+module Celerity
+  Log = Logger.new($DEBUG ? $stderr : nil)
+  Log.level = Logger::DEBUG
+
+  @index_offset = 1
+  class << self
+
+    #
+    # This index_offset attribute controls the indexing used when locating
+    # elements by :index or fetching from Celerity::ElementCollections.
+    #
+    # By default it is set to 1 for Watir compatibility, but users who use
+    # Celerity exlusively may want it set to 0 to make Celerity more consistent with Ruby.
+    #
+    attr_accessor :index_offset
+  end
+
+  DIR = File.expand_path(File.dirname(__FILE__) + "/celerity")
+end
+
+require "celerity/version"
+require "celerity/htmlunit"
+require "celerity/exception"
+require "celerity/clickable_element"
+require "celerity/disabled_element"
+require "celerity/element_collection"
+require "celerity/collections"
+require "celerity/element_locator"
+require "celerity/identifier"
+require "celerity/short_inspect"
+require "celerity/container"
+require "celerity/xpath_support"
+require "celerity/element"
+require "celerity/input_element"
+require "celerity/elements/non_control_elements"
+require "celerity/elements/button"
+require "celerity/elements/file_field"
+require "celerity/elements/form"
+require "celerity/elements/frame"
+require "celerity/elements/image"
+require "celerity/elements/label"
+require "celerity/elements/link"
+require "celerity/elements/meta"
+require "celerity/elements/option"
+require "celerity/elements/radio_check"
+require "celerity/elements/select_list"
+require "celerity/elements/table"
+require "celerity/elements/table_elements"
+require "celerity/elements/table_cell"
+require "celerity/elements/table_row"
+require "celerity/elements/text_field"
+require "celerity/util"
+require "celerity/default_viewer"
+require "celerity/listener"
+require "celerity/ignoring_web_connection"
+require "celerity/javascript_debugger"
+require "celerity/viewer_connection"
+require "celerity/browser"
+require "celerity/watir_compatibility"
+
+# undefine deprecated methods to use them for Element attributes
+Object.send :undef_method, :id   if Object.method_defined? "id"
+Object.send :undef_method, :type if Object.method_defined? "type"

data/tasks/benchmark.rake

@@ -0,0 +1,4 @@
+desc "Run benchmark scripts"
+task :benchmark do
+  Dir[File.dirname(__FILE__) + "/../benchmark/*.rb"].each { |f| load f }
+end

data/tasks/check.rake

@@ -0,0 +1,24 @@
+namespace :check do
+  
+  desc 'Check syntax of all .rb files'
+  task :syntax do
+    failed = []
+    
+    Dir['**/*.rb'].each do |f|
+      begin
+        eval("lambda do\n return true\n #{File.read f} \nend").call
+        print "."
+      rescue SyntaxError => e
+        print "!"
+        failed <<  [f, e.message]
+      end
+    end
+    
+    if failed.empty?
+      puts "ok."
+    else
+      puts "\n\t#{failed.join("\n\t")}"
+    end
+  end
+  
+end

data/tasks/clean.rake

@@ -0,0 +1,3 @@
+require 'rake/clean'
+
+CLEAN.include "classes/", "pkg/", "doc/"