pdf 0.1.0 → 0.1.1

data/examples/03_inherited_views.rb

@@ -0,0 +1,318 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Example 03: View Inheritance
+# Run: ruby examples/03_inherited_views.rb
+#
+# Demonstrates:
+# - Base view with shared elements
+# - Child views that extend parent
+# - Multi-level inheritance
+# - Layout inheritance
+# - Method overriding in child views
+# - Shared and specialized sections
+
+require_relative "../lib/pdf"
+
+# --- Shared Layout ---
+
+class CorporateLayout < Pdf::Layout
+  header do
+    context :document_header, label: "DOCUMENT"
+  end
+
+  footer do
+    text :company_footer, size: 7
+    page_number position: :right
+  end
+
+  margins top: 85, bottom: 65
+end
+
+# --- Base Document (Level 1) ---
+
+class BaseDocument < Pdf::View
+  layout CorporateLayout
+
+  # All documents start with this
+  title :document_title, size: 20
+  date :document_date
+  hr
+  spacer amount: 10
+
+  # All documents end with this
+  def document_header
+    [
+      "Acme Corporation",
+      "Document: #{data[:doc_type] || 'General'}",
+      "ID: #{data[:doc_id] || 'N/A'}"
+    ]
+  end
+
+  def company_footer
+    "Acme Corporation | Confidential | #{Date.today.year}"
+  end
+
+  def document_title
+    data[:title] || "Untitled Document"
+  end
+
+  def document_date
+    data[:date] || Date.today
+  end
+end
+
+# --- Report Base (Level 2) - Extends BaseDocument ---
+
+class BaseReport < BaseDocument
+  # Inherits: title, date, hr, spacer from BaseDocument
+
+  # Reports add an executive summary
+  alert :summary_alert
+
+  section "Overview" do
+    paragraph :overview_text
+  end
+
+  def summary_alert
+    {
+      title: "Summary",
+      description: data[:summary] || "No summary provided.",
+      color: "blue"
+    }
+  end
+
+  def overview_text
+    data[:overview] || "Overview not available."
+  end
+end
+
+# --- Sales Report (Level 3) - Extends BaseReport ---
+
+class SalesReport < BaseReport
+  # Inherits: title, date, hr, spacer, summary_alert, overview section
+
+  section "Sales Performance" do
+    table :sales_data, columns: [
+      { key: :product, label: "Product" },
+      { key: :units, label: "Units Sold" },
+      { key: :revenue, label: "Revenue" },
+      { key: :margin, label: "Margin %" }
+    ]
+  end
+
+  section "Top Performers" do
+    each(:top_sellers) do |seller|
+      heading seller[:name], size: 11
+      span "Region: #{seller[:region]} | Sales: #{seller[:sales]}"
+      spacer amount: 5
+    end
+  end
+
+  section "Recommendations" do
+    each(:recommendations) do |rec|
+      paragraph "- #{rec}"
+    end
+  end
+
+  def sales_data
+    data[:sales] || []
+  end
+
+  def top_sellers
+    data[:top_sellers] || []
+  end
+
+  def recommendations
+    data[:recommendations] || []
+  end
+end
+
+# --- HR Report (Level 3) - Also Extends BaseReport ---
+
+class HRReport < BaseReport
+  # Inherits: title, date, hr, spacer, summary_alert, overview section
+
+  section "Headcount Summary" do
+    table :headcount_data, columns: [:department, :count, :change, :openings]
+  end
+
+  section "Recent Hires" do
+    each(:recent_hires) do |hire|
+      paragraph "#{hire[:name]} - #{hire[:role]} (#{hire[:department]}) - Started #{hire[:start_date]}"
+    end
+  end
+
+  section "Turnover Analysis" do
+    alert :turnover_alert
+    paragraph :turnover_analysis
+  end
+
+  def headcount_data
+    data[:headcount] || []
+  end
+
+  def recent_hires
+    data[:recent_hires] || []
+  end
+
+  def turnover_alert
+    rate = data[:turnover_rate] || 0
+    color = rate < 10 ? "green" : rate < 20 ? "orange" : "red"
+    {
+      title: "Turnover Rate: #{rate}%",
+      description: rate < 10 ? "Healthy retention" : "Attention needed",
+      color: color
+    }
+  end
+
+  def turnover_analysis
+    data[:turnover_analysis] || "No analysis available."
+  end
+end
+
+# --- Finance Report (Level 3) - Also Extends BaseReport ---
+
+class FinanceReport < BaseReport
+  # Inherits: title, date, hr, spacer, summary_alert, overview section
+
+  section "Financial Summary" do
+    table :financial_data, columns: [:metric, :current, :previous, :change]
+  end
+
+  section "Budget Status" do
+    each(:budget_items) do |item|
+      color = item[:status] == "On Track" ? "green" : item[:status] == "At Risk" ? "orange" : "red"
+      alert title: item[:category], description: "#{item[:spent]} of #{item[:budget]} (#{item[:status]})", color: color
+    end
+  end
+
+  section "Cash Flow" do
+    paragraph :cash_flow_summary
+  end
+
+  def financial_data
+    data[:financials] || []
+  end
+
+  def budget_items
+    data[:budget] || []
+  end
+
+  def cash_flow_summary
+    data[:cash_flow] || "Cash flow data not available."
+  end
+end
+
+# --- Generate All Three Report Types ---
+
+puts "Generating inherited view examples...\n\n"
+
+# 1. Sales Report
+sales_data = {
+  doc_type: "Sales Report",
+  doc_id: "SR-2024-Q4-001",
+  title: "Q4 2024 Sales Report",
+  date: Date.new(2024, 12, 31),
+  summary: "Strong Q4 performance with 22% growth over Q3. Enterprise segment exceeded targets.",
+  overview: "This report covers sales performance for Q4 2024, highlighting key metrics, top performers, and strategic recommendations for Q1 2025.",
+
+  sales: [
+    { product: "Enterprise Suite", units: 145, revenue: "$2.1M", margin: "68%" },
+    { product: "Professional", units: 892, revenue: "$1.3M", margin: "72%" },
+    { product: "Starter", units: 2340, revenue: "$468K", margin: "81%" },
+    { product: "Add-ons", units: 1567, revenue: "$235K", margin: "89%" }
+  ],
+
+  top_sellers: [
+    { name: "Sarah Johnson", region: "West Coast", sales: "$890K" },
+    { name: "Michael Chen", region: "Northeast", sales: "$756K" },
+    { name: "Emily Rodriguez", region: "Southwest", sales: "$623K" }
+  ],
+
+  recommendations: [
+    "Increase Enterprise Suite marketing budget by 15%",
+    "Launch referral program for Professional tier",
+    "Expand West Coast team based on performance",
+    "Develop upsell path from Starter to Professional"
+  ]
+}
+
+sales_path = "/tmp/sales_report_inherited.pdf"
+SalesReport.new(sales_data).to_file(sales_path)
+puts "Generated Sales Report: #{sales_path}"
+
+# 2. HR Report
+hr_data = {
+  doc_type: "HR Report",
+  doc_id: "HR-2024-Q4-001",
+  title: "Q4 2024 HR Report",
+  date: Date.new(2024, 12, 31),
+  summary: "Successful hiring quarter with 28 new employees. Retention improved by 3%.",
+  overview: "Quarterly human resources report covering headcount, hiring, and employee retention metrics.",
+
+  headcount: [
+    { department: "Engineering", count: 45, change: "+8", openings: 5 },
+    { department: "Sales", count: 23, change: "+4", openings: 2 },
+    { department: "Marketing", count: 12, change: "+2", openings: 1 },
+    { department: "Operations", count: 18, change: "+3", openings: 0 },
+    { department: "Finance", count: 8, change: "+1", openings: 1 }
+  ],
+
+  recent_hires: [
+    { name: "Alex Thompson", role: "Senior Engineer", department: "Engineering", start_date: "Dec 1" },
+    { name: "Jessica Lee", role: "Account Executive", department: "Sales", start_date: "Nov 15" },
+    { name: "David Park", role: "Product Designer", department: "Engineering", start_date: "Nov 1" },
+    { name: "Maria Santos", role: "Marketing Manager", department: "Marketing", start_date: "Oct 15" }
+  ],
+
+  turnover_rate: 8,
+  turnover_analysis: "Q4 turnover decreased from 11% to 8%, primarily due to improved compensation " \
+                     "packages and the new remote work policy. Engineering retention improved significantly " \
+                     "following the technical career ladder implementation."
+}
+
+hr_path = "/tmp/hr_report_inherited.pdf"
+HRReport.new(hr_data).to_file(hr_path)
+puts "Generated HR Report: #{hr_path}"
+
+# 3. Finance Report
+finance_data = {
+  doc_type: "Finance Report",
+  doc_id: "FIN-2024-Q4-001",
+  title: "Q4 2024 Finance Report",
+  date: Date.new(2024, 12, 31),
+  summary: "Revenue exceeded forecast by 8%. Operating margin improved to 24%.",
+  overview: "Quarterly financial report with key metrics, budget analysis, and cash flow summary.",
+
+  financials: [
+    { metric: "Revenue", current: "$4.1M", previous: "$3.6M", change: "+13.9%" },
+    { metric: "Gross Profit", current: "$2.9M", previous: "$2.5M", change: "+16.0%" },
+    { metric: "Operating Expenses", current: "$1.9M", previous: "$1.8M", change: "+5.6%" },
+    { metric: "Net Income", current: "$980K", previous: "$720K", change: "+36.1%" },
+    { metric: "EBITDA", current: "$1.2M", previous: "$950K", change: "+26.3%" }
+  ],
+
+  budget: [
+    { category: "Engineering", budget: "$1.2M", spent: "$1.15M", status: "On Track" },
+    { category: "Sales & Marketing", budget: "$800K", spent: "$820K", status: "At Risk" },
+    { category: "Operations", budget: "$400K", spent: "$380K", status: "On Track" },
+    { category: "R&D", budget: "$600K", spent: "$720K", status: "Over Budget" }
+  ],
+
+  cash_flow: "Operating cash flow remained strong at $1.1M for the quarter. Major capital expenditure " \
+             "of $250K for infrastructure upgrades was completed. Cash reserves stand at $3.2M, " \
+             "providing 8 months of runway at current burn rate. Accounts receivable aging improved " \
+             "with DSO reduced from 45 to 38 days."
+}
+
+finance_path = "/tmp/finance_report_inherited.pdf"
+FinanceReport.new(finance_data).to_file(finance_path)
+puts "Generated Finance Report: #{finance_path}"
+
+puts "\nOpening all three reports..."
+system("open", sales_path)
+sleep 0.5
+system("open", hr_path)
+sleep 0.5
+system("open", finance_path)