1 {-# LANGUAGE DeriveDataTypeable #-}
2 {-# LANGUAGE FlexibleInstances #-}
4 {-# LANGUAGE QuasiQuotes #-}
5 {-# LANGUAGE RecordWildCards #-}
6 {-# LANGUAGE StandaloneDeriving #-}
7 {-# LANGUAGE TemplateHaskell #-}
8 {-# LANGUAGE TypeFamilies #-}
10 -- | Parse TSN XML for the DTD "newsxml.dtd". Each document contains a
11 -- root element \<message\> that contains an entire news item.
17 -- * WARNING: these are private but exported to silence warnings
18 News_NewsLocationConstructor(..),
19 News_NewsTeamConstructor(..),
21 NewsLocationConstructor(..),
22 NewsTeamConstructor(..) )
26 import Data.Data ( Data, constrFields, dataTypeConstrs, dataTypeOf )
27 import Data.List.Utils ( join, split )
28 import Data.Tuple.Curry ( uncurryN )
29 import Data.Typeable ( Typeable )
30 import Database.Groundhog (
33 import Database.Groundhog.Core ( DefaultKey )
34 import Database.Groundhog.TH (
38 import Test.Tasty ( TestTree, testGroup )
39 import Test.Tasty.HUnit ( (@?=), testCase )
40 import Text.XML.HXT.Core (
56 tsn_db_field_namer ) -- Used in a test
57 import TSN.DbImport ( DbImport(..), ImportResult(..), run_dbmigrate )
58 import TSN.XmlImport ( XmlImport(..) )
59 import Xml ( FromXml(..), pickle_unpickle, unpickleable )
63 -- | The database type for teams as they show up in the news.
66 NewsTeam { team_name :: String }
69 -- | This is needed to define the XmlImport instance for NewsTeam; it
70 -- basically says that the DB representation is the same as the XML
73 instance FromXml NewsTeam where
74 type Db NewsTeam = NewsTeam
77 -- | Allow us to call 'insert_xml' on the XML representation of
80 instance XmlImport NewsTeam
83 -- | Mapping between News records and NewsTeam records in the
84 -- database. We don't name the fields because we don't use the names
85 -- explicitly; that means we have to give them nice database names
88 data News_NewsTeam = News_NewsTeam
93 -- | The database type for locations as they show up in the news.
98 state :: Maybe String,
102 -- | This is needed to define the XmlImport instance for NewsLocation; it
103 -- basically says that the DB representation is the same as the XML
106 instance FromXml NewsLocation where
107 type Db NewsLocation = NewsLocation
110 -- | Allow us to call 'insert_xml' on the XML representation of
113 instance XmlImport NewsLocation
116 -- | Mapping between News records and NewsLocation records in the
117 -- database. We don't name the fields because we don't use the names
118 -- explicitly; that means we have to give them nice database names
121 data News_NewsLocation = News_NewsLocation
123 (DefaultKey NewsLocation)
126 -- | The msg_id child of <message> contains an event_id attribute; we
127 -- embed it into the 'News' type. We (pointlessly) use the "db_"
128 -- prefix here so that the two names don't collide on "id" when
129 -- Groundhog is creating its fields using our field namer.
133 db_event_id :: Maybe Int }
134 deriving (Data, Eq, Show, Typeable)
137 -- | The XML representation of a news item (message).
141 xml_xml_file_id :: Int,
142 xml_heading :: String,
144 xml_category :: String,
146 xml_url :: Maybe String,
147 xml_teams :: [NewsTeam],
148 xml_locations :: [NewsLocation],
150 xml_editor :: Maybe String,
151 xml_text :: Maybe String, -- Text and continue seem to show up in pairs,
152 xml_continue :: Maybe String, -- either both present or both missing.
153 xml_time_stamp :: String }
157 -- | The database representation of a news item. We drop several
158 -- uninteresting fields from 'Message', and omit the list fields which
159 -- will be represented as join tables.
165 db_url :: Maybe String,
167 db_editor :: Maybe String,
168 db_text :: Maybe String,
169 db_continue :: Maybe String }
170 deriving (Data, Eq, Show, Typeable)
173 -- | Convert the XML representation 'Message' to the database
174 -- representation 'News'.
176 instance FromXml Message where
177 type Db Message = News
179 -- | We use a record wildcard so GHC doesn't complain that we never
180 -- used the field names.
182 from_xml Message{..} = News { db_mid = xml_mid,
183 db_sport = xml_sport,
186 db_editor = xml_editor,
188 db_continue = xml_continue }
190 -- | This lets us call 'insert_xml' on a 'Message'.
192 instance XmlImport Message
194 -- | Define 'dbmigrate' and 'dbimport' for 'Message's. The import is
195 -- slightly non-generic because of our 'News_NewsTeam' and
196 -- 'News_NewsLocation' join tables.
198 instance DbImport Message where
201 migrate (undefined :: NewsTeam)
202 migrate (undefined :: NewsLocation)
203 migrate (undefined :: News)
204 migrate (undefined :: News_NewsTeam)
205 migrate (undefined :: News_NewsLocation)
207 dbimport message = do
208 -- Insert the message and acquire its primary key (unique ID)
209 news_id <- insert_xml message
211 -- And insert each one into its own table. We use insert_xml_or_select
212 -- because we know that most teams will already exist, and we
213 -- want to get back the id for the existing team when
214 -- there's a collision.
215 nt_ids <- mapM insert_xml_or_select (xml_teams message)
217 -- Now that the teams have been inserted, create
218 -- news__news_team records mapping beween the two.
219 let news_news_teams = map (News_NewsTeam news_id) nt_ids
220 mapM_ insert_ news_news_teams
222 -- Do all of that over again for the NewsLocations.
223 loc_ids <- mapM insert_xml_or_select (xml_locations message)
224 let news_news_locations = map (News_NewsLocation news_id) loc_ids
225 mapM_ insert_ news_news_locations
227 return ImportSucceeded
230 -- These types don't have special XML representations or field name
231 -- collisions so we use the defaultCodegenConfig and give their
232 -- fields nice simple names.
233 mkPersist defaultCodegenConfig [groundhog|
239 - name: unique_news_team
243 - entity: NewsLocation
244 dbName: news_locations
248 - name: unique_news_location
250 fields: [city, state, country]
255 -- These types have fields with e.g. db_ and xml_ prefixes, so we
256 -- use our own codegen to peel those off before naming the columns.
257 mkPersist tsn_codegen_config [groundhog|
265 - {name: msg_id, dbName: msg_id}
266 - {name: event_id, dbName: event_id}
275 - entity: News_NewsTeam
276 dbName: news__news_teams
278 - name: News_NewsTeam
280 - name: news_NewsTeam0 # Default created by mkNormalFieldName
282 - name: news_NewsTeam1 # Default created by mkNormalFieldName
283 dbName: news_teams_id
285 - entity: News_NewsLocation
286 dbName: news__news_locations
288 - name: News_NewsLocation
290 - name: news_NewsLocation0 # Default created by mkNormalFieldName
292 - name: news_NewsLocation1 # Default created by mkNormalFieldName
293 dbName: news_locations_id
297 -- | Convert a 'NewsTeam' to/from XML.
299 pickle_news_team :: PU NewsTeam
302 xpWrap (from_string, to_string) xpText
304 to_string :: NewsTeam -> String
305 to_string = team_name
307 from_string :: String -> NewsTeam
308 from_string = NewsTeam
311 -- | Convert a 'MsgId' to/from XML.
313 pickle_msg_id :: PU MsgId
316 xpWrap (from_tuple, to_tuple) $
317 xpPair xpInt (xpAttr "EventId" (xpOption xpInt))
319 from_tuple = uncurryN MsgId
320 to_tuple m = (db_msg_id m, db_event_id m)
323 -- | Convert a 'NewsLocation' to/from XML.
325 pickle_location :: PU NewsLocation
328 xpWrap (from_tuple, to_tuple) $
329 xpTriple (xpOption (xpElem "city" xpText))
330 (xpOption (xpElem "state" xpText))
331 (xpElem "country" xpText)
334 uncurryN NewsLocation
335 to_tuple l = (city l, state l, country l)
338 -- | Convert a 'Message' to/from XML.
340 pickle_message :: PU Message
343 xpWrap (from_tuple, to_tuple) $
344 xp13Tuple (xpElem "XML_File_ID" xpInt)
345 (xpElem "heading" xpText)
347 (xpElem "category" xpText)
348 (xpElem "sport" xpText)
349 (xpElem "url" $ xpOption xpText)
350 (xpList pickle_news_team)
351 (xpList pickle_location)
352 (xpElem "SMS" xpText)
353 (xpOption (xpElem "Editor" xpText))
354 (xpOption (xpElem "text" xpText))
356 (xpElem "time_stamp" xpText)
358 from_tuple = uncurryN Message
359 to_tuple m = (xml_xml_file_id m, -- Verbose,
360 xml_heading m, -- but
361 xml_mid m, -- eliminates
362 xml_category m, -- GHC
363 xml_sport m, -- warnings
366 xml_locations m, -- .
373 -- | We combine all of the \<continue\> elements into one 'String'
374 -- while unpickling and do the reverse while pickling.
376 pickle_continue :: PU (Maybe String)
379 xpWrap (to_string, from_string) $
381 xpList (xpElem "P" xpText)
383 from_string :: String -> [String]
384 from_string = split "\n"
386 to_string :: [String] -> String
387 to_string = join "\n"
394 -- | A list of all tests for this module.
396 news_tests :: TestTree
400 [ test_news_fields_have_correct_names,
401 test_pickle_of_unpickle_is_identity,
402 test_unpickle_succeeds ]
405 -- | Make sure our codegen is producing the correct database names.
407 test_news_fields_have_correct_names :: TestTree
408 test_news_fields_have_correct_names =
409 testCase "news fields get correct database names" $
410 mapM_ check (zip actual expected)
412 -- This is cool, it uses the (derived) Data instance of
413 -- News.News to get its constructor names.
414 field_names :: [String]
416 constrFields . head $ dataTypeConstrs $ dataTypeOf (undefined :: News)
420 map (\x -> tsn_db_field_namer "herp" "derp" 8675309 x 90210) field_names
423 actual = ["mid", "sport", "url", "sms", "editor", "text", "continue"]
425 check (x,y) = (x @?= y)
428 -- | If we unpickle something and then pickle it, we should wind up
429 -- with the same thing we started with. WARNING: succeess of this
430 -- test does not mean that unpickling succeeded.
432 test_pickle_of_unpickle_is_identity :: TestTree
433 test_pickle_of_unpickle_is_identity = testGroup "pickle-unpickle tests"
434 [ check "pickle composed with unpickle is the identity"
435 "test/xml/newsxml.xml",
437 check "pickle composed with unpickle is the identity (with Editor)"
438 "test/xml/newsxml-with-editor.xml" ]
440 check desc path = testCase desc $ do
441 (expected, actual) <- pickle_unpickle pickle_message path
445 -- | Make sure we can actually unpickle these things.
447 test_unpickle_succeeds :: TestTree
448 test_unpickle_succeeds = testGroup "unpickle tests"
449 [ check "unpickling succeeds"
450 "test/xml/newsxml.xml",
452 check "unpickling succeeds (with Editor)"
453 "test/xml/newsxml-with-editor.xml" ]
455 check desc path = testCase desc $ do
456 actual <- unpickleable path pickle_message