ferrum_pdf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fd59867787cfd16bf19645eda1dce8c8f21541d3d8b52614e025a60847787930
+  data.tar.gz: 5dd180545309a3a0c61ba90286943404382478c44337495c81237f49953559dd
+SHA512:
+  metadata.gz: 4b42648daf392f18fc9f1b8dfa947a1b26a1af29eb615af558dd23440222e80f9d846c40fe44206b1dd9f8bfcad5be64f5987559c6e833a2547b246a97093226
+  data.tar.gz: 649e5d9b57f8bfd4ad9e0c62d23cba3f1b435ec3a7a13a237e8e0cd567914e4958d93489519c103166bed3912327547bfe443af0f8f04697043a05e33658a7ed

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Chris Oliver
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# FerrumPdf
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "ferrum_pdf"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install ferrum_pdf
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/ferrum_pdf/railtie.rb

@@ -0,0 +1,9 @@
+module FerrumPdf
+  class Railtie < ::Rails::Railtie
+    initializer "ferrum_pdf.controller" do
+      ActiveSupport.on_load(:action_controller) do
+        include FerrumPdf::Controller
+      end
+    end
+  end
+end

data/lib/ferrum_pdf/version.rb

@@ -0,0 +1,3 @@
+module FerrumPdf
+  VERSION = "0.1.0"
+end

data/lib/ferrum_pdf.rb

@@ -0,0 +1,64 @@
+require "ferrum_pdf/version"
+require "ferrum_pdf/railtie"
+
+require "ferrum"
+
+module FerrumPdf
+  def self.browser(**options)
+    @browser ||= Ferrum::Browser.new(options)
+  end
+
+  def self.render_pdf(host:, protocol:, html: nil, url: nil)
+    Tempfile.create do |file|
+      browser.create_page do |page|
+        if html
+          page.content = FerrumPdf::HTMLPreprocessor.process(html, host, protocol)
+          page.network.wait_for_idle
+        else
+          page.go_to(url)
+        end
+        page.pdf(path: file.path)
+        file.read
+      end
+    end
+  end
+
+  # Helper module for preparing HTML for conversion
+  #
+  # Sourced from the PDFKit project
+  # @see https://github.com/pdfkit/pdfkit
+  module HTMLPreprocessor
+    # Change relative paths to absolute, and relative protocols to absolute protocols
+    def self.process(html, root_url, protocol)
+      html = translate_relative_paths(html, root_url) if root_url
+      html = translate_relative_protocols(html, protocol) if protocol
+      html
+    end
+
+    def self.translate_relative_paths(html, root_url)
+      # Try out this regexp using rubular http://rubular.com/r/hiAxBNX7KE
+      html.gsub(%r{(href|src)=(['"])/([^/"']([^"']*|[^"']*))?['"]}, "\\1=\\2#{root_url}\\3\\2")
+    end
+    private_class_method :translate_relative_paths
+
+    def self.translate_relative_protocols(body, protocol)
+      # Try out this regexp using rubular http://rubular.com/r/0Ohk0wFYxV
+      body.gsub(%r{(href|src)=(['"])//([^"']*|[^"']*)['"]}, "\\1=\\2#{protocol}://\\3\\2")
+    end
+    private_class_method :translate_relative_protocols
+  end
+
+  module Controller
+    extend ActiveSupport::Concern
+
+    def render_pdf(name = action_name, formats: [ :html ])
+      content = render_to_string(name, formats: formats)
+
+      FerrumPdf.render_pdf(
+        html: content,
+        host: request.host_with_port,
+        protocol: request.protocol
+      )
+    end
+  end
+end

data/lib/tasks/ferrum_pdf_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ferrum_pdf do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: ferrum_pdf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Oliver
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.1
+- !ruby/object:Gem::Dependency
+  name: ferrum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: Export PDFs from HTML in Rails using Ferrum & headless Chrome
+email:
+- excid3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/ferrum_pdf.rb
+- lib/ferrum_pdf/railtie.rb
+- lib/ferrum_pdf/version.rb
+- lib/tasks/ferrum_pdf_tasks.rake
+homepage: https://github.com/excid3/ferrum_pdf
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/excid3/ferrum_pdf
+  source_code_uri: https://github.com/excid3/ferrum_pdf
+  changelog_uri: https://github.com/excid3/ferrum_pdf/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key:
+specification_version: 4
+summary: PDFs for Rails using Ferrum & headless Chrome
+test_files: []