Improve behaviour of addPackage for hpack

Now addPackage will either add the package to all components
the module is part of or only to the main "dependencies" object.

Author: fendor

src/Haskell/Ide/Engine/Plugin/Package.hs

@@ -136,6 +136,7 @@ findPackageType rootDir = do
   return $ fromMaybe NoPackage $ asum [HpackPackage <$> mHpack, CabalPackage <$> mCabal]
 
 -- | Edit a hpack package to add the given package to the package.yaml.
+-- If package.yaml is not in an expected format, will fail fatally.
 --
 -- Currently does not preserve format.
 -- Keep an eye out on this other GSOC project!
@@ -155,19 +156,29 @@ editHpackPackage fp modulePath pkgName = do
 
   case Y.decodeThrow contents :: Maybe Object of
     Just obj -> do
+        -- Map over all major components, such as "executable", "executables",
+        -- "tests" and "benchmarks". Note, that "library" is a major component,
+        -- but its structure is different and can not be mapped over in the same way.
+        --
+        -- Only adds the package if the declared "source-dirs" field is part of the
+        -- module path, or if no "source-dirs" is declared.
         let compsMapped = mapComponentTypes (ensureObject $ mapComponents (ensureObject $ mapCompDependencies addDep)) obj
 
-        let addDepToMainLib = fromMaybe True $ do
-              Object lib <- HM.lookup "library" compsMapped
-              sourceDirs <- HM.lookup "source-dirs" lib
-              return $ isInSourceDir sourceDirs
+        -- Is there a global "dependencies" yaml object?
+        let addDepToMainDep = fromMaybe False $ do
+              Array _ <- HM.lookup "dependencies" compsMapped
+              return True
 
-        let newPkg = if addDepToMainLib
-            then mapMainDependencies addDep compsMapped
-            else compsMapped
+        -- Either add the package to only the top-level "dependencies",
+        -- or to all main components of which the given module is part of.
+        let newPkg
+              | addDepToMainDep = mapMainDependencies addDep obj
+              -- Map over the library component at last, since it has different structure.
+              | otherwise = mapLibraryDependency addDep compsMapped
 
-            newPkgText = T.decodeUtf8 $ Y.encode newPkg
+        let newPkgText = T.decodeUtf8 $ Y.encode newPkg
 
+        -- Construct the WorkSpaceEdit
         let numOldLines = length $ T.lines $ T.decodeUtf8 contents
             range = J.Range (J.Position 0 0) (J.Position numOldLines 0)
             textEdit = J.TextEdit range newPkgText
@@ -187,8 +198,14 @@ editHpackPackage fp modulePath pkgName = do
     mapMainDependencies :: (Value -> Value) -> Object -> Object
     mapMainDependencies f o =
       let g :: T.Text -> Value -> Value
-          g "dependencies" x = f x
-          g "library" (Y.Object o') = Y.Object (mapMainDependencies f o')
+          g "dependencies" = f
+          g _              = id
+      in HM.mapWithKey g o
+
+    mapLibraryDependency :: (Value -> Value) -> Object -> Object
+    mapLibraryDependency f o =
+      let g :: T.Text -> Value -> Value
+          g "library" (Y.Object o') = Y.Object (mapCompDependencies f o')
           g _ x = x
       in HM.mapWithKey g o
 

test/functional/FunctionalCodeActionsSpec.hs

@@ -258,10 +258,8 @@ spec = describe "code actions" $ do
         executeCodeAction action
 
         contents <- getDocumentEdit . TextDocumentIdentifier =<< getDocUri "package.yaml"
-        liftIO $ do
-          T.lines contents !! 23 `shouldSatisfy` T.isSuffixOf "zlib"
-          T.lines contents !! 5 `shouldNotSatisfy` T.isSuffixOf "zlib"
-          T.lines contents !! 6 `shouldNotSatisfy` T.isSuffixOf "zlib"
+        liftIO $ 
+          T.lines contents !! 22 `shouldSatisfy` T.isSuffixOf "zlib"
 
   -- -----------------------------------
 

test/testdata/addPackageTest/hybrid-exe/package.yaml

@@ -19,9 +19,6 @@ extra-source-files:
 # common to point users to the README.md file.
 description:         Please see the README on GitHub at <https://github.com/githubuser/asdf#readme>
 
-dependencies:
-- base >= 4.7 && < 5
-
 library:
   source-dirs: src
 

test/unit/PackagePluginSpec.hs

@@ -153,7 +153,6 @@ packageSpec = do
                   , "    - -rtsopts\n"
                   , "    - -with-rtsopts=-N\n"
                   , "    dependencies:\n"
-                  , "    - zlib\n"
                   , "    - asdf\n"
                   , "description: Please see the README on GitHub at <https://github.com/githubuser/asdf#readme>\n"
                   ]
@@ -203,13 +202,11 @@ packageSpec = do
             res  = IdeResultOk
               $ WorkspaceEdit (Just $ H.singleton uri textEdits) Nothing
             textEdits = List
-              [ TextEdit (Range (Position 0 0) (Position 37 0)) $ T.concat
+              [ TextEdit (Range (Position 0 0) (Position 34 0)) $ T.concat
                   [ "library:\n"
                   , "  source-dirs: src\n"
                   , "copyright: 2018 Author name here\n"
                   , "maintainer: [email protected]\n"
-                  , "dependencies:\n"
-                  , "- base >= 4.7 && < 5\n"
                   , "name: asdf\n"
                   , "version: 0.1.0.0\n"
                   , "extra-source-files:\n"