packages feed

nyan-interpolation (empty) → 0.9

raw patch · 10 files changed

+1077/−0 lines, 10 filesdep +HUnitdep +basedep +fmt

Dependencies added: HUnit, base, fmt, haskell-src-exts, haskell-src-meta, nyan-interpolation, nyan-interpolation-core, tasty, tasty-hunit-compat, template-haskell, text

Files

+ LICENSE view
@@ -0,0 +1,373 @@+Mozilla Public License Version 2.0+==================================++1. Definitions+--------------++1.1. "Contributor"+    means each individual or legal entity that creates, contributes to+    the creation of, or owns Covered Software.++1.2. "Contributor Version"+    means the combination of the Contributions of others (if any) used+    by a Contributor and that particular Contributor's Contribution.++1.3. "Contribution"+    means Covered Software of a particular Contributor.++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.++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.
+ nyan-interpolation.cabal view
@@ -0,0 +1,77 @@+cabal-version: 2.0++-- This file has been generated from package.yaml by hpack version 0.33.0.+--+-- see: https://github.com/sol/hpack+--+-- hash: 191c85a1a5dfccaa3abfb718b94a0a57cdb576f10a674129e73519fc12ed58c6++name:           nyan-interpolation+version:        0.9+synopsis:       Flexible production-scale string interpolation library+description:    Interpolation library tuneable to your project and your best practices. It supports custom rendering (via Buildable, Show), numerious modification options (like spaces and indentation stripping), and more.+category:       Interpolation, Text+homepage:       https://github.com/serokell/nyan-interpolation#readme+bug-reports:    https://github.com/serokell/nyan-interpolation/issues+author:         Serokell+maintainer:     Serokell <hi@serokell.io>+copyright:      2022 Serokell <https://serokell.io>+license:        MPL-2.0+license-file:   LICENSE+build-type:     Simple++source-repository head+  type: git+  location: https://github.com/serokell/nyan-interpolation++library+  exposed-modules:+      Text.Interpolation.Nyan+      Text.Interpolation.Nyan.Full+      Text.Interpolation.Nyan.Show+      Text.Interpolation.Nyan.Tutorial+  other-modules:+      Paths_nyan_interpolation+  autogen-modules:+      Paths_nyan_interpolation+  hs-source-dirs:+      src+  default-extensions: AllowAmbiguousTypes BangPatterns BlockArguments ConstraintKinds DataKinds DefaultSignatures DeriveDataTypeable DeriveGeneric DerivingStrategies FlexibleContexts FlexibleInstances FunctionalDependencies GeneralizedNewtypeDeriving LambdaCase MultiParamTypeClasses MultiWayIf NamedFieldPuns OverloadedStrings RankNTypes RecordWildCards ScopedTypeVariables StandaloneDeriving TemplateHaskell TupleSections TypeFamilies UndecidableInstances ViewPatterns TypeApplications TypeOperators QuasiQuotes+  ghc-options: -Weverything -Wno-missing-export-lists -Wno-missing-exported-signatures -Wno-missing-import-lists -Wno-missed-specialisations -Wno-all-missed-specialisations -Wno-unsafe -Wno-safe -Wno-missing-local-signatures -Wno-monomorphism-restriction -Wno-implicit-prelude -Wno-prepositive-qualified-module -Wno-missing-safe-haskell-mode -Wno-unused-packages+  build-depends:+      base <4.15+    , fmt+    , haskell-src-exts+    , haskell-src-meta+    , nyan-interpolation-core+    , template-haskell+    , text+  default-language: Haskell2010++test-suite nyan-interpolation-tests+  type: exitcode-stdio-1.0+  main-is: Main.hs+  other-modules:+      Test.Interpolator+      Test.ShowInterpolator+      Tree+      Paths_nyan_interpolation+  hs-source-dirs:+      tests+  default-extensions: AllowAmbiguousTypes BangPatterns BlockArguments ConstraintKinds DataKinds DefaultSignatures DeriveDataTypeable DeriveGeneric DerivingStrategies FlexibleContexts FlexibleInstances FunctionalDependencies GeneralizedNewtypeDeriving LambdaCase MultiParamTypeClasses MultiWayIf NamedFieldPuns OverloadedStrings RankNTypes RecordWildCards ScopedTypeVariables StandaloneDeriving TemplateHaskell TupleSections TypeFamilies UndecidableInstances ViewPatterns TypeApplications TypeOperators QuasiQuotes+  ghc-options: -Weverything -Wno-missing-export-lists -Wno-missing-exported-signatures -Wno-missing-import-lists -Wno-missed-specialisations -Wno-all-missed-specialisations -Wno-unsafe -Wno-safe -Wno-missing-local-signatures -Wno-monomorphism-restriction -Wno-implicit-prelude -Wno-prepositive-qualified-module -Wno-missing-safe-haskell-mode -Wno-unused-packages+  build-tool-depends:+      tasty-discover:tasty-discover+  build-depends:+      HUnit+    , base <4.15+    , fmt+    , haskell-src-exts+    , haskell-src-meta+    , nyan-interpolation+    , nyan-interpolation-core+    , tasty+    , tasty-hunit-compat+    , template-haskell+    , text+  default-language: Haskell2010
+ src/Text/Interpolation/Nyan.hs view
@@ -0,0 +1,104 @@+-- SPDX-FileCopyrightText: 2022 Serokell <https://serokell.io/>+--+-- SPDX-License-Identifier: MPL-2.0++{- | Flexible interpolation quoter.++>>> import Text.Interpolation.Nyan+>>> let what = "nyan" in [int||Let's #{what}!|]+"Let's nyan!"++This package comes as an attempt to satisfy numerious needs of a production-scale code.++For the full tutorial, see "Text.Interpolation.Nyan.Tutorial". And further goes+the basic introduction.++== Use of 'Buildable'. By default++Values are interpolated via 'Formatting.Buildable.Buildable' typeclass as+it is more efficient and dedicated to human-readable errors.++Using 'Show' is still available as:++>>> [int||Shown value: #s{value}|]++The produced text is also polymorphic by default and can be 'Data.Text.Text',+lazy 'Data.Text.Lazy.Text', 'String', 'Data.Text.Lazy.Builder.Builder' or other type.++== Multiline text++By default, the interpolator strips indentation, one leading newline, and+spaces before @|]@:++>>> :{+  [int||+    List:+      - a+      - b+   |]+:}+"List:\n  - a\n  - b\n"++When necessary, this behaviour can be fine-tuned with switches.++== Switches++The section after @int@ stands for the switches set.++For instance, to enable spaces trimming:++>>> [int|s| No extra spaces here |]+"No extra spaces here"++To fix the return type to be 'Text':++>>> [int|t|My text|]++To preview the resulting text at compilation stage, pass @!@ switch:++>>> [int|s!| My text: #{value}   |]+Reports "My text: ..."++This is reported as a build error, and substitutions are not performed.+Put @!@ twice to also see all the invisible characters.++There are much more switches supported. To quicky ask for a help on switches on+the go, put @?@ switch into the interpolator:++>>> [int|?||]+Fails with the help on switches++== Customization++This interpolator allows for a variety of tunning, therefore such a name for+the library.++* Aside from 'Formatting.Buildable.Buildable' and 'Show' support, one can define their own so-called+/rendering modes/.+* The existing rendering modes can be hidden or grouped into modesets.+  For instance, there is a modeset with 'Show' taken as the default rendering+  mode; it is used as the basic modeset in "Text.Interpolation.Nyan.Show" module.+* The set of switches enabled by default is also customizable.++Generally, once the user gets comfortable with the library, we encourage them+to define their own variation of the interpolator that would serve their+preferences, and include it in their custom preludes or util modules.++-}+module Text.Interpolation.Nyan+  ( int+  , module RModes+  ) where++import Text.Interpolation.Nyan.Core+import Text.Interpolation.Nyan.RModes.Buildable as RModes+import Text.Interpolation.Nyan.RModes.CommonExtra as RModes++import Text.Interpolation.Nyan.Full++-- | The interpolator.+int :: QuasiQuoter+int = mkInt defaultInterpolatorOptions+  { defaultSwitchesOptions = recommendedDefaultSwitchesOptions+  , valueInterpolator = fullHaskellValueInterpolator+  }
+ src/Text/Interpolation/Nyan/Full.hs view
@@ -0,0 +1,82 @@+-- SPDX-FileCopyrightText: 2022 Serokell <https://serokell.io/>+--+-- SPDX-License-Identifier: MPL-2.0++{-# LANGUAGE CPP #-}++-- | Contains full-fledged interpolator.+module Text.Interpolation.Nyan.Full+  ( fullHaskellValueInterpolator+  ) where++import Control.Monad (when)+import Data.Char (isSpace)+import qualified Data.Text as T+import Language.Haskell.Exts.Parser (ParseMode (extensions, parseFilename),+                                     ParseResult (ParseFailed, ParseOk), defaultParseMode,+                                     parseExpWithMode)+import Language.Haskell.Meta.Syntax.Translate (toExp)+import Language.Haskell.TH (extsEnabled)++#if MIN_VERSION_haskell_src_meta(0,8,9)+import Data.Maybe (mapMaybe)+import Language.Haskell.Exts.Extension (Extension (..), Language (..))+import Language.Haskell.Exts.Parser (baseLanguage)+import Language.Haskell.Meta.Extensions (fromExtension)+#endif++import Text.Interpolation.Nyan.Core++{- | Interpolates strings containing arbitrary Haskell expressions.++This is used in the interpolator provided by "Text.Interpolation.Nyan" module.++Known issues:++* If @haskell-src-meta@ prior to @0.8.9@ version is used, a default set of+  extensions for the given Haskell dialect (e.g. Haskell2010) is used+  for the interpolated values.+  With the modern version of @haskell-src-meta@, we do our best to be trasparent+  and pick the extensions enabled in the module where interpolator is called+  (some rare extensions may still be unsupported).++-}+fullHaskellValueInterpolator :: ValueInterpolator+fullHaskellValueInterpolator = ValueInterpolator $ \txt -> do+  when (T.all isSpace txt) $+    fail "Empty placeholder"+  enabledExtensions <- extsEnabled+  let parseMode = defaultParseMode+        { parseFilename = "interpolator placeholder"+#if MIN_VERSION_haskell_src_meta(0,8,9)+        , baseLanguage = HaskellAllDisabled+#else+          -- use default language+#endif+        , extensions = providedExtensions enabledExtensions+        }+  case parseExpWithMode parseMode (T.unpack txt) of+    ParseFailed _loc e -> fail e+    ParseOk res        -> return (toExp res)+  where+    providedExtensions =+#if MIN_VERSION_haskell_src_meta(0,8,9)+      map EnableExtension . mapMaybe fromExtension+#else+      -- There is no easy way to do the conversion between template-haskell's+      -- and haskell-src-exts's Extension types, so using only language-default+      -- extensions (e.g. Haskell2010).+      --+      -- It may be tempting to hardcode some common extensions, but we better+      -- not do that, otherwise on @haskell-src-meta@ bump the user's code will+      -- start relying on the extensions enabled in the module and so may break,+      -- which would be extremly bad if occurs in a library.+      --+      -- Meanwhile, using all the language-default extensions seems safe,+      -- they all seem to be supported by relatively recent versions of+      -- @haskell-src-meta@. An issue will fire only if the user disabled+      -- some extension in the module, and this starts affecting the interpolator+      -- after the bump; let's treat that as a non-caught timely bug in the+      -- user's code.+      \_enabledExts -> []+#endif
+ src/Text/Interpolation/Nyan/Show.hs view
@@ -0,0 +1,21 @@+-- SPDX-FileCopyrightText: 2022 Serokell <https://serokell.io/>+--+-- SPDX-License-Identifier: MPL-2.0++{- | Exports the default interpolator + Show-oriented rendering modes++>>> data Ty = Ty { val :: Int }+>>>    deriving stock Show+>>>+>>> [int||Value is #{Ty 5}]+"Value is Ty {val = 5}"++-}+module Text.Interpolation.Nyan.Show+  ( int+  , module RModes+  ) where++import Text.Interpolation.Nyan (int)+import Text.Interpolation.Nyan.RModes.CommonExtra as RModes+import Text.Interpolation.Nyan.RModes.Show as RModes
+ src/Text/Interpolation/Nyan/Tutorial.hs view
@@ -0,0 +1,344 @@+-- SPDX-FileCopyrightText: 2022 Serokell <https://serokell.io/>+--+-- SPDX-License-Identifier: MPL-2.0++{-# OPTIONS_GHC -Wno-unused-imports #-}+++{- | Tutorial on the nyan-interpolation.++>>> import Nyan.Interpolation+>>>+>>> let who = "world"+>>> in [int||Hello #{who}!|]+"Hello world!"++Variables can be inserted using @#{ ... }@ syntax.++For the meaning of two @||@ after @int@, see the [Switches](#switches) section.++Defaults are:++* Values put via @#{ ... }@ will be rendered with the help of 'Buildable' instance.+* Resulting type will be any type that has 'FromBuilder' instance.+* If multiline text is provided, its indentation, leading newline and trailing spaces are stripped:++>>> :{+  putStrLn [int||+      Yay+      Here goes+        my text+      and ends here.+  |]  -- the position of the enclosing `|]` does not matter+:}+Yay+Here goes+  my text+and ends here.+<BLANKLINE>++Note that the module with interpolator is assumed to be imported with an+implicit import list. This should not spoil your namespace, @int@ is the only+exported definition you may likely get collisions with.++== Values rendering++If necessary, various rendering means can be used for values:++* @#{val}@ uses 'Buildable' instance;+* @#s{val}@ uses 'Show' instance;+* @#l{"text"}@ for text literals;+* @#n{5}@ for decimal numeric literals;++We refer to the text immediately following the @#@ sign as to /rendering mode/.++Rules for rendering modes are not fixed and depend on the imported interpolation module.+If you don't like 'Buildable' and prefer the conventional 'Show' typeclass,+"Text.Interpolation.Nyan.Show" module is your choice.++Also, you can define your own rules for rendering modes as described in [Adding custom rendering modes](#custom-rendering-modes) section.+++== Escaping++If you don't want @#{@ to be interpreted as beginning of an interpolated piece, you can escape it:++>>> [int|| My code: \#{ code } |]+" My code: #{ code } "++Newlines can be escaped to avoid their appearance in the rendered text:++>>> :{+  [int||+    Text starts here \+    and continues here+  |]+:}+"Text starts here and continues here"++Note that [@n@ switch](#n-switch) provides another, often a more convenient way+for controlling newlines.++Finally, slash itself is also subject to escaping.++>>> [int|| My code: \\#{ letter } |]+" My code: \s "+++#switches#++== Switches++Interpolated text starts from the swithes section.+Switches section consists of a sequence of characters that ends with @|@.++>>> [int|sb| Hey! ]++In most cases, lowercase letter stands for enabling a switch, while uppercase+letter - for disabling it.++Available switches:++==== s (trim [s]paces)++Trims space-like characters around the text.++>>> [int|s| The text  |]+"The text"++Newlines are affected too:++>>> :{+  [int|s|+<BLANKLINE>+    My text+<BLANKLINE>+  |]+:}+"My text"++==== D (no inten[d]ation stripping)++Indentation will not be stripped.++>>> :{+  [int|D|+    List:+      * Item 1+      * Item 2+  |]+:}+"    List:\n      * Item 1\n     * Item 2\n"++Compare with:++>>> :{+  [int||+    List:+      * Item 1+      * Item 2+  |]+:}+"List:\n  * Item 1\n  * Item 2\n"+++==== A (no first newline stripping)++By default, the leading newline is stripped, allowing for neater rendering of+multiline interpolators. When the option is disabled via passing @A@ switch,+the initial line feed will appear in the resulting text.++>>> :{+  [int|A|+    The sentence.+  |]+:}+"\nThe sentence.\n"++==== Z (no last line stripping)++Similarly to the previous option, by default he position of the trailing @|]@+does not affect the result.+When the option is disabled via passing @Z@ switch, spaces at the last line+will be preserved.++>>> :{+  [int|Z|+    Foo+  Bar+    |]+:}+"  Foo\nBar\n  "++#n-switch#++==== n (special [n]ewlines)++Each substring of several newlines in a row will be trimmed by one newline.+Adjacent lines will be glued together with space.++This facilitates formatting in case code snippets are large.++>>> :{+  [int|n|+    Value 1 is #{veryLongComputationOfValue1},+    while value 2 is #{+      veryLongComputationOfValue2+    }+<BLANKLINE>+    Here we go.+<BLANKLINE>+<BLANKLINE>+    That's it.+ |]+:}+"Value 1 is 5, while value 2 is 10.\nHere we go.\n\nThat's it."++==== m ([m]onadic)++Accept monadic values.++>>> putStrLn =<< [int|m|Content of foo: #{readFile "foo"}|]++>>> serverConfig & [int|m|Connected to server #{name} at #{host . addr}:#{port . addr}|]++To be stricter, this switch requires only @Applicative@ instance.++In case monadic actions have side effects, they will be applied in the same order+in which braces appear in the quoter. /But you are not going to use this behaviour, don't you?/++==== t (return [t]ext)++The quoter will return concrete t'Text'.++==== T (return lazy [T]ext)++The quoter will return concrete lazy t'LT.Text'.++==== b (return [b]uilder)++The quoter will return concrete t'Builder'.++==== B (return From[B]uildable)++The quoter will return any type with t'FromBuilder' instance.++==== ! (preview)++Quoter will show as an error (non-blocking for the module's build) showing how the+resulting text looks like with all the enabled switches+(but without substitutions).++Passing the second @!@ will additionally highlight invisible characters.++==== ? (help)++Fail and remind what switches are available.++==== Switches interaction++Few rules to know here.++* Spaces trimming is applied last, it never affects whether other switches will+fire or not:++>>> :{+  [int|s|+    Text 1+    Text 2+  |]+:}+"Text 1\nText 2"++* The switch for stripping trailing whitespaces is applied first and+affects indentation stripping to also ignore the line with @|]@:++>>> :{+  [int||+    My text+  |]  -- this is safe, minimal detected indentation is still 2+:}++* Newlines reduction (@n@) is applied additionally to leading newline stripping (@a@):++>>> :{+  [int|n|+<BLANKLINE>+<BLANKLINE>+  Value 1 is #{veryLongComputationOfValue1},+  value 2 is #{veryLongComputationOfValue2}+<BLANKLINE>+ |]+:}+"\nValue 1 is 5, value 2 is 10\n"+++=== Customizing the interpolator++There are two main vectors of customization:++* Changing the quasi-quoter, this includes default switches set, how values are interpolated, e.t.c.+* Editing available rendering modes.++The source of "Text.Interpolation.Nyan" can be a good example of grouping those+to provide a ready-for-use interpolator.++==== Changing default switches++You can use 'mkInt' to supply the desired set of default switches and thus create your own interpolator for the project-wide use.++@+import Text.Interpolation.Nyan.Core++int :: QuasiQuoter+int = mkInt defaultInterpolationOptions+  { switchesOptions = basicDefaultSwitchesOptions+    { spacesTrimming = True+    , returnType = ConcreteText+    }+  }++-- In another module --+-- Spaces trimmed, no indentation stripped, returns @Text@+[int|| My text |]++-- Spaces not trimmed, indentation stripped, returns @FromBuilder a => a@+[int|SdB| My text |]+@+++#custom-rendering-modes#++==== Adding custom rendering modes++Rendering mode @xxx@ refers to whatever @rmode'xxx@ value that is available in scope.++For instance, the rendering mode for 'Show' is declared as++@+rmode's :: Show a => RMode a+rmode's = RMode $ build . show+@++Importing this @rmode's@ value will make @s@ mode with 'Show' semantics usable.++Declaring a rendering mode locally will also work:++>>> rmode'yay :: RMode Builder+>>> rmode'yay = RMode \t -> "*" <> t <> "!*"+>>>+>>> [int|t|Say #yay{"hello"}|]+"Say *hello!*"++You can declare /modesets/ ⁠— modules that export several rendering modes.+The user can then easily pick all or some of the modes by importing that module.++-}+module Text.Interpolation.Nyan.Tutorial where++import Data.Text (Text)+import qualified Data.Text.Lazy as LT+import Fmt (Buildable, Builder)+import Fmt.Internal.Core (FromBuilder)++import Text.Interpolation.Nyan.Core (mkInt)
+ tests/Main.hs view
@@ -0,0 +1,14 @@+-- SPDX-FileCopyrightText: 2022 Serokell <https://serokell.io/>+--+-- SPDX-License-Identifier: MPL-2.0++module Main+  ( main+  ) where++import Test.Tasty (defaultMain)++import Tree (tests)++main :: IO ()+main = defaultMain =<< tests
+ tests/Test/Interpolator.hs view
@@ -0,0 +1,34 @@+-- SPDX-FileCopyrightText: 2022 Serokell <https://serokell.io/>+--+-- SPDX-License-Identifier: MPL-2.0++-- | Tests on interpolator - ability to interpolate expressions.+module Test.Interpolator where++import Test.HUnit ((@?=))+import Test.Tasty (TestTree, testGroup)+import Test.Tasty.HUnit (testCase)++import Text.Interpolation.Nyan++test_DefaultInterpolator :: TestTree+test_DefaultInterpolator = testGroup "Default interpolator"+  [ testCase "Simple expr" do+      [int|t|#d{1 + 2}|]+        @?= "3"++  , testCase "Accessing fields" do+      let v = (1, 2)+      [int|t|First: #d{fst v}, second: #d{snd v}|]+        @?= "First: 1, second: 2"++  , testCase "Accessing fields 2" do+      let v = (1, 2)+      [int|tm|X = #d{fst}, Y = #d{succ . snd}|] v+        @?= "X = 1, Y = 3"++  , testCase "Operators' priorities are accounted" do+      [int|t|#d{succ . succ $ 5 + 7 `div` 2}|]+        @?= "10"++  ]
+ tests/Test/ShowInterpolator.hs view
@@ -0,0 +1,23 @@+-- SPDX-FileCopyrightText: 2022 Serokell <https://serokell.io/>+--+-- SPDX-License-Identifier: MPL-2.0++-- | Tests on interpolator with Show-oriented rendering modes.+module Test.ShowInterpolator where++import Test.HUnit ((@?=))+import Test.Tasty (TestTree, testGroup)+import Test.Tasty.HUnit (testCase)++import Text.Interpolation.Nyan.Show++data Ty = Ty { val :: Int }+  deriving stock Show++test_ShowInterpolator :: TestTree+test_ShowInterpolator = testGroup "Show interpolator"+  [ testCase "Simple ADT" do+      [int|t|#{Ty 5}|]+        @?= "Ty {val = 5}"++  ]
+ tests/Tree.hs view
@@ -0,0 +1,5 @@+-- SPDX-FileCopyrightText: 2022 Serokell <https://serokell.io/>+--+-- SPDX-License-Identifier: MPL-2.0++{-# OPTIONS_GHC -F -pgmF tasty-discover -optF --tree-display -optF --generated-module -optF Tree #-}