added os.userInfo([options])

Author: Thimoteus

generated-docs/Node/OS.md

@@ -0,0 +1,166 @@
+## Module Node.OS
+
+#### `NetworkInterface`
+
+``` purescript
+type NetworkInterface = { address :: String, netmask :: String, family :: String, mac :: String, internal :: Boolean }
+```
+
+#### `CPU`
+
+``` purescript
+type CPU = { model :: String, speed :: Int, times :: { user :: Milliseconds, nice :: Milliseconds, sys :: Milliseconds, idle :: Milliseconds, irq :: Milliseconds } }
+```
+
+#### `OS`
+
+``` purescript
+data OS :: Effect
+```
+
+#### `loadavg`
+
+``` purescript
+loadavg :: forall eff. Eff (os :: OS | eff) { one :: Number, five :: Number, fifteen :: Number }
+```
+
+#### `Arch`
+
+``` purescript
+data Arch
+  = X64
+  | ARM
+  | IA32
+  | UnknownArch
+```
+
+##### Instances
+``` purescript
+Eq Arch
+Show Arch
+```
+
+#### `arch`
+
+``` purescript
+arch :: forall eff. Eff (os :: OS | eff) Arch
+```
+
+#### `Endianness`
+
+``` purescript
+data Endianness
+  = LittleEndian
+  | BigEndian
+  | UnknownEndian
+```
+
+##### Instances
+``` purescript
+Eq Endianness
+Show Endianness
+```
+
+#### `endianness`
+
+``` purescript
+endianness :: forall eff. Eff (os :: OS | eff) Endianness
+```
+
+#### `Platform`
+
+``` purescript
+data Platform
+  = Darwin
+  | FreeBSD
+  | Linux
+  | SunOS
+  | Win32
+  | UnknownPlatform
+```
+
+##### Instances
+``` purescript
+Eq Platform
+Show Platform
+```
+
+#### `platform`
+
+``` purescript
+platform :: forall eff. Eff (os :: OS | eff) Platform
+```
+
+#### `userInfo`
+
+``` purescript
+userInfo :: forall eff. { encoding :: String } -> Eff (os :: OS | eff) UserInfo
+```
+
+#### `eol`
+
+``` purescript
+eol :: Char
+```
+
+#### `cpus`
+
+``` purescript
+cpus :: forall eff. Eff (os :: OS | eff) (Array CPU)
+```
+
+#### `freemem`
+
+``` purescript
+freemem :: forall eff. Eff (os :: OS | eff) Number
+```
+
+#### `homedir`
+
+``` purescript
+homedir :: forall eff. Eff (os :: OS | eff) String
+```
+
+#### `hostname`
+
+``` purescript
+hostname :: forall eff. Eff (os :: OS | eff) String
+```
+
+#### `release`
+
+``` purescript
+release :: forall eff. Eff (os :: OS | eff) String
+```
+
+#### `tmpdir`
+
+``` purescript
+tmpdir :: forall eff. Eff (os :: OS | eff) String
+```
+
+#### `totalmem`
+
+``` purescript
+totalmem :: forall eff. Eff (os :: OS | eff) Number
+```
+
+#### `ostype`
+
+``` purescript
+ostype :: forall eff. Eff (os :: OS | eff) String
+```
+
+#### `uptime`
+
+``` purescript
+uptime :: forall eff. Eff (os :: OS | eff) Seconds
+```
+
+#### `networkInterfaces`
+
+``` purescript
+networkInterfaces :: forall eff. Eff (os :: OS | eff) (StrMap (Array NetworkInterface))
+```
+
+

src/Node/OS.js

@@ -1,6 +1,5 @@
 "use strict";
-
-// module Node.OS
+/* jshint node: true */
 
 var os = require('os');
 
@@ -19,3 +18,23 @@ exports.tmpdir = os.tmpdir;
 exports.totalmem = os.totalmem;
 exports.ostype = os.type;
 exports.uptime = os.uptime;
+exports.userInfoImpl = function (update) {
+  return function (Nothing) {
+    return function (Just) {
+      return function (opts) {
+        return function () {
+          var userInfo = os.userInfo(opts);
+          if (userInfo.shell === null) {
+            return update(function (x) {
+              return Just(Nothing);
+            })(userInfo);
+          } else {
+            return update(function (x) {
+              return Just(Just(x));
+            })(userInfo);
+          }
+        };
+      };
+    };
+  };
+};

src/Node/OS.purs

@@ -5,23 +5,24 @@ module Node.OS
   , cpus
   , Endianness(..), endianness
   , freemem
-  , loadavg
   , homedir
   , hostname
+  , loadavg
+  , networkInterfaces
   , Platform(..), platform
   , release
   , tmpdir
   , totalmem
   , ostype
   , uptime
-  , networkInterfaces
+  , userInfo
   ) where
 
 import Prelude
 
 import Data.Array ((!!))
-import Data.Maybe (fromMaybe)
-import Data.StrMap (StrMap)
+import Data.Maybe (Maybe(..), fromMaybe)
+import Data.StrMap (StrMap, update)
 import Data.Time.Duration (Milliseconds, Seconds)
 
 import Control.Monad.Eff (Eff, kind Effect)
@@ -41,46 +42,12 @@ type CPU = { model :: String
                       , idle :: Milliseconds
                       , irq :: Milliseconds } }
 
-foreign import data OS :: Effect 
-
-foreign import eol :: Char
-
-foreign import archImpl :: forall eff. Eff ( os :: OS | eff ) String
-
-foreign import cpus :: forall eff. Eff ( os :: OS | eff ) (Array CPU)
-
-foreign import endiannessImpl :: forall eff. Eff ( os :: OS | eff ) String
-
-foreign import freemem :: forall eff. Eff ( os :: OS | eff ) Number
-
-foreign import homedir :: forall eff. Eff ( os :: OS | eff ) String
-
-foreign import hostname :: forall eff. Eff ( os :: OS | eff ) String
-
-foreign import loadavgImpl :: forall eff. Eff ( os :: OS | eff ) (Array Number)
-
-foreign import platformImpl :: forall eff. Eff ( os :: OS | eff ) String
-
-foreign import release :: forall eff. Eff ( os :: OS | eff ) String
-
-foreign import tmpdir :: forall eff. Eff ( os :: OS | eff ) String
-
-foreign import totalmem :: forall eff. Eff ( os :: OS | eff ) Number
-
-foreign import ostype :: forall eff. Eff ( os :: OS | eff ) String
-
-foreign import uptime :: forall eff. Eff ( os :: OS | eff ) Seconds
-
-foreign import networkInterfaces :: forall eff. Eff ( os :: OS | eff ) (StrMap (Array NetworkInterface))
+foreign import data OS :: Effect
 
 loadavg :: forall eff. Eff ( os :: OS | eff ) { one :: Number, five :: Number, fifteen :: Number }
 loadavg = pure <<< fromMaybe {one: 0.0, five: 0.0, fifteen: 0.0} <<< extract =<< loadavgImpl
   where
-  extract xs = do
-    one <- xs !! 0
-    five <- xs !! 1
-    fifteen <- xs !! 2
-    pure {one, five, fifteen}
+  extract xs = {one: _, five: _, fifteen: _} <$> xs !! 0 <*> xs !! 1 <*> xs !! 2
 
 data Arch = X64 | ARM | IA32 | UnknownArch
 
@@ -140,3 +107,39 @@ platform = do
            "freebsd" -> FreeBSD
            "sunos" -> SunOS
            _ -> UnknownPlatform
+
+type UserInfo =
+  { uid :: Int
+  , gid :: Int
+  , username :: String
+  , homedir :: String
+  , shell :: Maybe String
+  }
+
+userInfo :: forall eff. {encoding :: String} -> Eff ( os :: OS | eff ) UserInfo
+userInfo = userInfoImpl (flip update "shell") Nothing Just
+
+foreign import eol :: Char
+foreign import archImpl :: forall eff. Eff ( os :: OS | eff ) String
+foreign import cpus :: forall eff. Eff ( os :: OS | eff ) (Array CPU)
+foreign import endiannessImpl :: forall eff. Eff ( os :: OS | eff ) String
+foreign import freemem :: forall eff. Eff ( os :: OS | eff ) Number
+foreign import homedir :: forall eff. Eff ( os :: OS | eff ) String
+foreign import hostname :: forall eff. Eff ( os :: OS | eff ) String
+foreign import loadavgImpl :: forall eff. Eff ( os :: OS | eff ) (Array Number)
+foreign import platformImpl :: forall eff. Eff ( os :: OS | eff ) String
+foreign import release :: forall eff. Eff ( os :: OS | eff ) String
+foreign import tmpdir :: forall eff. Eff ( os :: OS | eff ) String
+foreign import totalmem :: forall eff. Eff ( os :: OS | eff ) Number
+foreign import ostype :: forall eff. Eff ( os :: OS | eff ) String
+foreign import uptime :: forall eff. Eff ( os :: OS | eff ) Seconds
+foreign import networkInterfaces
+  :: forall eff
+   . Eff ( os :: OS | eff ) (StrMap (Array NetworkInterface))
+foreign import userInfoImpl
+  :: forall a eff
+   . ((a -> Maybe a) -> StrMap a -> StrMap a)
+  -> Maybe a
+  -> (a -> Maybe a)
+  -> {encoding :: String}
+  -> Eff ( os :: OS | eff ) UserInfo