bidi2pdf 0.1.12 → 0.1.14

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bidi2pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.14
 platform: ruby
 authors:
 - Dieter S.
@@ -67,16 +67,22 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -195,14 +201,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -293,14 +299,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: testcontainers
   requirement: !ruby/object:Gem::Requirement
@@ -379,6 +385,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/devcontainer.json"
+- ".devcontainer/docker-compose.yml"
 - ".idea/.gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -392,6 +401,7 @@ files:
 - docker/Dockerfile
 - docker/Dockerfile.chromedriver
 - docker/Dockerfile.slim
+- docker/chrome-driver/chrome.json
 - docker/docker-compose.yml
 - docker/entrypoint.sh
 - docker/nginx/default.conf
@@ -415,6 +425,7 @@ files:
 - lib/bidi2pdf/bidi/commands/browsing_context_navigate.rb
 - lib/bidi2pdf/bidi/commands/browsing_context_print.rb
 - lib/bidi2pdf/bidi/commands/cancel_auth.rb
+- lib/bidi2pdf/bidi/commands/capture_screenshot.rb
 - lib/bidi2pdf/bidi/commands/cdp_get_session.rb
 - lib/bidi2pdf/bidi/commands/create_tab.rb
 - lib/bidi2pdf/bidi/commands/create_window.rb
@@ -429,6 +440,7 @@ files:
 - lib/bidi2pdf/bidi/commands/session_subscribe.rb
 - lib/bidi2pdf/bidi/commands/set_tab_cookie.rb
 - lib/bidi2pdf/bidi/commands/set_usercontext_cookie.rb
+- lib/bidi2pdf/bidi/commands/set_viewport.rb
 - lib/bidi2pdf/bidi/connection_manager.rb
 - lib/bidi2pdf/bidi/event_manager.rb
 - lib/bidi2pdf/bidi/interceptor.rb
@@ -471,6 +483,7 @@ files:
 - lib/bidi2pdf/test_helpers/testcontainers.rb
 - lib/bidi2pdf/test_helpers/testcontainers/chromedriver_container.rb
 - lib/bidi2pdf/test_helpers/testcontainers/chromedriver_test_helper.rb
+- lib/bidi2pdf/test_helpers/testcontainers/container_endpoint.rb
 - lib/bidi2pdf/test_helpers/testcontainers/shared_docker_network.rb
 - lib/bidi2pdf/test_helpers/testcontainers/testcontainers_refinement.rb
 - lib/bidi2pdf/verbose_logger.rb
@@ -479,6 +492,7 @@ files:
 - sig/bidi2pdf/bidi/add_headers_interceptor.rbs
 - sig/bidi2pdf/bidi/auth_interceptor.rbs
 - sig/bidi2pdf/bidi/browser.rbs
+- sig/bidi2pdf/bidi/browser_console_logger.rbs
 - sig/bidi2pdf/bidi/browser_tab.rbs
 - sig/bidi2pdf/bidi/client.rbs
 - sig/bidi2pdf/bidi/command_manager.rbs
@@ -487,14 +501,18 @@ files:
 - sig/bidi2pdf/bidi/commands/base.rbs
 - sig/bidi2pdf/bidi/commands/browser_close.rbs
 - sig/bidi2pdf/bidi/commands/browser_create_user_context.rbs
+- sig/bidi2pdf/bidi/commands/browser_remove_user_context.rbs
 - sig/bidi2pdf/bidi/commands/browsing_context_close.rbs
 - sig/bidi2pdf/bidi/commands/browsing_context_navigate.rbs
 - sig/bidi2pdf/bidi/commands/browsing_context_print.rbs
 - sig/bidi2pdf/bidi/commands/cancel_auth.rbs
+- sig/bidi2pdf/bidi/commands/capture_screenshot.rbs
+- sig/bidi2pdf/bidi/commands/cdp_get_session.rbs
 - sig/bidi2pdf/bidi/commands/create_tab.rbs
 - sig/bidi2pdf/bidi/commands/create_window.rbs
 - sig/bidi2pdf/bidi/commands/get_user_contexts.rbs
 - sig/bidi2pdf/bidi/commands/network_continue.rbs
+- sig/bidi2pdf/bidi/commands/page_print.rbs
 - sig/bidi2pdf/bidi/commands/print_parameters_validator.rbs
 - sig/bidi2pdf/bidi/commands/provide_credentials.rbs
 - sig/bidi2pdf/bidi/commands/script_evaluate.rbs
@@ -503,20 +521,54 @@ files:
 - sig/bidi2pdf/bidi/commands/session_subscribe.rbs
 - sig/bidi2pdf/bidi/commands/set_tab_cookie.rbs
 - sig/bidi2pdf/bidi/commands/set_usercontext_cookie.rbs
+- sig/bidi2pdf/bidi/commands/set_viewport.rbs
 - sig/bidi2pdf/bidi/connection_manager.rbs
 - sig/bidi2pdf/bidi/event_manager.rbs
 - sig/bidi2pdf/bidi/interceptor.rbs
+- sig/bidi2pdf/bidi/js_logger_helper.rbs
+- sig/bidi2pdf/bidi/logger_events.rbs
+- sig/bidi2pdf/bidi/navigation_failed_events.rbs
 - sig/bidi2pdf/bidi/network_event.rbs
+- sig/bidi2pdf/bidi/network_event_formatters.rbs
+- sig/bidi2pdf/bidi/network_event_formatters/network_event_console_formatter.rbs
+- sig/bidi2pdf/bidi/network_event_formatters/network_event_formatter_utils.rbs
+- sig/bidi2pdf/bidi/network_event_formatters/network_event_html_formatter.rbs
 - sig/bidi2pdf/bidi/network_events.rbs
 - sig/bidi2pdf/bidi/session.rbs
 - sig/bidi2pdf/bidi/user_context.rbs
 - sig/bidi2pdf/bidi/web_socket_dispatcher.rbs
 - sig/bidi2pdf/chromedriver_manager.rbs
 - sig/bidi2pdf/cli.rbs
+- sig/bidi2pdf/dsl.rbs
 - sig/bidi2pdf/launcher.rbs
+- sig/bidi2pdf/notifications.rbs
+- sig/bidi2pdf/notifications/event.rbs
+- sig/bidi2pdf/notifications/instrumenter.rbs
+- sig/bidi2pdf/notifications/logging_subscriber.rbs
 - sig/bidi2pdf/process_tree.rbs
 - sig/bidi2pdf/session_runner.rbs
-- sig/bidi2pdf/utils.rbs
+- sig/bidi2pdf/test_helpers.rbs
+- sig/bidi2pdf/test_helpers/configuration.rbs
+- sig/bidi2pdf/test_helpers/images.rbs
+- sig/bidi2pdf/test_helpers/images/extractor.rbs
+- sig/bidi2pdf/test_helpers/images/image_similarity_checker.rbs
+- sig/bidi2pdf/test_helpers/images/tiff_helper.rbs
+- sig/bidi2pdf/test_helpers/matchers/contains_pdf_image.rbs
+- sig/bidi2pdf/test_helpers/matchers/contains_pdf_text.rbs
+- sig/bidi2pdf/test_helpers/matchers/have_pdf_page_count.rbs
+- sig/bidi2pdf/test_helpers/matchers/match_pdf_text.rbs
+- sig/bidi2pdf/test_helpers/pdf_file_helper.rbs
+- sig/bidi2pdf/test_helpers/pdf_reader_utils.rbs
+- sig/bidi2pdf/test_helpers/pdf_text_sanitizer.rbs
+- sig/bidi2pdf/test_helpers/spec_paths_helper.rbs
+- sig/bidi2pdf/test_helpers/testcontainers.rbs
+- sig/bidi2pdf/test_helpers/testcontainers/chromedriver_container.rbs
+- sig/bidi2pdf/test_helpers/testcontainers/chromedriver_test_helper.rbs
+- sig/bidi2pdf/test_helpers/testcontainers/container_endpoint.rbs
+- sig/bidi2pdf/test_helpers/testcontainers/shared_docker_network.rbs
+- sig/bidi2pdf/test_helpers/testcontainers/testcontainers_refinement.rbs
+- sig/bidi2pdf/verbose_logger.rbs
+- sig/bidi2pdf/version.rbs
 - sig/vendor/thor.rbs
 - tasks/changelog.rake
 - tasks/coverage.rake
@@ -538,14 +590,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.3.0
+      version: 3.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A Ruby gem that generates PDFs from web pages using Chrome's BiDi protocol,
   providing high-quality PDF documents from any URL with full support for modern web

data/sig/bidi2pdf/utils.rbs

@@ -1,5 +0,0 @@
-module Bidi2pdf
-  module Utils
-    def self?.timed: (untyped operation_name) { () -> untyped } -> untyped
-  end
-end