diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -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. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/specs/Specs.hs b/specs/Specs.hs new file mode 100644 --- /dev/null +++ b/specs/Specs.hs @@ -0,0 +1,1 @@ +{-# OPTIONS_GHC -F -pgmF hspec-discover #-} diff --git a/src/Data/Text/ICU/Replace.hs b/src/Data/Text/ICU/Replace.hs new file mode 100644 --- /dev/null +++ b/src/Data/Text/ICU/Replace.hs @@ -0,0 +1,191 @@ +{-# LANGUAGE GeneralizedNewtypeDeriving #-} +{-# LANGUAGE OverloadedStrings #-} + +{-| + +This implements a common DSL for regular expression replacement text. This +is represented with the 'Replace' data type. It also implements the +'IsString' interface, so if 'OverloadedStrings' is on, you can use a raw +string to build the replacement. + +-} + + +module Data.Text.ICU.Replace + ( + -- * @OverloadedStrings@ Syntax + -- $doc + + -- * Types + Replace + + -- * High-level interface + , replace + , replace' + , replaceAll + , replaceAll' + + -- * Low-level interface + , rgroup + , rtext + , rstring + , rfn + , rtfn + , rbuilder + ) where + + +import Control.Applicative +import Control.Arrow +import Data.Attoparsec.Text +import Data.Foldable +import Data.Monoid +import Data.String +import qualified Data.Text as T +import Data.Text.ICU +import qualified Data.Text.ICU as ICU +import qualified Data.Text.Lazy as TL +import qualified Data.Text.Lazy.Builder as TB + + +-- | A 'Replace' instance is a function from a regular expression match to +-- a 'Data.Text.Lazy.Builder.Builder'. This naturally forms a 'Monoid', so +-- they're easy to combine. +-- +-- 'Replace' also implements 'IsString', so raw strings can be used to +-- construct them. +newtype Replace = Replace { unReplace :: Match -> TB.Builder } deriving + (Monoid) + +instance IsString Replace where + fromString = parseReplace . T.pack + +-- | Execute a regular expression on a 'Data.Text.Text' and replace the +-- first match. +replace :: Regex -- ^ The regular expression to match. + -> Replace -- ^ The specification to replace it with. + -> T.Text -- ^ The text to operate on. + -> T.Text -- ^ The text with the first match replaced. +replace re r t = maybe t (replace' r) $ ICU.find re t + +-- | Replace one regular expression match with the 'Replace'. +replace' :: Replace -- ^ The specification to replace it with. + -> Match -- ^ The match to replace. + -> T.Text -- ^ The text with the match replaced. +replace' r m = finish (Last (Just m)) $ unReplace r m + +-- | Execute a regular expression on a 'Data.Text.Text' and replace all +-- matches. +replaceAll :: Regex -- ^ The regular expression to match. + -> Replace -- ^ The specification to replace it with. + -> T.Text -- ^ The text to operate on. + -> T.Text -- ^ The text with all matches replaced. +replaceAll re r t = case ICU.findAll re t of + [] -> t + ms -> replaceAll' r ms + +-- | Replace all regular expression matches with the 'Replace'. +replaceAll' :: Replace -- ^ The specification to replace it with. + -> [Match] -- ^ The matches to replace. + -> T.Text -- ^ The text with all matches replaced. +replaceAll' r ms = uncurry finish $ foldMap (Last . Just &&& build r) ms + where + build :: Replace -> Match -> TB.Builder + build repl m = TB.fromText (ICU.span m) <> unReplace repl m + +-- This handles the last match by including not only the match's prefix and +-- the replacement text, but also the suffix trailing the match. +finish :: Last Match -> TB.Builder -> T.Text +finish m b = + TL.toStrict . TB.toLazyText . mappend b . TB.fromText . fold + $ suffix 0 =<< getLast m + +-- | Create a 'Replace' that inserts a regular expression group. +rgroup :: Int -- ^ The number of the group in a regular expression. + -> Replace -- ^ The 'Replace' that inserts a group's match. +rgroup g = Replace $ fold . fmap TB.fromText . group g + +-- | Create a 'Replace' that inserts static 'Data.Text.Text'. +rtext :: T.Text -- ^ The static 'Data.Text.Text' to insert. + -> Replace -- ^ The 'Replace' that inserts the static 'Data.Text.Text'. +rtext = rbuilder . TB.fromText + +-- | Create a 'Replace' that inserts a static 'String'. +rstring :: String -- ^ The static 'String' to insert. + -> Replace -- ^ The 'Replace' that inserts the static 'String'. +rstring = rbuilder . TB.fromString + +-- | Create a 'Replace' from a function that transforms a 'Match' into +-- a 'Data.Text.Lazy.Builder.Builder'. +rfn :: (Match -> TB.Builder) -- ^ The function that creates the replacement text. + -> Replace -- ^ The 'Replace' based off that function. +rfn = Replace + +-- | Create a 'Replace' From a function that transforms a 'Match' into +-- a 'Data.Text.Text'. +rtfn :: (Match -> T.Text) -- ^ The function that creates the replacement text. + -> Replace -- ^ The 'Replace' based off that function. +rtfn = Replace . (TB.fromText .) + +-- | Create a 'Replace' that inserts a static 'Data.Text.Lazy.Builder.Builder'. +rbuilder :: TB.Builder -- ^ The 'Data.Text.Lazy.Builder.Builder' to insert. + -> Replace -- ^ The 'Replace' that inserts the static + -- 'Data.Text.Lazy.Builder.Builder'. +rbuilder = Replace . const + +-- | This parses a 'Data.Text.Text' into a 'Replace' structure. +-- +-- Generally, input text is considered to be static. +-- +-- However, groups from the regular expression's matches can be insert +-- using @$1@ (to insert the first group) or @${7}@ (to insert the seventh +-- group). +-- +-- Dollar signs can be included in the output by doubling them (@$$@). +parseReplace :: T.Text -> Replace +parseReplace t = either (const $ rtext t) id + $ parseOnly (replacement <* endOfInput) t + +-- A replacement. +replacement :: Parser Replace +replacement = mconcat <$> many (dollarGroup <|> raw) + +-- A @\$\d+@ or @\$\{\d+\}@ group. This could also be an escaped dollar +-- sign (@$$@). +dollarGroup :: Parser Replace +dollarGroup = char '$' *> (grp <|> escaped) + where curly = char '{' *> decimal <* char '}' + grp = rgroup <$> (decimal <|> curly) + escaped = rtext . T.singleton <$> char '$' + +-- A raw input string. It must contain no dollar signs (@$@). +raw :: Parser Replace +raw = rtext <$> takeWhile1 (/= '$') + + +-- $doc +-- +-- The syntax used with 'OverloadedStrings' is meant to be similar to that +-- used in other regular expression libraries in other programming +-- languages. +-- +-- Generally, input text is considered to be static. +-- +-- >>> replaceAll "a" "b" "aaa" +-- "bbb" +-- >>> replaceAll "ab" "ba" "cdababcd" +-- "cdbabacd" +-- +-- However, groups from the regular expression's matches can be insert +-- using @$1@ (to insert the first group) or @${7}@ (to insert the seventh +-- group). +-- +-- >>> replaceAll "(.*), (.*)" "$2 $1" "Beeblebrox, Zaphod" +-- "Zaphod Beeblebrox" +-- >>> replaceAll "4(\\d)" "${1}4" "7458" +-- "7548" +-- +-- Dollar signs can be included in the output by doubling them (@$$@). +-- +-- >>> replaceAll "(\\d+\\.\\d+)" "$$$1" "9.99" +-- "$9.99" diff --git a/text-regex-replace.cabal b/text-regex-replace.cabal new file mode 100644 --- /dev/null +++ b/text-regex-replace.cabal @@ -0,0 +1,55 @@ +-- Initial text-regex-replace.cabal generated by cabal init. For further +-- documentation, see http://haskell.org/cabal/users-guide/ + +name: text-regex-replace +version: 0.1.0.0 +synopsis: Easy replacement when using text-icu regexes. +description: + This provides a convenient API for doing replacements off of a regular + expression, similar to what regex libraries in other languages provide. + . + At this point, this hasn't been used enough to have any idea of its + performance. Caveat emptor. +license: Apache-2.0 +license-file: LICENSE +author: Eric Rochester +maintainer: erochest@gmail.com +-- copyright: +category: Data, Text +build-type: Simple +-- extra-source-files: +cabal-version: >=1.10 + +library + exposed-modules: Data.Text.ICU.Replace + -- other-modules: + -- other-extensions: + build-depends: base >= 4.7 && <4.8 + , attoparsec >= 0.12 && <0.13 + , text >= 1.2 && <1.3 + , text-icu >= 0.7 && <0.8 + hs-source-dirs: src + default-language: Haskell2010 + +test-suite text-regex-replace-specs + type: exitcode-stdio-1.0 + ghc-options: -threaded -rtsopts + hs-source-dirs: specs + main-is: Specs.hs + build-depends: base == 4.7.* + , text-regex-replace + , QuickCheck + , smallcheck + , hspec + , text >= 1.2 && <1.3 + , text-icu >= 0.7 && <0.8 + -- , tasty + -- , tasty-quickcheck + -- , tasty-smallcheck + default-language: Haskell2010 + + +source-repository this + type: git + tag: master + location: git://github.com/erochest/text-regex-replace.git