notes in haskell now actually compile

1 files changed, 50 insertions, 29 deletions

diff --git a/types.hs b/types.hs
index 0021599..c151d89 100644
--- a/types.hs
+++ b/types.hs
@@ -1,12 +1,9 @@
-
--- Invite a user by email address.
--- Records the username of the inviting user and the time of the
--- request.
-data CreateInvitation = CreateInvitation Username Email UTCTime
-createInvitation (CreateInvitation u e t) = do
-    x...
-type Username = Text
-data User = User UserID Username
+{-# OPTIONS_GHC -Wall -Wno-unused-top-binds -Wno-unused-matches -Wno-missing-signatures #-}
+type Text = String
+type UUID = Text
+type UserID = Int
+type UTCTime = ()
+type EmailAddress = ()
 
 -- These ID types use a type parameter "trick." The type parameter is
 -- instantiated twice; once with () for its id field type, and once with an
@@ -14,15 +11,24 @@ data User = User UserID Username
 -- represent database field inputs; and the "indexed" version to represent
 -- corresponding outputs.
 
-newtype UserAccountID   = UserAccountID   UserID
-newtype SheetID         = SheetID         (UserID, Integer)
+type UserAccountID = UserID
+newtype SheetID         = SheetID         (UserAccountID, Integer)
 newtype SignupCodeID    = SignupCodeID    Text -- short code for typing
 newtype InvitationID    = InvitationID    UUID
 newtype PasswordResetID = PasswordResetID UUID
 
+data PasswordReset' id = PasswordReset'
+  { passwordResetID           :: id
+  , passwordResetSharedSecret :: Text
+  , passwordResetUserAccount  :: UserAccount
+  , passwordResetCreationTime :: UTCTime
+  }
+type CreatePasswordReset = PasswordReset' ()
+type PasswordReset = PasswordReset' UserID
+
 data UserAccount' id = UserAccount'
   { userAccountID           :: id
-  , userAccountInvitation   :: Invitation' InvitationID -- Contains inviter
+  , userAccountInvitationID :: InvitationID
   , userAccountEmail        :: EmailAddress
   , userAccountCreationTime :: UTCTime
   }
@@ -35,47 +41,62 @@ type UserAccount = UserAccount' UserID
 -- be submitted with the InvitationID to initiate the password reset in
 -- the browser.
 
-data Provenance = ProvenanceSheet Sheet | ProvenanceUser User
+data Provenance = ProvenanceSheet SheetID | ProvenanceUser UserAccountID
 data Invitation' id = Invitation'
   { invitationID           :: id
   , invitationCreationTime :: UTCTime
-  , invitationEmailAddress :: EmailAddress -- invited user
+  , invitationEmailAddress :: EmailAddress -- invited address
   , invitationProvenance   :: Provenance   -- inviting user
   }
+-- data CreateInvitation = CreateInvitation Username Email UTCTime
 type CreateInvitation = Invitation' ()
 type       Invitation = Invitation' UUID
+
 createInvitation :: CreateInvitation -> m Invitation
-createInvitation (CreateInvitation () t e (ProvenanceSheet s) = do
-createInvitation (CreateInvitation () t e (ProvenanceUser  u) = do
-  -- validate inviting user/sheet
-  -- record invitation code and shared secret in database
-  -- send email containing shared secret
-
--- signupcodes can be used to create self-invitations. the user must
--- supply a signupcode and their email address. a secret code will be
+createInvitation (Invitation' () t e (ProvenanceSheet s)) = undefined
+createInvitation (Invitation' () t e (ProvenanceUser  u)) = undefined
+
+-- Invite a user by email address.
+-- Records the username of the inviting user and the time of the
+-- request.
+--  * Validate inviting user/sheet.
+--  * Record invitation code and shared secret in database.
+--  * Send email containing shared secret.
+
+-- Signupcodes can be used to create self-invitations. The user must
+-- supply a signupcode and their email address. A shared secret will be
 -- sent to the email address.
 data SignupCode' id = SignupCode'
   { signupCodeID      :: id
   , signupCodeSheetID :: Sheet
   }
 type CreateSignupCode = SignupCode' ()
-type       SignupCode = SignupCode' SignupCodeCode
+type       SignupCode = SignupCode' SignupCodeID
 createSignupCode :: CreateSignupCode -> SignupCode
+createSignupCode = undefined
 
+-- ## Sheet' ##
 -- A sheet containing signupcodes.
--- The signupcodes link up to their creating sheet. Since the real purpose is to
+--
+-- The signupcodes link back to their creating sheet.
+-- Signupcodes are converted to Invitations
+
 -- get the Username, it is kept as a Sheet rather than SheetID. If the username
--- changes for the UserID then we have retained a record of the inviting
--- username at the time.
+-- changes for the UserID then we retain a record of the inviting username at
+-- the time. The UserID itself is stored as part of the index of the Sheet so it
+-- is not stored a second time along with the UserAccount data record.
+
 data Sheet' id = Sheet'
   { sheetID           :: id
-  , sheetCreator      :: UserAccount' () -- Stores the data! Not the database record ID!
+  , sheetCreator      :: UserAccount' () -- Stores the data, but not the database
+                                         -- record ID, which is stored in the
+                                         -- sheetID.
   , sheetCreationTime :: UTCTime
   }
 type CreateSheet = Sheet' ()
 type Sheet       = Sheet' SheetID
-type SheetID     = UUID
 createSheet :: CreateSheet -> m Sheet
+createSheet = undefined
 
 
 
@@ -92,7 +113,7 @@ createSheet :: CreateSheet -> m Sheet
 
 
 
-
+main = undefined
 
 -- The browser is expected to generate a secure password that will be
 -- stored within the browser. Do not re-use passwords! Password re-use