ParseMetadata.hs

module Epub2.ParseMetadata
   ( tests )
   where

import Control.Monad.Except
import Control.Monad.IO.Class ( liftIO )
import qualified Data.Map.Strict as Map
import System.FilePath
import Test.HUnit

import Codec.Epub.Data.Metadata
import Codec.Epub.Parse


tests :: Test
tests = TestList
   [ testFull
   , testMinimal
   , testMissingAll
   ]


{- A fairly comprehensive test containing all possible things
   Not complete at this time because the library can't parse it all yet!
-}
testFull :: Test
testFull = TestCase $ do
   xmlString <- readFile $ "util" </> "resources" </> "epub2-full.opf"
   actual <- runExceptT $ getMetadata xmlString
   let expected =
         Right Metadata
            { metaTitles =
               [ Title Nothing Nothing Nothing "Title Of This Book"
               , Title (Just "fr") Nothing Nothing "Titre De Ce Livre"
               ]
            , metaCreators = 
               [ Creator
                  (Just "aut")
                  (Just "Wiggins, Josephine B.")
                  Nothing
                  "Josephine B. Wiggins"
               , Creator
                  (Just "aut")
                  (Just "Dicker, Joël")
                  Nothing
                  "Joël Dicker"
               , Creator
                  (Just "aut")
                  Nothing
                  Nothing
                  "Horatio Cromwell"
               , Creator
                  Nothing
                  Nothing
                  Nothing
                  "Natalia Jenkins"
               ]
            , metaContributors = 
               [ Creator 
                  (Just "ill") 
                  (Just "Knickerbocker, Reginald Q.") 
                  Nothing
                  "Reginald Q. Knickerbocker"
               , Creator 
                  (Just "edt") 
                  Nothing
                  Nothing
                  "Beverly Abercrombie"
               ]
            , metaSubjects = ["Fiction","Science Fiction"]
            , metaDescriptions =
               [ Description Nothing "This document is a stub used for unit testing. It is missing the rest of the tags that normally occur after metadata."
               , Description Nothing "An additional description"
               ]
            , metaPublishers =
               [ "Fictional Books Ltd."
               , "An additional publisher"
               ]
            , metaDates = Map.fromList
               [ (Issued, DateValue "2010")
               , (Created, DateValue "2010-05-07")
               , (Epub, DateValue "2009")
               ]
            , metaType = Just "test OPF Package Document"
            , metaFormats =
               [ "ePub publication"
               , "an additional format"
               ]
            , metaIds = 
               [ Identifier (Just "isbn") Nothing (Just "ISBN") "1-82057-821-9"
               , Identifier (Just "other") Nothing Nothing "1386506873266"
               ]
            , metaSource = Just "document source"
            , metaLangs = ["en-US", "en-UK"]
            , metaRelations =
               [ "document relation"
               , "an additional relation"
               ]
            , metaCoverages =
               [ "coverage information"
               , "an additional coverage"
               ]
            , metaRights =
               [ "Copyright: 2010 Dino Morelli, License: ISC"
               , "an additional rights"
               ]
            }
   assertEqual "epub2 - very full" expected actual


{- Test the absolute minimum set of fields allowed while remaining 
   compliant with the spec
-}
testMinimal :: Test
testMinimal = TestCase $ do
   xmlString <- liftIO $ readFile $ "util" </> "resources" </> "epub2-minimal.opf"
   actual <- runExceptT $ getMetadata xmlString
   let expected = 
         Right Metadata 
            { metaTitles = [Title Nothing Nothing Nothing
               "Title Of This Book"]
            , metaCreators = []
            , metaContributors = []
            , metaSubjects = []
            , metaDescriptions = []
            , metaPublishers = []
            , metaDates = Map.empty
            , metaType = Nothing
            , metaFormats = []
            , metaIds = [Identifier (Just "isbn") Nothing
               (Just "ISBN") "1-82057-821-9"]
            , metaSource = Nothing
            , metaLangs = ["en-us"]
            , metaRelations = []
            , metaCoverages = []
            , metaRights = []
            }
   assertEqual "minimal" expected actual


{- Test data missing everything important: package version and 
   unique-identifier attributes, title, identifier and language tags
-}
testMissingAll :: Test
testMissingAll = TestCase $ do
   xmlString <- readFile $ "util" </> "resources" </> "epub2-missingAll.opf"
   actual <- runExceptT $ getMetadata xmlString
   let expected = Right emptyMetadata
   assertEqual "missing all" expected actual