From e0fe6c60035c9561154d0238ae7c49e7134abcaa Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Tue, 14 Jan 2014 06:24:22 -0500 Subject: [PATCH] Add docs for Injuries/InjuriesDetail. --- src/TSN/XML/Injuries.hs | 36 +++++++++++++++++++++++++++++++---- src/TSN/XML/InjuriesDetail.hs | 36 ++++++++++++++++++++++++++++++++--- 2 files changed, 65 insertions(+), 7 deletions(-) diff --git a/src/TSN/XML/Injuries.hs b/src/TSN/XML/Injuries.hs index 03f9565..f7eba8d 100644 --- a/src/TSN/XML/Injuries.hs +++ b/src/TSN/XML/Injuries.hs @@ -10,8 +10,9 @@ -- contains a root element \ that in turn contains zero or -- more \s. -- --- The listings will be mapped to a database table called "injuries" --- automatically. The root message is not retained. +-- The listings will be mapped to a database table called +-- \"injuries_listings\" automatically. The root message is not +-- retained. -- module TSN.XML.Injuries ( pickle_message, @@ -21,6 +22,7 @@ module TSN.XML.Injuries ( ListingConstructor(..) ) where +-- System imports. import Data.Data ( Data ) import Data.Typeable ( Typeable ) import Database.Groundhog ( @@ -46,17 +48,23 @@ import Text.XML.HXT.Core ( xpText, xpWrap ) - +-- Local imports. import TSN.DbImport ( DbImport(..), ImportResult(..), run_dbmigrate ) import TSN.XmlImport ( XmlImport(..) ) import Xml ( FromXml(..), pickle_unpickle, unpickleable ) +-- | XML/Database representation of a team as they appear in the +-- injuries documents. +-- data InjuriesTeam = InjuriesTeam { team_name :: String, team_league :: Maybe String } deriving (Data, Eq, Show, Typeable) + +-- | XML/Database representation of the injury listings. +-- data Listing = Listing { team :: InjuriesTeam, @@ -65,12 +73,23 @@ data Listing = updated :: Maybe Bool } deriving (Eq, Show) + instance FromXml Listing where + -- | The DB analogue of a 'Listing' is... itself! type Db Listing = Listing + + -- | To convert between a 'Listing' and a 'Listing', we do nothing. from_xml = id +-- | This lets us call 'insert_xml' on a 'Listing' without having to +-- explicitly convert it to its database analogue first. +-- instance XmlImport Listing + +-- | XML representation of an injuriesxml \. This is only +-- used for (un)pickling; 'Message's are not saved to the database. +-- data Message = Message { xml_file_id :: Int, @@ -78,10 +97,13 @@ data Message = category :: String, sport :: String, listings :: [Listing], - time_stamp :: String } + time_stamp :: String -- ^ Slightly lax, but we don't save it, so who cares. + } deriving (Eq, Show) instance DbImport Message where + -- | We import a 'Message' by inserting all of its 'listings'. + -- dbimport msg = mapM_ insert_xml (listings msg) >> return ImportSucceeded dbmigrate _ = run_dbmigrate $ migrate (undefined :: Listing) @@ -103,6 +125,8 @@ mkPersist defaultCodegenConfig [groundhog| |] +-- | A pickler for 'InjuriesTeam's that can convert them to/from XML. +-- pickle_injuries_team :: PU InjuriesTeam pickle_injuries_team = xpElem "team" $ @@ -113,6 +137,8 @@ pickle_injuries_team = to_tuple m = (team_name m, team_league m) +-- | A pickler for 'Listings's that can convert them to/from XML. +-- pickle_listing :: PU Listing pickle_listing = xpElem "listing" $ @@ -126,6 +152,8 @@ pickle_listing = to_tuple l = (team l, teamno l, injuries l, updated l) +-- | A pickler for 'Message's that can convert them to/from XML. +-- pickle_message :: PU Message pickle_message = xpElem "message" $ diff --git a/src/TSN/XML/InjuriesDetail.hs b/src/TSN/XML/InjuriesDetail.hs index 38e0268..a225cbf 100644 --- a/src/TSN/XML/InjuriesDetail.hs +++ b/src/TSN/XML/InjuriesDetail.hs @@ -13,8 +13,8 @@ -- found within the \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, @@ -24,6 +24,7 @@ module TSN.XML.InjuriesDetail ( PlayerListingConstructor(..) ) where +-- System imports. import Data.Time ( UTCTime ) import Data.Tuple.Curry ( uncurryN ) import Database.Groundhog ( @@ -47,12 +48,16 @@ import Text.XML.HXT.Core ( xpText, 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 \, the main type of +-- element contains in Injuries_Detail_XML messages. +-- data PlayerListing = PlayerListing { team_id :: String, -- ^ TeamIDs are (apparently) three characters long @@ -69,12 +74,24 @@ data PlayerListing = } 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 \ 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. @@ -85,6 +102,9 @@ data Listing = deriving (Eq, Show) +-- | XML representation of the top-level \ element. These +-- are not stored; the data type is used only for parsing. +-- data Message = Message { xml_file_id :: Int, @@ -96,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 @@ -109,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" $ @@ -141,6 +166,8 @@ pickle_player_listing = injury_type pl) +-- | Convert 'Listing's to/from XML. +-- pickle_listing :: PU Listing pickle_listing = xpElem "Listing" $ @@ -153,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" $ @@ -172,6 +201,7 @@ pickle_message = listings m, time_stamp m) + -- -- Tasty Tests -- -- 2.44.2