bidi2pdf 0.1.12 → 0.1.14

data/sig/bidi2pdf/notifications/instrumenter.rbs

@@ -0,0 +1,21 @@
+module Bidi2pdf
+  # rubocop: disable Lint/RescueException, Lint/SuppressedException
+  module Notifications
+    class Instrumenter
+      @id: untyped
+
+      attr_reader id: untyped
+
+      def initialize: () -> void
+
+      def notify: (untyped name, untyped payload) { (?) -> untyped } -> untyped
+
+      private
+
+      def create_event: (untyped name, untyped payload) -> untyped
+
+      # rubocop:disable  Style/CaseEquality
+      def notify_subscribers: (untyped name, untyped event) -> untyped
+    end
+  end
+end

data/sig/bidi2pdf/notifications/logging_subscriber.rbs

@@ -0,0 +1,41 @@
+module Bidi2pdf
+  module Notifications
+    # for reuse within ActiveSupport::LogSubscriber
+    module LoggingSubscriberActions
+      def handle_response: (untyped event) -> untyped
+
+      def send_cmd: (untyped event) -> untyped
+
+      def send_cmd_and_wait: (untyped event) -> (nil | untyped)
+
+      def session_close: (untyped event) -> (nil | untyped)
+
+      # rubocop: disable Metrics/AbcSize
+      def network_event_received: (untyped event) -> (nil | untyped)
+
+      # rubocop:disable  Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      def network_idle: (untyped event) -> (nil | untyped)
+
+      def page_loaded: (untyped event) -> untyped
+
+      def print: (untyped event) -> untyped
+
+      private
+
+      def redact_sensitive_fields: (untyped obj, ?::Array[untyped] sensitive_keys) -> untyped
+    end
+
+    class LoggingSubscriber
+      @logger: untyped
+
+      include LoggingSubscriberActions
+
+      attr_accessor logger: untyped
+
+      # rubocop: disable Metrics/AbcSize, Metrics/CyclomaticComplexity,  Metrics/PerceivedComplexity
+      def initialize: (?logger: untyped) -> void
+
+      def unsubscribe: () -> untyped
+    end
+  end
+end

data/sig/bidi2pdf/notifications.rbs

@@ -0,0 +1,24 @@
+module Bidi2pdf
+  module Notifications
+    self.@subscribers: untyped
+
+    attr_reader self.subscribers: untyped
+
+    def self.instrument: (untyped name, ?::Hash[untyped, untyped] payload) ?{ (untyped) -> untyped } -> untyped
+
+    def self.subscribe: (untyped event_pattern) { (?) -> untyped } -> untyped
+
+    def self.unsubscribe: (untyped event_pattern, ?untyped? block) -> untyped
+
+    # rubocop: disable Style/CaseEquality
+    def self.listening?: (untyped name) -> untyped
+
+    private
+
+    def self.bidi2pdf_notification_instrumenter: () -> untyped
+
+    def self.notify: (untyped name, untyped payload) { (?) -> untyped } -> untyped
+
+    def self.normalize_pattern: (untyped pat) -> untyped
+  end
+end

data/sig/bidi2pdf/process_tree.rbs

@@ -10,7 +10,7 @@ module Bidi2pdf
 
     def children: (untyped of_pid) -> (::Array[untyped] | untyped)
 
-    def traverse: () { () -> untyped } -> untyped
+    def traverse: () { (?) -> untyped } -> untyped
 
     private
 
@@ -22,6 +22,6 @@ module Bidi2pdf
 
     def root_pids: () -> (::Array[untyped] | untyped)
 
-    def traverse_branch: (untyped pid, ?::Integer level) { () -> untyped } -> (nil | untyped)
+    def traverse_branch: (untyped pid, ?::Integer level) { (?) -> untyped } -> (nil | untyped)
   end
 end

data/sig/bidi2pdf/session_runner.rbs

@@ -1,9 +1,43 @@
 module Bidi2pdf
+  # Represents a runner for managing browser sessions and executing tasks
+  # using the Bidi2pdf library. This class handles the setup, configuration,
+  # and execution of browser-related workflows, including navigation, cookie
+  # management, and printing.
+  #
+  # @example Running a session
+  #   session_runner = Bidi2pdf::SessionRunner.new(
+  #     session: session,
+  #     url: "http://example.com",
+  #     inputfile: "input.html",
+  #     output: "output.pdf",
+  #     cookies: { "key" => "value" },
+  #     headers: { "Authorization" => "Bearer token" },
+  #     auth: { username: "user", password: "pass" },
+  #     wait_window_loaded: true,
+  #     wait_network_idle: true,
+  #     print_options: { landscape: true },
+  #     network_log_format: :json
+  #   )
+  #   session_runner.run
+  #
+  # @param [Object] session The browser session object to use.
+  # @param [String, nil] url The URL to navigate to in the browser session.
+  # @param [String, nil] inputfile The path to the input file to be processed if no URL is provided.
+  # @param [String, nil] output The path to the output file to be generated.
+  # @param [Hash] cookies A hash of cookies to set in the browser session. Defaults to an empty hash.
+  # @param [Hash] headers A hash of HTTP headers to include in the browser session. Defaults to an empty hash.
+  # @param [Hash, nil] auth Authentication credentials (e.g., username and password). Defaults to an empty hash.
+  # @param [Boolean] wait_window_loaded Whether to wait for the window to fully load. Defaults to false.
+  # @param [Boolean] wait_network_idle Whether to wait for the network to become idle. Defaults to false.
+  # @param [Hash] print_options Options for printing the page. Defaults to an empty hash.
+  # @param [Symbol] network_log_format The format for network logs. Defaults to :console.
   class SessionRunner
     @session: untyped
 
     @url: untyped
 
+    @inputfile: untyped
+
     @output: untyped
 
     @cookies: untyped
@@ -18,13 +52,18 @@ module Bidi2pdf
 
     @print_options: untyped
 
+    @network_log_format: untyped
+
     @window: untyped
 
     @tab: untyped
 
+    @user_context: untyped
+
     @uri: untyped
 
-    def initialize: (session: untyped, url: untyped, output: untyped, ?cookies: ::Hash[untyped, untyped], ?headers: ::Hash[untyped, untyped], ?auth: ::Hash[untyped, untyped], ?wait_window_loaded: bool, ?wait_network_idle: bool, ?print_options: ::Hash[untyped, untyped]) -> void
+    # rubocop: disable Metrics/ParameterLists
+    def initialize: (session: untyped, url: untyped, inputfile: untyped, output: untyped, ?cookies: ::Hash[untyped, untyped], ?headers: ::Hash[untyped, untyped], ?auth: ::Hash[untyped, untyped], ?wait_window_loaded: bool, ?wait_network_idle: bool, ?print_options: ::Hash[untyped, untyped], ?network_log_format: ::Symbol) -> void
 
     def run: () -> untyped
 
@@ -38,6 +77,7 @@ module Bidi2pdf
 
     def add_basic_auth: () -> (nil | untyped)
 
+    # rubocop: disable Metrics/AbcSize
     def run_flow: () -> untyped
 
     def uri: () -> untyped

data/sig/bidi2pdf/test_helpers/configuration.rbs

@@ -0,0 +1,51 @@
+module Bidi2pdf
+  module TestHelpers
+    self.@configuration: untyped
+
+    class Configuration
+      @spec_dir: untyped
+
+      @docker_dir: untyped
+
+      @fixture_dir: untyped
+
+      @tmp_dir: untyped
+
+      @prefix: untyped
+
+      # @!attribute [rw] spec_dir
+      #   @return [Pathname] the directory where specs are located
+      attr_accessor spec_dir: untyped
+
+      # @!attribute [rw] tmp_dir
+      #   @return [String] the directory for temporary files
+      attr_accessor tmp_dir: untyped
+
+      # @!attribute [rw] prefix
+      #   @return [String] the prefix for temporary files
+      attr_accessor prefix: untyped
+
+      # @!attribute [rw] docker_dir
+      #  @return [String] the directory for Docker files
+      attr_accessor docker_dir: untyped
+
+      # @!attribute [rw] fixture_dir
+      # @return [String] the directory for fixture files
+      attr_accessor fixture_dir: untyped
+
+      def initialize: () -> void
+    end
+
+    # Retrieves the current configuration object for TestHelpers.
+    # @return [Configuration] the configuration object
+    def self.configuration: () -> untyped
+
+    # Sets the configuration object for TestHelpers.
+    # @param [Configuration] config the configuration object to set
+    attr_writer self.configuration: untyped
+
+    # Allows configuration of TestHelpers by yielding the configuration object.
+    # @yieldparam [Configuration] configuration the configuration object to modify
+    def self.configure: () { (untyped) -> untyped } -> untyped
+  end
+end

data/sig/bidi2pdf/test_helpers/images/extractor.rbs

@@ -0,0 +1,43 @@
+module Bidi2pdf
+  module TestHelpers
+    module Images
+      class Extractor
+        @pages: untyped
+
+        @logger: untyped
+
+        @extracted_images: untyped
+
+        include PDFReaderUtils
+
+        include TIFFHelper
+
+        attr_reader pages: untyped
+
+        attr_reader logger: untyped
+
+        def initialize: (untyped pdf_data, ?logger: untyped) -> void
+
+        def all_images: () -> untyped
+
+        def image_on_page: (untyped page_number, untyped image_number) -> (nil | untyped)
+
+        def images_on_page: (untyped page_number) -> untyped
+
+        private
+
+        def extracted_images: () -> untyped
+
+        def extract_images: (untyped page) -> (nil | untyped)
+
+        def process_image_stream: (untyped stream) -> (nil | untyped)
+
+        def extract_raw_image_data: (untyped stream, untyped filter) -> untyped
+
+        def handle_compressed_image: (untyped stream) -> untyped
+
+        def create_vips_image: (untyped raw, untyped filter) -> untyped
+      end
+    end
+  end
+end

data/sig/bidi2pdf/test_helpers/images/image_similarity_checker.rbs

@@ -0,0 +1,35 @@
+module Bidi2pdf
+  module TestHelpers
+    module Images
+      class ImageSimilarityChecker
+        @expected_image: untyped
+
+        @image_to_check: untyped
+
+        @expected_fingerprint: untyped
+
+        @actual_fingerprint: untyped
+
+        @distance: untyped
+
+        def initialize: (untyped expected_image, untyped image_to_check) -> void
+
+        def similar?: (?tolerance: ::Integer) -> untyped
+
+        def very_similar?: () -> untyped
+
+        def slightly_similar?: () -> untyped
+
+        def different?: () -> untyped
+
+        def expected_fingerprint: () -> untyped
+
+        def actual_fingerprint: () -> untyped
+
+        def distance: () -> untyped
+
+        def fingerprint: (untyped image) -> untyped
+      end
+    end
+  end
+end

data/sig/bidi2pdf/test_helpers/images/tiff_helper.rbs

@@ -0,0 +1,70 @@
+module Bidi2pdf
+  module TestHelpers
+    module Images
+      # rubocop: disable  Metrics/ModuleLength, Metrics/AbcSize
+      module TIFFHelper
+        # TIFF Tag IDs
+        IMAGE_WIDTH: 256
+
+        IMAGE_LENGTH: 257
+
+        BITS_PER_SAMPLE: 258
+
+        COMPRESSION: 259
+
+        PHOTOMETRIC_INTERPRETATION: 262
+
+        STRIP_OFFSETS: 273
+
+        SAMPLES_PER_PIXEL: 277
+
+        ROWS_PER_STRIP: 278
+
+        STRIP_BYTE_COUNTS: 279
+
+        PLANAR_CONFIGURATION: 284
+
+        INK_SET: 332
+
+        # TIFF Data Types
+        TYPE_SHORT: 3
+
+        TYPE_LONG: 4
+
+        # TIFF Compression Types
+        COMPRESSION_NONE: 1
+
+        COMPRESSION_CCITT_G3: 3
+
+        COMPRESSION_CCITT_G4: 4
+
+        # TIFF Photometric Interpretations
+        PHOTO_WHITE_IS_ZERO: 0
+
+        PHOTO_BLACK_IS_ZERO: 1
+
+        PHOTO_RGB: 2
+
+        PHOTO_SEPARATION: 5
+
+        # Planar Configuration
+        PLANAR_CHUNKY: 1
+
+        def tiff_header: (untyped hash, untyped data) -> untyped
+
+        # See:
+        #    * https://gist.github.com/gstorer/f6a9f1dfe41e8e64dcf58d07afa9ab2a
+        #    * https://github.com/yob/pdf-reader/blob/main/examples/extract_images.rb
+        def pack_tiff: (untyped entries) -> untyped
+
+        def tiff_header_for_gray: (untyped hash, untyped data) -> untyped
+
+        def tiff_header_for_ccitt: (untyped hash, untyped data) -> untyped
+
+        def tiff_header_for_cmyk: (untyped hash, untyped data) -> untyped
+
+        def tiff_header_for_rgb: (untyped hash, untyped data) -> untyped
+      end
+    end
+  end
+end

data/sig/bidi2pdf/test_helpers/pdf_file_helper.rbs

@@ -0,0 +1,23 @@
+module Bidi2pdf
+  module TestHelpers
+    # This module provides helper methods for handling PDF files in tests.
+    # It includes methods for debugging, storing, and managing PDF files.
+    module PdfFileHelper
+      def reporter: () -> untyped
+
+      # Executes a block with the given PDF data and handles debugging in case of test failures.
+      # If an expectation fails, the PDF data is saved to a file for debugging purposes.
+      # @param [String] pdf_data the PDF data to debug
+      # @yield [String] yields the PDF data to the given block
+      # @raise [RSpec::Expectations::ExpectationNotMetError] re-raises the exception after saving the PDF
+      def with_pdf_debug: (untyped pdf_data) { (untyped) -> untyped } -> untyped
+
+      # Stores the given PDF data to a file with a specified filename prefix.
+      # The file is saved in a temporary directory.
+      # @param [String] pdf_data the PDF data to store
+      # @param [String] filename_prefix the prefix for the generated filename (default: "test")
+      # @return [String] the full path to the saved PDF file
+      def store_pdf_file: (untyped pdf_data, ?::String filename_prefix) -> untyped
+    end
+  end
+end

data/sig/bidi2pdf/test_helpers/pdf_reader_utils.rbs

@@ -0,0 +1,49 @@
+module Bidi2pdf
+  module TestHelpers
+    module PDFReaderUtils
+      # Extracts text content from a PDF document.
+      #
+      # This method accepts various PDF input formats and attempts to extract text content
+      # from all pages. If extraction fails due to malformed PDF data, it returns the original input.
+      #
+      # @param pdf_data [String, StringIO, File] The PDF data in one of the following formats:
+      #   * Base64-encoded PDF string
+      #   * Raw PDF data beginning with "%PDF-"
+      #   * StringIO object containing PDF data
+      #   * Path to a PDF file as String
+      #   * Raw PDF data as String
+      # @return [Array<String>] An array of strings, with each string representing the text content of a page
+      # @return [Object] The original input if PDF extraction fails
+      # @example Extract text from a PDF file
+      #   text_content = pdf_text('path/to/document.pdf')
+      #
+      # @example Extract text from Base64-encoded string
+      #   text_content = pdf_text(base64_encoded_pdf_data)
+      def self.pdf_text: (untyped pdf_data) -> untyped
+
+      # Converts the input PDF data into an IO object and initializes a PDF::Reader.
+      #
+      # @param pdf_data [String, StringIO, File] The PDF data to be read.
+      # @return [PDF::Reader] A PDF::Reader instance for the given data.
+      # @raise [PDF::Reader::MalformedPDFError] If the PDF data is invalid.
+      def self.pdf_reader_for: (untyped pdf_data) -> untyped
+
+      # rubocop: disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      # Converts various input formats into an IO object for PDF::Reader.
+      #
+      # @param pdf_data [String, StringIO, File] The PDF data to be converted.
+      # @return [IO] An IO object containing the PDF data.
+      def self.convert_data_to_io: (untyped pdf_data) -> untyped
+
+      module InstanceMethods
+        def pdf_text: (untyped pdf_data) -> untyped
+
+        def pdf_reader_for: (untyped pdf_data) -> untyped
+
+        def convert_data_to_io: (untyped pdf_data) -> untyped
+      end
+
+      def self.included: (untyped base) -> untyped
+    end
+  end
+end

data/sig/bidi2pdf/test_helpers/pdf_text_sanitizer.rbs

@@ -0,0 +1,38 @@
+module Bidi2pdf
+  module TestHelpers
+    # rubocop: disable-next Metrics/ModuleLength
+    module PDFTextSanitizer
+      def self.clean: (untyped text) -> untyped
+
+      def self.clean_pages: (untyped pdf) -> untyped
+
+      def self.normalize: (untyped text) -> untyped
+
+      def self.contains?: (untyped actual_pdf_thingy, untyped expected, ?untyped? page_number) -> (false | untyped)
+
+      def self.match_expected?: (untyped text, untyped expected) -> (false | untyped)
+
+      def self.match?: (untyped actual_pdf_thingy, untyped expected_pdf_thingy) -> (true | false)
+
+      def self.report_content_mismatch: (untyped actual, untyped expected) -> untyped
+
+      def self.content_mismatch_message: (untyped actual, untyped expected) -> untyped
+
+      def self.page_difference_message: (untyped actual_page, untyped expected_page, untyped page_idx) -> (nil | untyped)
+
+      def self.format_diff_output: (untyped diffs, untyped expected, untyped actual) -> untyped
+
+      def self.reporter: () -> untyped
+
+      private
+
+      def self.group_changed_diffs: (untyped diffs) -> untyped
+
+      def self.format_change: (untyped expected, untyped actual, untyped change) -> untyped
+
+      def self.extract_snippets: (untyped expected, untyped actual, untyped change, untyped pos) -> { context_start: untyped, context: untyped, expected_snip: untyped, actual_snip: untyped }
+
+      def self.build_output: (untyped snip_data, untyped pos) -> ::Array[::String]
+    end
+  end
+end

data/sig/bidi2pdf/test_helpers/spec_paths_helper.rbs

@@ -0,0 +1,35 @@
+# This module provides helper methods for managing paths in test environments.
+# It includes methods to retrieve directories and generate temporary file paths.
+module Bidi2pdf
+  module TestHelpers
+    # This submodule contains path-related helper methods and configuration for tests.
+    module SpecPathsHelper
+      # Retrieves the directory path for Docker files.
+      # @return [String] the Docker directory path
+      def fixture_dir: () -> untyped
+
+      # Retrieves the directory path for fixtures.
+      # @return [String] the fixture directory path
+      def fixture_file: (*untyped) -> untyped
+
+      # Retrieves the directory path for specs.
+      # @return [String] the spec directory path
+      def spec_dir: () -> untyped
+
+      # Retrieves the directory path for temporary files.
+      # @return [String] the temporary directory path
+      def tmp_dir: () -> untyped
+
+      # Generates a path for a temporary file by joining the temporary directory with the given parts.
+      # @param [Array<String>] parts the parts of the file path to join
+      # @return [String] the full path to the temporary file
+      def tmp_file: (*untyped parts) -> untyped
+
+      # Generates a random temporary directory path.
+      # @param [Array<String>] dirs additional directory components to include in the path
+      # @param [String, nil] prefix an optional prefix for the directory name
+      # @return [String] the full path to the random temporary directory
+      def random_tmp_dir: (*untyped dirs, ?prefix: untyped?) -> untyped
+    end
+  end
+end

data/sig/bidi2pdf/test_helpers/testcontainers/chromedriver_container.rbs

@@ -0,0 +1,43 @@
+module Bidi2pdf
+  module TestHelpers
+    module Testcontainers
+      class ChromedriverContainer < ::Testcontainers::DockerContainer
+        @docker_file: untyped
+
+        @build_dir: untyped
+
+        @wait_for: untyped
+
+        @_container: untyped
+
+        @_id: untyped
+
+        @name: untyped
+
+        @_created_at: untyped
+
+        DEFAULT_CHROMEDRIVER_PORT: 3000
+
+        DEFAULT_IMAGE: "dieters877565/chromedriver"
+
+        attr_reader docker_file: untyped
+
+        attr_reader build_dir: untyped
+
+        def initialize: (?untyped image, **untyped options) -> void
+
+        def start: () -> untyped
+
+        def port: () -> untyped
+
+        # rubocop: disable Metrics/AbcSize
+        def build_local_image: () -> untyped
+
+        # rubocop: disable Metrics/AbcSize
+        def start_local_image: () -> untyped
+
+        def session_url: (?protocol: ::String) -> untyped
+      end
+    end
+  end
+end

data/sig/bidi2pdf/test_helpers/testcontainers/chromedriver_test_helper.rbs

@@ -0,0 +1,45 @@
+module Bidi2pdf
+  module TestHelpers
+    module Testcontainers
+      module ChromedriverTestHelper
+        def session_url: () -> untyped
+
+        def chromedriver_container: () -> untyped
+      end
+
+      module SessionTestHelper
+        def reporter: () -> untyped
+
+        def chrome_args: () -> untyped
+
+        def create_session: (untyped session_url) -> untyped
+
+        # Full session/tab lifecycle in one call - create_session above only builds the session
+        # object, it never starts or closes it, and there is no after(:each) teardown for a spec
+        # that uses it directly. Mirrors Bidi2pdf::DSL.with_tab's own ensure-based teardown, but
+        # against a session_url this module already knows about (a long-lived remote-chrome
+        # reached over `session:` metadata, not a freshly spawned local chromedriver per call).
+        def with_tab: (untyped session_url) { (untyped) -> untyped } -> untyped
+      end
+    end
+  end
+end
+
+# alias the long class name
+ChromedriverTestcontainer: untyped
+
+class Object
+  def stop_container: (untyped container) -> (nil | untyped)
+
+  def dump_container_logs: (untyped container) -> (nil | untyped)
+
+  def stop_running_container: (untyped container) -> (nil | untyped)
+
+  def reporter: () -> untyped
+
+  def chromedriver_tests_present?: () -> untyped
+
+  def test_of_kind_present?: (untyped type) -> untyped
+
+  def start_chromedriver_container: (build_dir: untyped, mounts: untyped, shared_network: untyped) -> untyped
+end

data/sig/bidi2pdf/test_helpers/testcontainers/container_endpoint.rbs

@@ -0,0 +1,25 @@
+module Bidi2pdf
+  module TestHelpers
+    module Testcontainers
+      # Builds a URL for reaching a container's published port from the test
+      # process, using the container's own host/port resolution.
+      class ContainerEndpoint
+        @container: untyped
+
+        @port: untyped
+
+        def initialize: (untyped container, untyped port) -> void
+
+        def url: (?scheme: ::String, ?path: ::String) -> ::String
+
+        # Address reachable from another container on the same Docker network (e.g. remote-chrome
+        # reaching nginx), by alias and internal port - as opposed to #url's host-accessible,
+        # externally-mapped port. Uses the same @port this instance was built with, not a
+        # container_ports.first guess: the two methods must agree on which port they're both
+        # describing for the same container, or a caller comparing #url and #alias_url for what's
+        # meant to be the same endpoint could silently get two different services.
+        def alias_url: (?scheme: ::String, ?path: ::String) -> ::String
+      end
+    end
+  end
+end

data/sig/bidi2pdf/test_helpers/testcontainers/shared_docker_network.rbs

@@ -0,0 +1,3 @@
+class Object
+  def reporter: () -> untyped
+end