Make benchmarks compatible with text-builder-1.0

Author: Bodigrim

README.md

@@ -59,14 +59,14 @@ Let's benchmark builders, which concatenate all `Char` from `minBound` to `maxBo
 ```haskell
 #!/usr/bin/env cabal
 {- cabal:
-build-depends: base, tasty-bench, text, text-builder, text-builder-linear
+build-depends: base, tasty-bench, text, text-builder >= 1.0, text-builder-linear
 ghc-options: -O2
 -}
 
 import qualified Data.Text as T
 import qualified Data.Text.Lazy as TL
 import qualified Data.Text.Lazy.Builder as TLB
-import qualified Text.Builder as TB
+import qualified TextBuilder as TB
 import qualified Data.Text.Builder.Linear as TBL
 import System.Environment (getArgs)
 import Test.Tasty.Bench
@@ -79,7 +79,7 @@ main :: IO ()
 main = defaultMain
   [ mkBench "text, lazy" TLB.singleton (fromIntegral . TL.length . TLB.toLazyText)
   , mkBench "text, strict" TLB.singleton (T.length . TL.toStrict . TLB.toLazyText)
-  , mkBench "text-builder" TB.char (T.length . TB.run)
+  , mkBench "text-builder" TB.char (T.length . TB.toText)
   , mkBench "text-builder-linear" TBL.fromChar (T.length . TBL.runBuilder)
   ]
 ```
@@ -117,7 +117,7 @@ The last result corresponds to the current package. We generate a strict
 high. Nevertheless, it is already faster than the usual `Text` builder with
 strict consumer and does not strain the garbage collector.
 
-Things get very different if we remove `{-# INLINE mkBench #-}`:
+As of GHC 9.10, things get very different if we remove `{-# INLINE mkBench #-}`:
 
 ```
 text, lazy:

bench/BenchChar.hs

@@ -19,7 +19,8 @@ import qualified Data.Text.Internal.Fusion as Fusion
 import Test.Tasty.Bench
 
 #ifdef MIN_VERSION_text_builder
-import qualified Text.Builder
+import qualified TextBuilder
+import qualified TextBuilderDev as TextBuilder
 #endif
 
 #ifdef MIN_VERSION_bytestring_strict_builder
@@ -44,10 +45,10 @@ benchLazyBuilderBS = B.toStrict . B.toLazyByteString . go mempty
 
 #ifdef MIN_VERSION_text_builder
 benchStrictBuilder ∷ Int → T.Text
-benchStrictBuilder = Text.Builder.run . go mempty
+benchStrictBuilder = TextBuilder.toText . go mempty
   where
     go !acc 0 = acc
-    go !acc n = let ch = chr n in go (Text.Builder.char ch <> (acc <> Text.Builder.char ch)) (n - 1)
+    go !acc n = let ch = chr n in go (TextBuilder.char ch <> (acc <> TextBuilder.char ch)) (n - 1)
 #endif
 
 #ifdef MIN_VERSION_bytestring_strict_builder
@@ -73,7 +74,7 @@ mkGroupChar n = bgroup (show n)
   [ bench "Data.Text.Lazy.Builder" $ nf benchLazyBuilder n
   , bench "Data.ByteString.Builder" $ nf benchLazyBuilderBS n
 #ifdef MIN_VERSION_text_builder
-  , bench "Text.Builder" $ nf benchStrictBuilder n
+  , bench "TextBuilder" $ nf benchStrictBuilder n
 #endif
 #ifdef MIN_VERSION_bytestring_strict_builder
   , bench "ByteString.StrictBuilder" $ nf benchStrictBuilderBS n
@@ -110,13 +111,13 @@ benchCharsLazyBuilderBS = B.toStrict . B.toLazyByteString . go mempty
 
 #ifdef MIN_VERSION_text_builder
 benchCharsStrictBuilder ∷ Int → T.Text
-benchCharsStrictBuilder = Text.Builder.run . go mempty
+benchCharsStrictBuilder = TextBuilder.toText . go mempty
   where
     go !acc 0 = acc
     go !acc n = let ch = chr n in go (replicateChar ch <> (acc <> replicateChar ch)) (n - 1)
 
     -- [TODO] Is there a better way?
-    replicateChar ch = Text.Builder.padFromRight (fromIntegral charCount) ch mempty
+    replicateChar ch = TextBuilder.padFromRight (fromIntegral charCount) ch mempty
 #endif
 
 {- [TODO]
@@ -144,7 +145,7 @@ mkGroupChars n = bgroup (show n)
   [ bench "Data.Text.Lazy.Builder" $ nf benchCharsLazyBuilder n
   -- , bench "Data.ByteString.Builder" $ nf benchCharsLazyBuilderBS n
 #ifdef MIN_VERSION_text_builder
-  , bench "Text.Builder" $ nf benchCharsStrictBuilder n
+  , bench "TextBuilder" $ nf benchCharsStrictBuilder n
 #endif
 -- #ifdef MIN_VERSION_bytestring_strict_builder
 --   , bench "ByteString.StrictBuilder" $ nf benchCharsStrictBuilderBS n
@@ -180,13 +181,13 @@ benchPaddingLazyBuilderBS = B.toStrict . B.toLazyByteString . go mempty
 
 #ifdef MIN_VERSION_text_builder
 benchPaddingStrictBuilder ∷ Int → T.Text
-benchPaddingStrictBuilder = Text.Builder.run . go mempty 0
+benchPaddingStrictBuilder = TextBuilder.toText . go mempty 0
   where
     go !acc !_ 0 = acc
     go !acc l  n =
       let ch = chr n
           !l' = l + 2 * fromIntegral charCount
-      in go (Text.Builder.padFromRight l' ch (Text.Builder.padFromLeft (l + fromIntegral charCount) ch acc))
+      in go (TextBuilder.padFromRight l' ch (TextBuilder.padFromLeft (l + fromIntegral charCount) ch acc))
             l'
             (n - 1)
 #endif
@@ -221,7 +222,7 @@ mkGroupPadding n = bgroup (show n)
   [ bench "Data.Text.Lazy.Builder" $ nf benchPaddingLazyBuilder n
   -- , bench "Data.ByteString.Builder" $ nf benchPaddingLazyBuilderBS n
 #ifdef MIN_VERSION_text_builder
-  , bench "Text.Builder" $ nf benchPaddingStrictBuilder n
+  , bench "TextBuilder" $ nf benchPaddingStrictBuilder n
 #endif
 -- #ifdef MIN_VERSION_bytestring_strict_builder
 --   , bench "ByteString.StrictBuilder" $ nf benchPaddingStrictBuilderBS n

bench/BenchDecimal.hs

@@ -14,7 +14,7 @@ import Data.Text.Lazy.Builder.Int (decimal)
 import Test.Tasty.Bench (Benchmark, bench, bgroup, nf)
 
 #ifdef MIN_VERSION_text_builder
-import qualified Text.Builder
+import qualified TextBuilder
 #endif
 
 #ifdef MIN_VERSION_bytestring_strict_builder
@@ -47,10 +47,10 @@ benchLazyBuilderBS k = B.toStrict . B.toLazyByteString . go mempty
 
 #ifdef MIN_VERSION_text_builder
 benchStrictBuilder ∷ (Integral a) ⇒ a → Int → T.Text
-benchStrictBuilder k = Text.Builder.run . go mempty
+benchStrictBuilder k = TextBuilder.toText . go mempty
   where
     go !acc 0 = acc
-    go !acc n = let i = fromIntegral n * k in go (Text.Builder.decimal i <> (acc <> Text.Builder.decimal i)) (n - 1)
+    go !acc n = let i = fromIntegral n * k in go (TextBuilder.decimal i <> (acc <> TextBuilder.decimal i)) (n - 1)
 {-# SPECIALIZE benchStrictBuilder ∷ Int → Int → T.Text #-}
 {-# SPECIALIZE benchStrictBuilder ∷ Integer → Int → T.Text #-}
 #endif
@@ -82,7 +82,7 @@ mkBoundedGroup n =
     [ bench "Data.Text.Lazy.Builder" $ nf (benchLazyBuilder int) n
     , bench "Data.ByteString.Builder" $ nf (benchLazyBuilderBS int) n
 #ifdef MIN_VERSION_text_builder
-    , bench "Text.Builder" $ nf (benchStrictBuilder int) n
+    , bench "TextBuilder" $ nf (benchStrictBuilder int) n
 #endif
 #ifdef MIN_VERSION_bytestring_strict_builder
     , bench "ByteString.StrictBuilder" $ nf (benchStrictBuilderBS int) n
@@ -136,7 +136,7 @@ mkUnboundedGroup integer n =
     [ bench "Data.Text.Lazy.Builder" $ nf (benchLazyBuilder integer) n
     , bench "Data.ByteString.Builder" $ nf (benchUnboundedLazyBuilderBS integer) n
 #ifdef MIN_VERSION_text_builder
-    , bench "Text.Builder" $ nf (benchStrictBuilder integer) n
+    , bench "TextBuilder" $ nf (benchStrictBuilder integer) n
 #endif
 #ifdef MIN_VERSION_bytestring_strict_builder
     , bench "ByteString.StrictBuilder" $ nf (benchStrictBuilderBS integer) n

bench/BenchDouble.hs

@@ -15,7 +15,8 @@ import Data.Text.Lazy.Builder.RealFloat (realFloat)
 import Test.Tasty.Bench
 
 #ifdef MIN_VERSION_text_builder
-import qualified Text.Builder
+import qualified TextBuilder
+import qualified TextBuilderDev as TextBuilder
 #endif
 
 dbl :: Double
@@ -35,10 +36,10 @@ benchLazyBuilderBS = B.toStrict . B.toLazyByteString . go mempty
 
 #ifdef MIN_VERSION_text_builder
 benchStrictBuilder ∷ Int → T.Text
-benchStrictBuilder = Text.Builder.run . go mempty
+benchStrictBuilder = TextBuilder.toText . go mempty
   where
     go !acc 0 = acc
-    go !acc n = let d = fromIntegral n * dbl in go (Text.Builder.fixedDouble 17 d <> (acc <> Text.Builder.fixedDouble 17 d)) (n - 1)
+    go !acc n = let d = fromIntegral n * dbl in go (TextBuilder.doubleFixedPoint 17 d <> (acc <> TextBuilder.doubleFixedPoint 17 d)) (n - 1)
 #endif
 
 benchLinearBuilder ∷ Int → T.Text
@@ -56,7 +57,7 @@ mkGroup n = bgroup (show n)
   [ bench "Data.Text.Lazy.Builder" $ nf benchLazyBuilder n
   , bench "Data.ByteString.Builder" $ nf benchLazyBuilderBS n
 #ifdef MIN_VERSION_text_builder
-  , bench "Text.Builder" $ nf benchStrictBuilder n
+  , bench "TextBuilder" $ nf benchStrictBuilder n
 #endif
   , bench "Data.Text.Builder.Linear" $ nf benchLinearBuilder n
   ]

bench/BenchHexadecimal.hs

@@ -15,7 +15,7 @@ import Data.Text.Lazy.Builder.Int (hexadecimal)
 import Test.Tasty.Bench
 
 #ifdef MIN_VERSION_text_builder
-import qualified Text.Builder
+import qualified TextBuilder
 #endif
 
 word :: Word
@@ -35,10 +35,10 @@ benchLazyBuilderBS = B.toStrict . B.toLazyByteString . go mempty
 
 #ifdef MIN_VERSION_text_builder
 benchStrictBuilder ∷ Word → T.Text
-benchStrictBuilder = Text.Builder.run . go mempty
+benchStrictBuilder = TextBuilder.toText . go mempty
   where
     go !acc 0 = acc
-    go !acc n = let i = n * word in go (Text.Builder.hexadecimal i <> (acc <> Text.Builder.hexadecimal i)) (n - 1)
+    go !acc n = let i = n * word in go (TextBuilder.hexadecimal i <> (acc <> TextBuilder.hexadecimal i)) (n - 1)
 #endif
 
 benchLinearBuilderWord ∷ Word → T.Text
@@ -63,7 +63,7 @@ mkGroup n = bgroup (show n)
   [ bench "Data.Text.Lazy.Builder" $ nf benchLazyBuilder n
   , bench "Data.ByteString.Builder" $ nf benchLazyBuilderBS n
 #ifdef MIN_VERSION_text_builder
-  , bench "Text.Builder" $ nf benchStrictBuilder n
+  , bench "TextBuilder" $ nf benchStrictBuilder n
 #endif
   , bench "Data.Text.Builder.Linear (Word)" $ nf benchLinearBuilderWord n
   , bench "Data.Text.Builder.Linear (Int)" $ nf benchLinearBuilderInt n

bench/BenchText.hs

@@ -15,7 +15,7 @@ import Data.Text.Lazy.Builder (toLazyText, fromText)
 import Test.Tasty.Bench
 
 #ifdef MIN_VERSION_text_builder
-import qualified Text.Builder
+import qualified TextBuilder
 #endif
 
 #ifdef MIN_VERSION_bytestring_strict_builder
@@ -41,9 +41,9 @@ benchLazyBuilderBS = B.toStrict . B.toLazyByteString . go mempty
 
 #ifdef MIN_VERSION_text_builder
 benchStrictBuilder ∷ Int → T.Text
-benchStrictBuilder = Text.Builder.run . go mempty
+benchStrictBuilder = TextBuilder.toText . go mempty
   where
-    txtB = Text.Builder.text txt
+    txtB = TextBuilder.text txt
     go !acc 0 = acc
     go !acc n = go (txtB <> (acc <> txtB)) (n - 1)
 #endif
@@ -72,7 +72,7 @@ mkGroup n = bgroup (show n)
   [ bench "Data.Text.Lazy.Builder" $ nf benchLazyBuilder n
   , bench "Data.ByteString.Builder" $ nf benchLazyBuilderBS n
 #ifdef MIN_VERSION_text_builder
-  , bench "Text.Builder" $ nf benchStrictBuilder n
+  , bench "TextBuilder" $ nf benchStrictBuilder n
 #endif
 #ifdef MIN_VERSION_bytestring_strict_builder
   , bench "ByteString.StrictBuilder" $ nf benchStrictBuilderBS n

bench/ParseCsv.hs

@@ -48,7 +48,7 @@ parseLine xs = M.singleton title (M.singleton size group)
     group = case ws of
       "Data.Text.Lazy.Builder" -> mempty { grpTextLazy = Just time }
       "Data.ByteString.Builder" -> mempty { grpBSLazy = Just time }
-      "Text.Builder" -> mempty { grpTextStrict = Just time }
+      "TextBuilder" -> mempty { grpTextStrict = Just time }
       "ByteString.StrictBuilder" -> mempty { grpBSStrict = Just time }
       "Data.Text.Builder.Linear" -> mempty { grpLinear = Just time }
 

text-builder-linear.cabal

@@ -96,7 +96,8 @@ benchmark linear-builder-bench
         -- NOTE: The following packages are optional, but are not required that
         --       often. While they could be guarded by a flag, we prefer keeping
         --       the Hackage page simple. Just uncomment these lines when needed.
-        -- bytestring-strict-builder >= 0.4.5 && < 0.5,
-        -- text-builder >= 0.6.7 && < 0.7,
+        -- bytestring-strict-builder >=0.4.5 && <0.5,
+        -- text-builder >=1.0 && <1.1,
+        -- text-builder-dev >=0.4 && <0.5,
         tasty,
         tasty-bench >=0.4 && <0.5