draft_forge 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 34f09b604f2763d94777f3cd8ae5ad4a1a486dac2663d3d4259c12bf107d7ed1
+  data.tar.gz: 323c0bd1ea8e9dbf4111f8a56e48c6e8f2883fc3460e624c35f88a912c01a989
+SHA512:
+  metadata.gz: 75143db17f2b1da748254d123e8bf6a96e371acf8c990c9bf04fc67db53056e61dc7355b9b519fbe983603066276efcdfc174cf6b6824e3fefe821b20a45cde3
+  data.tar.gz: 07eb51422510955246dea81c90757dc19235f402146a6cb76e8012de42dde0b079ff941c05a6b529068263a71362f520f13cb4ff484c32832916d2d371ce0359

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.3.0
+
+- Initial release.

data/MIT-LICENSE

@@ -0,0 +1,3 @@
+MIT License
+
+Copyright (c) 2025

data/README.md

@@ -0,0 +1,73 @@
+# draft_forge
+
+Rails engine for exporting HTML or Editor.js JSON to PDF. Can be paired with any front-end or used standalone.
+
+Requires Ruby 3.1 or higher. See [CHANGELOG](CHANGELOG.md) for release notes.
+
+## Installation
+
+Copy an initializer and migration into your application:
+
+```bash
+bin/rails generate draft_forge:install
+```
+
+Attempting to use DraftForge's services before running the generator and
+migrating will log an error directing you to install and migrate.
+
+## Mounting
+
+Expose DraftForge's endpoints by mounting the engine in your application's
+routes:
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  mount DraftForge::Engine => "/draft_forge"
+end
+```
+
+This provides `POST /draft_forge` to queue a PDF export and
+`GET /draft_forge/:id` to check status or download the finished file.
+
+## Services
+
+If you prefer not to expose HTTP endpoints, you can queue and fetch exports
+directly with service objects:
+
+```ruby
+export = DraftForge::CreateExport.call(
+  content_json: { blocks: [{ type: 'paragraph', data: { text: 'Hello world' } }] },
+  filename: "hello.pdf"
+)
+
+DraftForge::FetchExport.call(export.id)
+# => { id: 1, status: "queued" }
+```
+
+## Configuration
+
+`DraftForge` exposes simple configuration hooks for PDF rendering and HTML
+sanitization. The sanitizer controls which HTML elements (blocks) are allowed,
+letting you distinguish between editable and non-editable content. By default
+the sanitizer permits the `contenteditable` attribute so sanitized markup can
+be used in live editors.
+
+```ruby
+# config/initializers/draft_forge.rb
+DraftForge.configure do |config|
+  # Change page size/margins for Grover
+  config.pdf_options = { format: 'Letter' }
+
+  # Permit additional HTML elements
+  config.sanitizer_config[:elements] += %w[hr]
+end
+```
+
+## Testing
+
+Run the RSpec suite from this directory to verify changes:
+
+```bash
+bundle exec rspec
+```

data/app/controllers/draft_forge/application_controller.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module DraftForge
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/draft_forge/exports_controller.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+module DraftForge
+  class ExportsController < ApplicationController
+    protect_from_forgery with: :null_session
+    before_action :ensure_json
+
+    def create
+      html = if params[:content_json].present?
+               EditorJsRenderer.call(params[:content_json])
+             else
+               params[:content_html].to_s
+             end
+      filename = params[:filename].presence || "document.pdf"
+
+      export = Export.create!(status: :queued, requested_filename: filename)
+      ExportPdfJob.perform_later(export.id, html)
+
+      render json: { id: export.id, status: export.status }
+    rescue => e
+      render json: { error: e.message }, status: 422
+    end
+
+    def show
+      export = Export.find(params[:id])
+      if export.complete? && export.pdf.attached?
+        url = Rails.application.routes.url_helpers.rails_blob_url(export.pdf, only_path: false)
+        render json: { id: export.id, status: export.status, download_url: url }
+      else
+        render json: { id: export.id, status: export.status }
+      end
+    rescue ActiveRecord::RecordNotFound
+      render json: { error: "Not found" }, status: 404
+    end
+
+    private
+
+    def ensure_json
+      request.format = :json
+    end
+  end
+end

data/app/jobs/draft_forge/export_pdf_job.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+require 'grover'
+
+module DraftForge
+  class ExportPdfJob < ActiveJob::Base
+    queue_as :default
+
+    def perform(export_id, raw_html)
+      export = Export.find(export_id)
+      export.update!(status: :processing)
+
+      safe_html = HtmlSanitizer.call(raw_html)
+      html = wrap_html(safe_html)
+
+      pdf = Grover.new(html, DraftForge.pdf_options).to_pdf
+
+      filename = export.requested_filename.presence || "document.pdf"
+      export.pdf.attach(io: StringIO.new(pdf), filename: filename, content_type: 'application/pdf')
+      export.update!(status: :complete)
+    rescue => e
+      Rails.logger.error("[DraftForge] Export failed: #{e.class}: #{e.message}")
+      export.update!(status: :failed) rescue nil
+    end
+
+    private
+
+    def wrap_html(body)
+      options = DraftForge.pdf_options
+      size = options[:format] || 'A4'
+      margin = options[:margin] || {}
+      top = margin[:top] || '20mm'
+      right = margin[:right] || '15mm'
+      bottom = margin[:bottom] || '20mm'
+      left = margin[:left] || '15mm'
+
+      <<~HTML
+        <!doctype html>
+        <html>
+          <head>
+            <meta charset="utf-8" />
+            <meta name="viewport" content="width=device-width, initial-scale=1" />
+            <style>
+              @page { size: #{size}; margin: #{top} #{right} #{bottom} #{left}; }
+              body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, 'Helvetica Neue', Arial, 'Noto Sans', 'Liberation Sans', sans-serif; font-size: 12px; line-height: 1.45; color: #111; }
+              h1, h2, h3 { margin: 0 0 8px; }
+              h1 { font-size: 22px; }
+              h2 { font-size: 18px; }
+              h3 { font-size: 15px; }
+              p { margin: 0 0 8px; }
+              table { width: 100%; border-collapse: collapse; margin: 8px 0; }
+              th, td { border: 1px solid #ccc; padding: 6px 8px; vertical-align: top; }
+              img { max-width: 100%; height: auto; }
+              .page-break { page-break-after: always; }
+              .checklist li { list-style: none; }
+            </style>
+          </head>
+          <body>
+            #{body}
+          </body>
+        </html>
+      HTML
+    end
+  end
+end

data/app/models/draft_forge/export.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module DraftForge
+  class Export < ApplicationRecord
+    self.table_name = "draft_forge_exports"
+
+    enum status: { queued: 0, processing: 1, complete: 2, failed: 3 }
+    has_one_attached :pdf
+  end
+end

data/app/services/draft_forge/create_export.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DraftForge
+  class CreateExport
+    def self.call(content_html: nil, content_json: nil, filename: nil)
+      unless Export.table_exists?
+        Rails.logger.error("[DraftForge] Missing `draft_forge_exports` table. Run `rails generate draft_forge:install` and `rails db:migrate`.")
+        return
+      end
+      html = if content_json
+               EditorJsRenderer.call(content_json)
+             else
+               content_html.to_s
+             end
+      name = filename.presence || 'document.pdf'
+
+      export = Export.create!(status: :queued, requested_filename: name)
+      ExportPdfJob.perform_later(export.id, html)
+
+      export
+    end
+  end
+end
+

data/app/services/draft_forge/editor_js_renderer.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module DraftForge
+  # Convert Editor.js data to basic HTML
+  class EditorJsRenderer
+    def self.call(data)
+      data = parse(data)
+      blocks = data.fetch('blocks', [])
+      blocks.map { |block| render_block(block) }.join
+    end
+
+    def self.parse(data)
+      if data.is_a?(String)
+        JSON.parse(data)
+      elsif data.respond_to?(:to_unsafe_h)
+        data.to_unsafe_h
+      else
+        data || {}
+      end
+    end
+
+    def self.render_block(block)
+      type = block['type']
+      bdata = block['data'] || {}
+      case type
+      when 'paragraph'
+        "<p>#{bdata['text']}</p>"
+      when 'header'
+        level = bdata['level'].to_i
+        level = 1 if level < 1
+        level = 6 if level > 6
+        "<h#{level}>#{bdata['text']}</h#{level}>"
+      when 'list'
+        tag = bdata['style'] == 'ordered' ? 'ol' : 'ul'
+        items = Array(bdata['items']).map { |item| "<li>#{item}</li>" }.join
+        "<#{tag}>#{items}</#{tag}>"
+      else
+        ''
+      end
+    end
+  end
+end

data/app/services/draft_forge/fetch_export.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DraftForge
+  class FetchExport
+    def self.call(id)
+      unless Export.table_exists?
+        Rails.logger.error("[DraftForge] Missing `draft_forge_exports` table. Run `rails generate draft_forge:install` and `rails db:migrate`.")
+        return
+      end
+      export = Export.find(id)
+      result = { id: export.id, status: export.status }
+      if export.complete? && export.pdf.attached?
+        url = Rails.application.routes.url_helpers.rails_blob_url(export.pdf, only_path: false)
+        result[:download_url] = url
+      end
+      result
+    end
+  end
+end
+

data/app/services/draft_forge/html_sanitizer.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module DraftForge
+  class HtmlSanitizer
+    def self.call(html)
+      config = DraftForge.sanitizer_config
+      Sanitize.fragment(html.to_s, config.merge(remove_contents: ['script', 'style']))
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+DraftForge::Engine.routes.draw do
+  resources :exports, only: %i[create show], path: ''
+end

data/lib/draft_forge/engine.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "rails"
+require "sanitize"
+
+module DraftForge
+  class Engine < ::Rails::Engine
+    isolate_namespace DraftForge
+  end
+end

data/lib/draft_forge/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module DraftForge
+  VERSION = "0.3.0"
+end

data/lib/draft_forge.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "draft_forge/version"
+require "draft_forge/engine"
+require "sanitize"
+
+module DraftForge
+  DEFAULT_SANITIZER_CONFIG = {
+    elements: Sanitize::Config::RELAXED[:elements] + %w[table thead tbody tfoot tr td th figure figcaption],
+    attributes: {
+      'a' => ['href', 'title', 'target', 'rel'],
+      'img' => ['src', 'alt', 'title', 'width', 'height'],
+      'td' => ['colspan', 'rowspan', 'style'],
+      'th' => ['colspan', 'rowspan', 'style'],
+      :all => ['class', 'style', 'contenteditable']
+    },
+    protocols: {
+      'a' => { 'href' => ['http', 'https', 'mailto', 'tel', :relative] },
+      'img' => { 'src'  => ['http', 'https', :relative] }
+    },
+    transformers: []
+  }.freeze
+
+  mattr_accessor :sanitizer_config, default: DEFAULT_SANITIZER_CONFIG
+  mattr_accessor :pdf_options, default: { format: 'A4', margin: { top: '20mm', right: '15mm', bottom: '20mm', left: '15mm' } }
+
+  def self.configure
+    yield self
+  end
+end

data/lib/generators/draft_forge/install/install_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/migration"
+
+module DraftForge
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_initializer
+        template "draft_forge.rb", "config/initializers/draft_forge.rb"
+      end
+
+      def copy_migration
+        unless migration_exists?("db/migrate", "create_draft_forge_exports")
+          migration_template "create_draft_forge_exports.rb", "db/migrate/create_draft_forge_exports.rb"
+        end
+      end
+
+      def self.next_migration_number(dirname)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+
+      private
+
+      def migration_exists?(dir, name)
+        Dir.glob(File.join(destination_root, dir, "*_#{name}.rb")).any?
+      end
+    end
+  end
+end

data/lib/generators/draft_forge/install/templates/create_draft_forge_exports.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class CreateDraftForgeExports < ActiveRecord::Migration[7.1]
+  def change
+    create_table :draft_forge_exports, id: :uuid do |t|
+      t.integer :status, null: false, default: 0
+      t.string  :requested_filename
+      t.timestamps
+    end
+  end
+end

data/lib/generators/draft_forge/install/templates/draft_forge.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+DraftForge.configure do |config|
+  # Change page size/margins for Grover
+  # config.pdf_options = { format: 'Letter' }
+
+  # Permit additional HTML elements
+  # config.sanitizer_config[:elements] += %w[hr]
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: draft_forge
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Mike Attara
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: grover
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: sanitize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: A minimal Rails engine exposing endpoints to export sanitized HTML to
+  PDF via Grover.
+email:
+- mpyebattara@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- app/controllers/draft_forge/application_controller.rb
+- app/controllers/draft_forge/exports_controller.rb
+- app/jobs/draft_forge/export_pdf_job.rb
+- app/models/draft_forge/export.rb
+- app/services/draft_forge/create_export.rb
+- app/services/draft_forge/editor_js_renderer.rb
+- app/services/draft_forge/fetch_export.rb
+- app/services/draft_forge/html_sanitizer.rb
+- config/routes.rb
+- lib/draft_forge.rb
+- lib/draft_forge/engine.rb
+- lib/draft_forge/version.rb
+- lib/generators/draft_forge/install/install_generator.rb
+- lib/generators/draft_forge/install/templates/create_draft_forge_exports.rb
+- lib/generators/draft_forge/install/templates/draft_forge.rb
+homepage: https://github.com/draftforge/draftforge
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/draftforge/draftforge
+  source_code_uri: https://github.com/draftforge/draftforge
+  changelog_uri: https://github.com/draftforge/draftforge/blob/main/packages/rails/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: DraftForge — Rails engine for HTML->PDF exports
+test_files: []