]> gitweb.michael.orlitzky.com - dead/htsn-import.git/blobdiff - src/TSN/XML/Odds.hs
Add the 'xp_attr_option' pickler and use it to fix tests broken by HXT.
[dead/htsn-import.git] / src / TSN / XML / Odds.hs
index 444371ad1e055a2b723f08071a6dc15e7785b882..95aecbed22767a28fb03a071e94790ff2e7003b7 100644 (file)
@@ -1,6 +1,8 @@
+{-# LANGUAGE DeriveGeneric #-}
 {-# LANGUAGE DeriveDataTypeable #-}
 {-# LANGUAGE FlexibleInstances #-}
 {-# LANGUAGE GADTs #-}
+{-# LANGUAGE PatternGuards #-}
 {-# LANGUAGE QuasiQuotes #-}
 {-# LANGUAGE RecordWildCards #-}
 {-# LANGUAGE TemplateHaskell #-}
@@ -27,6 +29,7 @@ import Control.Applicative ( (<$>) )
 import Control.Monad ( forM_, join )
 import Data.Time ( UTCTime(..) )
 import Data.Tuple.Curry ( uncurryN )
+import qualified Data.Vector.HFixed as H ( HVector, convert )
 import Database.Groundhog (
   (=.),
   (==.),
@@ -34,15 +37,14 @@ import Database.Groundhog (
   deleteAll,
   insert_,
   migrate,
-  runMigration,
-  silentMigrationLogger,
   update )
 import Database.Groundhog.Core ( DefaultKey )
-import Database.Groundhog.Generic ( runDbConn )
+import Database.Groundhog.Generic ( runDbConn, runMigrationSilent )
 import Database.Groundhog.Sqlite ( withSqliteConn )
 import Database.Groundhog.TH (
   groundhog,
   mkPersist )
+import qualified GHC.Generics as GHC ( Generic )
 import Test.Tasty ( TestTree, testGroup )
 import Test.Tasty.HUnit ( (@?=), testCase )
 import Text.Read ( readMaybe )
@@ -61,16 +63,19 @@ import Text.XML.HXT.Core (
   xpWrap )
 
 -- Local imports.
-import TSN.Codegen (
-  tsn_codegen_config )
+import TSN.Codegen ( tsn_codegen_config )
+import TSN.Database ( insert_or_select )
 import TSN.DbImport ( DbImport(..), ImportResult(..), run_dbmigrate )
-import TSN.Picklers ( xp_date_padded, xp_time, xp_time_stamp )
-import TSN.Team ( Team(..) )
+import TSN.Picklers (
+  xp_attr_option,
+  xp_date_padded,
+  xp_tba_time,
+  xp_time_stamp )
+import TSN.Team ( FromXmlFkTeams(..), Team(..) )
 import TSN.XmlImport ( XmlImport(..), XmlImportFkTeams(..) )
 import Xml (
   Child(..),
   FromXml(..),
-  FromXmlFkTeams(..),
   ToDb(..),
   pickle_unpickle,
   unpickleable,
@@ -109,12 +114,25 @@ data OddsCasino =
 --   with a 'String' and then attempt to 'read' a 'Double' later when we
 --   go to insert the thing.
 --
+--   The client_id and name shouldn't really be optional, but TSN has
+--   started to send us empty casinos:
+--
+--     \<Casino ClientID=\"\" Name=\"\"\>\</Casino\>
+--
+--   We need to parse these, but we'll silently drop them during the
+--   database import.
+--
 data OddsGameCasinoXml =
   OddsGameCasinoXml {
-    xml_casino_client_id :: Int,
-    xml_casino_name      :: String,
+    xml_casino_client_id :: Maybe Int,
+    xml_casino_name      :: Maybe String,
     xml_casino_line      :: Maybe String }
-  deriving (Eq, Show)
+  deriving (Eq, GHC.Generic, Show)
+
+
+-- | For 'H.convert'.
+--
+instance H.HVector OddsGameCasinoXml
 
 
 -- | Try to get a 'Double' out of the 'xml_casino_line' which is a
@@ -127,24 +145,25 @@ home_away_line = join . (fmap readMaybe) . xml_casino_line
 
 instance ToDb OddsGameCasinoXml where
   -- | The database representation of an 'OddsGameCasinoXml' is an
-  --   'OddsCasino'.
+  --   'OddsCasino'. When our XML representation is missing a
+  --   client_id or a name, we want to ignore it. So in that case,
+  --   when we convert to the database type, we want 'Nothing'.
   --
-  type Db OddsGameCasinoXml = OddsCasino
+  type Db OddsGameCasinoXml = Maybe OddsCasino
 
 
 instance FromXml OddsGameCasinoXml where
-  -- | We convert from XML to the database by dropping the line field.
+  -- | We convert from XML to the database by dropping the
+  --   'xml_casino_line' field. If either the 'xml_casino_client_id'
+  --   or 'xml_casino_name' is missing ('Nothing'), we'll return
+  --   'Nothing'.
   --
-  from_xml OddsGameCasinoXml{..} =
-    OddsCasino {
-      casino_client_id = xml_casino_client_id,
-      casino_name      = xml_casino_name }
+  from_xml (OddsGameCasinoXml Nothing _ _) = Nothing
+  from_xml (OddsGameCasinoXml _ Nothing _) = Nothing
 
+  from_xml (OddsGameCasinoXml (Just c) (Just n) _) =
+    Just OddsCasino { casino_client_id = c, casino_name = n }
 
--- | This allows us to insert the XML representation 'OddsGameCasinoXml'
---   directly.
---
-instance XmlImport OddsGameCasinoXml
 
 
 -- * OddsGameTeamXml / OddsGameTeamStarterXml
@@ -159,7 +178,12 @@ data OddsGameTeamStarterXml =
   OddsGameTeamStarterXml {
     xml_starter_id :: Int,
     xml_starter_name :: Maybe String }
-  deriving (Eq, Show)
+  deriving (Eq, GHC.Generic, Show)
+
+
+-- | For 'H.convert'.
+--
+instance H.HVector OddsGameTeamStarterXml
 
 
 -- | The XML representation of a \<HomeTeam\> or \<AwayTeam\>, as
@@ -181,7 +205,13 @@ data OddsGameTeamXml =
     xml_team_name            :: String,
     xml_team_starter         :: Maybe OddsGameTeamStarterXml,
     xml_team_casinos         :: [OddsGameCasinoXml] }
-  deriving (Eq, Show)
+  deriving (Eq, GHC.Generic, Show)
+
+
+-- | For 'H.convert'.
+--
+instance H.HVector OddsGameTeamXml
+
 
 instance ToDb OddsGameTeamXml where
   -- | The database representation of an 'OddsGameTeamXml' is an
@@ -252,7 +282,7 @@ data OddsGame =
     db_away_team_id      :: DefaultKey Team,
     db_home_team_id      :: DefaultKey Team,
     db_game_id           :: Int,
-    db_game_time         :: UTCTime, -- ^ Contains both the date and time.
+    db_game_time         :: Maybe UTCTime, -- ^ Contains both the date and time.
     db_away_team_rotation_number :: Maybe Int,
     db_home_team_rotation_number :: Maybe Int,
     db_away_team_starter_id :: Maybe Int,
@@ -267,11 +297,17 @@ data OddsGameXml =
   OddsGameXml {
     xml_game_id         :: Int,
     xml_game_date       :: UTCTime, -- ^ Contains only the date
-    xml_game_time       :: UTCTime, -- ^ Contains only the time
+    xml_game_time       :: Maybe UTCTime, -- ^ Contains only the time
     xml_away_team  :: OddsGameTeamXml,
     xml_home_team  :: OddsGameTeamXml,
     xml_over_under :: OddsGameOverUnderXml }
-  deriving (Eq, Show)
+  deriving (Eq, GHC.Generic, Show)
+
+
+-- | For 'H.convert'.
+--
+instance H.HVector OddsGameXml
+
 
 -- | Pseudo-field that lets us get the 'OddsGameCasinoXml's out of
 --   xml_over_under.
@@ -307,9 +343,7 @@ instance FromXmlFkTeams OddsGameXml where
       db_home_team_id = fk_home,
       db_game_id   = xml_game_id,
 
-      db_game_time = UTCTime
-                       (utctDay xml_game_date) -- Take the day part from one,
-                       (utctDayTime xml_game_time), -- the time from the other.
+      db_game_time = make_game_time xml_game_date xml_game_time,
 
       db_away_team_rotation_number =
         (xml_team_rotation_number xml_away_team),
@@ -332,6 +366,16 @@ instance FromXmlFkTeams OddsGameXml where
       -- so we combine the two maybes with join.
       db_home_team_starter_name = join
         (xml_starter_name <$> xml_team_starter xml_home_team) }
+    where
+      -- | Construct the database game time from the XML \<Game_Date\>
+      --   and \<Game_Time\> elements. The \<Game_Time\> elements
+      --   sometimes have a value of \"TBA\"; in that case, we don't
+      --   want to pretend that we know the time by setting it to
+      --   e.g. midnight, so instead we make the entire date/time
+      --   Nothing.
+      make_game_time :: UTCTime -> Maybe UTCTime -> Maybe UTCTime
+      make_game_time _ Nothing = Nothing
+      make_game_time d (Just t) = Just $ UTCTime (utctDay d) (utctDayTime t)
 
 
 -- | This lets us insert the XML representation 'OddsGameXml' directly.
@@ -398,7 +442,12 @@ data Message =
     xml_line_time :: String,
     xml_games_with_notes :: [OddsGameWithNotes],
     xml_time_stamp :: UTCTime }
-  deriving (Eq, Show)
+  deriving (Eq, GHC.Generic, Show)
+
+-- | For 'H.convert'.
+--
+instance H.HVector Message
+
 
 -- | Pseudo-field that lets us get the 'OddsGame's out of
 --   'xml_games_with_notes'.
@@ -507,46 +556,76 @@ instance DbImport Message where
       -- Finally, we insert the lines. The over/under entries for this
       -- game and the lines for the casinos all wind up in the same
       -- table, odds_games_lines. We can insert the over/under entries
-      -- freely with empty away/home lines:
-      forM_ (xml_over_under_casinos game) $ \c -> do
-        -- Start by inderting the casino.
-        ou_casino_id <- insert_xml_or_select c
-
-        -- Now add the over/under entry with the casino's id.
-        let ogl = OddsGameLine {
-                    ogl_odds_games_id = game_id,
-                    ogl_odds_casinos_id = ou_casino_id,
-                    ogl_over_under = (xml_casino_line c),
-                    ogl_away_line = Nothing,
-                    ogl_home_line = Nothing }
-
-        insert_ ogl
+      -- freely with empty away/home lines.
+      --
+      -- Before we continue, we drop all casinos that are missing
+      -- either a client_id or name field.
+      --
+      let ou_casinos = filter nonempty_casino $ xml_over_under_casinos game
+
+      forM_ ou_casinos $ \c ->
+        -- Since we already filtered out the casinos without a
+        -- client_id or a name, the database conversion should always
+        -- return (Just something).
+        case (from_xml c) of
+          Nothing -> return () -- Should never happen, we filtered them out.
+          Just casino -> do
+            -- Start by inserting the casino.
+            ou_casino_id <- insert_or_select casino
+
+            -- Now add the over/under entry with the casino's id.
+            let ogl = OddsGameLine {
+                        ogl_odds_games_id = game_id,
+                        ogl_odds_casinos_id = ou_casino_id,
+                        ogl_over_under = (xml_casino_line c),
+                        ogl_away_line = Nothing,
+                        ogl_home_line = Nothing }
+
+            insert_ ogl
 
       -- ...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_team_casinos $ xml_away_team game) $ \c -> do
-        -- insert, or more likely retrieve the existing, casino
-        a_casino_id <- insert_xml_or_select c
+      let away_casinos = filter nonempty_casino $
+                           xml_team_casinos (xml_away_team game)
 
-        -- Get a Maybe Double instead of the Maybe String that's in there.
-        let away_line = home_away_line c
+      forM_ away_casinos $ \c ->
+        case (from_xml c) of
+          Nothing -> return () -- Should never happen, we filtered them out.
+          Just casino -> do
+            -- insert, or more likely retrieve the existing, casino
+            a_casino_id <- insert_or_select casino
 
-        -- Unconditionally update that casino's away team line with ours.
-        update [Ogl_Away_Line =. away_line] $ -- WHERE
-          Ogl_Odds_Casinos_Id ==. a_casino_id
+            -- Get a Maybe Double instead of the Maybe String that's in there.
+            let away_line = home_away_line c
+
+            -- Unconditionally update that casino's away team line with ours.
+            update [Ogl_Away_Line =. away_line] $ -- WHERE
+              Ogl_Odds_Casinos_Id ==. a_casino_id
 
       -- Repeat all that for the home team.
-      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
-          Ogl_Odds_Casinos_Id ==. h_casino_id
+      let home_casinos = filter nonempty_casino $
+                           xml_team_casinos (xml_home_team game)
+
+      forM_ home_casinos $ \c ->
+        case (from_xml c) of
+          Nothing -> return () -- Should never happen, we filtered them out.
+          Just casino -> do
+            h_casino_id <- insert_or_select casino
+            let home_line = home_away_line c
+            update [Ogl_Home_Line =. home_line] $ -- WHERE
+              Ogl_Odds_Casinos_Id ==. h_casino_id
 
       return game_id
 
     return ImportSucceeded
 
+    where
+      nonempty_casino :: OddsGameCasinoXml -> Bool
+      nonempty_casino OddsGameCasinoXml{..}
+        | Nothing <- xml_casino_client_id = False
+        | Nothing <- xml_casino_name = False
+        | otherwise = True
 
 --
 -- Pickling
@@ -571,17 +650,13 @@ pickle_game_with_notes =
 pickle_casino :: PU OddsGameCasinoXml
 pickle_casino =
   xpElem "Casino" $
-  xpWrap (from_tuple, to_tuple) $
+  xpWrap (from_tuple, H.convert) $
   xpTriple
-    (xpAttr "ClientID" xpInt)
-    (xpAttr "Name" xpText)
+    (xpAttr "ClientID" $ xp_attr_option)
+    (xpAttr "Name" $ xpOption xpText)
     (xpOption xpText)
   where
     from_tuple = uncurryN OddsGameCasinoXml
-    -- Use record wildcards to avoid unused field warnings.
-    to_tuple OddsGameCasinoXml{..} = (xml_casino_client_id,
-                                      xml_casino_name,
-                                      xml_casino_line)
 
 
 -- | Pickler for an 'OddsGameTeamXml'.
@@ -589,7 +664,7 @@ pickle_casino =
 pickle_home_team :: PU OddsGameTeamXml
 pickle_home_team =
   xpElem "HomeTeam" $
-    xpWrap (from_tuple, to_tuple) $
+    xpWrap (from_tuple, H.convert) $
       xp6Tuple
         (xpElem "HomeTeamID" xpText)
         (xpElem "HomeRotationNumber" (xpOption xpInt))
@@ -600,13 +675,6 @@ pickle_home_team =
   where
     from_tuple = uncurryN OddsGameTeamXml
 
-    -- Use record wildcards to avoid unused field warnings.
-    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
@@ -614,12 +682,11 @@ pickle_home_team =
 --
 pickle_starter :: PU OddsGameTeamStarterXml
 pickle_starter =
-  xpWrap (from_tuple, to_tuple) $
+  xpWrap (from_tuple, H.convert) $
     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'
 --
@@ -639,7 +706,7 @@ pickle_away_starter = xpElem "AStarter" pickle_starter
 pickle_away_team :: PU OddsGameTeamXml
 pickle_away_team =
   xpElem "AwayTeam" $
-    xpWrap (from_tuple, to_tuple) $
+    xpWrap (from_tuple, H.convert) $
       xp6Tuple
         (xpElem "AwayTeamID" xpText)
         (xpElem "AwayRotationNumber" (xpOption xpInt))
@@ -650,14 +717,6 @@ pickle_away_team =
   where
     from_tuple = uncurryN OddsGameTeamXml
 
-    -- Use record wildcards to avoid unused field warnings.
-    to_tuple OddsGameTeamXml{..} = (xml_team_id,
-                                    xml_team_rotation_number,
-                                    xml_team_abbr,
-                                    xml_team_name,
-                                    xml_team_starter,
-                                    xml_team_casinos)
-
 
 
 -- | Pickler for an 'OddsGameOverUnderXml'.
@@ -677,23 +736,16 @@ pickle_over_under =
 pickle_game :: PU OddsGameXml
 pickle_game =
   xpElem "Game" $
-  xpWrap (from_tuple, to_tuple) $
+  xpWrap (from_tuple, H.convert) $
   xp6Tuple
     (xpElem "GameID" xpInt)
     (xpElem "Game_Date" xp_date_padded)
-    (xpElem "Game_Time" xp_time)
+    (xpElem "Game_Time" xp_tba_time)
     pickle_away_team
     pickle_home_team
     pickle_over_under
   where
     from_tuple = uncurryN OddsGameXml
-    -- Use record wildcards to avoid unused field warnings.
-    to_tuple OddsGameXml{..} = (xml_game_id,
-                                xml_game_date,
-                                xml_game_time,
-                                xml_away_team,
-                                xml_home_team,
-                                xml_over_under)
 
 
 -- | Pickler for the top-level 'Message'.
@@ -701,7 +753,7 @@ pickle_game =
 pickle_message :: PU Message
 pickle_message =
   xpElem "message" $
-    xpWrap (from_tuple, to_tuple) $
+    xpWrap (from_tuple, H.convert) $
     xp8Tuple (xpElem "XML_File_ID" xpInt)
              (xpElem "heading" xpText)
              (xpElem "category" xpText)
@@ -712,14 +764,6 @@ pickle_message =
              (xpElem "time_stamp" xp_time_stamp)
   where
     from_tuple = uncurryN Message
-    to_tuple m = (xml_xml_file_id m,
-                  xml_heading m,
-                  xml_category m,
-                  xml_sport m,
-                  xml_title m,
-                  xml_line_time m,
-                  xml_games_with_notes m,
-                  xml_time_stamp m)
 
 
 --
@@ -759,7 +803,13 @@ test_pickle_of_unpickle_is_identity = testGroup "pickle-unpickle tests"
           "test/xml/Odds_XML-league-name.xml",
 
     check "pickle composed with unpickle is the identity (missing starters)"
-          "test/xml/Odds_XML-missing-starters.xml" ]
+          "test/xml/Odds_XML-missing-starters.xml",
+
+    check "pickle composed with unpickle is the identity (TBA game time)"
+          "test/xml/Odds_XML-tba-game-time.xml",
+
+    check "pickle composed with unpickle is the identity (empty casino)"
+          "test/xml/Odds_XML-empty-casino.xml" ]
   where
     check desc path = testCase desc $ do
       (expected, actual) <- pickle_unpickle pickle_message path
@@ -786,7 +836,13 @@ test_unpickle_succeeds = testGroup "unpickle tests"
           "test/xml/Odds_XML-league-name.xml",
 
     check "unpickling succeeds (missing starters)"
-          "test/xml/Odds_XML-missing-starters.xml" ]
+          "test/xml/Odds_XML-missing-starters.xml",
+
+    check "unpickling succeeds (TBA game time)"
+          "test/xml/Odds_XML-tba-game-time.xml",
+
+    check "unpickling succeeds (empty casino)"
+          "test/xml/Odds_XML-empty-casino.xml" ]
   where
     check desc path = testCase desc $ do
       actual <- unpickleable path pickle_message
@@ -825,6 +881,14 @@ test_on_delete_cascade = testGroup "cascading delete tests"
     check "deleting odds deleted its children (missing starters)"
           "test/xml/Odds_XML-missing-starters.xml"
           7 -- 5 casinos, 2 teams
+    ,
+    check "deleting odds deleted its children (TBA game time)"
+          "test/xml/Odds_XML-tba-game-time.xml"
+          119 -- 5 casinos, 114 teams
+    ,
+    check "deleting odds deleted its children (empty casino)"
+          "test/xml/Odds_XML-empty-casino.xml"
+          11 -- 5 casinos, 6 teams
     ]
   where
     check desc path expected = testCase desc $ do
@@ -835,7 +899,7 @@ test_on_delete_cascade = testGroup "cascading delete tests"
       let d = undefined :: OddsGame
       let e = undefined :: OddsGameLine
       actual <- withSqliteConn ":memory:" $ runDbConn $ do
-                  runMigration silentMigrationLogger $ do
+                  runMigrationSilent $ do
                     migrate a
                     migrate b
                     migrate c