Add "--enable-future-rundir" and start using the runDir

Author: apauley

ChangeLog.md

@@ -1,5 +1,13 @@
 # Changelog for [hledger-flow](https://github.com/apauley/hledger-flow)
 
+## 0.13.2
+
+Improve support for importing a subset of journals: start importing only from the directory given as argument,
+or the current directory, and generate only the relevant include files.
+
+This is a behavioural change and (for now) it needs to be enabled with the --enable-future-rundir switch.
+This will become the default behaviour in 0.14.x, at which time the switch will be removed.
+
 ## 0.13.1
 
 - Automatically add [include lines for yearly price files](https://github.com/apauley/hledger-flow/#price-files) if they are present on disk.

app/Main.hs

@@ -13,7 +13,7 @@ import Hledger.Flow.Reports
 import Hledger.Flow.CSVImport
 
 data ImportParams = ImportParams { maybeImportBaseDir :: Maybe FilePath
-                                 , maybeRunDir :: Maybe FilePath } deriving (Show)
+                                 , importUseRunDir :: Bool } deriving (Show)
 
 data ReportParams = ReportParams { maybeReportBaseDir :: Maybe FilePath } deriving (Show)
 
@@ -36,10 +36,11 @@ main = do
 
 toRuntimeOptionsImport :: MainParams -> ImportParams -> IO RT.RuntimeOptions
 toRuntimeOptionsImport mainParams' subParams' = do
-  (bd, _runDir) <- determineBaseDir $ maybeImportBaseDir subParams'
+  (bd, runDir) <- determineBaseDir $ maybeImportBaseDir subParams'
   hli <- hledgerInfoFromPath $ hledgerPathOpt mainParams'
   return RT.RuntimeOptions { RT.baseDir = bd
-                           , RT.importRunDir = maybeRunDir subParams'
+                           , RT.importRunDir = runDir
+                           , RT.useRunDir = importUseRunDir subParams'
                            , RT.hfVersion = versionInfo'
                            , RT.hledgerInfo = hli
                            , RT.sysInfo = systemInfo
@@ -52,7 +53,8 @@ toRuntimeOptionsReport mainParams' subParams' = do
   (bd, _) <- determineBaseDir $ maybeReportBaseDir subParams'
   hli <- hledgerInfoFromPath $ hledgerPathOpt mainParams'
   return RT.RuntimeOptions { RT.baseDir = bd
-                           , RT.importRunDir = Nothing
+                           , RT.importRunDir = "./"
+                           , RT.useRunDir = False
                            , RT.hfVersion = versionInfo'
                            , RT.hledgerInfo = hli
                            , RT.sysInfo = systemInfo
@@ -77,8 +79,8 @@ verboseParser = MainParams
 
 subcommandParserImport :: Parser ImportParams
 subcommandParserImport = ImportParams
-  <$> optional (argPath "dir" "The directory to import. Defaults to the current directory. Use the hledger-flow base directory for a full import.")
-  <*> optional (strOption (long "experimental-rundir" <> help "A subdirectory of the base where the command will restrict itself to"))
+  <$> optional (argPath "dir" "The directory to import. Use the base directory for a full import or a sub-directory for a partial import. Defaults to the current directory. This behaviour is changing: see --enable-future-rundir")
+  <*> switch (long "enable-future-rundir" <> help "Enable the future (0.14.x) default behaviour now: start importing only from the directory that was given as an argument, or the currect directory. Previously a full import was always done. This switch will be removed in 0.14.x")
 
 subcommandParserReport :: Parser ReportParams
 subcommandParserReport = ReportParams

package.yaml

@@ -1,5 +1,5 @@
 name:                hledger-flow
-version:             0.13.1.0
+version:             0.13.2.0
 synopsis:            An hledger workflow focusing on automated statement import and classification.
 category:            Finance, Console
 license:             GPL-3

src/Hledger/Flow/CSVImport.hs

@@ -35,10 +35,12 @@ inputFilePattern = contains (once (oneOf pathSeparators) <> asciiCI "1-in" <> on
 
 importCSVs' :: RuntimeOptions -> TChan FlowTypes.LogMessage -> IO [FilePath]
 importCSVs' opts ch = do
-  channelOutLn ch "Collecting input files..."
-  let effectiveDir = case importRunDir opts of
-        Nothing -> (baseDir opts) </> "import"
-        Just rd -> rd
+  let baseImportDir = forceTrailingSlash $ (baseDir opts) </> "import"
+  let runDir = forceTrailingSlash $ collapse $ (baseDir opts) </> (importRunDir opts)
+  let effectiveDir = if useRunDir opts
+        then if (forceTrailingSlash $ runDir </> "import") == baseImportDir then baseImportDir else runDir
+        else baseImportDir
+  channelOutLn ch $ format ("Collecting input files from "%fp) effectiveDir
   (inputFiles, diff) <- time $ single . shellToList . onlyFiles $ find inputFilePattern effectiveDir
   let fileCount = length inputFiles
   if (fileCount == 0) then
@@ -52,8 +54,7 @@ importCSVs' opts ch = do
       channelOutLn ch $ format ("Found "%d%" input files in "%s%". Proceeding with import...") fileCount (repr diff)
       let actions = map (extractAndImport opts ch) inputFiles :: [IO FilePath]
       importedJournals <- parAwareActions opts actions
-      let stopAt = forceTrailingSlash $ (baseDir opts) </> "import"
-      _ <- writeIncludesUpTo opts ch stopAt importedJournals
+      _ <- writeIncludesUpTo opts ch effectiveDir importedJournals
       _ <- writeToplevelAllYearsInclude opts
       return importedJournals
 

src/Hledger/Flow/Common.hs

@@ -400,13 +400,13 @@ writeFileMap opts ch (m, allYears) = do
 
 writeIncludesUpTo :: (HasBaseDir o, HasVerbosity o) => o -> TChan LogMessage -> FilePath -> [FilePath] -> IO [FilePath]
 writeIncludesUpTo _ _ _ [] = return []
-writeIncludesUpTo opts ch stopAt paths = do
-  let shouldStop = any (\dir -> dir == stopAt) $ map parent paths
+writeIncludesUpTo opts ch stopAt journalFiles = do
+  let shouldStop = any (\dir -> dir == stopAt) $ map parent journalFiles
   if shouldStop
-    then return paths
+    then return journalFiles
     else do
-      newPaths <- groupAndWriteIncludeFiles opts ch paths
-      writeIncludesUpTo opts ch stopAt newPaths
+      newJournalFiles <- groupAndWriteIncludeFiles opts ch journalFiles
+      writeIncludesUpTo opts ch stopAt newJournalFiles
 
 writeToplevelAllYearsInclude :: (HasBaseDir o, HasVerbosity o) => o -> IO [FilePath]
 writeToplevelAllYearsInclude opts = do

src/Hledger/Flow/RuntimeOptions.hs

@@ -6,7 +6,8 @@ import Prelude hiding (FilePath, putStrLn)
 import Hledger.Flow.Types
 
 data RuntimeOptions = RuntimeOptions { baseDir :: FilePath
-                                     , importRunDir :: Maybe FilePath
+                                     , importRunDir :: FilePath
+                                     , useRunDir :: Bool
                                      , hfVersion :: Text
                                      , hledgerInfo :: HledgerInfo
                                      , sysInfo :: SystemInfo
@@ -17,10 +18,10 @@ data RuntimeOptions = RuntimeOptions { baseDir :: FilePath
   deriving (Show)
 
 instance HasVerbosity RuntimeOptions where
-  verbose (RuntimeOptions _ _ _ _ _ v _ _) = v
+  verbose (RuntimeOptions _ _ _ _ _ _ v _ _) = v
 
 instance HasSequential RuntimeOptions where
-  sequential (RuntimeOptions _ _ _ _ _ _ _ sq) = sq
+  sequential (RuntimeOptions _ _ _ _ _ _ _ _ sq) = sq
 
 instance HasBaseDir RuntimeOptions where
-  baseDir (RuntimeOptions bd _ _ _ _ _ _ _) = bd
+  baseDir (RuntimeOptions bd _ _ _ _ _ _ _ _) = bd

stack.yaml

@@ -18,7 +18,7 @@
 #
 # resolver: ./custom-snapshot.yaml
 # resolver: https://example.com/snapshots/2018-01-01.yaml
-resolver: nightly-2020-03-04
+resolver: nightly-2020-03-09
 
 # User packages to be built.
 # Various formats can be used as shown in the example below.

stack.yaml.lock

@@ -6,7 +6,7 @@
 packages: []
 snapshots:
 - completed:
-    size: 499085
-    url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/nightly/2020/3/4.yaml
-    sha256: 0b9c6af3bacc5ad30f63b0818f035632e43367bbbed0ffda4ddec470bd3cffa2
-  original: nightly-2020-03-04
+    size: 499083
+    url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/nightly/2020/3/9.yaml
+    sha256: 50f89cfb4370c15e4224a34a2316214d54e8a62b19a379fc2b1dc57ea3d5f358
+  original: nightly-2020-03-09

test/TestHelpers.hs

@@ -59,7 +59,7 @@ defaultHlInfo :: FlowTypes.HledgerInfo
 defaultHlInfo = FlowTypes.HledgerInfo "/path/to/hledger" "1.2.3"
 
 defaultOpts :: FilePath -> RuntimeOptions
-defaultOpts bd = RuntimeOptions bd Nothing versionInfo' defaultHlInfo systemInfo False False False
+defaultOpts bd = RuntimeOptions bd "./" True versionInfo' defaultHlInfo systemInfo False False False
 
 toJournals :: [FilePath] -> [FilePath]
 toJournals = map (changePathAndExtension "3-journal" "journal")