+{-# LANGUAGE FlexibleInstances #-}
+{-# LANGUAGE GADTs #-}
+{-# LANGUAGE QuasiQuotes #-}
+{-# LANGUAGE RecordWildCards #-}
+{-# LANGUAGE TemplateHaskell #-}
+{-# LANGUAGE TypeFamilies #-}
+
-- | GameInfo represents a collection of DTDs that we don't really
-- handle but want to make available. The raw XML gets stored in the
-- database along with the XML_File_ID, but we don't parse any of it.
--
module TSN.XML.GameInfo (
dtds,
- from_xml )
+ gameinfo_tests,
+ parse_xml,
+ -- * WARNING: these are private but exported to silence warnings
+ GameInfoConstructor(..) )
where
+-- System imports.
+import Data.Either ( rights )
import Data.Time.Clock ( UTCTime )
+import Database.Groundhog (
+ countAll,
+ migrate,
+ runMigration,
+ silentMigrationLogger )
+import Database.Groundhog.Generic ( runDbConn )
+import Database.Groundhog.Sqlite ( withSqliteConn )
+import Database.Groundhog.TH (
+ groundhog,
+ mkPersist )
+import Test.Tasty ( TestTree, testGroup )
+import Test.Tasty.HUnit ( (@?=), testCase )
import Text.XML.HXT.Core ( XmlTree )
import Text.XML.HXT.DOM.ShowXml ( xshow )
+-- Local imports.
+import TSN.Codegen ( tsn_codegen_config )
+import TSN.DbImport (
+ DbImport(..),
+ ImportResult(..),
+ run_dbmigrate )
import TSN.Parse (
parse_message,
parse_xmlfid,
parse_xml_time_stamp )
+import TSN.XmlImport ( XmlImport(..) )
+import Xml (
+ FromXml(..),
+ ToDb(..),
+ unsafe_read_document )
+
-- | The DTDs for everything that we consider "Game Info."
--
"Matchup_NBA_NHL_XML.dtd",
"mlbpreviewxml.dtd",
"MLB_Gaming_Matchup_XML.dtd",
- "MLB.dtd",
"MLB_Lineup_XML.dtd",
"MLB_Matchup_XML.dtd",
"MLS_Preview_XML.dtd",
"NBA_Gaming_Matchup_XML.dtd",
- "NBA.dtd",
"NBA_Playoff_Matchup_XML.dtd",
"NBALineupXML.dtd",
"nbapreviewxml.dtd",
"WorldBaseballPreviewXML.dtd" ]
--- | The data structure that holds the XML representation of a
--- GameInfo message.
+-- | XML representation of a GameInfo \<message\>.
--
data Message =
Message {
- dtd :: String,
- xml_file_id :: Int,
- time_stamp :: UTCTime,
- xml :: String }
+ xml_dtd :: String,
+ xml_xml_file_id :: Int,
+ xml_time_stamp :: UTCTime,
+ xml_xml :: String }
deriving (Eq, Show)
-from_xml :: String -> XmlTree -> Either String Message
-from_xml dtdname xmltree = do
+-- | Attempt to parse a 'Message' from an 'XmlTree'. If we cannot,
+-- we fail with an error message.
+--
+parse_xml :: String -> XmlTree -> Either String Message
+parse_xml dtdname xmltree = do
xmlfid <- parse_xmlfid xmltree
timestamp <- parse_xml_time_stamp xmltree
message <- parse_message xmltree
return $ Message dtdname (fromInteger xmlfid) timestamp (xshow [message])
+
+-- | Database representation of a 'Message'.
+--
+data GameInfo =
+ GameInfo {
+ db_dtd :: String,
+ db_xml_file_id :: Int,
+ db_time_stamp :: UTCTime,
+ db_xml :: String }
+
+
+instance ToDb Message where
+ -- | The database analogue of a 'Message' is an 'GameInfo'.
+ type Db Message = GameInfo
+
+instance FromXml Message where
+ -- | The XML to DB conversion is trivial here.
+ --
+ from_xml Message{..} = GameInfo {
+ db_dtd = xml_dtd,
+ db_xml_file_id = xml_xml_file_id,
+ db_time_stamp = xml_time_stamp,
+ db_xml = xml_xml }
+
+
+-- | This allows us to insert the XML representation 'Message'
+-- directly.
+--
+instance XmlImport Message
+
+
+--
+-- Database code
+--
+
+instance DbImport Message where
+ dbmigrate _ =
+ run_dbmigrate $ migrate (undefined :: GameInfo)
+
+ -- | We import a 'Message' by inserting the whole thing at
+ -- once. Nothing fancy going on here.
+ dbimport msg = do
+ insert_xml_ msg
+ return ImportSucceeded
+
+
+-- | The database schema for GameInfo is trivial; all we need is for
+-- the XML_File_ID to be unique.
+--
+mkPersist tsn_codegen_config [groundhog|
+- entity: GameInfo
+ constructors:
+ - name: GameInfo
+ uniques:
+ - name: unique_game_info
+ type: constraint
+ # Prevent multiple imports of the same message.
+ fields: [db_xml_file_id]
+|]
+
+
+--
+-- Tasty Tests
+--
+
+-- | A list of all tests for this module.
+--
+gameinfo_tests :: TestTree
+gameinfo_tests =
+ testGroup
+ "GameInfo tests"
+ [ test_parse_xml_succeeds,
+ test_dbimport_succeeds ]
+
+
+-- | Sample XML documents for GameInfo types.
+--
+gameinfo_test_files :: [FilePath]
+gameinfo_test_files =
+ [ "test/xml/gameinfo/CBASK_Lineup_XML.xml",
+ "test/xml/gameinfo/cbaskpreviewxml.xml",
+ "test/xml/gameinfo/cflpreviewxml.xml",
+ "test/xml/gameinfo/Matchup_NBA_NHL_XML.xml",
+ "test/xml/gameinfo/MLB_Gaming_Matchup_XML.xml",
+ "test/xml/gameinfo/MLB_Lineup_XML.xml",
+ "test/xml/gameinfo/MLB_Matchup_XML.xml",
+ "test/xml/gameinfo/mlbpreviewxml.xml",
+ "test/xml/gameinfo/MLS_Preview_XML.xml",
+ "test/xml/gameinfo/NBA_Gaming_Matchup_XML.xml",
+ "test/xml/gameinfo/NBALineupXML.xml",
+ "test/xml/gameinfo/NBA_Playoff_Matchup_XML.xml",
+ "test/xml/gameinfo/NCAA_FB_Preview_XML.xml",
+ "test/xml/gameinfo/nbapreviewxml.xml",
+ "test/xml/gameinfo/nflpreviewxml.xml",
+ "test/xml/gameinfo/NFL_NCAA_FB_Matchup_XML.xml",
+ "test/xml/gameinfo/nhlpreviewxml.xml",
+ "test/xml/gameinfo/recapxml.xml",
+ "test/xml/gameinfo/WorldBaseballPreviewXML.xml" ]
+
+
+-- | Make sure we can parse every element of 'gameinfo_test_files'.
+--
+test_parse_xml_succeeds :: TestTree
+test_parse_xml_succeeds =
+ testGroup "parse_xml" $ map check gameinfo_test_files
+ where
+ check t = testCase t $ do
+ x <- unsafe_read_document t
+ let result = parse_xml "dummy" x
+ let actual = case result of -- isRight appears in base-4.7
+ Left _ -> False
+ Right _ -> True
+ let expected = True
+ actual @?= expected
+
+
+-- | Ensure that each element of 'gameinfo_test_files' can be imported
+-- by counting the total number of database records (after
+-- importing) and comparing it against the length of
+-- 'gameinfo_test_files'.
+--
+test_dbimport_succeeds :: TestTree
+test_dbimport_succeeds = testCase "dbimport succeeds" $ do
+ xmltrees <- mapM unsafe_read_document gameinfo_test_files
+ let msgs = rights $ map (parse_xml "dummy") xmltrees
+ actual <- withSqliteConn ":memory:" $ runDbConn $ do
+ runMigration silentMigrationLogger $ do
+ migrate (undefined :: GameInfo)
+ mapM_ dbimport msgs
+ countAll (undefined :: GameInfo)
+
+ actual @?= expected
+ where
+ expected = length gameinfo_test_files
projects / dead / htsn-import.git / blobdiff