Merge pull request #5 from jamesdbrock/features

Improvements

Author: jamesdbrock

CHANGELOG.md

@@ -1,3 +1,30 @@
+# Changelog
+
+Notable changes to this project are documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+Breaking changes:
+
+New features:
+
+Bugfixes:
+
+Other improvements:
+
+# [Unreleased]
+
+Breaking changes:
+
+* Delete `writableClose` and add `end`.
+
+New features:
+
+* Add `toStringUTF8` and `fromStringUTF8`.
+
+Bugfixes:
+
+* Bugfix `onceError`.
 
 # v2.0.0
 

src/Node/Stream/Aff.purs

@@ -6,9 +6,6 @@
 -- | Open __process streams__ with
 -- | [__Node.Process__](https://pursuit.purescript.org/packages/purescript-node-process/docs/Node.Process).
 -- |
--- | Read and write __`String`__s with the `toString` and `fromString` functions in
--- | [__Node.Buffer__](https://pursuit.purescript.org/packages/purescript-node-buffer/docs/Node.Buffer#t:MutableBuffer).
--- |
 -- | All __I/O errors__ will be thrown through the `Aff` `MonadError` class
 -- | instance.
 -- |
@@ -81,7 +78,9 @@ module Node.Stream.Aff
   , readAll
   , readN
   , write
-  , writableClose
+  , end
+  , toStringUTF8
+  , fromStringUTF8
   )
   where
 
@@ -95,14 +94,16 @@ import Data.Either (Either(..))
 import Data.Maybe (Maybe(..))
 import Data.Tuple (Tuple(..))
 import Effect (Effect, untilE)
-import Effect.Aff (effectCanceler, makeAff)
+import Effect.Aff (effectCanceler, makeAff, nonCanceler)
 import Effect.Aff.Class (class MonadAff, liftAff)
+import Effect.Class (class MonadEffect, liftEffect)
 import Effect.Exception (catchException)
 import Node.Buffer (Buffer)
 import Node.Buffer as Buffer
+import Node.Encoding as Encoding
 import Node.Stream (Readable, Writable)
 import Node.Stream as Stream
-import Node.Stream.Aff.Internal (onceDrain, onceEnd, onceError, onceReadable, readable, writeStreamClose)
+import Node.Stream.Aff.Internal (onceDrain, onceEnd, onceError, onceReadable, readable)
 
 
 -- | Wait until there is some data available from the stream, then read it.
@@ -375,21 +376,29 @@ write w bs = liftAff <<< makeAff $ \res -> do
     removeError
     join $ liftST $ ST.Ref.read removeDrain
 
--- | Close a `Writable` file stream.
+-- | Signal that no more data will be written to the `Writable`. Will complete
+-- | after all data is written and flushed.
+-- |
+-- | When the `Writable` is an [__fs.WriteStream__](https://nodejs.org/api/fs.html#class-fswritestream)
+-- | then this will close the file descriptor because
 -- |
--- | Will complete after the file stream is closed.
-writableClose
+-- | > “If `autoClose` is set to true (default behavior) on `'error'`
+-- | > or `'finish'` the file descriptor will be closed automatically.”
+end
   :: forall m w
    . MonadAff m
   => Writable w
   -> m Unit
-writableClose w = liftAff <<< makeAff $ \res -> do
-
-  removeError <- onceError w $ res <<< Left
-
-  writeStreamClose w do
-    removeError
-    res (Right unit)
-
-  pure $ effectCanceler do
-    removeError
+end w = liftAff <<< makeAff $ \res -> do
+  Stream.end w $ case _ of
+    Nothing -> res (Right unit)
+    Just err -> res (Left err)
+  pure $ nonCanceler
+
+  -- | Concatenate an `Array` of UTF-8 encoded `Buffer`s into a `String`.
+toStringUTF8 :: forall m. MonadEffect m => Array Buffer -> m String
+toStringUTF8 bs = liftEffect $ Buffer.toString Encoding.UTF8 =<< Buffer.concat bs
+
+-- | Encode a `String` as an `Array` containing one UTF-8 encoded `Buffer`.
+fromStringUTF8 :: forall m. MonadEffect m => String -> m (Array Buffer)
+fromStringUTF8 s = liftEffect $ map pure $ Buffer.fromString s Encoding.UTF8

src/Node/Stream/Internal.js

@@ -14,14 +14,10 @@ export const onceDrain = s => f => () => {
 }
 
 export const onceError = s => f => () => {
-  s.once('error', f);
+  s.once('error', error => f(error)());
   return () => {s.removeListener('error', f);};
 }
 
 export const readable = s => () => {
     return s.readable;
 }
-
-export const writeStreamClose = s => cb => () => {
-  return s.close(cb);
-}

src/Node/Stream/Internal.purs

@@ -7,7 +7,6 @@ module Node.Stream.Aff.Internal
   , onceError
   , onceReadable
   , readable
-  , writeStreamClose
   )
   where
 
@@ -65,18 +64,8 @@ foreign import onceError
 -- | property of a stream.
 -- |
 -- | > Is true if it is safe to call `readable.read()`, which means the stream
--- | > has not been destroyed or emitted 'error' or 'end'.
+-- | > has not been destroyed or emitted `'error'` or `'end'`.
 foreign import readable
   :: forall r
    . Readable r
   -> Effect Boolean
-
--- | The [`writeStream.close([callback])`](https://nodejs.org/api/fs.html#writestreamclosecallback)
--- | function.
--- |
--- | Accepts a callback that will be executed when the writeStream has closed.
-foreign import writeStreamClose
-  :: forall w
-   . Writable w
-  -> Effect Unit
-  -> Effect Unit

test/Main.purs

@@ -21,7 +21,7 @@ import Node.Buffer (Buffer, concat)
 import Node.Buffer as Buffer
 import Node.Encoding (Encoding(..))
 import Node.FS.Stream (createReadStream, createWriteStream)
-import Node.Stream.Aff (readAll, readN, readSome, writableClose, write)
+import Node.Stream.Aff (end, readAll, readN, readSome, write)
 import Partial.Unsafe (unsafePartial)
 import Test.Spec (describe, it)
 import Test.Spec.Assertions (expectError, shouldEqual)
@@ -62,7 +62,7 @@ main = unsafePartial $ do
           outfile <- liftEffect $ createWriteStream outfilename
           b <- liftEffect $ Buffer.fromString "test" UTF8
           write outfile [b]
-          writableClose outfile
+          end outfile
           expectError $ write outfile [b]
 
     pure (pure unit)