bidi2pdf 0.1.13 → 0.1.14

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

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

@@ -0,0 +1,47 @@
+module Bidi2pdf
+  module TestHelpers
+    module TestcontainersRefinement
+      @aliases: untyped
+
+      @_network: untyped
+
+      def id: () -> untyped
+
+      def aliases: () -> untyped
+
+      def aliases=: (untyped aliases) -> untyped
+
+      def network: () -> untyped
+
+      def with_network: (untyped network) -> self
+
+      def with_network_aliases: (*untyped aliases) -> self
+
+      def container_json: () -> untyped
+
+      # Address of the Docker host at which this container's *mapped* ports
+      # are reachable from the test process.
+      #
+      # Resolution belongs to testcontainers: it honours TC_HOST, a tcp:/ssh:
+      # DOCKER_HOST, a native local daemon, and a sibling container reaching
+      # the daemon over the bridge gateway — and it derives #mapped_port from
+      # the same decision, so the two must stay on one path. We only add a
+      # fallback for the cases 0.2.0 leaves unresolved.
+      #
+      # This is not the address containers use to reach each other; for that
+      # the helpers join a shared network and address containers by alias.
+      def accessible_host: () -> untyped
+
+      # testcontainers-core 0.2.0 cannot resolve a host when the test process
+      # runs inside a container and the container under test is on a custom
+      # network: #container_gateway_ip hardcodes the "bridge" network key
+      # (docker_container.rb:1074), so #host returns nil. On the default
+      # bridge it can instead reach docker_container.rb:703, which calls an
+      # undefined `bridge_ip`. Both are fixed on testcontainers-ruby main;
+      # treat either as "unresolved" and fall back.
+      def resolved_host: () -> untyped
+
+      def _container_create_options: () -> untyped
+    end
+  end
+end

data/sig/bidi2pdf/test_helpers/testcontainers.rbs

@@ -0,0 +1,6 @@
+module Bidi2pdf
+  module TestHelpers
+    module Testcontainers
+    end
+  end
+end

data/sig/bidi2pdf/verbose_logger.rbs

@@ -0,0 +1,37 @@
+module Bidi2pdf
+  class VerboseLogger < SimpleDelegator
+    @logger: untyped
+
+    @verbosity: untyped
+
+    VERBOSITY_LEVELS: { none: 0, low: 1, medium: 2, high: 3 }
+
+    attr_reader logger: untyped
+
+    attr_reader verbosity: untyped
+
+    def initialize: (untyped logger, ?::Symbol verbosity) -> void
+
+    def verbosity=: (untyped verbosity) -> untyped
+
+    def verbosity_sym: () -> untyped
+
+    def debug1: (?untyped? progname) { (?) -> untyped } -> (nil | untyped)
+
+    def debug1?: () -> untyped
+
+    def debug1!: () -> untyped
+
+    def debug2: (?untyped? progname) { (?) -> untyped } -> (nil | untyped)
+
+    def debug2?: () -> untyped
+
+    def debug2!: () -> untyped
+
+    def debug3: (?untyped? progname) { (?) -> untyped } -> (nil | untyped)
+
+    def debug3?: () -> untyped
+
+    def debug3!: () -> untyped
+  end
+end

data/sig/bidi2pdf/version.rbs

@@ -0,0 +1,3 @@
+module Bidi2pdf
+  VERSION: "0.1.14"
+end

data/sig/bidi2pdf.rbs

@@ -1,4 +1,114 @@
 module Bidi2pdf
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  self.@logger: untyped
+
+  self.@network_events_logger: untyped
+
+  self.@browser_console_logger: untyped
+
+  self.@logging_subscriber: untyped
+
+  self.@notification_service: untyped
+
+  PAPER_FORMATS_CM: { letter: { width: ::Float, height: ::Float }, legal: { width: ::Float, height: ::Float }, tabloid: { width: ::Float, height: ::Float }, ledger: { width: ::Float, height: ::Float }, a0: { width: ::Float, height: ::Float }, a1: { width: ::Float, height: ::Float }, a2: { width: ::Float, height: ::Float }, a3: { width: ::Float, height: ::Float }, a4: { width: ::Float, height: ::Float }, a5: { width: ::Float, height: ::Float }, a6: { width: ::Float, height: ::Float } }
+
+  class Error < StandardError
+  end
+
+  class SessionNotStartedError < Error
+  end
+
+  class WebsocketError < Error
+  end
+
+  class ClientError < WebsocketError
+  end
+
+  class CmdError < ClientError
+    @cmd: untyped
+
+    @response: untyped
+
+    attr_reader cmd: untyped
+
+    attr_reader response: untyped
+
+    def initialize: (untyped cmd, untyped response) -> void
+  end
+
+  class CmdResponseNotStoredError < ClientError
+  end
+
+  class CmdTimeoutError < ClientError
+  end
+
+  class PrintError < Error
+  end
+
+  class ScreenshotError < Error
+  end
+
+  class ScriptInjectionError < Error
+  end
+
+  class StyleInjectionError < Error
+  end
+
+  class NotificationsError < Error
+    @causes: untyped
+
+    attr_reader causes: untyped
+
+    def initialize: (untyped causes) -> void
+  end
+
+  class NavigationError < Error
+  end
+
+  class NavigationAuthError < NavigationError
+    @url: untyped
+
+    attr_reader url: untyped
+
+    def initialize: (untyped url, ?untyped? message) -> void
+  end
+
+  class NavigationTimeoutError < NavigationError
+  end
+
+  class NavigationNotFoundError < NavigationError
+  end
+
+  class NavigationDNSError < NavigationError
+  end
+
+  attr_accessor self.default_timeout: untyped
+
+  attr_accessor self.enable_default_logging_subscriber: untyped
+
+  attr_reader self.logging_subscriber: untyped
+
+  attr_reader self.logger: untyped
+
+  attr_reader self.network_events_logger: untyped
+
+  attr_reader self.browser_console_logger: untyped
+
+  attr_reader self.notification_service: untyped
+
+  # Allow configuration through a block
+  def self.configure: () ?{ (untyped) -> untyped } -> untyped
+
+  def self.init: () -> untyped
+
+  def self.translate_paper_format: (untyped format) -> { width: untyped, height: untyped }
+
+  def self.logger=: (untyped new_logger) -> untyped
+
+  def self.network_events_logger=: (untyped new_network_events_logger) -> untyped
+
+  def self.browser_console_logger=: (untyped new_browser_console_logger) -> untyped
+
+  def self.logging_subscriber=: (untyped new_logging_subscriber) -> untyped
+
+  def self.notification_service=: (untyped new_notification_service) -> untyped
 end

data/tasks/generate_rbs.rake

@@ -6,7 +6,7 @@ require "rbs"
 SOURCE_DIR = "lib"
 OUTPUT_DIR = "sig"
 
-# rubocop:disable  Metrics/BlockLength
+# rubocop:disable-next  Metrics/BlockLength
 namespace :rbs do
   file_list = FileList["#{SOURCE_DIR}/**/*.rb"]
 
@@ -32,15 +32,11 @@ namespace :rbs do
         parser = RBS::Prototype::RB.new
         parser.parse input.read
 
-        if output.file?
-          puts "⚠️  RBS file already exists: #{rbs_path}"
-        else
-          puts "📝 Writing RBS file: #{rbs_path}"
+        puts "📝 Writing RBS file: #{rbs_path}"
 
-          output.open("w") do |io|
-            writer = RBS::Writer.new(out: io)
-            writer.write(parser.decls)
-          end
+        output.open("w") do |io|
+          writer = RBS::Writer.new(out: io)
+          writer.write(parser.decls)
         end
       rescue StandardError => e
         puts "❌ Error generating RBS for #{rb_path}: #{e.message}"
@@ -55,10 +51,14 @@ namespace :rbs do
 
   desc "Clean all generated RBS files"
   task :clean_rbs do
-    FileList["#{OUTPUT_DIR}/**/*.rbs"].each do |file|
+    # sig/vendor/** holds hand-written signatures for third-party gems (e.g. Thor) with no
+    # corresponding lib/ source to regenerate from - excluded so a clean+regenerate cycle can't
+    # delete them with no way to get them back.
+    generated = FileList["#{OUTPUT_DIR}/**/*.rbs"].exclude("#{OUTPUT_DIR}/vendor/**")
+
+    generated.each do |file|
       FileUtils.rm_f(file)
     end
     puts "🧹 Cleaned up all RBS files"
   end
 end
-# rubocop:enable Metrics/BlockLength