codex 0.0.1.6 → 0.0.1.7

raw patch · 5 files changed

+289/−59 lines, 5 filesPVP: minor bump suggested

API additions: PVP suggests at least a minor version bump

API changes (from Hackage documentation)

Files

• LICENSE +202/−0
• UNLICENSE +0/−24
• codex.cabal +5/−4
• src/Codex/Project.hs +55/−0
• src/Main.hs +27/−31

@@ -0,0 +1,202 @@++                                 Apache License+                           Version 2.0, January 2004+                        http://www.apache.org/licenses/++   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++   1. Definitions.++      "License" shall mean the terms and conditions for use, reproduction,+      and distribution as defined by Sections 1 through 9 of this document.++      "Licensor" shall mean the copyright owner or entity authorized by+      the copyright owner that is granting the License.++      "Legal Entity" shall mean the union of the acting entity and all+      other entities that control, are controlled by, or are under common+      control with that entity. For the purposes of this definition,+      "control" means (i) the power, direct or indirect, to cause the+      direction or management of such entity, whether by contract or+      otherwise, or (ii) ownership of fifty percent (50%) or more of the+      outstanding shares, or (iii) beneficial ownership of such entity.++      "You" (or "Your") shall mean an individual or Legal Entity+      exercising permissions granted by this License.++      "Source" form shall mean the preferred form for making modifications,+      including but not limited to software source code, documentation+      source, and configuration files.++      "Object" form shall mean any form resulting from mechanical+      transformation or translation of a Source form, including but+      not limited to compiled object code, generated documentation,+      and conversions to other media types.++      "Work" shall mean the work of authorship, whether in Source or+      Object form, made available under the License, as indicated by a+      copyright notice that is included in or attached to the work+      (an example is provided in the Appendix below).++      "Derivative Works" shall mean any work, whether in Source or Object+      form, that is based on (or derived from) the Work and for which the+      editorial revisions, annotations, elaborations, or other modifications+      represent, as a whole, an original work of authorship. For the purposes+      of this License, Derivative Works shall not include works that remain+      separable from, or merely link (or bind by name) to the interfaces of,+      the Work and Derivative Works thereof.++      "Contribution" shall mean any work of authorship, including+      the original version of the Work and any modifications or additions+      to that Work or Derivative Works thereof, that is intentionally+      submitted to Licensor for inclusion in the Work by the copyright owner+      or by an individual or Legal Entity authorized to submit on behalf of+      the copyright owner. For the purposes of this definition, "submitted"+      means any form of electronic, verbal, or written communication sent+      to the Licensor or its representatives, including but not limited to+      communication on electronic mailing lists, source code control systems,+      and issue tracking systems that are managed by, or on behalf of, the+      Licensor for the purpose of discussing and improving the Work, but+      excluding communication that is conspicuously marked or otherwise+      designated in writing by the copyright owner as "Not a Contribution."++      "Contributor" shall mean Licensor and any individual or Legal Entity+      on behalf of whom a Contribution has been received by Licensor and+      subsequently incorporated within the Work.++   2. Grant of Copyright License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      copyright license to reproduce, prepare Derivative Works of,+      publicly display, publicly perform, sublicense, and distribute the+      Work and such Derivative Works in Source or Object form.++   3. Grant of Patent License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      (except as stated in this section) patent license to make, have made,+      use, offer to sell, sell, import, and otherwise transfer the Work,+      where such license applies only to those patent claims licensable+      by such Contributor that are necessarily infringed by their+      Contribution(s) alone or by combination of their Contribution(s)+      with the Work to which such Contribution(s) was submitted. If You+      institute patent litigation against any entity (including a+      cross-claim or counterclaim in a lawsuit) alleging that the Work+      or a Contribution incorporated within the Work constitutes direct+      or contributory patent infringement, then any patent licenses+      granted to You under this License for that Work shall terminate+      as of the date such litigation is filed.++   4. Redistribution. You may reproduce and distribute copies of the+      Work or Derivative Works thereof in any medium, with or without+      modifications, and in Source or Object form, provided that You+      meet the following conditions:++      (a) You must give any other recipients of the Work or+          Derivative Works a copy of this License; and++      (b) You must cause any modified files to carry prominent notices+          stating that You changed the files; and++      (c) You must retain, in the Source form of any Derivative Works+          that You distribute, all copyright, patent, trademark, and+          attribution notices from the Source form of the Work,+          excluding those notices that do not pertain to any part of+          the Derivative Works; and++      (d) If the Work includes a "NOTICE" text file as part of its+          distribution, then any Derivative Works that You distribute must+          include a readable copy of the attribution notices contained+          within such NOTICE file, excluding those notices that do not+          pertain to any part of the Derivative Works, in at least one+          of the following places: within a NOTICE text file distributed+          as part of the Derivative Works; within the Source form or+          documentation, if provided along with the Derivative Works; or,+          within a display generated by the Derivative Works, if and+          wherever such third-party notices normally appear. The contents+          of the NOTICE file are for informational purposes only and+          do not modify the License. You may add Your own attribution+          notices within Derivative Works that You distribute, alongside+          or as an addendum to the NOTICE text from the Work, provided+          that such additional attribution notices cannot be construed+          as modifying the License.++      You may add Your own copyright statement to Your modifications and+      may provide additional or different license terms and conditions+      for use, reproduction, or distribution of Your modifications, or+      for any such Derivative Works as a whole, provided Your use,+      reproduction, and distribution of the Work otherwise complies with+      the conditions stated in this License.++   5. Submission of Contributions. Unless You explicitly state otherwise,+      any Contribution intentionally submitted for inclusion in the Work+      by You to the Licensor shall be under the terms and conditions of+      this License, without any additional terms or conditions.+      Notwithstanding the above, nothing herein shall supersede or modify+      the terms of any separate license agreement you may have executed+      with Licensor regarding such Contributions.++   6. Trademarks. This License does not grant permission to use the trade+      names, trademarks, service marks, or product names of the Licensor,+      except as required for reasonable and customary use in describing the+      origin of the Work and reproducing the content of the NOTICE file.++   7. Disclaimer of Warranty. Unless required by applicable law or+      agreed to in writing, Licensor provides the Work (and each+      Contributor provides its Contributions) on an "AS IS" BASIS,+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+      implied, including, without limitation, any warranties or conditions+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+      PARTICULAR PURPOSE. You are solely responsible for determining the+      appropriateness of using or redistributing the Work and assume any+      risks associated with Your exercise of permissions under this License.++   8. Limitation of Liability. In no event and under no legal theory,+      whether in tort (including negligence), contract, or otherwise,+      unless required by applicable law (such as deliberate and grossly+      negligent acts) or agreed to in writing, shall any Contributor be+      liable to You for damages, including any direct, indirect, special,+      incidental, or consequential damages of any character arising as a+      result of this License or out of the use or inability to use the+      Work (including but not limited to damages for loss of goodwill,+      work stoppage, computer failure or malfunction, or any and all+      other commercial damages or losses), even if such Contributor+      has been advised of the possibility of such damages.++   9. Accepting Warranty or Additional Liability. While redistributing+      the Work or Derivative Works thereof, You may choose to offer,+      and charge a fee for, acceptance of support, warranty, indemnity,+      or other liability obligations and/or rights consistent with this+      License. However, in accepting such obligations, You may act only+      on Your own behalf and on Your sole responsibility, not on behalf+      of any other Contributor, and only if You agree to indemnify,+      defend, and hold each Contributor harmless for any liability+      incurred by, or claims asserted against, such Contributor by reason+      of your accepting any such warranty or additional liability.++   END OF TERMS AND CONDITIONS++   APPENDIX: How to apply the Apache License to your work.++      To apply the Apache License to your work, attach the following+      boilerplate notice, with the fields enclosed by brackets "[]"+      replaced with your own identifying information. (Don't include+      the brackets!)  The text should be enclosed in the appropriate+      comment syntax for the file format. We also recommend that a+      file or class name and description of purpose be included on the+      same "printed page" as the copyright notice for easier+      identification within third-party archives.++   Copyright [yyyy] [name of copyright owner]++   Licensed under the Apache License, Version 2.0 (the "License");+   you may not use this file except in compliance with the License.+   You may obtain a copy of the License at++       http://www.apache.org/licenses/LICENSE-2.0++   Unless required by applicable law or agreed to in writing, software+   distributed under the License is distributed on an "AS IS" BASIS,+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+   See the License for the specific language governing permissions and+   limitations under the License.

@@ -1,24 +0,0 @@-This is free and unencumbered software released into the public domain.--Anyone is free to copy, modify, publish, use, compile, sell, or-distribute this software, either in source code form or as a compiled-binary, for any purpose, commercial or non-commercial, and by any-means.--In jurisdictions that recognize copyright laws, the author or authors-of this software dedicate any and all copyright interest in the-software to the public domain. We make this dedication for the benefit-of the public at large and to the detriment of our heirs and-successors. We intend this dedication to be an overt act of-relinquishment in perpetuity of all present and future rights to this-software under copyright law.--THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.-IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR-OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR-OTHER DEALINGS IN THE SOFTWARE.--For more information, please refer to <http://unlicense.org/>

@@ -1,9 +1,9 @@ name:                codex-version:             0.0.1.6+version:             0.0.1.7 synopsis:            A ctags file generator for cabal project dependencies. description:            This tool download and cache the source code of packages in your local hackage,-  he can then use this cache to generate `tags` files aggregating the sources of all the dependencies of your cabal projects.+  it can then use this cache to generate `tags` files aggregating the sources of all the dependencies of your cabal projects.   .    You basically do `codex update` in your cabal project directory and you'll get a `codex.tags` file   that you can use in your favorite text editor.@@ -11,8 +11,8 @@   Usage overview can be found in the <http://github.com/aloiscochard/codex#codex README>.  homepage:            http://github.com/aloiscochard/codex-license:             OtherLicense-license-file:        UNLICENSE+license:             Apache-2.0+license-file:        LICENSE author:              Alois Cochard maintainer:          alois.cochard@gmail.com category:            Development@@ -25,6 +25,7 @@   ghc-options:       -fwarn-incomplete-patterns   exposed-modules:     Codex+    Codex.Project     Codex.Internal     Distribution.Hackage.Utils   build-depends:       

@@ -0,0 +1,55 @@+module Codex.Project where++import Control.Exception (try, SomeException)+import Data.Functor+import Data.Maybe+import Data.String.Utils+import Data.Traversable (traverse)+import Distribution.InstalledPackageInfo+import Distribution.Hackage.DB (readHackage)+import Distribution.Hackage.Utils+import Distribution.PackageDescription+import Distribution.PackageDescription.Parse+import Distribution.Simple.Configure+import Distribution.Simple.LocalBuildInfo+import Distribution.Simple.PackageIndex+import Distribution.Package+import Distribution.Verbosity+import System.Directory+import System.FilePath++import qualified Data.List as List++import Codex.Internal++findPackageDescription :: FilePath -> IO (Maybe GenericPackageDescription)+findPackageDescription root = do+  files <- getDirectoryContents root+  traverse (readPackageDescription silent) $ List.find (endswith ".cabal") files++resolveCurrentProjectDependencies :: IO (PackageIdentifier, [PackageIdentifier])+resolveCurrentProjectDependencies = resolveProjectDependencies "."++resolveProjectDependencies :: FilePath -> IO (PackageIdentifier, [PackageIdentifier])+resolveProjectDependencies root = do+  pd <- maybe (error "No cabal file found.") id <$> findPackageDescription root+  xs <- either (fallback pd) return =<< resolveProjectInstalledDependencies root+  return (identifier pd, xs) where+    fallback pd e = do+      putStrLn $ concat ["cabal: ", show e]+      putStrLn "codex: *warning* falling back on dependency resolution using hackage"+      resolveWithHackage pd+    resolveWithHackage pd = do+      db <- readHackage+      return $ identifier <$> resolveDependencies db pd++resolveProjectInstalledDependencies :: FilePath -> IO (Either SomeException [PackageIdentifier])+resolveProjectInstalledDependencies root = try $ do+  lbi <- getPersistBuildConfig distPref+  let pkg   = localPkgDescr lbi+      ipkgs = installedPkgs lbi+      clbis = snd <$> allComponentsInBuildOrder lbi+      pkgs  = componentPackageDeps =<< clbis+      xs = fmap sourcePackageId $ (maybeToList . lookupInstalledPackageId ipkgs) =<< fmap fst pkgs+  return xs where+    distPref = joinPath [root, "dist"]

@@ -5,26 +5,24 @@ import Control.Monad import Control.Monad.Trans.Either hiding (left, right) import Data.Either-import Data.Traversable (traverse)+import Data.Functor import Data.String.Utils+import Data.Traversable (traverse) import Data.Yaml-import Distribution.Hackage.DB (readHackage)-import Distribution.PackageDescription-import Distribution.PackageDescription.Parse+import Distribution.Hackage.Utils (getHackagePath) import Distribution.Text-import Distribution.Verbosity import GHC.Generics+import Paths_codex (version) import System.Directory import System.Environment import System.FilePath import System.Exit -import qualified Data.List as List--import Distribution.Hackage.Utils- import Codex+import Codex.Project (resolveCurrentProjectDependencies) +-- TODO Implement workspace resolution mechanism+-- TODO Add 'cache dump' to dump all tags in stdout (usecase: pipe to grep) -- TODO Use a mergesort algorithm for `assembly` -- TODO Better error handling and fine grained retry @@ -35,11 +33,6 @@     Left ls -> fmap (left (++ ls)) x     Right r -> return $ Right r -getCurrentProject :: IO (Maybe GenericPackageDescription)-getCurrentProject = do-  files <- getDirectoryContents $ joinPath ["."]-  traverse (readPackageDescription silent) $ List.find (endswith ".cabal") files- tagsFile :: FilePath tagsFile = joinPath ["codex.tags"] @@ -56,31 +49,33 @@       return . fmap (fp </>) $ filter (not . startswith ".") xs  update :: Codex -> Bool -> IO ()-update cx force = getCurrentProject >>= resolve where-  resolve Nothing = putStrLn "No cabal file found."-  resolve (Just project) = do-    dependencies <- fmap (\db -> resolveDependencies db project) readHackage-    shouldUpdate <- runEitherT . isUpdateRequired tagsFile $ fmap identifier dependencies-    when (either (const True) id shouldUpdate || force) $ do+update cx force = do+    (project, dependencies) <- resolveCurrentProjectDependencies+    shouldUpdate <- either (const True) id <$> (runEitherT $ isUpdateRequired tagsFile dependencies)+    if (shouldUpdate || force) then do       fileExist <- doesFileExist tagsFile       when fileExist $ removeFile tagsFile -      putStrLn $ concat ["Updating ", display . identifier $ project]-      results <- traverse (retrying 3 . runEitherT . getTags . identifier) dependencies +      putStrLn $ concat ["Updating ", display project]+      results <- traverse (retrying 3 . runEitherT . getTags) dependencies        traverse (putStrLn . show) . concat $ lefts results-      generate dependencies where-        getTags i = status cx i >>= \x -> case x of-          (Source Tagged)   -> return ()-          (Source Untagged) -> tags cx i >>= (const $ getTags i)-          (Archive)         -> extract cx i >>= (const $ getTags i)-          (Remote)          -> fetch cx i >>= (const $ getTags i)-        generate xs = do -          res <- runEitherT $ assembly cx (fmap identifier xs) tagsFile-          either (putStrLn . show) (const $ return ()) res+      generate dependencies +    else +      putStrLn "Nothing to update."+    where+      getTags i = status cx i >>= \x -> case x of+        (Source Tagged)   -> return ()+        (Source Untagged) -> tags cx i >>= (const $ getTags i)+        (Archive)         -> extract cx i >>= (const $ getTags i)+        (Remote)          -> fetch cx i >>= (const $ getTags i)+      generate xs = do +        res <- runEitherT $ assembly cx xs tagsFile+        either (putStrLn . show) (const $ return ()) res  help :: IO () help = putStrLn $   unlines [ "Usage: codex [update] [cache clean] [set tagger [hasktags|ctags]]"           , "             [--help]"+          , "             [--version]"           , ""           , " update                Synchronize the `codex.tags` file in the current cabal project directory"           , " update --force        Discard `codex.tags` file hash and force regeneration"@@ -99,6 +94,7 @@     run cx ["update", "--force"]  = update cx True     run cx ["set", "tagger", "ctags"]     = encodeConfig $ cx { tagsCmd = taggerCmd Ctags }     run cx ["set", "tagger", "hasktags"]  = encodeConfig $ cx { tagsCmd = taggerCmd Hasktags }+    run cx ["--version"] = putStrLn $ concat ["codex: ", display version]     run cx ["--help"] = help     run cx []         = help     run cx (x:_)      = do