X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=src%2FTSN%2FXML%2FWeather.hs;h=2bcb7360155947f5b5dbb94e7a5683809ae6c554;hb=928a90109375caaa888ae4413151b560838948b7;hp=c2eee4a6c739625d9ec19f114fadae12f854072b;hpb=6ccdf3223bd4025a8e57cec1c99633a381a9698e;p=dead%2Fhtsn-import.git diff --git a/src/TSN/XML/Weather.hs b/src/TSN/XML/Weather.hs index c2eee4a..2bcb736 100644 --- a/src/TSN/XML/Weather.hs +++ b/src/TSN/XML/Weather.hs @@ -1,3 +1,4 @@ +{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE GADTs #-} {-# LANGUAGE QuasiQuotes #-} @@ -11,7 +12,9 @@ -- module TSN.XML.Weather ( dtd, + is_type1, pickle_message, + teams_are_normal, -- * Tests weather_tests, -- * WARNING: these are private but exported to silence warnings @@ -25,23 +28,33 @@ where import Control.Monad ( forM_ ) import Data.Time ( UTCTime ) import Data.Tuple.Curry ( uncurryN ) +import qualified Data.Vector.HFixed as H ( HVector, cons, convert ) import Database.Groundhog ( countAll, deleteAll, insert_, - migrate, - runMigration, - silentMigrationLogger ) + migrate ) 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.XML.HXT.Core ( PU, + XmlTree, + (/>), + (>>>), + addNav, + descendantAxis, + filterAxis, + followingSiblingAxis, + hasName, + remNav, + runLA, xp8Tuple, xp9Tuple, xpAttr, @@ -67,6 +80,7 @@ import Xml ( ToDb(..), pickle_unpickle, unpickleable, + unsafe_read_invalid_document, unsafe_unpickle ) @@ -88,8 +102,13 @@ dtd = "weatherxml.dtd" data WeatherForecastListingXml = WeatherForecastListingXml { xml_teams :: String, - xml_weather :: String } - deriving (Eq, Show) + xml_weather :: Maybe String } + deriving (Eq, GHC.Generic, Show) + + +-- | For 'H.convert'. +-- +instance H.HVector WeatherForecastListingXml -- | Database representation of a weather forecast listing. The @@ -101,7 +120,7 @@ data WeatherForecastListing = db_weather_forecasts_id :: DefaultKey WeatherForecast, db_league_name :: Maybe String, db_teams :: String, - db_weather :: String } + db_weather :: Maybe String } -- | We don't make 'WeatherForecastListingXml' an instance of @@ -154,7 +173,12 @@ data WeatherForecastXml = WeatherForecastXml { xml_game_date :: UTCTime, xml_leagues :: [WeatherLeague] } - deriving (Eq, Show) + deriving (Eq, GHC.Generic, Show) + + +-- | For 'H.convert'. +-- +instance H.HVector WeatherForecastXml instance ToDb WeatherForecastXml where @@ -173,7 +197,10 @@ instance Child WeatherForecastXml where instance FromXmlFk WeatherForecastXml where -- | To convert a 'WeatherForecastXml' into a 'WeatherForecast', we - -- just copy everything verbatim. + -- add the foreign key to the containing 'Weather', and copy the + -- game date. + -- + -- This is so short it's pointless to do it generically. -- from_xml_fk fk WeatherForecastXml{..} = WeatherForecast { @@ -208,11 +235,26 @@ data WeatherDetailedWeatherXml = -- present in each \s. -- data WeatherDetailedWeatherListingXml = - WeatherDetailedWeatherListingXml { - xml_dtl_listing_sport :: String, - xml_dtl_listing_sport_code :: String, - xml_items :: [WeatherDetailedWeatherListingItemXml] } - deriving (Eq, Show) + WeatherDetailedWeatherListingXml + String -- xml_dtl_listing_sport, unused + String -- xml_dtl_listing_sport_code, unused + [WeatherDetailedWeatherListingItemXml] -- xml_items + deriving (Eq, GHC.Generic, Show) + + +-- | Accessor for the third field of WeatherDetailedWeatherListingXml. +-- We don't use field names to avoid the unused field warnings that +-- we'd otherwise get for the first two fields. +-- +xml_items :: WeatherDetailedWeatherListingXml + -> [WeatherDetailedWeatherListingItemXml] +xml_items (WeatherDetailedWeatherListingXml _ _ items) = items + + +-- | For 'H.convert'. +-- +instance H.HVector WeatherDetailedWeatherListingXml + -- * WeatherDetailedWeatherListingItem / WeatherDetailedWeatherListingItemXml @@ -223,37 +265,51 @@ data WeatherDetailedWeatherListingXml = -- We also drop the sport name, because it's given in the parent -- 'Weather'. -- +-- The leading underscores prevent unused field warnings. +-- data WeatherDetailedWeatherListingItem = WeatherDetailedWeatherListingItem { - db_dtl_weather_id :: DefaultKey Weather, -- ^ Avoid name collision by + _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 } + _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 :: Maybe String, + _db_temp_adjust :: Maybe String, + _db_temperature :: Int } + deriving ( GHC.Generic ) + +-- | For 'H.cons' and 'H.convert'. +-- +instance H.HVector WeatherDetailedWeatherListingItem -- | 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. +-- +-- The leading underscores prevent unused field warnings. +-- 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) + _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 :: Maybe String, + _xml_temp_adjust :: Maybe String, + _xml_temperature :: Int } + deriving (Eq, GHC.Generic, Show) + +-- | For 'H.convert'. +-- +instance H.HVector WeatherDetailedWeatherListingItemXml instance ToDb WeatherDetailedWeatherListingItemXml where -- | Our database analogue is a 'WeatherDetailedWeatherListingItem'. @@ -268,18 +324,7 @@ instance Child WeatherDetailedWeatherListingItemXml where 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 } + from_xml_fk = H.cons -- | This allows us to insert the XML representation directly without -- having to do the manual XML -\> DB conversion. @@ -312,7 +357,13 @@ data Message = xml_forecasts :: [WeatherForecastXml], xml_detailed_weather :: Maybe WeatherDetailedWeatherXml, xml_time_stamp :: UTCTime } - deriving (Eq, Show) + deriving (Eq, GHC.Generic, Show) + + +-- | For 'H.convert'. +-- +instance H.HVector Message + instance ToDb Message where -- | The database representation of 'Message' is 'Weather'. @@ -368,22 +419,78 @@ mkPersist tsn_codegen_config [groundhog| reference: onDelete: cascade -# We rename the two fields that needed a "dtl" prefix to avoid a name clash. + # 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 + - name: _db_dtl_weather_id dbName: weather_id reference: onDelete: cascade - - name: db_dtl_game_date + - name: _db_dtl_game_date dbName: game_date |] + +-- | There are two different types of documents that claim to be +-- \"weatherxml.dtd\". The first, more common type has listings +-- within forecasts. The second type has forecasts within +-- listings. Clearly we can't parse both of these using the same +-- parser! +-- +-- For now we're simply punting on the issue and refusing to parse +-- the second type. This will check the given @xmltree@ to see if +-- there are any forecasts contained within listings. If there are, +-- then it's the second type that we don't know what to do with. +-- +is_type1 :: XmlTree -> Bool +is_type1 xmltree = + case elements of + [] -> True + _ -> False + where + parse :: XmlTree -> [XmlTree] + parse = runLA $ hasName "/" + /> hasName "message" + /> hasName "listing" + /> hasName "forecast" + + elements = parse xmltree + + +-- | Some weatherxml documents even have the Home/Away teams in the +-- wrong order. We can't parse that! This next bit of voodoo detects +-- whether or not there are any \ elements that are +-- directly followed by sibling \ elements. This is the +-- opposite of the usual order. +-- +teams_are_normal :: XmlTree -> Bool +teams_are_normal xmltree = + case elements of + [] -> True + _ -> False + where + parse :: XmlTree -> [XmlTree] + parse = runLA $ hasName "/" + /> hasName "message" + /> hasName "Detailed_Weather" + /> hasName "DW_Listing" + /> hasName "Item" + >>> addNav + >>> descendantAxis + >>> filterAxis (hasName "HomeTeam") + >>> followingSiblingAxis + >>> remNav + >>> hasName "AwayTeam" + + elements = parse xmltree + + instance DbImport Message where dbmigrate _ = run_dbmigrate $ do @@ -413,6 +520,14 @@ instance DbImport Message where -- And finally, insert those DB listings. mapM_ insert_ db_listings + -- Now we do the detailed weather items. + case (xml_detailed_weather m) of + Nothing -> return () + Just dw -> do + let detailed_listings = xml_detailed_listings dw + let items = concatMap xml_items detailed_listings + mapM_ (insert_xml_fk_ weather_id) items + return ImportSucceeded @@ -425,13 +540,13 @@ instance DbImport Message where pickle_listing :: PU WeatherForecastListingXml pickle_listing = xpElem "listing" $ - xpWrap (from_pair, to_pair) $ + xpWrap (from_pair, H.convert) $ xpPair (xpElem "teams" xpText) - (xpElem "weather" xpText) + (xpElem "weather" (xpOption xpText)) where from_pair = uncurry WeatherForecastListingXml - to_pair WeatherForecastListingXml{..} = (xml_teams, xml_weather) + -- | Pickler to convert a 'WeatherLeague' to/from XML. @@ -469,27 +584,19 @@ pickle_forecast = pickle_item :: PU WeatherDetailedWeatherListingItemXml pickle_item = xpElem "Item" $ - xpWrap (from_tuple, to_tuple) $ + xpWrap (from_tuple, H.convert) $ 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 "Description" (xpOption xpText)) + (xpElem "TempAdjust" (xpOption 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'. @@ -497,15 +604,12 @@ pickle_item = pickle_dw_listing :: PU WeatherDetailedWeatherListingXml pickle_dw_listing = xpElem "DW_Listing" $ - xpWrap (from_tuple, to_tuple) $ + xpWrap (from_tuple, H.convert) $ 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' @@ -522,7 +626,7 @@ pickle_detailed_weather = 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) @@ -534,14 +638,6 @@ pickle_message = (xpElem "time_stamp" xp_time_stamp) where from_tuple = uncurryN Message - to_tuple Message{..} = (xml_xml_file_id, - xml_heading, - xml_category, - xml_sport, - xml_title, - xml_forecasts, - xml_detailed_weather, - xml_time_stamp) -- @@ -553,7 +649,9 @@ weather_tests = "Weather tests" [ test_on_delete_cascade, test_pickle_of_unpickle_is_identity, - test_unpickle_succeeds ] + test_unpickle_succeeds, + test_types_detected_correctly, + test_normal_teams_detected_correctly ] -- | If we unpickle something and then pickle it, we should wind up @@ -580,7 +678,9 @@ test_unpickle_succeeds = testGroup "unpickle tests" [ check "unpickling succeeds" "test/xml/weatherxml.xml", check "unpickling succeeds (detailed)" - "test/xml/weatherxml-detailed.xml" ] + "test/xml/weatherxml-detailed.xml", + check "unpickling succeeds (empty weather)" + "test/xml/weatherxml-empty-weather.xml"] where check desc path = testCase desc $ do actual <- unpickleable path pickle_message @@ -596,7 +696,9 @@ 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" ] + "test/xml/weatherxml-detailed.xml", + check "deleting weather deletes its children (empty weather)" + "test/xml/weatherxml-empty-weather.xml"] where check desc path = testCase desc $ do weather <- unsafe_unpickle path pickle_message @@ -605,7 +707,7 @@ test_on_delete_cascade = testGroup "cascading delete tests" let c = undefined :: WeatherForecastListing let d = undefined :: WeatherDetailedWeatherListingItem actual <- withSqliteConn ":memory:" $ runDbConn $ do - runMigration silentMigrationLogger $ do + runMigrationSilent $ do migrate a migrate b migrate c @@ -619,3 +721,49 @@ test_on_delete_cascade = testGroup "cascading delete tests" return $ count_a + count_b + count_c + count_d let expected = 0 actual @?= expected + + +-- | We want to make sure type1 documents are detected as type1, and +-- type2 documents detected as type2.. +-- +test_types_detected_correctly :: TestTree +test_types_detected_correctly = + testGroup "weatherxml types detected correctly" + [ check "test/xml/weatherxml.xml" + "first type detected correctly" + True, + check "test/xml/weatherxml-detailed.xml" + "first type detected correctly (detailed)" + True, + check "test/xml/weatherxml-empty-weather.xml" + "first type detected correctly (empty weather)" + True, + check "test/xml/weatherxml-type2.xml" + "second type detected correctly" + False ] + where + check path desc expected = testCase desc $ do + xmltree <- unsafe_read_invalid_document path + let actual = is_type1 xmltree + actual @?= expected + + +-- | We want to make sure normal teams are detected as normal, and the +-- backwards ones are flagged as backwards. +-- +test_normal_teams_detected_correctly :: TestTree +test_normal_teams_detected_correctly = + testGroup "team order is detected correctly" [ + + check "normal teams are detected correctly" + "test/xml/weatherxml.xml" + True, + + check "backwards teams are detected correctly" + "test/xml/weatherxml-backwards-teams.xml" + False ] + where + check desc path expected = testCase desc $ do + xmltree <- unsafe_read_invalid_document path + let actual = teams_are_normal xmltree + actual @?= expected