Merge pull request #49 from ChrisPenner/eve

Use the Eve framework

Author: ChrisPenner

docs/Building-An-Extension.md

@@ -70,7 +70,7 @@ main :: IO ()
 main = rasa $ do
   -- some plugins...
   -- Add the new action here!
-  onInit helloWorld
+  helloWorld
 ```
 
 Okay let's try again! `stack build && stack exec rasa` (you may want to alias
@@ -136,26 +136,26 @@ rasa/rasa-example-config/app/Main.hs:28:10: error:
                 with actual type ‘Keypress -> Action ()’
 ```
 
-Hrmm, right! Now that we're listening for keypress events we don't want to use
-`onInit` anymore, Rasa provides a way to register listeners for different events;
-we'll learn how to listen for any arbitrary event later; but for now it's time for
-`onKeypress`! 
+Hrmm, right! Now that we're listening for keypress events we need to set up an
+event-listener! Rasa provides a way to register listeners for different events;
+we'll learn how to listen for any arbitrary event later; but for now it's time
+for `onKeypress`!
 
 ```haskell
 onKeypress :: (Keypress -> Action ()) -> Action ListenerId
 ```
 
 So we've got our function from our event type (Keypress), so let's try
-registering it using `onKeypress`; we'll do all of this within `onInit` so the
-listener is registered when Rasa starts. The onKeypress function
-returns a reference to the newly created listener so that we could cancel the
-listener using `removeListener` later if we wanted to; but since we don't need
-to do that; we'll just ignore it.
+registering it using `onKeypress`; The onKeypress function returns a reference
+to the newly created listener so that we could cancel the listener using
+`removeListener` later if we wanted to; but since we don't need to do that;
+we'll just ignore it by using `void` from `Control.Monad`.
 
 ```haskell
+import Control.Monad
 main = rasa $ do
   -- other extensions
-  onInit $ onKeypress helloWorld
+  void $ onKeypress helloWorld
 ```
 
 Okay, let's build that and run it, now in a separate terminal we'll run
@@ -213,7 +213,7 @@ import qualified Yi.Rope as Y
 main = rasa $ do
   -- other extensions
   cursors
-  onInit $ onKeypress copyPasta
+  void $ onKeypress copyPasta
 
 copyPasta :: Keypress -> Action ()
 copyPasta (Keypress 'y' _) = focusDo_ $ rangeDo_ copier
@@ -504,7 +504,7 @@ newBuf (BufAdded bufRef) = bufDo_ bufRef (addCopyListener copyListener)
 
 main = rasa $ do
   -- other extensions
-  onInit . onBufAdded $ newBuf
+  onBufAdded_ $ newBuf
 ```
 
 Okay so this works; but there was a bit of boiler-plate to get it going!
@@ -599,7 +599,7 @@ newtype Copied = Copied String
 -- We've renamed things so we can export a single 'Action'
 -- that the user can embed in their config.
 copyPasta :: Action ()
-copyPasta = onInit $ onKeypress keyListener
+copyPasta = void $ onKeypress keyListener
 
 keyListener :: Keypress -> Action ()
 keyListener (Keypress 'y' _) = do

rasa-example-config/rasa-example-config.cabal

@@ -28,6 +28,7 @@ executable rasa
                      , data-default
                      , yi-rope
                      , mtl
+                     , eve
   default-language:    Haskell2010
   ghc-options:         -Wall -threaded -rtsopts -with-rtsopts=-N
 

rasa-ext-cmd/src/Rasa/Ext/Cmd.hs

@@ -1,5 +1,3 @@
-{-# LANGUAGE TemplateHaskell #-}
-
 module Rasa.Ext.Cmd
   ( addCmd
   , runCmd
@@ -13,7 +11,7 @@ import Data.Default
 import Data.Typeable
 
 data Cmd =
-  Cmd (Map String (String -> Action ()))
+  Cmd (Map String (String -> App ()))
   deriving (Typeable)
 
 instance Show Cmd where
@@ -23,15 +21,15 @@ instance Default Cmd where
   def = Cmd empty
 
 -- It would be nice to make this a little more generic, but I'm not sure how right now.
--- TODO try switching to T.Text -> (T.Text -> a) -> Action ()
-addCmd :: String -> (String -> Action ()) -> Action ()
+-- TODO try switching to T.Text -> (T.Text -> a) -> App ()
+addCmd :: String -> (String -> App ()) -> App ()
 addCmd alias mkEvent =
-  overExt add
+  stateLens %= add
     where add (Cmd commands) = Cmd $ commands & at alias ?~ mkEvent
 
-runCmd :: String -> String -> Action ()
+runCmd :: String -> String -> App ()
 runCmd alias args = do
-  Cmd commands <- getExt
+  Cmd commands <- use stateLens
   let mCmd = commands^.at alias
   case mCmd of
     Just cmd -> cmd args

rasa-ext-cursors/src/Rasa/Ext/Cursors.hs

@@ -26,6 +26,6 @@ import Rasa.Ext.Cursors.Internal.Base
 import Rasa.Ext.Cursors.Internal.Actions
 
 -- | Registers listeners for the extension. The user should add this to their config.
-cursors :: Action ()
-cursors = onInit . onBufAdded $
+cursors :: App ()
+cursors = onBufAdded_ $
   \(BufAdded bufRef) -> bufDo_ bufRef setStyleProvider

rasa-ext-files/src/Rasa/Ext/Files.hs

@@ -56,7 +56,7 @@ getFilename = do
   return filename
 
 -- | Main export, use this in your Rasa config
-files :: Action ()
+files :: App ()
 files = do
   onEveryNewBuffer_ $ do
     void . onBufTextChanged $ bufferChanged
@@ -100,13 +100,13 @@ setFilename :: String -> BufAction ()
 setFilename fname = setBufExt $ FileInfo (Just fname)
 
 -- | Add a buffer for a file
-addFile :: String -> Y.YiString -> Action ()
+addFile :: String -> Y.YiString -> App ()
 addFile fname txt = do
   newBuf <- addBuffer txt
   bufDo_ newBuf (setFilename fname)
 
 -- | Load files from command line
-loadFiles :: Action ()
+loadFiles :: App ()
 loadFiles = do
   fileNames <- liftIO getArgs
   fileTexts <- liftIO $ traverse TIO.readFile fileNames

rasa-ext-logger/src/Rasa/Ext/Logger.hs

@@ -8,15 +8,15 @@ import Rasa.Ext
 
 import Control.Monad.State
 
-logger :: Action ()
+logger :: App ()
 logger = do
-  onInit $ liftIO $ writeFile "logs.log" "Event Log\n"
-  onEveryRender_ $ do
-    ed <- getEditor
-    liftIO $ appendFile "logs.log" (show ed)
+  liftIO $ writeFile "logs.log" "Event Log\n"
+  onEveryRender_ $ return ()
+    -- ed <- getEditor
+    -- liftIO $ appendFile "logs.log" (show ed)
 
-logInfo :: String -> Action ()
+logInfo :: String -> App ()
 logInfo msg = liftIO $ appendFile "info.log" ("INFO: " ++ msg ++ "\n")
 
-logError :: String -> Action ()
+logError :: String -> App ()
 logError msg = liftIO $ appendFile "error.log" ("ERROR: " ++ msg ++ "\n")

rasa-ext-slate/src/Rasa/Ext/Slate.hs

@@ -15,14 +15,14 @@ import Control.Monad.IO.Class
 -- > rasa $ do
 -- >    slate
 -- >    ...
-slate :: Action ()
+slate :: App ()
 slate = do
-  onInit terminalEvents
+  terminalEvents
   onEveryRender_ renderAll
   onExit shutdown
 
 -- | Call vty shutdown procedure (if this doesn't happen the terminal ends up in strange states)
-shutdown :: Action ()
+shutdown :: App ()
 shutdown = do
   v <- getVty
   liftIO $ V.shutdown v

rasa-ext-slate/src/Rasa/Ext/Slate/Internal/Event.hs

@@ -8,7 +8,7 @@ import Control.Monad
 import qualified Graphics.Vty as V
 
 -- | Provides keypress events from the terminal, converted from Vty events.
-terminalEvents :: Action ()
+terminalEvents :: App ()
 terminalEvents = do
     v <- getVty
     asyncActionProvider $ getEvents v

rasa-ext-slate/src/Rasa/Ext/Slate/Internal/Render.hs

@@ -20,13 +20,13 @@ import Control.Lens
 import Control.Monad.IO.Class
 
 -- | Get the current terminal size.
-getSize :: Action (Width, Height)
+getSize :: App (Width, Height)
 getSize = do
   v <- getVty
   liftIO $ V.displayBounds $ V.outputIface v
 
 -- | Render the Editor
-renderAll :: Action ()
+renderAll :: App ()
 renderAll = do
   (width, height) <- getSize
   mViews <- getViews
@@ -56,7 +56,7 @@ splitByRule (FromEnd amt) sz = (start, end)
     end = min sz amt
 
 -- | Recursively render components of a Window to a 'V.Image' combining the results in the proper locations.
-renderWindow :: BiTree Split View -> Width -> Height -> Action V.Image
+renderWindow :: BiTree Split View -> Width -> Height -> App V.Image
 renderWindow = cata alg
   where
     mkBorder = V.charFill (V.defAttr `V.withForeColor` V.green)
@@ -88,7 +88,7 @@ type Left = V.Image
 type Right = V.Image
 
 -- | Renders widgets to images
-widgetsToImages :: Width -> Height -> ScrollPos -> Widgets -> Action (Top, Bottom, Left, Right)
+widgetsToImages :: Width -> Height -> ScrollPos -> Widgets -> App (Top, Bottom, Left, Right)
 widgetsToImages width height scrollAmt widgets = do
   top <- renderHorBar width (widgets^.topBar)
   bottom <- renderHorBar width (widgets^.bottomBar)
@@ -101,7 +101,7 @@ widgetsToImages width height scrollAmt widgets = do
       renderVertBar h rs = V.resizeHeight h . V.horizCat <$> traverse (renderToImage 1 h scrollAmt) rs
 
 -- | Render a given 'View' to a 'V.Image' given the context of the associated buffer and a size to render it in.
-renderView :: Width -> Height -> View -> Action V.Image
+renderView :: Width -> Height -> View -> App V.Image
 renderView width height vw = do
   widgets <- computeWidgets vw
   (top, bottom, left, right)  <- widgetsToImages width height scrollAmt widgets
@@ -112,5 +112,5 @@ renderView width height vw = do
   where
     scrollAmt = vw^.scrollPos
 
-renderToImage :: Renderable r => Width -> Height -> ScrollPos -> r -> Action V.Image
+renderToImage :: Renderable r => Width -> Height -> ScrollPos -> r -> App V.Image
 renderToImage w h scroll r = maybe V.emptyImage applyAttrs <$> render w h scroll r

rasa-ext-slate/src/Rasa/Ext/Slate/Internal/State.hs

@@ -2,7 +2,8 @@ module Rasa.Ext.Slate.Internal.State (getVty) where
 
 import Rasa.Ext
 
-import Control.Monad.IO.Class
+import Control.Lens
+import Control.Monad.Trans
 import qualified Graphics.Vty as V
 
 -- | Store 'V.Vty' state globally
@@ -11,17 +12,17 @@ instance Show Slate where
   show _ = "Slate"
 
 -- | V.Vty must be initialized, this takes IO to perform.
-initUi :: Action V.Vty
+initUi :: App V.Vty
 initUi = do
   cfg <- liftIO V.standardIOConfig
   v <- liftIO $ V.mkVty cfg
-  setExt $ Just (Slate v)
+  stateLens .= Just (Slate v)
   return v
 
 -- | Gets vty by checking if it has been initialized yet, if not it runs the initialization.
-getVty :: Action V.Vty
+getVty :: App V.Vty
 getVty = do
-  v <- getExt
+  v <- use stateLens
   case v of
     Just (Slate v') -> return v'
     Nothing -> initUi

rasa-ext-views/src/Rasa/Ext/Views.hs

@@ -19,7 +19,7 @@ module Rasa.Ext.Views
   , BiTreeF(..)
 
 
-  -- * Provided Actions
+  -- * ProvidedApps
   , A.rotate
   , A.closeInactive
   , A.focusViewLeft
@@ -74,7 +74,7 @@ import Rasa.Ext.Views.Internal.StatusBar
 import Rasa.Ext.Views.Internal.Actions as A
 
 -- | Main export from the views extension, add this to your rasa config.
-viewports :: Action ()
+viewports :: App ()
 viewports = do
   onBufAdded_ A.addSplit
   lineNumbers