]> gitweb.michael.orlitzky.com - dead/htsn-import.git/blobdiff - src/TSN/XML/AutoRacingResults.hs
Fix unused field warnings in TSN.XML.AutoRacingResults.
[dead/htsn-import.git] / src / TSN / XML / AutoRacingResults.hs
index e7ab014e50579c77fe9488639bd42549ce75f3b6..e2bb7e7af1edb1278410029480a5baa2352c5b3b 100644 (file)
@@ -1,4 +1,6 @@
+
 {-# LANGUAGE DeriveDataTypeable #-}
+{-# LANGUAGE DeriveGeneric #-}
 {-# LANGUAGE FlexibleInstances #-}
 {-# LANGUAGE GADTs #-}
 {-# LANGUAGE QuasiQuotes #-}
@@ -24,6 +26,7 @@ where
 -- System imports.
 import Control.Monad ( forM_ )
 import Data.Data ( Data )
+import Data.Maybe ( fromMaybe )
 import Data.Time ( UTCTime(..) )
 import Data.Tuple.Curry ( uncurryN )
 import Data.Typeable ( Typeable )
@@ -39,6 +42,7 @@ 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 (
@@ -58,6 +62,7 @@ import Text.XML.HXT.Core (
   xpWrap )
 
 -- Local imports.
+import Generics ( Generic(..), prepend, to_tuple )
 import TSN.Codegen ( tsn_codegen_config )
 import TSN.DbImport ( DbImport(..), ImportResult(..), run_dbmigrate )
 import TSN.Picklers (
@@ -127,7 +132,11 @@ data Message =
     xml_listings :: [AutoRacingResultsListingXml],
     xml_race_information :: AutoRacingResultsRaceInformationXml,
     xml_time_stamp :: UTCTime }
-  deriving (Eq, Show)
+  deriving (Eq, GHC.Generic, Show)
+
+-- | For 'Generics.to_tuple'.
+--
+instance Generic Message
 
 
 instance ToDb Message where
@@ -167,46 +176,55 @@ instance XmlImport Message
 -- * AutoRacingResultsListing/AutoRacingResultsListingXml
 
 -- | Database representation of a \<Listing\> contained within a
---   \<message\>.
+--   \<message\>. The leading underscores prevent unused field
+--   warnings.
 --
 data AutoRacingResultsListing =
   AutoRacingResultsListing {
-    db_auto_racing_results_id :: DefaultKey AutoRacingResults,
-    db_finish_position :: Int,
-    db_starting_position :: Int,
-    db_car_number :: Int,
-    db_driver_id :: Int,
-    db_driver :: String,
-    db_car_make :: String,
-    db_points :: Int,
-    db_laps_completed :: Int,
-    db_laps_leading :: Int,
-    db_status :: Maybe String,
-    db_dnf :: Maybe Bool,
-    db_nc :: Maybe Bool,
-    db_earnings :: Maybe Int }
-
+    _db_auto_racing_results_id :: DefaultKey AutoRacingResults,
+    _db_finish_position :: Int,
+    _db_starting_position :: Int,
+    _db_car_number :: Int,
+    _db_driver_id :: Int,
+    _db_driver :: String,
+    _db_car_make :: String,
+    _db_points :: Int,
+    _db_laps_completed :: Int,
+    _db_laps_leading :: Int,
+    _db_status :: Maybe String,
+    _db_dnf :: Maybe Bool,
+    _db_nc :: Maybe Bool,
+    _db_earnings :: Maybe Int }
+  deriving ( GHC.Generic )
+
+-- | For 'Generics.prepend'.
+--
+instance Generic AutoRacingResultsListing
 
 -- | XML representation of a \<Listing\> contained within a
---   \<message\>.
+--   \<message\>. The leading underscores prevent unused field
+--   warnings.
 --
 data AutoRacingResultsListingXml =
   AutoRacingResultsListingXml {
-    xml_finish_position :: Int,
-    xml_starting_position :: Int,
-    xml_car_number :: Int,
-    xml_driver_id :: Int,
-    xml_driver :: String,
-    xml_car_make :: String,
-    xml_points :: Int,
-    xml_laps_completed :: Int,
-    xml_laps_leading :: Int,
-    xml_status :: Maybe String,
-    xml_dnf :: Maybe Bool,
-    xml_nc :: Maybe Bool,
-    xml_earnings :: Maybe Int }
-  deriving (Eq, Show)
-
+    _xml_finish_position :: Int,
+    _xml_starting_position :: Int,
+    _xml_car_number :: Int,
+    _xml_driver_id :: Int,
+    _xml_driver :: String,
+    _xml_car_make :: String,
+    _xml_points :: Int,
+    _xml_laps_completed :: Int,
+    _xml_laps_leading :: Int,
+    _xml_status :: Maybe String,
+    _xml_dnf :: Maybe Bool,
+    _xml_nc :: Maybe Bool,
+    _xml_earnings :: Maybe Int }
+  deriving (Eq, GHC.Generic, Show)
+
+-- | For 'Generics.to_tuple'.
+--
+instance Generic AutoRacingResultsListingXml
 
 instance ToDb AutoRacingResultsListingXml where
   -- | The database analogue of an 'AutoRacingResultsListingXml' is
@@ -227,22 +245,7 @@ instance FromXmlFk AutoRacingResultsListingXml where
   --   'AutoRacingResultsListing', we add the foreign key and copy
   --   everything else verbatim.
   --
-  from_xml_fk fk AutoRacingResultsListingXml{..} =
-    AutoRacingResultsListing {
-      db_auto_racing_results_id = fk,
-      db_finish_position = xml_finish_position,
-      db_starting_position = xml_starting_position,
-      db_car_number = xml_car_number,
-      db_driver_id = xml_driver_id,
-      db_driver = xml_driver,
-      db_car_make = xml_car_make,
-      db_points = xml_points,
-      db_laps_completed = xml_laps_completed,
-      db_laps_leading = xml_laps_leading,
-      db_status = xml_status,
-      db_dnf = xml_dnf,
-      db_nc = xml_nc,
-      db_earnings = xml_earnings }
+  from_xml_fk = prepend
 
 
 -- | This allows us to insert the XML representation
@@ -318,7 +321,7 @@ data AutoRacingResultsRaceInformationXml =
     xml_lead_changes :: Maybe String,
     xml_lap_leaders :: Maybe String,
     xml_most_laps_leading :: Maybe MostLapsLeading }
-  deriving (Eq,Show)
+  deriving (Eq, Show)
 
 
 instance ToDb AutoRacingResultsRaceInformationXml where
@@ -340,7 +343,7 @@ instance Child AutoRacingResultsRaceInformationXml where
 instance FromXmlFk AutoRacingResultsRaceInformationXml where
   -- | To convert an 'AutoRacingResultsRaceInformationXml' to an
   --   'AutoRacingResultsRaceInformartion', we add the foreign key and
-  --   copy everything else verbatim.
+  --   massage the 'MostLapsLeading' embedded type,
   --
   from_xml_fk fk AutoRacingResultsRaceInformationXml{..} =
     AutoRacingResultsRaceInformation {
@@ -362,9 +365,9 @@ instance FromXmlFk AutoRacingResultsRaceInformationXml where
       -- the database with an (embedded) 'MostLapsLeading' with three
       -- missing fields.
       most_laps_leading =
-        case xml_most_laps_leading of
-          Just mll -> mll
-          Nothing  -> MostLapsLeading Nothing Nothing Nothing
+        fromMaybe (MostLapsLeading Nothing Nothing Nothing)
+                  xml_most_laps_leading
+
 
 -- | This allows us to insert the XML representation
 --   'AutoRacingResultsRaceInformationXml' directly.
@@ -414,7 +417,7 @@ mkPersist tsn_codegen_config [groundhog|
   constructors:
     - name: AutoRacingResultsListing
       fields:
-        - name: db_auto_racing_results_id
+        - name: _db_auto_racing_results_id
           reference:
             onDelete: cascade
 
@@ -473,19 +476,6 @@ pickle_listing =
               (xpElem "Earnings" xp_earnings)
   where
     from_tuple = uncurryN AutoRacingResultsListingXml
-    to_tuple m = (xml_finish_position m,
-                  xml_starting_position m,
-                  xml_car_number m,
-                  xml_driver_id m,
-                  xml_driver m,
-                  xml_car_make m,
-                  xml_points m,
-                  xml_laps_completed m,
-                  xml_laps_leading m,
-                  xml_status m,
-                  xml_dnf m,
-                  xml_nc m,
-                  xml_earnings m)
 
 
 -- | Pickler for the top-level 'Message'.
@@ -509,19 +499,6 @@ pickle_message =
               (xpElem "time_stamp" xp_time_stamp)
   where
     from_tuple = uncurryN Message
-    to_tuple m = (xml_xml_file_id m,
-                  xml_heading m,
-                  xml_category m,
-                  xml_sport m,
-                  xml_race_id m,
-                  xml_race_date m,
-                  xml_title m,
-                  xml_track_location m,
-                  xml_laps_remaining m,
-                  xml_checkered_flag m,
-                  xml_listings m,
-                  xml_race_information m,
-                  xml_time_stamp m)
 
 
 -- | Pickler for the \<Most_Laps_Leading\> child of a
@@ -535,7 +512,7 @@ pickle_message =
 pickle_most_laps_leading :: PU (Maybe MostLapsLeading)
 pickle_most_laps_leading =
   xpElem "Most_Laps_Leading" $
-    xpWrap (from_tuple, to_tuple) $
+    xpWrap (from_tuple, to_tuple') $
     xpTriple (xpOption $ xpElem "DriverID" xpInt)
              (xpOption $ xpElem "Driver" xpText)
              (xpOption $ xpElem "NumberOfLaps" xpInt)
@@ -547,14 +524,14 @@ pickle_most_laps_leading =
 
     -- Sure had to go out of my way to avoid the warnings about unused
     -- db_most_laps_foo fields here.
-    to_tuple :: Maybe MostLapsLeading -> (Maybe Int, Maybe String, Maybe Int)
-    to_tuple Nothing = (Nothing, Nothing, Nothing)
-    to_tuple (Just (MostLapsLeading Nothing _ _)) = (Nothing, Nothing, Nothing)
-    to_tuple (Just (MostLapsLeading _ Nothing _)) = (Nothing, Nothing, Nothing)
-    to_tuple (Just (MostLapsLeading _ _ Nothing)) = (Nothing, Nothing, Nothing)
-    to_tuple (Just m) = (db_most_laps_leading_driver_id m,
-                         db_most_laps_leading_driver m,
-                         db_most_laps_leading_number_of_laps m)
+    to_tuple' :: Maybe MostLapsLeading -> (Maybe Int, Maybe String, Maybe Int)
+    to_tuple' Nothing = (Nothing, Nothing, Nothing)
+    to_tuple' (Just (MostLapsLeading Nothing _ _)) = (Nothing, Nothing, Nothing)
+    to_tuple' (Just (MostLapsLeading _ Nothing _)) = (Nothing, Nothing, Nothing)
+    to_tuple' (Just (MostLapsLeading _ _ Nothing)) = (Nothing, Nothing, Nothing)
+    to_tuple' (Just m) = (db_most_laps_leading_driver_id m,
+                          db_most_laps_leading_driver m,
+                          db_most_laps_leading_number_of_laps m)
 
 
 -- | Pickler for the \<Race_Information\> child of \<message\>.
@@ -574,7 +551,7 @@ pickle_most_laps_leading =
 pickle_race_information :: PU AutoRacingResultsRaceInformationXml
 pickle_race_information =
   xpElem "Race_Information" $
-    xpWrap (from_tuple, to_tuple) $
+    xpWrap (from_tuple, to_tuple') $
     xp11Tuple (-- I can't think of another way to get both the
                -- TrackLength and its KPH attribute. So we shove them
                -- both in a 2-tuple. This should probably be an embedded type!
@@ -599,17 +576,17 @@ pickle_race_information =
           x1 x2 x3 x4 x5 x6 x7 x8 x9 x10 x11 x12
 
     -- And here we have to re-pair the first two.
-    to_tuple m = ((xml_track_length m, xml_track_length_kph m),
-                  xml_laps m,
-                  xml_average_speed_mph m,
-                  xml_average_speed_kph m,
-                  xml_average_speed m,
-                  xml_time_of_race m,
-                  xml_margin_of_victory m,
-                  xml_cautions m,
-                  xml_lead_changes m,
-                  xml_lap_leaders m,
-                  xml_most_laps_leading m)
+    to_tuple' m = ((xml_track_length m, xml_track_length_kph m),
+                   xml_laps m,
+                   xml_average_speed_mph m,
+                   xml_average_speed_kph m,
+                   xml_average_speed m,
+                   xml_time_of_race m,
+                   xml_margin_of_victory m,
+                   xml_cautions m,
+                   xml_lead_changes m,
+                   xml_lap_leaders m,
+                   xml_most_laps_leading m)
 
 --
 -- * Tasty Tests