plan-verify 0.0.0-stage → 0.1.0

package/examples/plan-to-problems/lint.json

@@ -0,0 +1,576 @@
+{
+  "ok": false,
+  "spec": "examples/plan-to-problems/generated.ears.md",
+  "conflicts": [
+    {
+      "ids": [
+        "R1",
+        "R2"
+      ],
+      "minimal": true,
+      "everySituation": false,
+      "summary": "R1 and R2 cannot both hold.",
+      "clash": "They clash when a member asks to take a copy home, not a member asks to renew a copy, not a member brings a copy back, the copy was in the building, the copy was out on loan, a fine was not owed, the loan was not overdue, and the loan length was 1.",
+      "requirements": [
+        {
+          "id": "R1",
+          "line": 16,
+          "sentence": "While the copy is in the building, when a member asks to take a copy home, the Fall Desk shall allow the loan."
+        },
+        {
+          "id": "R2",
+          "line": 17,
+          "sentence": "While the copy is out on loan, when a member asks to take a copy home, the Fall Desk shall not allow the loan."
+        }
+      ],
+      "situation": [
+        {
+          "name": "borrow_requested",
+          "value": "true"
+        },
+        {
+          "name": "renew_requested",
+          "value": "false"
+        },
+        {
+          "name": "copy_returned",
+          "value": "false"
+        },
+        {
+          "name": "copy_in_building",
+          "value": "true"
+        },
+        {
+          "name": "copy_on_loan",
+          "value": "true"
+        },
+        {
+          "name": "fine_owed",
+          "value": "false"
+        },
+        {
+          "name": "loan_overdue",
+          "value": "false"
+        },
+        {
+          "name": "loan_days",
+          "value": "1"
+        }
+      ],
+      "requires": [
+        {
+          "id": "R1",
+          "text": "that the loan was allowed"
+        },
+        {
+          "id": "R2",
+          "text": "that the loan was not allowed"
+        }
+      ],
+      "example": [
+        {
+          "name": "borrow_requested",
+          "value": "true"
+        },
+        {
+          "name": "renew_requested",
+          "value": "false"
+        },
+        {
+          "name": "copy_returned",
+          "value": "false"
+        },
+        {
+          "name": "copy_in_building",
+          "value": "true"
+        },
+        {
+          "name": "copy_on_loan",
+          "value": "true"
+        },
+        {
+          "name": "fine_owed",
+          "value": "false"
+        },
+        {
+          "name": "loan_overdue",
+          "value": "false"
+        },
+        {
+          "name": "loan_days",
+          "value": "1"
+        },
+        {
+          "name": "loan_allowed",
+          "value": "true"
+        },
+        {
+          "name": "renewal_allowed",
+          "value": "false"
+        },
+        {
+          "name": "reminder_sent",
+          "value": "false"
+        },
+        {
+          "name": "loan_closed",
+          "value": "false"
+        }
+      ],
+      "keeps": [
+        "R1"
+      ],
+      "breaks": "R2",
+      "fix": "Suggested fix: ask which requirement should win. To keep R1, remove R2. To keep R2, remove R1.",
+      "repairs": [
+        {
+          "kind": "drop",
+          "id": "R1",
+          "text": "One repair is to drop R1 and keep R2 as written.",
+          "sentence": "While the copy is out on loan, when a member asks to take a copy home, the Fall Desk shall not allow the loan."
+        },
+        {
+          "kind": "drop",
+          "id": "R2",
+          "text": "One repair is to drop R2 and keep R1 as written.",
+          "sentence": "While the copy is in the building, when a member asks to take a copy home, the Fall Desk shall allow the loan."
+        },
+        {
+          "kind": "strengthen",
+          "id": "R1",
+          "text": "One repair is to add \"and the copy is not out on loan\" to the condition of R1. R2 stays as written.",
+          "sentence": "While the copy is in the building, when a member asks to take a copy home and the copy is not out on loan, the Fall Desk shall allow the loan."
+        },
+        {
+          "kind": "strengthen",
+          "id": "R2",
+          "text": "One repair is to add \"and the copy is not in the building\" to the condition of R2. R1 stays as written.",
+          "sentence": "While the copy is out on loan, when a member asks to take a copy home and the copy is not in the building, the Fall Desk shall not allow the loan."
+        }
+      ]
+    },
+    {
+      "ids": [
+        "R2",
+        "R3"
+      ],
+      "minimal": true,
+      "everySituation": false,
+      "summary": "R2 and R3 cannot both hold.",
+      "clash": "They clash when a member asks to take a copy home, not a member asks to renew a copy, not a member brings a copy back, the copy was not in the building, the copy was out on loan, a fine was not owed, the loan was not overdue, and the loan length was 1.",
+      "requirements": [
+        {
+          "id": "R2",
+          "line": 17,
+          "sentence": "While the copy is out on loan, when a member asks to take a copy home, the Fall Desk shall not allow the loan."
+        },
+        {
+          "id": "R3",
+          "line": 18,
+          "sentence": "While the copy is out on loan, when a member asks to take a copy home, the Fall Desk shall allow the loan."
+        }
+      ],
+      "situation": [
+        {
+          "name": "borrow_requested",
+          "value": "true"
+        },
+        {
+          "name": "renew_requested",
+          "value": "false"
+        },
+        {
+          "name": "copy_returned",
+          "value": "false"
+        },
+        {
+          "name": "copy_in_building",
+          "value": "false"
+        },
+        {
+          "name": "copy_on_loan",
+          "value": "true"
+        },
+        {
+          "name": "fine_owed",
+          "value": "false"
+        },
+        {
+          "name": "loan_overdue",
+          "value": "false"
+        },
+        {
+          "name": "loan_days",
+          "value": "1"
+        }
+      ],
+      "requires": [
+        {
+          "id": "R2",
+          "text": "that the loan was not allowed"
+        },
+        {
+          "id": "R3",
+          "text": "that the loan was allowed"
+        }
+      ],
+      "example": [
+        {
+          "name": "borrow_requested",
+          "value": "true"
+        },
+        {
+          "name": "renew_requested",
+          "value": "false"
+        },
+        {
+          "name": "copy_returned",
+          "value": "false"
+        },
+        {
+          "name": "copy_in_building",
+          "value": "false"
+        },
+        {
+          "name": "copy_on_loan",
+          "value": "true"
+        },
+        {
+          "name": "fine_owed",
+          "value": "false"
+        },
+        {
+          "name": "loan_overdue",
+          "value": "false"
+        },
+        {
+          "name": "loan_days",
+          "value": "1"
+        },
+        {
+          "name": "loan_allowed",
+          "value": "false"
+        },
+        {
+          "name": "renewal_allowed",
+          "value": "false"
+        },
+        {
+          "name": "reminder_sent",
+          "value": "false"
+        },
+        {
+          "name": "loan_closed",
+          "value": "false"
+        }
+      ],
+      "keeps": [
+        "R2"
+      ],
+      "breaks": "R3",
+      "fix": "Suggested fix: ask which requirement should win. To keep R2, remove R3. To keep R3, remove R2.",
+      "repairs": [
+        {
+          "kind": "drop",
+          "id": "R2",
+          "text": "One repair is to drop R2 and keep R3 as written.",
+          "sentence": "While the copy is out on loan, when a member asks to take a copy home, the Fall Desk shall allow the loan."
+        },
+        {
+          "kind": "drop",
+          "id": "R3",
+          "text": "One repair is to drop R3 and keep R2 as written.",
+          "sentence": "While the copy is out on loan, when a member asks to take a copy home, the Fall Desk shall not allow the loan."
+        }
+      ]
+    },
+    {
+      "ids": [
+        "R5",
+        "R6"
+      ],
+      "minimal": true,
+      "everySituation": false,
+      "summary": "R5 and R6 cannot both hold.",
+      "clash": "They clash when not a member asks to take a copy home, a member asks to renew a copy, not a member brings a copy back, the copy was not in the building, the copy was not out on loan, a fine was owed, the loan was not overdue, and the loan length was 1.",
+      "requirements": [
+        {
+          "id": "R5",
+          "line": 20,
+          "sentence": "While a fine is owed, when a member asks to renew a copy, the Fall Desk shall not allow the renewal."
+        },
+        {
+          "id": "R6",
+          "line": 21,
+          "sentence": "While a fine is owed, when a member asks to renew a copy, the Fall Desk shall allow the renewal."
+        }
+      ],
+      "situation": [
+        {
+          "name": "borrow_requested",
+          "value": "false"
+        },
+        {
+          "name": "renew_requested",
+          "value": "true"
+        },
+        {
+          "name": "copy_returned",
+          "value": "false"
+        },
+        {
+          "name": "copy_in_building",
+          "value": "false"
+        },
+        {
+          "name": "copy_on_loan",
+          "value": "false"
+        },
+        {
+          "name": "fine_owed",
+          "value": "true"
+        },
+        {
+          "name": "loan_overdue",
+          "value": "false"
+        },
+        {
+          "name": "loan_days",
+          "value": "1"
+        }
+      ],
+      "requires": [
+        {
+          "id": "R5",
+          "text": "that the renewal was not allowed"
+        },
+        {
+          "id": "R6",
+          "text": "that the renewal was allowed"
+        }
+      ],
+      "example": [
+        {
+          "name": "borrow_requested",
+          "value": "false"
+        },
+        {
+          "name": "renew_requested",
+          "value": "true"
+        },
+        {
+          "name": "copy_returned",
+          "value": "false"
+        },
+        {
+          "name": "copy_in_building",
+          "value": "false"
+        },
+        {
+          "name": "copy_on_loan",
+          "value": "false"
+        },
+        {
+          "name": "fine_owed",
+          "value": "true"
+        },
+        {
+          "name": "loan_overdue",
+          "value": "false"
+        },
+        {
+          "name": "loan_days",
+          "value": "1"
+        },
+        {
+          "name": "loan_allowed",
+          "value": "false"
+        },
+        {
+          "name": "renewal_allowed",
+          "value": "false"
+        },
+        {
+          "name": "reminder_sent",
+          "value": "false"
+        },
+        {
+          "name": "loan_closed",
+          "value": "false"
+        }
+      ],
+      "keeps": [
+        "R5"
+      ],
+      "breaks": "R6",
+      "fix": "Suggested fix: ask which requirement should win. To keep R5, remove R6. To keep R6, remove R5.",
+      "repairs": [
+        {
+          "kind": "drop",
+          "id": "R5",
+          "text": "One repair is to drop R5 and keep R6 as written.",
+          "sentence": "While a fine is owed, when a member asks to renew a copy, the Fall Desk shall allow the renewal."
+        },
+        {
+          "kind": "drop",
+          "id": "R6",
+          "text": "One repair is to drop R6 and keep R5 as written.",
+          "sentence": "While a fine is owed, when a member asks to renew a copy, the Fall Desk shall not allow the renewal."
+        }
+      ]
+    }
+  ],
+  "gaps": [
+    {
+      "output": "loan_allowed",
+      "situation": [
+        {
+          "name": "borrow_requested",
+          "value": "true"
+        },
+        {
+          "name": "renew_requested",
+          "value": "true"
+        },
+        {
+          "name": "copy_returned",
+          "value": "true"
+        },
+        {
+          "name": "copy_in_building",
+          "value": "false"
+        },
+        {
+          "name": "copy_on_loan",
+          "value": "false"
+        },
+        {
+          "name": "fine_owed",
+          "value": "true"
+        },
+        {
+          "name": "loan_overdue",
+          "value": "true"
+        },
+        {
+          "name": "loan_days",
+          "value": "21"
+        }
+      ],
+      "text": "Nothing says whether the loan was allowed when a member asks to take a copy home, a member asks to renew a copy, a member brings a copy back, the copy was not in the building, the copy was not out on loan, a fine was owed, the loan was overdue, and the loan length was 21. Suggested fix: add a requirement for this situation, and ask what the system shall do. Do not choose the response."
+    },
+    {
+      "output": "renewal_allowed",
+      "situation": [
+        {
+          "name": "borrow_requested",
+          "value": "true"
+        },
+        {
+          "name": "renew_requested",
+          "value": "false"
+        },
+        {
+          "name": "copy_returned",
+          "value": "true"
+        },
+        {
+          "name": "copy_in_building",
+          "value": "true"
+        },
+        {
+          "name": "copy_on_loan",
+          "value": "true"
+        },
+        {
+          "name": "fine_owed",
+          "value": "true"
+        },
+        {
+          "name": "loan_overdue",
+          "value": "true"
+        },
+        {
+          "name": "loan_days",
+          "value": "21"
+        }
+      ],
+      "text": "Nothing says whether the renewal was allowed when a member asks to take a copy home, not a member asks to renew a copy, a member brings a copy back, the copy was in the building, the copy was out on loan, a fine was owed, the loan was overdue, and the loan length was 21. Suggested fix: add a requirement for this situation, and ask what the system shall do. Do not choose the response."
+    },
+    {
+      "output": "reminder_sent",
+      "situation": [
+        {
+          "name": "borrow_requested",
+          "value": "true"
+        },
+        {
+          "name": "renew_requested",
+          "value": "true"
+        },
+        {
+          "name": "copy_returned",
+          "value": "true"
+        },
+        {
+          "name": "copy_in_building",
+          "value": "true"
+        },
+        {
+          "name": "copy_on_loan",
+          "value": "true"
+        },
+        {
+          "name": "fine_owed",
+          "value": "true"
+        },
+        {
+          "name": "loan_overdue",
+          "value": "false"
+        },
+        {
+          "name": "loan_days",
+          "value": "21"
+        }
+      ],
+      "text": "Nothing says whether a reminder was sent when a member asks to take a copy home, a member asks to renew a copy, a member brings a copy back, the copy was in the building, the copy was out on loan, a fine was owed, the loan was not overdue, and the loan length was 21. Suggested fix: add a requirement for this situation, and ask what the system shall do. Do not choose the response."
+    }
+  ],
+  "misuse": [],
+  "wording": [
+    {
+      "line": 19,
+      "word": "not",
+      "kind": "negation",
+      "text": "The trigger is a bare negation. Write a positive condition, such as \"When a non-member asks\", or declare a positive event.",
+      "context": "When not a member asks to take a copy home, the Fall Desk shall not allow the loan."
+    },
+    {
+      "line": 27,
+      "word": "not",
+      "kind": "negation",
+      "text": "The trigger is a bare negation. Write a positive condition, such as \"When a non-member asks\", or declare a positive event.",
+      "context": "When not a member brings a copy back, the Fall Desk shall not close the loan."
+    }
+  ],
+  "redundant": [
+    {
+      "id": "R11",
+      "line": 26,
+      "sentence": "When a member brings a copy back and the loan is overdue, the Fall Desk shall close the loan.",
+      "text": "R11 adds nothing. Whenever the requirements outside a conflict hold, R11 holds too.",
+      "fix": "Suggested fix: remove R11, or ask whether it was meant to say something the others do not already require. Do not delete it until the PM agrees."
+    }
+  ],
+  "duplicate": [],
+  "vacuous": [
+    {
+      "id": "R9",
+      "line": 24,
+      "sentence": "When a member asks to take a copy home and the loan length is at least 40, the Fall Desk shall allow the loan.",
+      "text": "R9 can never trigger. Its condition is impossible for every allowed value.",
+      "fix": "Suggested fix: rewrite the condition in R9 so a real situation can make it true, or remove the requirement. Do not invent a response."
+    }
+  ],
+  "unused": []
+}

package/examples/plan-to-problems/plan.md

@@ -0,0 +1,5 @@
+The fall desk rules for the public library need to be settled before we build anything. A member can ask to take a copy home, renew a copy they already have, or bring a copy back. Loans are only 1 to 21 days, and those are the only lengths the desk will set. If a member asks for a copy and that copy is still in the building, let them take it home. If they ask for a copy that is already out on loan, do not lend it. I changed my mind on that last point: if they ask for a copy that is already out on loan, lend it anyway. If nobody is asking to borrow, do not open a loan.
+
+If a member still owes a fine, do not let them renew. Also, if a member still owes a fine, let them renew. If they do not owe a fine, renewals are allowed. After a loan passes its due date, send the member a reminder. If someone asks to keep a copy for 40 days or longer, allow that loan. If a member brings a copy back, close the loan. If a member brings a copy back and the loan is already overdue, close the loan as well. If the copy has not come back, leave the loan open.
+
+Staff need a clear answer on whether the loan was allowed, whether the renewal was allowed, whether a reminder went out, and whether the loan was closed. This quarter covers only those desk decisions. We are not adding holds, extra fees, or a new catalog.

package/examples/plan-to-problems/planted.txt

@@ -0,0 +1,5 @@
+conflict R2 R3
+conflict R5 R6
+gap reminder_sent
+vacuous R9
+redundant R11