editor-open (empty) → 0.1.0.0

raw patch · 5 files changed

+547/−0 lines, 5 filesdep +basedep +bytestringdep +processsetup-changed

Dependencies added: base, bytestring, process, temporary, unix

Files

• LICENSE +202/−0
• README.md +42/−0
• Setup.hs +2/−0
• editor-open.cabal +47/−0
• src/Text/Editor.hs +254/−0

@@ -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,42 @@+# editor-open++You know when you run `git commit`, and an editor pops open so you can enter a+commit message? This is a Haskell library that does that.++This library isn't very portable. It relies on the `$EDITOR` environment+variable. The concept only exists on *nix systems.++# Installing++If you're using this library, I assume you're familiar with the basic+infrastructure of Haskell programs. If not, check out+[Bitemyapp's guide](https://github.com/bitemyapp/learnhaskell).++Just add `editor-open` to the `build-depends:` field in your project's `.cabal`+file.++Alternatively, you can just do a one-off installation with:++```+cabal install editor-open+```++# Contact++* Email: `peter@harpending.org` +* IRC: `pharpend` on FreeNode and OFTC++# Copyright++Copyright 2015 Peter Harpending++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,2 @@+import Distribution.Simple+main = defaultMain

@@ -0,0 +1,47 @@+name:                editor-open+version:             0.1.0.0+synopsis:            Open the user's @$EDITOR@ for text input.+description:+  You know when you run @git commit@, and an editor pops open so you can enter a+  commit message? This is a Haskell library that does that.+  .+  This library isn't very portable. It relies on the @$EDITOR@ environment+  variable. The concept only exists on *nix systems.+homepage:            https://notabug.org/pharpend/editor-open+license:             Apache-2.0+license-file:        LICENSE+author:              Peter Harpending+maintainer:          peter@harpending.org+copyright:           Copyright 2015 Peter Harpending+category:            Text+build-type:          Simple+cabal-version:       >=1.10+extra-source-files:  +  README.md++library+  -- other-modules:       +  -- other-extensions:    +  hs-source-dirs:      src+  default-language:    Haskell2010+  default-extensions:+    LambdaCase+    MultiWayIf+    OverloadedStrings+  build-depends:+     base ==4.8.*+   , bytestring+   , process >=1.2+   , temporary+   , unix+  exposed-modules:     +    Text.Editor++source-repository head +  type: git+  location: https://notabug.org/pharpend/editor-open.git++source-repository this+  type: git+  location: https://notabug.org/pharpend/editor-open.git+  tag: 0.1.0.0

@@ -0,0 +1,254 @@+-- Copyright 2015 Peter Harpending+-- +-- 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.+++-- | +-- Module      : Text.Editor+-- Description : Open the user's @$EDITOR@+-- Copyright   : Copyright 2015 Peter Harpending+-- License     : Apache-2.0+-- Maintainer  : Peter Harpending <peter@harpending.org>+-- Stability   : experimental+-- Portability : POSIX+-- +-- You know when you run @git commit@, and a little editor pops up?+-- This is a Haskell library that does that.++module Text.Editor where++import qualified Data.ByteString as B+import           Data.ByteString (ByteString)+import           Data.Monoid+import           System.IO+import           System.IO.Temp+import           System.Process+import           System.Posix++-- == Porcelain functions =++-- |This is most likely the function you want to use. It takes a file+-- type template as an argument, along with what you want displayed+-- when the user opens the editor. It then runs the editor, and+-- returns the version of the text that the user modified.+-- +-- @+-- runUserEditorDWIM templ initialContents = userEditorDefault _default_editor >>= \theEditor ->+--                                             runSpecificEditor theEditor templ initialContents+-- @+-- +-- +-- Examples:+-- +-- >>> :set -XOverloadedStrings+-- >>> runUserEditorDWIM jsonTemplate "{\n\n}\n"+-- +-- This will open up the user's @$EDITOR@ configured to edit JSON, and+-- with the initial text:+--  +-- @+-- {+-- }+-- @+-- +-- There are a bunch of templates. See the "File-type extensions"+-- section. It's also trivially easy to make your own templates. Say+-- you want one for, I dunno, Python:+-- +-- @+-- pythonTemplate = mkTemplate "py"+-- @+-- +-- The argument to 'mkTemplate' should be the file extension you+-- want. In that case, I used @"py"@, because Python's file extension+-- is @.py@.+runUserEditorDWIM :: Template       -- ^Template for the file name+                  -> ByteString     -- ^Initial contents+                  -> IO ByteString  -- ^Resulting ByteString+runUserEditorDWIM templ initialContents = userEditorDefault _default_editor >>= \theEditor ->+                                            runSpecificEditor theEditor templ initialContents++-- |This is likely the simplest function here. It opens up the user's editor,+-- and fetches a ByteString from it+-- +-- @+-- runUserEditor = userEditorDefault _default_editor >>= \theEditor ->+--                   runSpecificEditor theEditor plainTemplate mempty+-- @+runUserEditor :: IO ByteString+runUserEditor = userEditorDefault _default_editor >>= \theEditor ->+                  runSpecificEditor theEditor plainTemplate mempty++-- |This is probably the second-simplest function.+-- +-- +runUserEditorWithTemplate :: Template       -- ^Template for the file name+                          -> IO ByteString  -- ^Resulting ByteString+runUserEditorWithTemplate templ = userEditorDefault _default_editor >>= \theEditor ->+                                    runSpecificEditor theEditor templ mempty++-- == File-type extensions ==+-- +-- If you use one of the extensions below, you'll likely enable syntax+-- highlighting in the user's editor.++type Template = String++-- |Make a template +-- +-- @+-- mkTemplate ext = _ftempl <> "." <> ext+-- @+-- +-- >>> mkTemplate "blah"+-- tmp.blah+-- +mkTemplate :: String -> Template+mkTemplate ext = _ftempl <> "." <> ext++-- |File-type template for HTML+-- +-- @+-- htmlTemplate = mkTemplate "html"+-- @+htmlTemplate :: Template+htmlTemplate = mkTemplate "html"++-- |File-type template for JSON+-- +-- @+-- jsonTemplate = mkTemplate "json"+-- @+jsonTemplate :: Template+jsonTemplate = mkTemplate "json"++-- |File-type template for Markdown+-- +-- @+-- markdownTemplate = mkTemplate "md"+-- @+markdownTemplate :: Template+markdownTemplate = mkTemplate "md"++-- |Older file-type template for Markdown+-- +-- @+-- markdownTemplate = mkTemplate "markdown"+-- @+oldMarkdownTemplate :: Template+oldMarkdownTemplate = mkTemplate "markdown"++-- |File-type template for plain text+-- +-- @+-- plainTemplate = mkTemplate "txt"+-- @+plainTemplate :: Template+plainTemplate = mkTemplate "txt"++-- |File-type template for XML+-- +-- @+-- xmlTemplate = mkTemplate "xml"+-- @+xmlTemplate :: Template+xmlTemplate = mkTemplate "xml"++-- |Same as 'plainTemplate'+txtTemplate :: Template+txtTemplate = mkTemplate "txt"++-- |File-type template for YAML+-- +-- @+-- yamlTemplate = mkTemplate "yaml"+-- @+yamlTemplate :: Template+yamlTemplate = mkTemplate "yaml"++-- == Plumbing =+-- |Open an editor. You probably don't want to use this function.+-- +-- @+-- runSpecific editorName templ initialContents =+--   withSystemTempFile templ $ \filePath hdl -> do+--     hSetBinaryMode hdl True+--     hSetBuffering hdl NoBuffering+--     B.hPut hdl initialContents+--     callProcess editorName [filePath]+--     B.hGetContents hdl+-- @+-- +runSpecificEditor :: String        -- ^Name of the editor.+                  -> Template      -- ^Template for the file name.+                  -> ByteString    -- ^Initial contents of the file.+                  -> IO ByteString -- ^Resulting ByteString.+runSpecificEditor editorName templ initialContents =+  withSystemTempFile templ $ \filePath hdl -> do+    hSetBinaryMode hdl True+    hSetBuffering hdl NoBuffering+    B.hPut hdl initialContents+    callProcess editorName [filePath]+    B.hGetContents hdl+++-- |This uses 'getEnv' from "System.Posix" to attempt to+-- get the user's @$EDITOR@ variable.+-- +-- @+-- userEditor = getEnv _editor+-- @+userEditor :: IO (Maybe String)+userEditor = getEnv _editor++-- |Wrapper around 'userEditor' that includes a fallback option if the+-- @$EDITOR@ variable doesn't exist.+-- @+-- userEditorDefault def = userEditor >>= \case+--                           Just e  -> pure e+--                           Nothing -> pure def+-- @+userEditorDefault :: String -- ^Default value if @$EDITOR@ is not found.+                  -> IO String+userEditorDefault def = userEditor >>= \case+                          Just e  -> pure e+                          Nothing -> pure def+++-- == Internal variables ==+-- +-- You are welcome to use these, but I can't see why you would want to.++-- |The default editor if no other editor is found+-- +-- @+-- _default_editor = "nano"+-- @+_default_editor :: String+_default_editor = "nano"++-- |The variable we should search when finding the user's editor.+-- +-- @+-- _editor = "EDITOR"+-- @+_editor :: String+_editor = "EDITOR"++-- |The standard filename template+-- +-- @+-- _ftempl = "tmp"+-- @+_ftempl :: String+_ftempl = "tmp"