rails-pdf-renderer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2396f2a50e521eb3641ddf19198e39504fb613541e1154cf2c050a9bec30031
+  data.tar.gz: 344b6c385d3432bc5571334ac263df132268fff1234946823289621dcfe986f0
+SHA512:
+  metadata.gz: 48992c0c124af8e2c681c3ff0b0fb908548c9a1bf04553559d39c5e20044bfc02eb7b53a84e97aa8133e2850eb81dc3035041dfee045c6e751a7bc5b7b7aa16f
+  data.tar.gz: 14db253bc2acf01a4ac8572a9a801b7f85022a993d5e4048bfdbb3a4c8b7e336b5ef7ee4f7e49930dff8b30ad4123d942591830519ae6245b1e92488369ab862

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.1.0]
+### New Features
+- Initial version

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Erik Axel Nielsen
+Copyright (c) 2008 Miles Z. Sterrett
+
+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,27 @@
+# RailsPdfRenderer
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rails-pdf-renderer
+
+## Usage
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/erikaxel/rails-pdf-renderer.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+Initial inspiration and code was influenced by [wicked_pdf](https://github.com/mileszs/wicked_pdf/)

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/rails/pdf/renderer/action_controller_helper.rb

@@ -0,0 +1,106 @@
+class RailsPdfRenderer
+  module ActionControllerHelper
+    def self.prepended(base)
+      # Protect from trying to augment modules that appear
+      # as the result of adding other gems.
+      return if base != ActionController::Base
+    end
+
+    def render(*args)
+      options = args.first
+      if options.is_a?(Hash) && options.key?(:pdf)
+        make_and_send_pdf(options.delete(:pdf), RailsPdfRenderer.configuration.default_options.merge(options))
+      else
+        super
+      end
+    end
+
+    def render_to_string(*args)
+      options = args.first
+      if options.is_a?(Hash) && options.key?(:pdf)
+        make_pdf(RailsPdfRenderer.configuration.default_options.merge(options))
+      else
+        super
+      end
+    end
+
+    private
+
+    def make_pdf(options = {})
+      options.delete :pdf # We dont use the filename when rendering to string
+
+      render_opts = {
+        :template => options[:template],
+        :layout => options[:layout],
+        :formats => options[:formats],
+        :handlers => options[:handlers],
+        :assigns => options[:assigns]
+      }
+      render_opts[:inline] = options[:inline] if options[:inline]
+      render_opts[:locals] = options[:locals] if options[:locals]
+      render_opts[:file] = options[:file] if options[:file]
+      html_string = render_to_string(render_opts)
+      pdf_from_server(html_string, options)
+    end
+
+    def make_and_send_pdf(pdf_name, options = {})
+      options[:layout] ||= false
+      options[:template] ||= File.join(controller_path, action_name)
+      options[:disposition] ||= 'inline'
+      if options[:show_as_html]
+        render_opts = {
+          :template => options[:template],
+          :layout => options[:layout],
+          :formats => options[:formats],
+          :handlers => options[:handlers],
+          :assigns => options[:assigns],
+          :content_type => 'text/html'
+        }
+        render_opts[:inline] = options[:inline] if options[:inline]
+        render_opts[:locals] = options[:locals] if options[:locals]
+        render_opts[:file] = options[:file] if options[:file]
+        render(render_opts)
+      else
+        pdf_content = make_pdf(options)
+        File.open(options[:save_to_file], 'wb') { |file| file << pdf_content } if options[:save_to_file]
+        send_data(pdf_content, :filename => pdf_name + '.pdf', :type => 'application/pdf', :disposition => options[:disposition]) unless options[:save_only]
+      end
+    end
+
+    def pdf_from_server(html, options)
+      payload = pdf_server_params(html, options)
+
+      auth_key = RailsPdfRenderer.configuration.auth_key
+      url = RailsPdfRenderer.configuration.url
+      auth_key64 = Base64.strict_encode64(auth_key)
+
+      raise "auth_key is not set, you need to set it for rails-pdf-renderer to work" if auth_key.blank?
+
+      uri = URI(url)
+      headers = { 'Content-Type': 'application/json', "Authorization": "Bearer #{auth_key64}" }
+      response = Net::HTTP.post(uri, payload.to_json, headers)
+
+      if response.kind_of? Net::HTTPSuccess
+        response.body
+      else
+        raise RailsPdfRenderer::Error.new(response)
+      end
+    end
+
+    def pdf_server_params(html, options = {})
+      request_params = {}
+      request_params[:html] = html
+      request_params[:orientation] = options[:orientation] if options.key?(:orientation)
+      request_params[:pageSize] = options[:pageSize] if options.key?(:pageSize)
+      request_params[:zoom] = options[:zoom] if options.key?(:zoom)
+      request_params[:height] = options[:height] if options.key?(:height)
+      request_params[:width] = options[:width] if options.key?(:width)
+      request_params[:footerTemplate] = options[:footerTemplate] if options.key?(:footerTemplate)
+      request_params[:marginTop] = options[:margin][:top]
+      request_params[:marginBottom] = options[:margin][:bottom]
+      request_params[:marginLeft] = options[:margin][:left]
+      request_params[:marginRight] = options[:margin][:right]
+      request_params
+    end
+  end
+end

data/lib/rails/pdf/renderer/action_view_helper.rb

@@ -0,0 +1,230 @@
+require 'net/http'
+require 'delegate'
+require 'stringio'
+require_relative 'path_helper'
+
+class RailsPdfRenderer
+  module ActionViewHelper
+    ASSET_URL_REGEX = /url\(['"]?([^'"]+?)['"]?\)/
+
+    class PropshaftAsset < SimpleDelegator
+      def content_type
+        super.to_s
+      end
+
+      def to_s
+        content
+      end
+
+      def filename
+        path.to_s
+      end
+    end
+
+    def pdf_asset_base64(path)
+      asset = find_asset(path)
+      raise "Could not find asset '#{path}'" if asset.nil?
+
+      base64 = Base64.encode64(asset.to_s).gsub(/\s+/, '')
+      "data:#{asset.content_type};base64,#{Rack::Utils.escape(base64)}"
+    end
+
+    # Using `image_tag` with URLs when generating PDFs (specifically large PDFs with lots of pages) can cause buffer/stack overflows.
+    #
+    def pdf_url_base64(url)
+      response = Net::HTTP.get_response(URI(url))
+
+      if response.is_a?(Net::HTTPSuccess)
+        base64 = Base64.encode64(response.body).gsub(/\s+/, '')
+        "data:#{response.content_type};base64,#{Rack::Utils.escape(base64)}"
+      else
+        Rails.logger.warn("[pdf] #{response.code} #{response.message}: #{url}")
+        nil
+      end
+    end
+
+    def pdf_stylesheet_link_tag(*sources)
+      stylesheet_contents = sources.collect do |source|
+        source = PathHelper.add_extension(source, 'css')
+        "<style type='text/css'>#{read_asset(source)}</style>"
+      end.join("\n")
+
+      stylesheet_contents.gsub(ASSET_URL_REGEX) do
+        if Regexp.last_match[1].starts_with?('data:')
+          "url(#{Regexp.last_match[1]})"
+        else
+          "url(#{pdf_asset_path(Regexp.last_match[1])})"
+        end
+      end.html_safe
+    end
+
+    def pdf_stylesheet_pack_tag(*sources)
+      return unless defined?(Webpacker)
+
+      if running_in_development?
+        stylesheet_pack_tag(*sources)
+      else
+        css_text = sources.collect do |source|
+          source = PathHelper.add_extension(source, 'css')
+          pdf_stylesheet_link_tag(webpacker_source_url(source))
+        end.join("\n")
+        css_text.respond_to?(:html_safe) ? css_text.html_safe : css_text
+      end
+    end
+
+    def pdf_javascript_pack_tag(*sources)
+      return unless defined?(Webpacker)
+
+      if running_in_development?
+        javascript_pack_tag(*sources)
+      else
+        sources.collect do |source|
+          source = PathHelper.add_extension(source, 'js')
+          "<script type='text/javascript'>#{read_asset(webpacker_source_url(source))}</script>"
+        end.join("\n").html_safe
+      end
+    end
+
+    def pdf_image_tag(img, options = {})
+      image_tag pdf_asset_path(img), options
+    end
+
+    def pdf_javascript_src_tag(jsfile, options = {})
+      jsfile = PathHelper.add_extension(jsfile, 'js')
+      javascript_include_tag pdf_asset_path(jsfile), options
+    end
+
+    def pdf_javascript_include_tag(*sources)
+      sources.collect do |source|
+        source = PathHelper.add_extension(source, 'js')
+        "<script type='text/javascript'>#{read_asset(source)}</script>"
+      end.join("\n").html_safe
+    end
+
+    def pdf_asset_path(asset)
+      if (pathname = asset_pathname(asset).to_s) =~ URI_REGEXP
+        pathname
+      else
+        "file:///#{pathname}"
+      end
+    end
+
+    def pdf_asset_pack_path(asset)
+      return unless defined?(Webpacker)
+
+      if running_in_development?
+        asset_pack_path(asset)
+      else
+        pdf_asset_path webpacker_source_url(asset)
+      end
+    end
+
+    private
+
+    # borrowed from actionpack/lib/action_view/helpers/asset_url_helper.rb
+    URI_REGEXP = %r{^[-a-z]+://|^(?:cid|data):|^//}
+
+    def asset_pathname(source)
+      if precompiled_or_absolute_asset?(source)
+        asset = asset_path(source)
+        pathname = prepend_protocol(asset)
+        if pathname =~ URI_REGEXP
+          # asset_path returns an absolute URL using asset_host if asset_host is set
+          pathname
+        else
+          File.join(Rails.public_path, asset.sub(/\A#{Rails.application.config.action_controller.relative_url_root}/, ''))
+        end
+      else
+        asset = find_asset(source)
+        if asset
+          # older versions need pathname, Sprockets 4 supports only filename
+          asset.respond_to?(:filename) ? asset.filename : asset.pathname
+        else
+          File.join(Rails.public_path, source)
+        end
+      end
+    end
+
+    def find_asset(path)
+      if Rails.application.assets.respond_to?(:find_asset)
+        Rails.application.assets.find_asset(path, :base_path => Rails.application.root.to_s)
+      elsif defined?(Propshaft::Assembly) && Rails.application.assets.is_a?(Propshaft::Assembly)
+        asset = Rails.application.assets.load_path.find(path)
+        raise "Could not find asset: #{path}" if asset.nil?
+        PropshaftAsset.new(asset)
+      else
+        Sprockets::Railtie.build_environment(Rails.application).find_asset(path, :base_path => Rails.application.root.to_s)
+      end
+    end
+
+    # will prepend a http or default_protocol to a protocol relative URL
+    # or when no protcol is set.
+    def prepend_protocol(source)
+      protocol = RailsPdfRenderer.configuration.default_protocol
+      if source[0, 2] == '//'
+        source = [protocol, ':', source].join
+      elsif source[0] != '/' && !source[0, 8].include?('://')
+        source = [protocol, '://', source].join
+      end
+      source
+    end
+
+    def precompiled_or_absolute_asset?(source)
+      !Rails.configuration.respond_to?(:assets) ||
+        Rails.configuration.assets.compile == false ||
+        source.to_s[0] == '/' ||
+        source.to_s.match(/\Ahttps?\:\/\//)
+    end
+
+    def read_asset(source)
+      if precompiled_or_absolute_asset?(source)
+        pathname = asset_pathname(source)
+        if pathname =~ URI_REGEXP
+          read_from_uri(pathname)
+        elsif File.file?(pathname)
+          IO.read(pathname)
+        end
+      else
+        find_asset(source).to_s
+      end
+    end
+
+    def read_from_uri(uri)
+      asset = Net::HTTP.get(URI(uri))
+      asset.force_encoding('UTF-8') if asset
+      asset
+    end
+
+    def webpacker_source_url(source)
+      return unless webpacker_version
+
+      # In Webpacker 3.2.0 asset_pack_url is introduced
+      if webpacker_version >= '3.2.0'
+        if (host = Rails.application.config.asset_host)
+          asset_pack_path(source, :host => host)
+        else
+          asset_pack_url(source)
+        end
+      else
+        source_path = asset_pack_path(source)
+        # Remove last slash from root path
+        root_url[0...-1] + source_path
+      end
+    end
+
+    def running_in_development?
+      return unless webpacker_version
+
+      # :dev_server method was added in webpacker 3.0.0
+      if Webpacker.respond_to?(:dev_server)
+        Webpacker.dev_server.running?
+      else
+        Rails.env.development? || Rails.env.test?
+      end
+    end
+
+    def webpacker_version
+      Webpacker::VERSION
+    end
+  end
+end

data/lib/rails/pdf/renderer/config.rb

@@ -0,0 +1,21 @@
+class RailsPdfRenderer
+  class Config
+    include ActiveSupport::Configurable
+
+    config_accessor :auth_key
+    config_accessor(:url) { "https://europe-west1-lucalabs-development.cloudfunctions.net/htmlToPdf" }
+    config_accessor(:basic_auth) { false }
+    config_accessor(:default_protocol) { "https" }
+
+
+    config_accessor(:default_options) do  {
+      margin: {
+        top: "0mm",
+        bottom: "0mm",
+        left: "0mm",
+        right: "0mm"
+      }
+    }
+    end
+  end
+end

data/lib/rails/pdf/renderer/error.rb

@@ -0,0 +1,13 @@
+class RailsPdfRenderer
+  class Error < StandardError
+    attr_accessor :http_response
+
+    def initialize(http_response)
+      @http_response = http_response
+    end
+
+    def message
+      "Got error when trying to fetch PDF from server. HTTP error #{@http_response.code} #{@http_response.message}"
+    end
+  end
+end

data/lib/rails/pdf/renderer/path_helper.rb

@@ -0,0 +1,36 @@
+class RailsPdfRenderer
+  module PathHelper
+    def self.root_path
+      String === Rails.root ? Pathname.new(Rails.root) : Rails.root
+    end
+
+    def self.add_extension(filename, extension)
+      filename.to_s.split('.').include?(extension) ? filename : "#{filename}.#{extension}"
+    end
+
+    def wicked_pdf_stylesheet_link_tag(*sources)
+      css_dir = PathHelper.root_path.join('public', 'stylesheets')
+      css_text = sources.collect do |source|
+        source = PathHelper.add_extension(source, 'css')
+        "<style type='text/css'>#{File.read(css_dir.join(source))}</style>"
+      end.join("\n")
+      css_text.respond_to?(:html_safe) ? css_text.html_safe : css_text
+    end
+
+    def wicked_pdf_image_tag(img, options = {})
+      image_tag "file:///#{PathHelper.root_path.join('public', 'images', img)}", options
+    end
+
+    def wicked_pdf_javascript_src_tag(jsfile, options = {})
+      jsfile = PathHelper.add_extension(jsfile, 'js')
+      type = ::Mime.respond_to?(:[]) ? ::Mime[:js] : ::Mime::JS # ::Mime[:js] cannot be used in Rails 2.3.
+      src = "file:///#{PathHelper.root_path.join('public', 'javascripts', jsfile)}"
+      content_tag('script', '', { 'type' => type, 'src' => path_to_javascript(src) }.merge(options))
+    end
+
+    def wicked_pdf_javascript_include_tag(*sources)
+      js_text = sources.collect { |source| wicked_pdf_javascript_src_tag(source, {}) }.join("\n")
+      js_text.respond_to?(:html_safe) ? js_text.html_safe : js_text
+    end
+  end
+end

data/lib/rails/pdf/renderer/railtie.rb

@@ -0,0 +1,15 @@
+require_relative 'action_controller_helper'
+require_relative 'action_view_helper'
+
+class RailsPdfRenderer
+  if defined?(Rails.env)
+    class RailsPdfRendererRailtie < Rails::Railtie
+      initializer 'rails-pdf-renderer.register' do |_app|
+        ActiveSupport.on_load(:action_controller) { ActionController::Base.send :prepend, RailsPdfRenderer::ActionControllerHelper }
+        ActiveSupport.on_load(:action_view) { include RailsPdfRenderer::ActionViewHelper }
+      end
+    end
+
+    Mime::Type.register('application/pdf', :pdf) if Mime::Type.lookup_by_extension(:pdf).nil?
+  end
+end

data/lib/rails/pdf/renderer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class RailsPdfRenderer
+  VERSION = "0.1.0"
+end

data/lib/rails/pdf/renderer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "renderer/version"
+require_relative "renderer/config"
+require_relative "renderer/error"
+require_relative "renderer/railtie"
+
+class RailsPdfRenderer
+  def self.configuration
+    @configuration ||= Config.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: rails-pdf-renderer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Erik Axel Nielsen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Helper library to generate PDFs from Rails.
+email:
+- erikaxel.nielsen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails/pdf/renderer.rb
+- lib/rails/pdf/renderer/action_controller_helper.rb
+- lib/rails/pdf/renderer/action_view_helper.rb
+- lib/rails/pdf/renderer/config.rb
+- lib/rails/pdf/renderer/error.rb
+- lib/rails/pdf/renderer/path_helper.rb
+- lib/rails/pdf/renderer/railtie.rb
+- lib/rails/pdf/renderer/version.rb
+homepage: https://github.com/erikaxel/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/erikaxel/
+  source_code_uri: https://github.com/erikaxel/
+  changelog_uri: https://github.com/erikaxel/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Create PDFs directly from Rails.
+test_files: []