Merge branch 'master' into clauding
This commit is contained in:
201
.claude/skills/invoice-template-creator/SKILL.md
Normal file
201
.claude/skills/invoice-template-creator/SKILL.md
Normal file
@@ -0,0 +1,201 @@
|
||||
---
|
||||
name: invoice-template-creator
|
||||
description: This skill creates PDF invoice parsing templates for the Integreat system. It should be used when adding support for a new vendor invoice format that needs to be automatically parsed.
|
||||
license: Complete terms in LICENSE.txt
|
||||
---
|
||||
|
||||
# Invoice Template Creator
|
||||
|
||||
This skill automates the creation of invoice parsing templates for the Integreat system. It generates both the template definition and a corresponding test file based on a sample PDF invoice.
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
Use this skill when you need to add support for a new vendor invoice format that cannot be parsed by existing templates. This typically happens when:
|
||||
|
||||
- A new vendor sends invoices in a unique format
|
||||
- An existing vendor changes their invoice layout
|
||||
- You encounter an invoice that fails to parse with current templates
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before using this skill, ensure you have:
|
||||
|
||||
1. A sample PDF invoice file placed in `dev-resources/` directory
|
||||
2. Identified the vendor name
|
||||
3. Identified unique text patterns in the invoice (phone numbers, addresses, etc.) that can distinguish this vendor
|
||||
4. Know the expected values for key fields (invoice number, date, customer name, total)
|
||||
|
||||
## Usage Workflow
|
||||
|
||||
### Step 1: Analyze the PDF
|
||||
|
||||
First, extract and analyze the PDF text to understand its structure:
|
||||
|
||||
```bash
|
||||
pdftotext -layout "dev-resources/FILENAME.pdf" -
|
||||
```
|
||||
|
||||
Look for:
|
||||
- **Vendor identifiers**: Phone numbers, addresses, or unique text that identifies this vendor
|
||||
- **Field patterns**: How invoice number, date, customer name, and total appear in the text
|
||||
- **Layout quirks**: Multi-line fields, special formatting, or unusual spacing
|
||||
|
||||
### Step 2: Define Expected Values
|
||||
|
||||
Document the expected values for each field:
|
||||
|
||||
| Field | Expected Value | Notes |
|
||||
|-------|---------------|-------|
|
||||
| Vendor Name | "Vendor Name" | Company name as it should appear |
|
||||
| Invoice Number | "12345" | The invoice identifier |
|
||||
| Date | "01/15/26" | Format found in PDF |
|
||||
| Customer Name | "Customer Name" | As it appears on invoice |
|
||||
| Customer Address | "123 Main St" | Street address if available |
|
||||
| Total | "100.00" | Amount |
|
||||
|
||||
### Step 3: Create the Template and Test
|
||||
|
||||
The skill will:
|
||||
|
||||
1. **Create a test file** at `test/clj/auto_ap/parse/templates_test.clj` (or add to existing)
|
||||
- Test parses the PDF file
|
||||
- Verifies all expected values are extracted correctly
|
||||
- Follows existing test patterns
|
||||
|
||||
2. **Add template to** `src/clj/auto_ap/parse/templates.clj`
|
||||
- Adds entry to `pdf-templates` vector
|
||||
- Includes:
|
||||
- `:vendor` - Vendor name
|
||||
- `:keywords` - Regex patterns to identify this vendor (must match all)
|
||||
- `:extract` - Regex patterns for each field
|
||||
- `:parser` - Optional date/number parsers
|
||||
|
||||
### Step 4: Iterative Refinement
|
||||
|
||||
Run the test to see if it passes:
|
||||
|
||||
```bash
|
||||
lein test auto-ap.parse.templates-test
|
||||
```
|
||||
|
||||
If it fails, examine the debug output and refine the regex patterns. Common issues:
|
||||
|
||||
- **Template doesn't match**: Keywords don't actually appear in the PDF text
|
||||
- **Field is nil**: Regex capture group doesn't match the actual text format
|
||||
- **Wrong value captured**: Regex is too greedy or matches wrong text
|
||||
|
||||
## Template Structure Reference
|
||||
|
||||
### Basic Template Format
|
||||
|
||||
```clojure
|
||||
{:vendor "Vendor Name"
|
||||
:keywords [#"unique-pattern-1" #"unique-pattern-2"]
|
||||
:extract {:invoice-number #"Invoice\s+#\s+(\d+)"
|
||||
:date #"Date:\s+(\d{2}/\d{2}/\d{2})"
|
||||
:customer-identifier #"Bill To:\s+([A-Za-z\s]+)"
|
||||
:total #"Total:\s+\$([\d,]+\.\d{2})"}
|
||||
:parser {:date [:clj-time "MM/dd/yy"]
|
||||
:total [:trim-commas nil]}}
|
||||
```
|
||||
|
||||
### Field Extraction Patterns
|
||||
|
||||
**Invoice Number:**
|
||||
- Look for: `"Invoice #12345"` or `"INV: 12345"`
|
||||
- Pattern: `#"Invoice\s*#?\s*(\d+)"` or `#"INV:\s*(\d+)"`
|
||||
|
||||
**Date:**
|
||||
- Common formats: `"01/15/26"`, `"Jan 15, 2026"`, `"2026-01-15"`
|
||||
- Pattern: `#"(\d{2}/\d{2}/\d{2})"` for MM/dd/yy
|
||||
- Parser: `:date [:clj-time "MM/dd/yy"]`
|
||||
|
||||
**Customer Identifier:**
|
||||
- Look for: `"Bill To: Customer Name"` or `"Sold To: Customer Name"`
|
||||
- Pattern: `#"Bill To:\s+([A-Za-z\s]+?)(?=\s{2,}|\n)"`
|
||||
- Use non-greedy `+?` and lookahead `(?=...)` to stop at boundaries
|
||||
|
||||
**Total:**
|
||||
- Look for: `"Total: $100.00"` or `"Amount Due: 100.00"`
|
||||
- Pattern: `#"Total:\s+\$?([\d,]+\.\d{2})"`
|
||||
- Parser: `:total [:trim-commas nil]` removes commas
|
||||
|
||||
### Advanced Patterns
|
||||
|
||||
**Multi-line customer address:**
|
||||
When customer info spans multiple lines (name + address):
|
||||
|
||||
```clojure
|
||||
:customer-identifier #"(?s)I\s+([A-Z][A-Z\s]+?)\s{2,}.*?L\s+([0-9][A-Z0-9\s]+?)(?=\s{2,}|\n)"
|
||||
:account-number #"(?s)L\s+([0-9][A-Z0-9\s]+?)(?=\s{2,}|\n)"
|
||||
```
|
||||
|
||||
The `(?s)` flag makes `.` match newlines. Use non-greedy `+?` and lookaheads `(?=...)` to capture clean values.
|
||||
|
||||
**Multiple date formats:**
|
||||
|
||||
```clojure
|
||||
:parser {:date [:clj-time ["MM/dd/yy" "yyyy-MM-dd"]]}
|
||||
```
|
||||
|
||||
**Credit memos (negative amounts):**
|
||||
|
||||
```clojure
|
||||
:parser {:total [:trim-commas-and-negate nil]}
|
||||
```
|
||||
|
||||
## Testing Best Practices
|
||||
|
||||
1. IMPORTANT, CRITICAL!! **Start with a failing test** - Define expected values before implementing
|
||||
2. **Test actual PDF parsing** - Use `parse-file` or `parse` with real PDF text
|
||||
3. **Verify each field individually** - Separate assertions for clarity
|
||||
4. **Handle date comparisons carefully** - Compare year/month/day separately if needed
|
||||
5. **Use `str/trim`** - Account for extra whitespace in extracted values
|
||||
|
||||
## Example Test Structure
|
||||
|
||||
```clojure
|
||||
(deftest parse-vendor-invoice-12345
|
||||
(testing "Should parse Vendor invoice with expected values"
|
||||
(let [results (sut/parse-file (io/file "dev-resources/INVOICE.pdf")
|
||||
"INVOICE.pdf")
|
||||
result (first results)]
|
||||
(is (some? results) "Should return results")
|
||||
(is (some? result) "Template should match")
|
||||
(when result
|
||||
(is (= "Vendor Name" (:vendor-code result)))
|
||||
(is (= "12345" (:invoice-number result)))
|
||||
(is (= "Customer Name" (:customer-identifier result)))
|
||||
(is (= "100.00" (:total result)))))))
|
||||
```
|
||||
|
||||
## Common Pitfalls
|
||||
|
||||
1. **Keywords must all match** - Every pattern in `:keywords` must be found in the PDF
|
||||
2. **Capture groups required** - Regexes need `()` to extract values
|
||||
3. **PDF text != visual text** - Layout may differ from what you see visually
|
||||
4. **Greedy quantifiers** - Use `+?` instead of `+` to avoid over-matching
|
||||
5. **Case sensitivity** - Regex is case-sensitive unless you use `(?i)` flag
|
||||
|
||||
## Post-Creation Checklist
|
||||
|
||||
After creating the template:
|
||||
|
||||
- [ ] Test passes: `lein test auto-ap.parse.templates-test`
|
||||
- [ ] Format is correct: `lein cljfmt check`
|
||||
- [ ] Code compiles: `lein check`
|
||||
- [ ] Template is in correct position in `pdf-templates` vector
|
||||
- [ ] Keywords uniquely identify this vendor (won't match other templates)
|
||||
- [ ] Test file follows naming conventions
|
||||
|
||||
## Integration with Workflow
|
||||
|
||||
This skill is typically used as part of a larger workflow:
|
||||
|
||||
1. User provides PDF and requirements
|
||||
2. This skill creates template and test
|
||||
3. User reviews and refines if needed
|
||||
4. Test is run to verify extraction
|
||||
5. Code is committed
|
||||
|
||||
The skill ensures consistency with existing patterns and reduces manual boilerplate when adding new vendor support.
|
||||
188
.claude/skills/invoice-template-creator/references/examples.md
Normal file
188
.claude/skills/invoice-template-creator/references/examples.md
Normal file
@@ -0,0 +1,188 @@
|
||||
# Invoice Template Examples
|
||||
|
||||
## Simple Single Invoice
|
||||
|
||||
```clojure
|
||||
{:vendor "Gstar Seafood"
|
||||
:keywords [#"G Star Seafood"]
|
||||
:extract {:total #"Total\s{2,}([\d\-,]+\.\d{2,2}+)"
|
||||
:customer-identifier #"(.*?)(?:\s+)Invoice #"
|
||||
:date #"Invoice Date\s{2,}([0-9]+/[0-9]+/[0-9]+)"
|
||||
:invoice-number #"Invoice #\s+(\d+)"}
|
||||
:parser {:date [:clj-time "MM/dd/yyyy"]
|
||||
:total [:trim-commas nil]}}
|
||||
```
|
||||
|
||||
## Multi-Invoice Statement
|
||||
|
||||
```clojure
|
||||
{:vendor "Southbay Fresh Produce"
|
||||
:keywords [#"(SOUTH BAY FRESH PRODUCE|SOUTH BAY PRODUCE)"]
|
||||
:extract {:date #"^([0-9]+/[0-9]+/[0-9]+)"
|
||||
:customer-identifier #"To:[^\n]*\n\s+([A-Za-z' ]+)\s{2}"
|
||||
:invoice-number #"INV #\/(\d+)"
|
||||
:total #"\$([0-9.]+)\."}
|
||||
:parser {:date [:clj-time "MM/dd/yyyy"]}
|
||||
:multi #"\n"
|
||||
:multi-match? #"^[0-9]+/[0-9]+/[0-9]+\s+INV "}
|
||||
```
|
||||
|
||||
## Customer with Address (Multi-line)
|
||||
|
||||
```clojure
|
||||
{:vendor "Bonanza Produce"
|
||||
:keywords [#"530-544-4136"]
|
||||
:extract {:invoice-number #"NO\s+(\d{8,})\s+\d{2}/\d{2}/\d{2}"
|
||||
:date #"NO\s+\d{8,}\s+(\d{2}/\d{2}/\d{2})"
|
||||
:customer-identifier #"(?s)I\s+([A-Z][A-Z\s]+?)\s{2,}.*?L\s+([0-9][A-Z0-9\s]+?)(?=\s{2,}|\n)"
|
||||
:account-number #"(?s)L\s+([0-9][A-Z0-9\s]+?)(?=\s{2,}|\n)"
|
||||
:total #"SHIPPED\s+[\d\.]+\s+TOTAL\s+([\d\.]+)"}
|
||||
:parser {:date [:clj-time "MM/dd/yy"]
|
||||
:total [:trim-commas nil]}}
|
||||
```
|
||||
|
||||
## Credit Memo (Negative Amounts)
|
||||
|
||||
```clojure
|
||||
{:vendor "General Produce Company"
|
||||
:keywords [#"916-552-6495"]
|
||||
:extract {:date #"DATE.*\n.*\n.*?([0-9]+/[0-9]+/[0-9]+)"
|
||||
:invoice-number #"CREDIT NO.*\n.*\n.*?(\d{5,}?)\s+"
|
||||
:account-number #"CUST NO.*\n.*\n\s+(\d+)"
|
||||
:total #"TOTAL:\s+\|\s*(.*)"}
|
||||
:parser {:date [:clj-time "MM/dd/yy"]
|
||||
:total [:trim-commas-and-negate nil]}}
|
||||
```
|
||||
|
||||
## Complex Date Parsing
|
||||
|
||||
```clojure
|
||||
{:vendor "Ben E. Keith"
|
||||
:keywords [#"BEN E. KEITH"]
|
||||
:extract {:date #"Customer No Mo Day Yr.*?\n.*?\d{5,}\s{2,}(\d+\s+\d+\s+\d+)"
|
||||
:customer-identifier #"Customer No Mo Day Yr.*?\n.*?(\d{5,})"
|
||||
:invoice-number #"Invoice No.*?\n.*?(\d{8,})"
|
||||
:total #"Total Invoice.*?\n.*?([\-]?[0-9]+\.[0-9]{2,})"}
|
||||
:parser {:date [:month-day-year nil]
|
||||
:total [:trim-commas-and-negate nil]}}
|
||||
```
|
||||
|
||||
## Multiple Date Formats
|
||||
|
||||
```clojure
|
||||
{:vendor "RNDC"
|
||||
:keywords [#"P.O.Box 743564"]
|
||||
:extract {:date #"(?:INVOICE|CREDIT) DATE\n(?:.*?)(\S+)\n"
|
||||
:account-number #"Store Number:\s+(\d+)"
|
||||
:invoice-number #"(?:INVOICE|CREDIT) DATE\n(?:.*?)\s{2,}(\d+?)\s+\S+\n"
|
||||
:total #"Net Amount(?:.*\n){4}(?:.*?)([\-]?[0-9\.]+)\n"}
|
||||
:parser {:date [:clj-time ["MM/dd/yy" "dd-MMM-yy"]]
|
||||
:total [:trim-commas-and-negate nil]}}
|
||||
```
|
||||
|
||||
## Common Regex Patterns
|
||||
|
||||
### Phone Numbers
|
||||
```clojure
|
||||
#"\(?[0-9]{3}\)?[-.\s]?[0-9]{3}[-.\s]?[0-9]{4}"
|
||||
```
|
||||
|
||||
### Dollar Amounts
|
||||
```clojure
|
||||
#"\$?([0-9,]+\.[0-9]{2})"
|
||||
```
|
||||
|
||||
### Dates (MM/dd/yy)
|
||||
```clojure
|
||||
#"([0-9]{2}/[0-9]{2}/[0-9]{2})"
|
||||
```
|
||||
|
||||
### Dates (MM/dd/yyyy)
|
||||
```clojure
|
||||
#"([0-9]{2}/[0-9]{2}/[0-9]{4})"
|
||||
```
|
||||
|
||||
### Multi-line Text (dotall mode)
|
||||
```clojure
|
||||
#"(?s)start.*?end"
|
||||
```
|
||||
|
||||
### Non-greedy Match
|
||||
```clojure
|
||||
#"(pattern.+?)"
|
||||
```
|
||||
|
||||
### Lookahead Boundary
|
||||
```clojure
|
||||
#"value(?=\s{2,}|\n)"
|
||||
```
|
||||
|
||||
## Field Extraction Strategies
|
||||
|
||||
### 1. Simple Line-based
|
||||
Use `[^\n]*` to match until end of line:
|
||||
```clojure
|
||||
#"Invoice:\s+([^\n]+)"
|
||||
```
|
||||
|
||||
### 2. Whitespace Boundary
|
||||
Use `(?=\s{2,}|\n)` to stop at multiple spaces or newline:
|
||||
```clojure
|
||||
#"Customer:\s+(.+?)(?=\s{2,}|\n)"
|
||||
```
|
||||
|
||||
### 3. Specific Marker
|
||||
Match until a specific pattern is found:
|
||||
```clojure
|
||||
#"(?s)Start(.*?)End"
|
||||
```
|
||||
|
||||
### 4. Multi-part Extraction
|
||||
Use multiple capture groups for related fields:
|
||||
```clojure
|
||||
#"Date:\s+(\d{2})/(\d{2})/(\d{2})"
|
||||
```
|
||||
|
||||
## Parser Options
|
||||
|
||||
### Date Parsers
|
||||
- `[:clj-time "MM/dd/yyyy"]` - Standard US date
|
||||
- `[:clj-time "MM/dd/yy"]` - 2-digit year
|
||||
- `[:clj-time "MMM dd, yyyy"]` - Named month
|
||||
- `[:clj-time ["MM/dd/yy" "yyyy-MM-dd"]]` - Multiple formats
|
||||
- `[:month-day-year nil]` - Space-separated (1 15 26)
|
||||
|
||||
### Number Parsers
|
||||
- `[:trim-commas nil]` - Remove commas from numbers
|
||||
- `[:trim-commas-and-negate nil]` - Handle negative/credit amounts
|
||||
- `[:trim-commas-and-remove-dollars nil]` - Remove $ and commas
|
||||
- `nil` - No parsing, return raw string
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
### Basic Test Structure
|
||||
```clojure
|
||||
(deftest parse-vendor-invoice
|
||||
(testing "Should parse vendor invoice"
|
||||
(let [results (sut/parse-file (io/file "dev-resources/INVOICE.pdf")
|
||||
"INVOICE.pdf")
|
||||
result (first results)]
|
||||
(is (some? result))
|
||||
(is (= "Vendor" (:vendor-code result)))
|
||||
(is (= "12345" (:invoice-number result))))))
|
||||
```
|
||||
|
||||
### Date Testing
|
||||
```clojure
|
||||
(let [d (:date result)]
|
||||
(is (= 2026 (time/year d)))
|
||||
(is (= 1 (time/month d)))
|
||||
(is (= 15 (time/day d))))
|
||||
```
|
||||
|
||||
### Multi-field Verification
|
||||
```clojure
|
||||
(is (= "Expected Name" (:customer-identifier result)))
|
||||
(is (= "Expected Street" (str/trim (:account-number result))))
|
||||
(is (= "Expected City, ST 12345" (str/trim (:location result))))
|
||||
```
|
||||
174
.opencode/skills/clojure-eval/SKILL.md
Normal file
174
.opencode/skills/clojure-eval/SKILL.md
Normal file
@@ -0,0 +1,174 @@
|
||||
---
|
||||
name: clojure-eval
|
||||
description: Evaluate Clojure code via nREPL using clj-nrepl-eval. Use this when you need to test code, check if edited files compile, verify function behavior, or interact with a running REPL session.
|
||||
---
|
||||
|
||||
# Clojure REPL Evaluation
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
Use this skill when you need to:
|
||||
- **Verify that edited Clojure files compile and load correctly**
|
||||
- Test function behavior interactively
|
||||
- Check the current state of the REPL
|
||||
- Debug code by evaluating expressions
|
||||
- Require or load namespaces for testing
|
||||
- Validate that code changes work before committing
|
||||
|
||||
## How It Works
|
||||
|
||||
The `clj-nrepl-eval` command evaluates Clojure code against an nREPL server. **Session state persists between evaluations**, so you can require a namespace in one evaluation and use it in subsequent calls. Each host:port combination maintains its own session file.
|
||||
|
||||
## Instructions
|
||||
|
||||
### 0. Discover and select nREPL server
|
||||
|
||||
First, discover what nREPL servers are running in the current directory:
|
||||
|
||||
```bash
|
||||
clj-nrepl-eval --discover-ports
|
||||
```
|
||||
|
||||
This will show all nREPL servers (Clojure, Babashka, shadow-cljs, etc.) running in the current project directory.
|
||||
|
||||
**Then use the AskUserQuestion tool:**
|
||||
|
||||
- **If ports are discovered:** Prompt user to select which nREPL port to use:
|
||||
- **question:** "Which nREPL port would you like to use?"
|
||||
- **header:** "nREPL Port"
|
||||
- **options:** Present each discovered port as an option with:
|
||||
- **label:** The port number
|
||||
- **description:** The server type and status (e.g., "Clojure nREPL server in current directory")
|
||||
- Include up to 4 discovered ports as options
|
||||
- The user can select "Other" to enter a custom port number
|
||||
|
||||
- **If no ports are discovered:** Prompt user how to start an nREPL server:
|
||||
- **question:** "No nREPL servers found. How would you like to start one?"
|
||||
- **header:** "Start nREPL"
|
||||
- **options:**
|
||||
- **label:** "deps.edn alias", **description:** "Find and use an nREPL alias in deps.edn"
|
||||
- **label:** "Leiningen", **description:** "Start nREPL using 'lein repl'"
|
||||
- The user can select "Other" for alternative methods or if they already have a server running on a specific port
|
||||
|
||||
IMPORTANT: IF you start a REPL do not supply a port let the nREPL start and return the port that it was started on.
|
||||
|
||||
### 1. Evaluate Clojure Code
|
||||
|
||||
> Evaluation automatically connects to the given port
|
||||
|
||||
Use the `-p` flag to specify the port and pass your Clojure code.
|
||||
|
||||
**Recommended: Pass code as a command-line argument:**
|
||||
```bash
|
||||
clj-nrepl-eval -p <PORT> "(+ 1 2 3)"
|
||||
```
|
||||
|
||||
**For multiple expressions (single line):**
|
||||
```bash
|
||||
clj-nrepl-eval -p <PORT> "(def x 10) (+ x 20)"
|
||||
```
|
||||
|
||||
**Alternative: Using heredoc (may require permission approval for multiline commands):**
|
||||
```bash
|
||||
clj-nrepl-eval -p <PORT> <<'EOF'
|
||||
(def x 10)
|
||||
(+ x 20)
|
||||
EOF
|
||||
```
|
||||
|
||||
**Alternative: Via stdin pipe:**
|
||||
```bash
|
||||
echo "(+ 1 2 3)" | clj-nrepl-eval -p <PORT>
|
||||
```
|
||||
|
||||
### 2. Display nREPL Sessions
|
||||
|
||||
**Discover all nREPL servers in current directory:**
|
||||
```bash
|
||||
clj-nrepl-eval --discover-ports
|
||||
```
|
||||
Shows all running nREPL servers in the current project directory, including their type (clj/bb/basilisp) and whether they match the current working directory.
|
||||
|
||||
**Check previously connected sessions:**
|
||||
```bash
|
||||
clj-nrepl-eval --connected-ports
|
||||
```
|
||||
Shows only connections you have made before (appears after first evaluation on a port).
|
||||
|
||||
### 3. Common Patterns
|
||||
|
||||
**Require a namespace (always use :reload to pick up changes):**
|
||||
```bash
|
||||
clj-nrepl-eval -p <PORT> "(require '[my.namespace :as ns] :reload)"
|
||||
```
|
||||
|
||||
**Test a function after requiring:**
|
||||
```bash
|
||||
clj-nrepl-eval -p <PORT> "(ns/my-function arg1 arg2)"
|
||||
```
|
||||
|
||||
**Check if a file compiles:**
|
||||
```bash
|
||||
clj-nrepl-eval -p <PORT> "(require 'my.namespace :reload)"
|
||||
```
|
||||
|
||||
**Multiple expressions:**
|
||||
```bash
|
||||
clj-nrepl-eval -p <PORT> "(def x 10) (* x 2) (+ x 5)"
|
||||
```
|
||||
|
||||
**Complex multiline code (using heredoc):**
|
||||
```bash
|
||||
clj-nrepl-eval -p <PORT> <<'EOF'
|
||||
(def x 10)
|
||||
(* x 2)
|
||||
(+ x 5)
|
||||
EOF
|
||||
```
|
||||
*Note: Heredoc syntax may require permission approval.*
|
||||
|
||||
**With custom timeout (in milliseconds):**
|
||||
```bash
|
||||
clj-nrepl-eval -p <PORT> --timeout 5000 "(long-running-fn)"
|
||||
```
|
||||
|
||||
**Reset the session (clears all state):**
|
||||
```bash
|
||||
clj-nrepl-eval -p <PORT> --reset-session
|
||||
clj-nrepl-eval -p <PORT> --reset-session "(def x 1)"
|
||||
```
|
||||
|
||||
## Available Options
|
||||
|
||||
- `-p, --port PORT` - nREPL port (required)
|
||||
- `-H, --host HOST` - nREPL host (default: 127.0.0.1)
|
||||
- `-t, --timeout MILLISECONDS` - Timeout (default: 120000 = 2 minutes)
|
||||
- `-r, --reset-session` - Reset the persistent nREPL session
|
||||
- `-c, --connected-ports` - List previously connected nREPL sessions
|
||||
- `-d, --discover-ports` - Discover nREPL servers in current directory
|
||||
- `-h, --help` - Show help message
|
||||
|
||||
## Important Notes
|
||||
|
||||
- **Prefer command-line arguments:** Pass code as quoted strings: `clj-nrepl-eval -p <PORT> "(+ 1 2 3)"` - works with existing permissions
|
||||
- **Heredoc for complex code:** Use heredoc (`<<'EOF' ... EOF`) for truly multiline code, but note it may require permission approval
|
||||
- **Sessions persist:** State (vars, namespaces, loaded libraries) persists across invocations until the nREPL server restarts or `--reset-session` is used
|
||||
- **Automatic delimiter repair:** The tool automatically repairs missing or mismatched parentheses
|
||||
- **Always use :reload:** When requiring namespaces, use `:reload` to pick up recent changes
|
||||
- **Default timeout:** 2 minutes (120000ms) - increase for long-running operations
|
||||
- **Input precedence:** Command-line arguments take precedence over stdin
|
||||
|
||||
## Typical Workflow
|
||||
|
||||
1. Discover nREPL servers: `clj-nrepl-eval --discover-ports`
|
||||
2. Use **AskUserQuestion** tool to prompt user to select a port
|
||||
3. Require namespace:
|
||||
```bash
|
||||
clj-nrepl-eval -p <PORT> "(require '[my.ns :as ns] :reload)"
|
||||
```
|
||||
4. Test function:
|
||||
```bash
|
||||
clj-nrepl-eval -p <PORT> "(ns/my-fn ...)"
|
||||
```
|
||||
5. Iterate: Make changes, re-require with `:reload`, test again
|
||||
|
||||
82
.opencode/skills/clojure-eval/examples.md
Normal file
82
.opencode/skills/clojure-eval/examples.md
Normal file
@@ -0,0 +1,82 @@
|
||||
# clj-nrepl-eval Examples
|
||||
|
||||
## Discovery
|
||||
|
||||
```bash
|
||||
clj-nrepl-eval --connected-ports
|
||||
```
|
||||
|
||||
## Heredoc for Multiline Code
|
||||
|
||||
```bash
|
||||
clj-nrepl-eval -p 7888 <<'EOF'
|
||||
(defn greet [name]
|
||||
(str "Hello, " name "!"))
|
||||
|
||||
(greet "Claude")
|
||||
EOF
|
||||
```
|
||||
|
||||
### Heredoc Simplifies String Escaping
|
||||
|
||||
Heredoc avoids shell escaping issues with quotes, backslashes, and special characters:
|
||||
|
||||
```bash
|
||||
# With heredoc - no escaping needed
|
||||
clj-nrepl-eval -p 7888 <<'EOF'
|
||||
(def regex #"\\d{3}-\\d{4}")
|
||||
(def message "She said \"Hello!\" and waved")
|
||||
(def path "C:\\Users\\name\\file.txt")
|
||||
(println message)
|
||||
EOF
|
||||
|
||||
# Without heredoc - requires complex escaping
|
||||
clj-nrepl-eval -p 7888 "(def message \"She said \\\"Hello!\\\" and waved\")"
|
||||
```
|
||||
|
||||
## Working with Project Namespaces
|
||||
|
||||
```bash
|
||||
# Test a function after requiring
|
||||
clj-nrepl-eval -p 7888 <<'EOF'
|
||||
(require '[clojure-mcp-light.delimiter-repair :as dr] :reload)
|
||||
(dr/delimiter-error? "(defn foo [x]")
|
||||
EOF
|
||||
```
|
||||
|
||||
## Verify Compilation After Edit
|
||||
|
||||
```bash
|
||||
# If this returns nil, the file compiled successfully
|
||||
clj-nrepl-eval -p 7888 "(require 'clojure-mcp-light.hook :reload)"
|
||||
```
|
||||
|
||||
## Session Management
|
||||
|
||||
```bash
|
||||
# Reset session if state becomes corrupted
|
||||
clj-nrepl-eval -p 7888 --reset-session
|
||||
```
|
||||
|
||||
## Common Workflow Patterns
|
||||
|
||||
### Load, Test, Iterate
|
||||
|
||||
```bash
|
||||
# After editing a file, reload and test in one command
|
||||
clj-nrepl-eval -p 7888 <<'EOF'
|
||||
(require '[my.namespace :as ns] :reload)
|
||||
(ns/my-function test-data)
|
||||
EOF
|
||||
```
|
||||
|
||||
### Run Tests After Changes
|
||||
|
||||
```bash
|
||||
clj-nrepl-eval -p 7888 <<'EOF'
|
||||
(require '[my.project.core :as core] :reload)
|
||||
(require '[my.project.core-test :as test] :reload)
|
||||
(clojure.test/run-tests 'my.project.core-test)
|
||||
EOF
|
||||
```
|
||||
|
||||
201
.opencode/skills/invoice-template-creator/SKILL.md
Normal file
201
.opencode/skills/invoice-template-creator/SKILL.md
Normal file
@@ -0,0 +1,201 @@
|
||||
---
|
||||
name: invoice-template-creator
|
||||
description: This skill creates PDF invoice parsing templates for the Integreat system. It should be used when adding support for a new vendor invoice format that needs to be automatically parsed.
|
||||
license: Complete terms in LICENSE.txt
|
||||
---
|
||||
|
||||
# Invoice Template Creator
|
||||
|
||||
This skill automates the creation of invoice parsing templates for the Integreat system. It generates both the template definition and a corresponding test file based on a sample PDF invoice.
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
Use this skill when you need to add support for a new vendor invoice format that cannot be parsed by existing templates. This typically happens when:
|
||||
|
||||
- A new vendor sends invoices in a unique format
|
||||
- An existing vendor changes their invoice layout
|
||||
- You encounter an invoice that fails to parse with current templates
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before using this skill, ensure you have:
|
||||
|
||||
1. A sample PDF invoice file placed in `dev-resources/` directory
|
||||
2. Identified the vendor name
|
||||
3. Identified unique text patterns in the invoice (phone numbers, addresses, etc.) that can distinguish this vendor
|
||||
4. Know the expected values for key fields (invoice number, date, customer name, total)
|
||||
|
||||
## Usage Workflow
|
||||
|
||||
### Step 1: Analyze the PDF
|
||||
|
||||
First, extract and analyze the PDF text to understand its structure:
|
||||
|
||||
```bash
|
||||
pdftotext -layout "dev-resources/FILENAME.pdf" -
|
||||
```
|
||||
|
||||
Look for:
|
||||
- **Vendor identifiers**: Phone numbers, addresses, or unique text that identifies this vendor
|
||||
- **Field patterns**: How invoice number, date, customer name, and total appear in the text
|
||||
- **Layout quirks**: Multi-line fields, special formatting, or unusual spacing
|
||||
|
||||
### Step 2: Define Expected Values
|
||||
|
||||
Document the expected values for each field:
|
||||
|
||||
| Field | Expected Value | Notes |
|
||||
|-------|---------------|-------|
|
||||
| Vendor Name | "Vendor Name" | Company name as it should appear |
|
||||
| Invoice Number | "12345" | The invoice identifier |
|
||||
| Date | "01/15/26" | Format found in PDF |
|
||||
| Customer Name | "Customer Name" | As it appears on invoice |
|
||||
| Customer Address | "123 Main St" | Street address if available |
|
||||
| Total | "100.00" | Amount |
|
||||
|
||||
### Step 3: Create the Template and Test
|
||||
|
||||
The skill will:
|
||||
|
||||
1. **Create a test file** at `test/clj/auto_ap/parse/templates_test.clj` (or add to existing)
|
||||
- Test parses the PDF file
|
||||
- Verifies all expected values are extracted correctly
|
||||
- Follows existing test patterns
|
||||
|
||||
2. **Add template to** `src/clj/auto_ap/parse/templates.clj`
|
||||
- Adds entry to `pdf-templates` vector
|
||||
- Includes:
|
||||
- `:vendor` - Vendor name
|
||||
- `:keywords` - Regex patterns to identify this vendor (must match all)
|
||||
- `:extract` - Regex patterns for each field
|
||||
- `:parser` - Optional date/number parsers
|
||||
|
||||
### Step 4: Iterative Refinement
|
||||
|
||||
Run the test to see if it passes:
|
||||
|
||||
```bash
|
||||
lein test auto-ap.parse.templates-test
|
||||
```
|
||||
|
||||
If it fails, examine the debug output and refine the regex patterns. Common issues:
|
||||
|
||||
- **Template doesn't match**: Keywords don't actually appear in the PDF text
|
||||
- **Field is nil**: Regex capture group doesn't match the actual text format
|
||||
- **Wrong value captured**: Regex is too greedy or matches wrong text
|
||||
|
||||
## Template Structure Reference
|
||||
|
||||
### Basic Template Format
|
||||
|
||||
```clojure
|
||||
{:vendor "Vendor Name"
|
||||
:keywords [#"unique-pattern-1" #"unique-pattern-2"]
|
||||
:extract {:invoice-number #"Invoice\s+#\s+(\d+)"
|
||||
:date #"Date:\s+(\d{2}/\d{2}/\d{2})"
|
||||
:customer-identifier #"Bill To:\s+([A-Za-z\s]+)"
|
||||
:total #"Total:\s+\$([\d,]+\.\d{2})"}
|
||||
:parser {:date [:clj-time "MM/dd/yy"]
|
||||
:total [:trim-commas nil]}}
|
||||
```
|
||||
|
||||
### Field Extraction Patterns
|
||||
|
||||
**Invoice Number:**
|
||||
- Look for: `"Invoice #12345"` or `"INV: 12345"`
|
||||
- Pattern: `#"Invoice\s*#?\s*(\d+)"` or `#"INV:\s*(\d+)"`
|
||||
|
||||
**Date:**
|
||||
- Common formats: `"01/15/26"`, `"Jan 15, 2026"`, `"2026-01-15"`
|
||||
- Pattern: `#"(\d{2}/\d{2}/\d{2})"` for MM/dd/yy
|
||||
- Parser: `:date [:clj-time "MM/dd/yy"]`
|
||||
|
||||
**Customer Identifier:**
|
||||
- Look for: `"Bill To: Customer Name"` or `"Sold To: Customer Name"`
|
||||
- Pattern: `#"Bill To:\s+([A-Za-z\s]+?)(?=\s{2,}|\n)"`
|
||||
- Use non-greedy `+?` and lookahead `(?=...)` to stop at boundaries
|
||||
|
||||
**Total:**
|
||||
- Look for: `"Total: $100.00"` or `"Amount Due: 100.00"`
|
||||
- Pattern: `#"Total:\s+\$?([\d,]+\.\d{2})"`
|
||||
- Parser: `:total [:trim-commas nil]` removes commas
|
||||
|
||||
### Advanced Patterns
|
||||
|
||||
**Multi-line customer address:**
|
||||
When customer info spans multiple lines (name + address):
|
||||
|
||||
```clojure
|
||||
:customer-identifier #"(?s)I\s+([A-Z][A-Z\s]+?)\s{2,}.*?L\s+([0-9][A-Z0-9\s]+?)(?=\s{2,}|\n)"
|
||||
:account-number #"(?s)L\s+([0-9][A-Z0-9\s]+?)(?=\s{2,}|\n)"
|
||||
```
|
||||
|
||||
The `(?s)` flag makes `.` match newlines. Use non-greedy `+?` and lookaheads `(?=...)` to capture clean values.
|
||||
|
||||
**Multiple date formats:**
|
||||
|
||||
```clojure
|
||||
:parser {:date [:clj-time ["MM/dd/yy" "yyyy-MM-dd"]]}
|
||||
```
|
||||
|
||||
**Credit memos (negative amounts):**
|
||||
|
||||
```clojure
|
||||
:parser {:total [:trim-commas-and-negate nil]}
|
||||
```
|
||||
|
||||
## Testing Best Practices
|
||||
|
||||
1. IMPORTANT, CRITICAL!! **Start with a failing test** - Define expected values before implementing
|
||||
2. **Test actual PDF parsing** - Use `parse-file` or `parse` with real PDF text
|
||||
3. **Verify each field individually** - Separate assertions for clarity
|
||||
4. **Handle date comparisons carefully** - Compare year/month/day separately if needed
|
||||
5. **Use `str/trim`** - Account for extra whitespace in extracted values
|
||||
|
||||
## Example Test Structure
|
||||
|
||||
```clojure
|
||||
(deftest parse-vendor-invoice-12345
|
||||
(testing "Should parse Vendor invoice with expected values"
|
||||
(let [results (sut/parse-file (io/file "dev-resources/INVOICE.pdf")
|
||||
"INVOICE.pdf")
|
||||
result (first results)]
|
||||
(is (some? results) "Should return results")
|
||||
(is (some? result) "Template should match")
|
||||
(when result
|
||||
(is (= "Vendor Name" (:vendor-code result)))
|
||||
(is (= "12345" (:invoice-number result)))
|
||||
(is (= "Customer Name" (:customer-identifier result)))
|
||||
(is (= "100.00" (:total result)))))))
|
||||
```
|
||||
|
||||
## Common Pitfalls
|
||||
|
||||
1. **Keywords must all match** - Every pattern in `:keywords` must be found in the PDF
|
||||
2. **Capture groups required** - Regexes need `()` to extract values
|
||||
3. **PDF text != visual text** - Layout may differ from what you see visually
|
||||
4. **Greedy quantifiers** - Use `+?` instead of `+` to avoid over-matching
|
||||
5. **Case sensitivity** - Regex is case-sensitive unless you use `(?i)` flag
|
||||
|
||||
## Post-Creation Checklist
|
||||
|
||||
After creating the template:
|
||||
|
||||
- [ ] Test passes: `lein test auto-ap.parse.templates-test`
|
||||
- [ ] Format is correct: `lein cljfmt check`
|
||||
- [ ] Code compiles: `lein check`
|
||||
- [ ] Template is in correct position in `pdf-templates` vector
|
||||
- [ ] Keywords uniquely identify this vendor (won't match other templates)
|
||||
- [ ] Test file follows naming conventions
|
||||
|
||||
## Integration with Workflow
|
||||
|
||||
This skill is typically used as part of a larger workflow:
|
||||
|
||||
1. User provides PDF and requirements
|
||||
2. This skill creates template and test
|
||||
3. User reviews and refines if needed
|
||||
4. Test is run to verify extraction
|
||||
5. Code is committed
|
||||
|
||||
The skill ensures consistency with existing patterns and reduces manual boilerplate when adding new vendor support.
|
||||
188
.opencode/skills/invoice-template-creator/references/examples.md
Normal file
188
.opencode/skills/invoice-template-creator/references/examples.md
Normal file
@@ -0,0 +1,188 @@
|
||||
# Invoice Template Examples
|
||||
|
||||
## Simple Single Invoice
|
||||
|
||||
```clojure
|
||||
{:vendor "Gstar Seafood"
|
||||
:keywords [#"G Star Seafood"]
|
||||
:extract {:total #"Total\s{2,}([\d\-,]+\.\d{2,2}+)"
|
||||
:customer-identifier #"(.*?)(?:\s+)Invoice #"
|
||||
:date #"Invoice Date\s{2,}([0-9]+/[0-9]+/[0-9]+)"
|
||||
:invoice-number #"Invoice #\s+(\d+)"}
|
||||
:parser {:date [:clj-time "MM/dd/yyyy"]
|
||||
:total [:trim-commas nil]}}
|
||||
```
|
||||
|
||||
## Multi-Invoice Statement
|
||||
|
||||
```clojure
|
||||
{:vendor "Southbay Fresh Produce"
|
||||
:keywords [#"(SOUTH BAY FRESH PRODUCE|SOUTH BAY PRODUCE)"]
|
||||
:extract {:date #"^([0-9]+/[0-9]+/[0-9]+)"
|
||||
:customer-identifier #"To:[^\n]*\n\s+([A-Za-z' ]+)\s{2}"
|
||||
:invoice-number #"INV #\/(\d+)"
|
||||
:total #"\$([0-9.]+)\."}
|
||||
:parser {:date [:clj-time "MM/dd/yyyy"]}
|
||||
:multi #"\n"
|
||||
:multi-match? #"^[0-9]+/[0-9]+/[0-9]+\s+INV "}
|
||||
```
|
||||
|
||||
## Customer with Address (Multi-line)
|
||||
|
||||
```clojure
|
||||
{:vendor "Bonanza Produce"
|
||||
:keywords [#"530-544-4136"]
|
||||
:extract {:invoice-number #"NO\s+(\d{8,})\s+\d{2}/\d{2}/\d{2}"
|
||||
:date #"NO\s+\d{8,}\s+(\d{2}/\d{2}/\d{2})"
|
||||
:customer-identifier #"(?s)I\s+([A-Z][A-Z\s]+?)\s{2,}.*?L\s+([0-9][A-Z0-9\s]+?)(?=\s{2,}|\n)"
|
||||
:account-number #"(?s)L\s+([0-9][A-Z0-9\s]+?)(?=\s{2,}|\n)"
|
||||
:total #"SHIPPED\s+[\d\.]+\s+TOTAL\s+([\d\.]+)"}
|
||||
:parser {:date [:clj-time "MM/dd/yy"]
|
||||
:total [:trim-commas nil]}}
|
||||
```
|
||||
|
||||
## Credit Memo (Negative Amounts)
|
||||
|
||||
```clojure
|
||||
{:vendor "General Produce Company"
|
||||
:keywords [#"916-552-6495"]
|
||||
:extract {:date #"DATE.*\n.*\n.*?([0-9]+/[0-9]+/[0-9]+)"
|
||||
:invoice-number #"CREDIT NO.*\n.*\n.*?(\d{5,}?)\s+"
|
||||
:account-number #"CUST NO.*\n.*\n\s+(\d+)"
|
||||
:total #"TOTAL:\s+\|\s*(.*)"}
|
||||
:parser {:date [:clj-time "MM/dd/yy"]
|
||||
:total [:trim-commas-and-negate nil]}}
|
||||
```
|
||||
|
||||
## Complex Date Parsing
|
||||
|
||||
```clojure
|
||||
{:vendor "Ben E. Keith"
|
||||
:keywords [#"BEN E. KEITH"]
|
||||
:extract {:date #"Customer No Mo Day Yr.*?\n.*?\d{5,}\s{2,}(\d+\s+\d+\s+\d+)"
|
||||
:customer-identifier #"Customer No Mo Day Yr.*?\n.*?(\d{5,})"
|
||||
:invoice-number #"Invoice No.*?\n.*?(\d{8,})"
|
||||
:total #"Total Invoice.*?\n.*?([\-]?[0-9]+\.[0-9]{2,})"}
|
||||
:parser {:date [:month-day-year nil]
|
||||
:total [:trim-commas-and-negate nil]}}
|
||||
```
|
||||
|
||||
## Multiple Date Formats
|
||||
|
||||
```clojure
|
||||
{:vendor "RNDC"
|
||||
:keywords [#"P.O.Box 743564"]
|
||||
:extract {:date #"(?:INVOICE|CREDIT) DATE\n(?:.*?)(\S+)\n"
|
||||
:account-number #"Store Number:\s+(\d+)"
|
||||
:invoice-number #"(?:INVOICE|CREDIT) DATE\n(?:.*?)\s{2,}(\d+?)\s+\S+\n"
|
||||
:total #"Net Amount(?:.*\n){4}(?:.*?)([\-]?[0-9\.]+)\n"}
|
||||
:parser {:date [:clj-time ["MM/dd/yy" "dd-MMM-yy"]]
|
||||
:total [:trim-commas-and-negate nil]}}
|
||||
```
|
||||
|
||||
## Common Regex Patterns
|
||||
|
||||
### Phone Numbers
|
||||
```clojure
|
||||
#"\(?[0-9]{3}\)?[-.\s]?[0-9]{3}[-.\s]?[0-9]{4}"
|
||||
```
|
||||
|
||||
### Dollar Amounts
|
||||
```clojure
|
||||
#"\$?([0-9,]+\.[0-9]{2})"
|
||||
```
|
||||
|
||||
### Dates (MM/dd/yy)
|
||||
```clojure
|
||||
#"([0-9]{2}/[0-9]{2}/[0-9]{2})"
|
||||
```
|
||||
|
||||
### Dates (MM/dd/yyyy)
|
||||
```clojure
|
||||
#"([0-9]{2}/[0-9]{2}/[0-9]{4})"
|
||||
```
|
||||
|
||||
### Multi-line Text (dotall mode)
|
||||
```clojure
|
||||
#"(?s)start.*?end"
|
||||
```
|
||||
|
||||
### Non-greedy Match
|
||||
```clojure
|
||||
#"(pattern.+?)"
|
||||
```
|
||||
|
||||
### Lookahead Boundary
|
||||
```clojure
|
||||
#"value(?=\s{2,}|\n)"
|
||||
```
|
||||
|
||||
## Field Extraction Strategies
|
||||
|
||||
### 1. Simple Line-based
|
||||
Use `[^\n]*` to match until end of line:
|
||||
```clojure
|
||||
#"Invoice:\s+([^\n]+)"
|
||||
```
|
||||
|
||||
### 2. Whitespace Boundary
|
||||
Use `(?=\s{2,}|\n)` to stop at multiple spaces or newline:
|
||||
```clojure
|
||||
#"Customer:\s+(.+?)(?=\s{2,}|\n)"
|
||||
```
|
||||
|
||||
### 3. Specific Marker
|
||||
Match until a specific pattern is found:
|
||||
```clojure
|
||||
#"(?s)Start(.*?)End"
|
||||
```
|
||||
|
||||
### 4. Multi-part Extraction
|
||||
Use multiple capture groups for related fields:
|
||||
```clojure
|
||||
#"Date:\s+(\d{2})/(\d{2})/(\d{2})"
|
||||
```
|
||||
|
||||
## Parser Options
|
||||
|
||||
### Date Parsers
|
||||
- `[:clj-time "MM/dd/yyyy"]` - Standard US date
|
||||
- `[:clj-time "MM/dd/yy"]` - 2-digit year
|
||||
- `[:clj-time "MMM dd, yyyy"]` - Named month
|
||||
- `[:clj-time ["MM/dd/yy" "yyyy-MM-dd"]]` - Multiple formats
|
||||
- `[:month-day-year nil]` - Space-separated (1 15 26)
|
||||
|
||||
### Number Parsers
|
||||
- `[:trim-commas nil]` - Remove commas from numbers
|
||||
- `[:trim-commas-and-negate nil]` - Handle negative/credit amounts
|
||||
- `[:trim-commas-and-remove-dollars nil]` - Remove $ and commas
|
||||
- `nil` - No parsing, return raw string
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
### Basic Test Structure
|
||||
```clojure
|
||||
(deftest parse-vendor-invoice
|
||||
(testing "Should parse vendor invoice"
|
||||
(let [results (sut/parse-file (io/file "dev-resources/INVOICE.pdf")
|
||||
"INVOICE.pdf")
|
||||
result (first results)]
|
||||
(is (some? result))
|
||||
(is (= "Vendor" (:vendor-code result)))
|
||||
(is (= "12345" (:invoice-number result))))))
|
||||
```
|
||||
|
||||
### Date Testing
|
||||
```clojure
|
||||
(let [d (:date result)]
|
||||
(is (= 2026 (time/year d)))
|
||||
(is (= 1 (time/month d)))
|
||||
(is (= 15 (time/day d))))
|
||||
```
|
||||
|
||||
### Multi-field Verification
|
||||
```clojure
|
||||
(is (= "Expected Name" (:customer-identifier result)))
|
||||
(is (= "Expected Street" (str/trim (:account-number result))))
|
||||
(is (= "Expected City, ST 12345" (str/trim (:location result))))
|
||||
```
|
||||
248
.opencode/skills/testing-conventions/SKILL.md
Normal file
248
.opencode/skills/testing-conventions/SKILL.md
Normal file
@@ -0,0 +1,248 @@
|
||||
---
|
||||
name: testing-conventions
|
||||
description: Describe the way that tests should be authored, conventions, tools, helpers, superceding any conventions found in existing tests.
|
||||
---
|
||||
|
||||
# Testing Conventions Skill
|
||||
|
||||
This skill documents the testing conventions for `test/clj/auto_ap/`.
|
||||
|
||||
## Test Focus: User-Observable Behavior
|
||||
|
||||
**Primary rule**: Test user-observable behavior. If an endpoint or function makes a database change, verify the change by querying the database directly rather than asserting on markup.
|
||||
|
||||
**other rules**:
|
||||
1. Don't test the means of doing work. For example, if there is a middleware that makes something available on a request, don't bother testing that wrapper.
|
||||
2. prefer :refer testing imports, rather than :as reference
|
||||
3. Prefer structured edits from clojure-mcp
|
||||
|
||||
### When to Assert on Database State
|
||||
|
||||
When testing an endpoint that modifies data:
|
||||
1. Verify the database change by querying the entity directly
|
||||
2. Use `dc/pull` or `dc/q` to verify the data was stored correctly
|
||||
|
||||
```clojure
|
||||
;; CORRECT: Verify the database change directly
|
||||
(deftest test-create-transaction
|
||||
(let [result @(post-create-transaction {:amount 100.0})]
|
||||
(let [entity (dc/pull (dc/db conn) [:db/id :transaction/amount] (:transaction/id result))]
|
||||
(is (= 100.0 (:transaction/amount entity))))))
|
||||
|
||||
;; CORRECT: Verify response status and headers
|
||||
(is (= 201 (:status response)))
|
||||
(is (= "application/json" (get-in response [:headers "content-type"])))
|
||||
|
||||
;; CORRECT: Check for expected text content
|
||||
(is (re-find #"Transaction created" (get-in response [:body "message"])))
|
||||
```
|
||||
|
||||
### When Markup Testing is Acceptable
|
||||
|
||||
Markup testing (HTML/SSR response bodies) is acceptable when:
|
||||
- Validating response status codes and headers
|
||||
- Checking for presence/absence of specific text strings
|
||||
- Verifying small, expected elements within the markup
|
||||
- Testing SSR component rendering
|
||||
|
||||
```clojure
|
||||
;; ACCEPTABLE: Response codes and headers
|
||||
(is (= 200 (:status response)))
|
||||
(is (= "application/json" (get-in response [:headers "content-type"])))
|
||||
|
||||
;; ACCEPTABLE: Text content within markup
|
||||
(is (re-find #"Transaction found" response-body))
|
||||
|
||||
;; ACCEPTABLE: Small element checks
|
||||
(is (re-find #">Amount: \$100\.00<" response-body))
|
||||
```
|
||||
|
||||
### When to Avoid Markup Testing
|
||||
|
||||
Do not use markup assertions for:
|
||||
- Verifying complex data structures (use database queries instead)
|
||||
- Complex nested content that's easier to query
|
||||
- Business logic verification (test behavior, not presentation)
|
||||
|
||||
## Database Setup
|
||||
|
||||
All tests in `test/clj/auto_ap/` use a shared database fixture (`wrap-setup`) that:
|
||||
1. Creates a temporary in-memory Datomic database (`datomic:mem://test`)
|
||||
2. Loads the full schema from `io/resources/schema.edn`
|
||||
3. Installs custom Datomic functions from `io/resources/functions.edn`
|
||||
4. Cleans up the database after each test
|
||||
|
||||
## Using the Fixture
|
||||
|
||||
```clojure
|
||||
(ns my-test
|
||||
(:require
|
||||
[auto-ap.integration.util :refer [wrap-setup]]
|
||||
[clojure.test :as t]))
|
||||
|
||||
(use-fixtures :each wrap-setup)
|
||||
|
||||
(deftest my-test
|
||||
;; tests here can access the test database
|
||||
)
|
||||
```
|
||||
|
||||
## Helper Functions
|
||||
|
||||
`test/clj/auto_ap/integration/util.clj` provides helper functions for creating test data:
|
||||
|
||||
### Identity Helpers
|
||||
|
||||
```clojure
|
||||
;; Add a unique string to avoid collisions
|
||||
(str "CLIENT" (rand-int 100000))
|
||||
(str "INVOICE " (rand-int 1000000))
|
||||
```
|
||||
|
||||
### Test Entity Builders
|
||||
|
||||
```clojure
|
||||
;; Client
|
||||
(test-client
|
||||
[:db/id "client-id"
|
||||
:client/code "CLIENT123"
|
||||
:client/locations ["DT" "MH"]
|
||||
:client/bank-accounts [:bank-account-id]])
|
||||
|
||||
;; Vendor
|
||||
(test-vendor
|
||||
[:db/id "vendor-id"
|
||||
:vendor/name "Vendorson"
|
||||
:vendor/default-account "test-account-id"])
|
||||
|
||||
;; Bank Account
|
||||
(test-bank-account
|
||||
[:db/id "bank-account-id"
|
||||
:bank-account/code "TEST-BANK-123"
|
||||
:bank-account/type :bank-account-type/check])
|
||||
|
||||
;; Transaction
|
||||
(test-transaction
|
||||
[:db/id "transaction-id"
|
||||
:transaction/date #inst "2022-01-01"
|
||||
:transaction/client "test-client-id"
|
||||
:transaction/bank-account "test-bank-account-id"
|
||||
:transaction/id (str (java.util.UUID/randomUUID))
|
||||
:transaction/amount 100.0
|
||||
:transaction/description-original "original description"])
|
||||
|
||||
;; Payment
|
||||
(test-payment
|
||||
[:db/id "test-payment-id"
|
||||
:payment/date #inst "2022-01-01"
|
||||
:payment/client "test-client-id"
|
||||
:payment/bank-account "test-bank-account-id"
|
||||
:payment/type :payment-type/check
|
||||
:payment/vendor "test-vendor-id"
|
||||
:payment/amount 100.0])
|
||||
|
||||
;; Invoice
|
||||
(test-invoice
|
||||
[:db/id "test-invoice-id"
|
||||
:invoice/date #inst "2022-01-01"
|
||||
:invoice/client "test-client-id"
|
||||
:invoice/status :invoice-status/unpaid
|
||||
:invoice/import-status :import-status/imported
|
||||
:invoice/total 100.0
|
||||
:invoice/outstanding-balance 100.00
|
||||
:invoice/vendor "test-vendor-id"
|
||||
:invoice/invoice-number "INVOICE 123456"
|
||||
:invoice/expense-accounts
|
||||
[{:invoice-expense-account/account "test-account-id"
|
||||
:invoice-expense-account/amount 100.0
|
||||
:invoice-expense-account/location "DT"}]])
|
||||
|
||||
;; Account
|
||||
(test-account
|
||||
[:db/id "account-id"
|
||||
:account/name "Account"
|
||||
:account/type :account-type/asset])
|
||||
```
|
||||
|
||||
### Common Data Setup (`setup-test-data`)
|
||||
|
||||
Creates a minimal but complete dataset for testing:
|
||||
|
||||
```clojure
|
||||
(defn setup-test-data [data]
|
||||
(:tempids @(dc/transact conn (into data
|
||||
[(test-account :db/id "test-account-id")
|
||||
(test-client :db/id "test-client-id"
|
||||
:client/bank-accounts [(test-bank-account :db/id "test-bank-account-id")])
|
||||
(test-vendor :db/id "test-vendor-id")
|
||||
{:db/id "accounts-payable-id"
|
||||
:account/name "Accounts Payable"
|
||||
:db/ident :account/accounts-payable
|
||||
:account/numeric-code 21000
|
||||
:account/account-set "default"}]))))
|
||||
```
|
||||
|
||||
Use like:
|
||||
```clojure
|
||||
(let [{:strs [test-client-id test-bank-account-id test-vendor-id]} (setup-test-data [])]
|
||||
...)
|
||||
```
|
||||
|
||||
### Token Helpers
|
||||
|
||||
```clojure
|
||||
;; Admin token
|
||||
(admin-token)
|
||||
|
||||
;; User token (optionally scoped to specific client)
|
||||
(user-token) ; Default: client-id 1
|
||||
(user-token client-id) ; Scoped to specific client
|
||||
```
|
||||
|
||||
## Example Usage
|
||||
|
||||
```clojure
|
||||
(ns my-test
|
||||
(:require
|
||||
[clojure.test :as t]
|
||||
[auto-ap.datomic :refer [conn]]
|
||||
[auto-ap.integration.util :refer [wrap-setup admin-token setup-test-data test-transaction]]))
|
||||
|
||||
(use-fixtures :each wrap-setup)
|
||||
|
||||
(deftest test-transaction-import
|
||||
(testing "Should import a transaction"
|
||||
(let [{:strs [client-id bank-account-id]} (setup-test-data [])
|
||||
tx-result @(dc/transact conn
|
||||
[(test-transaction
|
||||
{:db/id "test-tx-id"
|
||||
:transaction/client client-id
|
||||
:transaction/bank-account bank-account-id
|
||||
:transaction/amount 50.0})])]
|
||||
(is (= 1 (count (:tx-data tx-result))))
|
||||
;; Verify by querying the database, not markup
|
||||
(let [entity (dc/pull (dc/db conn) [:transaction/amount] (:db/id tx-result))]
|
||||
(is (= 50.0 (:transaction/amount entity)))))))
|
||||
```
|
||||
|
||||
## Note on Temp IDs
|
||||
|
||||
Test data often uses string-based temp IDs like `"client-id"`, `"bank-account-id"`, etc. When transacting, the returned `:tempids` map maps these symbolic IDs to Datomic's internal entity IDs:
|
||||
|
||||
```clojure
|
||||
(let [{:strs [client-id bank-account-id]} (:tempids @(dc/transact conn txes))]
|
||||
...)
|
||||
```
|
||||
|
||||
## Memory Database
|
||||
|
||||
All tests use `datomic:mem://test` - an in-memory database. This ensures:
|
||||
- Tests are fast
|
||||
- Tests don't interfere with each other
|
||||
- No setup required to run tests locally
|
||||
|
||||
The database is automatically deleted after each test completes.
|
||||
|
||||
# running tests
|
||||
prefer to use clojure nrepl evaluation skill over leiningen, but worst case,
|
||||
use leiningen to run tests
|
||||
BIN
dev-resources/13595522.pdf
Normal file
BIN
dev-resources/13595522.pdf
Normal file
Binary file not shown.
BIN
dev-resources/INVOICE - 03881260.pdf
Executable file
BIN
dev-resources/INVOICE - 03881260.pdf
Executable file
Binary file not shown.
229
docs/plans/2026-02-07-feat-add-invoice-template-03881260-plan.md
Normal file
229
docs/plans/2026-02-07-feat-add-invoice-template-03881260-plan.md
Normal file
@@ -0,0 +1,229 @@
|
||||
---
|
||||
title: Add New Invoice Template for Produce Distributor (Invoice 03881260)
|
||||
type: feat
|
||||
date: 2026-02-07
|
||||
status: completed
|
||||
---
|
||||
|
||||
# Add New Invoice Template for Produce Distributor (Invoice 03881260)
|
||||
|
||||
**Status:** ✅ Completed
|
||||
|
||||
**Summary:** Successfully implemented a new PDF parsing template for Bonanza Produce invoices. All tests pass.
|
||||
|
||||
## Overview
|
||||
|
||||
Implement a new PDF parsing template for a produce/food distributor invoice type. The invoice originates from a distributor with multiple locations (South Lake Tahoe, Sparks NV, Elko NV) and serves customers like "NICK THE GREEK".
|
||||
|
||||
## Problem Statement / Motivation
|
||||
|
||||
Currently, invoices from this produce distributor cannot be automatically parsed, requiring manual data entry. The invoice has a unique layout with multiple warehouse locations and specific formatting that doesn't match existing templates.
|
||||
|
||||
## Proposed Solution
|
||||
|
||||
Add a new template entry to `src/clj/auto_ap/parse/templates.clj` for **Bonanza Produce** with regex patterns to extract:
|
||||
- Invoice number
|
||||
- Date (MM/dd/yy format)
|
||||
- Customer identifier (including address for disambiguation)
|
||||
- Total amount
|
||||
|
||||
## Technical Considerations
|
||||
|
||||
### Vendor Identification Strategy
|
||||
|
||||
**Vendor Name:** Bonanza Produce
|
||||
|
||||
Based on the PDF analysis, use these unique identifiers as keywords:
|
||||
- `"3717 OSGOOD AVE"` - Unique South Lake Tahoe address
|
||||
- `"SPARKS, NEVADA"` - Primary warehouse location
|
||||
- `"1925 FREEPORT BLVD"` - Sparks warehouse address
|
||||
|
||||
**Recommended keyword combination:** `[#"3717 OSGOOD AVE" #"SPARKS, NEVADA"]` - These two together uniquely identify this vendor.
|
||||
|
||||
### Extract Patterns Required
|
||||
|
||||
From the PDF text analysis:
|
||||
|
||||
| Field | Value in PDF | Proposed Regex |
|
||||
|-------|--------------|----------------|
|
||||
| `:invoice-number` | `03881260` | `#"INVOICE\s+(\d+)"` |
|
||||
| `:date` | `01/20/26` | `#"(\d{2}/\d{2}/\d{2})"` (after invoice #) |
|
||||
| `:customer-identifier` | `NICK THE GREEK` | `#"BILL TO.*\n\s+([A-Z][A-Z\s]+)"` |
|
||||
| `:total` | `23.22` | `#"TOTAL\s+([\d\.]+)"` or `#"TOTAL\s+([\d\.]+)\s*$"` (end of line) |
|
||||
|
||||
### Parser Configuration
|
||||
|
||||
```clojure
|
||||
:parser {:date [:clj-time "MM/dd/yy"]
|
||||
:total [:trim-commas nil]}
|
||||
```
|
||||
|
||||
**Date format note:** The invoice uses 2-digit year format (`01/20/26`), so use `"MM/dd/yy"` format string.
|
||||
|
||||
### Template Structure
|
||||
|
||||
```clojure
|
||||
{:vendor "Bonanza Produce"
|
||||
:keywords [#"3717 OSGOOD AVE" #"SPARKS, NEVADA"]
|
||||
:extract {:invoice-number #"INVOICE\s+(\d+)"
|
||||
:date #"INVOICE\s+\d+\s+(\d{2}/\d{2}/\d{2})"
|
||||
:customer-identifier #"BILL TO.*?\n\s+([A-Z][A-Z\s]+)(?:\s{2,}|\n)"
|
||||
:total #"TOTAL\s+([\d\.]+)(?:\s*$|\s+TOTAL)"}
|
||||
:parser {:date [:clj-time "MM/dd/yy"]
|
||||
:total [:trim-commas nil]}}
|
||||
```
|
||||
|
||||
## Open Questions
|
||||
|
||||
1. **Is this a single invoice or multi-invoice document?**
|
||||
- Current PDF shows single invoice
|
||||
- Check if statements from this vendor contain multiple invoices
|
||||
- If multi-invoice, need `:multi` and `:multi-match?` keys
|
||||
|
||||
2. **Are credit memos formatted differently?**
|
||||
- Current example shows standard invoice
|
||||
- Need to verify if credits have different layout
|
||||
- May need separate template for credit memos
|
||||
|
||||
3. **How to capture the full customer address in the regex?**
|
||||
- The customer name is on one line: "NICK THE GREEK"
|
||||
- The street address is on the next line: "600 VISTA WAY"
|
||||
- The city/state/zip is on the third line: "MILPITAS, CA 95035"
|
||||
- The regex needs to span multiple lines to capture all three components
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
- [ ] Template successfully matches invoices from this vendor
|
||||
- [ ] Correctly extracts invoice number (e.g., `03881260`)
|
||||
- [ ] Correctly extracts date and parses to proper format
|
||||
- [ ] Correctly extracts customer identifier (e.g., `NICK THE GREEK`)
|
||||
- [ ] Correctly extracts total amount (e.g., `23.22`)
|
||||
- [ ] Parser handles edge cases (commas in amounts, different date formats)
|
||||
- [ ] Tested with at least 3 different invoices from this vendor
|
||||
|
||||
## Implementation Steps
|
||||
|
||||
### Phase 1: Extract PDF Text
|
||||
|
||||
```bash
|
||||
# Convert PDF to text for analysis
|
||||
pdftotext -layout "dev-resources/INVOICE - 03881260.pdf" -
|
||||
```
|
||||
|
||||
### Phase 2: Determine Vendor Name
|
||||
|
||||
1. Examine the PDF header for company name/logo
|
||||
2. Search for known identifiers (phone numbers, addresses)
|
||||
3. Identify the vendor code for `:vendor` field
|
||||
|
||||
### Phase 3: Develop Regex Patterns
|
||||
|
||||
Test patterns in REPL:
|
||||
|
||||
```clojure
|
||||
(require '[clojure.string :as str])
|
||||
|
||||
(def text "...") ; paste PDF text here
|
||||
|
||||
;; Test invoice number pattern
|
||||
(re-find #"INVOICE\s+(\d+)" text)
|
||||
|
||||
;; Test date pattern
|
||||
(re-find #"INVOICE\s+\d+\s+(\d{2}/\d{2}/\d{2})" text)
|
||||
|
||||
;; Test customer pattern
|
||||
(re-find #"BILL TO.*?\n\s+([A-Z][A-Z\s]+)" text)
|
||||
|
||||
;; Test total pattern
|
||||
(re-find #"TOTAL\s+([\d\.]+)" text)
|
||||
```
|
||||
|
||||
### Phase 4: Add Template
|
||||
|
||||
Add to `src/clj/auto_ap/parse/templates.clj` in the `pdf-templates` vector:
|
||||
|
||||
```clojure
|
||||
;; Bonanza Produce
|
||||
{:vendor "Bonanza Produce"
|
||||
:keywords [#"3717 OSGOOD AVE" #"SPARKS, NEVADA"]
|
||||
:extract {:invoice-number #"INVOICE\s+(\d+)"
|
||||
:date #"INVOICE\s+\d+\s+(\d{2}/\d{2}/\d{2})"
|
||||
:customer-identifier #"BILL TO.*?\n\s+([A-Z][A-Z\s]+)(?:\s{2,}|\n)"
|
||||
:total #"TOTAL\s+([\d\.]+)(?:\s*$|\s+TOTAL)"}
|
||||
:parser {:date [:clj-time "MM/dd/yy"]
|
||||
:total [:trim-commas nil]}}
|
||||
```
|
||||
|
||||
### Phase 5: Test Implementation
|
||||
|
||||
```clojure
|
||||
;; Load the namespace
|
||||
(require '[auto-ap.parse :as p])
|
||||
(require '[auto-ap.parse.templates :as t])
|
||||
|
||||
;; Test parsing
|
||||
(p/parse "...pdf text here...")
|
||||
|
||||
;; Or test full file
|
||||
(p/parse-file "dev-resources/INVOICE - 03881260.pdf" "INVOICE - 03881260.pdf")
|
||||
```
|
||||
|
||||
## Testing Considerations
|
||||
|
||||
1. **Date edge cases:** Ensure 2-digit year parsing works correctly (26 → 2026)
|
||||
2. **Amount edge cases:** Test with larger amounts that may include commas
|
||||
3. **Customer name variations:** Test with different customer names/lengths
|
||||
4. **Multi-page invoices:** Verify template handles page breaks if applicable
|
||||
|
||||
## Known PDF Structure
|
||||
|
||||
```
|
||||
SOUTH LAKE TAHOE, CA
|
||||
3717 OSGOOD AVE.
|
||||
...
|
||||
SPARKS, NEVADA ELKO, NEVADA
|
||||
1925 FREEPORT BLVD... 428 RIVER ST...
|
||||
|
||||
CUST. PHONE 775-622-0159 ... INVOICE DATE
|
||||
... 03881260 01/20/26
|
||||
B NICKGR
|
||||
I NICK THE GREEK S NICK THE GREEK
|
||||
L NICK THE GREEK H NICK THE GREEK
|
||||
L 600 VISTA WAY I VIA MICHELE
|
||||
...
|
||||
TOTAL
|
||||
TOTAL 23.22
|
||||
```
|
||||
|
||||
## References & Research
|
||||
|
||||
### Similar Templates for Reference
|
||||
|
||||
Based on `src/clj/auto_ap/parse/templates.clj`, these templates have similar patterns:
|
||||
|
||||
1. **Gstar Seafood** (lines 19-26) - Simple single invoice, uses `:trim-commas`
|
||||
2. **Don Vito Ozuna Food Corp** (lines 121-127) - Uses customer-identifier with multiline pattern
|
||||
3. **C&L Produce** (lines 260-267) - Similar "Bill To" pattern for customer extraction
|
||||
|
||||
### File Locations
|
||||
|
||||
- Templates: `src/clj/auto_ap/parse/templates.clj`
|
||||
- Parser logic: `src/clj/auto_ap/parse.clj`
|
||||
- Utility functions: `src/clj/auto_ap/parse/util.clj`
|
||||
- Test PDF: `dev-resources/INVOICE - 03881260.pdf`
|
||||
|
||||
### Parser Utilities Available
|
||||
|
||||
From `src/clj/auto_ap/parse/util.clj`:
|
||||
- `:clj-time` - Date parsing with format strings
|
||||
- `:trim-commas` - Remove commas from numbers
|
||||
- `:trim-commas-and-negate` - Handle credit/negative amounts
|
||||
- `:month-day-year` - Special format for space-separated dates
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **Identify the vendor name** by examining the PDF more closely or asking the user
|
||||
2. **Test regex patterns** in the REPL with the actual PDF text
|
||||
3. **Refine patterns** based on edge cases discovered during testing
|
||||
4. **Add template** to templates.clj
|
||||
5. **Test with multiple invoices** from this vendor to ensure robustness
|
||||
@@ -0,0 +1,376 @@
|
||||
---
|
||||
title: Rebase Invoice Templates, Merge to Master, and Integrate Branches
|
||||
type: refactor
|
||||
date: 2026-02-08
|
||||
---
|
||||
|
||||
# Rebase Invoice Templates, Merge to Master, and Integrate Branches
|
||||
|
||||
## Overview
|
||||
|
||||
This plan outlines a series of git operations to reorganize the branch structure by:
|
||||
1. Creating a rebase commit with all invoice template changes
|
||||
2. Applying those changes onto `master`
|
||||
3. Removing them from the current `clauding` branch
|
||||
4. Merging `master` back into `clauding`
|
||||
5. Finally merging `clauding` into `get-transactions2-page-working`
|
||||
|
||||
## Current State
|
||||
|
||||
### Branch Structure (as of Feb 8, 2026)
|
||||
|
||||
```
|
||||
master (dc021b8c)
|
||||
├─ deploy/master (dc021b8c)
|
||||
└─ (other branches)
|
||||
└─ clauding (0155d91e) - HEAD
|
||||
├─ 16 commits ahead of master
|
||||
└─ Contains invoice template work for Bonanza Produce
|
||||
├─ db1cb194 Add Bonanza Produce invoice template
|
||||
├─ ec754233 Improve Bonanza Produce customer identifier extraction
|
||||
├─ af7bc324 Add location extraction for Bonanza Produce invoices
|
||||
├─ 62107c99 Extract customer name and address for Bonanza Produce
|
||||
├─ 7ecd569e Add invoice-template-creator skill for automated template generation
|
||||
└─ 0155d91e Add Bonanza Produce multi-invoice statement template
|
||||
```
|
||||
|
||||
### Merge Base
|
||||
|
||||
- **Merge base between `clauding` and `master`**: `dc021b8c`
|
||||
- **Commits on `clauding` since merge base**: 16 commits
|
||||
- **Invoice template commits**: 6 commits (db1cb194 through 0155d91e)
|
||||
|
||||
## Problem Statement
|
||||
|
||||
The current branch structure has:
|
||||
1. Invoice template work mixed with other feature development in `clauding`
|
||||
2. No clear separation between invoice template changes and transaction page work
|
||||
3. A desire to get invoice template changes merged to `master` independently
|
||||
4. A need to reorganize branches to prepare for merging `get-transactions2-page-working`
|
||||
|
||||
## Proposed Solution
|
||||
|
||||
Use git rebase and merge operations to create a cleaner branch hierarchy:
|
||||
|
||||
1. **Create a new branch** (`invoice-templates-rebased`) with only invoice template commits
|
||||
2. **Rebase those commits** onto current `master`
|
||||
3. **Merge** this clean branch to `master`
|
||||
4. **Remove invoice template commits** from `clauding` branch
|
||||
5. **Merge `master` into `clauding`** to sync
|
||||
6. **Merge `clauding` into `get-transactions2-page-working`**
|
||||
|
||||
## Implementation Steps
|
||||
|
||||
### Phase 1: Extract and Rebase Invoice Templates
|
||||
|
||||
#### Step 1.1: Identify Invoice Template Commits
|
||||
|
||||
```bash
|
||||
# From clauding branch, find the range of invoice template commits
|
||||
git log --oneline --reverse dc021b8c..clauding
|
||||
```
|
||||
|
||||
**Invoice template commits to extract** (6 commits in order):
|
||||
1. `db1cb194` - Add Bonanza Produce invoice template
|
||||
2. `ec754233` - Improve Bonanza Produce customer identifier extraction
|
||||
3. `af7bc324` - Add location extraction for Bonanza Produce invoices
|
||||
4. `62107c99` - Extract customer name and address for Bonanza Produce
|
||||
5. `7ecd569e` - Add invoice-template-creator skill for automated template generation
|
||||
6. `0155d91e` - Add Bonanza Produce multi-invoice statement template
|
||||
|
||||
#### Step 1.2: Create Rebased Branch
|
||||
|
||||
```bash
|
||||
# Create a new branch from master with only invoice template commits
|
||||
git checkout master
|
||||
git pull origin master # Ensure master is up to date
|
||||
git checkout -b invoice-templates-rebased
|
||||
|
||||
# Cherry-pick the invoice template commits in order
|
||||
git cherry-pick db1cb194
|
||||
git cherry-pick ec754233
|
||||
git cherry-pick af7bc324
|
||||
git cherry-pick 62107c99
|
||||
git cherry-pick 7ecd569e
|
||||
git cherry-pick 0155d91e
|
||||
|
||||
# Resolve any conflicts that arise during cherry-pick
|
||||
# Run tests after each cherry-pick if conflicts occur
|
||||
```
|
||||
|
||||
#### Step 1.3: Verify Rebased Branch
|
||||
|
||||
```bash
|
||||
# Verify the commits are correctly applied
|
||||
git log --oneline master..invoice-templates-rebased
|
||||
|
||||
# Run tests to ensure invoice templates still work
|
||||
lein test auto-ap.parse.templates-test
|
||||
```
|
||||
|
||||
#### Step 1.4: Merge to Master
|
||||
|
||||
```bash
|
||||
# Merge the clean invoice templates to master
|
||||
git checkout master
|
||||
git merge invoice-templates-rebased --no-edit
|
||||
|
||||
# Push to remote
|
||||
git push origin master
|
||||
```
|
||||
|
||||
### Phase 2: Clean Up Clauding Branch
|
||||
|
||||
#### Step 2.1: Remove Invoice Template Commits from Clauding
|
||||
|
||||
```bash
|
||||
# From clauding branch, find the commit before the first invoice template
|
||||
git log --oneline clauding | grep -B1 "db1cb194"
|
||||
|
||||
# Suppose that's commit X, rebase clauding to remove invoice templates
|
||||
git checkout clauding
|
||||
|
||||
# Option A: Interactive rebase (recommended for cleanup)
|
||||
git rebase -i <commit-before-invoice-templates>
|
||||
|
||||
# In the editor, delete lines corresponding to invoice template commits:
|
||||
# db1cb194
|
||||
# ec754233
|
||||
# af7bc324
|
||||
# 62107c99
|
||||
# 7ecd569e
|
||||
# 0155d91e
|
||||
|
||||
# Save and exit to rebase
|
||||
|
||||
# Resolve any conflicts that occur
|
||||
# Run tests after rebase
|
||||
```
|
||||
|
||||
**OR**
|
||||
|
||||
```bash
|
||||
# Option B: Hard reset to commit before invoice templates
|
||||
# Identify the commit hash before db1cb194 (let's call it COMMIT_X)
|
||||
git reset --hard COMMIT_X
|
||||
|
||||
# Then add back any non-invoice template commits from clauding
|
||||
# (commits after the invoice templates that should remain)
|
||||
git cherry-pick <non-invoice-commits-if-any>
|
||||
```
|
||||
|
||||
#### Step 2.2: Verify Clauding Branch Cleanup
|
||||
|
||||
```bash
|
||||
# Verify invoice template commits are removed
|
||||
git log --oneline | grep -i "bonanza" # Should be empty
|
||||
|
||||
# Verify other commits remain
|
||||
git log --oneline -20
|
||||
|
||||
# Run tests to ensure nothing broke
|
||||
lein test
|
||||
```
|
||||
|
||||
#### Step 2.3: Force Push Updated Clauding
|
||||
|
||||
```bash
|
||||
# Force push the cleaned branch (use --force-with-lease for safety)
|
||||
git push --force-with-lease origin clauding
|
||||
```
|
||||
|
||||
### Phase 3: Sync Clauding with Master
|
||||
|
||||
#### Step 3.1: Merge Master into Clauding
|
||||
|
||||
```bash
|
||||
git checkout clauding
|
||||
git merge master --no-edit
|
||||
|
||||
# Resolve any conflicts
|
||||
# Run tests
|
||||
```
|
||||
|
||||
#### Step 3.2: Push Synced Clauding
|
||||
|
||||
```bash
|
||||
git push origin clauding
|
||||
```
|
||||
|
||||
### Phase 4: Final Merge to get-transactions2-page-working
|
||||
|
||||
#### Step 4.1: Merge Clauding to get-transactions2-page-working
|
||||
|
||||
```bash
|
||||
git checkout get-transactions2-page-working
|
||||
git merge clauding --no-edit
|
||||
|
||||
# Resolve any conflicts
|
||||
# Run tests
|
||||
```
|
||||
|
||||
#### Step 4.2: Push Final Branch
|
||||
|
||||
```bash
|
||||
git push origin get-transactions2-page-working
|
||||
```
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
### Pre-operations Validation
|
||||
- [ ] All invoice template commits identified correctly (6 commits)
|
||||
- [ ] Merge base commit (`dc021b8c`) confirmed
|
||||
- [ ] Current branch state documented
|
||||
- [ ] Team notified of branch manipulation
|
||||
|
||||
### Post-Rebase Validation
|
||||
- [ ] `invoice-templates-rebased` branch created from `master`
|
||||
- [ ] All 6 invoice template commits applied correctly
|
||||
- [ ] All invoice template tests pass
|
||||
- [ ] No conflicts or unexpected changes during cherry-pick
|
||||
|
||||
### Post-Master Validation
|
||||
- [ ] Invoice templates merged to `master`
|
||||
- [ ] Changes pushed to remote `master`
|
||||
- [ ] CI/CD passes on `master`
|
||||
|
||||
### Post-Cleanup Validation
|
||||
- [ ] `clauding` branch has only non-invoice template commits
|
||||
- [ ] No Bonanza Produce commits remain in `clauding` history
|
||||
- [ ] All `clauding` tests pass
|
||||
- [ ] Force push successful
|
||||
|
||||
### Post-Sync Validation
|
||||
- [ ] `clauding` merged with `master`
|
||||
- [ ] All conflicts resolved
|
||||
- [ ] Changes pushed to remote
|
||||
|
||||
### Final Merge Validation
|
||||
- [ ] `get-transactions2-page-working` merged with `clauding`
|
||||
- [ ] All conflicts resolved
|
||||
- [ ] Final tests pass
|
||||
- [ ] Changes pushed to remote
|
||||
|
||||
## Success Metrics
|
||||
|
||||
- **Branch structure**: Invoice templates cleanly separated on `master`
|
||||
- **Commit history**: Linear, no duplicate invoice template commits
|
||||
- **Tests passing**: 100% of existing tests pass after each step
|
||||
- **No data loss**: All work preserved in appropriate branches
|
||||
- **Branch clarity**: Each branch has a clear, focused purpose
|
||||
|
||||
## Dependencies & Risks
|
||||
|
||||
### Dependencies
|
||||
- [ ] All current work on `clauding` should be backed up or committed
|
||||
- [ ] Team should be aware of branch manipulation to avoid force pushing
|
||||
- [ ] CI/CD should be monitored during operations
|
||||
|
||||
### Risks
|
||||
1. **Force push risk**: Force pushing `clauding` will rewrite history
|
||||
- **Mitigation**: Use `--force-with-lease`, notify team beforehand
|
||||
|
||||
2. **Conflict resolution**: Multiple merge/conflict resolution points
|
||||
- **Mitigation**: Test after each step, resolve conflicts carefully
|
||||
|
||||
3. **Work loss**: Potential to lose commits if operations go wrong
|
||||
- **Mitigation**: Create backups, verify each step before proceeding
|
||||
|
||||
4. **CI/CD disruption**: Force pushes may affect CI/CD pipelines
|
||||
- **Mitigation**: Coordinate with team, avoid during active deployments
|
||||
|
||||
### Contingency Plan
|
||||
|
||||
If something goes wrong:
|
||||
1. **Recover `clauding` branch**:
|
||||
```bash
|
||||
git checkout clauding
|
||||
git reset --hard origin/clauding # Restore from remote backup
|
||||
```
|
||||
|
||||
2. **Recover master**:
|
||||
```bash
|
||||
git checkout master
|
||||
git reset --hard origin/master # Restore from deploy/master
|
||||
```
|
||||
|
||||
3. **Manual cherry-pick recovery**: If rebasing failed, manually cherry-pick remaining commits
|
||||
|
||||
## Alternative Approaches Considered
|
||||
|
||||
### Approach 1: Squash and Merge
|
||||
**Pros**: Single clean commit, simple history
|
||||
**Cons**: Loses individual commit history and context
|
||||
|
||||
**Rejected because**: Team uses merge commits (not squash), and individual commit history is valuable for tracking invoice template development.
|
||||
|
||||
### Approach 2: Keep Branches Separate
|
||||
**Pros**: No branch manipulation needed
|
||||
**Cons**: Branches remain tangled, harder to track progress
|
||||
|
||||
**Rejected because**: Goal is to cleanly separate invoice templates from transaction work.
|
||||
|
||||
### Approach 3: Rebase Clauding Onto Master
|
||||
**Pros**: Linear history
|
||||
**Cons**: Requires force push, may lose merge context
|
||||
|
||||
**Rejected because**: Current team workflow uses merge commits, and merging master into clauding preserves the integration point.
|
||||
|
||||
### Approach 4: Create New Branch Instead of Cleanup
|
||||
**Pros**: Less risky, preserves full history
|
||||
**Cons**: Accumulates branches, harder to track
|
||||
|
||||
**Rejected because**: Goal is cleanup and reorganization, not preservation.
|
||||
|
||||
## Related Work
|
||||
|
||||
- **Previous invoice template work**: `2026-02-07-feat-add-invoice-template-03881260-plan.md`
|
||||
- **Current branch structure**: `clauding` has hierarchical relationship with `get-transactions2-page-working`
|
||||
- **Team git workflow**: Uses merge commits (not rebasing), per repo research
|
||||
|
||||
## References & Research
|
||||
|
||||
### Internal References
|
||||
- **Branch management patterns**: Repo research analysis (see `task_id: ses_3c2287be8ffe9icFi5jHEspaqh`)
|
||||
- **Invoice template location**: `src/clj/auto_ap/parse/templates.clj`
|
||||
- **Current branch structure**: Git log analysis
|
||||
|
||||
### Git Operations Documentation
|
||||
- **Cherry-pick**: `git cherry-pick <commit>`
|
||||
- **Interactive rebase**: `git rebase -i <base>`
|
||||
- **Force push with lease**: `git push --force-with-lease`
|
||||
- **Merge commits**: `git merge <branch> --no-edit`
|
||||
|
||||
### File Locations
|
||||
- Templates: `src/clj/auto_ap/parse/templates.clj`
|
||||
- Parser logic: `src/clj/auto_ap/parse.clj`
|
||||
- Invoice PDF: `dev-resources/INVOICE - 03881260.pdf`
|
||||
|
||||
## Testing Plan
|
||||
|
||||
### Before Each Major Step
|
||||
```bash
|
||||
# Verify current branch state
|
||||
git branch -vv
|
||||
git log --oneline -10
|
||||
|
||||
# Run all tests
|
||||
lein test
|
||||
|
||||
# Run specific invoice template tests
|
||||
lein test auto-ap.parse.templates-test
|
||||
```
|
||||
|
||||
### After Each Major Step
|
||||
- Verify commit count and order
|
||||
- Run full test suite
|
||||
- Check for unintended changes
|
||||
- Verify remote branch state matches local
|
||||
|
||||
## Notes
|
||||
|
||||
- **Team coordination**: Inform team before force pushing to avoid conflicts
|
||||
- **Backup strategy**: All commits are preserved in the rebase process
|
||||
- **Testing**: Verify at each step to catch issues early
|
||||
- **Safety first**: Use `--force-with-lease` instead of `--force`
|
||||
- **Documentation**: This plan serves as documentation for the operation
|
||||
@@ -0,0 +1,132 @@
|
||||
---
|
||||
module: Invoice Parsing
|
||||
date: 2026-02-07
|
||||
problem_type: integration_failure
|
||||
component: pdf_template_parser
|
||||
symptoms:
|
||||
- "Bonanza Produce multi-invoice statement (13595522.pdf) fails to parse correctly"
|
||||
- "Single invoice template extracts only one invoice instead of four"
|
||||
- "Multi-invoice statement lacks I/L markers present in single invoices"
|
||||
- "Customer identifier extraction pattern requires different regex for statements"
|
||||
root_cause: template_inadequate
|
||||
resolution_type: template_fix
|
||||
severity: high
|
||||
tags: [pdf, parsing, invoice, bonanza-produce, multi-invoice, integration]
|
||||
---
|
||||
|
||||
# Bonanza Produce Multi-Invoice Statement Template Fix
|
||||
|
||||
## Problem
|
||||
|
||||
Bonanza Produce sends two different invoice formats:
|
||||
1. **Single invoices** (e.g., 03881260.pdf) with I/L markers and specific layout
|
||||
2. **Multi-invoice statements** (e.g., 13595522.pdf) containing 4 invoices per page
|
||||
|
||||
The single invoice template failed to parse multi-invoice statements because:
|
||||
- Multi-invoice statements lack the I/L (Invoice/Location) markers used in single invoice templates
|
||||
- The layout structure is completely different, with invoices listed as table rows instead of distinct sections
|
||||
- Customer identifier extraction requires a different regex pattern
|
||||
|
||||
## Environment
|
||||
|
||||
- Component: PDF Template Parser (Clojure)
|
||||
- Date: 2026-02-07
|
||||
- Test File: `test/clj/auto_ap/parse/templates_test.clj`
|
||||
- Template File: `src/clj/auto_ap/parse/templates.clj`
|
||||
- Test Document: `dev-resources/13595522.pdf` (4 invoices on single page)
|
||||
|
||||
## Symptoms
|
||||
|
||||
- Single invoice template only parses first invoice from multi-invoice statement
|
||||
- Parse returns single result instead of 4 separate invoice records
|
||||
- `:customer-identifier` extraction returns empty or incorrect values for statements
|
||||
- Test `parse-bonanza-produce-statement-13595522` expects 4 results but receives 1
|
||||
|
||||
## What Didn't Work
|
||||
|
||||
**Attempted Solution 1: Reuse single invoice template with `:multi` flag**
|
||||
- Added `:multi #"\n"` and `:multi-match?` pattern to existing single invoice template
|
||||
- **Why it failed:** The single invoice template's regex patterns (e.g., `I\s+([A-Z][A-Z\s]+?)\s{2,}.*?L\s+`) expect I/L markers that don't exist in multi-invoice statements. The layout structure is fundamentally different.
|
||||
|
||||
**Attempted Solution 2: Using simpler customer identifier pattern**
|
||||
- Tried pattern `#"(.*?)\s+RETURN"` extracted from multi-invoice statement text
|
||||
- **Why it failed:** This pattern alone doesn't account for the statement's column-based layout. Need to combine with `:multi` and `:multi-match?` flags to parse multiple invoices.
|
||||
|
||||
## Solution
|
||||
|
||||
Added a dedicated multi-invoice template that:
|
||||
1. Uses different keywords to identify multi-invoice statements
|
||||
2. Employs `:multi` and `:multi-match?` flags for multiple invoice extraction
|
||||
3. Uses simpler regex patterns suitable for the statement layout
|
||||
|
||||
**Implementation:**
|
||||
|
||||
```clojure
|
||||
;; Bonanza Produce Statement (multi-invoice)
|
||||
{:vendor "Bonanza Produce"
|
||||
:keywords [#"The perishable agricultural commodities" #"SPARKS, NEVADA"]
|
||||
:extract {:invoice-number #"^\s+[0-9]{2}/[0-9]{2}/[0-9]{2}\s+([0-9]+)\s+INVOICE"
|
||||
:customer-identifier #"(.*?)\s+RETURN"
|
||||
:date #"^\s+([0-9]{2}/[0-9]{2}/[0-9]{2})"
|
||||
:total #"^\s+[0-9]{2}/[0-9]{2}/[0-9]{2}\s+[0-9]+\s+INVOICE\s+([\d.]+)"}
|
||||
:parser {:date [:clj-time "MM/dd/yy"]
|
||||
:total [:trim-commas nil]}
|
||||
:multi #"\n"
|
||||
:multi-match? #"\s+[0-9]{2}/[0-9]{2}/[0-9]{2}\s+[0-9]+\s+INVOICE"}
|
||||
```
|
||||
|
||||
**Key differences from single invoice template:**
|
||||
- `:keywords`: Look for statement header text instead of phone number
|
||||
- `:customer-identifier`: Pattern `#"(.*?)\s+RETURN"` works for statement format
|
||||
- `:multi #"\n"`: Split results on newline boundaries
|
||||
- `:multi-match?`: Match invoice header pattern to identify individual invoices
|
||||
- No I/L markers: Patterns scan from left margin without location markers
|
||||
|
||||
## Why This Works
|
||||
|
||||
1. **Statement-specific keywords:** "The perishable agricultural commodities" and "SPARKS, NEVADA" uniquely identify multi-invoice statements vs. single invoices (which have phone number 530-544-4136)
|
||||
|
||||
2. **Multi-flag parsing:** The `:multi` and `:multi-match?` flags tell the parser to split the document on newlines and identify individual invoices using the date/invoice-number pattern, rather than treating the whole page as one invoice
|
||||
|
||||
3. **Simplified patterns:** Without I/L markers, patterns scan from line start (`^\s+`) and extract columns based on whitespace positions. The `:customer-identifier` pattern `(.*?)\s+RETURN` captures everything before "RETURN" on each line
|
||||
|
||||
4. **Separate templates:** Having distinct templates for single invoices vs. statements prevents conflict and allows optimization for each format
|
||||
|
||||
## Prevention
|
||||
|
||||
**When adding templates for vendors with multiple document formats:**
|
||||
|
||||
1. **Create separate templates:** Don't try to make one template handle both formats. Use distinct keywords to identify each format
|
||||
|
||||
2. **Test both single and multi-invoice documents:** Ensure templates parse expected number of invoices:
|
||||
```clojure
|
||||
(is (= 4 (count results)) "Should parse 4 invoices from statement")
|
||||
```
|
||||
|
||||
3. **Verify `:multi` usage:** Multi-invoice templates should have both `:multi` and `:multi-match?` flags:
|
||||
```clojure
|
||||
:multi #"\n"
|
||||
:multi-match? #"\s+[0-9]{2}/[0-9]{2}/[0-9]{2}\s+[0-9]+\s+INVOICE"
|
||||
```
|
||||
|
||||
4. **Check pattern scope:** Multi-invoice statements often lack structural markers (I/L), so patterns should:
|
||||
- Use `^\s+` to anchor at line start
|
||||
- Extract from whitespace-separated columns
|
||||
- Avoid patterns requiring specific markers
|
||||
|
||||
5. **Run all template tests:** Before committing, run:
|
||||
```bash
|
||||
lein test auto-ap.parse.templates-test
|
||||
```
|
||||
|
||||
## Related Issues
|
||||
|
||||
- Single invoice template: `src/clj/auto_ap/parse/templates.clj` lines 756-765
|
||||
- Similar multi-invoice patterns: Search for `:multi` and `:multi-match?` in `src/clj/auto_ap/parse/templates.clj`
|
||||
|
||||
## Key Files
|
||||
|
||||
- **Tests:** `test/clj/auto_ap/parse/templates_test.clj` (lines 36-53)
|
||||
- **Template:** `src/clj/auto_ap/parse/templates.clj` (lines 767-777)
|
||||
- **Test document:** `dev-resources/13595522.pdf`
|
||||
- **Template parser:** `src/clj/auto_ap/parse.clj`
|
||||
@@ -0,0 +1,133 @@
|
||||
---
|
||||
module: SSR Admin
|
||||
component: testing_framework
|
||||
date: '2026-02-07'
|
||||
problem_type: best_practice
|
||||
resolution_type: test_fix
|
||||
severity: medium
|
||||
root_cause: inadequate_documentation
|
||||
symptoms:
|
||||
- Route tests only verified HTTP status codes (200), not actual HTML content
|
||||
- No verification that route responses contain expected page elements
|
||||
- Could have false positives where routes return empty or wrong content
|
||||
rails_version: 7.1.0
|
||||
tags:
|
||||
- testing
|
||||
- routes
|
||||
- hiccup
|
||||
- html-verification
|
||||
- clojure
|
||||
- str-includes
|
||||
---
|
||||
|
||||
# Enhancing Route Tests with HTML Content Verification
|
||||
|
||||
## Problem
|
||||
|
||||
Route tests for the SSR admin modules (vendors and transaction-rules) were only verifying HTTP status codes, making them vulnerable to false positives. A route could return a 200 status but with empty or incorrect HTML content, and the tests would still pass.
|
||||
|
||||
## Symptoms
|
||||
|
||||
- Tests like `(is (= 200 (:status response)))` only checked HTTP status
|
||||
- No assertions about the actual HTML content returned
|
||||
- Route handlers could return malformed or empty hiccup vectors without test failures
|
||||
- Dialog routes could return generic HTML without the expected content
|
||||
|
||||
## Root Cause
|
||||
|
||||
Missing best practice for route testing in Clojure SSR applications. Unlike Rails controller tests that can use `assert_select` or Capybara matchers, there was no established pattern for verifying hiccup-rendered HTML content.
|
||||
|
||||
## Solution
|
||||
|
||||
Enhanced route tests to verify HTML content using `clojure.string/includes?` checks on the rendered HTML string.
|
||||
|
||||
### Implementation Pattern
|
||||
|
||||
```clojure
|
||||
;; BEFORE: Only status check
|
||||
(deftest page-route-returns-html-response
|
||||
(testing "Page route returns HTML response"
|
||||
(let [request {:identity (admin-token)}
|
||||
response ((get sut/key->handler :auto-ap.routes.admin.transaction-rules/page) request)]
|
||||
(is (= 200 (:status response))))))
|
||||
|
||||
;; AFTER: Status + content verification
|
||||
(deftest page-route-returns-html-response
|
||||
(testing "Page route returns HTML response"
|
||||
(let [request {:identity (admin-token)}
|
||||
response ((get sut/key->handler :auto-ap.routes.admin.transaction-rules/page) request)
|
||||
html-str (apply str (:body response))]
|
||||
(is (= 200 (:status response)))
|
||||
(is (str/includes? html-str "Transaction Rules")))))
|
||||
```
|
||||
|
||||
### Key Changes
|
||||
|
||||
1. **Convert body to string**: Use `(apply str (:body response))` to convert hiccup vectors to HTML string
|
||||
2. **Add content assertions**: Use `clojure.string/includes?` to verify expected content exists
|
||||
3. **Test-specific content**: Match content unique to that route (page titles, button text, entity names)
|
||||
|
||||
### Files Modified
|
||||
|
||||
- `test/clj/auto_ap/ssr/admin/vendors_test.clj`
|
||||
- Added `vendor-page-route-contains-vendor-content` test
|
||||
|
||||
- `test/clj/auto_ap/ssr/admin/transaction_rules_test.clj`
|
||||
- Enhanced 7 route tests with content verification:
|
||||
- `page-route-returns-html-response` → checks for "Transaction Rules"
|
||||
- `table-route-returns-table-data` → checks for "New Transaction Rule"
|
||||
- `edit-dialog-route-returns-dialog` → checks for entity-specific content
|
||||
- `account-typeahead-route-works` → checks for "account"
|
||||
- `location-select-route-works` → checks for "location"
|
||||
- `execute-dialog-route-works` → checks for "Code transactions"
|
||||
- `new-dialog-route-returns-empty-form` → checks for "Transaction rule"
|
||||
|
||||
### Testing Strategy
|
||||
|
||||
For each route, identify the minimal but specific content that indicates the route is working:
|
||||
|
||||
- **Page routes**: Check for page title or heading
|
||||
- **Dialog routes**: Check for dialog-specific button text or the entity name being edited
|
||||
- **Typeahead routes**: Check for the resource type (e.g., "account")
|
||||
- **Table routes**: Check for action buttons or empty state messages
|
||||
|
||||
## Prevention
|
||||
|
||||
When writing route tests, always:
|
||||
|
||||
1. ✅ Verify HTTP status code (200, 302, etc.)
|
||||
2. ✅ Verify response contains expected HTML content
|
||||
3. ✅ Use specific content unique to that route
|
||||
4. ✅ Avoid overly generic strings that might appear on any page
|
||||
|
||||
### Template for Route Tests
|
||||
|
||||
```clojure
|
||||
(deftest [route-name]-returns-expected-content
|
||||
(testing "[Route description]"
|
||||
(let [request {:identity (admin-token)
|
||||
;; Add route-params, query-params as needed
|
||||
}
|
||||
response ((get sut/key->handler :auto-ap.routes.[module]/[route]) request)
|
||||
html-str (apply str (:body response))]
|
||||
(is (= 200 (:status response)))
|
||||
(is (str/includes? html-str "[Expected content]")))))
|
||||
```
|
||||
|
||||
## Tools Used
|
||||
|
||||
- `clojure.string/includes?` - Simple string containment check
|
||||
- `apply str` - Converts hiccup vector to HTML string
|
||||
- No additional dependencies needed
|
||||
|
||||
## Benefits
|
||||
|
||||
- **Catches regressions**: Tests fail if route returns wrong content
|
||||
- **Self-documenting**: Test assertions describe expected behavior
|
||||
- **Lightweight**: No complex HTML parsing libraries required
|
||||
- **Fast**: String operations are performant
|
||||
|
||||
## Related
|
||||
|
||||
- Similar pattern could apply to any Clojure SSR application using hiccup
|
||||
- For more complex DOM assertions, consider adding hickory or enlive for structured HTML parsing
|
||||
@@ -5,7 +5,6 @@
|
||||
[clojure.string :as str]
|
||||
[auto-ap.time :as atime]))
|
||||
|
||||
|
||||
(def pdf-templates
|
||||
[;; CHEF's WAREHOUSE
|
||||
{:vendor "CHFW"
|
||||
@@ -45,8 +44,7 @@
|
||||
:parser {:date [:clj-time "MM/dd/yy"]}
|
||||
:multi #"\f\f"}
|
||||
|
||||
|
||||
;; IMPACT PAPER
|
||||
;; IMPACT PAPER
|
||||
{:vendor "Impact Paper & Ink LTD"
|
||||
:keywords [#"650-692-5598"]
|
||||
:extract {:total #"Total Amount\s+\$([\d\.\,\-]+)"
|
||||
@@ -369,8 +367,7 @@
|
||||
:parser {:date [:clj-time "MM/dd/yyyy"]
|
||||
:total [:trim-commas nil]}}
|
||||
|
||||
|
||||
;; Breakthru Bev
|
||||
;; Breakthru Bev
|
||||
{:vendor "Wine Warehouse"
|
||||
:keywords [#"BREAKTHRU BEVERAGE"]
|
||||
:extract {:date #"Invoice Date:\s+([0-9]+/[0-9]+/[0-9]+)"
|
||||
@@ -686,13 +683,13 @@
|
||||
|
||||
;; TODO DISABLING TO FOCUS ON STATEMENT
|
||||
#_{:vendor "Reel Produce"
|
||||
:keywords [#"reelproduce.com"]
|
||||
:extract {:date #"([0-9]+/[0-9]+/[0-9]+)"
|
||||
:customer-identifier #"Bill To(?:.*?)\n\n\s+(.*?)\s{2,}"
|
||||
:invoice-number #"Invoice #\n.*?\n.*?([\d\-]+)\n"
|
||||
:total #"Total\s*\n\s+\$([\d\-,]+\.\d{2,2}+)"}
|
||||
:parser {:date [:clj-time "MM/dd/yy"]
|
||||
:total [:trim-commas-and-negate nil]}}
|
||||
:keywords [#"reelproduce.com"]
|
||||
:extract {:date #"([0-9]+/[0-9]+/[0-9]+)"
|
||||
:customer-identifier #"Bill To(?:.*?)\n\n\s+(.*?)\s{2,}"
|
||||
:invoice-number #"Invoice #\n.*?\n.*?([\d\-]+)\n"
|
||||
:total #"Total\s*\n\s+\$([\d\-,]+\.\d{2,2}+)"}
|
||||
:parser {:date [:clj-time "MM/dd/yy"]
|
||||
:total [:trim-commas-and-negate nil]}}
|
||||
|
||||
{:vendor "Eddie's Produce"
|
||||
:keywords [#"Eddie's Produce"]
|
||||
@@ -754,7 +751,30 @@
|
||||
:parser {:date [:clj-time "MM/dd/yyyy"]
|
||||
:total [:trim-commas-and-negate nil]}
|
||||
:multi #"\n"
|
||||
:multi-match? #"INV #"}])
|
||||
:multi-match? #"INV #"}
|
||||
|
||||
;; Bonanza Produce
|
||||
{:vendor "Bonanza Produce"
|
||||
:keywords [#"530-544-4136"]
|
||||
:extract {:invoice-number #"NO\s+(\d{8,})\s+\d{2}/\d{2}/\d{2}"
|
||||
:date #"NO\s+\d{8,}\s+(\d{2}/\d{2}/\d{2})"
|
||||
:customer-identifier #"(?s)I\s+([A-Z][A-Z\s]+?)\s{2,}.*?L\s+([0-9][A-Z0-9\s]+?)(?=\s{2,}|\n)"
|
||||
:account-number #"(?s)L\s+([0-9][A-Z0-9\s]+?)(?=\s{2,}|\n)"
|
||||
:total #"SHIPPED\s+[\d\.]+\s+TOTAL\s+([\d\.]+)"}
|
||||
:parser {:date [:clj-time "MM/dd/yy"]
|
||||
:total [:trim-commas nil]}}
|
||||
|
||||
;; Bonanza Produce Statement (multi-invoice)
|
||||
{:vendor "Bonanza Produce"
|
||||
:keywords [#"The perishable agricultural commodities" #"SPARKS, NEVADA"]
|
||||
:extract {:invoice-number #"^\s+[0-9]{2}/[0-9]{2}/[0-9]{2}\s+([0-9]+)\s+INVOICE"
|
||||
:customer-identifier #"(.*?)\s+RETURN"
|
||||
:date #"^\s+([0-9]{2}/[0-9]{2}/[0-9]{2})"
|
||||
:total #"^\s+[0-9]{2}/[0-9]{2}/[0-9]{2}\s+[0-9]+\s+INVOICE\s+([\d.]+)"}
|
||||
:parser {:date [:clj-time "MM/dd/yy"]
|
||||
:total [:trim-commas nil]}
|
||||
:multi #"\n"
|
||||
:multi-match? #"\s+[0-9]{2}/[0-9]{2}/[0-9]{2}\s+[0-9]+\s+INVOICE"}])
|
||||
|
||||
(def excel-templates
|
||||
[{:vendor "Mama Lu's Foods"
|
||||
@@ -784,43 +804,41 @@
|
||||
{:vendor "Daylight Foods"
|
||||
:keywords [#"CUSTNO"]
|
||||
:extract (fn [sheet vendor]
|
||||
(alog/peek ::daylight-invoices
|
||||
(transduce (comp
|
||||
(drop 1)
|
||||
(filter
|
||||
(fn [r]
|
||||
(and
|
||||
(seq r)
|
||||
(->> r first not-empty))))
|
||||
(map
|
||||
(fn [[customer-number _ _ _ invoice-number date amount :as row]]
|
||||
(println "DAT E is" date)
|
||||
{:customer-identifier customer-number
|
||||
:text (str/join " " row)
|
||||
:full-text (str/join " " row)
|
||||
:date (try (or (u/parse-value :clj-time "MM/dd/yyyy" (str/trim date))
|
||||
(try
|
||||
(atime/as-local-time
|
||||
(time/plus (time/date-time 1900 1 1)
|
||||
(time/days (dec (dec (Integer/parseInt "45663"))))))
|
||||
(catch Exception e
|
||||
nil)
|
||||
))
|
||||
|
||||
(catch Exception e
|
||||
(try
|
||||
(atime/as-local-time
|
||||
(time/plus (time/date-time 1900 1 1)
|
||||
(time/days (dec (dec (Integer/parseInt "45663"))))))
|
||||
(catch Exception e
|
||||
nil)
|
||||
)
|
||||
))
|
||||
:invoice-number invoice-number
|
||||
:total (str amount)
|
||||
:vendor-code vendor})))
|
||||
conj
|
||||
[]
|
||||
sheet)))}])
|
||||
(alog/peek ::daylight-invoices
|
||||
(transduce (comp
|
||||
(drop 1)
|
||||
(filter
|
||||
(fn [r]
|
||||
(and
|
||||
(seq r)
|
||||
(->> r first not-empty))))
|
||||
(map
|
||||
(fn [[customer-number _ _ _ invoice-number date amount :as row]]
|
||||
(println "DAT E is" date)
|
||||
{:customer-identifier customer-number
|
||||
:text (str/join " " row)
|
||||
:full-text (str/join " " row)
|
||||
:date (try (or (u/parse-value :clj-time "MM/dd/yyyy" (str/trim date))
|
||||
(try
|
||||
(atime/as-local-time
|
||||
(time/plus (time/date-time 1900 1 1)
|
||||
(time/days (dec (dec (Integer/parseInt "45663"))))))
|
||||
(catch Exception e
|
||||
nil)))
|
||||
|
||||
(catch Exception e
|
||||
(try
|
||||
(atime/as-local-time
|
||||
(time/plus (time/date-time 1900 1 1)
|
||||
(time/days (dec (dec (Integer/parseInt "45663"))))))
|
||||
(catch Exception e
|
||||
nil))))
|
||||
|
||||
:invoice-number invoice-number
|
||||
:total (str amount)
|
||||
:vendor-code vendor})))
|
||||
conj
|
||||
[]
|
||||
sheet)))}])
|
||||
|
||||
|
||||
|
||||
53
test/clj/auto_ap/parse/templates_test.clj
Normal file
53
test/clj/auto_ap/parse/templates_test.clj
Normal file
@@ -0,0 +1,53 @@
|
||||
(ns auto-ap.parse.templates-test
|
||||
(:require [auto-ap.parse :as sut]
|
||||
[clojure.test :refer [deftest is testing]]
|
||||
[clojure.java.io :as io]
|
||||
[clojure.string :as str]
|
||||
[clj-time.core :as time]))
|
||||
|
||||
(deftest parse-bonanza-produce-invoice-03881260
|
||||
(testing "Should parse Bonanza Produce invoice 03881260 with customer identifier including address"
|
||||
(let [pdf-file (io/file "dev-resources/INVOICE - 03881260.pdf")
|
||||
;; Extract text same way parse-file does
|
||||
pdf-text (:out (clojure.java.shell/sh "pdftotext" "-layout" (str pdf-file) "-"))
|
||||
results (sut/parse pdf-text)
|
||||
result (first results)]
|
||||
(is (some? results) "parse should return a result")
|
||||
(is (some? result) "Template should match and return a result")
|
||||
(when result
|
||||
(println "DEBUG: customer-identifier =" (pr-str (:customer-identifier result)))
|
||||
(println "DEBUG: account-number =" (pr-str (:account-number result)))
|
||||
(is (= "Bonanza Produce" (:vendor-code result)))
|
||||
(is (= "03881260" (:invoice-number result)))
|
||||
;; Date is parsed as org.joda.time.DateTime - compare year/month/day
|
||||
(let [d (:date result)]
|
||||
(is (= 2026 (time/year d)))
|
||||
(is (= 1 (time/month d)))
|
||||
(is (= 20 (time/day d))))
|
||||
;; Customer identifier includes name, account-number includes street address
|
||||
;; Together they form the full customer identification
|
||||
(is (= "NICK THE GREEK" (:customer-identifier result)))
|
||||
(is (= "600 VISTA WAY" (str/trim (:account-number result))))
|
||||
(is (= "NICK THE GREEK 600 VISTA WAY"
|
||||
(str (:customer-identifier result) " " (str/trim (:account-number result)))))
|
||||
;; Total is parsed as string, not number (per current behavior)
|
||||
(is (= "23.22" (:total result)))))))
|
||||
|
||||
(deftest parse-bonanza-produce-statement-13595522
|
||||
(testing "Should parse Bonanza Produce statement 13595522 with multiple invoices"
|
||||
(let [pdf-file (io/file "dev-resources/13595522.pdf")
|
||||
pdf-text (:out (clojure.java.shell/sh "pdftotext" "-layout" (str pdf-file) "-"))
|
||||
results (sut/parse pdf-text)]
|
||||
(is (some? results) "parse should return results")
|
||||
(is (= 4 (count results)) "Should parse 4 invoices from statement")
|
||||
(doseq [result results]
|
||||
(is (= "Bonanza Produce" (:vendor-code result)))
|
||||
(is (= "600 VISTA WAY" (:customer-identifier result))))
|
||||
(is (= "03876838" (:invoice-number (nth results 0))))
|
||||
(is (= "03877314" (:invoice-number (nth results 1))))
|
||||
(is (= "03878619" (:invoice-number (nth results 2))))
|
||||
(is (= "03879035" (:invoice-number (nth results 3))))
|
||||
(is (= "891.65" (:total (nth results 0))))
|
||||
(is (= "720.33" (:total (nth results 1))))
|
||||
(is (= "853.16" (:total (nth results 2))))
|
||||
(is (= "1066.60" (:total (nth results 3)))))))
|
||||
Reference in New Issue
Block a user