ogma-extra-1.10.0/0000755000000000000000000000000015064246127012032 5ustar0000000000000000ogma-extra-1.10.0/LICENSE0000644000000000000000000002613715064246127013050 0ustar0000000000000000 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 https://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. ogma-extra-1.10.0/CHANGELOG.md0000644000000000000000000000372115064246127013646 0ustar0000000000000000# Revision history for ogma-extra ## [1.10.0] - 2025-09-21 * Version bump 1.10.0 (#310). * Replace NOSA license with Apache license (#293). ## [1.9.0] - 2025-08-06 * Version bump 1.9.0 (#284). * Remove deprecated functions from System.Directory.Extra (#278). ## [1.8.0] - 2025-07-13 * Version bump 1.8.0 (#275). ## [1.7.0] - 2025-03-21 * Version bump 1.7.0 (#269). * Bump upper version constraint on Cabal (#213). * Bump upper version constraint on aeson, text (#225). * Remove extraneous EOL character (#224). * Add auxiliary functions to manipulate strings, lists (#256). ## [1.6.0] - 2025-01-21 * Version bump 1.6.0 (#208). * Deprecate unnecessary functions (#185). * Add repository information to cabal package (#148). * Add version bounds to all dependencies (#119). ## [1.5.0] - 2024-11-21 * Version bump 1.5.0 (#178). * Introduce template expansion functionality (#162). ## [1.4.1] - 2024-09-21 * Version bump 1.4.1 (#155). * Replace homepage (#147). ## [1.4.0] - 2024-05-21 * Version bump 1.4.0 (#145). ## [1.3.0] - 2024-03-21 * Version bump 1.3.0 (#133). ## [1.2.0] - 2024-01-21 * Version bump 1.2.0 (#117). ## [1.1.0] - 2023-11-21 * Version bump 1.1.0 (#112). ## [1.0.11] - 2023-09-21 * Version bump 1.0.11 (#103). ## [1.0.10] - 2023-07-21 * Version bump 1.0.10 (#98). ## [1.0.9] - 2023-05-21 * Version bump 1.0.9 (#93). ## [1.0.8] - 2023-03-21 * Version bump 1.0.8 (#81). * Mark package as uncurated (#74). ## [1.0.7] - 2023-01-21 * Version bump 1.0.7 (#69). ## [1.0.6] - 2022-11-21 * Version bump 1.0.6 (#64). * Update license in cabal file to OtherLicense (#62). ## [1.0.5] - 2022-09-21 * Version bump 1.0.5 (#60). ## [1.0.4] - 2022-07-21 * Version bump 1.0.4 (#53). ## [1.0.3] - 2022-05-21 * Version bump 1.0.3 (#49). ## [1.0.2] - 2022-03-21 * Version bump 1.0.2 (#43). ## [1.0.1] - 2022-01-21 * Version bump 1.0.1 (#39). * Adjust indentation of ogma-extra:Data.ByteString.Extra.safeReadFile (#38). ## [1.0.0] - 2021-11-22 * Initial release. ogma-extra-1.10.0/Setup.hs0000644000000000000000000000005615064246127013467 0ustar0000000000000000import Distribution.Simple main = defaultMain ogma-extra-1.10.0/ogma-extra.cabal0000644000000000000000000000614015064246127015063 0ustar0000000000000000-- Copyright 2020 United States Government as represented by the Administrator -- of the National Aeronautics and Space Administration. All Rights Reserved. -- -- Disclaimers -- -- 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 -- -- https://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. cabal-version: 2.0 build-type: Simple name: ogma-extra version: 1.10.0 homepage: https://github.com/nasa/ogma bug-reports: https://github.com/nasa/ogma/issues license: Apache-2.0 license-file: LICENSE author: Ivan Perez, Alwyn Goodloe maintainer: ivan.perezdominguez@nasa.gov category: Aerospace extra-source-files: CHANGELOG.md synopsis: Ogma: Helper tool to interoperate between Copilot and other languages. description: Ogma is a tool to facilitate the integration of safe runtime monitors into other systems. Ogma extends , a high-level runtime verification framework that generates hard real-time C99 code. . This package implements internal extensions to existing libraries and modules that are used in several ogma packages and their testing facilities. -- Ogma packages should be uncurated so that only the official maintainers make -- changes. -- -- Because this is a NASA project, we want to make sure that users obtain -- exactly what we publish, unmodified by anyone external to our project. x-curation: uncurated source-repository head type: git location: git@github.com:nasa/ogma.git subdir: ogma-extra library exposed-modules: Data.ByteString.Extra Data.List.Extra Data.String.Extra System.Directory.Extra build-depends: base >= 4.11.0.0 && < 5 , aeson >= 2.0.0.0 && < 2.3 , bytestring >= 0.10.8.2 && < 0.13 , Cabal >= 2.2.0.0 && < 3.15 , directory >= 1.3.1.5 && < 1.4 , filepath >= 1.4.2 && < 1.6 , microstache >= 1.0 && < 1.1 , text >= 1.2.3.1 && < 2.2 hs-source-dirs: src default-language: Haskell2010 ghc-options: -Wall test-suite unit-tests type: exitcode-stdio-1.0 main-is: Main.hs build-depends: base >= 4.11.0.0 && < 5 , QuickCheck >= 2.8.2 && < 2.16 , test-framework >= 0.8.2 && < 0.9 , test-framework-quickcheck2 >= 0.3.0.4 && < 0.4 , ogma-extra hs-source-dirs: tests default-language: Haskell2010 ghc-options: -Wall ogma-extra-1.10.0/tests/0000755000000000000000000000000015064246127013174 5ustar0000000000000000ogma-extra-1.10.0/tests/Main.hs0000644000000000000000000000753215064246127014423 0ustar0000000000000000-- Copyright 2020 United States Government as represented by the Administrator -- of the National Aeronautics and Space Administration. All Rights Reserved. -- -- Disclaimers -- -- 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 -- -- https://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. -- -- | Test ogma-extra internals. module Main where -- External imports import Data.Either ( isLeft, isRight ) import Test.Framework ( Test, defaultMainWithOpts ) import Test.Framework.Providers.QuickCheck2 ( testProperty ) import Test.QuickCheck ( Property, (==>), Fun (Fun) ) -- Internal imports import Data.List.Extra ( headEither, toHead, toTail ) -- | Run all unit tests on Ogma's core. main :: IO () main = defaultMainWithOpts tests mempty -- | All unit tests for Ogma's core. tests :: [Test.Framework.Test] tests = [ testProperty "Data.List.Extra.toHead (diag commutativity)" propToHead , testProperty "Data.List.Extra.toHead (identity)" propToHeadId , testProperty "Data.List.Extra.toHead (composition)" propToHeadCmp , testProperty "Data.List.Extra.toHead (length)" propToHeadSameLength , testProperty "Data.List.Extra.toTail (diag commutativity)" propToTail , testProperty "Data.List.Extra.toTail (identity)" propToTailId , testProperty "Data.List.Extra.toTail (composition)" propToTailCmp , testProperty "Data.List.Extra.toTail (length)" propToTailSameLength , testProperty "Data.List.Extra.headEither (Right case)" propHeadEitherRight , testProperty "Data.List.Extra.headEither (Left case)" propHeadEitherLeft ] -- * Data.List.Extra -- | Test that 'toHead' applies a transformation to the head of a list. propToHead :: [Int] -> Fun Int Int -> Property propToHead xs (Fun _ f) = not (null xs) ==> f (head xs) == head (toHead f xs) -- | Test that 'toHead' preserves the identity. propToHeadId :: [Int] -> Bool propToHeadId xs = toHead id xs == xs -- | Test that 'toHead' preserves function composition. propToHeadCmp :: [Int] -> Fun Int Int -> Fun Int Int -> Bool propToHeadCmp xs (Fun _ f) (Fun _ g) = toHead (f . g) xs == toHead f (toHead g xs) -- | Test that 'toHead' does not alter the length of the list. propToHeadSameLength :: [Int] -> Fun Int Int -> Bool propToHeadSameLength xs (Fun _ f) = length xs == length (toHead f xs) -- | Test that 'toTail' applies a transformation to the tail of a list. propToTail :: [Int] -> Fun Int Int -> Property propToTail xs (Fun _ f) = not (null xs) ==> fmap f (tail xs) == tail (toTail f xs) -- | Test that 'toTail' preserves the identity. propToTailId :: [Int] -> Bool propToTailId xs = toTail id xs == xs -- | Test that 'toHead' preserves function composition. propToTailCmp :: [Int] -> Fun Int Int -> Fun Int Int -> Bool propToTailCmp xs (Fun _ f) (Fun _ g) = toTail (f . g) xs == toTail f (toTail g xs) -- | Test that 'toTail' does not alter the length of the list. propToTailSameLength :: [Int] -> Fun Int Int -> Bool propToTailSameLength xs (Fun _ f) = length xs == length (toTail f xs) -- | Test that 'headEither' returns a 'Right' value if applied to a non-empty -- list. propHeadEitherRight :: [Int] -> Property propHeadEitherRight xs = not (null xs) ==> isRight (headEither xs) -- | Test that 'headEither' returns a 'Left' value if applied to an empty list. propHeadEitherLeft :: [Int] -> Property propHeadEitherLeft xs = null xs ==> isLeft (headEither xs) ogma-extra-1.10.0/src/0000755000000000000000000000000015064246127012621 5ustar0000000000000000ogma-extra-1.10.0/src/Data/0000755000000000000000000000000015064246127013472 5ustar0000000000000000ogma-extra-1.10.0/src/Data/String/0000755000000000000000000000000015064246127014740 5ustar0000000000000000ogma-extra-1.10.0/src/Data/String/Extra.hs0000644000000000000000000000642215064246127016363 0ustar0000000000000000-- Copyright 2020 United States Government as represented by the Administrator -- of the National Aeronautics and Space Administration. All Rights Reserved. -- -- Disclaimers -- -- 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 -- -- https://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. -- -- | Auxiliary functions for working with values of type 'String'. module Data.String.Extra ( -- * Safe I/O safeReadFile -- * String transformation , pascalCase -- * String sanitization , sanitizeLCIdentifier , sanitizeUCIdentifier ) where -- External imports import Control.Exception ( catch ) import Data.Char ( toLower, toUpper ) import System.IO.Error ( isDoesNotExistError ) -- * Safe I/O -- | Safely read a file into a 'String', returning a 'Left' error message if -- the file cannot be opened. -- This function could also be placed in System.IO. However, we decide to -- include it in this module for symmetry with an analogous function for -- ByteString, included in Data.ByteString.Extra. safeReadFile :: FilePath -> IO (Either String String) safeReadFile fp = catch (return <$> readFile fp) $ \e -> if isDoesNotExistError e then return $ Left $ strStringFileNotFound fp else return $ Left $ strStringCannotOpenFile fp -- ** Error messages -- | File-not-found message. strStringFileNotFound :: FilePath -> String strStringFileNotFound fp = "File not found: " ++ fp -- | Cannot-open-file message. strStringCannotOpenFile :: FilePath -> String strStringCannotOpenFile fp = "Error opening file: " ++ fp -- * Transformation -- | Convert a string with underscores to PascalCase. pascalCase :: String -> String pascalCase = concatMap capitalize . parts where capitalize (x:xs) = toUpper x : map toLower xs capitalize [] = [] parts :: String -> [String] parts "" = [] parts s = let (l, r) = break (== '_') s in l : case r of [] -> [] (_:rs) -> parts rs -- * Sanitization -- | Remove extraneous characters from an identifier and make the starting -- character lowercase. -- -- This function currently replaces hyphens with underscores. sanitizeLCIdentifier :: String -> String sanitizeLCIdentifier = headToLower . map sanitizeCharacter where sanitizeCharacter '-' = '_' sanitizeCharacter x = x headToLower :: [Char] -> [Char] headToLower [] = [] headToLower (x:xs) = toLower x : xs -- | Remove extraneous characters from an identifier and make the starting -- character uppercase. -- -- This function currently replaces hyphens with underscores. sanitizeUCIdentifier :: String -> String sanitizeUCIdentifier = headToUpper . map sanitizeCharacter where sanitizeCharacter '-' = '_' sanitizeCharacter x = x headToUpper :: [Char] -> [Char] headToUpper [] = [] headToUpper (x:xs) = toUpper x : xs ogma-extra-1.10.0/src/Data/ByteString/0000755000000000000000000000000015064246127015564 5ustar0000000000000000ogma-extra-1.10.0/src/Data/ByteString/Extra.hs0000644000000000000000000000323515064246127017206 0ustar0000000000000000-- Copyright 2020 United States Government as represented by the Administrator -- of the National Aeronautics and Space Administration. All Rights Reserved. -- -- Disclaimers -- -- 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 -- -- https://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. -- -- | Auxiliary functions for working with values of type 'ByteString'. module Data.ByteString.Extra where import Control.Exception ( catch ) import qualified Data.ByteString.Lazy as B import System.IO.Error ( isDoesNotExistError ) -- * Safe I/O -- | Safely read a file into a lazy 'ByteString', returning a 'Left' error -- message if the file cannot be opened. safeReadFile :: FilePath -> IO (Either String B.ByteString) safeReadFile fp = catch (return <$> B.readFile fp) $ \e -> if isDoesNotExistError e then return $ Left $ strByteStringFileNotFound fp else return $ Left $ strByteStringCannotOpenFile fp -- ** Error messages -- | File-not-found message. strByteStringFileNotFound :: FilePath -> String strByteStringFileNotFound fp = "File not found: " ++ fp -- | Cannot-open-file message. strByteStringCannotOpenFile :: FilePath -> String strByteStringCannotOpenFile fp = "Error opening file " ++ fp ogma-extra-1.10.0/src/Data/List/0000755000000000000000000000000015064246127014405 5ustar0000000000000000ogma-extra-1.10.0/src/Data/List/Extra.hs0000644000000000000000000000300015064246127016015 0ustar0000000000000000-- Copyright 2020 United States Government as represented by the Administrator -- of the National Aeronautics and Space Administration. All Rights Reserved. -- -- Disclaimers -- -- 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 -- -- https://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. -- -- | Auxiliary functions for working with values of type '[]'. module Data.List.Extra where -- External imports import Data.List ( isSuffixOf ) -- | Safely extract the head of a list. headEither :: [a] -> Either String a headEither (a:_) = Right a headEither [] = Left "Empty list" -- | Apply a transformation only to the head of a list. toHead :: (a -> a) -> [a] -> [a] toHead f (x:xs) = f x : xs toHead _ xs = xs -- | Apply a transformation only to the tail of a list. toTail :: (a -> a) -> [a] -> [a] toTail f (x:xs) = x : fmap f xs toTail _ xs = xs -- | Remove a suffix from a string, if present. stripSuffix :: String -> String -> String stripSuffix suffix string | isSuffixOf suffix string = take (length string - length suffix) string | otherwise = string ogma-extra-1.10.0/src/System/0000755000000000000000000000000015064246127014105 5ustar0000000000000000ogma-extra-1.10.0/src/System/Directory/0000755000000000000000000000000015064246127016051 5ustar0000000000000000ogma-extra-1.10.0/src/System/Directory/Extra.hs0000644000000000000000000000661715064246127017502 0ustar0000000000000000{-# LANGUAGE OverloadedStrings #-} -- Copyright 2020 United States Government as represented by the Administrator -- of the National Aeronautics and Space Administration. All Rights Reserved. -- -- Disclaimers -- -- 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 -- -- https://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. -- -- | Auxiliary functions for working with directories. module System.Directory.Extra ( copyTemplate ) where -- External imports import Control.Monad ( filterM, forM_ ) import Data.Aeson ( Value (..) ) import qualified Data.ByteString.Lazy as B import Data.Text.Lazy ( pack, unpack ) import Data.Text.Lazy.Encoding ( encodeUtf8 ) import Distribution.Simple.Utils ( getDirectoryContentsRecursive ) import System.Directory ( createDirectoryIfMissing, doesFileExist ) import System.FilePath ( makeRelative, splitFileName, takeDirectory, () ) import Text.Microstache ( compileMustacheFile, compileMustacheText, renderMustache ) -- | Copy a template directory into a target location, expanding variables -- provided in a map in a JSON value, both in the file contents and in the -- filepaths themselves. copyTemplate :: FilePath -> Value -> FilePath -> IO () copyTemplate templateDir subst targetDir = do -- Get all files (not directories) in the template dir. To keep a directory, -- create an empty file in it (e.g., .keep). tmplContents <- map (templateDir ) . filter (`notElem` ["..", "."]) <$> getDirectoryContentsRecursive templateDir tmplFiles <- filterM doesFileExist tmplContents -- Copy files to new locations, expanding their name and contents as -- mustache templates. forM_ tmplFiles $ \fp -> do -- New file name in target directory, treating file -- name as mustache template. let fullPath = targetDir newFP where -- If file name has mustache markers, expand, otherwise use -- relative file path newFP = either (const relFP) (unpack . (`renderMustache` subst)) fpAsTemplateE -- Local file name within template dir relFP = makeRelative templateDir fp -- Apply mustache substitutions to file name fpAsTemplateE = compileMustacheText "fp" (pack relFP) -- File contents, treated as a mustache template. contents <- encodeUtf8 <$> (`renderMustache` subst) <$> compileMustacheFile fp -- Create target directory if necessary let dirName = fst $ splitFileName fullPath createDirectoryIfMissing True dirName -- Write expanded contents to expanded file path B.writeFile fullPath contents