webtranslateit-payday 1.7.4 → 2.1.0

data/lib/payday/templates/invoice.typ

@@ -0,0 +1,171 @@
+// Payday's invoice layout.
+//
+// All data arrives as JSON through sys.inputs, where Typst inserts string values as literal
+// text rather than markup. Never interpolate invoice data into this file's source, and never
+// call eval() on a value that came from an invoice.
+
+#let d = json(bytes(sys.inputs.invoice))
+
+// Gaps between the major blocks, calibrated so the rendered invoice keeps the vertical
+// rhythm the prawn renderer produced. Every within-block gap falls out of the table insets.
+#let gap-after-header = 15pt
+#let gap-after-addresses = 13.2pt
+#let gap-after-details = 8pt
+#let gap-before-totals = -12pt
+#let gap-before-notes = 22.3pt
+#let gap-notes-label-to-rule = -7.1pt
+#let gap-after-notes-rule = -0.4pt
+#let gap-before-qr = -0.6pt
+
+// Prawn page-size names mapped onto Typst paper names.
+#let papers = ("LETTER": "us-letter", "A4": "a4", "LEGAL": "us-legal")
+
+#set document(title: "Invoice", date: none)
+#set page(
+  paper: papers.at(d.page_size, default: "a4"),
+  margin: 36pt,  // prawn's default half-inch page margin
+  numbering: none,
+  // Page numbers appear only when the invoice runs to more than one page. This has to be a
+  // footer rather than a trailing `set page`, which would only affect the final page.
+  footer: context {
+    if counter(page).final().first() > 1 {
+      align(right, text(size: 9pt, counter(page).display("1 / 1", both: true)))
+    }
+  },
+)
+#set text(font: "Noto Sans", size: 10pt)
+
+// Renders the styled runs produced by Payday::Markup.
+#let render-runs(runs) = {
+  if runs == none { return }
+  for r in runs {
+    let body = text(
+      size: if "size" in r { r.size * 1pt } else { 1em },
+      fill: if "color" in r { rgb(r.color) } else { black },
+      weight: if r.at("bold", default: false) { "bold" } else { "regular" },
+      style: if r.at("italic", default: false) { "italic" } else { "normal" },
+      r.text,
+    )
+    if r.at("underline", default: false) { body = underline(body) }
+    if r.at("strike", default: false) { body = strike(body) }
+    if r.at("sub", default: false) { body = sub(body) }
+    if r.at("sup", default: false) { body = super(body) }
+    if "link" in r { link(r.link, body) } else { body }
+  }
+}
+
+// --- status stamp ------------------------------------------------------------------
+// Drawn before anything else so it stays at a fixed offset from the top of the page, the way
+// prawn stamped it, rather than drifting with the height of the logo.
+#if d.stamp != none {
+  place(top + center, dx: 5.1pt, dy: 33pt, rotate(15deg,
+    text(fill: rgb("cc0000"), size: 25pt, weight: "bold")[#d.stamp]))
+}
+
+// --- logo and company identity ---------------------------------------------------
+#grid(
+  columns: (1fr, auto),
+  align: (left + top, right + top),
+  if d.logo != none {
+    image(
+      d.logo.name,
+      width: if d.logo.width != none { d.logo.width * 1pt } else { auto },
+      height: if d.logo.height != none { d.logo.height * 1pt } else { auto },
+      fit: "contain",
+    )
+  },
+  align(left, pad(top: 5.7pt)[
+    #text(weight: "bold", size: 12pt)[#d.company_name] \
+    #d.company_details
+  ]),
+)
+
+#v(gap-after-header)
+
+// --- bill to / ship to -------------------------------------------------------------
+#grid(
+  columns: (1fr, 200pt),
+  align: (left + top, left + top),
+  [#text(weight: "bold")[#d.labels.bill_to]#v(10.4pt, weak: true)#d.bill_to],
+  if d.ship_to != none {
+    [#text(weight: "bold")[#d.labels.ship_to]#v(10.4pt, weak: true)#d.ship_to]
+  },
+)
+
+// prawn drew the ship-to box 2pt taller than its contents, so invoices carrying a ship-to
+// address pushed the details block down by that much.
+#v(gap-after-addresses + if d.ship_to != none { 2pt } else { 0pt })
+
+// --- invoice details ---------------------------------------------------------------
+#if d.details.len() > 0 {
+  table(
+    columns: 2,
+    stroke: none,
+    inset: (left: 1pt, right: 0pt, y: 4.25pt),
+    column-gutter: 10pt,
+    align: (left, right),
+    ..d.details.map(row => (
+      text(weight: "bold")[#row.at(0)],
+      text(weight: "bold")[#row.at(1)],
+    )).flatten()
+  )
+}
+
+#v(gap-after-details)
+
+// --- line items ---------------------------------------------------------------------
+#table(
+  columns: (1fr, auto, auto, auto),
+  align: (left, right, right, right),
+  inset: (x: 10pt, y: 8.25pt),
+  stroke: (x, y) => (
+    left: none,
+    right: none,
+    top: 0.5pt + rgb("F6F9FC"),
+    bottom: 0.5pt + rgb("BCC6D0"),
+  ),
+  fill: (x, y) => if y == 0 { white } else if calc.odd(y) { rgb("F6F9FC") } else { white },
+  table.header(
+    text(weight: "bold")[#d.labels.description],
+    text(weight: "bold")[#d.labels.unit_price],
+    text(weight: "bold")[#d.labels.quantity],
+    text(weight: "bold")[#d.labels.amount],
+  ),
+  ..d.line_items.map(li => (
+    render-runs(li.description), [#li.price], [#li.quantity], [#li.amount],
+  )).flatten()
+)
+
+#v(gap-before-totals)
+
+// --- totals ---------------------------------------------------------------------------
+#align(right, table(
+  columns: 2,
+  stroke: none,
+  // The total is set 12pt, whose taller glyph box would otherwise pull the row up.
+  inset: (x, y) => (
+    left: 5pt, right: 5pt, bottom: 8.25pt,
+    top: if y == d.totals.len() - 1 { 8.95pt } else { 8.25pt },
+  ),
+  align: (left, right),
+  ..d.totals.map(row => {
+    let size = if row.at(2) { 12pt } else { 10pt }
+    (text(weight: "bold", size: size)[#row.at(0)], text(size: size)[#row.at(1)])
+  }).flatten()
+))
+
+// --- notes ------------------------------------------------------------------------------
+#if d.notes != none {
+  v(gap-before-notes)
+  text(weight: "bold")[#d.labels.notes]
+  v(gap-notes-label-to-rule)
+  line(length: 100%, stroke: 0.5pt + rgb("cccccc"))
+  v(gap-after-notes-rule)
+  render-runs(d.notes)
+}
+
+// --- QR code ------------------------------------------------------------------------------
+#if d.qr_code != none {
+  v(gap-before-qr)
+  image("qr.svg", width: 100pt)
+}

data/lib/payday.rb

@@ -8,14 +8,14 @@ loader.setup
 require 'active_support/core_ext/object/blank' # For Object#blank? method
 require 'bigdecimal'
 require 'date'
+require 'json'
 require 'money'
-require 'prawn'
-require 'prawn/table'
-require 'prawn-svg'
+require 'typst'
 require 'time'
 
-# Load translations from the locale folder
-I18n.load_path.concat(Dir[File.join('config', 'locales', '*.yml')])
+# Load our own translations. This has to resolve against the gem rather than the working
+# directory, or the locales only load when the process happens to be running from the gem root.
+I18n.load_path.concat(Dir[File.expand_path('../config/locales/*.yml', __dir__)])
 
 module Payday
 end

data/payday.gemspec

@@ -2,26 +2,29 @@
 
 Gem::Specification.new do |s|
   s.name        = 'webtranslateit-payday'
-  s.version     = '1.7.4'
+  s.version     = '2.1.0'
   s.required_ruby_version = '>= 3.2'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Alan Johnson', 'Edouard Briere']
   s.email       = ['edouard@webtranslateit.com']
   s.homepage    = 'https://github.com/webtranslateit/payday'
   s.summary     = 'A simple library for rendering invoices.'
-  s.description = 'Payday is a library for rendering invoices to pdf.'
+  s.description = 'Payday is a library for rendering invoices to pdf, using Typst.'
   s.license = 'MIT'
 
   s.add_dependency 'activesupport', '>= 7', '< 9'
   s.add_dependency 'i18n', '~> 1.12', '< 2'
   s.add_dependency 'money', '>= 6.16', '< 8.0'
-  s.add_dependency 'prawn', '~> 2.4', '< 3'
-  s.add_dependency 'prawn-svg', '~> 0.32', '< 1'
-  s.add_dependency 'prawn-table', '~> 0.2', '< 1'
   s.add_dependency 'rqrcode', '>= 2', '< 4'
+  s.add_dependency 'typst', '~> 0.15'
   s.add_dependency 'zeitwerk', '~> 2.6', '< 3'
 
-  s.files = `git ls-files`.split("\n")
+  # Only what the gem needs at run time, plus the docs. The spec suite carries several
+  # hundred kilobytes of reference PDFs that nobody installing this wants.
+  root_files = %w[README.md CHANGELOG.md payday.gemspec].freeze
+  s.files = `git ls-files -z`.split("\x0").select do |path|
+    path.start_with?('lib/', 'config/locales/', 'fonts/') || root_files.include?(path)
+  end
   s.require_paths = ['lib']
   s.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webtranslateit-payday
 version: !ruby/object:Gem::Version
-  version: 1.7.4
+  version: 2.1.0
 platform: ruby
 authors:
 - Alan Johnson
@@ -71,85 +71,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '8.0'
 - !ruby/object:Gem::Dependency
-  name: prawn
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: prawn-svg
+  name: rqrcode
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.32'
+        version: '2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.32'
+        version: '2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: prawn-table
+  name: typst
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1'
-- !ruby/object:Gem::Dependency
-  name: rqrcode
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -170,27 +124,15 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
-description: Payday is a library for rendering invoices to pdf.
+description: Payday is a library for rendering invoices to pdf, using Typst.
 email:
 - edouard@webtranslateit.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitattributes"
-- ".github/dependabot.yml"
-- ".github/release-drafter.yml"
-- ".github/workflows/ci.yml"
-- ".github/workflows/release-drafter.yml"
-- ".gitignore"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
-- Guardfile
 - README.md
-- Rakefile
 - config/locales/payday.de.yml
 - config/locales/payday.en.yml
 - config/locales/payday.es.yml
@@ -205,25 +147,19 @@ files:
 - lib/generators/payday/setup/templates/line_item.rb
 - lib/generators/payday/setup/templates/migration.rb
 - lib/payday.rb
+- lib/payday/appendix.rb
+- lib/payday/assets/default_logo.png
 - lib/payday/config.rb
 - lib/payday/invoice.rb
+- lib/payday/invoice_presenter.rb
 - lib/payday/invoiceable.rb
 - lib/payday/line_item.rb
 - lib/payday/line_itemable.rb
+- lib/payday/markup.rb
 - lib/payday/pdf_renderer.rb
+- lib/payday/qr_code.rb
+- lib/payday/templates/invoice.typ
 - payday.gemspec
-- spec/assets/default_logo.png
-- spec/assets/example_invoice_with_qr.pdf
-- spec/assets/svg.pdf
-- spec/assets/testing.pdf
-- spec/assets/testing_es.pdf
-- spec/assets/testing_predefined_amount.pdf
-- spec/assets/tiger.svg
-- spec/invoice_spec.rb
-- spec/line_item_spec.rb
-- spec/pdf_renderer_spec.rb
-- spec/spec_helper.rb
-- spec/support/asset_matchers.rb
 homepage: https://github.com/webtranslateit/payday
 licenses:
 - MIT
@@ -243,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A simple library for rendering invoices.
 test_files: []

data/.gitattributes

@@ -1 +0,0 @@
-*.pdf binary

data/.github/dependabot.yml

@@ -1,28 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
-version: 2
-updates:
-  - package-ecosystem: "bundler" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "weekly"
-      day: "monday"
-      time: "04:00"
-    reviewers:
-    - edouard
-    assignees:
-    - edouard
-
-  - package-ecosystem: github-actions
-    directory: "/"
-    schedule:
-      interval: weekly
-      day: monday
-      time: "04:00"
-    reviewers:
-    - edouard
-    assignees:
-    - edouard

data/.github/release-drafter.yml

@@ -1,36 +0,0 @@
-name-template: '$RESOLVED_VERSION 🌈'
-tag-template: '$RESOLVED_VERSION'
-categories:
-  - title: '🚀 Features'
-    labels:
-      - 'feature'
-      - 'enhancement'
-  - title: '🐛 Bug Fixes'
-    labels:
-      - 'bug'
-      - 'design'
-      - 'performance'
-  - title: '🧰 Maintenance'
-    labels:
-      - 'admin'
-      - 'refactoring'
-      - 'dependencies'
-      - 'github_actions'
-      - 'tests'
-change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
-change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
-version-resolver:
-  major:
-    labels:
-      - 'major'
-  minor:
-    labels:
-      - 'minor'
-  patch:
-    labels:
-      - 'patch'
-  default: patch
-template: |
-  ## Changes
-
-  $CHANGES

data/.github/workflows/ci.yml

@@ -1,47 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Ruby
-
-on: push
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['3.2', '3.3', '3.4', '4.0']
-
-    steps:
-    - uses: actions/checkout@v7
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rspec
-
-  linters:
-    name: Linters
-    runs-on: ubuntu-latest
-    timeout-minutes: 10
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v7
-
-      - name: Install ruby and gems
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.3.6 # Use .ruby-version file instead of duplicating here and in Gemfile?
-          bundler-cache: true
-
-      - name: Run ruby linter
-        run: bundle exec rubocop --format github

data/.github/workflows/release-drafter.yml

@@ -1,24 +0,0 @@
-name: Release Drafter
-
-on:
-  push:
-    # branches to consider in the event; optional, defaults to all
-    branches:
-      - main
-jobs:
-  update_release_draft:
-    runs-on: ubuntu-latest
-    steps:
-      # (Optional) GitHub Enterprise requires GHE_HOST variable set
-      #- name: Set GHE_HOST
-      #  run: |
-      #    echo "GHE_HOST=${GITHUB_SERVER_URL##https:\/\/}" >> $GITHUB_ENV
-
-      # Drafts your next Release notes as Pull Requests are merged into "master"
-      - uses: release-drafter/release-drafter@v7
-        # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
-        # with:
-        #   config-name: my-config.yml
-        #   disable-autolabeler: true
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.gitignore

@@ -1,8 +0,0 @@
-tmp/
-doc/
-.yardoc/
-*.gem
-.bundle
-pkg/*
-bin/
-.rubocop-http*

data/.rubocop.yml

@@ -1,16 +0,0 @@
-plugins:
-  - rubocop-performance
-  - rubocop-rspec
-
-inherit_from:
-  - https://raw.githubusercontent.com/webtranslateit/webtranslateit/main/.rubocop_common.yml
-  - .rubocop_todo.yml
-
-AllCops:
-  TargetRubyVersion: 3.2
-  Exclude:
-    - lib/generators/**/*
-
-inherit_mode:
-   merge:
-     - Exclude

data/Gemfile

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'guard'
-gem 'guard-rspec'
-gem 'guard-rubocop'
-gem 'matrix'
-gem 'rspec', '~> 3.13.2'
-gem 'rubocop'
-gem 'rubocop-performance'
-gem 'rubocop-rspec'