bidi2pdf-rails 0.0.1.pre.alpha

data/README.md

@@ -0,0 +1,75 @@
+[![Build Status](https://github.com/dieter-medium/bidi2pdf-rails/actions/workflows/ruby.yml/badge.svg)](https://github.com/dieter-medium/bidi2pdf-rails/blob/main/.github/workflows/ruby.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/6425d9893aa3a9ca243e/maintainability)](https://codeclimate.com/github/dieter-medium/bidi2pdf-rails/maintainability)
+[![Gem Version](https://badge.fury.io/rb/bidi2pdf-rails.svg)](https://badge.fury.io/rb/bidi2pdf-rails)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/6425d9893aa3a9ca243e/test_coverage)](https://codeclimate.com/github/dieter-medium/bidi2pdf-rails/test_coverage)
+[![Open Source Helpers](https://www.codetriage.com/dieter-medium/bidi2pdf-rails/badges/users.svg)](https://www.codetriage.com/dieter-medium/bidi2pdf-rails)
+
+
+# 📄 Bidi2pdfRails
+
+**Bidi2pdfRails** is the official Rails integration for [Bidi2pdf](https://github.com/dieter-medium/bidi2pdf) – a modern, browser-based solution for converting HTML to high-quality PDFs.  
+It leverages headless browsing and offers a simple, flexible interface for PDF generation directly from your Rails application.
+
+> **⚠️ Note:** This project is currently **under development** and **not yet recommended for production use**.
+
+---
+
+## 🚀 Why Bidi2pdfRails?
+
+- Utilizes modern browser technologies for accurate rendering (similar to `grover` or `wicked_pdf`)
+- Easy to integrate into existing Rails projects
+- Configurable options: URL, output path, rendering settings
+
+---
+
+## 🔧 Installation
+
+Add the following lines to your `Gemfile`:
+
+```ruby
+gem "bidi2pdf-rails"
+# As long as the gem is not published, use:
+gem "bidi2pdf-rails", github: "dieter-medium/bidi2pdf", branch: "main"
+gem "bidi2pdf", github: "dieter-medium/bidi2pdf", branch: "main"
+```
+
+Then install the dependencies:
+
+```bash
+bundle
+```
+
+Generate the initializer:
+
+```bash
+bin/rails generate bidi2pdf_rails:initializer
+```
+
+Alternatively, install it manually:
+
+```bash
+gem install bidi2pdf-rails
+```
+
+---
+
+## 🧪 Example & Getting Started
+
+You can find a full example inside the [`spec/dummy`](spec/dummy) directory of this repository.  
+This demonstrates how to use `Bidi2pdfRails` in a realistic mini Rails application setup.
+
+---
+
+## 🙌 Contributing
+
+Want to contribute?  
+Pull requests, bug reports, and ideas are warmly welcome!
+
+*Contribution guidelines will be added soon.*
+
+---
+
+## 📄 License
+
+This gem is open-source and available under the terms of the [MIT License](https://opensource.org/licenses/MIT).  
+Free to use – with responsibility.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new

data/lib/bidi2pdf-rails.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# just to get the nicer gem name
+require_relative "bidi2pdf_rails"

data/lib/bidi2pdf_rails/chromedriver_manager_singleton.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Bidi2pdfRails
+  module ChromedriverManagerSingleton
+    class << self
+      attr_reader :manager, :session
+
+      def initialize_manager
+        return unless running_as_server?
+
+        @mutex ||= Mutex.new
+        @mutex.synchronize do
+          return if @manager && @session
+
+          msg = Bidi2pdfRails.remote_browser_url ? "Remote session" : "ChromeDriver manager"
+
+          Bidi2pdfRails.logger.info "Initializing Bidi2pdf #{msg}"
+
+          if Bidi2pdfRails.remote_browser_url
+            @session = Bidi::Session.new(
+              session_url: Bidi2pdfRails.remote_browser_url,
+              headless: Bidi2pdfRails.headless,
+              chrome_args: Bidi2pdfRails.chrome_session_args
+            )
+          else
+            @manager = Bidi2pdf::ChromedriverManager.new(
+              port: Bidi2pdfRails.chromedriver_port,
+              headless: Bidi2pdfRails.headless,
+              chrome_args: Bidi2pdfRails.chrome_session_args
+            )
+            @manager.start
+            @session = @manager.session
+          end
+
+          @session.start
+          @session.client.on_close { Bidi2pdfRails.logger.info "WebSocket session closed" }
+        end
+      end
+
+      def shutdown
+        return unless running_as_server?
+
+        @mutex ||= Mutex.new
+        @mutex.synchronize do
+          msg = Bidi2pdfRails.remote_browser_url ? "Remote session" : "ChromeDriver manager"
+          Bidi2pdfRails.logger.info "Shutting down Bidi2pdf #{msg}"
+          @session&.close
+          @manager&.stop
+          @session = nil
+          @manager = nil
+        end
+      end
+
+      def running_as_server?
+        return false if Rails.const_defined?(:Console)
+        return false if defined?(Rails::Generators)
+
+        return false if File.basename($0) == "rake"
+
+        # Covers common Rails server entrypoints
+        server_commands = %w[server puma unicorn passenger thin webrick rackup]
+        cmdline = File.basename($0)
+
+        server_commands.any? { |s| cmdline.include?(s) } ||
+          Rails.const_defined?("Server")
+      end
+    end
+  end
+end

data/lib/bidi2pdf_rails/log_subscriber.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Bidi2pdfRails
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    include Bidi2pdf::Notifications::LoggingSubscriberActions
+
+    def logger
+      Bidi2pdf::VerboseLogger.new(super.tagged("bidi2pdf_rails"), Bidi2pdfRails.verbosity)
+    end
+  end
+end
+
+Bidi2pdfRails::LogSubscriber.attach_to "bidi2pdf", inherit_all: true

data/lib/bidi2pdf_rails/railtie.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Bidi2pdfRails
+  class Railtie < ::Rails::Railtie
+    initializer "bidi2pdf_rails.add_mime_type" do
+      Mime::Type.register "application/pdf", :pdf unless Mime::Type.lookup_by_extension(:pdf)
+    end
+
+    initializer "bidi2pdf_rails.initialize_chromedriver_manager", after: :load_config_initializers do
+      Bidi2pdfRails.apply_bidi2pdf_config
+
+      Rails.application.config.after_initialize do
+        ChromedriverManagerSingleton.initialize_manager
+      end
+    end
+
+    config.after_initialize do
+      # Set up shutdown hook for when the application stops
+      at_exit do
+        ChromedriverManagerSingleton.shutdown
+      end
+    end
+
+    initializer "bidi2pdf_rails.add_pdf_renderer" do
+      ActionController::Renderers.add :pdf do |filename, options|
+        pdf_data = ""
+        options = options.dup
+
+        original_asset_host = ActionController::Base.asset_host
+
+        if options[:asset_host]
+          ActionController::Base.asset_host = options[:asset_host]
+        elsif !Rails.application.config.action_controller.asset_host
+          # Use request base URL as fallback if no asset host configured
+          ActionController::Base.asset_host = request.base_url
+        end
+
+        html = render_to_string(options.merge(formats: [ :html ]))
+
+        Bidi2pdf.default_timeout = 30
+
+        # without a thread, the app will be blocked in dev mode
+        thread = Thread.new {
+          Rails.application.executor.wrap do
+            # subscriptions in other threads will not be inherited
+            Bidi2pdfRails::LogSubscriber.attach_to "bidi2pdf", inherit_all: true
+
+            browser = ChromedriverManagerSingleton.session.browser
+            context = browser.create_user_context
+            window = context.create_browser_window
+            tab = window.create_browser_tab
+
+            tab.render_html_content html
+
+            tab.wait_until_network_idle
+
+            tab.wait_until_page_loaded
+
+            pdf_data = tab.print
+          ensure
+            tab&.close
+            window&.close
+            context&.close
+          end
+        }
+
+        thread.join
+
+        send_data Base64.decode64(pdf_data),
+                  type: Mime[:pdf],
+                  filename: "#{filename}.pdf",
+                  disposition: options.fetch(:disposition, "inline")
+      ensure
+
+        ActionController::Base.asset_host = original_asset_host
+      end
+    end
+  end
+end

data/lib/bidi2pdf_rails/version.rb

@@ -0,0 +1,3 @@
+module Bidi2pdfRails
+    VERSION = "0.0.1.pre.alpha"
+end

data/lib/bidi2pdf_rails.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "bidi2pdf"
+require "bidi2pdf_rails/version"
+require "bidi2pdf_rails/railtie"
+require "bidi2pdf_rails/chromedriver_manager_singleton"
+require "bidi2pdf_rails/log_subscriber"
+
+module Bidi2pdfRails
+  class << self
+    attr_accessor :logger, :notification_service, :verbosity, :default_timeout, :log_network_events, :log_browser_console, :remote_browser_url, :cookies,
+                  :headers, :auth, :headless, :chromedriver_port, :chrome_session_args,
+                  :proxy_addr, :proxy_port, :proxy_user, :proxy_pass, :install_dir,
+                  :viewport_width, :viewport_height,
+                  :pdf_margin_top, :pdf_margin_bottom, :pdf_margin_left, :pdf_margin_right,
+                  :pdf_scale, :pdf_print_background, :pdf_format, :pdf_orientation, :verbosity
+
+    # Allow configuration through a block
+    def configure
+      yield self if block_given?
+
+      apply_bidi2pdf_config
+    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
+
+        if log_network_events
+          config.network_events_logger = logger.tagged("bidi2pdf", "network")
+        else
+          config.network_events_logger = Logger.new(nil) # Disable network events logging
+        end
+
+        if log_browser_console
+          config.browser_console_logger = logger.tagged("bidi2pdf", "browser_console")
+        else
+          config.browser_console_logger = Logger.new(nil) # Disable browser console logging
+        end
+
+        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 reset_to_defaults!
+      @logger = nil
+      @default_timeout = 10
+      @log_network_events = false
+      @log_browser_console = true
+      @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
+    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,73 @@
+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_viewport = yes?("Configure custom viewport? (y/n)", :green)
+      if @configure_viewport
+        @viewport_width = ask("Viewport width (e.g., 1920):", :yellow)
+        @viewport_height = ask("Viewport height (e.g., 1080):", :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_print_background = yes?("Print background graphics? (y/n)", :green)
+        @pdf_scale = ask("PDF scale (e.g., 1.0):", :yellow)
+      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,89 @@
+# 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
+
+  # Logging options
+  config.log_network_events = <%= @log_network_events ? "true" : "false" %>
+  config.log_browser_console = <%= @log_browser_console ? "true" : "false" %>
+
+  # Chrome & BiDi
+  # config.remote_browser_url = nil
+  config.headless = overrides.headless.nil? ? <%= @headless ? "true" : "false" %> : overrides.headless
+  # 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 %>
+
+<% if @configure_viewport %>
+  # Viewport settings
+  config.viewport_width = <%= @viewport_width || 1920 %>
+  config.viewport_height = <%= @viewport_height || 1080 %>
+<% else %>
+  # Viewport settings
+  # config.viewport_width = 1920
+  # config.viewport_height = 1080
+<% end %>
+
+<% if @configure_pdf %>
+  # PDF settings
+  config.pdf_orientation = "<%= @pdf_orientation || "portrait" %>"
+  <% if @pdf_margins %>
+  config.pdf_margin_top = <%= @pdf_margin_top || 10 %>
+  config.pdf_margin_bottom = <%= @pdf_margin_bottom || 10 %>
+  config.pdf_margin_left = <%= @pdf_margin_left || 10 %>
+  config.pdf_margin_right = <%= @pdf_margin_right || 10 %>
+  <% else %>
+  # config.pdf_margin_top = 10
+  # config.pdf_margin_bottom = 10
+  # config.pdf_margin_left = 10
+  # config.pdf_margin_right = 10
+  <% end %>
+  config.pdf_print_background = <%= @pdf_print_background ? "true" : "false" %>
+  config.pdf_scale = <%= @pdf_scale || 1.0 %>
+<% else %>
+  # PDF settings
+  # config.pdf_orientation = "portrait"
+  # config.pdf_margin_top = 10
+  # config.pdf_margin_bottom = 10
+  # config.pdf_margin_left = 10
+  # config.pdf_margin_right = 10
+  # config.pdf_print_background = true
+  # config.pdf_scale = 1.0
+<% 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
+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