Feature/conditional action

__tests__/action/condition.spec.ts

@@ -0,0 +1,67 @@
+/*
+ * Copyright 2020 ZUP IT SERVICOS EM TECNOLOGIA E INOVACAO SA
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import actions from 'action'
+import condition from 'action/condition'
+import { ConditionAction } from 'action/types'
+import { BeagleView } from 'beagle-view/types'
+
+describe('Action: condition', () => {
+  const element = { _beagleComponent_: 'beagle:button', id: 'btn' }
+  const onTrue = [{ _beagleAction_: 'custom:onTrue' }]
+  const onFalse = [{ _beagleAction_: 'custom:onFalse' }]
+  const trueAction: ConditionAction = {
+    _beagleAction_: 'beagle:condition',
+    condition: true,
+    onFalse,
+    onTrue,
+  }
+  const beagleView = {} as BeagleView
+  const executeAction = jest.fn()
+
+  beforeEach(() => {
+    executeAction.mockClear()
+  })
+
+  it('should exist', () => {
+    expect(actions['beagle:condition']).toBe(condition)
+  })
+
+  it('should run onTrue, but not onFalse', () => {
+    condition({ action: trueAction, element, beagleView, executeAction })
+    expect(executeAction).toHaveBeenCalledTimes(1)
+    expect(executeAction).toHaveBeenCalledWith(onTrue)
+  })
+
+  it('should run onFalse, but not onTrue', () => {
+    const action = { ...trueAction, condition: false }
+    condition({ action, element, beagleView, executeAction })
+    expect(executeAction).toHaveBeenCalledTimes(1)
+    expect(executeAction).toHaveBeenCalledWith(onFalse)
+  })
+
+  it('should do nothing when resolved to true and no onTrue exists', () => {
+    const action = { ...trueAction, onTrue: undefined }
+    condition({ action, element, beagleView, executeAction })
+    expect(executeAction).toHaveBeenCalledTimes(0)
+  })
+
+  it('should do nothing when resolved to false and no onFalse exists', () => {
+    const action = { ...trueAction, condition: false, onFalse: undefined }
+    condition({ action, element, beagleView, executeAction })
+    expect(executeAction).toHaveBeenCalledTimes(0)
+  })
+})

src/action/condition.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2020 ZUP IT SERVICOS EM TECNOLOGIA E INOVACAO SA
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { ActionHandler, ConditionAction } from './types'
+
+const condition: ActionHandler<ConditionAction> = ({ action, executeAction }) => {
+  const { condition, onTrue, onFalse } = action
+  if (condition && onTrue) executeAction(onTrue)
+  if (!condition && onFalse) executeAction(onFalse)
+}
+
+export default condition

src/action/index.ts

@@ -20,6 +20,7 @@ import sendRequest from './send-request'
 import alert from './alert'
 import confirm from './confirm'
 import submitForm from './submit-form'
+import condition from './condition'
 import NavigationActions from './navigation'
 import { ActionHandler } from './types'
 
@@ -30,6 +31,7 @@ const defaultActionHandlers: Record<string, ActionHandler> = {
   'beagle:alert': alert,
   'beagle:confirm': confirm,
   'beagle:submitForm': submitForm,
+  'beagle:condition': condition,
   ...NavigationActions,
 }
 

src/action/types.ts

@@ -61,6 +61,13 @@ export interface SubmitFormAction {
   _beagleAction_: 'beagle:submitForm',
 }
 
+export interface ConditionAction {
+  _beagleAction_: 'beagle:condition',
+  condition: boolean,
+  onTrue?: BeagleAction | BeagleAction[],
+  onFalse?: BeagleAction | BeagleAction[],
+}
+
 export interface CustomAction {
   _beagleAction_: string,
   [key: string]: any,
@@ -74,6 +81,7 @@ export type BeagleDefaultAction = (
   | ConfirmAction
   | BeagleNavigationAction
   | SubmitFormAction
+  | ConditionAction
 )
 
 export type BeagleAction = BeagleDefaultAction | CustomAction