829 lines
		
	
	
		
			40 KiB
		
	
	
	
		
			Haskell
		
	
	
	
	
	
			
		
		
	
	
			829 lines
		
	
	
		
			40 KiB
		
	
	
	
		
			Haskell
		
	
	
	
	
	
{-|
 | 
						|
 | 
						|
A general query system for matching things (accounts, postings,
 | 
						|
transactions..)  by various criteria, and a SimpleTextParser for query expressions.
 | 
						|
 | 
						|
-}
 | 
						|
 | 
						|
{-# LANGUAGE FlexibleContexts   #-}
 | 
						|
{-# LANGUAGE OverloadedStrings  #-}
 | 
						|
{-# LANGUAGE ViewPatterns       #-}
 | 
						|
 | 
						|
module Hledger.Query (
 | 
						|
  -- * Query and QueryOpt
 | 
						|
  Query(..),
 | 
						|
  QueryOpt(..),
 | 
						|
  OrdPlus(..),
 | 
						|
  payeeTag,
 | 
						|
  noteTag,
 | 
						|
  generatedTransactionTag,
 | 
						|
  -- * parsing
 | 
						|
  parseQuery,
 | 
						|
  parseQueryList,
 | 
						|
  simplifyQuery,
 | 
						|
  filterQuery,
 | 
						|
  -- * accessors
 | 
						|
  queryIsNull,
 | 
						|
  queryIsAcct,
 | 
						|
  queryIsAmt,
 | 
						|
  queryIsDepth,
 | 
						|
  queryIsDate,
 | 
						|
  queryIsDate2,
 | 
						|
  queryIsDateOrDate2,
 | 
						|
  queryIsStartDateOnly,
 | 
						|
  queryIsSym,
 | 
						|
  queryIsReal,
 | 
						|
  queryIsStatus,
 | 
						|
  queryStartDate,
 | 
						|
  queryEndDate,
 | 
						|
  queryDateSpan,
 | 
						|
  queryDateSpan',
 | 
						|
  queryDepth,
 | 
						|
  inAccount,
 | 
						|
  inAccountQuery,
 | 
						|
  -- * matching
 | 
						|
  matchesTransaction,
 | 
						|
  matchesDescription,
 | 
						|
  matchesPayeeWIP,
 | 
						|
  matchesPosting,
 | 
						|
  matchesAccount,
 | 
						|
  matchesMixedAmount,
 | 
						|
  matchesAmount,
 | 
						|
  matchesCommodity,
 | 
						|
  matchesTags,
 | 
						|
  matchesPriceDirective,
 | 
						|
  words'',
 | 
						|
  prefixes,
 | 
						|
  -- * tests
 | 
						|
  tests_Query
 | 
						|
)
 | 
						|
where
 | 
						|
 | 
						|
import Control.Applicative ((<|>), many, optional)
 | 
						|
import Data.Default (Default(..))
 | 
						|
import Data.Either (partitionEithers)
 | 
						|
import Data.List (partition)
 | 
						|
import Data.Maybe (fromMaybe, isJust, mapMaybe)
 | 
						|
import Data.Text (Text)
 | 
						|
import qualified Data.Text as T
 | 
						|
import Data.Time.Calendar (Day, fromGregorian )
 | 
						|
import Safe (readDef, readMay, maximumByMay, maximumMay, minimumMay)
 | 
						|
import Text.Megaparsec (between, noneOf, sepBy)
 | 
						|
import Text.Megaparsec.Char (char, string)
 | 
						|
 | 
						|
import Hledger.Utils hiding (words')
 | 
						|
import Hledger.Data.Types
 | 
						|
import Hledger.Data.AccountName
 | 
						|
import Hledger.Data.Amount (amountsRaw, mixedAmount, nullamt, usd)
 | 
						|
import Hledger.Data.Dates
 | 
						|
import Hledger.Data.Posting
 | 
						|
import Hledger.Data.Transaction
 | 
						|
 | 
						|
 | 
						|
-- | A query is a composition of search criteria, which can be used to
 | 
						|
-- match postings, transactions, accounts and more.
 | 
						|
data Query = Any              -- ^ always match
 | 
						|
           | None             -- ^ never match
 | 
						|
           | Not Query        -- ^ negate this match
 | 
						|
           | Or [Query]       -- ^ match if any of these match
 | 
						|
           | And [Query]      -- ^ match if all of these match
 | 
						|
           | Code Regexp      -- ^ match if code matches this regexp
 | 
						|
           | Desc Regexp      -- ^ match if description matches this regexp
 | 
						|
           | Acct Regexp      -- ^ match postings whose account matches this regexp
 | 
						|
           | Date DateSpan    -- ^ match if primary date in this date span
 | 
						|
           | Date2 DateSpan   -- ^ match if secondary date in this date span
 | 
						|
           | StatusQ Status  -- ^ match txns/postings with this status
 | 
						|
           | Real Bool        -- ^ match if "realness" (involves a real non-virtual account ?) has this value
 | 
						|
           | Amt OrdPlus Quantity  -- ^ match if the amount's numeric quantity is less than/greater than/equal to/unsignedly equal to some value
 | 
						|
           | Sym Regexp       -- ^ match if the entire commodity symbol is matched by this regexp
 | 
						|
           | Depth Int        -- ^ match if account depth is less than or equal to this value.
 | 
						|
                              --   Depth is sometimes used like a query (for filtering report data)
 | 
						|
                              --   and sometimes like a query option (for controlling display)
 | 
						|
           | Tag Regexp (Maybe Regexp)  -- ^ match if a tag's name, and optionally its value, is matched by these respective regexps
 | 
						|
                                        -- matching the regexp if provided, exists
 | 
						|
    deriving (Eq,Show)
 | 
						|
 | 
						|
instance Default Query where def = Any
 | 
						|
 | 
						|
-- | Construct a payee tag
 | 
						|
payeeTag :: Maybe Text -> Either RegexError Query
 | 
						|
payeeTag = fmap (Tag (toRegexCI' "payee")) . maybe (pure Nothing) (fmap Just . toRegexCI)
 | 
						|
 | 
						|
-- | Construct a note tag
 | 
						|
noteTag :: Maybe Text -> Either RegexError Query
 | 
						|
noteTag = fmap (Tag (toRegexCI' "note")) . maybe (pure Nothing) (fmap Just . toRegexCI)
 | 
						|
 | 
						|
-- | Construct a generated-transaction tag
 | 
						|
generatedTransactionTag :: Query
 | 
						|
generatedTransactionTag = Tag (toRegexCI' "generated-transaction") Nothing
 | 
						|
 | 
						|
-- | A more expressive Ord, used for amt: queries. The Abs* variants
 | 
						|
-- compare with the absolute value of a number, ignoring sign.
 | 
						|
data OrdPlus = Lt | LtEq | Gt | GtEq | Eq | AbsLt | AbsLtEq | AbsGt | AbsGtEq | AbsEq
 | 
						|
 deriving (Show,Eq)
 | 
						|
 | 
						|
-- | A query option changes a query's/report's behaviour and output in some way.
 | 
						|
data QueryOpt = QueryOptInAcctOnly AccountName  -- ^ show an account register focussed on this account
 | 
						|
              | QueryOptInAcct AccountName      -- ^ as above but include sub-accounts in the account register
 | 
						|
           -- | QueryOptCostBasis      -- ^ show amounts converted to cost where possible
 | 
						|
           -- | QueryOptDate2  -- ^ show secondary dates instead of primary dates
 | 
						|
    deriving (Show, Eq)
 | 
						|
 | 
						|
-- parsing
 | 
						|
 | 
						|
-- -- | A query restricting the account(s) to be shown in the sidebar, if any.
 | 
						|
-- -- Just looks at the first query option.
 | 
						|
-- showAccountMatcher :: [QueryOpt] -> Maybe Query
 | 
						|
-- showAccountMatcher (QueryOptInAcctSubsOnly a:_) = Just $ Acct True $ accountNameToAccountRegex a
 | 
						|
-- showAccountMatcher _ = Nothing
 | 
						|
 | 
						|
 | 
						|
-- | A version of parseQueryList which acts on a single Text of
 | 
						|
-- space-separated terms.
 | 
						|
--
 | 
						|
-- The usual shell quoting rules are assumed. When a pattern contains
 | 
						|
-- whitespace, it (or the whole term including prefix) should be enclosed
 | 
						|
-- in single or double quotes.
 | 
						|
--
 | 
						|
-- >>> parseQuery nulldate "expenses:dining out"
 | 
						|
-- Right (Or [Acct (RegexpCI "expenses:dining"),Acct (RegexpCI "out")],[])
 | 
						|
--
 | 
						|
-- >>> parseQuery nulldate "\"expenses:dining out\""
 | 
						|
-- Right (Acct (RegexpCI "expenses:dining out"),[])
 | 
						|
parseQuery :: Day -> T.Text -> Either String (Query,[QueryOpt])
 | 
						|
parseQuery d = parseQueryList d . words'' prefixes
 | 
						|
 | 
						|
-- | Convert a list of query expression containing to a query and zero
 | 
						|
-- or more query options; or return an error message if query parsing fails.
 | 
						|
--
 | 
						|
-- A query term is either:
 | 
						|
--
 | 
						|
-- 1. a search pattern, which matches on one or more fields, eg:
 | 
						|
--
 | 
						|
--      acct:REGEXP     - match the account name with a regular expression
 | 
						|
--      desc:REGEXP     - match the transaction description
 | 
						|
--      date:PERIODEXP  - match the date with a period expression
 | 
						|
--
 | 
						|
--    The prefix indicates the field to match, or if there is no prefix
 | 
						|
--    account name is assumed.
 | 
						|
--
 | 
						|
-- 2. a query option, which modifies the reporting behaviour in some
 | 
						|
--    way. There is currently one of these, which may appear only once:
 | 
						|
--
 | 
						|
--      inacct:FULLACCTNAME
 | 
						|
--
 | 
						|
-- Period expressions may contain relative dates, so a reference date is
 | 
						|
-- required to fully parse these.
 | 
						|
--
 | 
						|
-- Multiple terms are combined as follows:
 | 
						|
-- 1. multiple account patterns are OR'd together
 | 
						|
-- 2. multiple description patterns are OR'd together
 | 
						|
-- 3. multiple status patterns are OR'd together
 | 
						|
-- 4. then all terms are AND'd together
 | 
						|
parseQueryList :: Day -> [T.Text] -> Either String (Query, [QueryOpt])
 | 
						|
parseQueryList d termstrs = do
 | 
						|
  eterms <- sequence $ map (parseQueryTerm d) termstrs
 | 
						|
  let (pats, opts) = partitionEithers eterms
 | 
						|
      (descpats, pats') = partition queryIsDesc pats
 | 
						|
      (acctpats, pats'') = partition queryIsAcct pats'
 | 
						|
      (statuspats, otherpats) = partition queryIsStatus pats''
 | 
						|
      q = simplifyQuery $ And $ [Or acctpats, Or descpats, Or statuspats] ++ otherpats
 | 
						|
  Right (q, opts)
 | 
						|
 | 
						|
-- XXX
 | 
						|
-- | Quote-and-prefix-aware version of words - don't split on spaces which
 | 
						|
-- are inside quotes, including quotes which may have one of the specified
 | 
						|
-- prefixes in front, and maybe an additional not: prefix in front of that.
 | 
						|
words'' :: [T.Text] -> T.Text -> [T.Text]
 | 
						|
words'' prefixes = fromparse . parsewith maybeprefixedquotedphrases -- XXX
 | 
						|
    where
 | 
						|
      maybeprefixedquotedphrases :: SimpleTextParser [T.Text]
 | 
						|
      maybeprefixedquotedphrases = choice' [prefixedQuotedPattern, singleQuotedPattern, doubleQuotedPattern, pattern] `sepBy` skipNonNewlineSpaces1
 | 
						|
      prefixedQuotedPattern :: SimpleTextParser T.Text
 | 
						|
      prefixedQuotedPattern = do
 | 
						|
        not' <- fromMaybe "" `fmap` (optional $ string "not:")
 | 
						|
        let allowednexts | T.null not' = prefixes
 | 
						|
                         | otherwise   = prefixes ++ [""]
 | 
						|
        next <- choice' $ map string allowednexts
 | 
						|
        let prefix :: T.Text
 | 
						|
            prefix = not' <> next
 | 
						|
        p <- singleQuotedPattern <|> doubleQuotedPattern
 | 
						|
        return $ prefix <> stripquotes p
 | 
						|
      singleQuotedPattern :: SimpleTextParser T.Text
 | 
						|
      singleQuotedPattern = between (char '\'') (char '\'') (many $ noneOf ("'" :: [Char])) >>= return . stripquotes . T.pack
 | 
						|
      doubleQuotedPattern :: SimpleTextParser T.Text
 | 
						|
      doubleQuotedPattern = between (char '"') (char '"') (many $ noneOf ("\"" :: [Char])) >>= return . stripquotes . T.pack
 | 
						|
      pattern :: SimpleTextParser T.Text
 | 
						|
      pattern = fmap T.pack $ many (noneOf (" \n\r" :: [Char]))
 | 
						|
 | 
						|
-- XXX
 | 
						|
-- keep synced with patterns below, excluding "not"
 | 
						|
prefixes :: [T.Text]
 | 
						|
prefixes = map (<>":") [
 | 
						|
     "inacctonly"
 | 
						|
    ,"inacct"
 | 
						|
    ,"amt"
 | 
						|
    ,"code"
 | 
						|
    ,"desc"
 | 
						|
    ,"payee"
 | 
						|
    ,"note"
 | 
						|
    ,"acct"
 | 
						|
    ,"date"
 | 
						|
    ,"date2"
 | 
						|
    ,"status"
 | 
						|
    ,"cur"
 | 
						|
    ,"real"
 | 
						|
    ,"empty"
 | 
						|
    ,"depth"
 | 
						|
    ,"tag"
 | 
						|
    ]
 | 
						|
 | 
						|
defaultprefix :: T.Text
 | 
						|
defaultprefix = "acct"
 | 
						|
 | 
						|
-- -- | Parse the query string as a boolean tree of match patterns.
 | 
						|
-- parseQueryTerm :: String -> Query
 | 
						|
-- parseQueryTerm s = either (const (Any)) id $ runParser query () "" $ lexmatcher s
 | 
						|
 | 
						|
-- lexmatcher :: String -> [String]
 | 
						|
-- lexmatcher s = words' s
 | 
						|
 | 
						|
-- query :: GenParser String () Query
 | 
						|
-- query = undefined
 | 
						|
 | 
						|
-- | Parse a single query term as either a query or a query option,
 | 
						|
-- or return an error message if parsing fails.
 | 
						|
parseQueryTerm :: Day -> T.Text -> Either String (Either Query QueryOpt)
 | 
						|
parseQueryTerm _ (T.stripPrefix "inacctonly:" -> Just s) = Right $ Right $ QueryOptInAcctOnly s
 | 
						|
parseQueryTerm _ (T.stripPrefix "inacct:" -> Just s) = Right $ Right $ QueryOptInAcct s
 | 
						|
parseQueryTerm d (T.stripPrefix "not:" -> Just s) =
 | 
						|
  case parseQueryTerm d s of
 | 
						|
    Right (Left m)  -> Right $ Left $ Not m
 | 
						|
    Right (Right _) -> Right $ Left Any -- not:somequeryoption will be ignored
 | 
						|
    Left err        -> Left err
 | 
						|
parseQueryTerm _ (T.stripPrefix "code:" -> Just s) = Left . Code <$> toRegexCI s
 | 
						|
parseQueryTerm _ (T.stripPrefix "desc:" -> Just s) = Left . Desc <$> toRegexCI s
 | 
						|
parseQueryTerm _ (T.stripPrefix "payee:" -> Just s) = Left <$> payeeTag (Just s)
 | 
						|
parseQueryTerm _ (T.stripPrefix "note:" -> Just s) = Left <$> noteTag (Just s)
 | 
						|
parseQueryTerm _ (T.stripPrefix "acct:" -> Just s) = Left . Acct <$> toRegexCI s
 | 
						|
parseQueryTerm d (T.stripPrefix "date2:" -> Just s) =
 | 
						|
        case parsePeriodExpr d s of Left e         -> Left $ "\"date2:"++T.unpack s++"\" gave a "++showDateParseError e
 | 
						|
                                    Right (_,span) -> Right $ Left $ Date2 span
 | 
						|
parseQueryTerm d (T.stripPrefix "date:" -> Just s) =
 | 
						|
        case parsePeriodExpr d s of Left e         -> Left $ "\"date:"++T.unpack s++"\" gave a "++showDateParseError e
 | 
						|
                                    Right (_,span) -> Right $ Left $ Date span
 | 
						|
parseQueryTerm _ (T.stripPrefix "status:" -> Just s) =
 | 
						|
        case parseStatus s of Left e   -> Left $ "\"status:"++T.unpack s++"\" gave a parse error: " ++ e
 | 
						|
                              Right st -> Right $ Left $ StatusQ st
 | 
						|
parseQueryTerm _ (T.stripPrefix "real:" -> Just s) = Right $ Left $ Real $ parseBool s || T.null s
 | 
						|
parseQueryTerm _ (T.stripPrefix "amt:" -> Just s) = Right $ Left $ Amt ord q where (ord, q) = either error id $ parseAmountQueryTerm s  -- PARTIAL:
 | 
						|
parseQueryTerm _ (T.stripPrefix "depth:" -> Just s)
 | 
						|
  | n >= 0    = Right $ Left $ Depth n
 | 
						|
  | otherwise = Left "depth: should have a positive number"
 | 
						|
  where n = readDef 0 (T.unpack s)
 | 
						|
 | 
						|
parseQueryTerm _ (T.stripPrefix "cur:" -> Just s) = Left . Sym <$> toRegexCI ("^" <> s <> "$") -- support cur: as an alias
 | 
						|
parseQueryTerm _ (T.stripPrefix "tag:" -> Just s) = Left <$> parseTag s
 | 
						|
parseQueryTerm _ "" = Right $ Left $ Any
 | 
						|
parseQueryTerm d s = parseQueryTerm d $ defaultprefix<>":"<>s
 | 
						|
 | 
						|
-- | Parse the argument of an amt query term ([OP][SIGN]NUM), to an
 | 
						|
-- OrdPlus and a Quantity, or if parsing fails, an error message. OP
 | 
						|
-- can be <=, <, >=, >, or = . NUM can be a simple integer or decimal.
 | 
						|
-- If a decimal, the decimal mark must be period, and it must have
 | 
						|
-- digits preceding it. Digit group marks are not allowed.
 | 
						|
parseAmountQueryTerm :: T.Text -> Either String (OrdPlus, Quantity)
 | 
						|
parseAmountQueryTerm amtarg =
 | 
						|
  case amtarg of
 | 
						|
    -- number has a + sign, do a signed comparison
 | 
						|
    (parse "<=+" -> Just q) -> Right (LtEq    ,q)
 | 
						|
    (parse "<+"  -> Just q) -> Right (Lt      ,q)
 | 
						|
    (parse ">=+" -> Just q) -> Right (GtEq    ,q)
 | 
						|
    (parse ">+"  -> Just q) -> Right (Gt      ,q)
 | 
						|
    (parse "=+"  -> Just q) -> Right (Eq      ,q)
 | 
						|
    (parse "+"   -> Just q) -> Right (Eq      ,q)
 | 
						|
    -- number has a - sign, do a signed comparison
 | 
						|
    (parse "<-"  -> Just q) -> Right (Lt      ,-q)
 | 
						|
    (parse "<=-" -> Just q) -> Right (LtEq    ,-q)
 | 
						|
    (parse ">-"  -> Just q) -> Right (Gt      ,-q)
 | 
						|
    (parse ">=-" -> Just q) -> Right (GtEq    ,-q)
 | 
						|
    (parse "=-"  -> Just q) -> Right (Eq      ,-q)
 | 
						|
    (parse "-"   -> Just q) -> Right (Eq      ,-q)
 | 
						|
    -- number is unsigned and zero, do a signed comparison (more useful)
 | 
						|
    (parse "<="  -> Just 0) -> Right (LtEq    ,0)
 | 
						|
    (parse "<"   -> Just 0) -> Right (Lt      ,0)
 | 
						|
    (parse ">="  -> Just 0) -> Right (GtEq    ,0)
 | 
						|
    (parse ">"   -> Just 0) -> Right (Gt      ,0)
 | 
						|
    -- number is unsigned and non-zero, do an absolute magnitude comparison
 | 
						|
    (parse "<="  -> Just q) -> Right (AbsLtEq ,q)
 | 
						|
    (parse "<"   -> Just q) -> Right (AbsLt   ,q)
 | 
						|
    (parse ">="  -> Just q) -> Right (AbsGtEq ,q)
 | 
						|
    (parse ">"   -> Just q) -> Right (AbsGt   ,q)
 | 
						|
    (parse "="   -> Just q) -> Right (AbsEq   ,q)
 | 
						|
    (parse ""    -> Just q) -> Right (AbsEq   ,q)
 | 
						|
    _ -> Left . T.unpack $
 | 
						|
         "could not parse as a comparison operator followed by an optionally-signed number: " <> amtarg
 | 
						|
  where
 | 
						|
    -- Strip outer whitespace from the text, require and remove the
 | 
						|
    -- specified prefix, remove all whitespace from the remainder, and
 | 
						|
    -- read it as a simple integer or decimal if possible.
 | 
						|
    parse :: T.Text -> T.Text -> Maybe Quantity
 | 
						|
    parse p s = (T.stripPrefix p . T.strip) s >>= readMay . T.unpack . T.filter (/=' ')
 | 
						|
 | 
						|
parseTag :: T.Text -> Either RegexError Query
 | 
						|
parseTag s = do
 | 
						|
    tag <- toRegexCI $ if T.null v then s else n
 | 
						|
    body <- if T.null v then pure Nothing else Just <$> toRegexCI (T.tail v)
 | 
						|
    return $ Tag tag body
 | 
						|
  where (n,v) = T.break (=='=') s
 | 
						|
 | 
						|
-- | Parse the value part of a "status:" query, or return an error.
 | 
						|
parseStatus :: T.Text -> Either String Status
 | 
						|
parseStatus s | s `elem` ["*","1"] = Right Cleared
 | 
						|
              | s `elem` ["!"]     = Right Pending
 | 
						|
              | s `elem` ["","0"]  = Right Unmarked
 | 
						|
              | otherwise          = Left $ "could not parse "++show s++" as a status (should be *, ! or empty)"
 | 
						|
 | 
						|
-- | Parse the boolean value part of a "status:" query. "1" means true,
 | 
						|
-- anything else will be parsed as false without error.
 | 
						|
parseBool :: T.Text -> Bool
 | 
						|
parseBool s = s `elem` truestrings
 | 
						|
 | 
						|
truestrings :: [T.Text]
 | 
						|
truestrings = ["1"]
 | 
						|
 | 
						|
simplifyQuery :: Query -> Query
 | 
						|
simplifyQuery q =
 | 
						|
  let q' = simplify q
 | 
						|
  in if q' == q then q else simplifyQuery q'
 | 
						|
  where
 | 
						|
    simplify (And []) = Any
 | 
						|
    simplify (And [q]) = simplify q
 | 
						|
    simplify (And qs) | same qs = simplify $ head qs
 | 
						|
                      | any (==None) qs = None
 | 
						|
                      | all queryIsDate qs = Date $ spansIntersect $ mapMaybe queryTermDateSpan qs
 | 
						|
                      | otherwise = And $ concat $ [map simplify dateqs, map simplify otherqs]
 | 
						|
                      where (dateqs, otherqs) = partition queryIsDate $ filter (/=Any) qs
 | 
						|
    simplify (Or []) = Any
 | 
						|
    simplify (Or [q]) = simplifyQuery q
 | 
						|
    simplify (Or qs) | same qs = simplify $ head qs
 | 
						|
                     | any (==Any) qs = Any
 | 
						|
                     -- all queryIsDate qs = Date $ spansUnion $ mapMaybe queryTermDateSpan qs  ?
 | 
						|
                     | otherwise = Or $ map simplify $ filter (/=None) qs
 | 
						|
    simplify (Date (DateSpan Nothing Nothing)) = Any
 | 
						|
    simplify (Date2 (DateSpan Nothing Nothing)) = Any
 | 
						|
    simplify q = q
 | 
						|
 | 
						|
same [] = True
 | 
						|
same (a:as) = all (a==) as
 | 
						|
 | 
						|
-- | Remove query terms (or whole sub-expressions) not matching the given
 | 
						|
-- predicate from this query.  XXX Semantics not completely clear.
 | 
						|
filterQuery :: (Query -> Bool) -> Query -> Query
 | 
						|
filterQuery p = simplifyQuery . filterQuery' p
 | 
						|
 | 
						|
filterQuery' :: (Query -> Bool) -> Query -> Query
 | 
						|
filterQuery' p (And qs) = And $ map (filterQuery p) qs
 | 
						|
filterQuery' p (Or qs) = Or $ map (filterQuery p) qs
 | 
						|
-- filterQuery' p (Not q) = Not $ filterQuery p q
 | 
						|
filterQuery' p q = if p q then q else Any
 | 
						|
 | 
						|
-- * accessors
 | 
						|
 | 
						|
-- | Does this query match everything ?
 | 
						|
queryIsNull :: Query -> Bool
 | 
						|
queryIsNull Any = True
 | 
						|
queryIsNull (And []) = True
 | 
						|
queryIsNull (Not (Or [])) = True
 | 
						|
queryIsNull _ = False
 | 
						|
 | 
						|
queryIsDepth :: Query -> Bool
 | 
						|
queryIsDepth (Depth _) = True
 | 
						|
queryIsDepth _ = False
 | 
						|
 | 
						|
queryIsDate :: Query -> Bool
 | 
						|
queryIsDate (Date _) = True
 | 
						|
queryIsDate _ = False
 | 
						|
 | 
						|
queryIsDate2 :: Query -> Bool
 | 
						|
queryIsDate2 (Date2 _) = True
 | 
						|
queryIsDate2 _ = False
 | 
						|
 | 
						|
queryIsDateOrDate2 :: Query -> Bool
 | 
						|
queryIsDateOrDate2 (Date _) = True
 | 
						|
queryIsDateOrDate2 (Date2 _) = True
 | 
						|
queryIsDateOrDate2 _ = False
 | 
						|
 | 
						|
queryIsDesc :: Query -> Bool
 | 
						|
queryIsDesc (Desc _) = True
 | 
						|
queryIsDesc _ = False
 | 
						|
 | 
						|
queryIsAcct :: Query -> Bool
 | 
						|
queryIsAcct (Acct _) = True
 | 
						|
queryIsAcct _ = False
 | 
						|
 | 
						|
queryIsAmt :: Query -> Bool
 | 
						|
queryIsAmt (Amt _ _) = True
 | 
						|
queryIsAmt _         = False
 | 
						|
 | 
						|
queryIsSym :: Query -> Bool
 | 
						|
queryIsSym (Sym _) = True
 | 
						|
queryIsSym _ = False
 | 
						|
 | 
						|
queryIsReal :: Query -> Bool
 | 
						|
queryIsReal (Real _) = True
 | 
						|
queryIsReal _ = False
 | 
						|
 | 
						|
queryIsStatus :: Query -> Bool
 | 
						|
queryIsStatus (StatusQ _) = True
 | 
						|
queryIsStatus _ = False
 | 
						|
 | 
						|
-- | Does this query specify a start date and nothing else (that would
 | 
						|
-- filter postings prior to the date) ?
 | 
						|
-- When the flag is true, look for a starting secondary date instead.
 | 
						|
queryIsStartDateOnly :: Bool -> Query -> Bool
 | 
						|
queryIsStartDateOnly _ Any = False
 | 
						|
queryIsStartDateOnly _ None = False
 | 
						|
queryIsStartDateOnly secondary (Or ms) = and $ map (queryIsStartDateOnly secondary) ms
 | 
						|
queryIsStartDateOnly secondary (And ms) = and $ map (queryIsStartDateOnly secondary) ms
 | 
						|
queryIsStartDateOnly False (Date (DateSpan (Just _) _)) = True
 | 
						|
queryIsStartDateOnly True (Date2 (DateSpan (Just _) _)) = True
 | 
						|
queryIsStartDateOnly _ _ = False
 | 
						|
 | 
						|
-- | What start date (or secondary date) does this query specify, if any ?
 | 
						|
-- For OR expressions, use the earliest of the dates. NOT is ignored.
 | 
						|
queryStartDate :: Bool -> Query -> Maybe Day
 | 
						|
queryStartDate secondary (Or ms) = earliestMaybeDate $ map (queryStartDate secondary) ms
 | 
						|
queryStartDate secondary (And ms) = latestMaybeDate $ map (queryStartDate secondary) ms
 | 
						|
queryStartDate False (Date (DateSpan (Just d) _)) = Just d
 | 
						|
queryStartDate True (Date2 (DateSpan (Just d) _)) = Just d
 | 
						|
queryStartDate _ _ = Nothing
 | 
						|
 | 
						|
-- | What end date (or secondary date) does this query specify, if any ?
 | 
						|
-- For OR expressions, use the latest of the dates. NOT is ignored.
 | 
						|
queryEndDate :: Bool -> Query -> Maybe Day
 | 
						|
queryEndDate secondary (Or ms) = latestMaybeDate' $ map (queryEndDate secondary) ms
 | 
						|
queryEndDate secondary (And ms) = earliestMaybeDate' $ map (queryEndDate secondary) ms
 | 
						|
queryEndDate False (Date (DateSpan _ (Just d))) = Just d
 | 
						|
queryEndDate True (Date2 (DateSpan _ (Just d))) = Just d
 | 
						|
queryEndDate _ _ = Nothing
 | 
						|
 | 
						|
queryTermDateSpan (Date span) = Just span
 | 
						|
queryTermDateSpan _ = Nothing
 | 
						|
 | 
						|
-- | What date span (or with a true argument, what secondary date span) does this query specify ?
 | 
						|
-- OR clauses specifying multiple spans return their union (the span enclosing all of them).
 | 
						|
-- AND clauses specifying multiple spans return their intersection.
 | 
						|
-- NOT clauses are ignored.
 | 
						|
queryDateSpan :: Bool -> Query -> DateSpan
 | 
						|
queryDateSpan secondary (Or qs)  = spansUnion     $ map (queryDateSpan secondary) qs
 | 
						|
queryDateSpan secondary (And qs) = spansIntersect $ map (queryDateSpan secondary) qs
 | 
						|
queryDateSpan False (Date span)  = span
 | 
						|
queryDateSpan True (Date2 span)  = span
 | 
						|
queryDateSpan _ _                = nulldatespan
 | 
						|
 | 
						|
-- | What date span does this query specify, treating primary and secondary dates as equivalent ?
 | 
						|
-- OR clauses specifying multiple spans return their union (the span enclosing all of them).
 | 
						|
-- AND clauses specifying multiple spans return their intersection.
 | 
						|
-- NOT clauses are ignored.
 | 
						|
queryDateSpan' :: Query -> DateSpan
 | 
						|
queryDateSpan' (Or qs)      = spansUnion     $ map queryDateSpan' qs
 | 
						|
queryDateSpan' (And qs)     = spansIntersect $ map queryDateSpan' qs
 | 
						|
queryDateSpan' (Date span)  = span
 | 
						|
queryDateSpan' (Date2 span) = span
 | 
						|
queryDateSpan' _            = nulldatespan
 | 
						|
 | 
						|
-- | What is the earliest of these dates, where Nothing is earliest ?
 | 
						|
earliestMaybeDate :: [Maybe Day] -> Maybe Day
 | 
						|
earliestMaybeDate = fromMaybe Nothing . minimumMay
 | 
						|
 | 
						|
-- | What is the latest of these dates, where Nothing is earliest ?
 | 
						|
latestMaybeDate :: [Maybe Day] -> Maybe Day
 | 
						|
latestMaybeDate = fromMaybe Nothing . maximumMay
 | 
						|
 | 
						|
-- | What is the earliest of these dates, where Nothing is the latest ?
 | 
						|
earliestMaybeDate' :: [Maybe Day] -> Maybe Day
 | 
						|
earliestMaybeDate' = fromMaybe Nothing . minimumMay . filter isJust
 | 
						|
 | 
						|
-- | What is the latest of these dates, where Nothing is the latest ?
 | 
						|
latestMaybeDate' :: [Maybe Day] -> Maybe Day
 | 
						|
latestMaybeDate' = fromMaybe Nothing . maximumByMay compareNothingMax
 | 
						|
  where
 | 
						|
    compareNothingMax Nothing  Nothing  = EQ
 | 
						|
    compareNothingMax (Just _) Nothing  = LT
 | 
						|
    compareNothingMax Nothing  (Just _) = GT
 | 
						|
    compareNothingMax (Just a) (Just b) = compare a b
 | 
						|
 | 
						|
-- | The depth limit this query specifies, if it has one
 | 
						|
queryDepth :: Query -> Maybe Int
 | 
						|
queryDepth = minimumMay . queryDepth'
 | 
						|
  where
 | 
						|
    queryDepth' (Depth d) = [d]
 | 
						|
    queryDepth' (Or qs)   = concatMap queryDepth' qs
 | 
						|
    queryDepth' (And qs)  = concatMap queryDepth' qs
 | 
						|
    queryDepth' _         = []
 | 
						|
 | 
						|
-- | The account we are currently focussed on, if any, and whether subaccounts are included.
 | 
						|
-- Just looks at the first query option.
 | 
						|
inAccount :: [QueryOpt] -> Maybe (AccountName,Bool)
 | 
						|
inAccount [] = Nothing
 | 
						|
inAccount (QueryOptInAcctOnly a:_) = Just (a,False)
 | 
						|
inAccount (QueryOptInAcct a:_) = Just (a,True)
 | 
						|
 | 
						|
-- | A query for the account(s) we are currently focussed on, if any.
 | 
						|
-- Just looks at the first query option.
 | 
						|
inAccountQuery :: [QueryOpt] -> Maybe Query
 | 
						|
inAccountQuery [] = Nothing
 | 
						|
inAccountQuery (QueryOptInAcctOnly a : _) = Just . Acct $ accountNameToAccountOnlyRegex a
 | 
						|
inAccountQuery (QueryOptInAcct a     : _) = Just . Acct $ accountNameToAccountRegex a
 | 
						|
 | 
						|
-- -- | Convert a query to its inverse.
 | 
						|
-- negateQuery :: Query -> Query
 | 
						|
-- negateQuery =  Not
 | 
						|
 | 
						|
-- matching
 | 
						|
 | 
						|
-- | Does the match expression match this account ?
 | 
						|
-- A matching in: clause is also considered a match.
 | 
						|
-- When matching by account name pattern, if there's a regular
 | 
						|
-- expression error, this function calls error.
 | 
						|
matchesAccount :: Query -> AccountName -> Bool
 | 
						|
matchesAccount (None) _ = False
 | 
						|
matchesAccount (Not m) a = not $ matchesAccount m a
 | 
						|
matchesAccount (Or ms) a = any (`matchesAccount` a) ms
 | 
						|
matchesAccount (And ms) a = all (`matchesAccount` a) ms
 | 
						|
matchesAccount (Acct r) a = regexMatchText r a
 | 
						|
matchesAccount (Depth d) a = accountNameLevel a <= d
 | 
						|
matchesAccount (Tag _ _) _ = False
 | 
						|
matchesAccount _ _ = True
 | 
						|
 | 
						|
matchesMixedAmount :: Query -> MixedAmount -> Bool
 | 
						|
matchesMixedAmount q ma = case amountsRaw ma of
 | 
						|
    [] -> q `matchesAmount` nullamt
 | 
						|
    as -> any (q `matchesAmount`) as
 | 
						|
 | 
						|
matchesCommodity :: Query -> CommoditySymbol -> Bool
 | 
						|
matchesCommodity (Sym r) = regexMatchText r
 | 
						|
matchesCommodity _ = const True
 | 
						|
 | 
						|
-- | Does the match expression match this (simple) amount ?
 | 
						|
matchesAmount :: Query -> Amount -> Bool
 | 
						|
matchesAmount (Not q) a = not $ q `matchesAmount` a
 | 
						|
matchesAmount (Any) _ = True
 | 
						|
matchesAmount (None) _ = False
 | 
						|
matchesAmount (Or qs) a = any (`matchesAmount` a) qs
 | 
						|
matchesAmount (And qs) a = all (`matchesAmount` a) qs
 | 
						|
matchesAmount (Amt ord n) a = compareAmount ord n a
 | 
						|
matchesAmount (Sym r) a = matchesCommodity (Sym r) (acommodity a)
 | 
						|
matchesAmount _ _ = True
 | 
						|
 | 
						|
-- | Is this simple (single-amount) mixed amount's quantity less than, greater than, equal to, or unsignedly equal to this number ?
 | 
						|
-- For multi-amount (multiple commodities, or just unsimplified) mixed amounts this is always true.
 | 
						|
 | 
						|
-- | Is this amount's quantity less than, greater than, equal to, or unsignedly equal to this number ?
 | 
						|
compareAmount :: OrdPlus -> Quantity -> Amount -> Bool
 | 
						|
compareAmount ord q Amount{aquantity=aq} = case ord of Lt      -> aq <  q
 | 
						|
                                                       LtEq    -> aq <= q
 | 
						|
                                                       Gt      -> aq >  q
 | 
						|
                                                       GtEq    -> aq >= q
 | 
						|
                                                       Eq      -> aq == q
 | 
						|
                                                       AbsLt   -> abs aq <  abs q
 | 
						|
                                                       AbsLtEq -> abs aq <= abs q
 | 
						|
                                                       AbsGt   -> abs aq >  abs q
 | 
						|
                                                       AbsGtEq -> abs aq >= abs q
 | 
						|
                                                       AbsEq   -> abs aq == abs q
 | 
						|
 | 
						|
-- | Does the match expression match this posting ?
 | 
						|
--
 | 
						|
-- Note that for account match we try both original and effective account
 | 
						|
matchesPosting :: Query -> Posting -> Bool
 | 
						|
matchesPosting (Not q) p = not $ q `matchesPosting` p
 | 
						|
matchesPosting (Any) _ = True
 | 
						|
matchesPosting (None) _ = False
 | 
						|
matchesPosting (Or qs) p = any (`matchesPosting` p) qs
 | 
						|
matchesPosting (And qs) p = all (`matchesPosting` p) qs
 | 
						|
matchesPosting (Code r) p = maybe False (regexMatchText r . tcode) $ ptransaction p
 | 
						|
matchesPosting (Desc r) p = maybe False (regexMatchText r . tdescription) $ ptransaction p
 | 
						|
matchesPosting (Acct r) p = matches p || maybe False matches (poriginal p)
 | 
						|
  where matches = regexMatchText r . paccount
 | 
						|
matchesPosting (Date span) p = span `spanContainsDate` postingDate p
 | 
						|
matchesPosting (Date2 span) p = span `spanContainsDate` postingDate2 p
 | 
						|
matchesPosting (StatusQ s) p = postingStatus p == s
 | 
						|
matchesPosting (Real v) p = v == isReal p
 | 
						|
matchesPosting q@(Depth _) Posting{paccount=a} = q `matchesAccount` a
 | 
						|
matchesPosting q@(Amt _ _) Posting{pamount=as} = q `matchesMixedAmount` as
 | 
						|
matchesPosting (Sym r) Posting{pamount=as} = any (matchesCommodity (Sym r)) . map acommodity $ amountsRaw as
 | 
						|
matchesPosting (Tag n v) p = case (reString n, v) of
 | 
						|
  ("payee", Just v) -> maybe False (regexMatchText v . transactionPayee) $ ptransaction p
 | 
						|
  ("note", Just v) -> maybe False (regexMatchText v . transactionNote) $ ptransaction p
 | 
						|
  (_, v) -> matchesTags n v $ postingAllTags p
 | 
						|
 | 
						|
-- | Does the match expression match this transaction ?
 | 
						|
matchesTransaction :: Query -> Transaction -> Bool
 | 
						|
matchesTransaction (Not q) t = not $ q `matchesTransaction` t
 | 
						|
matchesTransaction (Any) _ = True
 | 
						|
matchesTransaction (None) _ = False
 | 
						|
matchesTransaction (Or qs) t = any (`matchesTransaction` t) qs
 | 
						|
matchesTransaction (And qs) t = all (`matchesTransaction` t) qs
 | 
						|
matchesTransaction (Code r) t = regexMatchText r $ tcode t
 | 
						|
matchesTransaction (Desc r) t = regexMatchText r $ tdescription t
 | 
						|
matchesTransaction q@(Acct _) t = any (q `matchesPosting`) $ tpostings t
 | 
						|
matchesTransaction (Date span) t = spanContainsDate span $ tdate t
 | 
						|
matchesTransaction (Date2 span) t = spanContainsDate span $ transactionDate2 t
 | 
						|
matchesTransaction (StatusQ s) t = tstatus t == s
 | 
						|
matchesTransaction (Real v) t = v == hasRealPostings t
 | 
						|
matchesTransaction q@(Amt _ _) t = any (q `matchesPosting`) $ tpostings t
 | 
						|
matchesTransaction (Depth d) t = any (Depth d `matchesPosting`) $ tpostings t
 | 
						|
matchesTransaction q@(Sym _) t = any (q `matchesPosting`) $ tpostings t
 | 
						|
matchesTransaction (Tag n v) t = case (reString n, v) of
 | 
						|
  ("payee", Just v) -> regexMatchText v $ transactionPayee t
 | 
						|
  ("note", Just v) -> regexMatchText v $ transactionNote t
 | 
						|
  (_, v) -> matchesTags n v $ transactionAllTags t
 | 
						|
 | 
						|
-- | Does the query match this transaction description ?
 | 
						|
-- Tests desc: terms, any other terms are ignored.
 | 
						|
matchesDescription :: Query -> Text -> Bool
 | 
						|
matchesDescription (Not q) d      = not $ q `matchesDescription` d
 | 
						|
matchesDescription (Any) _        = True
 | 
						|
matchesDescription (None) _       = False
 | 
						|
matchesDescription (Or qs) d      = any (`matchesDescription` d) $ filter queryIsDesc qs
 | 
						|
matchesDescription (And qs) d     = all (`matchesDescription` d) $ filter queryIsDesc qs
 | 
						|
matchesDescription (Code _) _     = False
 | 
						|
matchesDescription (Desc r) d     = regexMatchText r d
 | 
						|
matchesDescription (Acct _) _     = False
 | 
						|
matchesDescription (Date _) _     = False
 | 
						|
matchesDescription (Date2 _) _    = False
 | 
						|
matchesDescription (StatusQ _) _  = False
 | 
						|
matchesDescription (Real _) _     = False
 | 
						|
matchesDescription (Amt _ _) _    = False
 | 
						|
matchesDescription (Depth _) _    = False
 | 
						|
matchesDescription (Sym _) _      = False
 | 
						|
matchesDescription (Tag _ _) _    = False
 | 
						|
 | 
						|
-- | Does the query match this transaction payee ?
 | 
						|
-- Tests desc: (and payee: ?) terms, any other terms are ignored.
 | 
						|
-- XXX Currently an alias for matchDescription. I'm not sure if more is needed,
 | 
						|
-- There's some shenanigan with payee: and "payeeTag" to figure out.
 | 
						|
matchesPayeeWIP :: Query -> Payee -> Bool
 | 
						|
matchesPayeeWIP q p = matchesDescription q p
 | 
						|
 | 
						|
-- | Does the query match the name and optionally the value of any of these tags ?
 | 
						|
matchesTags :: Regexp -> Maybe Regexp -> [Tag] -> Bool
 | 
						|
matchesTags namepat valuepat = not . null . filter (matches namepat valuepat)
 | 
						|
  where
 | 
						|
    matches npat vpat (n,v) = regexMatchText npat n && maybe (const True) regexMatchText vpat v
 | 
						|
 | 
						|
-- | Does the query match this market price ?
 | 
						|
matchesPriceDirective :: Query -> PriceDirective -> Bool
 | 
						|
matchesPriceDirective (None) _      = False
 | 
						|
matchesPriceDirective (Not q) p     = not $ matchesPriceDirective q p
 | 
						|
matchesPriceDirective (Or qs) p     = any (`matchesPriceDirective` p) qs
 | 
						|
matchesPriceDirective (And qs) p    = all (`matchesPriceDirective` p) qs
 | 
						|
matchesPriceDirective q@(Amt _ _) p = matchesAmount q (pdamount p)
 | 
						|
matchesPriceDirective q@(Sym _) p   = matchesCommodity q (pdcommodity p)
 | 
						|
matchesPriceDirective (Date span) p = spanContainsDate span (pddate p)
 | 
						|
matchesPriceDirective _ _           = True
 | 
						|
 | 
						|
 | 
						|
-- tests
 | 
						|
 | 
						|
tests_Query = tests "Query" [
 | 
						|
   test "simplifyQuery" $ do
 | 
						|
     (simplifyQuery $ Or [Acct $ toRegex' "a"])      @?= (Acct $ toRegex' "a")
 | 
						|
     (simplifyQuery $ Or [Any,None])      @?= (Any)
 | 
						|
     (simplifyQuery $ And [Any,None])     @?= (None)
 | 
						|
     (simplifyQuery $ And [Any,Any])      @?= (Any)
 | 
						|
     (simplifyQuery $ And [Acct $ toRegex' "b",Any]) @?= (Acct $ toRegex' "b")
 | 
						|
     (simplifyQuery $ And [Any,And [Date (DateSpan Nothing Nothing)]]) @?= (Any)
 | 
						|
     (simplifyQuery $ And [Date (DateSpan Nothing (Just $ fromGregorian 2013 01 01)), Date (DateSpan (Just $ fromGregorian 2012 01 01) Nothing)])
 | 
						|
       @?= (Date (DateSpan (Just $ fromGregorian 2012 01 01) (Just $ fromGregorian 2013 01 01)))
 | 
						|
     (simplifyQuery $ And [Or [],Or [Desc $ toRegex' "b b"]]) @?= (Desc $ toRegex' "b b")
 | 
						|
 | 
						|
  ,test "parseQuery" $ do
 | 
						|
     (parseQuery nulldate "acct:'expenses:autres d\233penses' desc:b") @?= Right (And [Acct $ toRegexCI' "expenses:autres d\233penses", Desc $ toRegexCI' "b"], [])
 | 
						|
     parseQuery nulldate "inacct:a desc:\"b b\""                       @?= Right (Desc $ toRegexCI' "b b", [QueryOptInAcct "a"])
 | 
						|
     parseQuery nulldate "inacct:a inacct:b"                           @?= Right (Any, [QueryOptInAcct "a", QueryOptInAcct "b"])
 | 
						|
     parseQuery nulldate "desc:'x x'"                                  @?= Right (Desc $ toRegexCI' "x x", [])
 | 
						|
     parseQuery nulldate "'a a' 'b"                                    @?= Right (Or [Acct $ toRegexCI' "a a",Acct $ toRegexCI' "'b"], [])
 | 
						|
     parseQuery nulldate "\""                                          @?= Right (Acct $ toRegexCI' "\"", [])
 | 
						|
 | 
						|
  ,test "words''" $ do
 | 
						|
      (words'' [] "a b")                   @?= ["a","b"]
 | 
						|
      (words'' [] "'a b'")                 @?= ["a b"]
 | 
						|
      (words'' [] "not:a b")               @?= ["not:a","b"]
 | 
						|
      (words'' [] "not:'a b'")             @?= ["not:a b"]
 | 
						|
      (words'' [] "'not:a b'")             @?= ["not:a b"]
 | 
						|
      (words'' ["desc:"] "not:desc:'a b'") @?= ["not:desc:a b"]
 | 
						|
      (words'' prefixes "\"acct:expenses:autres d\233penses\"") @?= ["acct:expenses:autres d\233penses"]
 | 
						|
      (words'' prefixes "\"")              @?= ["\""]
 | 
						|
 | 
						|
  ,test "filterQuery" $ do
 | 
						|
     filterQuery queryIsDepth Any       @?= Any
 | 
						|
     filterQuery queryIsDepth (Depth 1) @?= Depth 1
 | 
						|
     filterQuery (not.queryIsDepth) (And [And [StatusQ Cleared,Depth 1]]) @?= StatusQ Cleared
 | 
						|
     filterQuery queryIsDepth (And [Date nulldatespan, Not (Or [Any, Depth 1])]) @?= Any   -- XXX unclear
 | 
						|
 | 
						|
  ,test "parseQueryTerm" $ do
 | 
						|
     parseQueryTerm nulldate "a"                                @?= Right (Left $ Acct $ toRegexCI' "a")
 | 
						|
     parseQueryTerm nulldate "acct:expenses:autres d\233penses" @?= Right (Left $ Acct $ toRegexCI' "expenses:autres d\233penses")
 | 
						|
     parseQueryTerm nulldate "not:desc:a b"                     @?= Right (Left $ Not $ Desc $ toRegexCI' "a b")
 | 
						|
     parseQueryTerm nulldate "status:1"                         @?= Right (Left $ StatusQ Cleared)
 | 
						|
     parseQueryTerm nulldate "status:*"                         @?= Right (Left $ StatusQ Cleared)
 | 
						|
     parseQueryTerm nulldate "status:!"                         @?= Right (Left $ StatusQ Pending)
 | 
						|
     parseQueryTerm nulldate "status:0"                         @?= Right (Left $ StatusQ Unmarked)
 | 
						|
     parseQueryTerm nulldate "status:"                          @?= Right (Left $ StatusQ Unmarked)
 | 
						|
     parseQueryTerm nulldate "payee:x"                          @?= Left <$> payeeTag (Just "x")
 | 
						|
     parseQueryTerm nulldate "note:x"                           @?= Left <$> noteTag (Just "x")
 | 
						|
     parseQueryTerm nulldate "real:1"                           @?= Right (Left $ Real True)
 | 
						|
     parseQueryTerm nulldate "date:2008"                        @?= Right (Left $ Date $ DateSpan (Just $ fromGregorian 2008 01 01) (Just $ fromGregorian 2009 01 01))
 | 
						|
     parseQueryTerm nulldate "date:from 2012/5/17"              @?= Right (Left $ Date $ DateSpan (Just $ fromGregorian 2012 05 17) Nothing)
 | 
						|
     parseQueryTerm nulldate "date:20180101-201804"             @?= Right (Left $ Date $ DateSpan (Just $ fromGregorian 2018 01 01) (Just $ fromGregorian 2018 04 01))
 | 
						|
     parseQueryTerm nulldate "inacct:a"                         @?= Right (Right $ QueryOptInAcct "a")
 | 
						|
     parseQueryTerm nulldate "tag:a"                            @?= Right (Left $ Tag (toRegexCI' "a") Nothing)
 | 
						|
     parseQueryTerm nulldate "tag:a=some value"                 @?= Right (Left $ Tag (toRegexCI' "a") (Just $ toRegexCI' "some value"))
 | 
						|
     parseQueryTerm nulldate "amt:<0"                           @?= Right (Left $ Amt Lt 0)
 | 
						|
     parseQueryTerm nulldate "amt:>10000.10"                    @?= Right (Left $ Amt AbsGt 10000.1)
 | 
						|
 | 
						|
  ,test "parseAmountQueryTerm" $ do
 | 
						|
     parseAmountQueryTerm "<0"        @?= Right (Lt,0) -- special case for convenience, since AbsLt 0 would be always false
 | 
						|
     parseAmountQueryTerm ">0"        @?= Right (Gt,0) -- special case for convenience and consistency with above
 | 
						|
     parseAmountQueryTerm " > - 0 "   @?= Right (Gt,0) -- accept whitespace around the argument parts
 | 
						|
     parseAmountQueryTerm ">10000.10" @?= Right (AbsGt,10000.1)
 | 
						|
     parseAmountQueryTerm "=0.23"     @?= Right (AbsEq,0.23)
 | 
						|
     parseAmountQueryTerm "0.23"      @?= Right (AbsEq,0.23)
 | 
						|
     parseAmountQueryTerm "<=+0.23"   @?= Right (LtEq,0.23)
 | 
						|
     parseAmountQueryTerm "-0.23"     @?= Right (Eq,(-0.23))
 | 
						|
     assertLeft $ parseAmountQueryTerm "-0,23"
 | 
						|
     assertLeft $ parseAmountQueryTerm "=.23"
 | 
						|
 | 
						|
  ,test "queryStartDate" $ do
 | 
						|
     let small = Just $ fromGregorian 2000 01 01
 | 
						|
         big   = Just $ fromGregorian 2000 01 02
 | 
						|
     queryStartDate False (And [Date $ DateSpan small Nothing, Date $ DateSpan big Nothing])     @?= big
 | 
						|
     queryStartDate False (And [Date $ DateSpan small Nothing, Date $ DateSpan Nothing Nothing]) @?= small
 | 
						|
     queryStartDate False (Or  [Date $ DateSpan small Nothing, Date $ DateSpan big Nothing])     @?= small
 | 
						|
     queryStartDate False (Or  [Date $ DateSpan small Nothing, Date $ DateSpan Nothing Nothing]) @?= Nothing
 | 
						|
 | 
						|
  ,test "queryEndDate" $ do
 | 
						|
     let small = Just $ fromGregorian 2000 01 01
 | 
						|
         big   = Just $ fromGregorian 2000 01 02
 | 
						|
     queryEndDate False (And [Date $ DateSpan Nothing small, Date $ DateSpan Nothing big])     @?= small
 | 
						|
     queryEndDate False (And [Date $ DateSpan Nothing small, Date $ DateSpan Nothing Nothing]) @?= small
 | 
						|
     queryEndDate False (Or  [Date $ DateSpan Nothing small, Date $ DateSpan Nothing big])     @?= big
 | 
						|
     queryEndDate False (Or  [Date $ DateSpan Nothing small, Date $ DateSpan Nothing Nothing]) @?= Nothing
 | 
						|
 | 
						|
  ,test "matchesAccount" $ do
 | 
						|
     assertBool "" $ (Acct $ toRegex' "b:c") `matchesAccount` "a:bb:c:d"
 | 
						|
     assertBool "" $ not $ (Acct $ toRegex' "^a:b") `matchesAccount` "c:a:b"
 | 
						|
     assertBool "" $ Depth 2 `matchesAccount` "a"
 | 
						|
     assertBool "" $ Depth 2 `matchesAccount` "a:b"
 | 
						|
     assertBool "" $ not $ Depth 2 `matchesAccount` "a:b:c"
 | 
						|
     assertBool "" $ Date nulldatespan `matchesAccount` "a"
 | 
						|
     assertBool "" $ Date2 nulldatespan `matchesAccount` "a"
 | 
						|
     assertBool "" $ not $ Tag (toRegex' "a") Nothing `matchesAccount` "a"
 | 
						|
 | 
						|
  ,tests "matchesPosting" [
 | 
						|
     test "positive match on cleared posting status"  $
 | 
						|
      assertBool "" $ (StatusQ Cleared)  `matchesPosting` nullposting{pstatus=Cleared}
 | 
						|
    ,test "negative match on cleared posting status"  $
 | 
						|
      assertBool "" $ not $ (Not $ StatusQ Cleared)  `matchesPosting` nullposting{pstatus=Cleared}
 | 
						|
    ,test "positive match on unmarked posting status" $
 | 
						|
      assertBool "" $ (StatusQ Unmarked) `matchesPosting` nullposting{pstatus=Unmarked}
 | 
						|
    ,test "negative match on unmarked posting status" $
 | 
						|
      assertBool "" $ not $ (Not $ StatusQ Unmarked) `matchesPosting` nullposting{pstatus=Unmarked}
 | 
						|
    ,test "positive match on true posting status acquired from transaction" $
 | 
						|
      assertBool "" $ (StatusQ Cleared) `matchesPosting` nullposting{pstatus=Unmarked,ptransaction=Just nulltransaction{tstatus=Cleared}}
 | 
						|
    ,test "real:1 on real posting" $ assertBool "" $ (Real True) `matchesPosting` nullposting{ptype=RegularPosting}
 | 
						|
    ,test "real:1 on virtual posting fails" $ assertBool "" $ not $ (Real True) `matchesPosting` nullposting{ptype=VirtualPosting}
 | 
						|
    ,test "real:1 on balanced virtual posting fails" $ assertBool "" $ not $ (Real True) `matchesPosting` nullposting{ptype=BalancedVirtualPosting}
 | 
						|
    ,test "acct:" $ assertBool "" $ (Acct $ toRegex' "'b") `matchesPosting` nullposting{paccount="'b"}
 | 
						|
    ,test "tag:" $ do
 | 
						|
      assertBool "" $ not $ (Tag (toRegex' "a") (Just $ toRegex' "r$")) `matchesPosting` nullposting
 | 
						|
      assertBool "" $ (Tag (toRegex' "foo") Nothing) `matchesPosting` nullposting{ptags=[("foo","")]}
 | 
						|
      assertBool "" $ (Tag (toRegex' "foo") Nothing) `matchesPosting` nullposting{ptags=[("foo","baz")]}
 | 
						|
      assertBool "" $ (Tag (toRegex' "foo") (Just $ toRegex' "a")) `matchesPosting` nullposting{ptags=[("foo","bar")]}
 | 
						|
      assertBool "" $ not $ (Tag (toRegex' "foo") (Just $ toRegex' "a$")) `matchesPosting` nullposting{ptags=[("foo","bar")]}
 | 
						|
      assertBool "" $ not $ (Tag (toRegex' " foo ") (Just $ toRegex' "a")) `matchesPosting` nullposting{ptags=[("foo","bar")]}
 | 
						|
      assertBool "" $ not $ (Tag (toRegex' "foo foo") (Just $ toRegex' " ar ba ")) `matchesPosting` nullposting{ptags=[("foo foo","bar bar")]}
 | 
						|
    ,test "a tag match on a posting also sees inherited tags" $ assertBool "" $ (Tag (toRegex' "txntag") Nothing) `matchesPosting` nullposting{ptransaction=Just nulltransaction{ttags=[("txntag","")]}}
 | 
						|
    ,test "cur:" $ do
 | 
						|
      let toSym = either id (const $ error' "No query opts") . either error' id . parseQueryTerm (fromGregorian 2000 01 01) . ("cur:"<>)
 | 
						|
      assertBool "" $ not $ toSym "$" `matchesPosting` nullposting{pamount=mixedAmount $ usd 1} -- becomes "^$$", ie testing for null symbol
 | 
						|
      assertBool "" $ (toSym "\\$") `matchesPosting` nullposting{pamount=mixedAmount $ usd 1} -- have to quote $ for regexpr
 | 
						|
      assertBool "" $ (toSym "shekels") `matchesPosting` nullposting{pamount=mixedAmount nullamt{acommodity="shekels"}}
 | 
						|
      assertBool "" $ not $ (toSym "shek") `matchesPosting` nullposting{pamount=mixedAmount nullamt{acommodity="shekels"}}
 | 
						|
  ]
 | 
						|
 | 
						|
  ,test "matchesTransaction" $ do
 | 
						|
     assertBool "" $ Any `matchesTransaction` nulltransaction
 | 
						|
     assertBool "" $ not $ (Desc $ toRegex' "x x") `matchesTransaction` nulltransaction{tdescription="x"}
 | 
						|
     assertBool "" $ (Desc $ toRegex' "x x") `matchesTransaction` nulltransaction{tdescription="x x"}
 | 
						|
     -- see posting for more tag tests
 | 
						|
     assertBool "" $ (Tag (toRegex' "foo") (Just $ toRegex' "a")) `matchesTransaction` nulltransaction{ttags=[("foo","bar")]}
 | 
						|
     assertBool "" $ (Tag (toRegex' "payee") (Just $ toRegex' "payee")) `matchesTransaction` nulltransaction{tdescription="payee|note"}
 | 
						|
     assertBool "" $ (Tag (toRegex' "note") (Just $ toRegex' "note")) `matchesTransaction` nulltransaction{tdescription="payee|note"}
 | 
						|
     -- a tag match on a transaction also matches posting tags
 | 
						|
     assertBool "" $ (Tag (toRegex' "postingtag") Nothing) `matchesTransaction` nulltransaction{tpostings=[nullposting{ptags=[("postingtag","")]}]}
 | 
						|
 | 
						|
 ]
 |