agris 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7858ee0c5eb1c3058b8af68342f76d1ff70e822d1e4a4fe8f441aaf1dc53483
-  data.tar.gz: 3d681210bed7df9e36dc5ef613f19b0e946072faef0ab22f2e44a06686de29e3
+  metadata.gz: fb6a00f60484f228102da6c6b39aca2cc26057a5e4dba778ac28dea63e214e0a
+  data.tar.gz: 24a8b68a3c83a6f5b339ec0e491fd37664f26743476cca81f53ccbe7872520db
 SHA512:
-  metadata.gz: 58c4086d2afcb13fc9c897c3415a0feed77336cc31bbe3b9817ad808065067f2c424f2907ec2195c6f3173e54ca998830da3ca48d91af9b2e31603343f78f73c
-  data.tar.gz: 6fec59796e43d413239ca3db3a8f06f40581ab4795cc5fb1b60b755af1cbe55f46a26934931b531aa5d69dbe23d9734fcc347f33c33a75f99af550ae2bb818e5
+  metadata.gz: 5be6658248ae55cffa67b8a125a13e460b47b00d598721f8f94f3eb2cae6a7112ae8fd092f14b6902d4fc734e0f28624f1fd83e73ef38ead6398e949f3bdde82
+  data.tar.gz: 1b2784b44bf070775452801c629b065343d28a7083f990d1f589f7780ef46d0207138c0a6b49e3e2ef8122f478ba0597985d26d9b7fa1758d75883149e2c1f23

data/CHANGELOG.md

@@ -10,6 +10,16 @@ version number — see [docs/RELEASING.md](docs/RELEASING.md). Raising that floo
 is a breaking change and takes a major bump; adding support for a newer Ruby
 takes none.
 
+## [Unreleased]
+
+## [1.1.0] - 2026-09-22
+
+### Added
+
+- `Api::NewVoucher::FreightTicketReferenceDetail`, the `ACPV3` voucher detail
+  that references the grain ticket whose freight an FV voucher pays. AGRIS
+  stamps the ticket with the voucher number on import. (#58)
+
 ## [1.0.0] - 2026-09-14
 
 First release since `v0.19.0`. The `1.0.0` bump declares the public API stable
@@ -76,4 +86,6 @@ Releases up to and including `v0.19.0` predate this changelog. See the
 [commit history](https://github.com/westernmilling/agris.rb/commits/master)
 and [release tags](https://github.com/westernmilling/agris.rb/tags).
 
+[Unreleased]: https://github.com/westernmilling/agris.rb/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/westernmilling/agris.rb/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/westernmilling/agris.rb/compare/v0.19.0...v1.0.0

data/agris.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'savon', '~> 2.11'
 
   spec.add_development_dependency 'bundler', '>= 2.3'
+  spec.add_development_dependency 'factory_bot', '~> 6.4'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '~> 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'

data/docs/specs/README.md

@@ -1,26 +1,24 @@
 # Specs
 
-Source of truth for behavior in the `agris` gem. Implementation, tests, and PRs trace back to spec IDs (R#, E#, AC-#, AT#).
+Specs in this repo are **build prompts**: short, point-in-time briefs for one PR. The code is
+the source of truth; a prompt records what a slice was asked to deliver and is not updated
+after review. Divergence between prompt and merged code is an expected record of what review
+corrected.
 
-## How to add a spec
-1. Copy `spec-template.md` into the appropriate area folder (see below).
-2. Name the file by feature, kebab-case (e.g., `import-grain-ticket.md`).
-3. Fill in Goal → Rules → Acceptance Criteria → Acceptance Tests.
-4. Reference spec IDs in commits, tests, and PR descriptions.
+Standing facts (Agris behaviour, business rules, spike results) live in Jira and Confluence and
+are cited, not repeated. A prompt states only what is specific to its slice.
 
-## Layout
+## Writing one
+1. Name the file for the Jira task the PR delivers: `docs/specs/<key>-<slug>.md`
+   (e.g. `ot3-257-freight-ticket-reference.md`).
+2. Keep it to roughly 25–45 lines: **Goal** (2–3 sentences), **Scope** stated positively
+   ("Exactly: …" plus one "Later: …" line), **Rules** (R#, MUST / MUST NOT), **Acceptance
+   criteria** (AC#, the complete test list), and **Slice-specific notes** for gotchas.
+3. Note the diff budget (≤200 lines) and split before dispatch if the estimate is over.
+4. Commit it with the PR as a `docs(specs):` commit and paste it into the PR description
+   in a collapsed `<details>` block titled "Build prompt (frozen — not updated after review)".
+5. Cite R# and AC# in commit bodies and the PR's test checklist. Do not put spec IDs or
+   paths in code or test comments.
 
-Specs are grouped by Agris API area, mirroring `lib/agris/api/`:
-
-- `grain/` — tickets, contracts (purchase/sales), commodity codes, grade factors, rates
-- `inventory/` — delivery tickets, orders
-- `accounts-payables/` — voucher posting
-- `accounts-receivables/` — invoice posting
-- `messages/` — document-tracking and "changed since" queries
-- `support/` — support / utility messages
-
-Cross-cutting specs (config, transport, error model) can live at the top level of `docs/specs/`.
-
-## Templates
-- `spec-template.md` — blank template, copy this.
-- `rename-folder.example.md` — completed example showing the expected level of detail.
+`spec-template.md` and `rename-folder.example.md` are the retired long-form house format,
+kept for reference only. The area folders (`grain/`, `inventory/`, …) are unused by prompts.

data/docs/specs/ot3-257-freight-ticket-reference.md

@@ -0,0 +1,48 @@
+# Build Prompt — OT3-257: ACPV3 freight ticket reference detail
+
+Jira: OT3-255 task OT3-257 · 2026-09-16 · Budget ≤200.
+Condensed after the build from the house-format spec this PR first carried; rules and ACs
+match the shipped code. Standing facts live in Jira OT3-256 (staging spike, 2026-09-14) and
+the BRD "Freight Voucher via Agris API" (Confluence, SD space) and are not repeated here.
+
+## Goal
+Let a consumer post an AGRIS accounts-payable freight voucher (type FV) that references the
+grain ticket it pays. AGRIS 22.3.0 SU5 or later (AGS-17887) stamps the voucher number on the
+ticket and drops it from the unpaid Freight Expenses population. The gem gains the ACPV3
+detail record; contracto wires it into vouchers in OT3-259.
+
+## Scope
+Exactly: `Agris::Api::NewVoucher::FreightTicketReferenceDetail` in `lib/agris/api/new_voucher.rb`,
+its RSpec file, a `NewVoucher` RSpec file for mixed details, this prompt, and an `Unreleased`
+changelog line. Later: the 1.1.0 bump and dated changelog heading (release PR); consumer-side
+rules in contracto's `docs/specs/freight-conventions.md` (OT3-258).
+
+## Rules
+- R1 — includes `XmlModel`; `ATTRIBUTE_NAMES` is exactly `in_out_code`, `ticket_location`,
+  `ticket_number`, `freight_amount`, `record_type`; `attr_reader(*ATTRIBUTE_NAMES)` as on
+  `NewVoucher` and `NewDisbursement`.
+- R2 — `record_type` is always `'ACPV3'`; a value passed to the constructor is overwritten.
+- R3 — `to_xml_hash` emits `:@recordtype => 'ACPV3'` plus `:@inoutcode`, `:@ticketlocation`,
+  `:@ticketnumber`, `:@freightamount` for whichever attributes were supplied, values untouched.
+  An omitted attribute emits no key (existing `XmlModel` behaviour; AGRIS decides validity).
+- R4 — `NewVoucher#add_detail` needs no change: a voucher holding a `GeneralLedgerDetail` and
+  this detail serializes both, in insertion order, each under its own record type.
+- R5 — MUST NOT validate AGRIS-side rules (ACPV3 sum equals voucher amount, shipper equals
+  remit-to, an ACPV2 line present). AGRIS reports those in-band via `PostResult#reject_reasons`.
+
+## Acceptance criteria (the complete test list)
+- AC-1 — `record_type` defaults to ACPV3; `record_type: 'OTHER'` still reads and serializes ACPV3.
+- AC-2 — all four attributes supplied (I / 051 / 0028786 / 230.85, the spike's ticket): readers
+  return the inputs; `to_xml_hash` equals exactly the five-key hash.
+- AC-3 — only `ticket_number` supplied: the other readers return nil; hash keys are exactly
+  `:@ticketnumber` and `:@recordtype`.
+- AC-4 — `ATTRIBUTE_NAMES` lists exactly the five names.
+- AC-5 — `NewVoucher` with one GL detail then one ACPV3 detail: `details` in insertion order,
+  record types `%w(ACPV2 ACPV3)`, header `to_xml_hash` excludes the details.
+
+## Slice-specific notes
+- The two older detail classes have no readers and are left alone.
+- No spec IDs or paths in code or test comments (Coding Style Rules §2.4); traceability is this
+  prompt plus the PR checklist.
+- Wire shape confirmed by rendering the real `create_voucher` payload: the ACPV3 element lands
+  flat inside `<details>` beside ACPV0 and ACPV2.

data/lib/agris/api/new_voucher.rb

@@ -106,6 +106,26 @@ module Agris
           @record_type = 'ACPV1'
         end
       end
+
+      class FreightTicketReferenceDetail
+        include XmlModel
+
+        ATTRIBUTE_NAMES = %w(
+          in_out_code
+          ticket_location
+          ticket_number
+          freight_amount
+          record_type
+        ).freeze
+
+        attr_reader(*ATTRIBUTE_NAMES)
+
+        def initialize(hash = {})
+          super
+
+          @record_type = 'ACPV3'
+        end
+      end
     end
   end
 end

data/lib/agris/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Agris
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: agris
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - John Gray
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-09-14 00:00:00.000000000 Z
+date: 2026-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -39,6 +39,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -184,6 +198,7 @@ files:
 - docs/specs/grain/.gitkeep
 - docs/specs/inventory/.gitkeep
 - docs/specs/messages/.gitkeep
+- docs/specs/ot3-257-freight-ticket-reference.md
 - docs/specs/rename-folder.example.md
 - docs/specs/spec-template.md
 - docs/specs/support/.gitkeep
@@ -285,7 +300,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: Ruby client library for Agris API