-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A library for parsing a chat-based work hour reporting scheme.
--   
--   Parses a certain format for hour and task reporting in chat/Slack
--   form. See README for format.
@package work-time
@version 0.1.2.0


-- | Main API for <a>WorkTime</a>. This re-exports all functions meant to
--   be used.
module WorkTime

-- | Main data type of the library. Represents an entry in Slack containing
--   a nickname, timestamp, datestamp and <tt>WorkDay</tt> that themselves
--   contain several task descriptions.
--   
--   An entire entry will look as follows:
--   
--   <pre>
--   Rickard Andersson [11:16 PM]
--   [28.02] 8.5h
--   worked on missile guidance system
--   cleaned up parsing code
--   </pre>
--   
--   The first part is represented by a <a>MessageLine</a> and what follows
--   is one <a>Workday</a> in this example.
--   
--   An entry can also look as follows:
--   
--   <pre>
--   Rickard Andersson [11:16 PM]
--   [28.02] 8.5h
--   worked on missile guidance system
--   cleaned up parsing code
--   [01.03] 6h
--   fixed critical bug in missile guidance system
--   removed half of parsing code
--   </pre>
--   
--   In this example we have several <a>Workday</a> in one <a>WorkTime</a>.
data WorkTime
WorkTime :: MessageLine -> [Workday] -> WorkTime

-- | Represents a line like <tt>Rickard Andersson [10:48 AM]</tt> in Slack.
data MessageLine

-- | Represents a collection of lines like
--   
--   <pre>
--   [28.02] 8.5h
--   worked on missile guidance system
--   cleaned up parsing code
--   </pre>
--   
--   in Slack.
data Workday

-- | Parses a <a>Text</a> either into a [<a>WorkTime</a>] or into an error
--   message in the form of a <a>String</a>. The error message may be less
--   than informative as it comes straight from the parser
--   (<a>Text.Megaparsec</a>).
fromText :: Text -> Either (ParseError (Token Text) Void) [WorkTime]

-- | Parses the <a>Text</a> in a file and returns either a
--   [<a>WorkTime</a>] or an error message in the form of a <a>String</a>.
--   The error message may be less than informative as it come straight
--   from the parser (<a>Text.Megaparsec</a>).
fromFile :: FilePath -> IO (Either (ParseError (Token Text) Void) [WorkTime])

-- | Extracts the total work hours from a <a>WorkTime</a> entry, from all
--   workdays in the entry.
workTimeHours :: WorkTime -> Double

-- | Extracts the nickname from a <a>WorkTime</a> entry.
workTimeNickname :: WorkTime -> Text

-- | Takes a text and turns it into a list of a nickname (<a>Text</a>) and
--   work hours (<a>Double</a>).
hoursFromText :: Text -> Either (ParseError (Token Text) Void) [(Text, Double)]

-- | Takes a <a>FilePath</a> and reads the <a>Text</a> in the file, from
--   which it then parses a list of <tt>[(<a>Text</a>, <a>Double</a>)]</tt>
--   which represent a nickname and the parsed total amount of hours they
--   have worked.
hoursFromFile :: FilePath -> IO (Either (ParseError (Token Text) Void) [(Text, Double)])

-- | Takes a list of <a>WorkTime</a> and creates a map of nickname
--   (<a>Text</a>) to work hours (<a>Double</a>).
hours :: [WorkTime] -> Map Text Double