call-alloy 0.2.0.4 → 0.2.0.5

raw patch · 9 files changed

+292/−21 lines, 9 filesdep ~lensbinary-addedPVP: minor bump suggested

API additions: PVP suggests at least a minor version bump

Dependency ranges changed: lens

API changes (from Hackage documentation)

Files

• bin/alloy/RunAlloy.class binary
• bin/commons-cli/LICENSE.txt +202/−0
• bin/commons-cli/NOTICE.txt +5/−0
• bin/commons-cli/commons-cli-1.4.jar binary
• call-alloy.cabal +8/−5
• src/Language/Alloy/Call.hs +62/−10
• src/Language/Alloy/Parser.hs +4/−5
• src/Language/Alloy/RessourceNames.hs +4/−0
• src/Language/Alloy/Ressources.hs +7/−1

binary file changed (2438 → 3575 bytes)

@@ -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.+

@@ -0,0 +1,5 @@+Apache Commons CLI+Copyright 2001-2017 The Apache Software Foundation++This product includes software developed at+The Apache Software Foundation (http://www.apache.org/).

binary file changed (absent → 53820 bytes)

@@ -1,13 +1,13 @@ cabal-version: 1.12 --- This file has been generated from package.yaml by hpack version 0.31.2.+-- This file has been generated from package.yaml by hpack version 0.33.0. -- -- see: https://github.com/sol/hpack ----- hash: 0534c64ea3ef38876fc7fc965609f9d06865cdfa4b66fb3c23a3d01805827ce3+-- hash: 2059da2af3e61ace9eabf0447549b945be6baf9f01f87e02a60e6ddb074decb5  name:           call-alloy-version:        0.2.0.4+version:        0.2.0.5 synopsis:       A simple library to call Alloy given a specification description:    Please see the README on GitHub at <https://github.com/marcellussiegburg/call-alloy#readme> category:       Language@@ -25,6 +25,9 @@     ChangeLog.md     bin/alloy/RunAlloy.class     bin/org.alloytools.alloy.dist.jar+    bin/commons-cli/commons-cli-1.4.jar+    bin/commons-cli/NOTICE.txt+    bin/commons-cli/LICENSE.txt  source-repository head   type: git@@ -50,7 +53,7 @@     , file-embed >=0.0.11 && <0.1     , filepath >=1.4 && <1.5     , hashable >=1.2 && <1.4-    , lens >=4.17 && <4.19+    , lens >=4.17 && <4.20     , mtl >=2.2 && <2.3     , process >=1.6 && <1.7     , split >=0.2 && <0.3@@ -90,7 +93,7 @@     , filepath >=1.4 && <1.5     , hashable >=1.2 && <1.4     , hspec-    , lens >=4.17 && <4.19+    , lens >=4.17 && <4.20     , mtl >=2.2 && <2.3     , process >=1.6 && <1.7     , split >=0.2 && <0.3

@@ -14,8 +14,11 @@ {-# LANGUAGE CPP #-} {-# LANGUAGE OverloadedStrings #-} module Language.Alloy.Call (+  CallAlloyConfig (maxInstances, noOverflow),+  defaultCallAlloyConfig,   existsInstance,   getInstances,+  getInstancesWith,   module Functions,   module Types,   ) where@@ -55,17 +58,38 @@  import Language.Alloy.Functions         as Functions import Language.Alloy.Parser            (parseInstance)-import Language.Alloy.RessourceNames    (alloyJarName, className, classPackage)-import Language.Alloy.Ressources        (alloyJar, classFile)+import Language.Alloy.RessourceNames (+  alloyJarName, className, classPackage, commonsCliJarName+  )+import Language.Alloy.Ressources        (alloyJar, classFile, commonsCliJar) import Language.Alloy.Types             as Types   (AlloyInstance, AlloySig, Entries, Object, Signature) -data CallAlloyConfig = Config {-    alloyJarFile   :: FilePath,-    alloyClassFile :: FilePath,-    keepFiles      :: Bool+{-|+Configuration for calling alloy. These are:++ * maximal number of instances to retrieve ('Nothing' for all)+ * wheather to not overflow when calculating numbers within Alloy+-}+data CallAlloyConfig = CallAlloyConfig {+  -- | maximal number of instances to retrieve ('Nothing' for all)+  maxInstances :: Maybe Integer,+  -- | wheather to not overflow when calculating numbers within Alloy+  noOverflow   :: Bool   } +{-|+Default configuration for calling Alloy. Defaults to:++ * retrieve all instances+ * do not overflow+-}+defaultCallAlloyConfig :: CallAlloyConfig+defaultCallAlloyConfig = CallAlloyConfig {+  maxInstances = Nothing,+  noOverflow   = True+  }+ {-# NOINLINE mclassPath #-} {-| 'IORef' for storing the class path.@@ -84,11 +108,28 @@   -> String   -- ^ The Alloy specification which should be loaded.   -> IO [AlloyInstance]-getInstances maxInstances content = do+getInstances maxIs = getInstancesWith defaultCallAlloyConfig {+  maxInstances = maxIs+  }++{-|+This function may be used to get all model instances for a given Alloy+specification. It calls Alloy via a Java interface and parses the raw instance+answers before returning the resulting list of 'AlloyInstance's.+Parameters are set using a 'CallAlloyConfig'.+-}+getInstancesWith+  :: CallAlloyConfig+  -- ^ The configuration to be used.+  -> String+  -- ^ The Alloy specification which should be loaded.+  -> IO [AlloyInstance]+getInstancesWith config content = do   classPath <- getClassPath   let callAlloy = proc "java"-        ["-cp", classPath, classPackage ++ '.' : className,-         show $ fromMaybe (-1) maxInstances]+        $ ["-cp", classPath, classPackage ++ '.' : className,+           "-i", show $ fromMaybe (-1) $ maxInstances config]+        ++ ["-o" | not $ noOverflow config]   (Just hin, Just hout, Just herr, ph) <-     createProcess callAlloy {         std_out = CreatePipe,@@ -142,6 +183,14 @@   maybe readClassPath return mclassPath'  {-+{-+data CallAlloyConfig = Config {+    alloyJarFile   :: FilePath,+    alloyClassFile :: FilePath,+    keepFiles      :: Bool+  }+-}+ jarFileEnv :: String jarFileEnv = "ALLOY_JAR_FILE" @@ -211,6 +260,7 @@     else createVersionFile configDir versionFile   dataDir <- getXdgDirectory XdgData $ appName </> "dataDir"   return $ dataDir ++ searchPathSeparator : dataDir </> alloyJarName+    ++ searchPathSeparator : dataDir </> commonsCliJarName  {-| Create all library files within the users 'XdgDirectory' by calling@@ -233,6 +283,7 @@   createUserDirectoriesIfMissing $ dataDir </> classPackage   BS.writeFile (dataDir </> classPackage </> className <.> "class") classFile   BS.writeFile (dataDir </> alloyJarName) alloyJar+  BS.writeFile (dataDir </> commonsCliJarName) commonsCliJar  {-| Creates user directories using the file permissions 700.@@ -274,7 +325,8 @@ versions of this library. -} versionHash :: Int-versionHash = hash $ alloyHash + classFileHash+versionHash = hash $ alloyHash + commonsCliHash + classFileHash   where     alloyHash = hash alloyJar+    commonsCliHash = hash commonsCliJar     classFileHash = hash classFile

@@ -40,7 +40,7 @@  {-| Parse an Alloy instance from a given String.-May fail with a 'ParseError'.+May fail with 'ErrInfo'. -} parseInstance :: (MonadError ErrInfo m) => ByteString -> m AlloyInstance parseInstance inst = case parseByteString alloyInstance mempty inst of@@ -63,16 +63,15 @@   entryAnnotation <- try (string "skolem " $> Just Skolem) <|> pure Nothing   entrySignature <- sig   (entrySignature,)-    <$> (Entry-         <$> pure entryAnnotation-         <*> ((,)+    <$> (Entry entryAnnotation+         <$> ((,)               <$> ((string "<:" *> word) <|> pure "")               <*> parseRelations <* (void newline <|> eof)))  sig :: Parser Signature sig =   try (Signature <$> (Just <$> word) <* char '/' <*> word)-  <|> Signature <$> pure Nothing <*> word+  <|> Signature Nothing <$> word  parseRelations :: Parser (Relation Set) parseRelations = char '='

@@ -2,10 +2,14 @@   alloyJarName,   className,   classPackage,+  commonsCliJarName,   ) where  alloyJarName :: String alloyJarName = "org.alloytools.alloy.dist.jar"++commonsCliJarName :: String+commonsCliJarName = "commons-cli-1.4.jar"  className :: String className = "RunAlloy"

@@ -2,16 +2,22 @@ module Language.Alloy.Ressources (   alloyJar,   classFile,+  commonsCliJar,   ) where  import Data.ByteString                  (ByteString) import Data.FileEmbed                   (embedFile) import System.FilePath                  ((</>), (<.>)) -import Language.Alloy.RessourceNames    (alloyJarName, className, classPackage)+import Language.Alloy.RessourceNames (+  alloyJarName, className, classPackage, commonsCliJarName+  )  alloyJar :: ByteString alloyJar = $(embedFile $ "bin" </> alloyJarName)++commonsCliJar :: ByteString+commonsCliJar = $(embedFile $ "bin" </> "commons-cli" </> commonsCliJarName)  classFile :: ByteString classFile = $(embedFile $ "bin" </> classPackage </> className <.> "class")