castle (empty) → 0.1.0.0
raw patch · 5 files changed
+484/−0 lines, 5 filesdep +QuickCheckdep +basedep +configuratorsetup-changed
Dependencies added: QuickCheck, base, configurator, containers, errors, hspec, lens, optparse-applicative, shelly, system-fileio, system-filepath, tasty, tasty-golden, tasty-hspec, tasty-quickcheck, text
Files
- Castle.hs +185/−0
- LICENSE +202/−0
- Setup.hs +2/−0
- castle.cabal +73/−0
- specs/Specs.hs +22/−0
+ Castle.hs view
@@ -0,0 +1,185 @@+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE RecordWildCards #-}+++module Main where+++import Control.Monad+import Data.Maybe+import Data.Monoid+import qualified Data.Text as T+import Data.Tree+import Filesystem+import Filesystem.Path.CurrentOS as FS+import Options.Applicative+import qualified Options.Applicative as O+import Prelude hiding (FilePath)+import Shelly+import qualified Shelly as S+++-- Settings++castleDir :: IO FilePath+castleDir = (FS.</> ".castle") <$> getHomeDirectory++-- Shell utilities++cabal_ :: T.Text -> [T.Text] -> Sh ()+cabal_ = command1_ "cabal" []++sandbox_ :: T.Text -> [T.Text] -> Sh ()+sandbox_ cmd = cabal_ "sandbox" . (cmd:)++-- Workflow and utility functions++installCastle :: Sh ()+installCastle = do+ castle <- liftIO castleDir+ chdir (parent castle) $ do+ mkdirTree $ (filename castle) # leaves ["castles"]+ where (#) = Node+ leaves = map (# [])++getSandboxDir :: T.Text -> Sh FilePath+getSandboxDir name = liftIO $ fmap subdir castleDir+ where subdir base = base FS.</> "castles" FS.</> S.fromText name++withSandbox :: T.Text -> (FilePath -> Sh ()) -> (FilePath -> Sh ()) -> Sh ()+withSandbox name onExists onFail = do+ sandboxDir <- getSandboxDir name+ exists <- test_d sandboxDir+ if exists+ then onExists sandboxDir+ else onFail sandboxDir++withSandbox' :: T.Text -> (FilePath -> Sh ()) -> Sh ()+withSandbox' name onExists = withSandbox name onExists noop+ where noop = const $ return ()++getConfigFile :: Sh FilePath+getConfigFile = (FS.</> "cabal.sandbox.config") <$> pwd++listCastles :: Sh [T.Text]+listCastles = liftIO (fmap (FS.</> "castles") castleDir)+ >>= ls+ >>= fmap (map (toTextIgnore . basename)) . filterM test_d++-- Command function++castle :: CastleCmd -> Sh ()+castle ListCmd = mapM_ echo =<< listCastles++castle NewCmd{..} = withSandbox castleName+ (const $ errorExit $ "Sandbox " <> castleName <> " already exists.")+ (\d -> mkdir_p d >> chdir d+ (sandbox_ "init" ["--sandbox=" <> toTextIgnore d]))++castle UseCmd{..} = withSandbox castleName+ (\d -> pwd >>= cp (d FS.</> "cabal.sandbox.config"))+ (const $ errorExit $ "Sandbox " <> castleName <> " does not exist.\+ \ Create it with 'sandbox new'.")++castle CurrentCmd = do+ configFile <- getConfigFile+ whenM (not <$> test_f configFile) $+ errorExit "No sandbox in this directory."+ config <- T.lines <$> readfile configFile+ maybe (errorExit "No 'prefix:' line in configuration file.")+ (echo . toTextIgnore . FS.basename . FS.fromText . T.drop 10)+ . listToMaybe+ $ filter (T.isPrefixOf " prefix: ") config++castle RemoveCmd = do+ configFile <- getConfigFile+ whenM (not <$> test_f configFile) $+ errorExit "No sandbox in this directory."+ rm configFile++castle DeleteCmd{..} = withSandbox castleName+ rm_rf+ (const $ errorExit $ "Sandbox " <> castleName <> " does not exist.")++castle ClearCmd{..} =+ withSandbox' castleName rm_rf >> castle (NewCmd castleName)++castle SearchCmd{..} =+ mapM_ echo =<< filter (T.isInfixOf searchQuery) <$> listCastles++-- Main++main :: IO ()+main = do+ CastleOpts{..} <- execParser opts++ shelly $ verbosely $ do+ installCastle+ castle mode++ where+ opts' = CastleOpts+ <$> subparser ( O.command "list" listCmd+ <> O.command "new" newCmd+ <> O.command "use" useCmd+ <> O.command "current" currCmd+ <> O.command "remove" rmCmd+ <> O.command "delete" delCmd+ <> O.command "clear" clrCmd+ <> O.command "search" srchCmd+ )++ listCmd = pinfo (pure ListCmd) "List sand castles." mempty+ newCmd = pinfo (NewCmd <$> castleNameArg "The name of the castle to create.")+ "Create a new castle." mempty+ useCmd = pinfo (UseCmd <$> castleNameArg "The name of the castle to use.")+ "Use an existing castle." mempty+ currCmd = pinfo (pure CurrentCmd) "Display the current castle name."+ mempty+ rmCmd = pinfo (pure RemoveCmd) "Removes the sandbox from the current directory."+ mempty+ delCmd = pinfo (DeleteCmd <$> castleNameArg "The name of the castle to delete.")+ "Deletes the castle." mempty+ clrCmd = pinfo (ClearCmd <$> castleNameArg "The name of the castle to clear.")+ "Clears a castle by deleting and re-creating it." mempty+ srchCmd = pinfo (SearchCmd <$> textArg "QUERY" "Search the castles\+ \ for one matching the name.")+ "Searches for a castle with a name containing the QUERY." mempty++ opts = pinfo opts' "Manage shared cabal sandboxes."+ (header "castle - manage shared cabal sandboxes.")++-- Command-line parsing++-- | This is a builder utility for ParserInfo instances.+pinfo :: Parser a -> String -> InfoMod a -> ParserInfo a+pinfo p desc imod = info (helper <*> p) (fullDesc <> progDesc desc <> imod)++textOption :: Mod OptionFields T.Text -> Parser T.Text+textOption fields = nullOption (reader (pure . T.pack) <> fields)++fileOption :: Mod OptionFields FilePath -> Parser FilePath+fileOption fields = nullOption (reader (pure . decodeString) <> fields)++textArg :: String -> String -> Parser T.Text+textArg meta helpText = argument (Just . T.pack) (metavar meta <> help helpText)++castleNameArg :: String -> Parser T.Text+castleNameArg = textArg "CASTLE_NAME"++data CastleOpts+ = CastleOpts+ { mode :: CastleCmd+ } deriving (Show)++data CastleCmd+ = ListCmd+ | NewCmd { castleName :: T.Text }+ | UseCmd { castleName :: T.Text }+ | CurrentCmd+ | RemoveCmd+ | DeleteCmd { castleName :: T.Text }+ | ClearCmd { castleName :: T.Text }+ | SearchCmd { searchQuery :: T.Text }+ deriving (Show)+
+ LICENSE view
@@ -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.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ castle.cabal view
@@ -0,0 +1,73 @@+-- Initial castle.cabal generated by cabal init. For further +-- documentation, see http://haskell.org/cabal/users-guide/++name: castle+version: 0.1.0.0+synopsis: A tool to manage shared cabal-install sandboxes.+description:+ I really like having sandboxes baked into cabal-install.+ .+ However, I got tired of waiting for big packages like Yesod and Lens to+ compile in project after project that used them. However, I still didn't want+ to install them in the user database. I wanted to maintain /some/ sandboxing+ among a group of projects that all share a common set of packages, but I wanted+ to be able to switch from them or upgrade them easily.+ .+ That's the itch I was trying to scratch with `castle`.+ .+ It allows you to share one Cabal sandbox between multiple projects. This keeps+ the package versions for all of these projects in line. It also means that you+ don't have to constantly be re-installing everything, but you still get the+ ability to blow away a set of packages without borking your whole system.++license: Apache-2.0+license-file: LICENSE+author: Eric Rochester+maintainer: erochest@gmail.com+category: Development+stability: alpha+-- copyright: +-- category: +build-type: Simple+-- extra-source-files: +cabal-version: >=1.10+homepage: https://github.com/erochest/castle+bug-reports: https://github.com/erochest/castle/issues++executable castle+ main-is: Castle.hs+ -- other-modules: + -- other-extensions: + build-depends: base >=4.6 && <4.7+ -- , cabal-install >=1.18.0+ , shelly+ , errors+ , system-filepath+ , system-fileio+ , lens+ , configurator+ , optparse-applicative+ , text+ , containers+ -- hs-source-dirs: + default-language: Haskell2010++test-suite castle-specs+ type: exitcode-stdio-1.0+ ghc-options: -threaded -rtsopts+ hs-source-dirs: specs+ main-is: Specs.hs+ build-depends: base == 4.6.*+ , tasty+ , tasty-golden+ , tasty-quickcheck+ , tasty-hspec+ , hspec+ , QuickCheck+ default-language: Haskell2010++source-repository this+ type: git+ location: git://github.com/erochest/castle.git+ tag: 0.1.0.0+ branch: master
+ specs/Specs.hs view
@@ -0,0 +1,22 @@+++module Main where+++import Test.Tasty+-- import Test.Tasty.QuickCheck as QC+-- import Test.Tasty.HUnit as HU+-- import Test.Tasty.Golden as TG+import Test.Tasty.Hspec+++specs :: Spec+specs = undefined++tests :: TestTree+tests = testGroup "main"+ [ testCase "something" specs+ ]++main = defaultMain tests+