Add docs for Injuries/InjuriesDetail.

[dead/htsn-import.git] / src / TSN / XML / InjuriesDetail.hs

diff --git a/src/TSN/XML/InjuriesDetail.hs b/src/TSN/XML/InjuriesDetail.hs
index c06768ed554c2f9aa399afd948f23838f79ace62..a225cbf8db1e32faaf830a100b9789d644f3edf5 100644 (file)
--- a/src/TSN/XML/InjuriesDetail.hs
+++ b/src/TSN/XML/InjuriesDetail.hs
@@ -13,14 +13,18 @@
 --   found within the \<PlayerListing\>s.
 --
 --   The player listings will be mapped to a database table called
---   "injuries_detail" automatically. The root "message" and "listing"
---   are not retained.
+--   \"injuries_detail_player_listings\" automatically. The root
+--   \"message\" and \"listing\" are not retained.
 --
 module TSN.XML.InjuriesDetail (
+  pickle_message,
+  -- * Tests
   injuries_detail_tests,
-  pickle_message )
+  -- * WARNING: these are private but exported to silence warnings
+  PlayerListingConstructor(..) )
 where
 
+-- System imports.
 import Data.Time ( UTCTime )
 import Data.Tuple.Curry ( uncurryN )
 import Database.Groundhog (
@@ -39,17 +43,21 @@ import Text.XML.HXT.Core (
   xpElem,
   xpInt,
   xpList,
+  xpOption,
   xpPrim,
   xpText,
-  xpText0,
   xpWrap )
 
+-- Local imports.
 import TSN.Picklers( xp_date, xp_team_id )
 import TSN.DbImport ( DbImport(..), ImportResult(..), run_dbmigrate )
 import TSN.XmlImport ( XmlImport(..) )
 import Xml ( FromXml(..), pickle_unpickle, unpickleable )
 
 
+-- | Database representation of a \<PlayerListing\>, the main type of
+--   element contains in Injuries_Detail_XML messages.
+--
 data PlayerListing =
   PlayerListing {
     team_id   :: String, -- ^ TeamIDs are (apparently) three characters long
@@ -60,18 +68,30 @@ data PlayerListing =
     name      :: String,
     injury    :: String,
     status    :: String,
-    fantasy   :: String, -- ^ Nobody knows what this is.
+    fantasy   :: Maybe String, -- ^ Nobody knows what this is.
     injured     :: Bool,
     injury_type :: String -- ^ "type" is a reserved keyword so we can't use it
     }
   deriving (Eq, Show)
 
+
 instance FromXml PlayerListing where
+  -- | The DB analogue of a 'PlayerListing' is... itself!
   type Db PlayerListing = PlayerListing
+
+    -- | To convert between a 'PlayerListing' and a 'PlayerListing',
+    --   we do nothing.
   from_xml = id
 
+-- | This lets us call 'insert_xml' on a 'PlayerListing' without
+--   having to explicitly convert it to its database analogue first.
+--
 instance XmlImport PlayerListing
 
+
+-- | XML incarnation of a \<Listing\> element. We don't store these;
+--   the data type is used only for parsing.
+--
 data Listing =
   Listing {
     listing_team_id :: String -- ^ Avoid conflict with PlayerListing's team_id.
@@ -82,6 +102,9 @@ data Listing =
   deriving (Eq, Show)
 
 
+-- | XML representation of the top-level \<message\> element. These
+--   are not stored; the data type is used only for parsing.
+--
 data Message =
   Message {
     xml_file_id :: Int,
@@ -93,12 +116,15 @@ data Message =
   deriving (Eq, Show)
 
 instance DbImport Message where
+  -- | To import a 'Message', we import all of its 'PlayerListing's,
+  --   which we have to dig out of its 'Listing's.
   dbimport msg = do
     mapM_ insert_xml (concatMap player_listings $ listings msg)
     return ImportSucceeded
 
   dbmigrate _ = run_dbmigrate $ migrate (undefined :: PlayerListing)
 
+
 mkPersist defaultCodegenConfig [groundhog|
 - entity: PlayerListing
   dbName: injuries_detail_player_listings
@@ -106,10 +132,12 @@ mkPersist defaultCodegenConfig [groundhog|
     - name: PlayerListing
       fields:
         - name: team_id
-          type: varchar(3)
+          type: varchar(3) # We've only seen 3... so far.
 |]
 
 
+-- | Convert 'PlayerListing's to/from XML.
+--
 pickle_player_listing :: PU PlayerListing
 pickle_player_listing =
   xpElem "PlayerListing" $
@@ -121,7 +149,7 @@ pickle_player_listing =
               (xpElem "Name" xpText)
               (xpElem "Injury" xpText)
               (xpElem "Status" xpText)
-              (xpElem "Fantasy" xpText0)
+              (xpElem "Fantasy" $ xpOption xpText)
               (xpElem "Injured" xpPrim)
               (xpElem "Type" xpText)
   where
@@ -138,6 +166,8 @@ pickle_player_listing =
                    injury_type pl)
 
 
+-- | Convert 'Listing's to/from XML.
+--
 pickle_listing :: PU Listing
 pickle_listing =
   xpElem "Listing" $
@@ -150,6 +180,8 @@ pickle_listing =
     to_tuple l = (listing_team_id l, full_name l, player_listings l)
 
 
+-- | Convert 'Message's to/from XML.
+--
 pickle_message :: PU Message
 pickle_message =
   xpElem "message" $
@@ -170,7 +202,12 @@ pickle_message =
                   time_stamp m)
 
 
--- * Tasty Tests
+--
+-- Tasty Tests
+--
+
+-- | A list of all tests for this module.
+--
 injuries_detail_tests :: TestTree
 injuries_detail_tests =
   testGroup
@@ -179,8 +216,10 @@ injuries_detail_tests =
       test_unpickle_succeeds ]
 
 
--- | Warning, succeess of this test does not mean that unpickling
---   succeeded.
+-- | If we unpickle something and then pickle it, we should wind up
+--   with the same thing we started with. WARNING: succeess of this
+--   test does not mean that unpickling succeeded.
+--
 test_pickle_of_unpickle_is_identity :: TestTree
 test_pickle_of_unpickle_is_identity = testGroup "pickle-unpickle tests"
   [ check "pickle composed with unpickle is the identity"
@@ -194,6 +233,8 @@ test_pickle_of_unpickle_is_identity = testGroup "pickle-unpickle tests"
       actual @?= expected
 
 
+-- | Make sure we can actually unpickle these things.
+--
 test_unpickle_succeeds :: TestTree
 test_unpickle_succeeds = testGroup "unpickle tests"
   [ check "unpickling succeeds"