shortcut-links 0.4.2.1 → 0.5.0.0
raw patch · 8 files changed
+627/−190 lines, 8 filesdep ~basedep ~textsetup-changednew-uploaderPVP ok
version bump matches the API change (PVP)
Dependency ranges changed: base, text
API changes (from Hackage documentation)
+ ShortcutLinks.All: instance Control.Monad.Fail.MonadFail ShortcutLinks.All.Result
Files
- CHANGELOG.md +20/−7
- LICENSE +367/−24
- README.md +7/−0
- Setup.hs +0/−2
- shortcut-links.cabal +38/−21
- src/ShortcutLinks.hs +30/−26
- src/ShortcutLinks/All.hs +105/−56
- src/ShortcutLinks/Utils.hs +60/−54
CHANGELOG.md view
@@ -1,26 +1,36 @@-# 0.4.2.1+# Changelog +`shortcut-links` uses [PVP Versioning][1].+The changelog is available [on GitHub][2].++## 0.5.0.0 - Dec 26, 2019++* Support GHC-8.8.1.+* Update maintenance info.++## 0.4.2.1+ * Fixed links to GHC extensions. -# 0.4.2.0+## 0.4.2.0 * Added `useShortcutFrom`. * `@` is now allowed in Github/Gitlab/Bitbucket nicks. -# 0.4.1.0+## 0.4.1.0 * Exported `useShortcut` (gee). -# 0.4.0.0+## 0.4.0.0 * Exported `Shortcut`. * Renamed “braumeister” to “brew” (it still uses Braumeister, but this can change in the future). -# 0.3.0.0+## 0.3.0.0 * Added shortcut names to their descriptions. -# 0.2.0.0+## 0.2.0.0 * Descriptions of shortcuts look much better now. * “sublime” was renamed to “sublimepc”, since it's possible that some other package manager for Sublime Text would emerge in the future.@@ -28,6 +38,9 @@ * “facebook” can link to profiles by their ID. * “tvtropes” properly capitalises names of categories (if given as an option) – previously you needed to write e.g. “SugarWiki”, now “sugar wiki” works too. -# 0.1.0.0+## 0.1.0.0 First release.++[1]: https://pvp.haskell.org+[2]: https://github.com/kowainik/shortcut-links/releases
LICENSE view
@@ -1,30 +1,373 @@-Copyright (c) 2015, Aelve+Mozilla Public License Version 2.0+================================== -All rights reserved.+1. Definitions+-------------- -Redistribution and use in source and binary forms, with or without-modification, are permitted provided that the following conditions are met:+1.1. "Contributor"+ means each individual or legal entity that creates, contributes to+ the creation of, or owns Covered Software. - * Redistributions of source code must retain the above copyright- notice, this list of conditions and the following disclaimer.+1.2. "Contributor Version"+ means the combination of the Contributions of others (if any) used+ by a Contributor and that particular Contributor's Contribution. - * Redistributions in binary form must reproduce the above- copyright notice, this list of conditions and the following- disclaimer in the documentation and/or other materials provided- with the distribution.+1.3. "Contribution"+ means Covered Software of a particular Contributor. - * Neither the name of Aelve nor the names of other contributors- may be used to endorse or promote products derived from this- software without specific prior written permission.+1.4. "Covered Software"+ means Source Code Form to which the initial Contributor has attached+ the notice in Exhibit A, the Executable Form of such Source Code+ Form, and Modifications of such Source Code Form, in each case+ including portions thereof. -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.+1.5. "Incompatible With Secondary Licenses"+ means++ (a) that the initial Contributor has attached the notice described+ in Exhibit B to the Covered Software; or++ (b) that the Covered Software was made available under the terms of+ version 1.1 or earlier of the License, but not also under the+ terms of a Secondary License.++1.6. "Executable Form"+ means any form of the work other than Source Code Form.++1.7. "Larger Work"+ means a work that combines Covered Software with other material, in+ a separate file or files, that is not Covered Software.++1.8. "License"+ means this document.++1.9. "Licensable"+ means having the right to grant, to the maximum extent possible,+ whether at the time of the initial grant or subsequently, any and+ all of the rights conveyed by this License.++1.10. "Modifications"+ means any of the following:++ (a) any file in Source Code Form that results from an addition to,+ deletion from, or modification of the contents of Covered+ Software; or++ (b) any new file in Source Code Form that contains any Covered+ Software.++1.11. "Patent Claims" of a Contributor+ means any patent claim(s), including without limitation, method,+ process, and apparatus claims, in any patent Licensable by such+ Contributor that would be infringed, but for the grant of the+ License, by the making, using, selling, offering for sale, having+ made, import, or transfer of either its Contributions or its+ Contributor Version.++1.12. "Secondary License"+ means either the GNU General Public License, Version 2.0, the GNU+ Lesser General Public License, Version 2.1, the GNU Affero General+ Public License, Version 3.0, or any later versions of those+ licenses.++1.13. "Source Code Form"+ means the form of the work preferred for making modifications.++1.14. "You" (or "Your")+ means an individual or a legal entity exercising rights under this+ License. For legal entities, "You" includes any entity that+ controls, is controlled by, or is under common control with You. For+ purposes of this definition, "control" means (a) the power, direct+ or indirect, to cause the direction or management of such entity,+ whether by contract or otherwise, or (b) ownership of more than+ fifty percent (50%) of the outstanding shares or beneficial+ ownership of such entity.++2. License Grants and Conditions+--------------------------------++2.1. Grants++Each Contributor hereby grants You a world-wide, royalty-free,+non-exclusive license:++(a) under intellectual property rights (other than patent or trademark)+ Licensable by such Contributor to use, reproduce, make available,+ modify, display, perform, distribute, and otherwise exploit its+ Contributions, either on an unmodified basis, with Modifications, or+ as part of a Larger Work; and++(b) under Patent Claims of such Contributor to make, use, sell, offer+ for sale, have made, import, and otherwise transfer either its+ Contributions or its Contributor Version.++2.2. Effective Date++The licenses granted in Section 2.1 with respect to any Contribution+become effective for each Contribution on the date the Contributor first+distributes such Contribution.++2.3. Limitations on Grant Scope++The licenses granted in this Section 2 are the only rights granted under+this License. No additional rights or licenses will be implied from the+distribution or licensing of Covered Software under this License.+Notwithstanding Section 2.1(b) above, no patent license is granted by a+Contributor:++(a) for any code that a Contributor has removed from Covered Software;+ or++(b) for infringements caused by: (i) Your and any other third party's+ modifications of Covered Software, or (ii) the combination of its+ Contributions with other software (except as part of its Contributor+ Version); or++(c) under Patent Claims infringed by Covered Software in the absence of+ its Contributions.++This License does not grant any rights in the trademarks, service marks,+or logos of any Contributor (except as may be necessary to comply with+the notice requirements in Section 3.4).++2.4. Subsequent Licenses++No Contributor makes additional grants as a result of Your choice to+distribute the Covered Software under a subsequent version of this+License (see Section 10.2) or under the terms of a Secondary License (if+permitted under the terms of Section 3.3).++2.5. Representation++Each Contributor represents that the Contributor believes its+Contributions are its original creation(s) or it has sufficient rights+to grant the rights to its Contributions conveyed by this License.++2.6. Fair Use++This License is not intended to limit any rights You have under+applicable copyright doctrines of fair use, fair dealing, or other+equivalents.++2.7. Conditions++Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted+in Section 2.1.++3. Responsibilities+-------------------++3.1. Distribution of Source Form++All distribution of Covered Software in Source Code Form, including any+Modifications that You create or to which You contribute, must be under+the terms of this License. You must inform recipients that the Source+Code Form of the Covered Software is governed by the terms of this+License, and how they can obtain a copy of this License. You may not+attempt to alter or restrict the recipients' rights in the Source Code+Form.++3.2. Distribution of Executable Form++If You distribute Covered Software in Executable Form then:++(a) such Covered Software must also be made available in Source Code+ Form, as described in Section 3.1, and You must inform recipients of+ the Executable Form how they can obtain a copy of such Source Code+ Form by reasonable means in a timely manner, at a charge no more+ than the cost of distribution to the recipient; and++(b) You may distribute such Executable Form under the terms of this+ License, or sublicense it under different terms, provided that the+ license for the Executable Form does not attempt to limit or alter+ the recipients' rights in the Source Code Form under this License.++3.3. Distribution of a Larger Work++You may create and distribute a Larger Work under terms of Your choice,+provided that You also comply with the requirements of this License for+the Covered Software. If the Larger Work is a combination of Covered+Software with a work governed by one or more Secondary Licenses, and the+Covered Software is not Incompatible With Secondary Licenses, this+License permits You to additionally distribute such Covered Software+under the terms of such Secondary License(s), so that the recipient of+the Larger Work may, at their option, further distribute the Covered+Software under the terms of either this License or such Secondary+License(s).++3.4. Notices++You may not remove or alter the substance of any license notices+(including copyright notices, patent notices, disclaimers of warranty,+or limitations of liability) contained within the Source Code Form of+the Covered Software, except that You may alter any license notices to+the extent required to remedy known factual inaccuracies.++3.5. Application of Additional Terms++You may choose to offer, and to charge a fee for, warranty, support,+indemnity or liability obligations to one or more recipients of Covered+Software. However, You may do so only on Your own behalf, and not on+behalf of any Contributor. You must make it absolutely clear that any+such warranty, support, indemnity, or liability obligation is offered by+You alone, and You hereby agree to indemnify every Contributor for any+liability incurred by such Contributor as a result of warranty, support,+indemnity or liability terms You offer. You may include additional+disclaimers of warranty and limitations of liability specific to any+jurisdiction.++4. Inability to Comply Due to Statute or Regulation+---------------------------------------------------++If it is impossible for You to comply with any of the terms of this+License with respect to some or all of the Covered Software due to+statute, judicial order, or regulation then You must: (a) comply with+the terms of this License to the maximum extent possible; and (b)+describe the limitations and the code they affect. Such description must+be placed in a text file included with all distributions of the Covered+Software under this License. Except to the extent prohibited by statute+or regulation, such description must be sufficiently detailed for a+recipient of ordinary skill to be able to understand it.++5. Termination+--------------++5.1. The rights granted under this License will terminate automatically+if You fail to comply with any of its terms. However, if You become+compliant, then the rights granted under this License from a particular+Contributor are reinstated (a) provisionally, unless and until such+Contributor explicitly and finally terminates Your grants, and (b) on an+ongoing basis, if such Contributor fails to notify You of the+non-compliance by some reasonable means prior to 60 days after You have+come back into compliance. Moreover, Your grants from a particular+Contributor are reinstated on an ongoing basis if such Contributor+notifies You of the non-compliance by some reasonable means, this is the+first time You have received notice of non-compliance with this License+from such Contributor, and You become compliant prior to 30 days after+Your receipt of the notice.++5.2. If You initiate litigation against any entity by asserting a patent+infringement claim (excluding declaratory judgment actions,+counter-claims, and cross-claims) alleging that a Contributor Version+directly or indirectly infringes any patent, then the rights granted to+You by any and all Contributors for the Covered Software under Section+2.1 of this License shall terminate.++5.3. In the event of termination under Sections 5.1 or 5.2 above, all+end user license agreements (excluding distributors and resellers) which+have been validly granted by You or Your distributors under this License+prior to termination shall survive termination.++************************************************************************+* *+* 6. Disclaimer of Warranty *+* ------------------------- *+* *+* Covered Software is provided under this License on an "as is" *+* basis, without warranty of any kind, either expressed, implied, or *+* statutory, including, without limitation, warranties that the *+* Covered Software is free of defects, merchantable, fit for a *+* particular purpose or non-infringing. The entire risk as to the *+* quality and performance of the Covered Software is with You. *+* Should any Covered Software prove defective in any respect, You *+* (not any Contributor) assume the cost of any necessary servicing, *+* repair, or correction. This disclaimer of warranty constitutes an *+* essential part of this License. No use of any Covered Software is *+* authorized under this License except under this disclaimer. *+* *+************************************************************************++************************************************************************+* *+* 7. Limitation of Liability *+* -------------------------- *+* *+* Under no circumstances and under no legal theory, whether tort *+* (including negligence), contract, or otherwise, shall any *+* Contributor, or anyone who distributes Covered Software as *+* permitted above, be liable to You for any direct, indirect, *+* special, incidental, or consequential damages of any character *+* including, without limitation, damages for lost profits, loss of *+* goodwill, work stoppage, computer failure or malfunction, or any *+* and all other commercial damages or losses, even if such party *+* shall have been informed of the possibility of such damages. This *+* limitation of liability shall not apply to liability for death or *+* personal injury resulting from such party's negligence to the *+* extent applicable law prohibits such limitation. Some *+* jurisdictions do not allow the exclusion or limitation of *+* incidental or consequential damages, so this exclusion and *+* limitation may not apply to You. *+* *+************************************************************************++8. Litigation+-------------++Any litigation relating to this License may be brought only in the+courts of a jurisdiction where the defendant maintains its principal+place of business and such litigation shall be governed by laws of that+jurisdiction, without reference to its conflict-of-law provisions.+Nothing in this Section shall prevent a party's ability to bring+cross-claims or counter-claims.++9. Miscellaneous+----------------++This License represents the complete agreement concerning the subject+matter hereof. If any provision of this License is held to be+unenforceable, such provision shall be reformed only to the extent+necessary to make it enforceable. Any law or regulation which provides+that the language of a contract shall be construed against the drafter+shall not be used to construe this License against a Contributor.++10. Versions of the License+---------------------------++10.1. New Versions++Mozilla Foundation is the license steward. Except as provided in Section+10.3, no one other than the license steward has the right to modify or+publish new versions of this License. Each version will be given a+distinguishing version number.++10.2. Effect of New Versions++You may distribute the Covered Software under the terms of the version+of the License under which You originally received the Covered Software,+or under the terms of any subsequent version published by the license+steward.++10.3. Modified Versions++If you create software not governed by this License, and you want to+create a new license for such software, you may create and use a+modified version of this License if you rename the license and remove+any references to the name of the license steward (except to note that+such modified license differs from this License).++10.4. Distributing Source Code Form that is Incompatible With Secondary+Licenses++If You choose to distribute Source Code Form that is Incompatible With+Secondary Licenses under the terms of this version of the License, the+notice described in Exhibit B of this License must be attached.++Exhibit A - Source Code Form License Notice+-------------------------------------------++ This Source Code Form is subject to the terms of the Mozilla Public+ License, v. 2.0. If a copy of the MPL was not distributed with this+ file, You can obtain one at http://mozilla.org/MPL/2.0/.++If it is not possible or desirable to put the notice in a particular+file, then You may include the notice in a location (such as a LICENSE+file in a relevant directory) where a recipient would be likely to look+for such a notice.++You may add additional accurate notices of copyright ownership.++Exhibit B - "Incompatible With Secondary Licenses" Notice+---------------------------------------------------------++ This Source Code Form is "Incompatible With Secondary Licenses", as+ defined by the Mozilla Public License, v. 2.0.
README.md view
@@ -1,5 +1,12 @@ # shortcut-links +[](https://travis-ci.org/kowainik/shortcut-links)+[](https://ci.appveyor.com/project/kowainik/shortcut-links)+[](https://hackage.haskell.org/package/shortcut-links)+[](http://stackage.org/lts/package/shortcut-links)+[](http://stackage.org/nightly/package/shortcut-links)+[](https://github.com/kowainik/shortcut-links/blob/master/LICENSE)+ This package is a database of link shortcuts. A Markdown example: `[Google](@w)` turns into <http://en.wikipedia.org/wiki/Google>. It's intended to be used in wikis and text markup converters (such as Pandoc) and anywhere else where humans may be entering links.
− Setup.hs
@@ -1,2 +0,0 @@-import Distribution.Simple-main = defaultMain
shortcut-links.cabal view
@@ -1,37 +1,54 @@+cabal-version: 2.4 name: shortcut-links-version: 0.4.2.1+version: 0.5.0.0 synopsis: Link shortcuts for use in text markup description: This package is a database of link shortcuts. A Markdown example: @\[Google\](\@w)@ turns into <http://en.wikipedia.org/wiki/Google>. . See the "ShortcutLinks.All" module for a full list of shortcuts.-homepage: http://github.com/aelve/shortcut-links-bug-reports: http://github.com/aelve/shortcut-links/issues-license: BSD3+homepage: http://github.com/kowainik/shortcut-links+bug-reports: http://github.com/kowainik/shortcut-links/issues+license: MPL-2.0 license-file: LICENSE author: Artyom-maintainer: Artyom <yom@artyom.me>-copyright: 2015–∞ Aelve-category: Text, Web+maintainer: Kowainik <xrom.xkov@gmail.com>+copyright: 2015–2019 Aelve (BSD-3-Clause)+ 2019-2020 Kowainik+category: Text, Web, Markdown build-type: Simple-extra-source-files:- README.md- CHANGELOG.md-cabal-version: >=1.10-tested-with: GHC ==8.0.2, GHC ==8.2.2, GHC ==8.4.4, GHC ==8.6.2+stability: stable+extra-doc-files: README.md+ CHANGELOG.md+tested-with: GHC == 8.2.2+ GHC == 8.4.4+ GHC == 8.6.5+ GHC == 8.8.1 source-repository head- type: git- location: git://github.com/aelve/shortcut-links.git+ type: git+ location: git://github.com/kowainik/shortcut-links.git library- exposed-modules: ShortcutLinks- ShortcutLinks.All- ShortcutLinks.Utils- -- other-modules:- -- other-extensions:- build-depends: base >= 4.5 && < 5- , text >= 1.1 hs-source-dirs: src+ exposed-modules: ShortcutLinks+ ShortcutLinks.All+ ShortcutLinks.Utils+ build-depends: base >= 4.5 && < 4.14+ , text >= 1.1 && < 1.3+ ghc-options: -Wall+ -Wincomplete-uni-patterns+ -Wincomplete-record-updates+ -Wcompat+ -Widentities+ -Wredundant-constraints+ -fhide-source-paths+ if impl(ghc >= 8.8.1)+ ghc-options: -Wmissing-deriving-strategies+ -Werror=missing-deriving-strategies++ default-extensions: DerivingStrategies+ InstanceSigs+ OverloadedStrings+ default-language: Haskell2010
src/ShortcutLinks.hs view
@@ -1,27 +1,28 @@-{-# LANGUAGE OverloadedStrings #-}+{- |+Copyright: (c) 2015-2019 Aelve+ (c) 2019-2020 Kowainik+SPDX-License-Identifier: MPL-2.0+Maintainer: Kowainik <xrom.xkov@gmail.com>+-} module ShortcutLinks-(- Result(..),- Shortcut,- allShortcuts,- useShortcut,- useShortcutFrom,-)-where-+ ( Result(..)+ , Shortcut+ , allShortcuts+ , useShortcut+ , useShortcutFrom+ ) where --- Text import Data.Text (Text)-import qualified Data.Text as T--- shortcut-links-import ShortcutLinks.All++import ShortcutLinks.All (Result (..), Shortcut, allShortcuts) import ShortcutLinks.Utils (format) --- | Use a shortcut from 'allShortcuts'.------ This is the main function you should use.+{- | Use a shortcut from 'allShortcuts'.++This is the main function you should use.+-} useShortcut :: Text -- ^ Shortcut name -> Maybe Text -- ^ Option@@ -29,12 +30,13 @@ -> Result Text -- ^ Resulting URL useShortcut = useShortcutFrom allShortcuts --- | Use a shortcut from a list.------ For instance, if you want to add @hk@ as a synonym for @hackage@, you'd--- write:------ >>> useShortcutFrom ((["hk"], hackage) : allShortcuts)+{- | Use a shortcut from a list.++For instance, if you want to add @hk@ as a synonym for @hackage@, you'd+write:++>>> useShortcutFrom ((["hk"], hackage) : allShortcuts)+-} useShortcutFrom :: [([Text], Shortcut)] -> Text -- ^ Shortcut name@@ -42,8 +44,10 @@ -> Text -- ^ Link text -> Result Text -- ^ Resulting URL useShortcutFrom shortcuts name option link =- let givenShortcut (names,_) = name `elem` names- in case filter givenShortcut shortcuts of+ case filter givenShortcut shortcuts of [] -> fail (format "there's no shortcut named '{}'" name)- [sh] -> (snd sh) option link+ [sh] -> snd sh option link _ -> fail (format "there's more than one shortcut named '{}'" name)+ where+ givenShortcut :: ([Text], Shortcut) -> Bool+ givenShortcut (names, _) = name `elem` names
src/ShortcutLinks/All.hs view
@@ -1,80 +1,126 @@-{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE CPP #-} {-# LANGUAGE DeriveFunctor #-}-{-# LANGUAGE ViewPatterns #-}+{-# LANGUAGE ViewPatterns #-} +{- |+Copyright: (c) 2015-2019 Aelve+ (c) 2019-2020 Kowainik+SPDX-License-Identifier: MPL-2.0+Maintainer: Kowainik <xrom.xkov@gmail.com>+-} module ShortcutLinks.All-(- Result(..),- Shortcut,- allShortcuts,-- -- * Encyclopedias- wikipedia, tvtropes,+ ( Result(..)+ , Shortcut+ , allShortcuts - -- * Social networks- facebook, vk, googleplus,+ -- * Encyclopedias+ , wikipedia+ , tvtropes - -- * Microblogs- twitter, juick,+ -- * Social networks+ , facebook+ , vk+ , googleplus - -- * Major search engines- google, duckduckgo, yandex, baidu,+ -- * Microblogs+ , twitter+ , juick - -- * Programming language libraries- npm, jam, rubygems, pypi, metacpanPod, metacpanRelease, hackage, cargo,- pub, hex, cran, swiprolog, dub, bpkg, pear,+ -- * Major search engines+ , google+ , duckduckgo+ , yandex+ , baidu - -- * Code hosting- github, gitlab, bitbucket,+ -- * Programming language libraries+ , npm+ , jam+ , rubygems+ , pypi+ , metacpanPod+ , metacpanRelease+ , hackage+ , cargo+ , pub+ , hex+ , cran+ , swiprolog+ , dub+ , bpkg+ , pear - -- * OS packages- -- ** Mobile- googleplay,- -- ** Windows- chocolatey,- -- ** OS X- brew,- -- ** Linux- debian, aur, mint, fedora, gentoo, opensuse,+ -- * Code hosting+ , github+ , gitlab+ , bitbucket - -- * Addons- -- ** Text editors- marmalade, melpa, elpa, packagecontrol, atomPackage, atomTheme, jedit, vim,- -- ** Browsers- operaExt, operaTheme, firefox, chrome,+ -- * OS packages+ -- ** Mobile+ , googleplay+ -- ** Windows+ , chocolatey+ -- ** OS X+ , brew+ -- ** Linux+ , debian+ , aur+ , mint+ , fedora+ , gentoo+ , opensuse - -- * Manuals- ghcExt,+ -- * Addons+ -- ** Text editors+ , marmalade+ , melpa+ , elpa+ , packagecontrol+ , atomPackage+ , atomTheme+ , jedit+ , vim+ -- ** Browsers+ , operaExt+ , operaTheme+ , firefox+ , chrome - -- * Standards and databases- rfc, ecma, cve,-)-where+ -- * Manuals+ , ghcExt + -- * Standards and databases+ , rfc+ , ecma+ , cve+ ) where --- General-import Data.Monoid-import Control.Applicative-import Control.Monad-import Data.Maybe--- Text-import qualified Data.Text as T+import Control.Monad (ap, unless, when)+import Data.Char (isAlphaNum, isDigit, isPunctuation, isSpace)+import Data.Maybe (fromMaybe)+import Data.Semigroup ((<>)) import Data.Text (Text)-import Data.Char--- shortcut-links-import ShortcutLinks.Utils +import ShortcutLinks.Utils (format, orElse, replaceSpaces, stripPrefixCI, titleFirst,+ tryStripPrefixCI) -data Result a = Failure String | Warning [String] a | Success a- deriving (Show, Functor)+import qualified Control.Monad.Fail as Fail+import qualified Data.Text as T +data Result a+ = Failure String+ | Warning [String] a+ | Success a+ deriving stock (Show, Functor)+ instance Applicative Result where pure = return (<*>) = ap instance Monad Result where- fail = Failure+#if !(MIN_VERSION_base(4,13,0))+ fail = Fail.fail+#endif return = Success Failure x >>= _ = Failure x Warning wa a >>= f = case f a of@@ -83,6 +129,9 @@ Failure x -> Failure x Success a >>= f = f a +instance Fail.MonadFail Result where+ fail = Failure+ warn :: String -> Result () warn s = Warning [s] () @@ -245,7 +294,7 @@ -} googleplus :: Shortcut googleplus _ q- | T.null q = return $ url+ | T.null q = return url | T.head q == '#' = return $ format "{}/explore/{}" url (T.tail q) | T.head q == '+' = return $ format "{}/{}" url q | T.all isDigit q = return $ format "{}/{}" url q@@ -277,7 +326,7 @@ -} twitter :: Shortcut twitter _ q- | T.null q = return $ url+ | T.null q = return url | T.head q == '#' = return $ format "{}/hashtag/{}" url (T.tail q) | T.head q == '@' = return $ format "{}/{}" url (T.tail q) | otherwise = return $ format "{}/{}" url q@@ -308,7 +357,7 @@ -} juick :: Shortcut juick _ q- | T.null q = return $ url+ | T.null q = return url | T.head q == '*' = return $ format "{}/tag/{}" url (T.tail q) | T.head q == '@' = return $ format "{}/{}" url (T.tail q) | otherwise = return $ format "{}/{}" url q
src/ShortcutLinks/Utils.hs view
@@ -1,75 +1,79 @@-{-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE FlexibleInstances #-} - {- |+Copyright: (c) 2015-2019 Aelve+ (c) 2019-2020 Kowainik+SPDX-License-Identifier: MPL-2.0+Maintainer: Kowainik <xrom.xkov@gmail.com>+ Useful functions when writing your own link rules. -}+ module ShortcutLinks.Utils-(- replaceSpaces,- titleFirst,- tryStripPrefixCI,- stripPrefixCI,- orElse,- format,-)-where+ ( replaceSpaces+ , titleFirst+ , tryStripPrefixCI+ , stripPrefixCI+ , orElse+ , format+ ) where +import Data.Char (isSpace, toUpper)+import Data.Semigroup ((<>))+import Data.Text (Text) --- General-import Data.Monoid--- Text-import Data.Char import qualified Data.Text as T-import Data.Text (Text) --- | Replace spaces in text with chosen character (useful when processing queries containing spaces – they are often turned into “+” or “_”).------ >>> replaceSpaces '_' "hi there"--- "hi___there"+{- | Replace spaces in text with chosen character (useful when processing queries containing spaces – they are often turned into “+” or “_”).++>>> replaceSpaces '_' "hi there"+"hi___there"+-} replaceSpaces :: Char -> Text -> Text replaceSpaces r = T.map (\c -> if isSpace c then r else c) --- | Convert the 1st character of a string to upper case.------ This function is dumber than it could've been; when the 1st character--- doesn't have a single-character uppercase form (like “ß”), it is left--- intact instead of being converted (“Ss” in the case of “ß”). This is good,--- however; for instance, if the “proper” capitalisation rule was applied to--- e.g. Wikipedia links, a link to the article on “ß” would've been rendered--- as “Ss”, which is a redirect to “Schutzstaffel”.+{- | Convert the 1st character of a string to upper case.++This function is dumber than it could've been; when the 1st character+doesn't have a single-character uppercase form (like “ß”), it is left+intact instead of being converted (“Ss” in the case of “ß”). This is good,+however; for instance, if the “proper” capitalisation rule was applied to+e.g. Wikipedia links, a link to the article on “ß” would've been rendered+as “Ss”, which is a redirect to “Schutzstaffel”.+-} titleFirst :: Text -> Text titleFirst s = case T.uncons s of Nothing -> "" Just (c, rest) -> toUpper c `T.cons` rest --- | Strip given prefix from a string, or do nothing if the string doesn't--- have given prefix.------ This function is case-insensitive.------ >>> tryStripPrefixCI "FOO" "FooBAR"--- "BAR"------ >>> tryStripPrefixCI "foo" "quux"--- "quux"+{- | Strip given prefix from a string, or do nothing if the string doesn't+have given prefix.++This function is case-insensitive.++>>> tryStripPrefixCI "FOO" "FooBAR"+"BAR"++>>> tryStripPrefixCI "foo" "quux"+"quux"+-} tryStripPrefixCI :: Text -> Text -> Text tryStripPrefixCI pref str = let pref' = T.toCaseFold pref (str_pref, rest) = T.splitAt (T.length pref') str in if T.toCaseFold str_pref == pref' then rest else str --- | Strip given prefix from a string.------ This function is case-insensitive.------ >>> stripPrefixCI "FOO" "FooBAR"--- Just "BAR"------ >>> stripPrefixCI "foo" "quux"--- Nothing+{- | Strip given prefix from a string.++This function is case-insensitive.++>>> stripPrefixCI "FOO" "FooBAR"+Just "BAR"++>>> stripPrefixCI "foo" "quux"+Nothing+-} stripPrefixCI :: Text -> Text -> Maybe Text stripPrefixCI pref str = let pref' = T.toCaseFold pref@@ -110,13 +114,15 @@ (length params) instance (FormatArg a, FormatType r) => FormatType (a -> r) where- format' str params = \a -> format' str (formatArg a : params)+ format' :: Text -> [Text] -> (a -> r)+ format' str params a = format' str (formatArg a : params) --- | A 'printf'-like function which fully supports 'Text' as an input and--- output format and which uses @{}@ instead of @%@ to indicate--- placeholders. If you use it, don't forget to enable @OverloadedStrings@.------ This is a lightweight alternative to something like the text-format--- package, and it's closer to 'printf' and simpler to use.+{- | A 'printf'-like function which fully supports 'Text' as an input and+output format and which uses @{}@ instead of @%@ to indicate+placeholders. If you use it, don't forget to enable @OverloadedStrings@.++This is a lightweight alternative to something like the text-format+package, and it's closer to 'printf' and simpler to use.+-} format :: FormatType r => Text -> r format str = format' str []