WIP main: factor the top-level as textToYAML #20

deepfire · 2018-03-12T16:09:15Z

@Gabriel439, this is a suggested refactoring -- would you feel like including something like this?

If so, what improvements (besides the obvious lack of a docstring) would you suggest?

Gabriella439 · 2018-03-12T16:55:17Z

Perhaps simplify the utility to only encompass this logic:

codeToValue :: Text -> Text -> IO Value
codeToValue name code = do
    expr <- case Dhall.Parser.exprFromText (Directed name 0 0 0 0) code of
              Left  err  -> Control.Exception.throwIO err
              Right expr -> return expr

    expr' <- Dhall.Import.load expr
    case Dhall.TypeCheck.typeOf expr' of
      Left  err -> Control.Exception.throwIO err
      Right _   -> return ()

    case Dhall.JSON.dhallToJSON expr' of
      Left  err  -> Control.Exception.throwIO err
      Right json -> return json

Then if the user wants detailed error messages they can wrap that in detailed and if they want to omit null then they wrap the result in omitNull. Also, returning Value has the advantage that you can generate both YAML and JSON from the same utility.

deepfire · 2018-03-12T18:11:18Z

@Gabriel439, does that one look better?

Gabriella439 · 2018-03-12T18:12:30Z

src/Dhall/YAML.hs

@@ -0,0 +1,20 @@
+{-# LANGUAGE DeriveDataTypeable #-}


I don't think you need this module any longer. All it does is re-export codeToValue from the Dhall.JSON module

Right, removed it.

Gabriella439 · 2018-03-12T18:13:10Z

dhall-to-yaml/Main.hs

-                then Dhall.JSON.omitNull json
-                else json
-        Data.ByteString.putStr (Data.Yaml.encode filteredJSON) ))
+    Data.ByteString.putStr =<< (Data.Yaml.encode . omittingNull <$>) . explaining . (Dhall.JSON.codeToValue "(stdin)")


I'd prefer to use do notation here to split this up over multiple lines. This is difficult to read

deepfire · 2018-03-12T18:31:34Z

Added a provisional docstring to textToValue.

Gabriella439 · 2018-03-12T18:30:45Z

dhall-json.cabal

        aeson                >= 1.0.0.0  && < 1.4 ,
        dhall                >= 1.11.0   && < 1.12,
        text                 >= 0.11.1.0 && < 1.3 ,
-        unordered-containers                < 0.3
+        trifecta             >= 1.6      && < 1.8 ,


I think you can now remove the trifecta dependency from the dhall-to-json and dhall-to-yaml executables

Gabriella439 · 2018-03-12T18:31:51Z

src/Dhall/JSON.hs

+-}
+codeToValue :: Data.Text.Text -> Data.Text.Text -> IO Value
+codeToValue name code = do
+    let textBS = Data.ByteString.UTF8.fromString . Data.Text.unpack


Oops! Perhaps I should have suggested that the first argument have type ByteString that way we don't need to convert from Text using the utf8-string package

Gabriella439 · 2018-03-12T18:33:19Z

dhall-json.cabal

+        trifecta             >= 1.6      && < 1.8 ,
+        unordered-containers                < 0.3 ,
+        utf8-string                               ,
+        yaml                 >= 0.5.0    && < 0.9


I think the library section doesn't need to depend on the yaml package any longer now that codeToValue returns a Value

Gabriella439 · 2018-03-12T18:33:56Z

src/Dhall/JSON.hs

+{-| Convert a piece of Text carrying a Dhall inscription to an equivalent JSON Value
+
+>>> :set -XOverloadedStrings
+>>> :set -XOverloadedLists


I think this example doesn't require -XOverloadedLists

Gabriella439 · 2018-03-12T18:34:12Z

src/Dhall/JSON.hs

+>>> Dhall.JSON.codeToValue "(stdin)" "{ a = 1 }"
+>>> Object (fromList [("a",Number 1.0)])
+-}
+codeToValue :: Data.Text.Text -> Data.Text.Text -> IO Value


Don't forget to document what each argument represents

deepfire · 2018-03-12T19:40:50Z

All done and CI passes : -)

Gabriella439 · 2018-03-12T19:47:23Z

Looks great! Thanks for doing this :)

deepfire · 2018-03-12T19:56:40Z

Thank you for your feedback!

Gabriella439 · 2018-03-12T19:57:19Z

You're welcome! :)

deepfire mentioned this pull request Mar 12, 2018

[DEVOPS-690] Dhall-based multi-cluster configuration input-output-hk/daedalus#749

Merged

deepfire force-pushed the master branch 2 times, most recently from cec71d8 to 6223361 Compare March 12, 2018 16:22

deepfire force-pushed the master branch 2 times, most recently from 8ad6cb4 to d031a22 Compare March 12, 2018 18:09

Gabriella439 reviewed Mar 12, 2018

View reviewed changes

deepfire force-pushed the master branch 5 times, most recently from 49072b5 to ad57699 Compare March 12, 2018 18:31

Gabriella439 reviewed Mar 12, 2018

View reviewed changes

deepfire force-pushed the master branch 5 times, most recently from e393ba3 to 212f2c6 Compare March 12, 2018 19:20

main: factor the top-level as codeToValue

0354c6d

deepfire force-pushed the master branch from 212f2c6 to 0354c6d Compare March 12, 2018 19:37

Gabriella439 merged commit d6adaa2 into dhall-lang:master Mar 12, 2018

sjakobi mentioned this pull request Aug 2, 2019

Fix import logic with --file for dhall-to-{json,yaml} dhall-lang/dhall-haskell#1191

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP main: factor the top-level as textToYAML #20

WIP main: factor the top-level as textToYAML #20

deepfire commented Mar 12, 2018

Gabriella439 commented Mar 12, 2018

deepfire commented Mar 12, 2018

Gabriella439 Mar 12, 2018

deepfire Mar 12, 2018

Gabriella439 Mar 12, 2018

deepfire Mar 12, 2018

deepfire commented Mar 12, 2018

Gabriella439 Mar 12, 2018

deepfire Mar 12, 2018

Gabriella439 Mar 12, 2018

deepfire Mar 12, 2018

Gabriella439 Mar 12, 2018

deepfire Mar 12, 2018

Gabriella439 Mar 12, 2018

deepfire Mar 12, 2018

Gabriella439 Mar 12, 2018

deepfire Mar 12, 2018

deepfire commented Mar 12, 2018

Gabriella439 commented Mar 12, 2018

deepfire commented Mar 12, 2018

Gabriella439 commented Mar 12, 2018

WIP main: factor the top-level as textToYAML #20

WIP main: factor the top-level as textToYAML #20

Conversation

deepfire commented Mar 12, 2018

Gabriella439 commented Mar 12, 2018

deepfire commented Mar 12, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

deepfire commented Mar 12, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

deepfire commented Mar 12, 2018

Gabriella439 commented Mar 12, 2018

deepfire commented Mar 12, 2018

Gabriella439 commented Mar 12, 2018