{-| Module : Monomer.Widgets.Containers.KeystrokeSpec Copyright : (c) 2018 Francisco Vallarino License : BSD-3-Clause (see the LICENSE file) Maintainer : fjvallarino@gmail.com Stability : experimental Portability : non-portable Unit tests for Keystroke widget. -} {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE FunctionalDependencies #-} {-# LANGUAGE ScopedTypeVariables #-} {-# LANGUAGE TemplateHaskell #-} module Monomer.Widgets.Containers.KeystrokeSpec (spec) where import Control.Lens ((&), (^.), (.~)) import Control.Lens.TH (abbreviatedFields, makeLensesWith) import Data.Default import Data.Text (Text) import Test.Hspec import qualified Data.Sequence as Seq import Monomer.Common import Monomer.Core.Combinators import Monomer.Event import Monomer.TestUtil import Monomer.TestEventUtil import Monomer.Widgets.Containers.Keystroke import Monomer.Widgets.Singles.Button import Monomer.Widgets.Singles.Label import Monomer.Widgets.Singles.TextField import qualified Monomer.Lens as L data TestEvt = ButtonEvent | EnterPressed | SingleO | TextFieldChanged Text | CtrlA | CtrlSpace | CtrlDash | CtrlShiftSpace | MultiKey Int | FunctionKey Int | SymbolKey Text deriving (Eq, Show) newtype TestModel = TestModel { _tmTextValue :: Text } deriving (Eq, Show) makeLensesWith abbreviatedFields ''TestModel spec :: Spec spec = describe "Keystroke" $ do handleEvent handleNestedEvent getSizeReq handleEvent :: Spec handleEvent = describe "handleEvent" $ do it "should not generate events" $ do events [] `shouldBe` Seq.empty it "should generate an event when Ctrl-Space is pressed" $ do events [evtKC keySpace] `shouldBe` Seq.fromList [CtrlSpace] it "should generate an event when Ctrl-Dash is pressed" $ do let wenv = mockWenv (TestModel "") & L.inputStatus . L.keyMod . L.leftCtrl .~ True let events es = nodeHandleEventEvts wenv es kstNode events [evtT "-"] `shouldBe` Seq.fromList [CtrlDash] it "should generate an event when Ctrl-Shift-Space is pressed" $ do events [evtKCS keySpace] `shouldBe` Seq.fromList [CtrlShiftSpace] it "should generate events when function keys are pressed" $ do events [evtK keyF1] `shouldBe` Seq.fromList [FunctionKey 1] events [evtKC keyF3] `shouldBe` Seq.fromList [FunctionKey 3] events [evtKG keyF7] `shouldBe` Seq.fromList [FunctionKey 7] events [evtKS keyF12] `shouldBe` Seq.fromList [FunctionKey 12] it "should generate events when symbol keys are pressed" $ do let wenv = mockWenv (TestModel "") & L.inputStatus . L.keyMod . L.leftCtrl .~ True let events es = nodeHandleEventEvts wenv es kstNode events [evtT "["] `shouldBe` Seq.fromList [SymbolKey "["] events [evtT "^"] `shouldBe` Seq.fromList [SymbolKey "^"] it "should only generate events when the exact keys are pressed" $ do events [evtKC keyA, evtKC keyB] `shouldBe` Seq.fromList [] events [evtKC keyA, evtKC keyB, evtKC keyD, evtKC keyC] `shouldBe` Seq.fromList [] events [evtKC keyA, evtKC keyB, evtKC keyC] `shouldBe` Seq.fromList [MultiKey 1] events [ evtKC keyA, evtKC keyB, evtKC keyC, evtKC keyD, evtKC keyE] `shouldBe` Seq.fromList [MultiKey 1] events [ evtKC keyA, evtKC keyB, evtKC keyC, evtRKC keyA, evtRKC keyB, evtRKC keyC, evtKC keyD, evtKC keyE] `shouldBe` Seq.fromList [MultiKey 1, MultiKey 2] it "should not ignore children events if not explicitly requested" $ do events1 [evtKG keyA, evtT "d"] `shouldBe` Seq.fromList [CtrlA, TextFieldChanged "d"] model1 [evtKG keyA, evtT "d"] ^. textValue `shouldBe` "d" it "should ignore children events if requested" $ do events2 [evtKG keyA, evtT "d"] `shouldBe` Seq.fromList [CtrlA, TextFieldChanged "abcd"] model2 [evtKG keyA, evtT "d"] ^. textValue `shouldBe` "abcd" it "should not filter text events if not explicitly requested" $ do events1 [evtK keyO, evtT "o"] `shouldBe` Seq.fromList [SingleO, TextFieldChanged "abco"] model1 [evtK keyO, evtT "o"] ^. textValue `shouldBe` "abco" it "should filter text events if requested" $ do events2 [evtK keyO, evtT "o"] `shouldBe` Seq.fromList [SingleO] model2 [evtK keyO, evtT "o"] ^. textValue `shouldBe` "abc" where wenv = mockWenv (TestModel "") bindings = [ ("C-Space", CtrlSpace), ("C-Dash", CtrlDash), ("C-S-Space", CtrlShiftSpace), ("C-a-b-c", MultiKey 1), ("C-d-e", MultiKey 2), ("F1", FunctionKey 1), ("Ctrl-F3", FunctionKey 3), ("Cmd-F7", FunctionKey 7), ("S-F12", FunctionKey 12), ("C-[", SymbolKey "["), ("Shift-^", SymbolKey "^") ] kstNode = keystroke bindings (textField textValue) events es = nodeHandleEventEvts wenv es kstNode wenv2 = mockWenv (TestModel "abc") kstModel1 = keystroke [("C-a", CtrlA), ("o", SingleO)] (textField_ textValue [onChange TextFieldChanged]) kstModel2 = keystroke_ [("C-a", CtrlA), ("o", SingleO)] [ignoreChildrenEvts] (textField_ textValue [onChange TextFieldChanged]) model1 es = nodeHandleEventModel wenv2 es kstModel1 model2 es = nodeHandleEventModel wenv2 es kstModel2 events1 es = nodeHandleEventEvts wenv2 es kstModel1 events2 es = nodeHandleEventEvts wenv2 es kstModel2 handleNestedEvent :: Spec handleNestedEvent = describe "handleNestedEvent" $ do it "should not generate events" $ do events False False [] `shouldBe` Seq.empty it "should generate an event when clicking the button" $ do events False False [evtClick (Point 100 100)] `shouldBe` Seq.fromList [ButtonEvent] events True False [evtClick (Point 100 100)] `shouldBe` Seq.fromList [ButtonEvent] events False True [evtClick (Point 100 100)] `shouldBe` Seq.fromList [ButtonEvent] events True True [evtClick (Point 100 100)] `shouldBe` Seq.fromList [ButtonEvent] it "should generate the expected events when pressing the enter key" $ do events False False [evtK keyEnter] `shouldBe` Seq.fromList [EnterPressed, ButtonEvent] events True False [evtK keyEnter] `shouldBe` Seq.fromList [EnterPressed] events False True [evtK keyEnter] `shouldBe` Seq.fromList [ButtonEvent] events True True [evtK keyEnter] `shouldBe` Seq.fromList [EnterPressed] where wenv = mockWenv (TestModel "") bindings = [ ("Enter", EnterPressed) ] kstNode ignoreChild ignoreParent = keystroke_ bindings [ignoreChildrenEvts_ ignoreChild] $ button_ "Test" ButtonEvent [ignoreParentEvts_ ignoreParent] events ignoreChild ignoreParent es = nodeHandleEventEvts wenv es $ kstNode ignoreChild ignoreParent getSizeReq :: Spec getSizeReq = describe "getSizeReq" $ do it "should return same reqW as child node" $ kSizeReqW `shouldBe` lSizeReqW it "should return same reqH as child node" $ kSizeReqH `shouldBe` lSizeReqH where wenv = mockWenvEvtUnit (TestModel "Test value") lblNode = label "Test label" (lSizeReqW, lSizeReqH) = nodeGetSizeReq wenv lblNode (kSizeReqW, kSizeReqH) = nodeGetSizeReq wenv (keystroke [] lblNode)