]> gitweb.michael.orlitzky.com - dead/htsn-import.git/blobdiff - src/TSN/XML/Odds.hs
Replace all raw DELETE queries with deleteAll.
[dead/htsn-import.git] / src / TSN / XML / Odds.hs
index bab8c28ee8e66a30ab05ac87a6c6bf5d26337ebf..b8888af2052d62f7fd5e85fdc61f907d9aaae20d 100644 (file)
@@ -7,11 +7,12 @@
 {-# LANGUAGE TemplateHaskell #-}
 {-# LANGUAGE TypeFamilies #-}
 
--- | Parse TSN XML for the DTD "Odds_XML.dtd". Each document contains
---   a root element \<message\> that contains a bunch of other
---   unorganized crap.
+-- | Parse TSN XML for the DTD \"Odds_XML.dtd\". Each document
+--   contains a root element \<message\> that contains a bunch of
+--   other... disorganized... information.
 --
 module TSN.XML.Odds (
+  dtd,
   pickle_message,
   -- * Tests
   odds_tests,
@@ -31,10 +32,16 @@ import Data.Tuple.Curry ( uncurryN )
 import Database.Groundhog (
   (=.),
   (==.),
+  countAll,
+  deleteAll,
   insert_,
   migrate,
+  runMigration,
+  silentMigrationLogger,
   update )
 import Database.Groundhog.Core ( DefaultKey )
+import Database.Groundhog.Generic ( runDbConn )
+import Database.Groundhog.Sqlite ( withSqliteConn )
 import Database.Groundhog.TH (
   groundhog,
   mkPersist )
@@ -67,7 +74,14 @@ import Xml (
   FromXmlFk(..),
   ToDb(..),
   pickle_unpickle,
-  unpickleable )
+  unpickleable,
+  unsafe_unpickle )
+
+
+-- | The DTD to which this module corresponds. Used to invoke dbimport.
+--
+dtd :: String
+dtd = "Odds_XML.dtd"
 
 
 --
@@ -78,10 +92,10 @@ import Xml (
 
 
 -- | The casinos should have their own table, but the lines don't
---   belong in that table (there should be another table joining the
---   casinos and the thing the lines are for together.)
+--   belong in that table (there is a separate table for
+--   'OddsGameLine' which associates the two).
 --
---   We drop the 'Game' prefix because the Casinos really aren't
+--   We drop the \"Game\" prefix because the casinos really aren't
 --   children of the games; the XML just makes it seem that way.
 --
 data OddsCasino =
@@ -121,14 +135,16 @@ instance ToDb OddsGameCasinoXml where
 
 instance FromXml OddsGameCasinoXml where
   -- | We convert from XML to the database by dropping the line field.
+  --
   from_xml OddsGameCasinoXml{..} =
     OddsCasino {
       casino_client_id = xml_casino_client_id,
       casino_name      = xml_casino_name }
 
 
--- | This allows us to call 'insert_xml' on an 'OddsGameCasinoXml'
---   without first converting it to the database representation.
+-- | This allows us to insert the XML representation 'OddsGameCasinoXml'
+--   directly.
+--
 instance XmlImport OddsGameCasinoXml
 
 
@@ -188,9 +204,8 @@ instance FromXml OddsGameHomeTeamXml where
       db_abbr      = xml_home_abbr,
       db_team_name = xml_home_team_name }
 
--- | XmlImport allows us to call 'insert_xml' directly on an
---   'OddsGameHomeTeamXml' without explicitly converting it to the
---   associated database type.
+-- | This allows us to insert the XML representation
+--   'OddsGameHomeTeamXml' directly.
 --
 instance XmlImport OddsGameHomeTeamXml where
 
@@ -229,9 +244,8 @@ instance FromXml OddsGameAwayTeamXml where
                                        xml_away_abbr
                                        xml_away_team_name
 
--- | XmlImport allows us to call 'insert_xml' directly on an
---   'OddsGameAwayTeamXml' without explicitly converting it to the
---   associated database type.
+-- | This allows us to insert the XML representation
+--   'OddsGameAwayTeamXml' directly.
 --
 instance XmlImport OddsGameAwayTeamXml where
 
@@ -239,6 +253,7 @@ instance XmlImport OddsGameAwayTeamXml where
 -- * OddsGame_OddsGameTeam
 
 -- | Database mapping between games and their home/away teams.
+--
 data OddsGame_OddsGameTeam =
   OddsGame_OddsGameTeam {
     ogogt_odds_games_id :: DefaultKey OddsGame,
@@ -260,7 +275,7 @@ newtype OddsGameOverUnderXml =
 
 -- | This database representation of the casino lines can't be
 --   constructed from the one in the XML. The casinos within
---   Game>HomeTeam, Game>AwayTeam, and Game>Over_Under are all more or
+--   Game-\>HomeTeam, Game-\>AwayTeam, and Game-\>Over_Under are all more or
 --   less the same. We don't need a bajillion different tables to
 --   store that, just one tying the casino/game pair to the three
 --   lines.
@@ -293,7 +308,7 @@ data OddsGame =
     db_game_home_team_rotation_number :: Int }
 
 
--- | XML representation of a game.
+-- | XML representation of an 'OddsGame'.
 --
 data OddsGameXml =
   OddsGameXml {
@@ -319,6 +334,9 @@ instance ToDb OddsGameXml where
   type Db OddsGameXml = OddsGame
 
 instance FromXmlFk OddsGameXml where
+  -- | Each 'OddsGameXml' is contained in an 'Odds'. In other words
+  --   the foreign key for 'OddsGame' points to an 'Odds'.
+  --
   type Parent OddsGameXml = Odds
 
   -- | To convert from the XML representation to the database one, we
@@ -340,8 +358,7 @@ instance FromXmlFk OddsGameXml where
       db_game_home_team_rotation_number =
         (xml_home_rotation_number xml_game_home_team) }
 
--- | This lets us call 'insert_xml_fk' directly on an 'OddsGameXml'
---   without converting it to the database representation explicitly.
+-- | This lets us insert the XML representation 'OddsGameXml' directly.
 --
 instance XmlImportFk OddsGameXml
 
@@ -350,16 +367,16 @@ instance XmlImportFk OddsGameXml
 
 -- | This is our best guess at what occurs in the Odds_XML
 --   documents. It looks like each consecutive set of games can
---   optionally have some notes appear before it. Each "note" comes as
---   its own <Notes>...</Notes> element.
+--   optionally have some notes appear before it. Each \"note\" comes
+--   as its own \<Notes\>...\</Notes\> element.
 --
 --   The notes are ignored completely in the database; we only bother
 --   with them to ensure that we're (un)pickling correctly.
 --
---   We can't group the notes with a "set" of 'OddsGame's, because that
---   leads to ambiguity in parsing. Since we're going to ignore the
---   notes anyway, we just stick them with an arbitrary game. C'est la
---   vie.
+--   We can't group the notes with a \"set\" of 'OddsGame's, because
+--   that leads to ambiguity in parsing. Since we're going to ignore
+--   the notes anyway, we just stick them with an arbitrary
+--   game. C'est la vie.
 --
 data OddsGameWithNotes =
   OddsGameWithNotes {
@@ -370,8 +387,8 @@ data OddsGameWithNotes =
 
 -- * Odds/Message
 
--- | Database and representation of the top-level Odds object (a
---   'Message').
+-- | Database representation of a 'Message'.
+--
 data Odds =
   Odds {
     db_xml_file_id :: Int,
@@ -385,6 +402,7 @@ data Odds =
 
 
 -- | The XML representation of 'Odds'.
+--
 data Message =
   Message {
     xml_xml_file_id :: Int,
@@ -421,8 +439,7 @@ instance FromXml Message where
       db_line_time = xml_line_time,
       db_time_stamp = xml_time_stamp }
 
--- | This lets us call 'insert_xml' on a Message directly, without
---   having to convert it to its database representation explicitly.
+-- | This lets us insert the XML representation 'Message' directly.
 --
 instance XmlImport Message
 
@@ -477,10 +494,10 @@ mkPersist tsn_codegen_config [groundhog|
     - name: OddsGameLine
       fields:
         - name: ogl_odds_games_id
-          references:
+          reference:
             onDelete: cascade
         - name: ogl_odds_casinos_id
-          references:
+          reference:
             onDelete: cascade
 
 - entity: OddsGame_OddsGameTeam
@@ -728,7 +745,8 @@ odds_tests :: TestTree
 odds_tests =
   testGroup
     "Odds tests"
-    [ test_pickle_of_unpickle_is_identity,
+    [ test_on_delete_cascade,
+      test_pickle_of_unpickle_is_identity,
       test_unpickle_succeeds ]
 
 
@@ -775,3 +793,57 @@ 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 odds deletes its children"
+          "test/xml/Odds_XML.xml"
+          13 -- 5 casinos, 8 teams
+    ,
+
+    check "deleting odds deletes its children (non-int team_id)"
+          "test/xml/Odds_XML-noninteger-team-id.xml"
+          51 -- 5 casinos, 46 teams
+    ,
+
+    check "deleting odds deleted its children (positive(+) line)"
+          "test/xml/Odds_XML-positive-line.xml"
+          17 -- 5 casinos, 12 teams
+    ,
+
+    check "deleting odds deleted its children (large file)"
+          "test/xml/Odds_XML-largefile.xml"
+          189 -- 5 casinos, 184 teams
+    ]
+  where
+    check desc path expected = testCase desc $ do
+      odds <- unsafe_unpickle path pickle_message
+      let a = undefined :: Odds
+      let b = undefined :: OddsCasino
+      let c = undefined :: OddsGameTeam
+      let d = undefined :: OddsGame
+      let e = undefined :: OddsGame_OddsGameTeam
+      let f = undefined :: OddsGameLine
+      actual <- withSqliteConn ":memory:" $ runDbConn $ do
+                  runMigration silentMigrationLogger $ do
+                    migrate a
+                    migrate b
+                    migrate c
+                    migrate d
+                    migrate e
+                    migrate f
+                  _ <- dbimport odds
+                  deleteAll a
+                  count_a <- countAll a
+                  count_b <- countAll b
+                  count_c <- countAll c
+                  count_d <- countAll d
+                  count_e <- countAll e
+                  count_f <- countAll f
+                  return $ sum [count_a, count_b, count_c,
+                                count_d, count_e, count_f ]
+      actual @?= expected