Merge pull request #66 from apauley/include-path-fix

Fix incorrect paths in include files when given a relative base dir

Author: apauley

.travis.yml

@@ -53,7 +53,6 @@ install:
   - git clone --recurse-submodules https://github.com/apauley/hledger-flow-example.git $HOME/hledger-flow-example
 
 script:
-  - stack test --interleaved-output
   - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then git checkout HEAD package.yaml; fi
   - hledger-flow --verbose --show-options import $HOME/hledger-flow-example
   - hledger-flow --verbose --show-options report $HOME/hledger-flow-example

ChangeLog.md

@@ -1,5 +1,21 @@
 # Changelog for [hledger-flow](https://github.com/apauley/hledger-flow)
 
+## 0.12.3.1
+
+Fixed a bug where:
+
+Given:
+- A run of `hledger-flow import`
+
+When:
+- specifying a relative import base directory
+- but specifically without any relative prefixes such as `./` or `../`
+
+Then:
+- the account-level include files pointing to the real journal entries would have incorrect paths
+
+https://github.com/apauley/hledger-flow/issues/65
+
 ## 0.12.3
 
 Add more reports:

package.yaml

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

src/Hledger/Flow/Common.hs

@@ -427,7 +427,9 @@ determineBaseDir Nothing = pwd >>= determineBaseDir'
 
 determineBaseDir' :: FilePath -> IO FilePath
 determineBaseDir' startDir = do
-  ebd <- determineBaseDir'' startDir startDir
+  currentDir <- pwd
+  let absoluteStartDir = if relative startDir then collapse (currentDir </> startDir) else startDir
+  ebd <- determineBaseDir'' absoluteStartDir absoluteStartDir
   case ebd of
     Right bd -> return bd
     Left  t  -> die t

stack.yaml

@@ -18,7 +18,7 @@
 #
 # resolver: ./custom-snapshot.yaml
 # resolver: https://example.com/snapshots/2018-01-01.yaml
-resolver: nightly-2019-05-26
+resolver: nightly-2019-06-21
 
 # User packages to be built.
 # Various formats can be used as shown in the example below.

test/Common/Integration.hs

@@ -7,6 +7,7 @@ import Test.HUnit
 import Turtle
 import Prelude hiding (FilePath)
 import qualified Data.List as List (sort)
+import qualified Data.Text as T
 
 import TestHelpers
 import Hledger.Flow.Common
@@ -49,6 +50,23 @@ testDirOrPwd = TestCase (
      )
   )
 
+assertSubDirsForDetermineBaseDir :: FilePath -> [FilePath] -> IO ()
+assertSubDirsForDetermineBaseDir expectedBaseDir importDirs = do
+  _ <- sequence $ map (assertDetermineBaseDir expectedBaseDir) importDirs
+  return ()
+
+assertDetermineBaseDir :: FilePath -> FilePath -> IO ()
+assertDetermineBaseDir expectedBaseDir subDir = do
+  initialPwd <- pwd
+  bd1 <- determineBaseDir $ Just subDir
+  cd subDir
+  bd2 <- determineBaseDir Nothing
+  bd3 <- determineBaseDir $ Just "."
+  cd initialPwd
+  let msg = format ("determineBaseDir searches from pwd upwards until it finds a dir containing 'import' - "%fp) subDir
+  _ <- sequence $ map (assertEqual (T.unpack msg) expectedBaseDir) [bd1, bd2, bd3]
+  return ()
+
 testDetermineBaseDir :: Test
 testDetermineBaseDir = TestCase (
   sh (
@@ -63,51 +81,29 @@ testDetermineBaseDir = TestCase (
         bdUnrelated <- liftIO $ determineBaseDir'' unrelatedDir unrelatedDir
         liftIO $ assertEqual "determineBaseDir produces an error message when it cannot find a baseDir" (Left $ errorMessageBaseDir unrelatedDir) bdUnrelated
 
-        currentDir <- pwd
-        let baseDir = forceTrailingSlash $ collapse $ currentDir </> tmpdir </> "bd1"
-
+        let baseDir = "bd1"
         let importDir = baseDir </> "import"
         let ownerDir = importDir </> "john"
         let bankDir = ownerDir </> "mybank"
         let accDir = bankDir </> "myacc"
         let inDir = accDir </> "1-in"
         let yearDir = inDir </> "2019"
-        mktree yearDir
-
-        let reportDir = baseDir </> "report"
-        mkdir reportDir
+        let subDirs = [yearDir, inDir, accDir, bankDir, ownerDir, importDir, baseDir]
 
-        cd baseDir
-        bd <- liftIO $ determineBaseDir Nothing
-        liftIO $ assertEqual "determineBaseDir searches from pwd upwards until it finds a dir containing 'import' - in the base dir" baseDir bd
+        mktree $ tmpdir </> yearDir
 
-        cd reportDir
-        bdReport <- liftIO $ determineBaseDir Nothing
-        liftIO $ assertEqual "determineBaseDir searches from pwd upwards until it finds a dir containing 'import' - report dir" baseDir bdReport
+        let subDirsRelativeToTop = map (tmpdir </>) subDirs
 
-        cd yearDir
-        bdYear <- liftIO $ determineBaseDir Nothing
-        liftIO $ assertEqual "determineBaseDir searches from pwd upwards until it finds a dir containing 'import' - year dir" baseDir bdYear
-
-        cd inDir
-        bdIn <- liftIO $ determineBaseDir Nothing
-        liftIO $ assertEqual "determineBaseDir searches from pwd upwards until it finds a dir containing 'import' - input dir" baseDir bdIn
-
-        cd accDir
-        bdAcc <- liftIO $ determineBaseDir Nothing
-        liftIO $ assertEqual "determineBaseDir searches from pwd upwards until it finds a dir containing 'import' - account dir" baseDir bdAcc
-
-        cd bankDir
-        bdBank <- liftIO $ determineBaseDir Nothing
-        liftIO $ assertEqual "determineBaseDir searches from pwd upwards until it finds a dir containing 'import' - bank dir" baseDir bdBank
+        currentDir <- pwd
+        let absoluteTempDir = forceTrailingSlash $ collapse $ currentDir </> tmpdir
+        let absoluteSubDirs = map (absoluteTempDir </>) subDirs
 
-        cd ownerDir
-        bdOwner <- liftIO $ determineBaseDir Nothing
-        liftIO $ assertEqual "determineBaseDir searches from pwd upwards until it finds a dir containing 'import' - owner dir" baseDir bdOwner
+        let absoluteBaseDir = forceTrailingSlash $ absoluteTempDir </> baseDir
+        liftIO $ assertSubDirsForDetermineBaseDir absoluteBaseDir absoluteSubDirs
+        liftIO $ assertSubDirsForDetermineBaseDir absoluteBaseDir subDirsRelativeToTop
 
-        cd importDir
-        bdImport <- liftIO $ determineBaseDir Nothing
-        liftIO $ assertEqual "determineBaseDir searches from pwd upwards until it finds a dir containing 'import' - import dir" baseDir bdImport
+        cd absoluteTempDir
+        liftIO $ assertSubDirsForDetermineBaseDir absoluteBaseDir subDirs
      )
   )