Copyright	© 2015-Present Stack Builders
License	MIT
Maintainer	Juan Paucar <jpaucar@stackbuilders.com>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

System.Hapistrano.Commands

Description

Collection of type safe shell commands that can be fed into runCommand.

Synopsis

class Command a where
- type Result a :: *
- renderCommand :: a -> String
- parseResult :: Proxy a -> String -> Result a
data Whoami = Whoami
data Cd cmd = Cd (Path Abs Dir) cmd
data MkDir = MkDir (Path Abs Dir)
data Rm where
- Rm :: Path Abs t -> Rm
data Mv t = Mv TargetSystem (Path Abs t) (Path Abs t)
data Ln where
- Ln :: TargetSystem -> Path Abs t -> Path Abs File -> Ln
data Ls = Ls (Path Abs Dir)
data Readlink t = Readlink TargetSystem (Path Abs File)
data Find t = Find Natural (Path Abs Dir)
data Touch = Touch (Path Abs File)
data GitCheckout = GitCheckout String
data GitClone = GitClone Bool (Either String (Path Abs Dir)) (Path Abs Dir)
data GitFetch = GitFetch String
data GitReset = GitReset String
data GenericCommand
mkGenericCommand :: String -> Maybe GenericCommand
unGenericCommand :: GenericCommand -> String
readScript :: MonadIO m => Path Abs File -> m [GenericCommand]

Documentation

class Command a where Source #

Class for data types that represent shell commands in typed way.

Associated Types

type Result a :: * Source #

Type of result.

Methods

renderCommand :: a -> String Source #

How to render the command before feeding it into shell (possibly via SSH).

parseResult :: Proxy a -> String -> Result a Source #

How to parse the result from stdout.

Instances

Instances details

Command GenericCommand Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result GenericCommand Source # Methods renderCommand :: GenericCommand -> String Source # parseResult :: Proxy GenericCommand -> String -> Result GenericCommand Source #
Command GitReset Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result GitReset Source # Methods renderCommand :: GitReset -> String Source # parseResult :: Proxy GitReset -> String -> Result GitReset Source #
Command GitFetch Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result GitFetch Source # Methods renderCommand :: GitFetch -> String Source # parseResult :: Proxy GitFetch -> String -> Result GitFetch Source #
Command GitClone Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result GitClone Source # Methods renderCommand :: GitClone -> String Source # parseResult :: Proxy GitClone -> String -> Result GitClone Source #
Command GitCheckout Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result GitCheckout Source # Methods renderCommand :: GitCheckout -> String Source # parseResult :: Proxy GitCheckout -> String -> Result GitCheckout Source #
Command Touch Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result Touch Source # Methods renderCommand :: Touch -> String Source # parseResult :: Proxy Touch -> String -> Result Touch Source #
Command Ls Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result Ls Source # Methods renderCommand :: Ls -> String Source # parseResult :: Proxy Ls -> String -> Result Ls Source #
Command Ln Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result Ln Source # Methods renderCommand :: Ln -> String Source # parseResult :: Proxy Ln -> String -> Result Ln Source #
Command Rm Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result Rm Source # Methods renderCommand :: Rm -> String Source # parseResult :: Proxy Rm -> String -> Result Rm Source #
Command MkDir Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result MkDir Source # Methods renderCommand :: MkDir -> String Source # parseResult :: Proxy MkDir -> String -> Result MkDir Source #
Command Whoami Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result Whoami Source # Methods renderCommand :: Whoami -> String Source # parseResult :: Proxy Whoami -> String -> Result Whoami Source #
Command (Find File) Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result (Find File) Source # Methods renderCommand :: Find File -> String Source # parseResult :: Proxy (Find File) -> String -> Result (Find File) Source #
Command (Find Dir) Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result (Find Dir) Source # Methods renderCommand :: Find Dir -> String Source # parseResult :: Proxy (Find Dir) -> String -> Result (Find Dir) Source #
Command (Readlink File) Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result (Readlink File) Source # Methods renderCommand :: Readlink File -> String Source # parseResult :: Proxy (Readlink File) -> String -> Result (Readlink File) Source #
Command (Readlink Dir) Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result (Readlink Dir) Source # Methods renderCommand :: Readlink Dir -> String Source # parseResult :: Proxy (Readlink Dir) -> String -> Result (Readlink Dir) Source #
Command (Mv File) Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result (Mv File) Source # Methods renderCommand :: Mv File -> String Source # parseResult :: Proxy (Mv File) -> String -> Result (Mv File) Source #
Command (Mv Dir) Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result (Mv Dir) Source # Methods renderCommand :: Mv Dir -> String Source # parseResult :: Proxy (Mv Dir) -> String -> Result (Mv Dir) Source #
Command cmd => Command (Cd cmd) Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result (Cd cmd) Source # Methods renderCommand :: Cd cmd -> String Source # parseResult :: Proxy (Cd cmd) -> String -> Result (Cd cmd) Source #

data Whoami Source #

Unix whoami.

Constructors

Whoami

Instances

Instances details

Eq Whoami Source #
Instance details Defined in System.Hapistrano.Commands.Internal Methods (==) :: Whoami -> Whoami -> Bool # (/=) :: Whoami -> Whoami -> Bool #
Ord Whoami Source #
Instance details Defined in System.Hapistrano.Commands.Internal Methods compare :: Whoami -> Whoami -> Ordering # (<) :: Whoami -> Whoami -> Bool # (<=) :: Whoami -> Whoami -> Bool # (>) :: Whoami -> Whoami -> Bool # (>=) :: Whoami -> Whoami -> Bool # max :: Whoami -> Whoami -> Whoami # min :: Whoami -> Whoami -> Whoami #
Show Whoami Source #
Instance details Defined in System.Hapistrano.Commands.Internal Methods showsPrec :: Int -> Whoami -> ShowS # show :: Whoami -> String # showList :: [Whoami] -> ShowS #
Command Whoami Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result Whoami Source # Methods renderCommand :: Whoami -> String Source # parseResult :: Proxy Whoami -> String -> Result Whoami Source #
type Result Whoami Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result Whoami = String

data Cd cmd Source #

Specify directory in which to perform another command.

Constructors

Cd (Path Abs Dir) cmd

Instances

Instances details

Command cmd => Command (Cd cmd) Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result (Cd cmd) Source # Methods renderCommand :: Cd cmd -> String Source # parseResult :: Proxy (Cd cmd) -> String -> Result (Cd cmd) Source #
type Result (Cd cmd) Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result (Cd cmd) = Result cmd

data MkDir Source #

Create a directory. Does not fail if the directory already exists.

Constructors

MkDir (Path Abs Dir)

Instances

Instances details

Command MkDir Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result MkDir Source # Methods renderCommand :: MkDir -> String Source # parseResult :: Proxy MkDir -> String -> Result MkDir Source #
type Result MkDir Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result MkDir = ()

data Rm where Source #

Delete file or directory.

Constructors

Rm :: Path Abs t -> Rm

Instances

Instances details

Command Rm Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result Rm Source # Methods renderCommand :: Rm -> String Source # parseResult :: Proxy Rm -> String -> Result Rm Source #
type Result Rm Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result Rm = ()

data Mv t Source #

Move or rename files or directories.

Constructors

Mv TargetSystem (Path Abs t) (Path Abs t)

Instances

Instances details

Command (Mv File) Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result (Mv File) Source # Methods renderCommand :: Mv File -> String Source # parseResult :: Proxy (Mv File) -> String -> Result (Mv File) Source #
Command (Mv Dir) Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result (Mv Dir) Source # Methods renderCommand :: Mv Dir -> String Source # parseResult :: Proxy (Mv Dir) -> String -> Result (Mv Dir) Source #
type Result (Mv File) Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result (Mv File) = ()
type Result (Mv Dir) Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result (Mv Dir) = ()

data Ln where Source #

Create symlinks.

Constructors

Ln :: TargetSystem -> Path Abs t -> Path Abs File -> Ln

Instances

Instances details

Command Ln Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result Ln Source # Methods renderCommand :: Ln -> String Source # parseResult :: Proxy Ln -> String -> Result Ln Source #
type Result Ln Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result Ln = ()

data Ls Source #

ls, so far used only to check existence of directories, so it's not very functional right now.

Constructors

Ls (Path Abs Dir)

Instances

Instances details

Command Ls Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result Ls Source # Methods renderCommand :: Ls -> String Source # parseResult :: Proxy Ls -> String -> Result Ls Source #
type Result Ls Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result Ls = ()

data Readlink t Source #

Read link.

Constructors

Readlink TargetSystem (Path Abs File)

Instances

Instances details

Command (Readlink File) Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result (Readlink File) Source # Methods renderCommand :: Readlink File -> String Source # parseResult :: Proxy (Readlink File) -> String -> Result (Readlink File) Source #
Command (Readlink Dir) Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result (Readlink Dir) Source # Methods renderCommand :: Readlink Dir -> String Source # parseResult :: Proxy (Readlink Dir) -> String -> Result (Readlink Dir) Source #
type Result (Readlink File) Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result (Readlink File) = Path Abs File
type Result (Readlink Dir) Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result (Readlink Dir) = Path Abs Dir

data Find t Source #

Find (a very limited version).

Constructors

Find Natural (Path Abs Dir)

Instances

Instances details

Command (Find File) Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result (Find File) Source # Methods renderCommand :: Find File -> String Source # parseResult :: Proxy (Find File) -> String -> Result (Find File) Source #
Command (Find Dir) Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result (Find Dir) Source # Methods renderCommand :: Find Dir -> String Source # parseResult :: Proxy (Find Dir) -> String -> Result (Find Dir) Source #
type Result (Find File) Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result (Find File) = [Path Abs File]
type Result (Find Dir) Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result (Find Dir) = [Path Abs Dir]

data Touch Source #

touch.

Constructors

Touch (Path Abs File)

Instances

Instances details

Command Touch Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result Touch Source # Methods renderCommand :: Touch -> String Source # parseResult :: Proxy Touch -> String -> Result Touch Source #
type Result Touch Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result Touch = ()

data GitCheckout Source #

Git checkout.

Constructors

GitCheckout String

Instances

Instances details

Command GitCheckout Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result GitCheckout Source # Methods renderCommand :: GitCheckout -> String Source # parseResult :: Proxy GitCheckout -> String -> Result GitCheckout Source #
type Result GitCheckout Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result GitCheckout = ()

data GitClone Source #

Git clone.

Constructors

GitClone Bool (Either String (Path Abs Dir)) (Path Abs Dir)

Instances

Instances details

Command GitClone Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result GitClone Source # Methods renderCommand :: GitClone -> String Source # parseResult :: Proxy GitClone -> String -> Result GitClone Source #
type Result GitClone Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result GitClone = ()

data GitFetch Source #

Git fetch (simplified).

Constructors

GitFetch String

Instances

Instances details

Command GitFetch Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result GitFetch Source # Methods renderCommand :: GitFetch -> String Source # parseResult :: Proxy GitFetch -> String -> Result GitFetch Source #
type Result GitFetch Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result GitFetch = ()

data GitReset Source #

Git reset.

Constructors

GitReset String

Instances

Instances details

Command GitReset Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result GitReset Source # Methods renderCommand :: GitReset -> String Source # parseResult :: Proxy GitReset -> String -> Result GitReset Source #
type Result GitReset Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result GitReset = ()

data GenericCommand Source #

Weakly-typed generic command, avoid using it directly.

Instances

Instances details

Eq GenericCommand Source #
Instance details Defined in System.Hapistrano.Commands.Internal Methods (==) :: GenericCommand -> GenericCommand -> Bool # (/=) :: GenericCommand -> GenericCommand -> Bool #
Ord GenericCommand Source #
Instance details Defined in System.Hapistrano.Commands.Internal Methods compare :: GenericCommand -> GenericCommand -> Ordering # (<) :: GenericCommand -> GenericCommand -> Bool # (<=) :: GenericCommand -> GenericCommand -> Bool # (>) :: GenericCommand -> GenericCommand -> Bool # (>=) :: GenericCommand -> GenericCommand -> Bool # max :: GenericCommand -> GenericCommand -> GenericCommand # min :: GenericCommand -> GenericCommand -> GenericCommand #
Show GenericCommand Source #
Instance details Defined in System.Hapistrano.Commands.Internal Methods showsPrec :: Int -> GenericCommand -> ShowS # show :: GenericCommand -> String # showList :: [GenericCommand] -> ShowS #
Command GenericCommand Source #
Instance details Defined in System.Hapistrano.Commands.Internal Associated Types type Result GenericCommand Source # Methods renderCommand :: GenericCommand -> String Source # parseResult :: Proxy GenericCommand -> String -> Result GenericCommand Source #
type Result GenericCommand Source #
Instance details Defined in System.Hapistrano.Commands.Internal type Result GenericCommand = ()

mkGenericCommand :: String -> Maybe GenericCommand Source #

Smart constructor that allows to create GenericCommands. Just a little bit more safety.

unGenericCommand :: GenericCommand -> String Source #

Get the raw command back from GenericCommand.

readScript :: MonadIO m => Path Abs File -> m [GenericCommand] Source #

Read commands from a file.