1
0
Fork 0

added documentation for adding an new operator to the mapper

Dieser Commit ist enthalten in:
Faizaan Gagan 2021-05-10 11:00:59 +05:30
Ursprung f3c29aba3c
Commit 001651d153
2 geänderte Dateien mit 43 neuen und 1 gelöschten Zeilen

Datei anzeigen

@ -231,6 +231,13 @@ en:
regex: '=~' regex: '=~'
association: '→' association: '→'
is: 'is' is: 'is'
##
# unit: custom_wizard:mapper adding_an_operator
# type: step
# number: 4
# title: Adding client translation for the operator
# description: Add the translation string for the said operator
##
in: 'in' in: 'in'
action: action:

Datei anzeigen

@ -1,4 +1,13 @@
# frozen_string_literal: true # frozen_string_literal: true
##
# unit: custom_wizard:mapper adding_an_operator
# type: introduction
# title: Adding a new operator to the mapper
# description: In this unit, we'll learn about adding a new operator to
# custom wizard's mapper
##
class CustomWizard::Mapper class CustomWizard::Mapper
attr_accessor :inputs, :data, :user attr_accessor :inputs, :data, :user
@ -33,6 +42,15 @@ class CustomWizard::Mapper
true: "==", true: "==",
false: "==" false: "=="
}, },
##
# unit: custom_wizard:mapper adding_an_operator
# type: step
# number: 1
# title: Adding the operator to the OPERATORS hash
# description: Add operator to this hash. The key will be used in code
# to refer to it and the value is generally the ruby operator
# to be used between the key and value
##
in: 'in' in: 'in'
} }
@ -119,6 +137,14 @@ class CustomWizard::Mapper
def cast_value(value, key, connector) def cast_value(value, key, connector)
if connector == 'regex' if connector == 'regex'
Regexp.new(value) Regexp.new(value)
##
# unit: custom_wizard:mapper adding_an_operator
# type: step
# number: 3
# title: Type casting mapper value
# description: You may want to typecast mapper values, based on certain conditions. Here,
# we're typecasting the value to an array so that we can use check for value contains key
##
elsif connector == 'in' elsif connector == 'in'
value.to_a value.to_a
else else
@ -134,7 +160,16 @@ class CustomWizard::Mapper
def validation_result(key, value, operator) def validation_result(key, value, operator)
result = nil result = nil
##
# unit: custom_wizard:mapper adding_an_operator
# type: step
# number: 2
# title: Defining operator's behaviour
# description: Define what happens when your operator is used between a key
# and value. The default behaviour is to use the operator hash value as a ruby
# operator between key and value. i.e. if operator is `equal`, then key == value or
# key.public_send('==', value).
##
if operator.is_a?(Hash) && (operator = operator[value.to_sym]).present? if operator.is_a?(Hash) && (operator = operator[value.to_sym]).present?
if value == "present" if value == "present"
result = key.public_send(operator) result = key.public_send(operator)