openhab-scripting 4.30.4 → 4.32.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5836c0c28481307c2e5b7e455f78e6a41db200d6d0479b6510ca920a6b4b1327
-  data.tar.gz: 3dae55830faebd93761bd1250c7d1a82c1fdb0e086fe152c9c7cb4b3791aa817
+  metadata.gz: 89c274fd9901e8ccc5d1890a7cf41dbf17ab6d79eb2b798b4e86dde9101cdd11
+  data.tar.gz: dea8df6ebfb5b572745df0f4ab2b33ac251d74f0fe694ca4759e227f0588b4c3
 SHA512:
-  metadata.gz: cf42c9413c725a57783cd261c89162186573739676f681e0d0a6749c461262a7dbe22fac2d7692a7c39dd36a525e75facb4345f0f61b2ee5e4ea81b09bd0875f
-  data.tar.gz: 588986cf6160cf230ffe403381cc55b267a29c9bd36f444bb38d446eddbdee7173c7f42efea39082302506eb50c92b60125a9575e19e9063f2015f42098c2ee1
+  metadata.gz: 7ddee7681015930c085afe7fa68a6c6b913e414097d8da32ed9519b2d701ad71699f9bc585186f9cf229fb67633f3781995b04099290b67dd781ba9d5e167e93
+  data.tar.gz: a8d606a0b5c1fe02822955ad03fd6affbf111a774581cb1706ab7661af874ef907004c73e21bfa445f16780e27f65090b140ab83487b3dc2b6729ac1fba01b03

data/lib/openhab/dsl/items/color_item.rb

@@ -54,29 +54,6 @@ module OpenHAB
           super
         end
 
-        #
-        # Convert the ColorItem to a hash
-        # @param [:hsb, :rgb] format for hash
-        # @return [Hash] in requested format
-        def to_h(format = :hsb)
-          values = to_a(format)
-          keys = (format == :hsb ? %i[hue saturation brightness] : %i[red green blue])
-          keys.zip(values).to_h
-        end
-
-        #
-        # Convert the ColorItem to an array of values
-        # @param [:hsb, :rgb] format for elements in the array
-        # @return [Array] of ColorItem components in requested format
-        def to_a(format = :hsb)
-          case format
-          when :hsb then [hue, saturation, brightness]
-          when :rgb then [red, green, blue].map(&:to_byte)
-          else
-            raise ArgumentError, "Unsupported format #{format}"
-          end
-        end
-
         private
 
         # Mapping of hash values sets to conversion methods

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.include? 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/dsl/types/hsb_type.rb

@@ -105,13 +105,15 @@ module OpenHAB
         #
         #   nil is returned if the two values are incomparable
         #
-        def <=>(other)
+        def <=>(other) # rubocop:disable Metrics
           logger.trace("(#{self.class}) #{self} <=> #{other} (#{other.class})")
           if other.is_a?(Items::ColorItem) ||
              (other.is_a?(Items::GroupItem) && other.base_item.is_a?(ColorItem))
-            return false unless other.state?
+            return nil unless other.state?
 
             self <=> other.state
+          elsif other.is_a?(HSBType)
+            to_a <=> other.to_a
           elsif other.respond_to?(:to_str)
             self <=> HSBType.new(other)
           else
@@ -178,6 +180,29 @@ module OpenHAB
           "#{hue},#{saturation},#{brightness}"
         end
 
+        #
+        # Convert the ColorItem to a hash
+        # @param [:hsb, :rgb] format for hash
+        # @return [Hash] in requested format
+        def to_h(format = :hsb)
+          values = to_a(format)
+          keys = (format == :hsb ? %i[hue saturation brightness] : %i[red green blue])
+          keys.zip(values).to_h
+        end
+
+        #
+        # Convert the ColorItem to an array of values
+        # @param [:hsb, :rgb] format for elements in the array
+        # @return [Array] of ColorItem components in requested format
+        def to_a(format = :hsb)
+          case format
+          when :hsb then [hue, saturation, brightness]
+          when :rgb then [red, green, blue].map(&:to_byte)
+          else
+            raise ArgumentError, "Unsupported format #{format}"
+          end
+        end
+
         # @!attribute [r] saturation
         #   @return [PercentType]
 

data/lib/openhab/dsl/types/string_type.rb

@@ -80,7 +80,7 @@ module OpenHAB
         end
 
         # any method that exists on String gets forwarded to to_s
-        delegate (String.instance_methods - instance_methods) => :to_s
+        delegate (String.instance_methods - instance_methods + %w[=~ inspect]) => :to_s
       end
     end
   end

data/lib/openhab/version.rb

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

metadata

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