@filipebraida/adonis-function-points 0.3.0 → 0.5.0

package/CHANGELOG.md

@@ -6,6 +6,119 @@ release moves the number for unchanged code, the rule set version moves with it
 otherwise the difference would measure the tool's change rather than the work, and
 that difference becomes an invoice.
 
+## 0.5.0
+
+**Rule set `afp@1.4.0`.** Two classification defects are fixed and both move numbers,
+so a 0.4.0 baseline has to be recounted.
+
+Found by auditing a production count function by function against the code, rather than
+by reading the report's warnings — which is where the previous rounds had been looking.
+
+### Fixed
+
+- **Maintenance was decided per REQUEST instead of per store.** `behavior.writes`
+  decides EI against EO and was also read as "this store is maintained", so every store
+  a writing transaction touched became an ILF. A reference table merely READ by a route
+  that writes something else counted as maintained. On a production application this
+  left exactly one EIF in the whole count, which should have been the signal.
+- **Seeders, tests and factories counted as maintenance.** The project-wide pass read a
+  seeder's inserts as the application maintaining a table, so reference data only the
+  seed populates came out as an ILF — which the CPM does not allow. The filter on scan
+  roots drops `tests/` and `database/` only at the ROOT, and a domain-module layout puts
+  both inside `app/`. It now applies at any depth.
+- **The override warning counted floors that were already answered**, said "one schema"
+  whatever it was given, and therefore fired on a configuration that was complete.
+- **`opaqueReviewed` matching nothing was silent.** `detFromSchema` already warns when
+  it names a schema that is not declared; a review naming a field that does not exist
+  reviewed nothing while the warning kept firing, which reads as the tool ignoring the
+  configuration.
+- **A review was invisible in `fp:explain`.** Its reason appeared nowhere, which defeats
+  requiring one. Reviewed floors are now marked `(opaque, reviewed)` and the reason is
+  printed — without being counted in the "Declared by override" share, since a review
+  declares no number.
+
+### Documented
+
+- **In CI, prefer the standalone binary.** `node ace` validates `start/env.ts` before
+  running any command, so `node ace fp:count` fails on a missing environment variable
+  that has nothing to do with counting — measured on a production application, it
+  stopped at `Missing environment variable "AUTHZ_STORE"` and never reached the
+  command. The `fp:*` commands declare `startApp: false`, which is not enough. The
+  README said the two front-ends were interchangeable; for a pipeline that only checks
+  out code, they are not.
+
+### New
+
+- **`CallResolver.technicalWrite()`** declares that a write is not what the transaction
+  is for. §6.5.3 reads any write as an EI, which misreads a screen that records the
+  visit; the CPM asks about primary intent. The fact is declared about the CALL, so a
+  bookkeeping helper called from several screens is declared once. It does not hide the
+  write: the store stays an ILF and stays an FTR.
+- **`boundary.business` says when it contradicts the code.** It accepted without comment
+  a table nothing in the application writes — which is how two read-only lookup tables
+  were declared as business data on the belief they had a CRUD, when the routes were
+  `.only(['index', 'show'])`. The declaration is still honoured; the fact is reported.
+
+## 0.4.0
+
+**Rule set `afp@1.3.0`.** Conditional validator groups now count, and a nested
+schema is recognised however the formatter wrapped it — so a 0.3.0 baseline has to
+be recounted.
+
+Five items reported from real use of 0.3.0, three of them defects.
+
+### Fixed
+
+- **A newline decided whether a field counted.** The recogniser for a nested schema
+  was a regex over the property's source text (`/vine\.object/`), and Prettier breaks
+  a long chain across lines — `data: vine` then `.object({})` — so the regex missed
+  and the field was counted as one leaf instead of its nested ones, and never marked
+  opaque. Decided by structure now: is this literal the argument of a call named
+  `object`? The same applied to `.merge(…)` and `group.if(…)`, which had the same
+  kind of check. A count that depends on where the formatter put a newline is not a
+  measurement — the reason the implementation-scope hash strips whitespace before
+  hashing.
+- **The list of unreadable DETs ignored the overrides that answered it.** It was
+  computed before `applyOverrides` ran, so a function whose floor `detFromSchema` had
+  already replaced still appeared under "this is a FLOOR", telling the reader to map
+  something already mapped. It caused a real misreading of a production report, by
+  the author of this code. It now runs after the overrides, is grouped by FUNCTION,
+  and states per function how many were replaced by an override, how many reviewed,
+  and how many are still unanswered — only the last being a request to do anything.
+- **Emitted artefacts carried absolute paths.** `CountSource.app` is documented as
+  never being one, because that says where the machine keeps its files and travels
+  with every artefact sent anywhere — and the rule was applied to that one field. A
+  production count carried **858** absolute paths in its traces; an inventory
+  carried **2036** across ten fields, including the data-store `id`. Every path that
+  leaves is now relative to the application root, and the internal absolute form is
+  untouched because that is what ts-morph resolves against.
+- **`vine.group` and `.merge()` were not read.**
+  `vine.object({}).merge(vine.group([vine.group.if(p, {…})]))` reported the whole
+  validator as an open input object: five fields counted as one, and the report said
+  they were data when they are in the code. The branches are mutually exclusive at
+  runtime and the transaction can carry any of them, so §7.2 counts their union — a
+  field two branches share counts once. The group usually lives in an unexported
+  constant beside the validator, so the reference is resolved in the validator's own
+  file rather than the caller's.
+- **`fp:explain` matched by substring even when the exact name existed.** Asking
+  about `POST /orders/:param/submit` returned four functions, because
+  `/submit-ready` and `/submit-ready/return` contain it. An exact name now wins
+  outright; the substring search is the fallback.
+
+### New
+
+- **`detFromSchema` accepts a list**, unioned by leaf path. An ILF's DETs are the
+  fields the user recognises in the file, and an application with one schema per
+  template recognises all of them. Pointing at the largest and justifying it in
+  `reason` gives the same answer only while they land in the same band — reasoning
+  the configuration should not have to carry.
+- **`overrides.<fn>.opaqueReviewed`** records that someone looked at an opaque DET
+  and decided 1 is right. 1 DET is a floor and `fp:count` says so on every run, but
+  some of those columns really are one field, and a warning that cannot be answered
+  is one the team learns to scroll past. It moves no number, it is not counted as a
+  declared override in the "Declared by override" share, and the volume reviewed is
+  still printed.
+
 ## 0.3.0
 
 **Rule set `afp@1.2.0`.** Three counting fixes move the number for unchanged code,

package/README.md

@@ -13,7 +13,7 @@ node ace fp:count
 
 ```
 Unadjusted count: 46 FP
-Ruleset: afp@1.2.0
+Ruleset: afp@1.4.0
 
 type      n     FP
 ILF       2     14
@@ -63,11 +63,21 @@ For CI, or a one-off count on a project you do not want to touch:
 npx @filipebraida/adonis-function-points count --root ./my-app
 ```
 
-Nothing is booted either way — the engine only reads files — so a standalone
-run needs no `.env`, no database, and no install inside the analysed project.
-The standalone binary **does not replace installing**: a project that installs
-the package keeps the `node ace fp:*` commands, and both front-ends call the
-same code, so they cannot disagree about a number.
+The engine itself boots nothing — it only reads files — and the standalone binary
+needs no `.env`, no database, and no install inside the analysed project. The
+`fp:*` commands declare `startApp: false` for the same reason.
+
+**In CI, prefer the standalone binary.** Not for convenience: `node ace` validates
+`start/env.ts` before it runs any command, so `node ace fp:count` fails on a
+missing environment variable that has nothing to do with counting. Measured on a
+production application, it stopped at `Missing environment variable "AUTHZ_STORE"`
+and never reached the command. A pipeline that only checks out the code has no
+secrets, and does not need them to count.
+
+The standalone binary **does not replace installing**: a project that installs the
+package keeps the `node ace fp:*` commands — which is the right front-end at a
+developer's terminal, where the `.env` is already there — and both call the same
+code, so they cannot disagree about a number.
 
 ```
 adonis-function-points <command> [options]
@@ -75,6 +85,7 @@ adonis-function-points <command> [options]
   count                    count the unadjusted function points
   inventory                the raw facts: stores, routes, tracing coverage
   explain <name>           why one function was counted that way
+  metrics                  density, coupling and conformance, from the same run
   diff <previous.json>     additions / modifications / deletions, and billable FP
   calibrate <samples.csv>  correction factors against a manual count
 

package/build/commands/main.js

@@ -14,27 +14,27 @@
 const commands = [
 	{
 		commandName: "fp:inventory",
-		importer: () => import("../fp_inventory-Bu6O1Nn0.js")
+		importer: () => import("../fp_inventory-CPtmuuke.js")
 	},
 	{
 		commandName: "fp:metrics",
-		importer: () => import("../fp_metrics-MGDppfSa.js")
+		importer: () => import("../fp_metrics-et8F1Wvt.js")
 	},
 	{
 		commandName: "fp:count",
-		importer: () => import("../fp_count-D21tQ_pv.js")
+		importer: () => import("../fp_count-ChtblhZV.js")
 	},
 	{
 		commandName: "fp:explain",
-		importer: () => import("../fp_explain-BwFs-LW-.js")
+		importer: () => import("../fp_explain-DZJ--0-S.js")
 	},
 	{
 		commandName: "fp:diff",
-		importer: () => import("../fp_diff-D0pHGMgi.js")
+		importer: () => import("../fp_diff-Dt7J4IWu.js")
 	},
 	{
 		commandName: "fp:calibrate",
-		importer: () => import("../fp_calibrate-iFAec0tA.js")
+		importer: () => import("../fp_calibrate-DUbHiifm.js")
 	}
 ];
 let cache = null;

package/build/{fp_calibrate-iFAec0tA.js → fp_calibrate-DUbHiifm.js}

@@ -1,4 +1,4 @@
-import { s as printResult, t as runCalibrate } from "./runners-CmxNHuuq.js";
+import { s as printResult, t as runCalibrate } from "./runners-DIt1G85i.js";
 import { n as printerFor, t as __decorate } from "./decorate-D6enDn9D.js";
 import { BaseCommand, args } from "@adonisjs/core/ace";
 //#region commands/fp_calibrate.ts

package/build/{fp_count-D21tQ_pv.js → fp_count-ChtblhZV.js}

@@ -1,4 +1,4 @@
-import { n as runCount, s as printResult } from "./runners-CmxNHuuq.js";
+import { n as runCount, s as printResult } from "./runners-DIt1G85i.js";
 import { n as printerFor, t as __decorate } from "./decorate-D6enDn9D.js";
 import { BaseCommand, flags } from "@adonisjs/core/ace";
 //#region commands/fp_count.ts

package/build/{fp_diff-D0pHGMgi.js → fp_diff-Dt7J4IWu.js}

@@ -1,4 +1,4 @@
-import { r as runDiff, s as printResult } from "./runners-CmxNHuuq.js";
+import { r as runDiff, s as printResult } from "./runners-DIt1G85i.js";
 import { n as printerFor, t as __decorate } from "./decorate-D6enDn9D.js";
 import { BaseCommand, args } from "@adonisjs/core/ace";
 //#region commands/fp_diff.ts

package/build/{fp_explain-BwFs-LW-.js → fp_explain-DZJ--0-S.js}

@@ -1,4 +1,4 @@
-import { i as runExplain, s as printResult } from "./runners-CmxNHuuq.js";
+import { i as runExplain, s as printResult } from "./runners-DIt1G85i.js";
 import { n as printerFor, t as __decorate } from "./decorate-D6enDn9D.js";
 import { BaseCommand, args } from "@adonisjs/core/ace";
 //#region commands/fp_explain.ts

package/build/{fp_inventory-Bu6O1Nn0.js → fp_inventory-CPtmuuke.js}

@@ -1,4 +1,4 @@
-import { a as runInventory, s as printResult } from "./runners-CmxNHuuq.js";
+import { a as runInventory, s as printResult } from "./runners-DIt1G85i.js";
 import { n as printerFor, t as __decorate } from "./decorate-D6enDn9D.js";
 import { BaseCommand, flags } from "@adonisjs/core/ace";
 //#region commands/fp_inventory.ts

package/build/{fp_metrics-MGDppfSa.js → fp_metrics-et8F1Wvt.js}

@@ -1,4 +1,4 @@
-import { o as runMetrics, s as printResult } from "./runners-CmxNHuuq.js";
+import { o as runMetrics, s as printResult } from "./runners-DIt1G85i.js";
 import { n as printerFor, t as __decorate } from "./decorate-D6enDn9D.js";
 import { BaseCommand, flags } from "@adonisjs/core/ace";
 //#region commands/fp_metrics.ts

package/build/index.js

@@ -1,6 +1,6 @@
 import { configure } from "./configure.js";
 import { a as AEP_FACTORS, c as diffCounts, i as measureStructure, n as parseSamples, o as IncomparableRulesetsError, r as measureConformance, s as IncomparableSourcesError, t as calibrate, u as defineConfig } from "./calibration-8eV8CEix.js";
 import "./src/types.js";
-import { t as BUILTIN_CALL_RESOLVERS } from "./resolvers-CRB6lXoo.js";
-import { i as RULESET_VERSION, n as analyze, r as RULESET, t as CoverageTooLowError } from "./pipeline-CIAydCcT.js";
+import { t as BUILTIN_CALL_RESOLVERS } from "./resolvers-PJwo2Z8R.js";
+import { i as RULESET_VERSION, n as analyze, r as RULESET, t as CoverageTooLowError } from "./pipeline-CNTBhs6o.js";
 export { AEP_FACTORS, BUILTIN_CALL_RESOLVERS, CoverageTooLowError, IncomparableRulesetsError, IncomparableSourcesError, RULESET, RULESET_VERSION, analyze, calibrate, configure, defineConfig, diffCounts, measureConformance, measureStructure, parseSamples };