Rename Text to String (#18)

Author: brandonchinn178

CHANGELOG.md

@@ -5,6 +5,9 @@
 * Improve rendering parse errors
 * Include filepath in error messages when `decodeFileWith` fails
 
+API changes:
+* Rename `Text` constructor to `String` in `ValueData`
+
 ## v0.2.1
 
 * Add `KDL.Applicative`

src/KDL/Decoder/Arrow.hs

@@ -1020,7 +1020,7 @@ any = valueDataDecoderPrim (SchemaOr $ map SchemaOne [minBound .. maxBound]) pur
 -- | Decode a KDL text value.
 text :: DecodeArrow Value a Text
 text = valueDataDecoderPrim (SchemaOne TextSchema) $ \case
-  Value{data_ = Text s} -> pure s
+  Value{data_ = String s} -> pure s
   v -> decodeThrow DecodeError_ValueDecodeFail{expectedType = "text", value = v}
 
 -- | Decode a KDL number value.

src/KDL/Parser/Internal.hs

@@ -440,7 +440,7 @@ p_value = label "value" $ do
 
   (data_, repr) <-
     withSource . choice . map try $
-      [ Text <$> p_string
+      [ String <$> p_string
       , p_number
       , p_keyword
       ]

src/KDL/Render.hs

@@ -101,7 +101,7 @@ renderValue Value{..} =
 
 renderValueData :: ValueData -> Text
 renderValueData = \case
-  Text s -> renderString s
+  String s -> renderString s
   Number x -> (Text.pack . show) x
   Bool b -> if b then "#true" else "#false"
   Inf -> "#inf"

src/KDL/Types.hs

@@ -338,7 +338,7 @@ valueFormat :: Value -> Maybe ValueFormat
 valueFormat = (.format)
 
 data ValueData
-  = Text Text
+  = String Text
   | Number Scientific
   | Bool Bool
   | Inf

test/KDL/Decoder/ArrowSpec.hs

@@ -854,7 +854,7 @@ apiSpec = do
                 , entries =
                     [ Entry
                         { name = Nothing
-                        , value = Value{ann = Nothing, data_ = Text "test", format = Nothing}
+                        , value = Value{ann = Nothing, data_ = String "test", format = Nothing}
                         , format = Nothing
                         }
                     ]
@@ -894,7 +894,7 @@ apiSpec = do
                 , format = Nothing
                 }
         KDL.decodeWith decoder config
-          `shouldBe` Right [val $ Number 1, val $ Text "asdf", val $ Bool True]
+          `shouldBe` Right [val $ Number 1, val $ String "asdf", val $ Bool True]
 
     describe "text" $ do
       it "decodes text value" $ do

test/KDL/Decoder/MonadSpec.hs

@@ -848,7 +848,7 @@ apiSpec = do
                 , entries =
                     [ Entry
                         { name = Nothing
-                        , value = Value{ann = Nothing, data_ = Text "test", format = Nothing}
+                        , value = Value{ann = Nothing, data_ = String "test", format = Nothing}
                         , format = Nothing
                         }
                     ]
@@ -888,7 +888,7 @@ apiSpec = do
                 , format = Nothing
                 }
         KDL.decodeWith decoder config
-          `shouldBe` Right [val $ Number 1, val $ Text "asdf", val $ Bool True]
+          `shouldBe` Right [val $ Number 1, val $ String "asdf", val $ Bool True]
 
     describe "text" $ do
       it "decodes text value" $ do

test/KDL/__snapshots__/ParserSpec.snap.md

@@ -32,7 +32,7 @@ NodeList
                   , value =
                       Value
                         { ann = Nothing
-                        , data_ = Text "world"
+                        , data_ = String "world"
                         , format = Just ValueFormat { repr = "world" }
                         }
                   , format =

test/kdl-hs-test-decoder.hs

@@ -56,7 +56,7 @@ encodeEntry entry =
 
 encodeValueData :: KDL.ValueData -> Aeson.Value
 encodeValueData = \case
-  KDL.Text s -> val "string" (Text.unpack s)
+  KDL.String s -> val "string" (Text.unpack s)
   KDL.Number x -> val "number" (Scientific.formatScientific Scientific.Fixed Nothing x)
   KDL.Bool x -> val "boolean" (if x then "true" else "false")
   KDL.Inf -> val "number" "inf"