bidi2pdf-rails 0.0.1.alpha.1 → 0.1.0

data/lib/bidi2pdf_rails/config.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require_relative "configurable"
+
+module Bidi2pdfRails
+  class Config
+    include Bidi2pdfRails::Configurable
+
+    CONFIG_OPTIONS = {
+      general_options: {
+        name: "General Options",
+        ask: "Configure general options? (y/n)",
+        options: [
+          { name: :logger, desc: "The logger", default: -> { Rails.logger || ActiveSupport::TaggedLogging.new(Logger.new(nil)) }, default_as_str: "Rails.logger", ask: false, color: :yellow },
+          { name: :verbosity, desc: "How verbose to be", default: Bidi2pdf::VerboseLogger::VERBOSITY_LEVELS.keys.sort_by { |k| Bidi2pdf::VerboseLogger::VERBOSITY_LEVELS[k] }.first.to_s, limited_to: Bidi2pdf::VerboseLogger::VERBOSITY_LEVELS.keys.sort_by { |k| Bidi2pdf::VerboseLogger::VERBOSITY_LEVELS[k] }.map(&:to_s), ask: true, color: :yellow },
+          { name: :headless, desc: "Run Chrome in headless mode", default: -> { !Rails.env.development? }, default_as_str: "!Rails.env.development?", ask: true, color: :green },
+          { name: :wait_for_network_idle, desc: "Wait for network idle", default: true, ask: true, color: :green },
+          { name: :wait_for_page_loaded, desc: "Wait for page loaded", default: false, ask: true, color: :green },
+          { name: :wait_for_page_check_script, desc: "Wait for page check script", default: nil, ask: false },
+          { name: :notification_service, desc: "Notification service", default: -> { ActiveSupport::Notifications }, default_as_str: "-> { ActiveSupport::Notifications }", ask: false },
+          { name: :default_timeout, desc: "Default timeout for various Bidi commands", default: 10, ask: true, color: :yellow },
+          { name: :chrome_session_args, desc: "Chrome session arguments", default: Bidi2pdf::Bidi::Session::DEFAULT_CHROME_ARGS, ask: false }
+        ]
+      },
+
+      chromedriver_settings: {
+        name: "Chromedriver Settings (when chromedriver run within your app)",
+        ask: "Configure chromedriver settings? (y/n)",
+        options: [
+          { name: :install_dir, desc: "Chromedriver install directory", default: nil, ask: false, color: :yellow },
+          { name: :port, desc: "Chromedriver port", default: 0, ask: true, color: :yellow }
+        ]
+      },
+
+      proxy_settings: {
+        name: "Proxy Settings",
+        ask: "Use a proxy server? (y/n)",
+        options: [
+          { name: :addr, desc: "Proxy address (e.g., 127.0.0.1)", default: nil, ask: true, color: :yellow },
+          { name: :port, desc: "Proxy port (e.g., 8080)", default: nil, ask: true, color: :yellow },
+          { name: :user, desc: "Proxy user", default: nil, ask: true, color: :yellow },
+          {
+            name: :pass,
+            desc: "Proxy password",
+            default: -> { -> { Rails.application.credentials.dig("bidi2pdf_rails", "proxy_pass") } },
+            default_as_str: "-> { Rails.application.credentials.dig('bidi2pdf_rails', 'proxy_pass') }",
+            secret: true,
+            ask: true,
+            color: :yellow
+          }
+        ]
+      },
+
+      pdf_settings: {
+        name: "PDF Settings",
+        ask: "Configure custom PDF settings? (y/n)",
+        options: [
+          { name: :orientation, desc: "PDF orientation (portrait/landscape)", default: "portrait", limited_to: %w[portrait landscape], ask: true },
+          { name: :margins, desc: "Configure PDF margins?", default: false, ask: true, color: :green },
+          { name: :margin_top, desc: "PDF margin top (cm)", default: 2.5, ask: true, color: :yellow },
+          { name: :margin_bottom, desc: "PDF margin bottom (cm)", default: 2, ask: true, color: :yellow },
+          { name: :margin_left, desc: "PDF margin left (cm)", default: 2, ask: true, color: :yellow },
+          { name: :margin_right, desc: "PDF margin right (cm)", default: 2, ask: true, color: :yellow },
+          { name: :page_format, desc: "PDF page format (e.g., A4)", default: nil, limited_to: Bidi2pdf::PAPER_FORMATS_CM.keys.map(&:to_s), ask: true },
+          { name: :page_width, desc: "PDF page width (cm, not needed when format is specified)", default: Bidi2pdf::PAPER_FORMATS_CM[:a4][:width], ask: true, color: :yellow },
+          { name: :page_height, desc: "PDF page height (cm, not needed when format is specified)", default: Bidi2pdf::PAPER_FORMATS_CM[:a4][:height], ask: true, color: :yellow },
+          { name: :print_background, desc: "Print background graphics?", default: true, ask: true, color: :green },
+          { name: :scale, desc: "PDF scale (e.g., 1.0)", default: 1.0, ask: true, color: :yellow },
+          { name: :shrink_to_fit, desc: "Shrink to fit?", default: false, ask: true, color: :green }
+        ]
+      },
+
+      render_remote_settings: {
+        name: "Remote URL Settings",
+        ask: false,
+        options: [
+          { name: :browser_url, desc: "Remote browser URL (e.g. http://localhost:3001/sesion)", default: nil, ask: true, color: :yellow },
+          { name: :basic_auth_user, desc: "Basic auth user", default: nil },
+          { name: :basic_auth_pass, desc: "Basic auth password", default: nil, default_as_str: "-> { Rails.application.credentials.dig('bidi2pdf_rails', 'basic_auth_pass') }", secret: true },
+          { name: :headers, desc: "Headers to be send when allong an url", default: {}, default_as_str: '{"X-API-INFO" => "my info"}' },
+          { name: :cookies, desc: "Cookies to be send when alling an url", default: {}, default_as_str: '{"session_id" => "my session"}' }
+        ]
+      }
+
+    }.freeze
+
+    configure_with(CONFIG_OPTIONS)
+
+    def initialize
+      reset_to_defaults!
+    end
+
+    def pdf_settings_for_bidi_cmd(overrides = {})
+      overrides ||= {}
+      opts = {}
+
+      opts[:background] = pdf_settings.print_background_value
+      opts[:orientation] = pdf_settings.orientation_value
+      opts[:scale] = pdf_settings.scale_value
+      opts[:shrinkToFit] = pdf_settings.shrink_to_fit_value
+
+      # Margins
+      margins = {
+        top: pdf_settings.margin_top_value,
+        bottom: pdf_settings.margin_bottom_value,
+        left: pdf_settings.margin_left_value,
+        right: pdf_settings.margin_right_value
+      }.compact
+
+      opts[:margin] = margins unless margins.empty?
+
+      # Page size
+      page = {
+        width: pdf_settings.page_width_value,
+        height: pdf_settings.page_height_value,
+        format: pdf_settings.page_format_value
+      }.compact
+
+      page = overrides[:page].compact if overrides[:page]&.compact.present?
+      page = { format: page[:format] } if page[:format]
+
+      opts[:page] = page unless page.empty?
+
+      opts.deep_merge(overrides).compact
+    end
+
+    def validate_print_options!
+      validator = Bidi2pdf::Bidi::Commands::PrintParametersValidator.new(pdf_settings_for_bidi_cmd)
+
+      validator.validate!
+    end
+  end
+end

data/lib/bidi2pdf_rails/configurable.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Bidi2pdfRails
+  module Configurable
+    extend ActiveSupport::Concern
+    included do
+      include Singleton
+    end
+
+    class BaseNestedConfig
+      def initialize(option_defs)
+        @__options = option_defs
+        define_accessors!
+        reset_to_defaults!
+      end
+
+      def define_accessors!
+        @__options.each do |opt|
+          name = opt[:name]
+          unless respond_to?(name)
+            define_singleton_method(name) { instance_variable_get("@#{name}") }
+            define_singleton_method("#{name}=") { |v| instance_variable_set("@#{name}", v) }
+
+            define_singleton_method("#{name}_value") do |*args|
+              value = send("#{name}")
+              value.respond_to?(:call) ? value.call(*args) : value
+            end
+          end
+        end
+      end
+
+      def reset_to_defaults!
+        @__options.each do |opt|
+          default = opt[:default]
+          value = default
+          send("#{opt[:name]}=", value)
+        end
+      end
+
+      def config_options
+        @__options
+      end
+
+      def configure
+        yield self if block_given?
+      end
+
+      def to_h
+        @__options.to_h do |opt|
+          [opt[:name], send(opt[:name])]
+        end
+      end
+
+      def inspect
+        "#<#{self.class.name || "ConfigSection"} #{to_h.inspect}>"
+      end
+    end
+
+    def configure
+      yield self if block_given?
+    end
+
+    class_methods do
+      def configure_with(grouped_options)
+        @config_groups = grouped_options
+
+        grouped_options.each do |group_key, group_data|
+          group_class = Class.new(BaseNestedConfig)
+
+          define_method(group_key) do
+            ivar = "@#{group_key}"
+            instance_variable_get(ivar) || instance_variable_set(ivar, group_class.new(group_data[:options]))
+          end
+
+          define_method("#{group_key}=") do |val|
+            raise ArgumentError, "Use individual accessors, not direct assignment to config groups"
+          end
+        end
+
+        define_method(:reset_to_defaults!) do
+          grouped_options.each_key do |group_key|
+            section = send(group_key)
+            section.reset_to_defaults!
+          end
+        end
+
+        define_method(:config_groups) do
+          grouped_options
+        end
+
+        define_method(:to_h) do
+          grouped_options.keys.to_h do |group_key|
+            section = send(group_key)
+            [group_key, section.to_h]
+          end
+        end
+
+        define_method(:inspect) do
+          "#<#{self.class.name} #{to_h.inspect}>"
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf_rails/main_log_subscriber.rb

@@ -23,7 +23,7 @@ module Bidi2pdfRails
     end
 
     def logger
-      Bidi2pdf::VerboseLogger.new(super.tagged("bidi2pdf_rails"), Bidi2pdfRails.verbosity)
+      Bidi2pdf::VerboseLogger.new(super.tagged("bidi2pdf_rails"), Bidi2pdfRails.config.general_options.verbosity_value)
     end
 
     def silenced?(event)

data/lib/bidi2pdf_rails/network_log_subscriber.rb

@@ -10,7 +10,7 @@ module Bidi2pdfRails
       return if payload[:method] == "network.responseStarted" || payload[:method] == "network.beforeRequestSent"
 
       logger.tagged("bidi2pdf_rails", "network") do |tagged_logger|
-        verbose_logger = Bidi2pdf::VerboseLogger.new(tagged_logger, Bidi2pdfRails.verbosity)
+        verbose_logger = Bidi2pdf::VerboseLogger.new(tagged_logger, Bidi2pdfRails.config.general_options.verbosity_value)
         formatter = Bidi2pdf::Bidi::NetworkEventFormatters::NetworkEventConsoleFormatter.new(logger: verbose_logger)
 
         formatter.log [payload[:event]]

data/lib/bidi2pdf_rails/railtie.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "rails/railtie"
+
 require_relative "services/html_renderer"
 require_relative "services/pdf_renderer"
 require_relative "services/pdf_browser_session"

data/lib/bidi2pdf_rails/services/pdf_renderer.rb

@@ -26,6 +26,7 @@ module Bidi2pdfRails
         wait_for_network_idle
         wait_for_page_loaded
         wait_for_page_check_script
+        html
       ].freeze
 
       PRINT_URL_OPTIONS = %i[
@@ -45,15 +46,15 @@ module Bidi2pdfRails
 
       def render_pdf
         ActiveSupport::Notifications.instrument("handle_printing.bidi2pdf_rails") do
-          print_options = Bidi2pdfRails.print_options(@pdf_options[:print_options] || {})
-          wait_for_network_idle = @pdf_options.fetch(:wait_for_network_idle, Bidi2pdfRails.wait_for_network_idle)
-          wait_for_page_loaded = @pdf_options.fetch(:wait_for_page_loaded, Bidi2pdfRails.wait_for_page_loaded)
-          wait_for_page_check_script = @pdf_options.fetch(:wait_for_page_check_script, Bidi2pdfRails.wait_for_page_check_script)
+          print_options = Bidi2pdfRails.config.pdf_settings_for_bidi_cmd(@pdf_options[:print_options] || {})
+          wait_for_network_idle = @pdf_options.fetch(:wait_for_network_idle, Bidi2pdfRails.config.general_options.wait_for_network_idle_value)
+          wait_for_page_loaded = @pdf_options.fetch(:wait_for_page_loaded, Bidi2pdfRails.config.general_options.wait_for_page_loaded_value)
+          wait_for_page_check_script = @pdf_options.fetch(:wait_for_page_check_script, Bidi2pdfRails.config.general_options.wait_for_page_check_script_value)
 
           if @print_url_options[:url]
-            headers = @print_url_options[:headers] || Bidi2pdfRails.headers
-            cookies = @print_url_options[:cookies] || Bidi2pdfRails.cookies
-            auth = @print_url_options[:auth] || Bidi2pdfRails.auth
+            headers = @print_url_options[:headers] || Bidi2pdfRails.config.render_remote_settings.headers_value(@controller)
+            cookies = @print_url_options[:cookies] || Bidi2pdfRails.config.render_remote_settings.cookies_value(@controller)
+            auth = @print_url_options[:auth] || { username: Bidi2pdfRails.config.render_remote_settings.basic_auth_user_value(@controller), password: Bidi2pdfRails.config.render_remote_settings.basic_auth_pass_value(@controller) }
 
             UrlToPdfConverter.new(@print_url_options[:url],
                                   headers: headers,
@@ -65,7 +66,7 @@ module Bidi2pdfRails
                                   wait_for_page_check_script: wait_for_page_check_script
             ).generate
           else
-            html = HtmlRenderer.new(@controller, @html_options).render
+            html = @html_options.fetch(:inline, HtmlRenderer.new(@controller, @html_options).render)
 
             HtmlToPdfConverter.new(html,
                                    print_options: print_options,

data/lib/bidi2pdf_rails/version.rb

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

data/lib/bidi2pdf_rails.rb

@@ -3,6 +3,7 @@
 require "bidi2pdf"
 require "bidi2pdf/bidi/commands/print_parameters_validator"
 require_relative "bidi2pdf_rails/version"
+require_relative "bidi2pdf_rails/config"
 require_relative "bidi2pdf_rails/railtie"
 require_relative "bidi2pdf_rails/chromedriver_manager_singleton"
 require_relative "bidi2pdf_rails/main_log_subscriber"
@@ -11,84 +12,41 @@ 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
+    def config
+      Config.instance
+    end
 
     # Allow configuration through a block
     def configure
-      yield self if block_given?
-
-      validate_print_options! print_options
-      apply_bidi2pdf_config
-    end
+      yield config if block_given?
 
-    def validate_print_options!(opts)
-      validator = Bidi2pdf::Bidi::Commands::PrintParametersValidator.new(opts)
+      config.validate_print_options!
 
-      validator.validate!
+      apply_bidi2pdf_config config
     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?
+    def apply_bidi2pdf_config(config = Config.instance)
+      Bidi2pdf.configure do |bidi2pdf_config|
+        bidi2pdf_config.notification_service = config.general_options.notification_service_value
 
-      # Margins
-      margins = {
-        top: @pdf_margin_top,
-        bottom: @pdf_margin_bottom,
-        left: @pdf_margin_left,
-        right: @pdf_margin_right
-      }.compact
+        bidi2pdf_config.logger = config.general_options.logger_value&.tagged("bidi2pdf")
+        bidi2pdf_config.default_timeout = config.general_options.default_timeout_value
 
-      opts[:margin] = margins unless margins.empty?
+        bidi2pdf_config.network_events_logger = Logger.new(nil)
+        bidi2pdf_config.browser_console_logger = Logger.new(nil)
 
-      # 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
+        bidi2pdf_config.enable_default_logging_subscriber = false
       end
 
-      Chromedriver::Binary.configure do |config|
-        config.logger = logger
+      Chromedriver::Binary.configure do |chromedriver_config|
+        chromedriver_config.logger = config.general_options.logger_value&.tagged("bidi2pdf")
 
-        config.proxy_addr = proxy_addr
-        config.proxy_port = proxy_port
-        config.proxy_user = proxy_user
-        config.proxy_pass = proxy_pass
+        chromedriver_config.proxy_addr = config.proxy_settings.addr_value
+        chromedriver_config.proxy_port = config.proxy_settings.port_value
+        chromedriver_config.proxy_user = config.proxy_settings.user_value
+        chromedriver_config.proxy_pass = config.proxy_settings.pass_value
 
-        config.install_dir = install_dir
+        chromedriver_config.install_dir = config.chromedriver_settings.install_dir_value
       end
     end
 
@@ -97,45 +55,16 @@ module Bidi2pdfRails
     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
+      config.render_remote_settings.browser_url_value.present?
     end
 
     def logger
-      @logger ||= Rails.logger # lazy load the logger, after it exists
+      config.general_options.logger_value&.tagged("bidi2pdf-rails")
     end
   end
 
-  self.reset_to_defaults!
+  that = self
+  ActiveSupport.on_load(:action_controller_base, run_once: true) do
+    that.configure # apply the default configuration at load time
+  end
 end

data/lib/generators/bidi2pdf_rails/USAGE

@@ -1,8 +1,16 @@
 Description:
-    Explain the generator
+    Generates a configuration file for Bidi2pdfRails in config/initializers/bidi2pdf_rails.rb
+    and adds development environment settings.
 
 Example:
-    bin/rails generate initializer Thing
+    bin/rails generate bidi2pdf_rails:initializer
 
-    This will create:
-        what/will/it/create
+    # With options
+    bin/rails generate bidi2pdf_rails:initializer --quiet    # Skip interactive prompts
+    bin/rails generate bidi2pdf_rails:initializer --force    # Overwrite existing config
+
+This will create:
+    config/initializers/bidi2pdf_rails.rb
+
+And add settings to:
+    config/environments/development.rb