bidi2pdf-rails 0.0.1.alpha.1

data/lib/bidi2pdf_rails.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require "bidi2pdf"
+require "bidi2pdf/bidi/commands/print_parameters_validator"
+require_relative "bidi2pdf_rails/version"
+require_relative "bidi2pdf_rails/railtie"
+require_relative "bidi2pdf_rails/chromedriver_manager_singleton"
+require_relative "bidi2pdf_rails/main_log_subscriber"
+require_relative "bidi2pdf_rails/browser_console_log_subscriber"
+require_relative "bidi2pdf_rails/network_log_subscriber"
+
+module Bidi2pdfRails
+  class << self
+    attr_accessor :logger, :notification_service, :verbosity, :default_timeout, :remote_browser_url, :cookies,
+                  :headers, :auth, :headless, :chromedriver_port, :chrome_session_args,
+                  :proxy_addr, :proxy_port, :proxy_user, :proxy_pass, :install_dir,
+                  :pdf_page_width, :pdf_page_height,
+                  :pdf_margin_top, :pdf_margin_bottom, :pdf_margin_left, :pdf_margin_right,
+                  :pdf_scale, :pdf_shrink_to_fit, :pdf_print_background, :pdf_page_format, :pdf_orientation, :verbosity,
+                  :wait_for_network_idle, :wait_for_page_loaded, :wait_for_page_check_script
+
+    # Allow configuration through a block
+    def configure
+      yield self if block_given?
+
+      validate_print_options! print_options
+      apply_bidi2pdf_config
+    end
+
+    def validate_print_options!(opts)
+      validator = Bidi2pdf::Bidi::Commands::PrintParametersValidator.new(opts)
+
+      validator.validate!
+    end
+
+    def print_options(overrides = {})
+      overrides ||= {}
+      opts = {}
+
+      opts[:background] = pdf_print_background unless pdf_print_background.nil?
+      opts[:orientation] = pdf_orientation unless pdf_orientation.nil?
+      opts[:scale] = pdf_scale unless pdf_scale.nil?
+      opts[:shrinkToFit] = pdf_shrink_to_fit unless pdf_shrink_to_fit.nil?
+
+      # Margins
+      margins = {
+        top: @pdf_margin_top,
+        bottom: @pdf_margin_bottom,
+        left: @pdf_margin_left,
+        right: @pdf_margin_right
+      }.compact
+
+      opts[:margin] = margins unless margins.empty?
+
+      # Page size
+      page = {
+        width: @pdf_page_width,
+        height: @pdf_page_height,
+        format: @pdf_page_format
+      }.compact
+
+      page = overrides[:page].compact if overrides[:page]&.compact.present?
+
+      opts[:page] = page unless page.empty?
+
+      opts.deep_merge(overrides)
+    end
+
+    def apply_bidi2pdf_config
+      # Allow configuration through a block
+      Bidi2pdf.configure do |config|
+        config.notification_service = notification_service
+
+        config.logger = logger.tagged("bidi2pdf")
+        config.default_timeout = default_timeout
+
+        config.network_events_logger = Logger.new(nil)
+        config.browser_console_logger = Logger.new(nil) # Disable browser console logging
+
+        config.enable_default_logging_subscriber = false
+      end
+
+      Chromedriver::Binary.configure do |config|
+        config.logger = logger
+
+        config.proxy_addr = proxy_addr
+        config.proxy_port = proxy_port
+        config.proxy_user = proxy_user
+        config.proxy_pass = proxy_pass
+
+        config.install_dir = install_dir
+      end
+    end
+
+    def use_local_chromedriver?
+      !use_remote_browser?
+    end
+
+    def use_remote_browser?
+      remote_browser_url.present?
+    end
+
+    def reset_to_defaults!
+      @logger = nil
+      @default_timeout = 10
+      @verbosity = 0
+      @remote_browser_url = nil
+      @cookies = {}
+      @headers = {}
+      @auth = nil
+      @headless = !Rails.env.development?
+      @chromedriver_port = 0
+      @chrome_session_args = Bidi2pdf::Bidi::Session::DEFAULT_CHROME_ARGS
+
+      @proxy_addr = nil
+      @proxy_port = nil
+      @proxy_user = nil
+      @proxy_pass = nil
+      @install_dir = nil
+
+      @wait_for_network_idle = true
+      @wait_for_page_loaded = false
+      @wait_for_page_check_script = nil
+
+      @pdf_print_background = true
+      @pdf_orientation = "portrait"
+      @pdf_page_width = Bidi2pdf::PAPER_FORMATS_CM[:a4][:width]
+      @pdf_page_height = Bidi2pdf::PAPER_FORMATS_CM[:a4][:height]
+      @pdf_page_format = nil
+
+      @pdf_shrink_to_fit = nil
+      @pdf_scale = 1.0
+    end
+
+    def logger
+      @logger ||= Rails.logger # lazy load the logger, after it exists
+    end
+  end
+
+  self.reset_to_defaults!
+end

data/lib/generators/bidi2pdf_rails/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate initializer Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/bidi2pdf_rails/initializer_generator.rb

@@ -0,0 +1,74 @@
+module Bidi2pdfRails
+  class InitializerGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+    desc "Generates a config/initializers/bidi2pdf.rb config file"
+
+    class_option :force, type: :boolean, default: false, desc: "Overwrite existing file"
+    class_option :quiet, type: :boolean, default: false, desc: "Skip prompts"
+
+    def ask_questions
+      return if options[:quiet]
+
+      @log_network_events = yes?("Log network traffic? (y/n)", :green)
+      @log_browser_console = yes?("Log browser console output? (y/n)", :green)
+      @headless = yes?("Run Chrome in headless mode? (y/n)", :green)
+      @proxy = yes?("Use a proxy server? (y/n)", :green)
+
+      if @proxy
+        @proxy_addr = ask("Proxy address (e.g., 127.0.0.1):", :yellow)
+        @proxy_port = ask("Proxy port (e.g., 8080):", :yellow)
+      end
+
+      @configure_pdf = yes?("Configure custom PDF settings? (y/n)", :green)
+      if @configure_pdf
+        @pdf_orientation = ask("PDF orientation (portrait/landscape):", :yellow)
+        @pdf_margins = yes?("Configure PDF margins? (y/n)", :green)
+        if @pdf_margins
+          @pdf_margin_top = ask("PDF margin top (mm):", :yellow)
+          @pdf_margin_bottom = ask("PDF margin bottom (mm):", :yellow)
+          @pdf_margin_left = ask("PDF margin left (mm):", :yellow)
+          @pdf_margin_right = ask("PDF margin right (mm):", :yellow)
+        end
+        @pdf_page = yes?("Configure PDF page size? (y/n)", :green)
+        if @pdf_page
+          @pdf_page_width = ask("PDF page width (mm):", :yellow)
+          @pdf_page_height = ask("PDF page height (mm):", :yellow)
+        end
+
+        @pdf_print_background = yes?("Print background graphics? (y/n)", :green)
+        @pdf_scale = ask("PDF scale (e.g., 1.0):", :yellow)
+        @shrink_to_fit = ask("Shrink to fit? (y/n)", :green)
+      end
+    end
+
+    def generate_config
+      @config_path = "config/initializers/bidi2pdf_rails.rb"
+
+      template "bidi2pdf_rails.rb.tt", @config_path
+    end
+
+    def inject_environment_config
+      env_file = "config/environments/development.rb"
+
+      if File.exist?(env_file)
+        if File.read(env_file).include?("config.x.bidi2pdf_rails")
+          say_status :skipped, "Bidi2PDF settings already present in #{env_file}", :yellow
+        else
+          content = <<~RUBY.gsub(/^(?=[\w#])/, "  ")
+            # Custom Bidi2PDF settings, check config/initializers/bidi2pdf_rails.rb for hints
+            config.x.bidi2pdf_rails.headless = false
+            config.x.bidi2pdf_rails.verbosity = :high
+            # config.x.bidi2pdf_rails.log_browser_console = true
+            # config.x.bidi2pdf_rails.default_timeout = 60
+          RUBY
+
+          inject_into_file env_file, content, before: /^end\s*$/
+
+          say_status :modified, env_file, :green
+        end
+      else
+        say_status :error, "Could not find #{env_file}", :red
+      end
+    end
+  end
+end

data/lib/generators/bidi2pdf_rails/templates/bidi2pdf_rails.rb.tt

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+Bidi2pdfRails.configure do |config|
+  overrides = Rails.application.config.x.bidi2pdf_rails
+
+  config.notification_service = ActiveSupport::Notifications
+
+  config.logger = Rails.logger
+  config.verbosity = overrides.verbosity.nil? ? :none : overrides.verbosity
+  config.default_timeout = 10
+
+  # Chrome & BiDi
+  # config.remote_browser_url = nil
+  config.headless = overrides.headless.nil? ? <%= @headless ? "true" : "false" %> : overrides.headless
+  #
+  # alternative to remote_browser_url
+  #
+  # config.chromedriver_port = 0
+  # config.chrome_session_args = [
+  #   "--disable-gpu",
+  #   "--no-sandbox"
+  # ]
+
+<% if @proxy %>
+  config.proxy_addr = "<%= @proxy_addr %>"
+  config.proxy_port = <%= @proxy_port %>
+  config.proxy_user = nil
+  config.proxy_pass = nil
+<% else %>
+  # config.proxy_addr = nil
+  # config.proxy_port = nil
+  # config.proxy_user = nil
+  # config.proxy_pass = nil
+<% end %>
+
+  # PDF settings (css media settings take precedence over these)
+<% if @configure_pdf %>
+
+  config.pdf_orientation = "<%= @pdf_orientation || "portrait" %>"
+  <% if @pdf_margins %>
+  config.pdf_margin_top = <%= @pdf_margin_top || 2.5 %>
+  config.pdf_margin_bottom = <%= @pdf_margin_bottom || 2 %>
+  config.pdf_margin_left = <%= @pdf_margin_left || 2 %>
+  config.pdf_margin_right = <%= @pdf_margin_right || 2 %>
+  <% else %>
+  # config.pdf_margin_top = 2.5
+  # config.pdf_margin_bottom = 2
+  # config.pdf_margin_left = 2
+  # config.pdf_margin_right = 2
+  <% end %>
+
+  <% if @pdf_page %>
+    # Page settings
+    config.pdf_page_width = <%= @pdf_page_width || Bidi2pdf::PAPER_FORMATS_CM[:a4][:width] %>
+    config.pdf_page_height = <%= @pdf_page_height || Bidi2pdf::PAPER_FORMATS_CM[:a4][:height] %>
+  <% else %>
+    # Page settings
+    # config.pdf_page_format = "A4"
+    #
+    # or custom page size
+    #
+    # config.pdf_page_width = <%= Bidi2pdf::PAPER_FORMATS_CM[:a4][:width] %>
+    # config.pdf_page_height = <%= Bidi2pdf::PAPER_FORMATS_CM[:a4][:height] %>
+  <% end %>
+
+  config.pdf_print_background = <%= @pdf_print_background ? "true" : "false" %>
+  config.pdf_scale = <%= @pdf_scale || 1.0 %>
+  config.shrink_to_fit = <%= @shrink_to_fit ? "true" : "false" %>
+<% else %>
+  # config.pdf_orientation = "portrait"
+  # config.pdf_margin_top = 2.5
+  # config.pdf_margin_bottom = 2
+  # config.pdf_margin_left = 2
+  # config.pdf_margin_right = 2
+  # config.pdf_print_background = true
+  # config.pdf_scale = 1.0
+  # config.shrink_to_fit = true
+
+  # Page settings
+  # config.pdf_page_format = "A4"
+  #
+  # or custom page size
+  #
+  # config.pdf_page_width = <%= Bidi2pdf::PAPER_FORMATS_CM[:a4][:width] %>
+  # config.pdf_page_height = <%= Bidi2pdf::PAPER_FORMATS_CM[:a4][:height] %>
+<% end %>
+
+  # config.cookies = [
+  #   { name: "session", value: "abc123", domain: "example.com" }
+  # ]
+
+  # config.headers = {
+  #   "X-API-KEY" => "topsecret"
+  # }
+
+  # config.auth = {
+  #   username: "admin",
+  #   password: "secret"
+  # }
+
+  # chromedriver install dir
+  # config.install_dir = Rails.root.join("tmp", "bidi2pdf").to_s
+
+  # wait for the page to load settings
+  # config.wait_for_network_idle = true
+  # config.wait_for_page_loaded = false
+  # this script can be any valid JS script that returns a Promise
+  # it will wait for the Promise to resolve
+  # config.wait_for_page_check_script = nil
+end
+
+Rails.application.config.after_initialize do
+  Bidi2pdfRails::MainLogSubscriber.attach_to "bidi2pdf", inherit_all: true # needed for imported methods
+  Bidi2pdfRails::MainLogSubscriber.attach_to "bidi2pdf_rails", inherit_all: true # needed for imported methods
+
+  Bidi2pdfRails::BrowserConsoleLogSubscriber.attach_to "bidi2pdf"
+
+  Bidi2pdfRails::MainLogSubscriber.silence /network_event_.*\.bidi2pdf/
+
+  Bidi2pdfRails::NetworkLogSubscriber.attach_to "bidi2pdf"
+end

data/spec/bidi2pdf_rails/bidi2pdf_rails_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "../rails_helper"
+
+RSpec.describe Bidi2pdfRails do
+  it "has a version number" do
+    expect(Bidi2pdfRails::VERSION).not_to be_nil
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks