poltergeist 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 440dc77fc5ba49d78d8e7af8134da82b93a500cd
-  data.tar.gz: afc6fba6b9d6be96866c9810cb1b9a729dddc4a8
+  metadata.gz: 80b33a1ca12aebf206487179bd97bde02aaf2934
+  data.tar.gz: 4b1545c216c97fd54b9673516e5a7d854daf86d9
 SHA512:
-  metadata.gz: 704dea9cd5162c277fd8b5b9ee2f816beec71d4deabd64616a7ebe87d64d6c8a922a9fd9ba1d9b71b05be8b28eeaacc6aad225140ee47be19c4d8c1536726eb6
-  data.tar.gz: 6ba1c737813c8a09c47a51e31032626ad21e251f1de4a7e05e758057d99702720313950c307d04b458be52ffc665eae5e892ac256e536afdf4baf399bf37b5df
+  metadata.gz: 27e4dbb8868f7dfc18daaec1beae92d7afef23c61d4b720fa4a1f9f6352a1d0eb8909053a0a5c920103507ef1a135965061a3874b74c649554823004cc655459
+  data.tar.gz: cb0ed5f12f3cddd189277ee37802fc45b2fc9f157a41812882d14da9de21a135d699a4ffd6d6441919206305b60ee650766e514db2e6fc83d49953cbd27c33f5

data/README.md

@@ -9,7 +9,7 @@ provided by [PhantomJS](http://phantomjs.org/).
 **If you're viewing this at https://github.com/teampoltergeist/poltergeist,
 you're reading the documentation for the master branch.
 [View documentation for the latest release
-(1.7.0).](https://github.com/teampoltergeist/poltergeist/tree/v1.7.0)**
+(1.8.0).](https://github.com/teampoltergeist/poltergeist/tree/v1.8.0)**
 
 ## Getting help ##
 

data/lib/capybara/poltergeist/browser.rb

@@ -1,4 +1,5 @@
 require "capybara/poltergeist/errors"
+require "capybara/poltergeist/command"
 require 'multi_json'
 require 'time'
 
@@ -78,6 +79,10 @@ module Capybara::Poltergeist
       command 'delete_text', page_id, id
     end
 
+    def property(page_id, id, name)
+      command 'property', page_id, id, name.to_s
+    end
+
     def attributes(page_id, id)
       command 'attributes', page_id, id
     end
@@ -124,7 +129,7 @@ module Capybara::Poltergeist
 
     def within_frame(handle, &block)
       if handle.is_a?(Capybara::Node::Base)
-        command 'push_frame', handle[:name] || handle[:id]
+        command 'push_frame', [handle.native.page_id, handle.native.id]
       else
         command 'push_frame', handle
       end
@@ -154,11 +159,17 @@ module Capybara::Poltergeist
       command 'close_window', handle
     end
 
-    def within_window(name, &block)
+    def find_window_handle(locator)
+      return locator if window_handles.include? locator
+
+      handle = command 'window_handle', locator
+      raise noSuchWindowError unless handle
+      return handle
+    end
+
+    def within_window(locator, &block)
       original = window_handle
-      handle = command 'window_handle', name
-      handle = name if handle.nil? && window_handles.include?(name)
-      raise NoSuchWindowError unless handle
+      handle = find_window_handle(locator)
       switch_to_window(handle)
       yield
     ensure
@@ -322,10 +333,10 @@ module Capybara::Poltergeist
     end
 
     def command(name, *args)
-      message = JSON.dump({ 'name' => name, 'args' => args })
-      log message
+      cmd = Command.new(name, *args)
+      log cmd.message
 
-      response = server.send(message)
+      response = server.send(cmd)
       log response
 
       json = JSON.load(response)

data/lib/capybara/poltergeist/client/agent.coffee

@@ -1,6 +1,10 @@
 # This is injected into each page that is loaded
 
 class PoltergeistAgent
+  # Since this code executes in the sites browser space - copy needed JSON functions
+  # in case user code messes with JSON (early mootools for instance)
+  @.JSON ||= { parse: JSON.parse, stringify: JSON.stringify }
+
   constructor: ->
     @elements = []
     @nodes    = {}
@@ -13,7 +17,7 @@ class PoltergeistAgent
 
   @stringify: (object) ->
     try
-      JSON.stringify object, (key, value) ->
+      PoltergeistAgent.JSON.stringify object, (key, value) ->
         if Array.isArray(this[key])
           return this[key]
         else
@@ -120,6 +124,8 @@ class PoltergeistAgent.Node
     # from the parent SELECT
     if @element.nodeName == 'OPTION'
       element = @element.parentNode
+      element = element.parentNode if element.nodeName == 'OPTGROUP'
+      element
     else
       element = @element
 
@@ -172,9 +178,12 @@ class PoltergeistAgent.Node
     window.getSelection().addRange(range)
     window.getSelection().deleteFromDocument()
 
+  getProperty: (name) ->
+    @element[name]
+
   getAttributes: ->
     attrs = {}
-    for attr, i in @element.attributes
+    for attr in @element.attributes
       attrs[attr.name] = attr.value.replace("\n","\\n");
     attrs
 
@@ -186,6 +195,10 @@ class PoltergeistAgent.Node
 
   scrollIntoView: ->
     @element.scrollIntoViewIfNeeded()
+    #Sometimes scrollIntoViewIfNeeded doesn't seem to work, not really sure why.
+    #Just calling scrollIntoView doesnt work either, however calling scrollIntoView
+    #after scrollIntoViewIfNeeded when element is not in the viewport does appear to work
+    @element.scrollIntoView() unless this.isInViewport()
 
   value: ->
     if @element.tagName == 'SELECT' && @element.multiple
@@ -199,8 +212,8 @@ class PoltergeistAgent.Node
     if (@element.maxLength >= 0)
       value = value.substr(0, @element.maxLength)
 
-    @element.value = ''
     this.trigger('focus')
+    @element.value = ''
 
     if @element.type == 'number'
       @element.value = value
@@ -244,14 +257,24 @@ class PoltergeistAgent.Node
     @element.tagName
 
   isVisible: (element) ->
-    element = @element unless element
+    element ||= @element
 
-    if window.getComputedStyle(element).display == 'none'
-      false
-    else if element.parentElement
-      this.isVisible element.parentElement
-    else
-      true
+    while (element)
+      style = window.getComputedStyle(element)
+      return false if style.display == 'none' or
+                      style.visibility == 'hidden' or
+                      parseFloat(style.opacity) == 0
+      element = element.parentElement
+
+    return true
+
+  isInViewport: ->
+    rect = @element.getBoundingClientRect();
+
+    rect.top >= 0 &&
+    rect.left >= 0 &&
+    rect.bottom <= window.innerHeight &&
+    rect.right <= window.innerWidth
 
   isDisabled: ->
     @element.disabled || @element.tagName == 'OPTION' && @element.parentNode.disabled
@@ -340,12 +363,14 @@ class PoltergeistAgent.Node
         el = el.parentNode
 
     { status: 'failure', selector: origEl && this.getSelector(origEl) }
-
   getSelector: (el) ->
     selector = if el.tagName != 'HTML' then this.getSelector(el.parentNode) + ' ' else ''
     selector += el.tagName.toLowerCase()
     selector += "##{el.id}" if el.id
-    for className in el.classList
+
+    #PhantomJS < 2.0 doesn't support classList for SVG elements - so get classes manually
+    classes = el.classList || (el.getAttribute('class')?.trim()?.split(/\s+/)) || []
+    for className in classes when className != ''
       selector += ".#{className}"
     selector
 

data/lib/capybara/poltergeist/client/browser.coffee

@@ -1,5 +1,5 @@
 class Poltergeist.Browser
-  constructor: (@owner, width, height) ->
+  constructor: (width, height) ->
     @width      = width || 1024
     @height     = height || 768
     @pages      = []
@@ -57,9 +57,10 @@ class Poltergeist.Browser
   getPageByHandle: (handle) ->
     @pages.filter((p) -> !p.closed && p.handle == handle)[0]
 
-  runCommand: (name, args) ->
+  runCommand: (command) ->
+    @current_command = command
     @currentPage.state = 'default'
-    this[name].apply(this, args)
+    this[command.name].apply(this, command.args)
 
   debug: (message) ->
     if @_debug
@@ -68,18 +69,9 @@ class Poltergeist.Browser
   setModalMessage: (msg) ->
     @processed_modal_messages.push(msg)
 
-  sendResponse: (response) ->
-    errors = @currentPage.errors
-    @currentPage.clearErrors()
-
-    if errors.length > 0 && @js_errors
-      @owner.sendError(new Poltergeist.JavascriptError(errors))
-    else
-      @owner.sendResponse(response)
-
   add_extension: (extension) ->
     @currentPage.injectExtension extension
-    this.sendResponse 'success'
+    @current_command.sendResponse 'success'
 
   node: (page_id, id) ->
     if @currentPage.id == page_id
@@ -88,6 +80,7 @@ class Poltergeist.Browser
       throw new Poltergeist.ObsoleteNode
 
   visit: (url) ->
+
     @currentPage.state = 'loading'
     #reset modal processing state when changing page
     @processed_modal_messages = []
@@ -105,59 +98,63 @@ class Poltergeist.Browser
     if /#/.test(url) && prevUrl.split('#')[0] == url.split('#')[0]
       # Hash change occurred, so there will be no onLoadFinished
       @currentPage.state = 'default'
-      this.sendResponse(status: 'success')
+      @current_command.sendResponse(status: 'success')
     else
+      command = @current_command
       @currentPage.waitState 'default', =>
         if @currentPage.statusCode == null && @currentPage.status == 'fail'
-          @owner.sendError(new Poltergeist.StatusFailError)
+          command.sendError(new Poltergeist.StatusFailError(url))
         else
-          this.sendResponse(status: @currentPage.status)
+          command.sendResponse(status: @currentPage.status)
 
   current_url: ->
-    this.sendResponse @currentPage.currentUrl()
+    @current_command.sendResponse @currentPage.currentUrl()
 
   status_code: ->
-    this.sendResponse @currentPage.statusCode
+    @current_command.sendResponse @currentPage.statusCode
 
   body: ->
-    this.sendResponse @currentPage.content()
+    @current_command.sendResponse @currentPage.content()
 
   source: ->
-    this.sendResponse @currentPage.source
+    @current_command.sendResponse @currentPage.source
 
   title: ->
-    this.sendResponse @currentPage.title()
+    @current_command.sendResponse @currentPage.title()
 
   find: (method, selector) ->
-    this.sendResponse(page_id: @currentPage.id, ids: @currentPage.find(method, selector))
+    @current_command.sendResponse(page_id: @currentPage.id, ids: @currentPage.find(method, selector))
 
   find_within: (page_id, id, method, selector) ->
-    this.sendResponse this.node(page_id, id).find(method, selector)
+    @current_command.sendResponse this.node(page_id, id).find(method, selector)
 
   all_text: (page_id, id) ->
-    this.sendResponse this.node(page_id, id).allText()
+    @current_command.sendResponse this.node(page_id, id).allText()
 
   visible_text: (page_id, id) ->
-    this.sendResponse this.node(page_id, id).visibleText()
+    @current_command.sendResponse this.node(page_id, id).visibleText()
 
   delete_text: (page_id, id) ->
-    this.sendResponse this.node(page_id, id).deleteText()
+    @current_command.sendResponse this.node(page_id, id).deleteText()
+
+  property: (page_id, id, name) ->
+    @current_command.sendResponse this.node(page_id, id).getProperty(name)
 
   attribute: (page_id, id, name) ->
-    this.sendResponse this.node(page_id, id).getAttribute(name)
+    @current_command.sendResponse this.node(page_id, id).getAttribute(name)
 
   attributes: (page_id, id, name) ->
-    this.sendResponse this.node(page_id, id).getAttributes()
+    @current_command.sendResponse this.node(page_id, id).getAttributes()
 
   parents: (page_id, id) ->
-    this.sendResponse this.node(page_id, id).parentIds()
+    @current_command.sendResponse this.node(page_id, id).parentIds()
 
   value: (page_id, id) ->
-    this.sendResponse this.node(page_id, id).value()
+    @current_command.sendResponse this.node(page_id, id).value()
 
   set: (page_id, id, value) ->
     this.node(page_id, id).set(value)
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   # PhantomJS only allows us to reference the element by CSS selector, not XPath,
   # so we have to add an attribute to the element to identify it, then remove it
@@ -168,56 +165,71 @@ class Poltergeist.Browser
     @currentPage.beforeUpload(node.id)
     @currentPage.uploadFile('[_poltergeist_selected]', value)
     @currentPage.afterUpload(node.id)
-
-    this.sendResponse(true)
+    if phantom.version.major == 2
+      # In phantomjs 2 - uploadFile only fully works if executed within a user action
+      # It does however setup the filenames to be uploaded, so if we then click on the
+      # file input element the filenames will get set
+      @click(page_id, id)
+    else
+      @current_command.sendResponse(true)
 
   select: (page_id, id, value) ->
-    this.sendResponse this.node(page_id, id).select(value)
+    @current_command.sendResponse this.node(page_id, id).select(value)
 
   tag_name: (page_id, id) ->
-    this.sendResponse this.node(page_id, id).tagName()
+    @current_command.sendResponse this.node(page_id, id).tagName()
 
   visible: (page_id, id) ->
-    this.sendResponse this.node(page_id, id).isVisible()
+    @current_command.sendResponse this.node(page_id, id).isVisible()
 
   disabled: (page_id, id) ->
-    this.sendResponse this.node(page_id, id).isDisabled()
+    @current_command.sendResponse this.node(page_id, id).isDisabled()
 
   path: (page_id, id) ->
-    this.sendResponse this.node(page_id, id).path()
+    @current_command.sendResponse this.node(page_id, id).path()
 
   evaluate: (script) ->
-    this.sendResponse @currentPage.evaluate("function() { return #{script} }")
+    @current_command.sendResponse @currentPage.evaluate("function() { return #{script} }")
 
   execute: (script) ->
     @currentPage.execute("function() { #{script} }")
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   frameUrl: (frame_name) ->
     @currentPage.frameUrl(frame_name)
 
-  push_frame: (name, timeout = new Date().getTime() + 2000) ->
+  pushFrame: (command, name, timeout) ->
+    if Array.isArray(name)
+      frame = this.node(name...)
+      name = frame.getAttribute('name') || frame.getAttribute('id')
+      unless name
+        frame.setAttribute('name', "_random_name_#{new Date().getTime()}")
+        name = frame.getAttribute('name')
+
     if @frameUrl(name) in @currentPage.blockedUrls()
-      this.sendResponse(true)
+      command.sendResponse(true)
     else if @currentPage.pushFrame(name)
       if @currentPage.currentUrl() == 'about:blank'
         @currentPage.state = 'awaiting_frame_load'
         @currentPage.waitState 'default', =>
-          this.sendResponse(true)
+          command.sendResponse(true)
       else
-        this.sendResponse(true)
+        command.sendResponse(true)
     else
       if new Date().getTime() < timeout
-        setTimeout((=> this.push_frame(name, timeout)), 50)
+        setTimeout((=> @pushFrame(command, name, timeout)), 50)
       else
-        @owner.sendError(new Poltergeist.FrameNotFound(name))
+        command.sendError(new Poltergeist.FrameNotFound(name))
+
+  push_frame: (name, timeout = (new Date().getTime()) + 2000) ->
+    @pushFrame(@current_command, name, timeout)
 
   pop_frame: ->
-    this.sendResponse(@currentPage.popFrame())
+    @current_command.sendResponse(@currentPage.popFrame())
 
   window_handles: ->
     handles = @pages.filter((p) -> !p.closed).map((p) -> p.handle)
-    this.sendResponse(handles)
+    @current_command.sendResponse(handles)
 
   window_handle: (name = null) ->
     handle = if name
@@ -226,31 +238,32 @@ class Poltergeist.Browser
     else
       @currentPage.handle
 
-    this.sendResponse(handle)
+    @current_command.sendResponse(handle)
 
   switch_to_window: (handle) ->
+    command = @current_command
     page = @getPageByHandle(handle)
     if page
       if page != @currentPage
         page.waitState 'default', =>
           @currentPage = page
-          this.sendResponse(true)
+          command.sendResponse(true)
       else
-        this.sendResponse(true)
+        command.sendResponse(true)
     else
       throw new Poltergeist.NoSuchWindowError
 
   open_new_window: ->
     this.execute 'window.open()'
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   close_window: (handle) ->
     page = @getPageByHandle(handle)
     if page
       page.release()
-      this.sendResponse(true)
+      @current_command.sendResponse(true)
     else
-      this.sendResponse(false)
+      @current_command.sendResponse(false)
 
   mouse_event: (page_id, id, name) ->
     # Get the node before changing state, in case there is an exception
@@ -262,14 +275,16 @@ class Poltergeist.Browser
 
     @last_mouse_event = node.mouseEvent(name)
 
+    command = @current_command
+
     setTimeout =>
       # If the state is still the same then navigation event won't happen
       if @currentPage.state == 'mouse_event'
         @currentPage.state = 'default'
-        this.sendResponse(position: @last_mouse_event)
+        command.sendResponse(position: @last_mouse_event)
       else
         @currentPage.waitState 'default', =>
-          this.sendResponse(position: @last_mouse_event)
+          command.sendResponse(position: @last_mouse_event)
     , 5
 
   click: (page_id, id) ->
@@ -286,30 +301,30 @@ class Poltergeist.Browser
 
   click_coordinates: (x, y) ->
     @currentPage.sendEvent('click', x, y)
-    this.sendResponse(click: { x: x, y: y })
+    @current_command.sendResponse(click: { x: x, y: y })
 
   drag: (page_id, id, other_id) ->
     this.node(page_id, id).dragTo this.node(page_id, other_id)
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   drag_by: (page_id, id, x, y) ->
     this.node(page_id, id).dragBy(x, y)
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   trigger: (page_id, id, event) ->
     this.node(page_id, id).trigger(event)
-    this.sendResponse(event)
+    @current_command.sendResponse(event)
 
   equals: (page_id, id, other_id) ->
-    this.sendResponse this.node(page_id, id).isEqual(this.node(page_id, other_id))
+    @current_command.sendResponse this.node(page_id, id).isEqual(this.node(page_id, other_id))
 
   reset: ->
     this.resetPage()
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   scroll_to: (left, top) ->
     @currentPage.setScrollPosition(left: left, top: top)
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   send_keys: (page_id, id, keys) ->
     target = this.node(page_id, id)
@@ -330,19 +345,19 @@ class Poltergeist.Browser
       else
         @currentPage.sendEvent('keypress', key)
 
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   render_base64: (format, full, selector = null)->
     this.set_clip_rect(full, selector)
     encoded_image = @currentPage.renderBase64(format)
-    this.sendResponse(encoded_image)
+    @current_command.sendResponse(encoded_image)
 
   render: (path, full, selector = null) ->
     dimensions = this.set_clip_rect(full, selector)
     @currentPage.setScrollPosition(left: 0, top: 0)
     @currentPage.render(path)
     @currentPage.setScrollPosition(left: dimensions.left, top: dimensions.top)
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   set_clip_rect: (full, selector) ->
     dimensions = @currentPage.validatedDimensions()
@@ -361,31 +376,31 @@ class Poltergeist.Browser
 
   set_paper_size: (size) ->
     @currentPage.setPaperSize(size)
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   set_zoom_factor: (zoom_factor) ->
     @currentPage.setZoomFactor(zoom_factor)
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   resize: (width, height) ->
     @currentPage.setViewportSize(width: width, height: height)
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   network_traffic: ->
-    this.sendResponse(@currentPage.networkTraffic())
+    @current_command.sendResponse(@currentPage.networkTraffic())
 
   clear_network_traffic: ->
     @currentPage.clearNetworkTraffic()
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   get_headers: ->
-    this.sendResponse(@currentPage.getCustomHeaders())
+    @current_command.sendResponse(@currentPage.getCustomHeaders())
 
   set_headers: (headers) ->
     # Workaround for https://code.google.com/p/phantomjs/issues/detail?id=745
     @currentPage.setUserAgent(headers['User-Agent']) if headers['User-Agent']
     @currentPage.setCustomHeaders(headers)
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   add_headers: (headers) ->
     allHeaders = @currentPage.getCustomHeaders()
@@ -398,40 +413,40 @@ class Poltergeist.Browser
     this.add_headers(header)
 
   response_headers: ->
-    this.sendResponse(@currentPage.responseHeaders())
+    @current_command.sendResponse(@currentPage.responseHeaders())
 
   cookies: ->
-    this.sendResponse(@currentPage.cookies())
+    @current_command.sendResponse(@currentPage.cookies())
 
   # We're using phantom.addCookie so that cookies can be set
   # before the first page load has taken place.
   set_cookie: (cookie) ->
     phantom.addCookie(cookie)
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   remove_cookie: (name) ->
     @currentPage.deleteCookie(name)
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   clear_cookies: () ->
     phantom.clearCookies()
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   cookies_enabled: (flag) ->
     phantom.cookiesEnabled = flag
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   set_http_auth: (user, password) ->
     @currentPage.setHttpAuth(user, password)
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   set_js_errors: (value) ->
     @js_errors = value
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   set_debug: (value) ->
     @_debug = value
-    this.sendResponse(true)
+    @current_command.sendResponse(true)
 
   exit: ->
     phantom.exit()
@@ -444,34 +459,36 @@ class Poltergeist.Browser
     throw new Error('zomg')
 
   go_back: ->
+    command = @current_command
     if @currentPage.canGoBack
       @currentPage.state = 'loading'
       @currentPage.goBack()
       @currentPage.waitState 'default', =>
-        this.sendResponse(true)
+        command.sendResponse(true)
     else
-      this.sendResponse(false)
+      command.sendResponse(false)
 
   go_forward: ->
+    command = @current_command
     if @currentPage.canGoForward
       @currentPage.state = 'loading'
       @currentPage.goForward()
       @currentPage.waitState 'default', =>
-        this.sendResponse(true)
+        command.sendResponse(true)
     else
-      this.sendResponse(false)
+      command.sendResponse(false)
 
   set_url_blacklist: ->
     @currentPage.urlBlacklist = Array.prototype.slice.call(arguments)
-    @sendResponse(true)
+    @current_command.sendResponse(true)
 
   set_confirm_process: (process) ->
     @confirm_processes.push process
-    @sendResponse(true)
+    @current_command.sendResponse(true)
 
   set_prompt_response: (response) ->
     @prompt_responses.push response
-    @sendResponse(true)
+    @current_command.sendResponse(true)
 
   modal_message: ->
-    @sendResponse(@processed_modal_messages.shift())
+    @current_command.sendResponse(@processed_modal_messages.shift())