pdf 0.1.0 → 0.1.1

data/Rakefile

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require "rake/testtask"
 
-RSpec::Core::RakeTask.new(:spec)
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
 
 require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: %i[test rubocop]

data/examples/01_basic_invoice.rb

@@ -0,0 +1,139 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Example 01: Basic Invoice
+# Run: ruby examples/01_basic_invoice.rb
+#
+# Demonstrates:
+# - Basic view structure
+# - Title, subtitle, date components
+# - Table with columns
+# - Sections
+# - Data binding via symbols
+# - Method-based computed values
+
+require_relative "../lib/pdf"
+
+class Invoice < Pdf::View
+  title "INVOICE"
+  date :invoice_date, format: "%B %d, %Y"
+
+  spacer amount: 10
+
+  paragraph :billing_info
+
+  hr
+
+  section "Order Items" do
+    table :line_items, columns: [
+      { key: :sku, label: "SKU" },
+      { key: :description, label: "Description" },
+      { key: :quantity, label: "Qty" },
+      { key: :unit_price, label: "Unit Price" },
+      { key: :total, label: "Total" }
+    ], widths: ["15%", "40%", "10%", "17.5%", "17.5%"]
+  end
+
+  spacer amount: 15
+
+  section "Summary" do
+    paragraph :subtotal_line
+    paragraph :tax_line
+    heading :total_line, size: 14
+  end
+
+  spacer amount: 20
+
+  alert :payment_info
+
+  hr
+
+  span :footer_note, size: 8, color: "666666"
+
+  # Data accessors
+
+  def invoice_date
+    data[:date] || Date.today
+  end
+
+  def billing_info
+    <<~INFO
+      Invoice #: #{data[:invoice_number]}
+      Customer: #{data[:customer][:name]}
+      Address: #{data[:customer][:address]}
+      Email: #{data[:customer][:email]}
+    INFO
+  end
+
+  def line_items
+    data[:items].map do |item|
+      item.merge(total: format_currency(item[:quantity] * item[:unit_price_cents]))
+    end
+  end
+
+  def subtotal_line
+    "Subtotal: #{format_currency(subtotal_cents)}"
+  end
+
+  def tax_line
+    "Tax (#{data[:tax_rate]}%): #{format_currency(tax_cents)}"
+  end
+
+  def total_line
+    "TOTAL DUE: #{format_currency(subtotal_cents + tax_cents)}"
+  end
+
+  def payment_info
+    {
+      title: "Payment Due: #{(data[:date] + 30).strftime('%B %d, %Y')}",
+      description: "Please remit payment to: #{data[:payment_details]}",
+      color: "blue"
+    }
+  end
+
+  def footer_note
+    "Thank you for your business! Questions? Contact us at billing@example.com"
+  end
+
+  private
+
+  def subtotal_cents
+    data[:items].sum { |i| i[:quantity] * i[:unit_price_cents] }
+  end
+
+  def tax_cents
+    (subtotal_cents * data[:tax_rate] / 100.0).round
+  end
+
+  def format_currency(cents)
+    "$#{'%.2f' % (cents / 100.0)}"
+  end
+end
+
+# --- Generate the invoice ---
+
+invoice_data = {
+  invoice_number: "INV-2024-0042",
+  date: Date.new(2024, 12, 15),
+  tax_rate: 8.5,
+  payment_details: "Acme Corp, Account #12345678",
+  customer: {
+    name: "John Smith",
+    address: "123 Main Street, Anytown, ST 12345",
+    email: "john.smith@example.com"
+  },
+  items: [
+    { sku: "WDG-001", description: "Premium Widget (Blue)", quantity: 5, unit_price_cents: 2499 },
+    { sku: "WDG-002", description: "Deluxe Widget (Red)", quantity: 3, unit_price_cents: 3499 },
+    { sku: "GDG-001", description: "Standard Gadget", quantity: 10, unit_price_cents: 999 },
+    { sku: "ACC-001", description: "Widget Mounting Kit", quantity: 2, unit_price_cents: 1599 },
+    { sku: "SVC-001", description: "Installation Service", quantity: 1, unit_price_cents: 7500 }
+  ]
+}
+
+# Generate and open
+output_path = "/tmp/invoice_example.pdf"
+Invoice.new(invoice_data).to_file(output_path)
+
+puts "Generated: #{output_path}"
+system("open", output_path)

data/examples/02_report_with_layout.rb

@@ -0,0 +1,266 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Example 02: Report with Layout
+# Run: ruby examples/02_report_with_layout.rb
+#
+# Demonstrates:
+# - Custom layout with header and footer
+# - QR code generation from data
+# - Context lines in header
+# - Page numbers
+# - Multi-section report
+# - Alerts with different colors
+# - Tables with data transformation
+# - Raw Prawn access for custom drawing
+
+require_relative "../lib/pdf"
+
+# --- Layout Definition ---
+
+class CompanyReportLayout < Pdf::Layout
+  header do
+    qr_code data: :document_url, size: 50, position: :right
+    context :header_context, label: "REPORT INFO"
+  end
+
+  footer do
+    text :footer_disclaimer, size: 7
+    page_number position: :right, format: "Page %<page>d of %<total>d"
+  end
+
+  margins top: 90, bottom: 70, left: 50, right: 50
+end
+
+# --- Report View ---
+
+class QuarterlyReport < Pdf::View
+  layout CompanyReportLayout
+
+  title :report_title, size: 22
+  subtitle :report_period
+  date :generated_at, format: "Generated: %B %d, %Y at %H:%M"
+
+  spacer amount: 15
+
+  alert :executive_summary
+
+  hr
+
+  section "Revenue Breakdown" do
+    table :revenue_data, columns: [
+      { key: :category, label: "Category" },
+      { key: :q1, label: "Q1" },
+      { key: :q2, label: "Q2" },
+      { key: :q3, label: "Q3" },
+      { key: :q4, label: "Q4" },
+      { key: :total, label: "Total" }
+    ], widths: ["25%", "15%", "15%", "15%", "15%", "15%"]
+  end
+
+  spacer amount: 10
+
+  # Custom chart placeholder using raw Prawn
+  raw do |pdf|
+    pdf.text "Revenue Trend (Visual)", size: 12, style: :bold
+    pdf.move_down 10
+
+    # Draw a simple bar chart
+    start_x = 50
+    bar_width = 60
+    max_height = 100
+    values = [65, 78, 82, 95]
+    labels = ["Q1", "Q2", "Q3", "Q4"]
+    colors = ["4CAF50", "2196F3", "FF9800", "9C27B0"]
+
+    values.each_with_index do |val, i|
+      x = start_x + (i * (bar_width + 20))
+      height = (val / 100.0) * max_height
+
+      pdf.fill_color colors[i]
+      pdf.fill_rectangle [x, pdf.cursor], bar_width, height
+
+      pdf.fill_color "333333"
+      pdf.draw_text labels[i], at: [x + 20, pdf.cursor - height - 15], size: 10
+      pdf.draw_text "#{val}%", at: [x + 18, pdf.cursor - height + 10], size: 8
+    end
+
+    pdf.fill_color "000000"
+    pdf.move_down max_height + 30
+  end
+
+  hr
+
+  section "Key Performance Indicators" do
+    each(:kpis) do |kpi|
+      alert kpi
+    end
+  end
+
+  section "Regional Performance" do
+    table :regional_data, columns: [
+      { key: :region, label: "Region" },
+      { key: :revenue, label: "Revenue" },
+      { key: :growth, label: "YoY Growth" },
+      { key: :status, label: "Status" }
+    ]
+  end
+
+  spacer amount: 15
+
+  section "Notes & Observations" do
+    each(:observations) do |obs|
+      paragraph obs
+    end
+  end
+
+  page_break
+
+  section "Appendix: Detailed Metrics" do
+    table :detailed_metrics, columns: [:metric, :value, :target, :variance]
+  end
+
+  # --- Data Methods ---
+
+  def report_title
+    "#{data[:company]} Quarterly Report"
+  end
+
+  def report_period
+    "#{data[:quarter]} #{data[:year]}"
+  end
+
+  def generated_at
+    Time.now
+  end
+
+  def header_context
+    [
+      "Company: #{data[:company]}",
+      "Period: #{data[:quarter]} #{data[:year]}",
+      "Confidentiality: #{data[:confidentiality]}"
+    ]
+  end
+
+  def document_url
+    "https://reports.example.com/#{data[:report_id]}"
+  end
+
+  def footer_disclaimer
+    "#{data[:company]} - Confidential. Distribution restricted to authorized personnel only."
+  end
+
+  def executive_summary
+    {
+      title: "Executive Summary",
+      description: data[:summary],
+      color: "blue"
+    }
+  end
+
+  def revenue_data
+    data[:revenue].map do |row|
+      row.merge(total: format_currency(row.values_at(:q1, :q2, :q3, :q4).map { |v| parse_currency(v) }.sum))
+    end
+  end
+
+  def kpis
+    data[:kpis].map do |kpi|
+      color = case kpi[:status]
+              when :good then "green"
+              when :warning then "orange"
+              when :critical then "red"
+              else "blue"
+              end
+      {
+        title: "#{kpi[:name]}: #{kpi[:value]}",
+        description: "Target: #{kpi[:target]} | #{kpi[:trend]}",
+        color: color
+      }
+    end
+  end
+
+  def regional_data
+    data[:regions]
+  end
+
+  def observations
+    data[:observations]
+  end
+
+  def detailed_metrics
+    data[:metrics]
+  end
+
+  private
+
+  def format_currency(cents)
+    "$#{cents.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse}"
+  end
+
+  def parse_currency(str)
+    str.to_s.gsub(/[$,]/, "").to_i
+  end
+end
+
+# --- Generate the report ---
+
+report_data = {
+  company: "Acme Corporation",
+  quarter: "Q4",
+  year: 2024,
+  report_id: "RPT-2024-Q4-001",
+  confidentiality: "Internal Use Only",
+
+  summary: "Q4 2024 showed strong performance across all regions with 18% YoY revenue growth. " \
+           "The APAC region exceeded targets by 25%, while EMEA stabilized after Q3 restructuring. " \
+           "Customer acquisition costs decreased by 12% due to improved marketing efficiency.",
+
+  revenue: [
+    { category: "Product Sales", q1: "$1.2M", q2: "$1.4M", q3: "$1.5M", q4: "$1.8M" },
+    { category: "Services", q1: "$800K", q2: "$850K", q3: "$920K", q4: "$1.1M" },
+    { category: "Subscriptions", q1: "$2.1M", q2: "$2.3M", q3: "$2.5M", q4: "$2.8M" },
+    { category: "Licensing", q1: "$400K", q2: "$420K", q3: "$450K", q4: "$500K" }
+  ],
+
+  kpis: [
+    { name: "Revenue Growth", value: "+18%", target: "+15%", trend: "Exceeding target", status: :good },
+    { name: "Customer Retention", value: "94%", target: "95%", trend: "Slightly below", status: :warning },
+    { name: "NPS Score", value: "72", target: "70", trend: "Improving", status: :good },
+    { name: "CAC", value: "$142", target: "$150", trend: "12% reduction", status: :good },
+    { name: "Churn Rate", value: "2.8%", target: "2.5%", trend: "Needs attention", status: :warning }
+  ],
+
+  regions: [
+    { region: "North America", revenue: "$3.2M", growth: "+15%", status: "On Track" },
+    { region: "EMEA", revenue: "$1.8M", growth: "+8%", status: "Recovering" },
+    { region: "APAC", revenue: "$1.5M", growth: "+32%", status: "Exceeding" },
+    { region: "LATAM", revenue: "$0.7M", growth: "+22%", status: "Growing" }
+  ],
+
+  observations: [
+    "Product launch in October drove significant Q4 growth in North America.",
+    "APAC expansion strategy showing strong ROI, consider accelerating.",
+    "EMEA restructuring complete, expect normalized growth in Q1 2025.",
+    "Customer feedback indicates high demand for enterprise features.",
+    "Recommend increasing R&D budget allocation for H1 2025."
+  ],
+
+  metrics: [
+    { metric: "MRR", value: "$580K", target: "$550K", variance: "+5.5%" },
+    { metric: "ARR", value: "$6.96M", target: "$6.6M", variance: "+5.5%" },
+    { metric: "Active Users", value: "45,200", target: "42,000", variance: "+7.6%" },
+    { metric: "Avg. Deal Size", value: "$12,400", target: "$11,000", variance: "+12.7%" },
+    { metric: "Sales Cycle", value: "34 days", target: "40 days", variance: "-15%" },
+    { metric: "Support Tickets", value: "1,240", target: "1,500", variance: "-17.3%" },
+    { metric: "Resolution Time", value: "4.2 hrs", target: "6 hrs", variance: "-30%" },
+    { metric: "Employee Count", value: "128", target: "125", variance: "+2.4%" }
+  ]
+}
+
+# Generate and open
+output_path = "/tmp/quarterly_report_example.pdf"
+QuarterlyReport.new(report_data).to_file(output_path)
+
+puts "Generated: #{output_path}"
+system("open", output_path)