]> gitweb.michael.orlitzky.com - dead/htsn-import.git/blobdiff - src/TSN/XML/Odds.hs
Move the FromXmlFkTeams class out of Xml and into TSN.Team.
[dead/htsn-import.git] / src / TSN / XML / Odds.hs
index 934c3d340508f89a3d0c40b770ce49c3fd9e975d..fed7fa11a3fcc6066e3b2eda4c184c0039dba9f5 100644 (file)
@@ -23,6 +23,7 @@ module TSN.XML.Odds (
 where
 
 -- System imports.
+import Control.Applicative ( (<$>) )
 import Control.Monad ( forM_, join )
 import Data.Time ( UTCTime(..) )
 import Data.Tuple.Curry ( uncurryN )
@@ -64,12 +65,11 @@ import TSN.Codegen (
   tsn_codegen_config )
 import TSN.DbImport ( DbImport(..), ImportResult(..), run_dbmigrate )
 import TSN.Picklers ( xp_date_padded, xp_time, xp_time_stamp )
-import TSN.Team ( Team(..) )
+import TSN.Team ( FromXmlFkTeams(..), Team(..) )
 import TSN.XmlImport ( XmlImport(..), XmlImportFkTeams(..) )
 import Xml (
   Child(..),
   FromXml(..),
-  FromXmlFkTeams(..),
   ToDb(..),
   pickle_unpickle,
   unpickleable,
@@ -146,96 +146,64 @@ instance FromXml OddsGameCasinoXml where
 instance XmlImport OddsGameCasinoXml
 
 
--- * OddsGameHomeTeamXml / OddsGameAwayTeamXml
-
--- | The XML representation of a \<HomeTeam\>, as found in \<Game\>s.
---   This is basically the same as 'OddsGameAwayTeamXml', but the two
---   types have different picklers.
---
---   The starter id/name could perhaps be combined into an embedded
---   type, but can you make an entire embedded type optional with
---   Maybe? I doubt it works.
---
-data OddsGameHomeTeamXml =
-  OddsGameHomeTeamXml {
-    xml_home_team_id         :: String, -- ^ The home/away team IDs
-                                        --   are three characters but
-                                        --   Postgres imposes no
-                                        --   performance penalty on
-                                        --   lengthless text fields,
-                                        --   so we ignore the probable
-                                        --   upper bound of three
-                                        --   characters.
-    xml_home_team_rotation_number :: Maybe Int,
-    xml_home_team_abbr            :: String,
-    xml_home_team_name            :: String,
-    xml_home_team_starter         :: Maybe (Int, String), -- ^ (id, name)
-    xml_home_team_casinos         :: [OddsGameCasinoXml] }
-  deriving (Eq, Show)
-
-instance ToDb OddsGameHomeTeamXml where
-  -- | The database representation of an 'OddsGameHomeTeamXml' is an
-  --   'OddsGameTeam'.
-  --
-  type Db OddsGameHomeTeamXml = Team
-
-instance FromXml OddsGameHomeTeamXml where
-  -- | We convert from XML to the database by dropping the lines and
-  --   rotation number (which are specific to the games, not the teams
-  --   themselves).
-  --
-  from_xml OddsGameHomeTeamXml{..} =
-    Team {
-      team_id   = xml_home_team_id,
-      abbreviation = Just xml_home_team_abbr,
-      name = Just xml_home_team_name }
+-- * OddsGameTeamXml / OddsGameTeamStarterXml
 
--- | This allows us to insert the XML representation
---   'OddsGameHomeTeamXml' directly.
+-- | The XML representation of a \"starter\". It contains both an ID
+--   and a name. The ID does not appear to be optional, but the name
+--   can be absent. When the name is absent, the ID has always been
+--   set to \"0\". This occurs even though the entire starter element
+--   is optional (see 'OddsGameTeamXml' below).
 --
-instance XmlImport OddsGameHomeTeamXml where
-
+data OddsGameTeamStarterXml =
+  OddsGameTeamStarterXml {
+    xml_starter_id :: Int,
+    xml_starter_name :: Maybe String }
+  deriving (Eq, Show)
 
 
--- | The XML representation of a \<AwayTeam\>, as found in \<Game\>s.
---   This is basically the same as 'OddsGameHomeTeamXml', but the two
---   types have different picklers.
---
-data OddsGameAwayTeamXml =
-  OddsGameAwayTeamXml {
-    xml_away_team_id         :: String, -- ^ The home/away team IDs are
-                                        --   three characters but Postgres
-                                        --   imposes no performance penalty
-                                        --   on lengthless text fields, so
-                                        --   we ignore the probable upper
-                                        --   bound of three characters
-    xml_away_team_rotation_number :: Maybe Int,
-    xml_away_team_abbr            :: String,
-    xml_away_team_name            :: String,
-    xml_away_team_starter         :: Maybe (Int, String), -- ^ (id, name)
-    xml_away_team_casinos         :: [OddsGameCasinoXml] }
+-- | The XML representation of a \<HomeTeam\> or \<AwayTeam\>, as
+--   found in \<Game\>s. We can't use the 'Team' representation
+--   directly because there are some other fields we need to parse.
+--
+data OddsGameTeamXml =
+  OddsGameTeamXml {
+    xml_team_id         :: String, -- ^ The home/away team IDs
+                                   --   are three characters but
+                                   --   Postgres imposes no
+                                   --   performance penalty on
+                                   --   lengthless text fields,
+                                   --   so we ignore the probable
+                                   --   upper bound of three
+                                   --   characters.
+    xml_team_rotation_number :: Maybe Int,
+    xml_team_abbr            :: String,
+    xml_team_name            :: String,
+    xml_team_starter         :: Maybe OddsGameTeamStarterXml,
+    xml_team_casinos         :: [OddsGameCasinoXml] }
   deriving (Eq, Show)
 
-instance ToDb OddsGameAwayTeamXml where
-  -- | The database representation of an 'OddsGameAwayTeamXml' is a
-  --   'Team'.
+instance ToDb OddsGameTeamXml where
+  -- | The database representation of an 'OddsGameTeamXml' is an
+  --   'OddsGameTeam'.
   --
-  type Db OddsGameAwayTeamXml = Team
+  type Db OddsGameTeamXml = Team
 
-instance FromXml OddsGameAwayTeamXml where
+instance FromXml OddsGameTeamXml where
   -- | We convert from XML to the database by dropping the lines and
   --   rotation number (which are specific to the games, not the teams
   --   themselves).
   --
-  from_xml OddsGameAwayTeamXml{..} = Team
-                                       xml_away_team_id
-                                       (Just xml_away_team_abbr)
-                                       (Just xml_away_team_name)
+  from_xml OddsGameTeamXml{..} =
+    Team {
+      team_id   = xml_team_id,
+      abbreviation = Just xml_team_abbr,
+      name = Just xml_team_name }
 
 -- | This allows us to insert the XML representation
---   'OddsGameAwayTeamXml' directly.
+--   'OddsGameTeamXml' directly.
 --
-instance XmlImport OddsGameAwayTeamXml where
+instance XmlImport OddsGameTeamXml where
+
 
 
 
@@ -299,8 +267,8 @@ data OddsGameXml =
     xml_game_id         :: Int,
     xml_game_date       :: UTCTime, -- ^ Contains only the date
     xml_game_time       :: UTCTime, -- ^ Contains only the time
-    xml_away_team  :: OddsGameAwayTeamXml,
-    xml_home_team  :: OddsGameHomeTeamXml,
+    xml_away_team  :: OddsGameTeamXml,
+    xml_home_team  :: OddsGameTeamXml,
     xml_over_under :: OddsGameOverUnderXml }
   deriving (Eq, Show)
 
@@ -343,22 +311,26 @@ instance FromXmlFkTeams OddsGameXml where
                        (utctDayTime xml_game_time), -- the time from the other.
 
       db_away_team_rotation_number =
-        (xml_away_team_rotation_number xml_away_team),
+        (xml_team_rotation_number xml_away_team),
 
       db_home_team_rotation_number =
-        (xml_home_team_rotation_number xml_home_team),
+        (xml_team_rotation_number xml_home_team),
 
       db_away_team_starter_id =
-        (fmap fst $ xml_away_team_starter xml_away_team),
+        (xml_starter_id <$> xml_team_starter xml_away_team),
 
-      db_away_team_starter_name =
-        (fmap snd $ xml_away_team_starter xml_away_team),
+      -- Sometimes the starter element is present but the name isn't,
+      -- so we combine the two maybes with join.
+      db_away_team_starter_name = join
+        (xml_starter_name <$> xml_team_starter xml_away_team),
 
       db_home_team_starter_id =
-        (fmap fst $ xml_home_team_starter xml_home_team),
+        (xml_starter_id <$> xml_team_starter xml_home_team),
 
-      db_home_team_starter_name =
-        (fmap snd $ xml_home_team_starter xml_home_team) }
+      -- Sometimes the starter element is present but the name isn't,
+      -- so we combine the two maybes with join.
+      db_home_team_starter_name = join
+        (xml_starter_name <$> xml_team_starter xml_home_team) }
 
 
 -- | This lets us insert the XML representation 'OddsGameXml' directly.
@@ -477,7 +449,7 @@ mkPersist tsn_codegen_config [groundhog|
   constructors:
     - name: OddsCasino
       uniques:
-        - name: unique_odds_casino
+        - name: unique_odds_casinos
           type: constraint
           fields: [casino_client_id]
 
@@ -552,7 +524,7 @@ instance DbImport Message where
       -- ...but then when we insert the home/away team lines, we
       -- prefer to update the existing entry rather than overwrite it
       -- or add a new record.
-      forM_ (xml_away_team_casinos $ xml_away_team game) $ \c -> do
+      forM_ (xml_team_casinos $ xml_away_team game) $ \c -> do
         -- insert, or more likely retrieve the existing, casino
         a_casino_id <- insert_xml_or_select c
 
@@ -564,7 +536,7 @@ instance DbImport Message where
           Ogl_Odds_Casinos_Id ==. a_casino_id
 
       -- Repeat all that for the home team.
-      forM_ (xml_home_team_casinos $ xml_home_team game) $ \c ->do
+      forM_ (xml_team_casinos $ xml_home_team game) $ \c ->do
         h_casino_id <- insert_xml_or_select c
         let home_line = home_away_line c
         update [Ogl_Home_Line =. home_line] $ -- WHERE
@@ -611,9 +583,9 @@ pickle_casino =
                                       xml_casino_line)
 
 
--- | Pickler for an 'OddsGameHomeTeamXml'.
+-- | Pickler for an 'OddsGameTeamXml'.
 --
-pickle_home_team :: PU OddsGameHomeTeamXml
+pickle_home_team :: PU OddsGameTeamXml
 pickle_home_team =
   xpElem "HomeTeam" $
     xpWrap (from_tuple, to_tuple) $
@@ -622,24 +594,48 @@ pickle_home_team =
         (xpElem "HomeRotationNumber" (xpOption xpInt))
         (xpElem "HomeAbbr" xpText)
         (xpElem "HomeTeamName" xpText)
-        (-- This is an ugly way to get both the HStarter ID attribute
-         -- and contents.
-         xpOption (xpElem "HStarter" $ xpPair (xpAttr "ID" xpInt) xpText))
+        (xpOption pickle_home_starter)
         (xpList pickle_casino)
   where
-    from_tuple = uncurryN OddsGameHomeTeamXml
+    from_tuple = uncurryN OddsGameTeamXml
 
     -- Use record wildcards to avoid unused field warnings.
-    to_tuple OddsGameHomeTeamXml{..} = (xml_home_team_id,
-                                        xml_home_team_rotation_number,
-                                        xml_home_team_abbr,
-                                        xml_home_team_name,
-                                        xml_home_team_starter,
-                                        xml_home_team_casinos)
+    to_tuple OddsGameTeamXml{..} = (xml_team_id,
+                                    xml_team_rotation_number,
+                                    xml_team_abbr,
+                                    xml_team_name,
+                                    xml_team_starter,
+                                    xml_team_casinos)
+
+
+-- | Portion of the 'OddsGameTeamStarterXml' pickler that is not
+--   specific to the home/away teams.
+--
+pickle_starter :: PU OddsGameTeamStarterXml
+pickle_starter =
+  xpWrap (from_tuple, to_tuple) $
+    xpPair (xpAttr "ID" xpInt) (xpOption xpText)
+  where
+    from_tuple = uncurry OddsGameTeamStarterXml
+    to_tuple OddsGameTeamStarterXml{..} = (xml_starter_id,
+                                           xml_starter_name)
+
+-- | Pickler for an home team 'OddsGameTeamStarterXml'
+--
+pickle_home_starter :: PU OddsGameTeamStarterXml
+pickle_home_starter = xpElem "HStarter" pickle_starter
 
--- | Pickler for an 'OddsGameAwayTeamXml'.
+
+-- | Pickler for an away team 'OddsGameTeamStarterXml'
+--
+pickle_away_starter :: PU OddsGameTeamStarterXml
+pickle_away_starter = xpElem "AStarter" pickle_starter
+
+
+
+-- | Pickler for an 'OddsGameTeamXml'.
 --
-pickle_away_team :: PU OddsGameAwayTeamXml
+pickle_away_team :: PU OddsGameTeamXml
 pickle_away_team =
   xpElem "AwayTeam" $
     xpWrap (from_tuple, to_tuple) $
@@ -648,20 +644,18 @@ pickle_away_team =
         (xpElem "AwayRotationNumber" (xpOption xpInt))
         (xpElem "AwayAbbr" xpText)
         (xpElem "AwayTeamName" xpText)
-        (-- This is an ugly way to get both the AStarter ID attribute
-         -- and contents.
-         xpOption (xpElem "AStarter" $ xpPair (xpAttr "ID" xpInt) xpText))
+        (xpOption pickle_away_starter)
         (xpList pickle_casino)
   where
-    from_tuple = uncurryN OddsGameAwayTeamXml
+    from_tuple = uncurryN OddsGameTeamXml
 
     -- Use record wildcards to avoid unused field warnings.
-    to_tuple OddsGameAwayTeamXml{..} = (xml_away_team_id,
-                                        xml_away_team_rotation_number,
-                                        xml_away_team_abbr,
-                                        xml_away_team_name,
-                                        xml_away_team_starter,
-                                        xml_away_team_casinos)
+    to_tuple OddsGameTeamXml{..} = (xml_team_id,
+                                    xml_team_rotation_number,
+                                    xml_team_abbr,
+                                    xml_team_name,
+                                    xml_team_starter,
+                                    xml_team_casinos)
 
 
 
@@ -761,7 +755,10 @@ test_pickle_of_unpickle_is_identity = testGroup "pickle-unpickle tests"
           "test/xml/Odds_XML-largefile.xml",
 
     check "pickle composed with unpickle is the identity (league name)"
-          "test/xml/Odds_XML-league-name.xml" ]
+          "test/xml/Odds_XML-league-name.xml",
+
+    check "pickle composed with unpickle is the identity (missing starters)"
+          "test/xml/Odds_XML-missing-starters.xml" ]
   where
     check desc path = testCase desc $ do
       (expected, actual) <- pickle_unpickle pickle_message path
@@ -785,7 +782,10 @@ test_unpickle_succeeds = testGroup "unpickle tests"
           "test/xml/Odds_XML-largefile.xml",
 
     check "unpickling succeeds (league name)"
-          "test/xml/Odds_XML-league-name.xml" ]
+          "test/xml/Odds_XML-league-name.xml",
+
+    check "unpickling succeeds (missing starters)"
+          "test/xml/Odds_XML-missing-starters.xml" ]
   where
     check desc path = testCase desc $ do
       actual <- unpickleable path pickle_message
@@ -820,6 +820,10 @@ test_on_delete_cascade = testGroup "cascading delete tests"
     check "deleting odds deleted its children (league name)"
           "test/xml/Odds_XML-league-name.xml"
           35 -- 5 casinos, 30 teams
+    ,
+    check "deleting odds deleted its children (missing starters)"
+          "test/xml/Odds_XML-missing-starters.xml"
+          7 -- 5 casinos, 2 teams
     ]
   where
     check desc path expected = testCase desc $ do