{-# LANGUAGE TypeFamilies #-}
-- | Parse TSN XML for the DTD \"weatherxml.dtd\". Each document
--- contains a bunch of forecasts, which each contain one league, and
--- that league contains a bunch of listings.
+-- contains a bunch of forecasts, which each contain zero or more
+-- leagues, which in turn (each) contain a bunch of listings.
--
module TSN.XML.Weather (
+ dtd,
pickle_message,
-- * Tests
weather_tests,
-- * WARNING: these are private but exported to silence warnings
WeatherConstructor(..),
+ WeatherDetailedWeatherListingItemConstructor(..),
WeatherForecastConstructor(..),
WeatherForecastListingConstructor(..) )
where
import Control.Monad ( forM_ )
import Data.Time ( UTCTime )
import Data.Tuple.Curry ( uncurryN )
-import Database.Groundhog ( migrate )
+import Database.Groundhog (
+ countAll,
+ deleteAll,
+ insert_,
+ migrate,
+ runMigration,
+ silentMigrationLogger )
import Database.Groundhog.Core ( DefaultKey )
+import Database.Groundhog.Generic ( runDbConn )
+import Database.Groundhog.Sqlite ( withSqliteConn )
import Database.Groundhog.TH (
groundhog,
mkPersist )
import Test.Tasty.HUnit ( (@?=), testCase )
import Text.XML.HXT.Core (
PU,
- xp7Tuple,
+ xp8Tuple,
+ xp9Tuple,
xpAttr,
xpElem,
xpInt,
xpOption,
xpPair,
xpText,
+ xpTriple,
xpWrap )
-- Local imports.
import TSN.Codegen (
tsn_codegen_config )
import TSN.DbImport ( DbImport(..), ImportResult(..), run_dbmigrate )
-import TSN.Picklers ( xp_gamedate, xp_time_stamp )
+import TSN.Picklers ( xp_datetime, xp_gamedate, xp_time_stamp )
import TSN.XmlImport ( XmlImport(..), XmlImportFk(..) )
import Xml (
+ Child(..),
FromXml(..),
FromXmlFk(..),
ToDb(..),
pickle_unpickle,
- unpickleable )
+ unpickleable,
+ unsafe_unpickle )
+
+
+
+-- | The DTD to which this module corresponds. Used to invoke dbimport.
+--
+dtd :: String
+dtd = "weatherxml.dtd"
--
xml_weather :: String }
deriving (Eq, Show)
--- | Database representation of a weather forecast listing.
+
+-- | Database representation of a weather forecast listing. The
+-- 'db_league_name' field should come from the containing \<league\>
+-- element which is not stored in the database.
--
data WeatherForecastListing =
WeatherForecastListing {
db_weather_forecasts_id :: DefaultKey WeatherForecast,
+ db_league_name :: Maybe String,
db_teams :: String,
db_weather :: String }
--- | The database analogue of a 'WeatherForecastListingXml' is
--- 'WeatherForecastListing'.
+-- | We don't make 'WeatherForecastListingXml' an instance of
+-- 'FromXmlFk' because it needs some additional information, namely
+-- the league name from its containing \<league\> element.
--
-instance ToDb WeatherForecastListingXml where
- type Db WeatherForecastListingXml = WeatherForecastListing
-
--- | This is needed to define the 'XmlImportFk' instance for
--- 'WeatherForecastListing'.
+-- When supplied with a forecast id and a league name, this will
+-- turn an XML listing into a database one.
--
-instance FromXmlFk WeatherForecastListingXml where
- -- | Each 'WeatherForecastListingXml' is contained in a
- -- 'WeatherForecast'.
- --
- type Parent WeatherForecastListingXml = WeatherForecast
-
- from_xml_fk fk WeatherForecastListingXml{..} =
+from_xml_fk_league :: DefaultKey WeatherForecast
+ -> (Maybe String)
+ -> WeatherForecastListingXml
+ -> WeatherForecastListing
+from_xml_fk_league fk ln WeatherForecastListingXml{..} =
WeatherForecastListing {
db_weather_forecasts_id = fk,
+ db_league_name = ln,
db_teams = xml_teams,
db_weather = xml_weather }
--- | This allows us to insert the XML representation
--- 'WeatherForecastListingXml' directly.
---
-instance XmlImportFk WeatherForecastListingXml
-
-- * WeatherLeague
-- | XML representation of a league, as they appear in the weather
-- documents. There is no associated database representation because
-- the league element really adds no information besides its own
--- (usually empty) name. Since there's exactly one league per
--- forecast, we just store the league_name in the database
--- representation of a forecast.
+-- (usually empty) name. The leagues contain listings, so we
+-- associate the league name with each listing instead.
--
data WeatherLeague =
WeatherLeague {
- league_name :: Maybe String,
- listings :: [WeatherForecastListingXml] }
+ league_name :: Maybe String,
+ listings :: [WeatherForecastListingXml] }
deriving (Eq, Show)
data WeatherForecast =
WeatherForecast {
db_weather_id :: DefaultKey Weather,
- db_game_date :: UTCTime,
- db_league_name :: Maybe String }
+ db_game_date :: UTCTime }
+
--- | XML representation of a weather forecast. It would have been
--- cleaner to omit the 'WeatherLeague' middleman, but having it
--- simplifies parsing.
+-- | XML representation of a weather forecast.
--
data WeatherForecastXml =
WeatherForecastXml {
xml_game_date :: UTCTime,
- xml_league :: WeatherLeague }
+ xml_leagues :: [WeatherLeague] }
deriving (Eq, Show)
+
instance ToDb WeatherForecastXml where
-- | The database representation of a 'WeatherForecastXml' is a
-- 'WeatherForecast'.
--
type Db WeatherForecastXml = WeatherForecast
-instance FromXmlFk WeatherForecastXml where
+
+instance Child WeatherForecastXml where
+ -- | The database type containing a 'WeatherForecastXml' is
+ -- 'Weather'.
type Parent WeatherForecastXml = Weather
+
+instance FromXmlFk WeatherForecastXml where
+
-- | To convert a 'WeatherForecastXml' into a 'WeatherForecast', we
- -- replace the 'WeatherLeague' with its name.
+ -- just copy everything verbatim.
--
from_xml_fk fk WeatherForecastXml{..} =
WeatherForecast {
db_weather_id = fk,
- db_game_date = xml_game_date,
- db_league_name = (league_name xml_league) }
+ db_game_date = xml_game_date }
-- | This allows us to call 'insert_xml' on an 'WeatherForecastXml'
--
instance XmlImportFk WeatherForecastXml
+-- * WeatherDetailedWeatherXml
+
+-- | XML Representation of a \<Detailed_Weather\>, which just contains
+-- a bunch iof \<DW_Listing\>s. There is no associated database type
+-- since these don't really contain any information.
+--
+data WeatherDetailedWeatherXml =
+ WeatherDetailedWeatherXml {
+ xml_detailed_listings :: [WeatherDetailedWeatherListingXml] }
+ deriving (Eq, Show)
+
+
+-- * WeatherDetailedWeatherXml
+
+-- | XML Representation of a \<DW_Listing\>. The sport and sport code
+-- come as attributes, but then these just contain a bunch of
+-- \<Item\>s. There is no associated database type since these don't
+-- contain much information. The sport we already know from the
+-- \<message\>, while the sport code is ignored since it's already
+-- present in each \<Item\>s.
+--
+data WeatherDetailedWeatherListingXml =
+ WeatherDetailedWeatherListingXml {
+ xml_dtl_listing_sport :: String,
+ xml_dtl_listing_sport_code :: String,
+ xml_items :: [WeatherDetailedWeatherListingItemXml] }
+ deriving (Eq, Show)
+
+-- * WeatherDetailedWeatherListingItem / WeatherDetailedWeatherListingItemXml
+
+-- | Database representation of a detailed weather item. The away/home
+-- teams don't use the representation in "TSN.Team" because all
+-- we're given is a name, and a team id is required for "TSN.Team".
+--
+-- We also drop the sport name, because it's given in the parent
+-- 'Weather'.
+--
+data WeatherDetailedWeatherListingItem =
+ WeatherDetailedWeatherListingItem {
+ db_dtl_weather_id :: DefaultKey Weather, -- ^ Avoid name collision by
+ -- using \"dtl\" prefix.
+ db_sport_code :: String,
+ db_game_id :: Int,
+ db_dtl_game_date :: UTCTime, -- ^ Avoid name clash with \"dtl\" prefix
+ db_away_team :: String,
+ db_home_team :: String,
+ db_weather_type :: Int,
+ db_description :: String,
+ db_temp_adjust :: String,
+ db_temperature :: Int }
+
+
+-- | XML representation of a detailed weather item. Same as the
+-- database representation, only without the foreign key and the
+-- sport name that comes from the containing listing.
+data WeatherDetailedWeatherListingItemXml =
+ WeatherDetailedWeatherListingItemXml {
+ xml_sport_code :: String,
+ xml_game_id :: Int,
+ xml_dtl_game_date :: UTCTime,
+ xml_away_team :: String,
+ xml_home_team :: String,
+ xml_weather_type :: Int,
+ xml_description :: String,
+ xml_temp_adjust :: String,
+ xml_temperature :: Int }
+ deriving (Eq, Show)
+
+
+instance ToDb WeatherDetailedWeatherListingItemXml where
+ -- | Our database analogue is a 'WeatherDetailedWeatherListingItem'.
+ type Db WeatherDetailedWeatherListingItemXml =
+ WeatherDetailedWeatherListingItem
+
+instance Child WeatherDetailedWeatherListingItemXml where
+ -- | We skip two levels of containers and say that the items belong
+ -- to the top-level 'Weather'.
+ type Parent WeatherDetailedWeatherListingItemXml = Weather
+
+instance FromXmlFk WeatherDetailedWeatherListingItemXml where
+ -- | To convert from the XML to database representation, we simply
+ -- add the foreign key (to Weather) and copy the rest of the fields.
+ from_xml_fk fk WeatherDetailedWeatherListingItemXml{..} =
+ WeatherDetailedWeatherListingItem {
+ db_dtl_weather_id = fk,
+ db_sport_code = xml_sport_code,
+ db_game_id = xml_game_id,
+ db_dtl_game_date = xml_dtl_game_date,
+ db_away_team = xml_away_team,
+ db_home_team = xml_home_team,
+ db_weather_type = xml_weather_type,
+ db_description = xml_description,
+ db_temp_adjust = xml_temp_adjust,
+ db_temperature = xml_temperature }
+
+-- | This allows us to insert the XML representation directly without
+-- having to do the manual XML -\> DB conversion.
+--
+instance XmlImportFk WeatherDetailedWeatherListingItemXml
-- * Weather/Message
--- | The database representation of a weather message.
+-- | The database representation of a weather message. We don't
+-- contain the forecasts or the detailed weather since those are
+-- foreigned-keyed to us.
--
data Weather =
Weather {
xml_sport :: String,
xml_title :: String,
xml_forecasts :: [WeatherForecastXml],
+ xml_detailed_weather :: Maybe WeatherDetailedWeatherXml,
xml_time_stamp :: UTCTime }
deriving (Eq, Show)
--
--- Database stuff
+-- * Database stuff
--
mkPersist tsn_codegen_config [groundhog|
reference:
onDelete: cascade
+# We rename the two fields that needed a "dtl" prefix to avoid a name clash.
+- entity: WeatherDetailedWeatherListingItem
+ dbName: weather_detailed_items
+ constructors:
+ - name: WeatherDetailedWeatherListingItem
+ fields:
+ - name: db_dtl_weather_id
+ dbName: weather_id
+ reference:
+ onDelete: cascade
+ - name: db_dtl_game_date
+ dbName: game_date
+
|]
migrate (undefined :: Weather)
migrate (undefined :: WeatherForecast)
migrate (undefined :: WeatherForecastListing)
+ migrate (undefined :: WeatherDetailedWeatherListingItem)
dbimport m = do
- -- The weather database schema has a nice linear structure. First
- -- we insert the top-level weather record.
+ -- First we insert the top-level weather record.
weather_id <- insert_xml m
-- Next insert all of the forecasts, one at a time.
forM_ (xml_forecasts m) $ \forecast -> do
forecast_id <- insert_xml_fk weather_id forecast
- -- Insert all of this forecast's listings.
- mapM_ (insert_xml_fk_ forecast_id) (listings $ xml_league forecast)
+ -- With the forecast id in hand, loop through this forecast's
+ -- leagues...
+ forM_ (xml_leagues forecast) $ \league -> do
+ -- Construct the function that converts an XML listing to a
+ -- database one.
+ let todb = from_xml_fk_league forecast_id (league_name league)
+
+ -- Now use it to convert all of the XML listings.
+ let db_listings = map todb (listings league)
+
+ -- And finally, insert those DB listings.
+ mapM_ insert_ db_listings
return ImportSucceeded
----
---- Pickling
----
+--
+-- * Pickling
+--
-- | Pickler to convert a 'WeatherForecastListingXml' to/from XML.
--
xpWrap (from_pair, to_pair) $
xpPair
(xpAttr "gamedate" xp_gamedate)
- pickle_league
+ (xpList pickle_league)
where
from_pair = uncurry WeatherForecastXml
to_pair WeatherForecastXml{..} = (xml_game_date,
- xml_league)
+ xml_leagues)
+-- | (Un)pickle a 'WeatherDetailedWeatherListingItemXml'.
+--
+pickle_item :: PU WeatherDetailedWeatherListingItemXml
+pickle_item =
+ xpElem "Item" $
+ xpWrap (from_tuple, to_tuple) $
+ xp9Tuple (xpElem "Sportcode" xpText)
+ (xpElem "GameID" xpInt)
+ (xpElem "Gamedate" xp_datetime)
+ (xpElem "AwayTeam" xpText)
+ (xpElem "HomeTeam" xpText)
+ (xpElem "WeatherType" xpInt)
+ (xpElem "Description" xpText)
+ (xpElem "TempAdjust" xpText)
+ (xpElem "Temperature" xpInt)
+ where
+ from_tuple = uncurryN WeatherDetailedWeatherListingItemXml
+ to_tuple w = (xml_sport_code w,
+ xml_game_id w,
+ xml_dtl_game_date w,
+ xml_away_team w,
+ xml_home_team w,
+ xml_weather_type w,
+ xml_description w,
+ xml_temp_adjust w,
+ xml_temperature w)
+
+
+-- | (Un)pickle a 'WeatherDetailedWeatherListingXml'.
+--
+pickle_dw_listing :: PU WeatherDetailedWeatherListingXml
+pickle_dw_listing =
+ xpElem "DW_Listing" $
+ xpWrap (from_tuple, to_tuple) $
+ xpTriple (xpAttr "SportCode" xpText)
+ (xpAttr "Sport" xpText)
+ (xpList pickle_item)
+ where
+ from_tuple = uncurryN WeatherDetailedWeatherListingXml
+ to_tuple w = (xml_dtl_listing_sport w,
+ xml_dtl_listing_sport_code w,
+ xml_items w)
+
+
+-- | (Un)pickle a 'WeatherDetailedWeatherXml'
+--
+pickle_detailed_weather :: PU WeatherDetailedWeatherXml
+pickle_detailed_weather =
+ xpElem "Detailed_Weather" $
+ xpWrap (WeatherDetailedWeatherXml, xml_detailed_listings)
+ (xpList pickle_dw_listing)
+
+
-- | Pickler to convert a 'Message' to/from XML.
--
pickle_message :: PU Message
pickle_message =
xpElem "message" $
xpWrap (from_tuple, to_tuple) $
- xp7Tuple
+ xp8Tuple
(xpElem "XML_File_ID" xpInt)
(xpElem "heading" xpText)
(xpElem "category" xpText)
(xpElem "sport" xpText)
(xpElem "title" xpText)
(xpList pickle_forecast)
+ (xpOption pickle_detailed_weather)
(xpElem "time_stamp" xp_time_stamp)
where
from_tuple = uncurryN Message
xml_sport,
xml_title,
xml_forecasts,
+ xml_detailed_weather,
xml_time_stamp)
+
--
--- Tasty tests
+-- * Tasty tests
--
-
weather_tests :: TestTree
weather_tests =
testGroup
"Weather tests"
- [ test_pickle_of_unpickle_is_identity,
+ [ test_on_delete_cascade,
+ test_pickle_of_unpickle_is_identity,
test_unpickle_succeeds ]
-- 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/weatherxml.xml"
- (expected, actual) <- pickle_unpickle pickle_message path
- actual @?= expected
+test_pickle_of_unpickle_is_identity = testGroup "pickle-unpickle tests"
+ [ check "pickle composed with unpickle is the identity"
+ "test/xml/weatherxml.xml",
+
+ check "pickle composed with unpickle is the identity (detailed)"
+ "test/xml/weatherxml-detailed.xml" ]
+ where
+ check desc path = testCase desc $ do
+ (expected, actual) <- pickle_unpickle pickle_message path
+ actual @?= expected
-- | Make sure we can actually unpickle these things.
--
test_unpickle_succeeds :: TestTree
-test_unpickle_succeeds =
- testCase "unpickling succeeds" $ do
- let path = "test/xml/weatherxml.xml"
- actual <- unpickleable path pickle_message
- let expected = True
- actual @?= expected
+test_unpickle_succeeds = testGroup "unpickle tests"
+ [ check "unpickling succeeds"
+ "test/xml/weatherxml.xml",
+ check "unpickling succeeds (detailed)"
+ "test/xml/weatherxml-detailed.xml" ]
+ where
+ check desc path = testCase desc $ do
+ actual <- unpickleable path pickle_message
+ let expected = True
+ actual @?= expected
+
+
+-- | Make sure everything gets deleted when we delete the top-level
+-- record.
+--
+test_on_delete_cascade :: TestTree
+test_on_delete_cascade = testGroup "cascading delete tests"
+ [ check "deleting weather deletes its children"
+ "test/xml/weatherxml.xml",
+ check "deleting weather deletes its children (detailed)"
+ "test/xml/weatherxml-detailed.xml" ]
+ where
+ check desc path = testCase desc $ do
+ weather <- unsafe_unpickle path pickle_message
+ let a = undefined :: Weather
+ let b = undefined :: WeatherForecast
+ let c = undefined :: WeatherForecastListing
+ let d = undefined :: WeatherDetailedWeatherListingItem
+ actual <- withSqliteConn ":memory:" $ runDbConn $ do
+ runMigration silentMigrationLogger $ do
+ migrate a
+ migrate b
+ migrate c
+ migrate d
+ _ <- dbimport weather
+ deleteAll a
+ count_a <- countAll a
+ count_b <- countAll b
+ count_c <- countAll c
+ count_d <- countAll d
+ return $ count_a + count_b + count_c + count_d
+ let expected = 0
+ actual @?= expected
projects / dead / htsn-import.git / blobdiff