require (empty) → 0.0.1
raw patch · 11 files changed
+564/−0 lines, 11 filesdep +basedep +bytestringdep +criterionsetup-changed
Dependencies added: base, bytestring, criterion, require, tasty, tasty-hspec, text, universum
Files
- CHANGELOG.md +7/−0
- LICENSE.md +195/−0
- README.md +5/−0
- Setup.hs +7/−0
- benchmark/Main.hs +6/−0
- executable/Main.hs +14/−0
- library/Require.hs +54/−0
- package.yaml +70/−0
- require.cabal +100/−0
- stack.yaml +67/−0
- test-suite/Main.hs +39/−0
+ CHANGELOG.md view
@@ -0,0 +1,7 @@+# Change log++require uses [Semantic Versioning][].+The change log is available through the [releases on GitHub][].++[Semantic Versioning]: http://semver.org/spec/v2.0.0.html+[releases on GitHub]: https://github.com/githubuser/require/releases
+ LICENSE.md view
@@ -0,0 +1,195 @@+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 2018 The Agile Monkeys S.L.+ + 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.+
+ README.md view
@@ -0,0 +1,5 @@+# require+## Scrap your qualified import clutter++Proceed to the [require website](https://theam.github.io/require) for documentation and usage.+
+ Setup.hs view
@@ -0,0 +1,7 @@+-- This script is used to build and install your package. Typically you don't+-- need to change it. The Cabal documentation has more information about this+-- file: <https://www.haskell.org/cabal/users-guide/installing-packages.html>.+import qualified Distribution.Simple++main :: IO ()+main = Distribution.Simple.defaultMain
+ benchmark/Main.hs view
@@ -0,0 +1,6 @@+-- You can benchmark your code quickly and effectively with Criterion. See its+-- website for help: <http://www.serpentine.com/criterion/>.+import Criterion.Main++main :: IO ()+main = defaultMain [bench "const" (whnf const ())]
+ executable/Main.hs view
@@ -0,0 +1,14 @@+-- It is generally a good idea to keep all your business logic in your library+-- and only use it in the executable. Doing so allows others to use what you+-- wrote in their libraries.+import Universum++import System.Environment as System++import qualified Require++main :: IO ()+main = do+ (_:inFile:outFile:_) <- System.getArgs+ content <- readFile inFile+ writeFile outFile $ Require.transform (Require.FileName $ toText inFile) content
+ library/Require.hs view
@@ -0,0 +1,54 @@+module Require where++import Universum++import qualified Data.Text as Text++newtype FileName = FileName Text++transform :: FileName -> Text -> Text+transform filename input =+ let+ foo = Text.lines input+ <&> (Text.splitOn "require")+ & zip [1..]+ <&> (\(lineNumber, texts) -> convertIfNeeded filename lineNumber texts)+ & Text.concat+ in foo+++convertIfNeeded :: FileName -> Int -> [Text] -> Text+convertIfNeeded (FileName fn) lineNumber texts =+ case texts of+ ["", moduleName] ->+ let+ moduleLast = Text.reverse moduleName+ & Text.takeWhile (/= '.')+ & Text.reverse++ qualifiedImport = lineTag+ <> "import qualified"+ <> moduleName+ <> " as "+ <> moduleLast++ typeImport = lineTag+ <> "import"+ <> moduleName+ <> " ("+ <> moduleLast+ <> ")"++ lineTag = "{-# LINE "+ <> show lineNumber+ <> " \""+ <> fn+ <> "\" #-}\n"+ in+ typeImport+ <> "\n"+ <> qualifiedImport+ <> "\n"++ otherList ->+ unlines otherList
+ package.yaml view
@@ -0,0 +1,70 @@+name: require+version: '0.0.1'+github: "theam/require"+license: Apache-2.0+author: "The Agile Monkeys"+maintainer: "hackers@theam.io"+copyright: "2018 Theam"+synopsis: Scrap your qualified import clutter+description: See <https://theam.github.io/require>+category: Other+license-file: LICENSE.md++extra-source-files:+- CHANGELOG.md+- LICENSE.md+- package.yaml+- README.md+- stack.yaml++ghc-options: -Wall++default-extensions:+ - NoImplicitPrelude+ - OverloadedStrings+ - TypeApplications++dependencies:+ - base >= 4.11 && < 5+ - universum >= 1.2.0 && < 2+ - bytestring >= 0.10 && < 0.11+ - text >= 1.2.3.0 && < 2++library:+ source-dirs: library++executables:+ requirepp:+ source-dirs: executable+ main: Main.hs+ dependencies:+ - require+ ghc-options:+ - -rtsopts+ - -threaded+ - -with-rtsopts=-N++benchmarks:+ require-benchmarks:+ source-dirs: benchmark+ main: Main.hs+ dependencies:+ - require+ - criterion+ ghc-options:+ - -rtsopts+ - -threaded+ - -with-rtsopts=-N++tests:+ require-test-suite:+ source-dirs: test-suite+ main: Main.hs+ dependencies:+ - require+ - tasty+ - tasty-hspec+ ghc-options:+ - -rtsopts+ - -threaded+ - -with-rtsopts=-N
+ require.cabal view
@@ -0,0 +1,100 @@+-- This file has been generated from package.yaml by hpack version 0.27.0.+--+-- see: https://github.com/sol/hpack+--+-- hash: d44fb331420f1b19f369701590ab0a52898b99681925f4142991554e004bff7a++name: require+version: 0.0.1+synopsis: Scrap your qualified import clutter+description: See <https://theam.github.io/require>+category: Other+homepage: https://github.com/theam/require#readme+bug-reports: https://github.com/theam/require/issues+author: The Agile Monkeys+maintainer: hackers@theam.io+copyright: 2018 Theam+license: Apache-2.0+license-file: LICENSE.md+build-type: Simple+cabal-version: >= 1.10++extra-source-files:+ CHANGELOG.md+ LICENSE.md+ package.yaml+ README.md+ stack.yaml++source-repository head+ type: git+ location: https://github.com/theam/require++library+ exposed-modules:+ Require+ other-modules:+ Paths_require+ hs-source-dirs:+ library+ default-extensions: NoImplicitPrelude OverloadedStrings TypeApplications+ ghc-options: -Wall+ build-depends:+ base >=4.11 && <5+ , bytestring >=0.10 && <0.11+ , text >=1.2.3.0 && <2+ , universum >=1.2.0 && <2+ default-language: Haskell2010++executable requirepp+ main-is: Main.hs+ other-modules:+ Paths_require+ hs-source-dirs:+ executable+ default-extensions: NoImplicitPrelude OverloadedStrings TypeApplications+ ghc-options: -Wall -rtsopts -threaded -with-rtsopts=-N+ build-depends:+ base >=4.11 && <5+ , bytestring >=0.10 && <0.11+ , require+ , text >=1.2.3.0 && <2+ , universum >=1.2.0 && <2+ default-language: Haskell2010++test-suite require-test-suite+ type: exitcode-stdio-1.0+ main-is: Main.hs+ other-modules:+ Paths_require+ hs-source-dirs:+ test-suite+ default-extensions: NoImplicitPrelude OverloadedStrings TypeApplications+ ghc-options: -Wall -rtsopts -threaded -with-rtsopts=-N+ build-depends:+ base >=4.11 && <5+ , bytestring >=0.10 && <0.11+ , require+ , tasty+ , tasty-hspec+ , text >=1.2.3.0 && <2+ , universum >=1.2.0 && <2+ default-language: Haskell2010++benchmark require-benchmarks+ type: exitcode-stdio-1.0+ main-is: Main.hs+ other-modules:+ Paths_require+ hs-source-dirs:+ benchmark+ default-extensions: NoImplicitPrelude OverloadedStrings TypeApplications+ ghc-options: -Wall -rtsopts -threaded -with-rtsopts=-N+ build-depends:+ base >=4.11 && <5+ , bytestring >=0.10 && <0.11+ , criterion+ , require+ , text >=1.2.3.0 && <2+ , universum >=1.2.0 && <2+ default-language: Haskell2010
+ stack.yaml view
@@ -0,0 +1,67 @@+# This file was automatically generated by 'stack init'+#+# Some commonly used options have been documented as comments in this file.+# For advanced use and comprehensive documentation of the format, please see:+# https://docs.haskellstack.org/en/stable/yaml_configuration/++# Resolver to choose a 'specific' stackage snapshot or a compiler version.+# A snapshot resolver dictates the compiler version and the set of packages+# to be used for project dependencies. For example:+#+# resolver: lts-3.5+# resolver: nightly-2015-09-21+# resolver: ghc-7.10.2+# resolver: ghcjs-0.1.0_ghc-7.10.2+# resolver:+# name: custom-snapshot+# location: "./custom-snapshot.yaml"+resolver: nightly-2018-05-23++# User packages to be built.+# Various formats can be used as shown in the example below.+#+# packages:+# - some-directory+# - https://example.com/foo/bar/baz-0.0.2.tar.gz+# - location:+# git: https://github.com/commercialhaskell/stack.git+# commit: e7b331f14bcffb8367cd58fbfc8b40ec7642100a+# - location: https://github.com/commercialhaskell/stack/commit/e7b331f14bcffb8367cd58fbfc8b40ec7642100a+# extra-dep: true+# subdirs:+# - auto-update+# - wai+#+# A package marked 'extra-dep: true' will only be built if demanded by a+# non-dependency (i.e. a user package), and its test suites and benchmarks+# will not be run. This is useful for tweaking upstream packages.+packages:+- .+# Dependency packages to be pulled from upstream that are not in the resolver+# (e.g., acme-missiles-0.3)+extra-deps:+ - universum-1.2.0++# Override default flag values for local packages and extra-deps+# flags: {}++# Extra package databases containing global packages+# extra-package-dbs: []++# Control whether we use the GHC we find on the path+# system-ghc: true+#+# Require a specific version of stack, using version ranges+# require-stack-version: -any # Default+# require-stack-version: ">=1.6"+#+# Override the architecture used by stack, especially useful on Windows+# arch: i386+# arch: x86_64+#+# Extra directories used by stack for building+# extra-include-dirs: [/path/to/dir]+# extra-lib-dirs: [/path/to/dir]+#+# Allow a newer minor version of GHC than the snapshot specifies+# compiler-check: newer-minor
+ test-suite/Main.hs view
@@ -0,0 +1,39 @@+import Universum++import qualified Test.Tasty+import Test.Tasty.Hspec+import qualified Data.Text as Text++import qualified Require++main :: IO ()+main = do+ test <- testSpec "require" spec+ Test.Tasty.defaultMain test+++spec :: Spec+spec = parallel $ do+ it "transforms the 'require' keyword into a properly qualified import" $ do+ let input = "require Data.Text"+ let expected = "import qualified Data.Text as Text"+ let actual = Require.transform (Require.FileName "Foo.hs") input+ expected `Text.isInfixOf` actual++ it "imports the type based on the module" $ do+ let input = "require Data.Text"+ let expected = "import Data.Text (Text)"+ let actual = Require.transform (Require.FileName "Foo.hs") input+ expected `Text.isInfixOf` actual++ it "keeps the rest of the content intact" $ do+ let input = "module Foo where\nrequire Data.Text\nfoo = 42"+ let expectedModule = "module Foo where"+ let expectedTypeImport = "import Data.Text (Text)"+ let expectedQualifiedImport = "import qualified Data.Text as Text"+ let expectedContent = "foo = 42\n"+ let actual = toString $ Require.transform (Require.FileName "Foo.hs") input+ actual `shouldStartWith` expectedModule+ actual `shouldContain` expectedTypeImport+ actual `shouldContain` expectedQualifiedImport+ actual `shouldEndWith` expectedContent