openhab-scripting 4.30.5 → 4.32.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b08e3b890a03ea51fe482ae4c54f1e69c85f7e6bd1fa2efb3289369906ea6cf
-  data.tar.gz: 0ffd8091cba81d6e41e1d893433ddee3290bb791f8d09fc21320485fbdec9504
+  metadata.gz: 8d988eed567dd4fb75d8f43550f005cc1e09264310157c6ec7f267f82d68f6af
+  data.tar.gz: f790a909228f3671204fe6e00c27064ee25ab69154f4b54a21efe233d36d6b2b
 SHA512:
-  metadata.gz: cc315816395abcde25be7a0722d1190b001a17758a7dd2f513e6ff1d35b7ce0f5d9d35d817f4bd045d5812492aed2f280b7065ee3797a0eba04ac74ae4b20291
-  data.tar.gz: 1d1362ef4aff0a0560995322f7b4c52c0255291b2f8d2041418be419fe4a899c163624a7bdee6323b85af67677a89851a8247857e111a228e1fdf19b07049e21
+  metadata.gz: bf7f712761e6b051f674c0709abba39f13ca3cbc52db417cb7a5c40f013425f860b52bd8ff840f1bb60a81cbda845899c348a9da2045ad0b0480816e70478f4d
+  data.tar.gz: 9c40d8bb624713aba27f93edc5c0dac12d003c14d3db47a37715954b7c788cf0d0f195e32797cd3a454eb984d57a05eb650660e585f476aff7ded57c4e6c5fff

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/log/logger.rb

@@ -8,7 +8,8 @@ module OpenHAB
   #
   # Provides access to the OpenHAB logging using a Ruby logging methods
   #
-  module Log
+
+  module Core
     #
     # Ruby Logger that forwards messages at appropriate levels to OpenHAB Logger
     #
@@ -105,7 +106,9 @@ module OpenHAB
       #
       def log_exception(exception, rule_name)
         exception = clean_backtrace(exception)
-        error { "#{exception.message} (#{exception.class})\nIn rule: #{rule_name}\n#{exception.backtrace&.join("\n")}" }
+        error do
+          "#{exception.message} (#{exception.class})\nIn rule: #{rule_name}\n#{exception.backtrace&.join("\n")}"
+        end
       end
 
       private
@@ -152,6 +155,12 @@ module OpenHAB
         end
       end
     end
+  end
+
+  module Log
+    #
+    # Ruby Logger that forwards messages at appropriate levels to OpenHAB Logger
+    #
 
     # Logger caches
     @loggers = {}
@@ -180,7 +189,7 @@ module OpenHAB
         # of logger name requires lots of operations and logger
         # names for some objects are specific to the class
         logger_name = logger_name(object)
-        @loggers[logger_name] ||= Logger.new(logger_name)
+        @loggers[logger_name] ||= OpenHAB::Core::Logger.new(logger_name)
       end
 
       private

data/lib/openhab/version.rb

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

metadata

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