bidi2pdf-rails 0.1.0 → 0.1.1

data/spec/acceptance/user_can_inject_js_before_pdf_printing_spec.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+require "net/http"
+require "rack/handler/puma"
+require "socket"
+require "base64"
+
+RSpec.feature "As a user, I want to inject js into a website before printing a PDF", :pdf, type: :request do
+  before(:all) do
+    # Bidi2pdfRails.config.general_options.headless = false
+    Bidi2pdfRails::ChromedriverManagerSingleton.initialize_manager force: true
+  end
+
+  after(:all) do
+    Bidi2pdfRails::ChromedriverManagerSingleton.shutdown
+  end
+
+  scenario "Using raw CSS" do
+    # Controller setup:
+    #
+    # You can configure basic auth in two ways:
+    #
+    # 1. In an initializer (global config):
+    #
+    #   Bidi2pdfRails.configure do |config|
+    #     config.pdf_settings.custom_js = <<~JS
+    #        // insert styles into the page with javascript
+    #        document.head.insertAdjacentHTML('beforeend', `
+    #          <style>
+    #            p {
+    #               page-break-after: always;
+    #           }
+    #          </style>
+    #        `);
+    #        document.body.insertAdjacentHTML('beforeend', `
+    #           <p>7</p>
+    #           <p>8</p>
+    #        `);
+    #     JS
+    #
+    # 2. Inline within controller action:
+    #   js = <<~JS
+    #        // insert styles into the page with javascript
+    #        document.head.insertAdjacentHTML('beforeend', `
+    #          <style>
+    #            p {
+    #               page-break-after: always;
+    #           }
+    #          </style>
+    #        `);
+    #        document.body.insertAdjacentHTML('beforeend', `
+    #           <p>7</p>
+    #           <p>8</p>
+    #        `);
+    #   JS
+    #   render pdf: 'inject-js-raw',
+    #          custom_js: js,
+    #          layout: 'simple',
+    #          template: 'reports/simple',
+    #          wait_for_page_loaded: false,
+    #          print_options: { page: { format: :A4 } }
+    #
+
+    when_ "I request a PDF from a page and inject raw js" do
+      before do
+        with_pdf_settings :custom_js, <<-JS
+          // insert styles into the page with javascript
+          document.head.insertAdjacentHTML('beforeend', `
+              <style>
+                p {
+                  page-break-after: always;
+                }
+              </style>
+            `);
+            document.body.insertAdjacentHTML('beforeend', `
+              <p>7</p>
+              <p>8</p>
+            `);
+        JS
+
+        @response = get_pdf_response "/inject/raw-js"
+      end
+
+      then_ "I receive a successful HTTP response" do
+        expect(@response.code).to eq("200")
+      end
+
+      and_ "I receive a PDF file in response" do
+        expect(@response['Content-Type']).to eq("application/pdf")
+      end
+
+      and_ "the PDF contains the expected number of pages" do
+        expected_page_count = 8
+        expect(@response.body).to have_pdf_page_count(expected_page_count)
+      end
+
+      and_ "the disposition header is set to attachment" do
+        expect(@response['Content-Disposition']).to start_with('inline; filename="inject-raw-js.pdf"')
+      end
+
+      and_ 'the last page contains the expected content ("6")' do
+        expect(@response.body).to contains_pdf_text("6").at_page(6)
+      end
+    end
+  end
+
+  scenario "Using an external javascript file" do
+    # Controller setup:
+    #
+    # You can configure cookies in two ways:
+    #
+    # 1. In an initializer (global config):
+    #
+    #   Bidi2pdfRails.configure do |config|
+    #     config.pdf_settings.custom_js_url = ->(controller) { controller.view_context.asset_url 'javascripts/simple.js' }
+    #   end
+    #
+    # 2. Inline within controller action:
+    #
+    #   render pdf: 'inject-js-url',
+    #          custom_js_url: view_context.asset_url('javascripts/simple.js'),
+    #          layout: 'simple',
+    #          template: 'reports/simple',
+    #          wait_for_page_loaded: false,
+    #          print_options: { page: { format: :A4 } }
+    #
+
+    when_ "I request a PDF from a page and inject an external stylesheet" do
+      before do
+        with_pdf_settings :custom_js_url, ->(controller) { controller.view_context.asset_url 'javascripts/simple.js' }
+
+        @response = get_pdf_response "/inject/url-js"
+      end
+
+      then_ "I receive a successful HTTP response" do
+        expect(@response.code).to eq("200")
+      end
+
+      and_ "I receive a PDF file in response" do
+        expect(@response['Content-Type']).to eq("application/pdf")
+      end
+
+      and_ "the PDF contains the expected number of pages" do
+        expected_page_count = 8
+        expect(@response.body).to have_pdf_page_count(expected_page_count)
+      end
+
+      and_ "the disposition header is set to attachment" do
+        expect(@response['Content-Disposition']).to start_with('inline; filename="inject-url-js.pdf"')
+      end
+
+      and_ 'the last page contains the expected content ("6")' do
+        expect(@response.body).to contains_pdf_text(6).at_page(6)
+      end
+    end
+  end
+end

data/spec/dummy/app/assets/javascripts/simple.js

@@ -0,0 +1,12 @@
+// insert styles into the page with javascript
+document.head.insertAdjacentHTML('beforeend', `
+              <style>
+                p {
+                  page-break-after: always;
+                }
+              </style>
+            `);
+document.body.insertAdjacentHTML('beforeend', `
+              <p>7</p>
+              <p>8</p>
+            `);

data/spec/dummy/app/assets/stylesheets/simple.css

@@ -0,0 +1,3 @@
+p {
+    page-break-after: always;
+}

data/spec/dummy/app/controllers/reports_controller.rb

@@ -25,6 +25,10 @@ class ReportsController < ApplicationController
     render pdf: 'inline-html', inline: html, wait_for_page_loaded: false, print_options: { page: { format: :A4 } }
   end
 
+  def inject
+    render pdf: "inject-#{params[:kind]}", layout: 'simple', template: 'reports/simple', wait_for_page_loaded: false, print_options: { page: { format: :A4 } }
+  end
+
   def convert_remote_url_basic_auth
     render pdf: 'convert-remote-url-basic-auth',
            url: basic_auth_endpoint_url(only_path: false),
@@ -42,4 +46,10 @@ class ReportsController < ApplicationController
            url: api_endpoint_url(only_path: false),
            wait_for_page_loaded: false
   end
+
+  def convert_remote_url_error
+    render pdf: 'convert-remote-url-cookie',
+           url: "https://httpstat.us/#{params[:code]}",
+           wait_for_page_loaded: false
+  end
 end

data/spec/dummy/app/views/reports/simple.html.erb

@@ -0,0 +1,6 @@
+<p>1</p>
+<p>2</p>
+<p>3</p>
+<p>4</p>
+<p>5</p>
+<p>6</p>

data/spec/dummy/config/initializers/bidi2pdf_rails.rb

@@ -54,6 +54,10 @@ Bidi2pdfRails.configure do |config|
   # config.pdf_settings.print_background = true # Print background graphics?
   # config.pdf_settings.scale = 1.0 # PDF scale (e.g., 1.0)
   # config.pdf_settings.shrink_to_fit = false # Shrink to fit?
+  # config.pdf_settings.custom_js = nil # Raw JavaScript code to inject before PDF generation (without <script> tags)
+  # config.pdf_settings.custom_css = nil # Raw CSS styles to inject before PDF generation (without <style> tags)
+  # config.pdf_settings.custom_js_url = nil # URL to JavaScript file to load before PDF generation (takes precedence over custom_js)
+  # config.pdf_settings.custom_css_url = nil # URL to CSS file to load before PDF generation (takes precedence over custom_css)
 
   #
   # Remote URL Settings

data/spec/dummy/config/routes.rb

@@ -6,6 +6,10 @@ Rails.application.routes.draw do
   get "convert-remote-url-basic-auth" => "reports#convert_remote_url_basic_auth", as: :print_remote_basic_auth
   get "convert-remote-url-cookie" => "reports#convert_remote_url_cookie", as: :print_remote_url_cookie
   get "convert-remote-url-header" => "reports#convert_remote_url_header", as: :print_remote_url_header
+  get "convert-remote-url-error/:code" => "reports#convert_remote_url_error", as: :print_error
+  get "inject/:kind" => "reports#inject",
+      constraints: { kind: /(raw-css|raw-js|url-css|url-js)/ },
+      as: :inject_css
 
   get 'basic-auth', to: 'secure#basic_auth_endpoint', as: :basic_auth_endpoint
   get 'header-auth', to: 'secure#api_endpoint', as: :api_endpoint