openhab-scripting 4.31.0 → 4.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1e47b2bd8ffa13c3736bf92e2007ba10f733f6af21733f75aacb3edf579a100
-  data.tar.gz: 6ba382d4a2620626a2a58519c71aa17d2dff84748a7e29de991b254d4d3ee5ae
+  metadata.gz: 737517891b51326c4c0ab343c448cca3f07a4855ca44222a8564d107d5101cf4
+  data.tar.gz: 0cd4aea92b89e152c7bc7bb0b1e759a22609d833f1022510ec348ff4ad634812
 SHA512:
-  metadata.gz: 0bd7f2697b7135c4eed32918613be450e52ee257f07a200e5c777e2d04f1872696a58df81e352f0dd82f6f4cebfc03bcc75fa0eefa1a138c796de7ee4b87727a
-  data.tar.gz: ba920e1fdf93981f749873b28aa271664a9410e1152db9b6071ad6a50e869868098e0d96ae791a667e963d5219c761b1e2017efa600c620efae3274b5eb1b8d5
+  metadata.gz: c479724e15cb266f9f797f2e6c5646384f089ff83164890cfd2c6924d1ec0b07011015d4195a4e6de30dfa06da8c2617d2528de4652f8432afd4b2cef4c9bb21
+  data.tar.gz: 6e52ab144a7ba4118c39b9d843ba33a16a9f66903b6f9cdd6fd1cb585febdc121b5934bdd59ae813422c2e6325755302a0285f002427258762ae275214f686ce

data/lib/openhab/dsl/rules/triggers/command.rb

@@ -29,10 +29,11 @@ module OpenHAB
           combined_commands = Command.combine_commands(command: command, commands: commands)
 
           Command.flatten_items(items).map do |item|
-            logger.states 'Creating received command trigger', item: item, command: command, commands: commands,
-                                                               combined_commands: combined_commands
+            combined_commands.map do |cmd|
+              logger.states 'Creating received command trigger', item: item, command: cmd
 
-            command_trigger.trigger(item: item, commands: combined_commands, attach: attach)
+              command_trigger.trigger(item: item, command: cmd, attach: attach)
+            end
           end.flatten
         end
 
@@ -57,6 +58,47 @@ module OpenHAB
             combined_commands
           end
 
+          #
+          # Create a received command trigger
+          #
+          # @param [Object] item item to create trigger for
+          # @param [Object] command to check against
+          # @param [Object] attach attachment
+          #
+          # @return [Trigger] OpenHAB triggers
+          #
+          def trigger(item:, command:, attach:)
+            case command
+            when Range then range_trigger(item: item, command: command, attach: attach)
+            when Proc then proc_trigger(item: item, command: command, attach: attach)
+            else command_trigger(item: item, command: command, attach: attach)
+            end
+          end
+
+          #
+          # Creates a trigger with a range condition on the 'command' field
+          # @param [Object] item to create changed trigger on
+          # @param [Object] command to restrict trigger to
+          # @param [Object] attach to trigger
+          # @return [Trigger] OpenHAB trigger
+          #
+          def range_trigger(item:, command:, attach:)
+            command_range, * = Conditions::Proc.range_procs(command)
+            proc_trigger(item: item, command: command_range, attach: attach)
+          end
+
+          #
+          # Creates a trigger with a proc condition on the 'command' field
+          # @param [Object] item to create changed trigger on
+          # @param [Object] command to restrict trigger to
+          # @param [Object] attach to trigger
+          # @return [Trigger] OpenHAB trigger
+          #
+          def proc_trigger(item:, command:, attach:)
+            conditions = Conditions::Proc.new(command: command)
+            command_trigger(item: item, command: nil, attach: attach, conditions: conditions)
+          end
+
           #
           # Create a received trigger based on item type
           #
@@ -64,16 +106,14 @@ module OpenHAB
           # @param [Object] item to create trigger for
           #
           #
-          def trigger(item:, commands:, attach:)
-            commands.map do |command|
-              type, config = if item.is_a? OpenHAB::DSL::Items::GroupItem::GroupMembers
-                               group(group: item)
-                             else
-                               item(item: item)
-                             end
-              config['command'] = command.to_s unless command.nil?
-              append_trigger(type: type, config: config, attach: attach)
-            end
+          def command_trigger(item:, command:, attach: nil, conditions: nil)
+            type, config = if item.is_a? OpenHAB::DSL::Items::GroupItem::GroupMembers
+                             group(group: item)
+                           else
+                             item(item: item)
+                           end
+            config['command'] = command.to_s unless command.nil?
+            append_trigger(type: type, config: config, attach: attach, conditions: conditions)
           end
 
           private

data/lib/openhab/dsl/rules/triggers/conditions/proc.rb

@@ -38,9 +38,9 @@ module OpenHAB
             #
             def self.range_proc(range)
               logger.trace("Creating range proc for #{range}")
-              lambda do |state|
-                logger.trace("Range proc checking if #{state} is in  #{range}")
-                range.cover? state
+              lambda do |val|
+                logger.trace("Range proc checking if #{val} is in #{range}")
+                range.cover? val
               end
             end
 
@@ -77,9 +77,10 @@ module OpenHAB
             # @param [Proc] from Proc to check against from value
             # @param [Proc] to Proc to check against to value
             #
-            def initialize(from: nil, to: nil)
+            def initialize(from: nil, to: nil, command: nil)
               @from = from
               @to = to
+              @command = command
             end
 
             #
@@ -88,7 +89,18 @@ module OpenHAB
             #
             def process(mod:, inputs:) # rubocop:disable Lint/UnusedMethodArgument - mod is unused here but required
               logger.trace("Checking #{inputs} against condition trigger #{self}")
-              yield if check_from(inputs: inputs) && check_to(inputs: inputs)
+              yield if check_procs(inputs: inputs)
+            end
+
+            #
+            # Check if command condition match the proc
+            # @param [Hash] inputs from trigger must be supplied if state is not supplied
+            # @return [true/false] depending on if from is set and matches supplied conditions
+            #
+            def check_command(inputs: nil)
+              command = input_state(inputs, 'command')
+              logger.trace "Checking command(#{@command}) against command(#{command})"
+              check_proc(proc: @command, value: command)
             end
 
             #
@@ -100,7 +112,7 @@ module OpenHAB
             def check_from(inputs: nil, state: nil)
               state ||= input_state(inputs, 'oldState')
               logger.trace "Checking from(#{@from}) against state(#{state})"
-              check_proc(proc: @from, state: state)
+              check_proc(proc: @from, value: state)
             end
 
             #
@@ -112,27 +124,34 @@ module OpenHAB
             def check_to(inputs: nil, state: nil)
               state ||= input_state(inputs, 'newState', 'state')
               logger.trace "Checking to(#{@to}) against state(#{state})"
-              check_proc(proc: @to, state: state)
+              check_proc(proc: @to, value: state)
             end
 
             # Describe the Proc Condition as a string
             # @return [String] string representation of proc condition
             #
             def to_s
-              "From:(#{@from}) To:(#{@to})"
+              "From:(#{@from}) To:(#{@to}) Command:(#{@command})"
             end
 
             private
 
+            #
+            # Check all procs
+            # @param [Hash] inputs from event
+            # @return [true/false] true if all procs return true, false otherwise
+            def check_procs(inputs:)
+              check_from(inputs: inputs) && check_to(inputs: inputs) && check_command(inputs: inputs)
+            end
+
             # Check if a field matches the proc condition
             # @param [Proc] proc to call
-            # @param [Hash] inputs containing fields
-            # @param [Array] fields array of fields to extract from inputs, first one found is passed to proc
+            # @param [Hash] value to check
             # @return [true,false] true if proc is nil or proc.call returns true, false otherwise
-            def check_proc(proc:, state:)
-              return true if proc.nil? || proc.call(state)
+            def check_proc(proc:, value:)
+              return true if proc.nil? || proc.call(value)
 
-              logger.trace("Skipped execution of rule because state #{state} evalulated false for (#{proc})")
+              logger.trace("Skipped execution of rule because value #{value} evaluated false for (#{proc})")
               false
             end
 

data/lib/openhab/version.rb

@@ -5,5 +5,5 @@
 #
 module OpenHAB
   # @return [String] Version of OpenHAB helper libraries
-  VERSION = '4.31.0'
+  VERSION = '4.32.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.31.0
+  version: 4.32.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-22 00:00:00.000000000 Z
+date: 2022-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler