cuprite 0.18 → 0.20

data/lib/capybara/cuprite/devices.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Cuprite
+    module Devices
+      IPHONE_USER_AGENT = "Mozilla/5.0 (iPhone; CPU iPhone OS 18_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.5 Mobile/15E148 Safari/604.1"
+      SAMSUNG_GALAXY_S8_PLUS_USER_AGENT = "Mozilla/5.0 (Linux; Android 8.0.0; SM-G955U Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Mobile Safari/537.36"
+      WINDOWS_USER_AGENT = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Safari/537.36"
+
+      LIST = {
+        iphone_se: {
+          window_size: [375, 667], scale_factor: 2, mobile: true,
+          user_agent: IPHONE_USER_AGENT
+        },
+        iphone_xr: {
+          window_size: [414, 896], scale_factor: 2, mobile: true,
+          user_agent: IPHONE_USER_AGENT
+        },
+        iphone_12_pro: {
+          window_size: [390, 844], scale_factor: 3, mobile: true,
+          user_agent: IPHONE_USER_AGENT
+        },
+        iphone_14: {
+          window_size: [390, 844], scale_factor: 3, mobile: true,
+          user_agent: IPHONE_USER_AGENT
+        },
+        iphone_14_plus: {
+          window_size: [428, 926], scale_factor: 3, mobile: true,
+          user_agent: IPHONE_USER_AGENT
+        },
+        iphone_14_pro: {
+          window_size: [393, 852], scale_factor: 3, mobile: true,
+          user_agent: IPHONE_USER_AGENT
+        },
+        iphone_14_pro_max: {
+          window_size: [430, 932], scale_factor: 3, mobile: true,
+          user_agent: IPHONE_USER_AGENT
+        },
+        iphone_15: {
+          window_size: [393, 852], scale_factor: 3, mobile: true,
+          user_agent: IPHONE_USER_AGENT
+        },
+        iphone_15_plus: {
+          window_size: [430, 932], scale_factor: 3, mobile: true,
+          user_agent: IPHONE_USER_AGENT
+        },
+        iphone_15_pro: {
+          window_size: [393, 852], scale_factor: 3, mobile: true,
+          user_agent: IPHONE_USER_AGENT
+        },
+        iphone_15_pro_max: {
+          window_size: [430, 932], scale_factor: 3, mobile: true,
+          user_agent: IPHONE_USER_AGENT
+        },
+        iphone_16e: {
+          window_size: [390, 844], scale_factor: 3, mobile: true,
+          user_agent: IPHONE_USER_AGENT
+        },
+        iphone_16: {
+          window_size: [393, 852], scale_factor: 3, mobile: true,
+          user_agent: IPHONE_USER_AGENT
+        },
+        iphone_16_plus: {
+          window_size: [430, 932], scale_factor: 3, mobile: true,
+          user_agent: IPHONE_USER_AGENT
+        },
+        iphone_16_pro: {
+          window_size: [402, 874], scale_factor: 3, mobile: true,
+          user_agent: IPHONE_USER_AGENT
+        },
+        iphone_16_pro_max: {
+          window_size: [440, 956], scale_factor: 3, mobile: true,
+          user_agent: IPHONE_USER_AGENT
+        },
+        ipad_mini: {
+          window_size: [768, 1024], scale_factor: 2, mobile: true,
+          user_agent: "Mozilla/5.0 (iPad; CPU OS 18_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.5 Mobile/15E148 Safari/604.1"
+        },
+        ipad_pro_13: {
+          window_size: [1032, 1376], scale_factor: 2, mobile: true,
+          user_agent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.5 Safari/605.1.15"
+        },
+
+        pixel_7: {
+          window_size: [412, 915], scale_factor: 2.625, mobile: true,
+          user_agent: "Mozilla/5.0 (Linux; Android 13; Pixel 7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Mobile Safari/537.36"
+        },
+        pixel_8: {
+          window_size: [412, 915], scale_factor: 2.625, mobile: true,
+          user_agent: "Mozilla/5.0 (Linux; Android 14; Pixel 8) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Mobile Safari/537.36"
+        },
+        pixel_8_pro: {
+          window_size: [448, 997], scale_factor: 3, mobile: true,
+          user_agent: "Mozilla/5.0 (Linux; Android 14; Pixel 8 Pro) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Mobile Safari/537.36"
+        },
+        pixel_8a: {
+          window_size: [412, 915], scale_factor: 2.625, mobile: true,
+          user_agent: "Mozilla/5.0 (Linux; Android 14; Pixel 8a) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Mobile Safari/537.36"
+        },
+        pixel_9: {
+          window_size: [412, 924], scale_factor: 2.625, mobile: true,
+          user_agent: "Mozilla/5.0 (Linux; Android 14; Pixel 9) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Mobile Safari/537.36"
+        },
+        pixel_9_pro: {
+          window_size: [427, 952], scale_factor: 3, mobile: true,
+          user_agent: "Mozilla/5.0 (Linux; Android 14; Pixel 9 Pro) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Mobile Safari/537.36"
+        },
+        pixel_9_pro_xl: {
+          window_size: [448, 997], scale_factor: 3, mobile: true,
+          user_agent: "Mozilla/5.0 (Linux; Android 14; Pixel 9 Pro XL) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Mobile Safari/537.36"
+        },
+        pixel_10: {
+          window_size: [412, 924], scale_factor: 2.625, mobile: true,
+          user_agent: "Mozilla/5.0 (Linux; Android 16; Pixel 10) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Mobile Safari/537.36"
+        },
+        pixel_9_pro_fold: {
+          window_size: [412, 922], scale_factor: 2.625, mobile: true,
+          user_agent: "Mozilla/5.0 (Linux; Android 14; Pixel 9 Pro Fold) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Mobile Safari/537.36"
+        },
+
+        samsung_galaxy_s8_plus: {
+          window_size: [360, 740], scale_factor: 4, mobile: true,
+          user_agent: SAMSUNG_GALAXY_S8_PLUS_USER_AGENT
+        },
+        samsung_galaxy_s20_ultra: {
+          window_size: [412, 915], scale_factor: 3.5, mobile: true,
+          user_agent: "Mozilla/5.0 (Linux; Android 13; SM-G981B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Mobile Safari/537.36"
+        },
+        samsung_galaxy_a55: {
+          window_size: [360, 800], scale_factor: 2.25, mobile: true,
+          user_agent: "Mozilla/5.0 (Linux; Android 14; SM-A556B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Mobile Safari/537.36"
+        },
+        galaxy_z_fold_6: {
+          window_size: [412, 968], scale_factor: 2.625, mobile: true,
+          user_agent: "Mozilla/5.0 (Linux; Android 14; SM-F956U) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Mobile Safari/537.36"
+        },
+        galaxy_z_fold_5: {
+          window_size: [344, 882], scale_factor: 2.625, mobile: true,
+          user_agent: "Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Mobile Safari/537.36"
+        },
+        samsung_galaxy_a51_71: {
+          window_size: [412, 914], scale_factor: 2.625, mobile: true,
+          user_agent: SAMSUNG_GALAXY_S8_PLUS_USER_AGENT
+        },
+        galaxy_tab_s4: {
+          window_size: [712, 1138], scale_factor: 2.25, mobile: true,
+          user_agent: "Mozilla/5.0 (Linux; Android 8.1.0; SM-T837A) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Safari/537.36"
+        },
+
+        surface_pro_7: {
+          window_size: [912, 1368], scale_factor: 2, mobile: true,
+          user_agent: WINDOWS_USER_AGENT
+        },
+        surface_pro_10: {
+          window_size: [960, 1440], scale_factor: 2, mobile: true,
+          user_agent: WINDOWS_USER_AGENT
+        },
+        surface_duo: {
+          window_size: [540, 720], scale_factor: 2.5, mobile: true,
+          user_agent: "Mozilla/5.0 (Linux; Android 11.0; Surface Duo) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Mobile Safari/537.36"
+        },
+
+        nest_hub_max: {
+          window_size: [1280, 800], scale_factor: 2, mobile: true,
+          user_agent: "Mozilla/5.0 (X11; Linux aarch64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Safari/537.36 CrKey/1.54.250320"
+        },
+        jiophone_2: {
+          window_size: [240, 320], scale_factor: 1, mobile: true,
+          user_agent: "Mozilla/5.0 (Mobile; LYF/F300B/LYF-F300B-001-01-15-130718-i;Android; rv:48.0) Gecko/48.0 Firefox/48.0 KAIOS/2.5"
+        },
+        moto_g4: {
+          window_size: [360, 640], scale_factor: 3, mobile: true,
+          user_agent: "Mozilla/5.0 (Linux; Android 6.0.1; Moto G (4)) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Mobile Safari/537.36"
+        },
+        moto_g_power: {
+          window_size: [412, 823], scale_factor: 1.75, mobile: true,
+          user_agent: "Mozilla/5.0 (Linux; Android 11; moto g power (2022)) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/%<version>s Mobile Safari/537.36"
+        }
+      }.freeze
+
+      def self.fetch(name)
+        LIST.fetch(name.to_sym) do
+          raise ArgumentError, "Unknown device to emulate: #{name.inspect}, use one of #{LIST.keys.join(', ')}"
+        end
+      end
+    end
+  end
+end

data/lib/capybara/cuprite/driver/deprecations.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+require "uri"
+require "capybara/cuprite/deprecation"
+
+module Capybara
+  module Cuprite
+    class Driver < Capybara::Driver::Base
+      module Deprecations
+        def self.deprecate(name, replacement)
+          define_method(name) do |*args, **kwargs, &block|
+            Cuprite.deprecation_warning("#{self.class}##{name}", "use ##{replacement}")
+            public_send(replacement, *args, **kwargs, &block)
+          end
+        end
+        private_class_method :deprecate
+
+        deprecate :body, :html
+        deprecate :window_handle, :current_window_handle
+        deprecate :back, :go_back
+        deprecate :forward, :go_forward
+        deprecate :render, :save_screenshot
+
+        def render_base64(format = :png, options = {})
+          Cuprite.deprecation_warning("#{self.class}#render_base64", "use page.driver.browser.screenshot or .pdf")
+          browser.screenshot(format: format, encoding: :base64, **options)
+        end
+
+        def zoom_factor=(value)
+          Cuprite.deprecation_warning("#{self.class}#zoom_factor=", "pass scale: to save_screenshot")
+          @zoom_factor = value.to_f
+        end
+
+        def paper_size=(value)
+          Cuprite.deprecation_warning("#{self.class}#paper_size=",
+                                      "pass paper_width: and paper_height: to save_screenshot")
+          @paper_size = value
+        end
+
+        def resize(width, height)
+          Cuprite.deprecation_warning("#{self.class}##{__callee__}", "use page.current_window.resize_to")
+          resize_window_to(current_window_handle, width, height)
+        end
+        alias resize_window resize
+
+        def click(x, y)
+          Cuprite.deprecation_warning("#{self.class}#click", "use page.driver.browser.mouse.click")
+          browser.mouse.click(x: x, y: y)
+        end
+
+        def scroll_to(left, top)
+          Cuprite.deprecation_warning("#{self.class}#scroll_to", "use page.scroll_to")
+          browser.mouse.scroll_to(left, top)
+        end
+
+        def set_proxy(host, port, user = nil, password = nil, bypass = nil)
+          Cuprite.deprecation_warning("#{self.class}#set_proxy", "pass the :proxy option to the driver")
+          @options.merge!(proxy: { host: host, port: port, user: user, password: password, bypass: bypass })
+        end
+
+        def restart
+          Cuprite.deprecation_warning("#{self.class}#restart", "use page.driver.browser.restart")
+          browser.restart
+        end
+
+        def wait_for_reload(timeout = 1)
+          Cuprite.deprecation_warning("#{self.class}#wait_for_reload", "use page.driver.browser.wait_for_reload")
+          browser.wait_for_reload(timeout)
+        end
+
+        def timeout
+          Cuprite.deprecation_warning("#{self.class}#timeout", "use page.driver.browser.timeout")
+          browser.timeout
+        end
+
+        def timeout=(value)
+          Cuprite.deprecation_warning("#{self.class}#timeout=", "use page.driver.browser.timeout=")
+          browser.timeout = value
+        end
+
+        def device_pixel_ratio
+          Cuprite.deprecation_warning("#{self.class}#device_pixel_ratio", "use page.driver.browser.device_pixel_ratio")
+          browser.device_pixel_ratio
+        end
+
+        def viewport_size
+          Cuprite.deprecation_warning("#{self.class}#viewport_size", "use page.driver.browser.viewport_size")
+          browser.viewport_size
+        end
+
+        def authorize(user, password)
+          Cuprite.deprecation_warning("#{self.class}##{__callee__}", "use page.driver.browser.network.authorize")
+          browser.network.authorize(user: user, password: password) do |request, _index, _total|
+            request.continue
+          end
+        end
+        alias basic_authorize authorize
+
+        def headers
+          Cuprite.deprecation_warning("#{self.class}#headers", "use page.driver.browser.headers.get")
+          browser.headers.get
+        end
+
+        def headers=(headers)
+          Cuprite.deprecation_warning("#{self.class}#headers=", "use page.driver.browser.headers.set")
+          browser.headers.set(headers)
+        end
+
+        def add_headers(headers)
+          Cuprite.deprecation_warning("#{self.class}#add_headers", "use page.driver.browser.headers.add")
+          browser.headers.add(headers)
+        end
+
+        def add_header(name, value, permanent: true)
+          Cuprite.deprecation_warning("#{self.class}#add_header", "use page.driver.browser.headers.add")
+          browser.headers.add({ name => value }, permanent: permanent)
+        end
+
+        def cookies
+          Cuprite.deprecation_warning("#{self.class}#cookies", "use page.driver.browser.cookies.all")
+          browser.cookies.all
+        end
+
+        def set_cookie(name, value, options = {})
+          Cuprite.deprecation_warning("#{self.class}#set_cookie", "use page.driver.browser.cookies.set")
+          options = options.dup
+          options[:name]   ||= name
+          options[:value]  ||= value
+          options[:domain] ||= default_domain
+          browser.cookies.set(**options)
+        end
+
+        def remove_cookie(name, **options)
+          Cuprite.deprecation_warning("#{self.class}#remove_cookie", "use page.driver.browser.cookies.remove")
+          options[:domain] = default_domain if options.empty?
+          options = options.merge(name: name)
+          browser.cookies.remove(**options)
+        end
+
+        def clear_cookies
+          Cuprite.deprecation_warning("#{self.class}#clear_cookies", "use page.driver.browser.cookies.clear")
+          browser.cookies.clear
+        end
+
+        def network_traffic(type = nil)
+          Cuprite.deprecation_warning("#{self.class}#network_traffic", "use page.driver.browser.network.traffic")
+          traffic = browser.network.traffic
+
+          case type.to_s
+          when "all"
+            traffic
+          when "blocked"
+            traffic.select(&:blocked?)
+          else
+            # when request isn't blocked
+            traffic.reject(&:blocked?)
+          end
+        end
+
+        def clear_network_traffic
+          Cuprite.deprecation_warning("#{self.class}#clear_network_traffic",
+                                      "use page.driver.browser.network.clear(:traffic)")
+          browser.network.clear(:traffic)
+        end
+
+        def wait_for_network_idle(**options)
+          Cuprite.deprecation_warning("#{self.class}#wait_for_network_idle",
+                                      "use page.driver.browser.network.wait_for_idle")
+          browser.network.wait_for_idle(**options)
+        end
+
+        def clear_memory_cache
+          Cuprite.deprecation_warning("#{self.class}#clear_memory_cache",
+                                      "use page.driver.browser.network.clear(:cache)")
+          browser.network.clear(:cache)
+        end
+
+        private
+
+        def default_domain
+          if @started
+            URI.parse(browser.current_url).host
+          else
+            URI.parse(default_cookie_host).host || "127.0.0.1"
+          end
+        end
+
+        def default_cookie_host
+          if respond_to?(:session_options)
+            session_options.app_host
+          else
+            Capybara.app_host
+          end || ""
+        end
+      end
+    end
+  end
+end

data/lib/capybara/cuprite/driver/extensions.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Cuprite
+    class Driver < Capybara::Driver::Base
+      module Extensions
+        def debug(...)
+          browser.debug(...)
+        end
+      end
+    end
+  end
+end