Add a new (un)pickler for the auto racing schedule "TBA"-able time field.

[dead/htsn-import.git] / src / TSN / Picklers.hs

diff --git a/src/TSN/Picklers.hs b/src/TSN/Picklers.hs
index d87139b793bbb6dddc2e429a0c14b56fb96f3ccc..c70b2ba84edc5d627575622d1bb2a609f99bb195 100644 (file)
--- a/src/TSN/Picklers.hs
+++ b/src/TSN/Picklers.hs
@@ -3,16 +3,19 @@
 --
 module TSN.Picklers (
   xp_date,
-  xp_team_id,
-  xp_time )
+  xp_gamedate,
+  xp_tba_time,
+  xp_time,
+  xp_time_stamp )
 where
 
 -- System imports.
-import Data.Time.Clock ( UTCTime )
+import Data.Time.Clock ( NominalDiffTime, UTCTime, addUTCTime )
 import Data.Time.Format ( formatTime, parseTime )
 import System.Locale ( defaultTimeLocale )
 import Text.XML.HXT.Arrow.Pickle (
   xpText,
+  xpWrap,
   xpWrapMaybe )
 import Text.XML.HXT.Arrow.Pickle.Xml ( PU )
 
@@ -32,35 +35,116 @@ xp_date =
     from_date = formatTime defaultTimeLocale format
 
 
+-- | (Un)pickle a UTCTime from a weather forecast's gamedate. Example
+--   input looks like,
+--
+--   \<forecast gamedate=\"Monday, December 30th\"\>
+--
+--   When unpickling we get rid of the suffixes \"st\", \"nd\", \"rd\", and
+--   \"th\". During pickling, we add them back based on the last digit
+--   of the date.
+--
+xp_gamedate :: PU UTCTime
+xp_gamedate =
+  (to_gamedate, from_gamedate) `xpWrapMaybe` xpText
+  where
+    format = "%A, %B %-d"
+
+    to_gamedate :: String -> Maybe UTCTime
+    to_gamedate s =
+      parseTime defaultTimeLocale format s'
+      where
+        s' = case (reverse s) of
+               (c2:c1:cs) -> let suffix = [c1,c2]
+                             in
+                               case suffix of
+                                 "st" -> reverse cs
+                                 "nd" -> reverse cs
+                                 "rd" -> reverse cs
+                                 "th" -> reverse cs
+                                 _    -> s -- Unknown suffix, leave it alone.
+               _ -> s -- The String is less than two characters long,
+                      -- leave it alone.
+
+
+    from_gamedate :: UTCTime -> String
+    from_gamedate d = s ++ (suffix s)
+      where
+        s = formatTime defaultTimeLocale format d
+
+        suffix :: String -> String
+        suffix cs =
+          case (reverse cs) of
+            []       -> []
+            ('1':_) -> "st"
+            ('2':_) -> "nd"
+            ('3':_) -> "rd"
+            _        -> "th"
+
+
+
+-- | The time format string used in 'xp_time' and 'xp_time_stamp'.
+--
+xp_time_format :: String
+xp_time_format = "%I:%M %p"
+
+
 -- | (Un)pickle a UTCTime without the date portion.
 --
 xp_time :: PU UTCTime
 xp_time =
   (to_time, from_time) `xpWrapMaybe` xpText
   where
-    format = "%I:%M %p"
-
     to_time :: String -> Maybe UTCTime
-    to_time = parseTime defaultTimeLocale format
+    to_time = parseTime defaultTimeLocale xp_time_format
 
     from_time :: UTCTime -> String
-    from_time = formatTime defaultTimeLocale format
+    from_time = formatTime defaultTimeLocale xp_time_format
+
+
+-- | (Un)pickle a UTCTime without the date portion, allowing for a
+--   value of \"TBA\" (which gets translated to 'Nothing').
+--
+xp_tba_time :: PU (Maybe UTCTime)
+xp_tba_time =
+  (to_time, from_time) `xpWrap` xpText
+  where
+    to_time :: String -> Maybe UTCTime
+    to_time s
+      | s == "TBA" = Nothing
+      | otherwise = parseTime defaultTimeLocale xp_time_format s
 
+    from_time :: Maybe UTCTime -> String
+    from_time Nothing = ""
+    from_time (Just t) = formatTime defaultTimeLocale xp_time_format t
 
 
--- | Parse a team_id. These are (so far!) three characters long, and
---   not necessarily numeric. For simplicity, we return a 'String'
---   rather than e.g. a @(Char, Char, Char)@. But unpickling will fail
---   if the team_id is longer than three characters.
+-- | (Un)pickle the \<time_stamp\> element format to/from a 'UTCTime'.
 --
-xp_team_id :: PU String
-xp_team_id =
-  (to_team_id, from_team_id) `xpWrapMaybe` xpText
+--   Example:  \<time_stamp\> January 6, 2014, at 10:11 PM ET \</time_stamp\>
+--
+--   TSN doesn't provide a proper time zone name, so we assume that
+--   it's always Eastern Standard Time. EST is UTC-5, so we
+--   add/subtract 5 hours to convert to/from UTC.
+--
+xp_time_stamp :: PU UTCTime
+xp_time_stamp =
+  (to_time_stamp, from_time_stamp) `xpWrapMaybe` xpText
   where
-    to_team_id :: String -> Maybe String
-    to_team_id s
-      | length s <= 3 = Just s
-      | otherwise = Nothing
+    -- This omits the timezone and trailing space.
+    format = " %B %-d, %Y, at " ++ xp_time_format ++ " ET "
+
+    five_hours :: NominalDiffTime
+    five_hours = 5 * 60 * 60
+
+    add_five :: UTCTime -> UTCTime
+    add_five = addUTCTime five_hours
+
+    subtract_five :: UTCTime -> UTCTime
+    subtract_five = addUTCTime (-1 * five_hours)
+
+    to_time_stamp :: String -> Maybe UTCTime
+    to_time_stamp = fmap add_five . parseTime defaultTimeLocale format
 
-    from_team_id :: String -> String
-    from_team_id = id
+    from_time_stamp :: UTCTime -> String
+    from_time_stamp = formatTime defaultTimeLocale format . subtract_five