tallyman 1.0.0

data/lib/tallyman/templates/invoice.typ

@@ -0,0 +1,171 @@
+// Tallyman'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 Tallyman::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/tallyman.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/generators")
+loader.setup
+
+require 'active_support/core_ext/object/blank' # For Object#blank? method
+require 'bigdecimal'
+require 'date'
+require 'i18n'
+require 'json'
+require 'money'
+require 'typst'
+require 'time'
+
+# 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 Tallyman
+
+  # A blank value (nil, "", "  ") is 0.
+  def self.to_decimal(value)
+    BigDecimal(value.to_s.presence || 0)
+  end
+
+end

data/tallyman.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name        = 'tallyman'
+  s.version     = '1.0.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/Rebase-Capital/tallyman'
+  s.summary     = 'A simple library for rendering invoices.'
+  s.description = 'Tallyman 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 'rqrcode', '>= 2', '< 4'
+  s.add_dependency 'typst', '~> 0.15'
+  s.add_dependency 'zeitwerk', '~> 2.6', '< 3'
+
+  # 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 tallyman.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

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: tallyman
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alan Johnson
+- Edouard Briere
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: typst
+  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'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Tallyman is a library for rendering invoices to pdf, using Typst.
+email:
+- edouard@webtranslateit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- config/locales/tallyman.de.yml
+- config/locales/tallyman.en.yml
+- config/locales/tallyman.es.yml
+- config/locales/tallyman.fr.yml
+- config/locales/tallyman.nl.yml
+- config/locales/tallyman.zh-CN.yml
+- fonts/NotoSans-Bold.ttf
+- fonts/NotoSans-Regular.ttf
+- lib/generators/tallyman/setup/USAGE
+- lib/generators/tallyman/setup/setup_generator.rb
+- lib/generators/tallyman/setup/templates/invoice.rb
+- lib/generators/tallyman/setup/templates/line_item.rb
+- lib/generators/tallyman/setup/templates/migration.rb
+- lib/tallyman.rb
+- lib/tallyman/appendix.rb
+- lib/tallyman/assets/default_logo.png
+- lib/tallyman/config.rb
+- lib/tallyman/invoice.rb
+- lib/tallyman/invoice_presenter.rb
+- lib/tallyman/invoiceable.rb
+- lib/tallyman/line_item.rb
+- lib/tallyman/line_itemable.rb
+- lib/tallyman/markup.rb
+- lib/tallyman/pdf_renderer.rb
+- lib/tallyman/qr_code.rb
+- lib/tallyman/templates/invoice.typ
+- tallyman.gemspec
+homepage: https://github.com/Rebase-Capital/tallyman
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A simple library for rendering invoices.
+test_files: []