-{-# LANGUAGE BangPatterns #-}
{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE GADTs #-}
{-# LANGUAGE QuasiQuotes #-}
{-# LANGUAGE RecordWildCards #-}
-{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE StandaloneDeriving #-}
{-# LANGUAGE TemplateHaskell #-}
{-# LANGUAGE TypeFamilies #-}
-module TSN.XML.Odds (
- Message )
-where
-
-
-- | Parse TSN XML for the DTD "Odds_XML.dtd". Each document contains
-- a root element \<message\> that contains a bunch of other
-- unorganized crap.
--
+module TSN.XML.Odds (
+ odds_tests,
+ pickle_message )
+where
-import Data.Data ( Data, constrFields, dataTypeConstrs, dataTypeOf )
-import Data.List.Utils ( join, split )
+import Control.Monad ( forM_ )
import Data.Tuple.Curry ( uncurryN )
-import Data.Typeable ( Typeable )
import Database.Groundhog (
- defaultMigrationLogger,
- insert,
+ (=.),
+ (==.),
+ insert_,
+ insertByAll,
migrate,
- runMigration )
+ update )
import Database.Groundhog.Core ( DefaultKey )
import Database.Groundhog.TH (
groundhog,
import Test.Tasty.HUnit ( (@?=), testCase )
import Text.XML.HXT.Core (
PU,
- XmlPickler(..),
- unpickleDoc,
xp5Tuple,
xp6Tuple,
- xp11Tuple,
+ xp8Tuple,
xpAttr,
xpElem,
xpInt,
xpPair,
xpPrim,
xpText,
- xpText0,
xpTriple,
xpWrap )
import TSN.Codegen (
- tsn_codegen_config,
- tsn_db_field_namer )
-import TSN.DbImport ( DbImport(..), ImportResult(..) )
-import Xml ( ToFromXml(..), pickle_unpickle )
+ tsn_codegen_config )
+import TSN.DbImport ( DbImport(..), ImportResult(..), run_dbmigrate )
+import TSN.XmlImport ( XmlImport(..) )
+import Xml ( FromXml(..), pickle_unpickle, unpickleable )
-data OddsCasino =
- OddsCasino {
+data OddsGameCasinoXml =
+ OddsGameCasinoXml {
xml_casino_client_id :: Int,
xml_casino_name :: String,
- xml_casino_line :: Maybe Float }
+ xml_casino_line :: Maybe Double }
deriving (Eq, Show)
-data OddsHomeTeam =
- OddsHomeTeam {
+
+-- | The casinos should have their own table, but the lines don't
+-- belong in that table. (There should be another table joining the
+-- casinos and the thing the lines are for together.)
+--
+-- We drop the 'Game' prefix because the Casinos really aren't
+-- children of the games; the XML just makes it seem that way.
+--
+data OddsCasino =
+ OddsCasino {
+ casino_client_id :: Int,
+ casino_name :: String }
+ deriving (Eq, Show)
+
+instance FromXml OddsGameCasinoXml where
+ type Db OddsGameCasinoXml = OddsCasino
+
+ -- We don't need the key argument (from_xml_fk) since the XML type
+ -- contains more information in this case.
+ from_xml OddsGameCasinoXml{..} = OddsCasino
+ xml_casino_client_id
+ xml_casino_name
+
+instance XmlImport OddsGameCasinoXml
+
+
+data OddsGameHomeTeamXml =
+ OddsGameHomeTeamXml {
xml_home_team_id :: Int,
xml_home_rotation_number :: Int,
xml_home_abbr :: String,
xml_home_team_name :: String,
- xml_home_casinos :: [OddsCasino] }
+ xml_home_casinos :: [OddsGameCasinoXml] }
+ deriving (Eq, Show)
+
+instance FromXml OddsGameHomeTeamXml where
+ type Db OddsGameHomeTeamXml = OddsGameTeam
+ from_xml OddsGameHomeTeamXml{..} = OddsGameTeam
+ xml_home_team_id
+ xml_home_abbr
+ xml_home_team_name
+
+instance XmlImport OddsGameHomeTeamXml where
+
+
+data OddsGameTeam =
+ OddsGameTeam {
+ db_team_id :: Int,
+ db_abbr :: String,
+ db_team_name :: String }
deriving (Eq, Show)
-data OddsAwayTeam =
- OddsAwayTeam {
+
+-- | Database mapping between games and their home/away teams.
+data OddsGame_OddsGameTeam =
+ OddsGame_OddsGameTeam {
+ ogogt_odds_games_id :: DefaultKey OddsGame,
+ ogogt_away_team_id :: DefaultKey OddsGameTeam,
+ ogogt_home_team_id :: DefaultKey OddsGameTeam }
+
+data OddsGameAwayTeamXml =
+ OddsGameAwayTeamXml {
xml_away_team_id :: Int,
xml_away_rotation_number :: Int,
xml_away_abbr :: String,
xml_away_team_name :: String,
- xml_away_casinos :: [OddsCasino] }
+ xml_away_casinos :: [OddsGameCasinoXml] }
deriving (Eq, Show)
+instance FromXml OddsGameAwayTeamXml where
+ type Db OddsGameAwayTeamXml = OddsGameTeam
+ from_xml OddsGameAwayTeamXml{..} = OddsGameTeam
+ xml_away_team_id
+ xml_away_abbr
+ xml_away_team_name
+
+instance XmlImport OddsGameAwayTeamXml where
+
-- | Can't use a newtype with Groundhog.
-data OddsOverUnder =
- OddsOverUnder [OddsCasino]
+newtype OddsGameOverUnderXml =
+ OddsGameOverUnderXml { xml_casinos :: [OddsGameCasinoXml] }
deriving (Eq, Show)
+-- | This database representation of the casino lines can't be
+-- constructed from the one in the XML. The casinos within
+-- Game>HomeTeam, Game>AwayTeam, and Game>Over_Under are all the
+-- same. We don't need a bajillion different tables to store that --
+-- just one tying the casino/game pair to the three lines.
+data OddsGameLine =
+ OddsGameLine {
+ ogl_odds_games_id :: DefaultKey OddsGame,
+ ogl_odds_casinos_id :: DefaultKey OddsCasino,
+ ogl_over_under :: Maybe Double,
+ ogl_away_line :: Maybe Double,
+ ogl_home_line :: Maybe Double }
+
data OddsGame =
OddsGame {
+ db_game_id :: Int,
+ db_game_date :: String, -- TODO
+ db_game_time :: String, -- TODO
+ db_game_away_team_rotation_number :: Int,
+ db_game_home_team_rotation_number :: Int }
+deriving instance Eq OddsGame
+deriving instance Show OddsGame
+
+data OddsGameXml =
+ OddsGameXml {
xml_game_id :: Int,
xml_game_date :: String, -- TODO
xml_game_time :: String, -- TODO
- xml_game_away_team :: OddsAwayTeam,
- xml_game_home_team :: OddsHomeTeam,
- xml_game_over_under :: OddsOverUnder }
+ xml_game_away_team :: OddsGameAwayTeamXml,
+ xml_game_home_team :: OddsGameHomeTeamXml,
+ xml_game_over_under :: OddsGameOverUnderXml }
deriving (Eq, Show)
-data Message = Message
+-- | Pseudo-field that lets us get the 'OddsCasino's out of
+-- xml_game_over_under.
+xml_game_over_under_casinos :: OddsGameXml -> [OddsGameCasinoXml]
+xml_game_over_under_casinos = xml_casinos . xml_game_over_under
+
+
+instance FromXml OddsGameXml where
+ type Db OddsGameXml = OddsGame
+ from_xml OddsGameXml{..} = OddsGame
+ xml_game_id
+ xml_game_date
+ xml_game_time
+ (xml_away_rotation_number xml_game_away_team)
+ (xml_home_rotation_number xml_game_home_team)
+
+instance XmlImport OddsGameXml
+
-data MessageXml =
- MessageXml {
+
+data Odds =
+ Odds {
+ db_sport :: String,
+ db_title :: String,
+ db_line_time :: String }
+
+
+-- | Map 'Odds' to their children 'OddsGame's.
+data Odds_OddsGame =
+ Odds_OddsGame {
+ oog_odds_id :: DefaultKey Odds,
+ oog_odds_games_id :: DefaultKey OddsGame }
+
+-- | This is our best guess at what occurs in the Odds_XML
+-- documents. It looks like each consecutive set of games can
+-- optionally have some notes appear before it. Each "note" comes as
+-- its own <Notes>...</Notes> element.
+--
+-- The notes are ignored completely in the database; we only bother
+-- with them to ensure that we're (un)pickling correctly.
+--
+-- We can't group the notes with a "set" of 'OddsGame's, because that
+-- leads to ambiguity in parsing. Since we're going to ignore the
+-- notes anyway, we just stick them with an arbitrary game. C'est la
+-- vie.
+--
+data OddsGameWithNotes =
+ OddsGameWithNotes {
+ notes :: [String],
+ game :: OddsGameXml }
+ deriving (Eq, Show)
+
+-- | The XML representation of Odds.
+data Message =
+ Message {
xml_xml_file_id :: Int,
xml_heading :: String,
xml_category :: String,
xml_sport :: String,
xml_title :: String,
- xml_line_time :: String, -- The DTD goes crazy here.
- xml_notes1 :: String,
- xml_games1 :: [OddsGame],
- xml_notes2 :: String,
- xml_games2 :: [OddsGame],
+ xml_line_time :: String,
+ xml_games_with_notes :: [OddsGameWithNotes],
xml_time_stamp :: String }
deriving (Eq, Show)
+-- | Pseudo-field that lets us get the 'OddsGame's out of
+-- 'xml_games_with_notes'.
+xml_games :: Message -> [OddsGameXml]
+xml_games m = map game (xml_games_with_notes m)
+
+
+instance FromXml Message where
+ type Db Message = Odds
+
+ -- We don't need the key argument (from_xml_fk) since the XML type
+ -- contains more information in this case.
+ from_xml (Message _ _ _ d e f _ _) =
+ Odds d e f
+
+instance XmlImport Message
+
+
+
+-- * Groundhog database schema.
+-- | This must come before the dbimport code.
+--
+mkPersist tsn_codegen_config [groundhog|
+- entity: Odds
+
+- entity: OddsCasino
+ dbName: odds_casinos
+ constructors:
+ - name: OddsCasino
+ uniques:
+ - name: unique_odds_casino
+ type: constraint
+ fields: [casino_client_id]
+
+- entity: OddsGameTeam
+ dbName: odds_games_teams
+ constructors:
+ - name: OddsGameTeam
+ uniques:
+ - name: unique_odds_games_team
+ type: constraint
+ fields: [db_team_id]
+
+
+- entity: OddsGame
+ dbName: odds_games
+ constructors:
+ - name: OddsGame
+ uniques:
+ - name: unique_odds_game
+ type: constraint
+ fields: [db_game_id]
+
+- entity: OddsGameLine
+ dbName: odds_games_lines
+
+- entity: Odds_OddsGame
+ dbName: odds__odds_games
+
+- entity: OddsGame_OddsGameTeam
+ dbName: odds_games__odds_games_teams
+|]
+
+instance DbImport Message where
+ dbmigrate _=
+ run_dbmigrate $ do
+ migrate (undefined :: Odds)
+ migrate (undefined :: OddsCasino)
+ migrate (undefined :: OddsGameTeam)
+ migrate (undefined :: OddsGame)
+ migrate (undefined :: Odds_OddsGame)
+ migrate (undefined :: OddsGame_OddsGameTeam)
+ migrate (undefined :: OddsGameLine)
+
+ dbimport m = do
+ -- Insert the root "odds" element and acquire its primary key (id).
+ odds_id <- insert_xml m
+
+ -- Next, we insert the home and away teams. We do this before
+ -- inserting the game itself because the game has two foreign keys
+ -- pointing to odds_games_teams.
+ forM_ (xml_games m) $ \g -> do
+ game_id <- insert_xml_or_select g
+ -- Insert a record into odds__odds_game mapping this game
+ -- to its parent in the odds table.
+ insert_ (Odds_OddsGame odds_id game_id)
+
+ -- Next to insert the home and away teams.
+ away_team_id <- insert_xml_or_select (xml_game_away_team g)
+ home_team_id <- insert_xml_or_select (xml_game_home_team g)
+
+ -- Insert a record into odds_games__odds_games_teams
+ -- mapping the home/away teams to this game.
+ insert_ (OddsGame_OddsGameTeam game_id away_team_id home_team_id)
+
+ -- Finaly, 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_game_over_under_casinos g) $ \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
+ game_id
+ ou_casino_id
+ (xml_casino_line c)
+ Nothing
+ Nothing
+
+ insertByAll 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_away_casinos $ xml_game_away_team g) $ \c ->do
+ -- insert, or more likely retrieve the existing, casino
+ a_casino_id <- insert_xml_or_select c
+
+ -- Unconditionally update that casino's away team line with ours.
+ update [Ogl_Away_Line =. (xml_casino_line c)] $ -- WHERE
+ Ogl_Odds_Casinos_Id ==. a_casino_id
+
+ -- Repeat all that for the home team.
+ forM_ (xml_home_casinos $ xml_game_home_team g) $ \c ->do
+ h_casino_id <- insert_xml_or_select c
+ update [Ogl_Home_Line =. (xml_casino_line c)] $ -- WHERE
+ Ogl_Odds_Casinos_Id ==. h_casino_id
+
+ return game_id
+
+ return ImportSucceeded
+
+pickle_game_with_notes :: PU OddsGameWithNotes
+pickle_game_with_notes =
+ xpWrap (from_pair, to_pair) $
+ xpPair
+ (xpList $ xpElem "Notes" xpText)
+ pickle_game
+ where
+ from_pair = uncurry OddsGameWithNotes
+ to_pair OddsGameWithNotes{..} = (notes, game)
+
+
-pickle_casino :: PU OddsCasino
+pickle_casino :: PU OddsGameCasinoXml
pickle_casino =
xpElem "Casino" $
xpWrap (from_tuple, to_tuple) $
xpTriple
(xpAttr "ClientID" xpInt)
(xpAttr "Name" xpText)
- (xpOption xpPrim)
+ (xpOption xpPrim) -- Double
where
- from_tuple = uncurryN OddsCasino
- to_tuple (OddsCasino x y z) = (x, y, z)
+ 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)
-instance XmlPickler OddsCasino where
- xpickle = pickle_casino
-
-pickle_home_team :: PU OddsHomeTeam
+pickle_home_team :: PU OddsGameHomeTeamXml
pickle_home_team =
xpElem "HomeTeam" $
- xpWrap (from_tuple, to_tuple) $
- xp5Tuple
- (xpElem "HomeTeamID" xpPrim)
- (xpElem "HomeRotationNumber" xpPrim)
- (xpElem "HomeAbbr" xpText)
- (xpElem "HomeTeamName" xpText)
- (xpList pickle_casino)
+ xpWrap (from_tuple, to_tuple) $
+ xp5Tuple
+ (xpElem "HomeTeamID" xpInt)
+ (xpElem "HomeRotationNumber" xpInt)
+ (xpElem "HomeAbbr" xpText)
+ (xpElem "HomeTeamName" xpText)
+ (xpList pickle_casino)
where
- from_tuple = uncurryN OddsHomeTeam
- to_tuple (OddsHomeTeam v w x y z) = (v, w, x, y, z)
-
+ from_tuple = uncurryN OddsGameHomeTeamXml
+ -- Use record wildcards to avoid unused field warnings.
+ to_tuple OddsGameHomeTeamXml{..} = (xml_home_team_id,
+ xml_home_rotation_number,
+ xml_home_abbr,
+ xml_home_team_name,
+ xml_home_casinos)
-instance XmlPickler OddsHomeTeam where
- xpickle = pickle_home_team
-pickle_away_team :: PU OddsAwayTeam
+pickle_away_team :: PU OddsGameAwayTeamXml
pickle_away_team =
xpElem "AwayTeam" $
- xpWrap (from_tuple, to_tuple) $
- xp5Tuple
- (xpElem "AwayTeamID" xpPrim)
- (xpElem "AwayRotationNumber" xpPrim)
- (xpElem "AwayAbbr" xpText)
- (xpElem "AwayTeamName" xpText)
- (xpList pickle_casino)
+ xpWrap (from_tuple, to_tuple) $
+ xp5Tuple
+ (xpElem "AwayTeamID" xpInt)
+ (xpElem "AwayRotationNumber" xpInt)
+ (xpElem "AwayAbbr" xpText)
+ (xpElem "AwayTeamName" xpText)
+ (xpList pickle_casino)
where
- from_tuple = uncurryN OddsAwayTeam
- to_tuple (OddsAwayTeam v w x y z) = (v, w, x, y, z)
+ from_tuple = uncurryN OddsGameAwayTeamXml
+ -- Use record wildcards to avoid unused field warnings.
+ to_tuple OddsGameAwayTeamXml{..} = (xml_away_team_id,
+ xml_away_rotation_number,
+ xml_away_abbr,
+ xml_away_team_name,
+ xml_away_casinos)
-instance XmlPickler OddsAwayTeam where
- xpickle = pickle_away_team
-
-pickle_over_under :: PU OddsOverUnder
+pickle_over_under :: PU OddsGameOverUnderXml
pickle_over_under =
xpElem "Over_Under" $
xpWrap (to_newtype, from_newtype) $
xpList pickle_casino
where
- from_newtype (OddsOverUnder cs) = cs
- to_newtype = OddsOverUnder
+ from_newtype (OddsGameOverUnderXml cs) = cs
+ to_newtype = OddsGameOverUnderXml
-instance XmlPickler OddsOverUnder where
- xpickle = pickle_over_under
-pickle_game :: PU OddsGame
+pickle_game :: PU OddsGameXml
pickle_game =
xpElem "Game" $
xpWrap (from_tuple, to_tuple) $
xp6Tuple
- (xpElem "GameID" xpPrim)
+ (xpElem "GameID" xpInt)
(xpElem "Game_Date" xpText)
(xpElem "Game_Time" xpText)
pickle_away_team
pickle_home_team
pickle_over_under
where
- from_tuple = uncurryN OddsGame
- to_tuple (OddsGame u v w x y z) = (u,v,w,x,y,z)
-
-instance XmlPickler OddsGame where
- xpickle = pickle_game
+ 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_game_away_team,
+ xml_game_home_team,
+ xml_game_over_under)
-pickle_message :: PU MessageXml
+pickle_message :: PU Message
pickle_message =
xpElem "message" $
xpWrap (from_tuple, to_tuple) $
- xp11Tuple (xpElem "XML_File_ID" xpPrim)
- (xpElem "heading" xpText)
- (xpElem "category" xpText)
- (xpElem "sport" xpText)
- (xpElem "Title" xpText)
- (xpElem "Line_Time" xpText)
- pickle_notes
- (xpList $ pickle_game)
- pickle_notes
- (xpList $ pickle_game)
- (xpElem "time_stamp" xpText)
+ xp8Tuple (xpElem "XML_File_ID" xpInt)
+ (xpElem "heading" xpText)
+ (xpElem "category" xpText)
+ (xpElem "sport" xpText)
+ (xpElem "Title" xpText)
+ (xpElem "Line_Time" xpText)
+ (xpList pickle_game_with_notes)
+ (xpElem "time_stamp" xpText)
where
- from_tuple = uncurryN MessageXml
- to_tuple m = undefined
-
- pickle_notes :: PU String
- pickle_notes =
- xpWrap (to_string, from_string) $
- (xpList $ xpElem "Notes" xpText)
- where
- from_string :: String -> [String]
- from_string = split "\n"
-
- to_string :: [String] -> String
- to_string = join "\n"
-
-instance XmlPickler MessageXml where
- xpickle = pickle_message
-
+ 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)
+
+
+
+-- * Tasty Tests
+odds_tests :: TestTree
+odds_tests =
+ testGroup
+ "Odds tests"
+ [ test_pickle_of_unpickle_is_identity,
+ test_unpickle_succeeds ]
+
+
+-- | Warning, succeess of this test does not mean that unpickling
+-- succeeded.
+test_pickle_of_unpickle_is_identity :: TestTree
+test_pickle_of_unpickle_is_identity =
+ testCase "pickle composed with unpickle is the identity" $ do
+ let path = "test/xml/Odds_XML.xml"
+ (expected, actual) <- pickle_unpickle pickle_message path
+ actual @?= expected
+
+
+test_unpickle_succeeds :: TestTree
+test_unpickle_succeeds =
+ testCase "unpickling succeeds" $ do
+ let path = "test/xml/Odds_XML.xml"
+ actual <- unpickleable path pickle_message
+ let expected = True
+ actual @?= expected