capybara 3.0.0 → 3.40.0

data/lib/capybara/selenium/extensions/html5_drag.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+class Capybara::Selenium::Node
+  module Html5Drag
+    # Implement methods to emulate HTML5 drag and drop
+
+    def drag_to(element, html5: nil, delay: 0.05, drop_modifiers: [])
+      drop_modifiers = Array(drop_modifiers)
+
+      driver.execute_script MOUSEDOWN_TRACKER
+      scroll_if_needed { browser_action.click_and_hold(native).perform }
+      html5 = !driver.evaluate_script(LEGACY_DRAG_CHECK, self) if html5.nil?
+      if html5
+        perform_html5_drag(element, delay, drop_modifiers)
+      else
+        perform_legacy_drag(element, drop_modifiers)
+      end
+    end
+
+  private
+
+    def perform_legacy_drag(element, drop_modifiers)
+      element.scroll_if_needed do
+        # browser_action.move_to(element.native).release.perform
+        keys_down = modifiers_down(browser_action, drop_modifiers)
+        keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)
+        keys_up.perform
+      end
+    end
+
+    def perform_html5_drag(element, delay, drop_modifiers)
+      driver.evaluate_async_script HTML5_DRAG_DROP_SCRIPT, self, element, delay * 1000, normalize_keys(drop_modifiers)
+      browser_action.release.perform
+    end
+
+    def html5_drop(*args)
+      if args[0].is_a? String
+        input = driver.evaluate_script ATTACH_FILE
+        input.set_file(args)
+        driver.execute_script DROP_FILE, self, input
+      else
+        items = args.flat_map do |arg|
+          arg.map { |(type, data)| { type: type, data: data } }
+        end
+        driver.execute_script DROP_STRING, items, self
+      end
+    end
+
+    DROP_STRING = <<~JS
+      var strings = arguments[0],
+          el = arguments[1],
+          dt = new DataTransfer(),
+          opts = { cancelable: true, bubbles: true, dataTransfer: dt };
+      for (var i=0; i < strings.length; i++){
+        if (dt.items) {
+          dt.items.add(strings[i]['data'], strings[i]['type']);
+        } else {
+          dt.setData(strings[i]['type'], strings[i]['data']);
+        }
+      }
+      var dropEvent = new DragEvent('drop', opts);
+      el.dispatchEvent(dropEvent);
+    JS
+
+    DROP_FILE = <<~JS
+      var el = arguments[0],
+          input = arguments[1],
+          files = input.files,
+          dt = new DataTransfer(),
+          opts = { cancelable: true, bubbles: true, dataTransfer: dt };
+      input.parentElement.removeChild(input);
+      if (dt.items){
+        for (var i=0; i<files.length; i++){
+          dt.items.add(files[i]);
+        }
+      } else {
+        Object.defineProperty(dt, "files", {
+          value: files,
+          writable: false
+        });
+      }
+      var dropEvent = new DragEvent('drop', opts);
+      el.dispatchEvent(dropEvent);
+    JS
+
+    ATTACH_FILE = <<~JS
+      (function(){
+        var input = document.createElement('INPUT');
+        input.type = "file";
+        input.id = "_capybara_drop_file";
+        input.multiple = true;
+        document.body.appendChild(input);
+        return input;
+      })()
+    JS
+
+    MOUSEDOWN_TRACKER = <<~JS
+      window.capybara_mousedown_prevented = null;
+      document.addEventListener('mousedown', ev => {
+        window.capybara_mousedown_prevented = ev.defaultPrevented;
+      }, { once: true, passive: true })
+    JS
+
+    LEGACY_DRAG_CHECK = <<~JS
+      (function(el){
+        if ([true, null].indexOf(window.capybara_mousedown_prevented) >= 0){
+          return true;
+        }
+
+        do {
+          if (el.draggable) return false;
+        } while (el = el.parentElement );
+        return true;
+      })(arguments[0])
+    JS
+
+    HTML5_DRAG_DROP_SCRIPT = <<~JS
+      function rectCenter(rect){
+        return new DOMPoint(
+          (rect.left + rect.right)/2,
+          (rect.top + rect.bottom)/2
+        );
+      }
+
+      function pointOnRect(pt, rect) {
+      	var rectPt = rectCenter(rect);
+      	var slope = (rectPt.y - pt.y) / (rectPt.x - pt.x);
+
+      	if (pt.x <= rectPt.x) { // left side
+      		var minXy = slope * (rect.left - pt.x) + pt.y;
+      		if (rect.top <= minXy && minXy <= rect.bottom)
+            return new DOMPoint(rect.left, minXy);
+      	}
+
+      	if (pt.x >= rectPt.x) { // right side
+      		var maxXy = slope * (rect.right - pt.x) + pt.y;
+      		if (rect.top <= maxXy && maxXy <= rect.bottom)
+            return new DOMPoint(rect.right, maxXy);
+      	}
+
+      	if (pt.y <= rectPt.y) { // top side
+      		var minYx = (rectPt.top - pt.y) / slope + pt.x;
+      		if (rect.left <= minYx && minYx <= rect.right)
+            return new DOMPoint(minYx, rect.top);
+      	}
+
+      	if (pt.y >= rectPt.y) { // bottom side
+      		var maxYx = (rect.bottom - pt.y) / slope + pt.x;
+      		if (rect.left <= maxYx && maxYx <= rect.right)
+            return new DOMPoint(maxYx, rect.bottom);
+      	}
+
+        return new DOMPoint(pt.x,pt.y);
+      }
+
+      function dragEnterTarget() {
+        target.scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});
+        var targetRect = target.getBoundingClientRect();
+        var sourceCenter = rectCenter(source.getBoundingClientRect());
+
+        for (var i = 0; i < drop_modifier_keys.length; i++) {
+          key = drop_modifier_keys[i];
+          if (key == "control"){
+            key = "ctrl"
+          }
+          opts[key + 'Key'] = true;
+        }
+
+        var dragEnterEvent = new DragEvent('dragenter', opts);
+        target.dispatchEvent(dragEnterEvent);
+
+        // fire 2 dragover events to simulate dragging with a direction
+        var entryPoint = pointOnRect(sourceCenter, targetRect)
+        var dragOverOpts = Object.assign({clientX: entryPoint.x, clientY: entryPoint.y}, opts);
+        var dragOverEvent = new DragEvent('dragover', dragOverOpts);
+        target.dispatchEvent(dragOverEvent);
+        window.setTimeout(dragOnTarget, step_delay);
+      }
+
+      function dragOnTarget() {
+        var targetCenter = rectCenter(target.getBoundingClientRect());
+        var dragOverOpts = Object.assign({clientX: targetCenter.x, clientY: targetCenter.y}, opts);
+        var dragOverEvent = new DragEvent('dragover', dragOverOpts);
+        target.dispatchEvent(dragOverEvent);
+        window.setTimeout(dragLeave, step_delay, dragOverEvent.defaultPrevented, dragOverOpts);
+      }
+
+      function dragLeave(drop, dragOverOpts) {
+        var dragLeaveOptions = Object.assign({}, opts, dragOverOpts);
+        var dragLeaveEvent = new DragEvent('dragleave', dragLeaveOptions);
+        target.dispatchEvent(dragLeaveEvent);
+        if (drop) {
+          var dropEvent = new DragEvent('drop', dragLeaveOptions);
+          target.dispatchEvent(dropEvent);
+        }
+        var dragEndEvent = new DragEvent('dragend', dragLeaveOptions);
+        source.dispatchEvent(dragEndEvent);
+        callback.call(true);
+      }
+
+      var source = arguments[0],
+          target = arguments[1],
+          step_delay = arguments[2],
+          drop_modifier_keys = arguments[3],
+          callback = arguments[4];
+
+      var dt = new DataTransfer();
+      var opts = { cancelable: true, bubbles: true, dataTransfer: dt };
+
+      while (source && !source.draggable) {
+        source = source.parentElement;
+      }
+
+      if (source.tagName == 'A'){
+        dt.setData('text/uri-list', source.href);
+        dt.setData('text', source.href);
+      }
+      if (source.tagName == 'IMG'){
+        dt.setData('text/uri-list', source.src);
+        dt.setData('text', source.src);
+      }
+
+      var dragEvent = new DragEvent('dragstart', opts);
+      source.dispatchEvent(dragEvent);
+
+      window.setTimeout(dragEnterTarget, step_delay);
+    JS
+  end
+end

data/lib/capybara/selenium/extensions/modifier_keys_stack.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class Capybara::Selenium::Node
+  #
+  # @api private
+  #
+  class ModifierKeysStack
+    def initialize
+      @stack = []
+    end
+
+    def include?(key)
+      @stack.flatten.include?(key)
+    end
+
+    def press(key)
+      @stack.last.push(key)
+    end
+
+    def push
+      @stack.push []
+    end
+
+    def pop
+      @stack.pop
+    end
+  end
+end

data/lib/capybara/selenium/extensions/scroll.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Selenium
+    module Scroll
+      def scroll_by(x, y)
+        driver.execute_script <<~JS, self, x, y
+          var el = arguments[0];
+          if (el.scrollBy){
+            el.scrollBy(arguments[1], arguments[2]);
+          } else {
+            el.scrollTop = el.scrollTop + arguments[2];
+            el.scrollLeft = el.scrollLeft + arguments[1];
+          }
+        JS
+      end
+
+      def scroll_to(element, location, position = nil)
+        # location, element = element, nil if element.is_a? Symbol
+        if element.is_a? Capybara::Selenium::Node
+          scroll_element_to_location(element, location)
+        elsif location.is_a? Symbol
+          scroll_to_location(location)
+        else
+          scroll_to_coords(*position)
+        end
+        self
+      end
+
+    private
+
+      def scroll_element_to_location(element, location)
+        scroll_opts = case location
+        when :top
+          'true'
+        when :bottom
+          'false'
+        when :center
+          "{behavior: 'instant', block: 'center'}"
+        else
+          raise ArgumentError, "Invalid scroll_to location: #{location}"
+        end
+        driver.execute_script <<~JS, element
+          arguments[0].scrollIntoView(#{scroll_opts})
+        JS
+      end
+
+      SCROLL_POSITIONS = {
+        top: '0',
+        bottom: 'arguments[0].scrollHeight',
+        center: '(arguments[0].scrollHeight - arguments[0].clientHeight)/2'
+      }.freeze
+
+      def scroll_to_location(location)
+        driver.execute_script <<~JS, self
+          if (arguments[0].scrollTo){
+            arguments[0].scrollTo(0, #{SCROLL_POSITIONS[location]});
+          } else {
+            arguments[0].scrollTop = #{SCROLL_POSITIONS[location]};
+          }
+        JS
+      end
+
+      def scroll_to_coords(x, y)
+        driver.execute_script <<~JS, self, x, y
+          if (arguments[0].scrollTo){
+            arguments[0].scrollTo(arguments[1], arguments[2]);
+          } else {
+            arguments[0].scrollTop = arguments[2];
+            arguments[0].scrollLeft = arguments[1];
+          }
+        JS
+      end
+    end
+  end
+end