X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=src%2FTSN%2FXML%2FNews.hs;h=3f9fef5375b58ec440eed4c041985871ed0d6300;hb=83bad08d7f28143cdaae42156d951b421fa15a8a;hp=20316343f8afccfe360280e6871fa003bcfea46d;hpb=c5d61081ad0d95950ca06761978d240632c44510;p=dead%2Fhtsn-import.git diff --git a/src/TSN/XML/News.hs b/src/TSN/XML/News.hs index 2031634..3f9fef5 100644 --- a/src/TSN/XML/News.hs +++ b/src/TSN/XML/News.hs @@ -3,7 +3,6 @@ {-# LANGUAGE GADTs #-} {-# LANGUAGE QuasiQuotes #-} {-# LANGUAGE RecordWildCards #-} -{-# LANGUAGE StandaloneDeriving #-} {-# LANGUAGE TemplateHaskell #-} {-# LANGUAGE TypeFamilies #-} @@ -11,14 +10,14 @@ -- a root element \ that contains an entire news item. -- module TSN.XML.News ( + dtd, pickle_message, -- * Tests news_tests, -- * WARNING: these are private but exported to silence warnings - News_NewsLocationConstructor(..), + News_LocationConstructor(..), News_NewsTeamConstructor(..), NewsConstructor(..), - NewsLocationConstructor(..), NewsTeamConstructor(..) ) where @@ -29,9 +28,15 @@ import Data.List.Utils ( join, split ) import Data.Tuple.Curry ( uncurryN ) import Data.Typeable ( Typeable ) import Database.Groundhog ( + countAll, + deleteAll, insert_, - migrate ) + migrate, + runMigration, + silentMigrationLogger ) import Database.Groundhog.Core ( DefaultKey ) +import Database.Groundhog.Generic ( runDbConn ) +import Database.Groundhog.Sqlite ( withSqliteConn ) import Database.Groundhog.TH ( defaultCodegenConfig, groundhog, @@ -48,7 +53,6 @@ import Text.XML.HXT.Core ( xpOption, xpPair, xpText, - xpTriple, xpWrap ) -- Local imports. @@ -58,8 +62,20 @@ import TSN.Codegen ( import TSN.Database ( insert_or_select ) import TSN.DbImport ( DbImport(..), ImportResult(..), run_dbmigrate ) import TSN.Picklers ( xp_time_stamp ) +import TSN.Location ( Location(..), pickle_location ) import TSN.XmlImport ( XmlImport(..) ) -import Xml ( FromXml(..), ToDb(..), pickle_unpickle, unpickleable ) +import Xml ( + FromXml(..), + ToDb(..), + pickle_unpickle, + unpickleable, + unsafe_unpickle ) + + +-- | The DTD to which this module corresponds. Used to invoke dbimport. +-- +dtd :: String +dtd = "newsxml.dtd" -- @@ -68,9 +84,9 @@ import Xml ( FromXml(..), ToDb(..), pickle_unpickle, unpickleable ) -- * News/Message --- | The msg_id child of contains an event_id attribute; we --- embed it into the 'News' type. We (pointlessly) use the "db_" --- prefix here so that the two names don't collide on "id" when +-- | The msg_id child of \ contains an event_id attribute; we +-- embed it into the 'News' type. We (pointlessly) use the \"db_\" +-- prefix here so that the two names don't collide on \"id\" when -- Groundhog is creating its fields using our field namer. -- data MsgId = @@ -91,7 +107,7 @@ data Message = xml_sport :: String, xml_url :: Maybe String, xml_teams :: [NewsTeam], - xml_locations :: [NewsLocation], + xml_locations :: [Location], xml_sms :: String, xml_editor :: Maybe String, xml_text :: Maybe String, -- Text and continue seem to show up in pairs, @@ -147,7 +163,13 @@ instance XmlImport Message -- * NewsTeam --- | The database type for teams as they show up in the news. +-- | The database/XML type for teams as they show up in the news. We +-- can't reuse the representation from "TSN.Team" because they +-- require a team id. We wouldn't want to make the team ID optional +-- and then insert a team with no id, only to find the same team +-- later with an id and be unable to update the record. (We could +-- add the update logic, but it would be more trouble than it's +-- worth.) -- data NewsTeam = NewsTeam { team_name :: String } @@ -167,28 +189,16 @@ data News_NewsTeam = News_NewsTeam (DefaultKey NewsTeam) --- * NewsLocation - --- | The database type for locations as they show up in the news. --- -data NewsLocation = - NewsLocation { - city :: Maybe String, - state :: Maybe String, - country :: String } - deriving (Eq, Show) +-- * News_Location - --- * News_NewsLocation - --- | Mapping between News records and NewsLocation records in the +-- | Mapping between 'News' records and 'Location' records in the -- database. We don't name the fields because we don't use the names -- explicitly; that means we have to give them nice database names -- via groundhog. -- -data News_NewsLocation = News_NewsLocation - (DefaultKey News) - (DefaultKey NewsLocation) +data News_Location = News_Location + (DefaultKey News) + (DefaultKey Location) @@ -198,25 +208,24 @@ data News_NewsLocation = News_NewsLocation -- | Define 'dbmigrate' and 'dbimport' for 'Message's. The import is -- slightly non-generic because of our 'News_NewsTeam' and --- 'News_NewsLocation' join tables. +-- 'News_Location' join tables. -- instance DbImport Message where dbmigrate _ = run_dbmigrate $ do + migrate (undefined :: Location) migrate (undefined :: News) migrate (undefined :: NewsTeam) migrate (undefined :: News_NewsTeam) - migrate (undefined :: NewsLocation) - migrate (undefined :: News_NewsLocation) + migrate (undefined :: News_Location) dbimport message = do -- Insert the message and acquire its primary key (unique ID) news_id <- insert_xml message - -- And insert each one into its own table. We use insert_xml_or_select - -- because we know that most teams will already exist, and we - -- want to get back the id for the existing team when - -- there's a collision. + -- Now insert the teams. We use insert_or_select because we know + -- that most teams will already exist, and we want to get back the + -- id for the existing team when there's a collision. nt_ids <- mapM insert_or_select (xml_teams message) -- Now that the teams have been inserted, create @@ -224,9 +233,9 @@ instance DbImport Message where let news_news_teams = map (News_NewsTeam news_id) nt_ids mapM_ insert_ news_news_teams - -- Do all of that over again for the NewsLocations. + -- Do all of that over again for the Locations. loc_ids <- mapM insert_or_select (xml_locations message) - let news_news_locations = map (News_NewsLocation news_id) loc_ids + let news_news_locations = map (News_Location news_id) loc_ids mapM_ insert_ news_news_locations return ImportSucceeded @@ -245,15 +254,6 @@ mkPersist defaultCodegenConfig [groundhog| type: constraint fields: [team_name] -- entity: NewsLocation - dbName: news_locations - constructors: - - name: NewsLocation - uniques: - - name: unique_news_location - type: constraint - fields: [city, state, country] - |] @@ -261,7 +261,6 @@ mkPersist defaultCodegenConfig [groundhog| -- use our own codegen to peel those off before naming the columns. mkPersist tsn_codegen_config [groundhog| - entity: News - dbName: news constructors: - name: News uniques: @@ -296,17 +295,17 @@ mkPersist tsn_codegen_config [groundhog| reference: onDelete: cascade -- entity: News_NewsLocation - dbName: news__news_locations +- entity: News_Location + dbName: news__locations constructors: - - name: News_NewsLocation + - name: News_Location fields: - - name: news_NewsLocation0 # Default created by mkNormalFieldName + - name: news_Location0 # Default created by mkNormalFieldName dbName: news_id reference: onDelete: cascade - - name: news_NewsLocation1 # Default created by mkNormalFieldName - dbName: news_locations_id + - name: news_Location1 # Default created by mkNormalFieldName + dbName: locations_id reference: onDelete: cascade |] @@ -342,20 +341,6 @@ pickle_msg_id = to_tuple m = (db_msg_id m, db_event_id m) --- | Convert a 'NewsLocation' to/from XML. --- -pickle_location :: PU NewsLocation -pickle_location = - xpElem "location" $ - xpWrap (from_tuple, to_tuple) $ - xpTriple (xpOption (xpElem "city" xpText)) - (xpOption (xpElem "state" xpText)) - (xpElem "country" xpText) - where - from_tuple = - uncurryN NewsLocation - to_tuple l = (city l, state l, country l) - -- | Convert a 'Message' to/from XML. -- @@ -420,6 +405,7 @@ news_tests = testGroup "News tests" [ test_news_fields_have_correct_names, + test_on_delete_cascade, test_pickle_of_unpickle_is_identity, test_unpickle_succeeds ] @@ -485,3 +471,38 @@ test_unpickle_succeeds = testGroup "unpickle tests" 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 news deletes its children" + "test/xml/newsxml.xml" + 4 -- 2 news_teams and 2 news_locations that should remain. + ] + where + check desc path expected = testCase desc $ do + news <- unsafe_unpickle path pickle_message + let a = undefined :: Location + let b = undefined :: News + let c = undefined :: NewsTeam + let d = undefined :: News_NewsTeam + let e = undefined :: News_Location + actual <- withSqliteConn ":memory:" $ runDbConn $ do + runMigration silentMigrationLogger $ do + migrate a + migrate b + migrate c + migrate d + migrate e + _ <- dbimport news + deleteAll b + count_a <- countAll a + count_b <- countAll b + count_c <- countAll c + count_d <- countAll d + count_e <- countAll e + return $ count_a + count_b + count_c + count_d + count_e + actual @?= expected