DirectoryTree: Replaced file with binary-file and text-file

Author: mmhat

dhall/src/Dhall/DirectoryTree.hs

@@ -5,6 +5,7 @@
 {-# LANGUAGE TupleSections     #-}
 {-# LANGUAGE ViewPatterns      #-}
 
+{-# OPTIONS_GHC -Wno-deprecations #-}
 {-# OPTIONS_GHC -Wno-orphans #-}
 
 -- | Implementation of the @dhall to-directory-tree@ subcommand
@@ -259,7 +260,8 @@ directoryTreeType = Pi Nothing "tree" (Const Type)
 makeType :: Expector (Expr Src Void)
 makeType = Record . Map.fromList <$> sequenceA
     [ makeConstructor "directory" (Decode.auto :: Decoder DirectoryEntry)
-    , makeConstructor "file" (Decode.auto :: Decoder FileEntry)
+    , makeConstructor "binary-file" (Decode.auto :: Decoder BinaryFileEntry)
+    , makeConstructor "text-file" (Decode.auto :: Decoder TextFileEntry)
     ]
     where
         makeConstructor :: Text -> Decoder b -> Expector (Text, RecordField Src Void)

dhall/src/Dhall/DirectoryTree/Types.hs

@@ -15,6 +15,8 @@ module Dhall.DirectoryTree.Types
     ( FilesystemEntry(..)
     , DirectoryEntry
     , FileEntry
+    , BinaryFileEntry
+    , TextFileEntry
     , Entry(..)
     , User(..)
     , Group(..)
@@ -67,14 +69,21 @@ pattern Make label entry <- App (Field (Var (V "_" 0)) (fieldSelectionLabel -> l
 type DirectoryEntry = Entry (Seq FilesystemEntry)
 
 -- | A file in the filesystem.
+{-# DEPRECATED FileEntry "`FileEntry` is deprecated and will be removed eventually. Please use `TextFileEntry` instead." #-}
 type FileEntry = Entry Text
 
+-- | A binary file in the filesystem.
+type BinaryFileEntry = Entry ByteString
+
+-- | A text file in the filesystem.
+type TextFileEntry = Entry Text
+
 -- | A filesystem entry.
 data FilesystemEntry
     = DirectoryEntry (Entry (Seq FilesystemEntry))
     | FileEntry (Entry Text)
-    | BinaryFileEntry (Entry ByteString)
-    | TextFileEntry (Entry Text)
+    | BinaryFileEntry BinaryFileEntry
+    | TextFileEntry TextFileEntry
     deriving (Eq, Generic, Ord, Show)
 
 instance FromDhall FilesystemEntry where
@@ -83,8 +92,6 @@ instance FromDhall FilesystemEntry where
         , extract = \case
             Make "directory" entry ->
                 DirectoryEntry <$> extract (autoWith normalizer) entry
-            Make "file" entry ->
-                FileEntry <$> extract (autoWith normalizer) entry
             Make "binary-file" entry ->
                 BinaryFileEntry <$> extract (autoWith normalizer) entry
             Make "text-file" entry ->

dhall/tests/Dhall/Test/DirectoryTree.hs

@@ -84,14 +84,14 @@ fixpointedUserGroup = testCase "user and group" $ do
     expr <- Dhall.inputExpr file
     entries <- decodeDirectoryTree expr
     entries @?=
-        [ FileEntry $ Entry
+        [ TextFileEntry $ Entry
             { entryName = "ids"
             , entryContent = ""
             , entryUser = Just (UserId 0)
             , entryGroup = Just (GroupId 0)
             , entryMode = Nothing
             }
-        , FileEntry $ Entry
+        , TextFileEntry $ Entry
             { entryName = "names"
             , entryContent = ""
             , entryUser = Just (UserName "user")

dhall/tests/to-directory-tree/fixpoint-helper.dhall

@@ -21,6 +21,6 @@ let Entry =
         }
 
 let Make =
-      \(r : Type) -> { directory : Entry (List r) -> r, file : Entry Text -> r }
+      \(r : Type) -> { directory : Entry (List r) -> r, binary-file : Entry Bytes -> r, text-file : Entry Text -> r }
 
 in  { User, Group, Access, Mode, Entry, Make }

dhall/tests/to-directory-tree/fixpoint-permissions.dhall

@@ -10,7 +10,7 @@ let full-access = { execute = Some True, read = Some True, write = Some True }
 
 in  \(r : Type) ->
     \(make : Make r) ->
-      [ make.file
+      [ make.text-file
           { name = "file"
           , content = ""
           , user = None User

dhall/tests/to-directory-tree/fixpoint-simple.dhall

@@ -8,7 +8,7 @@ let Make = (./fixpoint-helper.dhall).Make
 
 in  \(r : Type) ->
     \(make : Make r) ->
-        [ make.file
+        [ make.text-file
             { name = "file"
             , content = ""
             , user = None User

dhall/tests/to-directory-tree/fixpoint-usergroup.dhall

@@ -8,14 +8,14 @@ let Make = (./fixpoint-helper.dhall).Make
 
 in  \(r : Type) ->
     \(make : Make r) ->
-      [ make.file
+      [ make.text-file
           { name = "ids"
           , content = ""
           , user = Some (User.UserId 0)
           , group = Some (Group.GroupId 0)
           , mode = None Mode
           }
-      , make.file
+      , make.text-file
           { name = "names"
           , content = ""
           , user = Some (User.UserName "user")

dhall/tests/to-directory-tree/type.dhall

@@ -23,9 +23,11 @@ let Entry =
 in  forall (result : Type) ->
       let DirectoryEntry = Entry (List result)
 
-      let FileEntry = Entry Text
+      let BinaryFileEntry = Entry Bytes
+
+      let TextFileEntry = Entry Text
 
       let Make =
-            { directory : DirectoryEntry -> result, file : FileEntry -> result }
+            { directory : DirectoryEntry -> result, binary-file : BinaryFileEntry -> result, text-file : TextFileEntry -> result }
 
       in  forall (make : Make) -> List result