1 {-# LANGUAGE FlexibleInstances #-}
3 {-# LANGUAGE QuasiQuotes #-}
4 {-# LANGUAGE RecordWildCards #-}
5 {-# LANGUAGE TemplateHaskell #-}
6 {-# LANGUAGE TypeFamilies #-}
8 -- | GameInfo represents a collection of DTDs that we don't really
9 -- handle but want to make available. The raw XML gets stored in the
10 -- database along with the XML_File_ID, but we don't parse any of it.
12 -- See also: TSN.XML.SportInfo
14 module TSN.XML.GameInfo (
18 -- * WARNING: these are private but exported to silence warnings
19 GameInfoConstructor(..) )
23 import Data.Either ( rights )
24 import Data.String.Utils ( replace )
25 import Data.Time.Clock ( UTCTime )
26 import Database.Groundhog (
30 silentMigrationLogger )
31 import Database.Groundhog.Generic ( runDbConn )
32 import Database.Groundhog.Sqlite ( withSqliteConn )
33 import Database.Groundhog.TH (
36 import Test.Tasty ( TestTree, testGroup )
37 import Test.Tasty.HUnit ( (@?=), testCase )
38 import Text.XML.HXT.Core ( XmlTree )
39 import Text.XML.HXT.DOM.ShowXml ( xshow )
42 import TSN.Codegen ( tsn_codegen_config )
50 parse_xml_time_stamp )
51 import TSN.XmlImport ( XmlImport(..) )
55 unsafe_read_document )
58 -- | The DTDs for everything that we consider \"Game Info.\"
60 -- TODO: This is the list from the old implementation. We need to
61 -- make sure that we are really receiving XML for these DTDs
62 -- (i.e. the names are correct).
66 [ "CBASK_Lineup_XML.dtd",
67 "cbaskpreviewxml.dtd",
69 "Matchup_NBA_NHL_XML.dtd",
71 "MLB_Gaming_Matchup_XML.dtd",
73 "MLB_Matchup_XML.dtd",
74 "MLS_Preview_XML.dtd",
75 "NBA_Gaming_Matchup_XML.dtd",
76 "NBA_Playoff_Matchup_XML.dtd",
79 "NCAA_FB_Preview_XML.dtd",
81 "NFL_NCAA_FB_Matchup_XML.dtd",
84 "WorldBaseballPreviewXML.dtd" ]
87 -- | XML representation of a GameInfo \<message\>.
92 xml_xml_file_id :: Int,
93 xml_time_stamp :: UTCTime,
98 -- | Attempt to parse a 'Message' from an 'XmlTree'. If we cannot,
99 -- we fail with an error message.
101 parse_xml :: String -> XmlTree -> Either String Message
102 parse_xml dtdname xmltree = do
103 xmlfid <- parse_xmlfid xmltree
104 timestamp <- parse_xml_time_stamp xmltree
105 message <- parse_message xmltree
106 return $ Message dtdname (fromInteger xmlfid) timestamp (xshow [message])
109 -- | Database representation of a 'Message'.
114 db_xml_file_id :: Int,
115 db_time_stamp :: UTCTime,
119 instance ToDb Message where
120 -- | The database analogue of a 'Message' is an 'GameInfo'.
121 type Db Message = GameInfo
123 instance FromXml Message where
124 -- | The XML to DB conversion is trivial here.
126 from_xml Message{..} = GameInfo {
128 db_xml_file_id = xml_xml_file_id,
129 db_time_stamp = xml_time_stamp,
133 -- | This allows us to insert the XML representation 'Message'
136 instance XmlImport Message
143 instance DbImport Message where
145 run_dbmigrate $ migrate (undefined :: GameInfo)
147 -- | We import a 'Message' by inserting the whole thing at
148 -- once. Nothing fancy going on here.
151 return ImportSucceeded
154 -- | The database schema for GameInfo is trivial; all we need is for
155 -- the XML_File_ID to be unique.
157 mkPersist tsn_codegen_config [groundhog|
162 - name: unique_game_info
164 # Prevent multiple imports of the same message.
165 fields: [db_xml_file_id]
173 -- | A list of all tests for this module.
175 game_info_tests :: TestTree
179 [ test_parse_xml_succeeds,
180 test_dbimport_succeeds ]
183 -- | Sample XML documents for GameInfo types.
185 game_info_test_files :: [FilePath]
186 game_info_test_files =
187 map (change_suffix . add_path) dtds
189 add_path = ("test/xml/gameinfo/" ++ )
190 change_suffix = replace ".dtd" ".xml"
192 -- | Make sure we can parse every element of 'game_info_test_files'.
194 test_parse_xml_succeeds :: TestTree
195 test_parse_xml_succeeds =
196 testGroup "parse_xml" $ map check game_info_test_files
198 check t = testCase t $ do
199 x <- unsafe_read_document t
200 let result = parse_xml "dummy" x
201 let actual = case result of -- isRight appears in base-4.7
208 -- | Ensure that each element of 'game_info_test_files' can be imported
209 -- by counting the total number of database records (after
210 -- importing) and comparing it against the length of
211 -- 'game_info_test_files'.
213 test_dbimport_succeeds :: TestTree
214 test_dbimport_succeeds = testCase "dbimport succeeds" $ do
215 xmltrees <- mapM unsafe_read_document game_info_test_files
216 let msgs = rights $ map (parse_xml "dummy") xmltrees
217 actual <- withSqliteConn ":memory:" $ runDbConn $ do
218 runMigration silentMigrationLogger $ do
219 migrate (undefined :: GameInfo)
221 countAll (undefined :: GameInfo)
225 expected = length game_info_test_files