Modulemilestone-dsl-0.1.0GHC2024

Milestone.Effects

The milestone theory, and the scope a milestone program is elaborated in: its export list is the verb table and the values the verbs speak, so a program needs this module and Prelude and nothing else. A program over Milestones only describes what it does to the forge's plans; an interpreter decides what that means, purely (Milestone.Pure) or over a forge's store.

7 types
17 values

Packagemilestone-dsl-0.1.0
Exports24
LanguageGHC2024
LicenceMIT
SourceEffects.hs

datadata Milestones (m :: Type -> Type) a where

CreateMilestone :: String -> String -> Maybe Due -> Milestones m MilestonecreateMilestone
title, markdown description, due date: a new open milestone with no members, under the next free id. A blank title is refused.
EditMilestone :: MilestoneId -> String -> String -> Maybe Due -> Milestones m MilestoneeditMilestone
Rewrites the title, description and due date, closed or open; membership, state, author and creation time stay as they were.
CloseMilestone :: MilestoneId -> Milestones m ()closeMilestone
Idempotent.
ReopenMilestone :: MilestoneId -> Milestones m ()reopenMilestone
Idempotent.
ListMilestones :: Milestones m [Milestone]listMilestones
Every milestone, in id order.
GetMilestone :: MilestoneId -> Milestones m (Maybe Milestone)getMilestone
Nothing for an id no milestone has; every other verb that names a milestone refuses such an id.
Assign :: Ref -> MilestoneId -> Milestones m ()assign
Makes the ref a member. Members are a set, so assigning a member again changes nothing. A closed milestone refuses.
Unassign :: Ref -> MilestoneId -> Milestones m ()unassign
Unassigning a ref that is not a member changes nothing. A closed milestone refuses.
Complete :: Ref -> Milestones m ()complete
Marks a ref done in every milestone, closed ones included, now and when it is assigned later. A forge derives this from the issue or merge request instead.
Uncomplete :: Ref -> Milestones m ()uncomplete
Progress :: MilestoneId -> Milestones m Tallyprogress
The milestone's Tally: tallyDone of its tallyTotal members are done. Counts rather than a ratio, so "none of three" and "no members" differ; milestoneShare gives the share.

valuecreateMilestone

:: Member Milestones r
=> String
-> String
-> Maybe Due
-> Sem r Milestone

title, markdown description, due date: a new open milestone with no members, under the next free id. A blank title is refused.

valueeditMilestone

:: Member Milestones r
=> MilestoneId
-> String
-> String
-> Maybe Due
-> Sem r Milestone

Rewrites the title, description and due date, closed or open; membership, state, author and creation time stay as they were.

valuecloseMilestone :: Member Milestones r => MilestoneId -> Sem r ()

Idempotent.

valuereopenMilestone :: Member Milestones r => MilestoneId -> Sem r ()

Idempotent.

valuelistMilestones :: Member Milestones r => Sem r [Milestone]

Every milestone, in id order.

valuegetMilestone

Nothing for an id no milestone has; every other verb that names a milestone refuses such an id.

valueassign :: Member Milestones r => Ref -> MilestoneId -> Sem r ()

Makes the ref a member. Members are a set, so assigning a member again changes nothing. A closed milestone refuses.

valueunassign :: Member Milestones r => Ref -> MilestoneId -> Sem r ()

Unassigning a ref that is not a member changes nothing. A closed milestone refuses.

valuecomplete :: Member Milestones r => Ref -> Sem r ()

Marks a ref done in every milestone, closed ones included, now and when it is assigned later. A forge derives this from the issue or merge request instead.

valueuncomplete :: Member Milestones r => Ref -> Sem r ()

from Uncomplete

valueprogress :: Member Milestones r => MilestoneId -> Sem r Tally

The milestone's Tally: tallyDone of its tallyTotal members are done. Counts rather than a ratio, so "none of three" and "no members" differ; milestoneShare gives the share.

Values

12 declarations

datadata Milestone

A milestone as it crosses the wire. milestoneDone is the members that are done, so it is a subset of milestoneMembers; neither repeats a ref.

Constructors

MkMilestone
- milestoneId :: MilestoneId
- milestoneTitle :: String
- milestoneDescription :: String
- milestoneDue :: Maybe Due
- milestoneState :: MilestoneState
- milestoneAuthor :: String
- milestoneCreated :: String
- milestoneMembers :: [Ref]
- milestoneDone :: [Ref]

Instances3Eq, Read, Show

Eq MilestoneDefined in milestone-dsl-0.1.0 · Milestone.Types
Read MilestoneDefined in milestone-dsl-0.1.0 · Milestone.Types
Show MilestoneDefined in milestone-dsl-0.1.0 · Milestone.Types

newtypenewtype MilestoneId

A milestone's number, forge-wide.

Constructors

MilestoneId
- fromMilestoneId :: Int

Instances4Eq, Ord, Read, Show

Eq MilestoneIdDefined in milestone-dsl-0.1.0 · Milestone.Types
Ord MilestoneIdDefined in milestone-dsl-0.1.0 · Milestone.Types
Read MilestoneIdDefined in milestone-dsl-0.1.0 · Milestone.Types
Show MilestoneIdDefined in milestone-dsl-0.1.0 · Milestone.Types

datadata MilestoneState

MilestoneOpen MilestoneClosed

Instances6Bounded, Enum, Eq, Ord, Read, Show

Bounded MilestoneStateDefined in milestone-dsl-0.1.0 · Milestone.Types
Enum MilestoneStateDefined in milestone-dsl-0.1.0 · Milestone.Types
Eq MilestoneStateDefined in milestone-dsl-0.1.0 · Milestone.Types
Ord MilestoneStateDefined in milestone-dsl-0.1.0 · Milestone.Types
Read MilestoneStateDefined in milestone-dsl-0.1.0 · Milestone.Types
Show MilestoneStateDefined in milestone-dsl-0.1.0 · Milestone.Types

datadata Tally

How far a milestone has got: tallyDone of its tallyTotal members are done. Counts rather than a ratio, so "none of three" and "no members" are different answers and a reader can print "2 of 5".

Constructors

MkTally
- tallyDone :: Int
- tallyTotal :: Int

Instances3Eq, Read, Show

Eq TallyDefined in milestone-dsl-0.1.0 · Milestone.Types
Read TallyDefined in milestone-dsl-0.1.0 · Milestone.Types
Show TallyDefined in milestone-dsl-0.1.0 · Milestone.Types

newtypenewtype Ref

An issue (ns/proj#N) or a merge request (ns/proj!N), the namespace possibly nested (package-setshaskellx#3). Built only by parseRef, makeRef, ref or a string literal, so a ref always names something a forge could hold. No record field: an update through one would skip the check.

Instances5Eq, Ord, Read, Show, IsString

Eq RefDefined in milestone-dsl-0.1.0 · Milestone.Types
Ord RefDefined in milestone-dsl-0.1.0 · Milestone.Types
Read RefDefined in milestone-dsl-0.1.0 · Milestone.Types
Show RefDefined in milestone-dsl-0.1.0 · Milestone.Types
Shown as its string literal; read back through parseRef, so a malformed ref cannot cross the wire.
IsString RefDefined in milestone-dsl-0.1.0 · Milestone.Types

valuefromRef :: Ref -> String

valueparseRef :: String -> Maybe Ref

Accepts exactly NS/PROJ#N and NS/PROJ!N: two or more /-separated names, the marker, and a positive number written without leading zeros, so every ref has one spelling.

valueref :: String -> Ref

The ref a string spells, as a string literal is: partial, an error on a string that is not a ref, so a program written without OverloadedStrings still fails as it is folded, not later.

newtypenewtype Due

A due date, a calendar date written YYYY-MM-DD. Built only by parseDue, due or a string literal, so the 30th of February cannot be due; no record field, for the reason Ref has none.

Instances5Eq, Ord, Read, Show, IsString

Eq DueDefined in milestone-dsl-0.1.0 · Milestone.Types
Ord DueDefined in milestone-dsl-0.1.0 · Milestone.Types
Read DueDefined in milestone-dsl-0.1.0 · Milestone.Types
Show DueDefined in milestone-dsl-0.1.0 · Milestone.Types
Shown as its string literal; read back through parseDue.
IsString DueDefined in milestone-dsl-0.1.0 · Milestone.Types

valuefromDue :: Due -> String

valueparseDue :: String -> Maybe Due

Accepts exactly the YYYY-MM-DD spellings of real dates, the 29th of February in leap years only.

valuedue :: String -> Due

The due date a string spells, as a string literal is: partial, an error on a string that is not a calendar date, as for ref.