Add more comments to TSN.XML.EarlyLine.

Remove earlylineXML.dtd from the TODO.
Add earlylineXML.dtd to the man page as a supported type.
Bump version in the cabal file.

diff --git a/doc/TODO b/doc/TODO
index b399605601343013e70805b5cd886f4c0c306aa7..01caafd59abac4420be1af5390501d956cec58ca 100644 (file)
--- a/doc/TODO
+++ b/doc/TODO
@@ -36,7 +36,6 @@
    * CBATeamScheduleXML
    * CFLTeamScheduleXML
    * CFLTotalTeamScheduleXML
-   * earlylineXML
    * Minor_Baseball_TeamScheduleXML
    * MinorLeagueHockeyTeamScheduleXML
    * MLB_Boxscore_XML

diff --git a/doc/man1/htsn-import.1 b/doc/man1/htsn-import.1
index 9c76165a4768f8d24f0418c85261438d42a503ea..66f7ae5d1e769b23357f9fcdea9aaf1beb69cc83 100644 (file)
--- a/doc/man1/htsn-import.1
+++ b/doc/man1/htsn-import.1
@@ -579,6 +579,8 @@ AutoRacingResultsXML.dtd
 .IP \[bu]
 Auto_Racing_Schedule_XML.dtd
 .IP \[bu]
+earlylineXML.dtd
+.IP \[bu]
 Heartbeat.dtd
 .IP \[bu]
 Injuries_Detail_XML.dtd

diff --git a/htsn-import.cabal b/htsn-import.cabal
index d1e184c463e18329d41b5651efebd90fee3bcdc6..e7d2940ba993393f90aa46f65d0e712e6bf07b00 100644 (file)
--- a/htsn-import.cabal
+++ b/htsn-import.cabal
@@ -1,5 +1,5 @@
 name:           htsn-import
-version:        0.0.8
+version:        0.0.9
 cabal-version:  >= 1.8
 author:         Michael Orlitzky
 maintainer:    Michael Orlitzky <michael@orlitzky.com>

diff --git a/src/TSN/XML/EarlyLine.hs b/src/TSN/XML/EarlyLine.hs
index 3870eb8d139b59a009fcc58c0cceb746cbaa54e7..4ad9ae2ca0a5f1bc59c9d0b3bb60b71f13f8fa5d 100644 (file)
--- a/src/TSN/XML/EarlyLine.hs
+++ b/src/TSN/XML/EarlyLine.hs
@@ -5,6 +5,11 @@
 {-# LANGUAGE TemplateHaskell #-}
 {-# LANGUAGE TypeFamilies #-}
 
+-- | Parse TSN XML for the DTD \"earlylineXML.dtd\". Each \<message\>
+--   element contains a bunch of \<date\>s, and those \<date\>s
+--   contain a single \<game\>. In the database, we merge the date
+--   info into the games, and key the games to the messages.
+--
 module TSN.XML.EarlyLine (
   dtd,
   pickle_message,
@@ -100,7 +105,7 @@ data Message =
     xml_category :: String,
     xml_sport :: String,
     xml_title :: String,
-    xml_dates :: [EarlyLineDateXml],
+    xml_dates :: [EarlyLineDate],
     xml_time_stamp :: UTCTime }
   deriving (Eq, Show)
 
@@ -135,18 +140,18 @@ instance XmlImport Message
 
 
 
--- * EarlyLineDateXml
+-- * EarlyLineDate
 
 -- | XML representation of a \<date\>. It has a \"value\" attribute
 --   containing the actual date string. As children it contains a
 --   (non-optional) note, and a game. The note and date value are
 --   properties of the game as far as I can tell.
 --
-data EarlyLineDateXml =
-  EarlyLineDateXml {
-    xml_date_value :: UTCTime,
-    xml_note :: String,
-    xml_game :: EarlyLineGameXml }
+data EarlyLineDate =
+  EarlyLineDate {
+    date_value :: UTCTime,
+    date_note :: String,
+    date_game :: EarlyLineGameXml }
   deriving (Eq, Show)
 
 
@@ -182,18 +187,27 @@ data EarlyLineGameTeam =
   deriving (Eq, Show)
 
 
-date_to_game :: (DefaultKey EarlyLine) -> EarlyLineDateXml -> EarlyLineGame
+-- | Convert an 'EarlyLineDate' into an 'EarlyLineGame'. Each date has
+--   exactly one game, and the fields that belong to the date should
+--   really be in the game anyway. So the database representation of a
+--   game has the combined fields of the XML date/game.
+--
+--   This function gets the game out of a date, and then sticks the
+--   date value and note inside the game. It also adds the foreign key
+--   reference to the game's parent message, and returns the result.
+--
+date_to_game :: (DefaultKey EarlyLine) -> EarlyLineDate -> EarlyLineGame
 date_to_game fk date =
   EarlyLineGame {
     db_early_lines_id = fk,
     db_game_time = combined_date_time,
-    db_note = (xml_note date),
-    db_away_team = xml_away_team (xml_game date),
-    db_home_team = xml_home_team (xml_game date),
-    db_over_under = xml_over_under (xml_game date) }
+    db_note = (date_note date),
+    db_away_team = xml_away_team (date_game date),
+    db_home_team = xml_home_team (date_game date),
+    db_over_under = xml_over_under (date_game date) }
   where
-    date_part = xml_date_value date
-    time_part = xml_game_time (xml_game date)
+    date_part = date_value date
+    time_part = xml_game_time (date_game date)
     combined_date_time = UTCTime (utctDay date_part) (utctDayTime time_part)
 
 --
@@ -268,6 +282,10 @@ mkPersist tsn_codegen_config [groundhog|
 --
 -- * Pickling
 --
+
+
+-- | Pickler for the top-level 'Message'.
+--
 pickle_message :: PU Message
 pickle_message =
   xpElem "message" $
@@ -289,7 +307,10 @@ pickle_message =
                   xml_dates m,
                   xml_time_stamp m)
 
-pickle_date :: PU EarlyLineDateXml
+
+-- | Pickler for the \<date\> elements within each \<message\>.
+--
+pickle_date :: PU EarlyLineDate
 pickle_date =
   xpElem "date" $
     xpWrap (from_tuple, to_tuple) $
@@ -297,10 +318,13 @@ pickle_date =
              (xpElem "note" xpText)
              pickle_game
   where
-    from_tuple = uncurryN EarlyLineDateXml
-    to_tuple m = (xml_date_value m, xml_note m, xml_game m)
+    from_tuple = uncurryN EarlyLineDate
+    to_tuple m = (date_value m, date_note m, date_game m)
 
 
+
+-- | Pickler for the \<game\> element within each \<date\>.
+--
 pickle_game :: PU EarlyLineGameXml
 pickle_game =
   xpElem "game" $
@@ -318,12 +342,26 @@ pickle_game =
 
 
 
+-- | Pickle an away team (\<teamA\>) element within a \<game\>. Most
+--   of the work (common with the home team pickler) is done by
+--   'pickle_team'.
+--
 pickle_away_team :: PU EarlyLineGameTeam
 pickle_away_team = xpElem "teamA" pickle_team
 
+
+-- | Pickle a home team (\<teamH\>) element within a \<game\>. Most
+--   of the work (common with theaway team pickler) is done by
+--   'pickle_team'.
+--
 pickle_home_team :: PU EarlyLineGameTeam
 pickle_home_team = xpElem "teamH" pickle_team
 
+
+-- | Team pickling common to both 'pickle_away_team' and
+--   'pickle_home_team'. Handles everything inside the \<teamA\> and
+--   \<teamH\> elements.
+--
 pickle_team :: PU EarlyLineGameTeam
 pickle_team =
   xpWrap (from_tuple, to_tuple) $