openhab-scripting 4.47.0 → 5.0.0

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

@@ -1,34 +1,22 @@
 # frozen_string_literal: true
 
-require 'openhab/log/logger'
-
 module OpenHAB
   module DSL
     module Rules
       module Triggers
-        #
-        # Module for conditions for triggers
-        #
+        # @!visibility private
         module Conditions
-          include OpenHAB::Log
-          #
-          # this is a no-op condition which simply executes the provided block
-          #
-
           #
           # Struct capturing data necessary for a conditional trigger
           #
-          # TriggerDelay = Struct.new(:to, :from, :duration, :timer, :tracking_to, keyword_init: true) do
-          #  def timer_active?
-          #    timer&.is_active
-          #  end
-          # end
           class Duration
+            attr_accessor :rule
+
             #
             # Create a new duration condition
             # @param [Object] to optional condition on to state
             # @param [Object] from optional condition on from state
-            # @param [Duration] duration to state must stay at specific value before triggering
+            # @param [java.time.temporal.TemporalAmount] duration to state must stay at specific value before triggering
             #
             def initialize(to:, from:, duration:)
               to = Conditions::Proc.from_value(to)
@@ -44,24 +32,34 @@ module OpenHAB
             # @param [Hash] inputs inputs from trigger
             #
             def process(mod:, inputs:, &block)
-              process_trigger_delay(mod, inputs, &block)
+              if @timer&.active?
+                process_active_timer(inputs, mod, &block)
+              elsif check_trigger_guards(inputs)
+                logger.trace("Trigger Guards Matched for #{self}, delaying rule execution")
+                # Add timer and attach timer to delay object, and also state being tracked to so
+                # timer can be cancelled if state changes
+                # Also another timer should not be created if changed to same value again but instead rescheduled
+                create_trigger_delay_timer(inputs, mod, &block)
+              else
+                logger.trace("Trigger Guards did not match for #{self}, ignoring trigger.")
+              end
             end
 
-            private
-
+            # Cleanup any resources from the condition
             #
-            # Checks if there is an active timer
-            # @return [true, false] true if the timer exists and is active, false otherwise
-            def timer_active?
-              @timer&.is_active
+            # Cancels the timer, if it's active
+            def cleanup
+              @timer&.cancel
             end
 
+            private
+
             #
             # Check if trigger guards prevent rule execution
             #
-            # @param [Map] inputs OpenHAB map object describing rule trigger
+            # @param [java.util.Map] inputs map object describing rule trigger
             #
-            # @return [Boolean] True if the rule should execute, false if trigger guard prevents execution
+            # @return [true,false] True if the rule should execute, false if trigger guard prevents execution
             #
             def check_trigger_guards(inputs)
               new_state, old_state = retrieve_states(inputs)
@@ -72,49 +70,17 @@ module OpenHAB
             # Rerieve the newState and oldState, alternatively newStatus and oldStatus
             # from the input map
             #
-            # @param [Map] inputs OpenHAB map object describing rule trigger
+            # @param [java.util.Map] inputs map object describing rule trigger
             #
             # @return [Array] An array of the values for [newState, oldState] or [newStatus, oldStatus]
             #
             def retrieve_states(inputs)
-              new_state = inputs['newState'] || thing_status_to_sym(inputs['newStatus'])
-              old_state = inputs['oldState'] || thing_status_to_sym(inputs['oldStatus'])
+              new_state = inputs["newState"] || inputs["newStatus"]&.to_s&.downcase&.to_sym
+              old_state = inputs["oldState"] || inputs["oldStatus"]&.to_s&.downcase&.to_sym
 
               [new_state, old_state]
             end
 
-            #
-            # Converts a ThingStatus object to a ruby Symbol
-            #
-            # @param [org.openhab.core.thing.ThingStatus] status A ThingStatus instance
-            #
-            # @return [Symbol] A corresponding symbol, in lower case
-            #
-            def thing_status_to_sym(status)
-              status&.to_s&.downcase&.to_sym
-            end
-
-            #
-            # Process any matching trigger delays
-            #
-            # @param [Map] mod OpenHAB map object describing rule trigger
-            # @param [Map] inputs OpenHAB map object describing rule trigger
-            #
-            #
-            def process_trigger_delay(mod, inputs, &block)
-              if timer_active?
-                process_active_timer(inputs, mod, &block)
-              elsif check_trigger_guards(inputs)
-                logger.trace("Trigger Guards Matched for #{self}, delaying rule execution")
-                # Add timer and attach timer to delay object, and also state being tracked to so
-                # timer can be cancelled if state changes
-                # Also another timer should not be created if changed to same value again but instead rescheduled
-                create_trigger_delay_timer(inputs, mod, &block)
-              else
-                logger.trace("Trigger Guards did not match for #{self}, ignoring trigger.")
-              end
-            end
-
             #
             # Creates a timer for trigger delays
             #
@@ -124,12 +90,13 @@ module OpenHAB
             #
             def create_trigger_delay_timer(inputs, _mod)
               logger.trace("Creating timer for trigger delay #{self}")
-              @timer = after(@duration) do
+              @timer = DSL.after(@duration) do
                 logger.trace("Delay Complete for #{self}, executing rule")
                 @timer = nil
                 yield
               end
-              @tracking_to, = retrieve_states(inputs)
+              rule.on_removal(self)
+              _, @tracking_from = retrieve_states(inputs)
             end
 
             #
@@ -138,17 +105,15 @@ module OpenHAB
             # @param [Hash] inputs rule trigger inputs
             # @param [Hash] mod rule trigger mods
             #
-            #
             def process_active_timer(inputs, mod, &block)
-              state, = retrieve_states(inputs)
-              if state == @tracking_to
-                logger.trace("Item changed to #{state} for #{self}, rescheduling timer.")
-                @timer.reschedule(ZonedDateTime.now.plus(@duration))
+              new_state, old_state = retrieve_states(inputs)
+              if new_state != @tracking_from && @conditions.check_to(inputs: {})
+                logger.trace("Item changed from #{old_state} to #{new_state} for #{self}, keep waiting.")
               else
-                logger.trace("Item changed to #{state} for #{self}, canceling timer.")
+                logger.trace("Item changed from #{old_state} to #{new_state} for #{self}, canceling timer.")
                 @timer.cancel
                 # Reprocess trigger delay after canceling to track new state (if guards matched, etc)
-                process_trigger_delay(mod, inputs, &block)
+                process(mod: mod, inputs: inputs, &block)
               end
             end
           end

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

@@ -1,25 +1,17 @@
 # frozen_string_literal: true
 
-require 'openhab/log/logger'
-
 module OpenHAB
   module DSL
     module Rules
       module Triggers
-        #
-        # Module for conditions for triggers
-        #
+        # @!visibility private
         module Conditions
-          include OpenHAB::Log
-
           #
           # This creates trigger conditions that work on procs
           # @param [Proc] from Proc
           # @param [Proc] to Proc
           #
           class Proc
-            include OpenHAB::Log
-
             #
             # Converts supplied ranges to procs that check range
             # @param [Array] ranges objects to convert to range proc if they are ranges
@@ -63,8 +55,8 @@ module OpenHAB
             def self.from_value(value)
               logger.trace("Creating proc for Value(#{value})")
               return value if value.nil?
-              return value if value.is_a? ::Proc
-              return range_proc(value) if value.is_a? Range
+              return value if value.is_a?(::Proc)
+              return range_proc(value) if value.is_a?(Range)
 
               equality_proc(value)
             end
@@ -98,7 +90,7 @@ module OpenHAB
             # @return [true/false] depending on if from is set and matches supplied conditions
             #
             def check_command(inputs: nil)
-              command = input_state(inputs, 'command')
+              command = input_state(inputs, "command")
               logger.trace "Checking command(#{@command}) against command(#{command})"
               check_proc(proc: @command, value: command)
             end
@@ -110,7 +102,7 @@ module OpenHAB
             # @return [true/false] depending on if from is set and matches supplied conditions
             #
             def check_from(inputs: nil, state: nil)
-              state ||= input_state(inputs, 'oldState')
+              state ||= input_state(inputs, "oldState")
               logger.trace "Checking from(#{@from}) against state(#{state})"
               check_proc(proc: @from, value: state)
             end
@@ -122,7 +114,7 @@ module OpenHAB
             # @return [true/false] depending on if from is set and matches supplied conditions
             #
             def check_to(inputs: nil, state: nil)
-              state ||= input_state(inputs, 'newState', 'state')
+              state ||= input_state(inputs, "newState", "state")
               logger.trace "Checking to(#{@to}) against state(#{state})"
               check_proc(proc: @to, value: state)
             end

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

@@ -1,64 +1,18 @@
 # frozen_string_literal: true
 
-require 'java'
-require 'openhab/dsl/rules/triggers/trigger'
+require "openhab/dsl/rules/triggers/trigger"
 
 module OpenHAB
   module DSL
     module Rules
-      #
-      # Cron type rules
-      #
       module Triggers
-        #
-        # Create a rule that executes at the specified interval
-        #
-        # @param [Object] value String, Symbol, Duration, or MonthDay to execute this rule
-        # @param [Object] at TimeOfDay or String representing TimeOfDay in which to execute rule
-        # @param [Object] attach object to be attached to the trigger
-        #
-        #
-        def every(value, at: nil, attach: nil)
-          return every(MonthDay.parse(value), at: at, attach: attach) if value.is_a? String
-
-          @ruby_triggers << [:every, value, { at: at }]
-
-          cron_expression = case value
-                            when Symbol then Cron.from_symbol(value, at)
-                            when java.time.Duration then Cron.from_duration(value, at)
-                            when java.time.MonthDay then Cron.from_monthday(value, at)
-                            else raise ArgumentError, 'Unknown interval'
-                            end
-          cron(cron_expression, attach: attach)
-        end
-
-        #
-        # Create a OpenHAB Cron trigger
-        #
-        # @param [String] expression OpenHAB style cron expression
-        # @param [Object] attach object to be attached to the trigger
-        # @param [Hash] fields cron expression elements (second, minute, hour, dom, month, dow, year)
-        #
-        def cron(expression = nil, attach: nil, **fields)
-          if fields.any?
-            raise ArgumentError, 'Cron elements cannot be used with a cron expression' if expression
-
-            cron_expression = Cron.from_fields(fields)
-            return cron(cron_expression, attach: attach)
-          end
-
-          raise ArgumentError, 'Missing cron expression or elements' unless expression
-
-          cron = Cron.new(rule_triggers: @rule_triggers)
-          cron.trigger(config: { 'cronExpression' => expression }, attach: attach)
-        end
-
+        # @!visibility private
         #
         # Creates cron triggers
         #
         class Cron < Trigger
-          # Trigger ID for Watch Triggers
-          CRON_TRIGGER_MODULE_ID = 'jsr223.jruby.CronTrigger'
+          # Trigger ID for Cron Triggers
+          CRON_TRIGGER_MODULE_ID = "jsr223.jruby.CronTrigger"
 
           #
           # Returns a default map for cron expressions that fires every second
@@ -69,25 +23,25 @@ module OpenHAB
           #
           CRON_EXPRESSION_MAP =
             {
-              second: '*',
-              minute: '*',
-              hour: '*',
-              dom: '?',
-              month: '*',
-              dow: '?',
-              year: '*'
+              second: "*",
+              minute: "*",
+              hour: "*",
+              dom: "?",
+              month: "*",
+              dow: "?",
+              year: "*"
             }.freeze
           private_constant :CRON_EXPRESSION_MAP
 
-          # @return [Hash] Map of days of the week from symbols to to OpenHAB cron strings
+          # @return [Hash] Map of days of the week from symbols to to openHAB cron strings
           DAY_OF_WEEK_MAP = {
-            monday: 'MON',
-            tuesday: 'TUE',
-            wednesday: 'WED',
-            thursday: 'THU',
-            friday: 'FRI',
-            saturday: 'SAT',
-            sunday: 'SUN'
+            monday: "MON",
+            tuesday: "TUE",
+            wednesday: "WED",
+            thursday: "THU",
+            friday: "FRI",
+            saturday: "SAT",
+            sunday: "SUN"
           }.freeze
           private_constant :DAY_OF_WEEK_MAP
 
@@ -99,12 +53,12 @@ module OpenHAB
           # @return [Hash] Create a set of cron expressions based on different time intervals
           EXPRESSION_MAP = {
             second: CRON_EXPRESSION_MAP,
-            minute: CRON_EXPRESSION_MAP.merge(second: '0'),
-            hour: CRON_EXPRESSION_MAP.merge(second: '0', minute: '0'),
-            day: CRON_EXPRESSION_MAP.merge(second: '0', minute: '0', hour: '0'),
-            week: CRON_EXPRESSION_MAP.merge(second: '0', minute: '0', hour: '0', dow: 'MON'),
-            month: CRON_EXPRESSION_MAP.merge(second: '0', minute: '0', hour: '0', dom: '1'),
-            year: CRON_EXPRESSION_MAP.merge(second: '0', minute: '0', hour: '0', dom: '1', month: '1')
+            minute: CRON_EXPRESSION_MAP.merge(second: "0"),
+            hour: CRON_EXPRESSION_MAP.merge(second: "0", minute: "0"),
+            day: CRON_EXPRESSION_MAP.merge(second: "0", minute: "0", hour: "0"),
+            week: CRON_EXPRESSION_MAP.merge(second: "0", minute: "0", hour: "0", dow: "MON"),
+            month: CRON_EXPRESSION_MAP.merge(second: "0", minute: "0", hour: "0", dom: "1"),
+            year: CRON_EXPRESSION_MAP.merge(second: "0", minute: "0", hour: "0", dom: "1", month: "1")
           }.merge(DAY_OF_WEEK_EXPRESSION_MAP).freeze
 
           private_constant :EXPRESSION_MAP
@@ -112,8 +66,8 @@ module OpenHAB
           #
           # Create a cron map from a duration
           #
-          # @param [java.time.Duration] duration
-          # @param [Object] at TimeOfDay or String representing time of day
+          # @param [Duration] duration
+          # @param [Object] at LocalTime or String representing time of day
           #
           # @return [Hash] map describing cron expression
           #
@@ -126,8 +80,8 @@ module OpenHAB
           #
           # Create a cron map from a MonthDay
           #
-          # @param [java.time.MonthDay] monthday a {MonthDay} object
-          # @param [Object] at TimeOfDay or String representing time of day
+          # @param [MonthDay] monthday a {MonthDay} object
+          # @param [Object] at LocalTime or String representing time of day
           #
           # @return [Hash] map describing cron expression
           #
@@ -141,7 +95,7 @@ module OpenHAB
           # Create a cron map from a symbol
           #
           # @param [Symbol] symbol
-          # @param [Object] at TimeOfDay or String representing time of day
+          # @param [Object] at LocalTime or String representing time of day
           #
           # @return [Hash] map describing cron expression created from symbol
           #
@@ -159,8 +113,19 @@ module OpenHAB
           # @return [Hash] map describing cron expression
           #
           def self.from_fields(fields)
-            fields = fields.transform_values { |value| value.to_s.gsub(/\s+/, '') }
-            expression_map = CRON_EXPRESSION_MAP.merge(fields)
+            extra_fields = fields.keys - CRON_EXPRESSION_MAP.keys
+            unless extra_fields.empty?
+              raise ArgumentError,
+                    "unknown keyword#{"s" if extra_fields.size > 1}: #{extra_fields.map(&:inspect).join(", ")}"
+            end
+
+            fields = fields.transform_values { |value| value.to_s.delete(" ") }
+            # find the first expression map that has a field from fields.
+            # this ensure more-specific fields get set to 0, not *
+            base_key = EXPRESSION_MAP.keys.find { |field, _| fields.key?(field) }
+            base_expression = EXPRESSION_MAP[base_key]
+            expression_map = base_expression.merge(fields)
+
             map_to_cron(expression_map)
           end
 
@@ -169,16 +134,16 @@ module OpenHAB
           #
           # @param [Map] map of cron expression
           #
-          # @return [String] OpenHAB cron string
+          # @return [String] openHAB cron string
           #
           def self.map_to_cron(map)
-            %i[second minute hour dom month dow year].map { |field| map.fetch(field) }.join(' ')
+            %i[second minute hour dom month dow year].map { |field| map.fetch(field) }.join(" ")
           end
 
           #
           # Convert a Java Duration to a map for the map_to_cron method
           #
-          # @param duration [java.time.Duration] The duration object
+          # @param duration [Duration] The duration object
           #
           # @return [Hash] a map suitable for map_to_cron
           #
@@ -207,7 +172,7 @@ module OpenHAB
           #
           def self.at_condition(expression_map, at_time)
             if at_time
-              tod = at_time.is_a?(TimeOfDay::TimeOfDay) ? at_time : TimeOfDay::TimeOfDay.parse(at_time)
+              tod = at_time.is_a?(LocalTime) ? at_time : LocalTime.parse(at_time)
               expression_map = expression_map.merge(hour: tod.hour, minute: tod.minute, second: tod.second)
             end
             expression_map
@@ -221,6 +186,7 @@ module OpenHAB
           #
           #
           def trigger(config:, attach:)
+            CronHandler::CronTriggerHandlerFactory.instance # ensure it's registered
             append_trigger(type: CRON_TRIGGER_MODULE_ID, config: config, attach: attach)
           end
         end

data/lib/openhab/dsl/rules/triggers/cron/cron_handler.rb

@@ -1,55 +1,22 @@
 # frozen_string_literal: true
 
-require 'java'
-require_relative 'cron'
+require "singleton"
+
+require_relative "cron"
 
 module OpenHAB
   module DSL
     module Rules
-      #
-      # Cron type rules
-      #
       module Triggers
+        # @!visibility private
         #
         # Cron trigger handler that provides trigger ID
         #
         module CronHandler
-          include OpenHAB::Log
-
-          #
-          # Creates trigger types and trigger type factories for OpenHAB
-          #
-          def self.add_script_cron_handler
-            java_import org.openhab.core.automation.type.TriggerType
-            OpenHAB::Core.automation_manager.add_trigger_handler(
-              OpenHAB::DSL::Rules::Triggers::Cron::CRON_TRIGGER_MODULE_ID,
-              OpenHAB::DSL::Rules::Triggers::CronHandler::CronTriggerHandlerFactory.new
-            )
-
-            OpenHAB::Core.automation_manager.add_trigger_type(cron_trigger_type)
-            OpenHAB::Log.logger(self).trace('Added script cron trigger handler')
-          end
-
-          #
-          # Creates trigger types and trigger type factories for OpenHAB
-          #
-          private_class_method def self.cron_trigger_type
-            TriggerType.new(
-              OpenHAB::DSL::Rules::Triggers::Cron::CRON_TRIGGER_MODULE_ID,
-              nil,
-              'A specific instant occurs',
-              'Triggers when the specified instant occurs',
-              nil,
-              org.openhab.core.automation.Visibility::VISIBLE,
-              nil
-            )
-          end
-
           # Cron Trigger Handler that provides trigger IDs
-          # Unfortunatly because the CronTriggerHandler in OpenHAB core is marked internal
+          # Unfortunatly because the CronTriggerHandler in openHAB core is marked internal
           # the entire thing must be recreated here
           class CronTriggerHandler < org.openhab.core.automation.handler.BaseTriggerModuleHandler
-            include OpenHAB::Log
             include org.openhab.core.scheduler.SchedulerRunnable
             include org.openhab.core.automation.handler.TimeBasedTriggerHandler
 
@@ -57,13 +24,13 @@ module OpenHAB
             field_accessor :callback
 
             # Creates a new CronTriggerHandler
-            # @param [Trigger] trigger OpenHAB trigger associated with handler
+            # @param [org.openhab.core.automation.Trigger] trigger openHAB trigger associated with handler
             #
             def initialize(trigger)
               @trigger = trigger
-              @scheduler = OpenHAB::Core::OSGI.service('org.openhab.core.scheduler.CronScheduler')
+              @scheduler = OSGi.service("org.openhab.core.scheduler.CronScheduler")
               @schedule = nil
-              @expression = trigger.configuration.get('cronExpression')
+              @expression = trigger.configuration.get("cronExpression")
               super(trigger)
             end
 
@@ -91,7 +58,7 @@ module OpenHAB
             # Execute the callback
             #
             def run
-              callback&.triggered(@trigger, { 'module' => @trigger.id })
+              callback&.triggered(@trigger, { "module" => @trigger.id })
             end
 
             #
@@ -112,10 +79,29 @@ module OpenHAB
 
           # Implements the ScriptedTriggerHandlerFactory interface to create a new Cron Trigger Handler
           class CronTriggerHandlerFactory
+            include Singleton
             include org.openhab.core.automation.module.script.rulesupport.shared.factories.ScriptedTriggerHandlerFactory
 
-            # Invoked by the OpenHAB core to get a trigger handler for the supllied trigger
-            # @param [Trigger] trigger OpenHAB trigger
+            def initialize
+              Core.automation_manager.add_trigger_handler(
+                Cron::CRON_TRIGGER_MODULE_ID,
+                self
+              )
+
+              Core.automation_manager.add_trigger_type(org.openhab.core.automation.type.TriggerType.new(
+                                                         Cron::CRON_TRIGGER_MODULE_ID,
+                                                         nil,
+                                                         "A specific instant occurs",
+                                                         "Triggers when the specified instant occurs",
+                                                         nil,
+                                                         org.openhab.core.automation.Visibility::VISIBLE,
+                                                         nil
+                                                       ))
+              logger.trace("Added script cron trigger handler")
+            end
+
+            # Invoked by openHAB core to get a trigger handler for the supplied trigger
+            # @param [org.openhab.core.automation.Trigger] trigger
             #
             # @return [WatchTriggerHandler] trigger handler for supplied trigger
             def get(trigger)
@@ -127,6 +113,3 @@ module OpenHAB
     end
   end
 end
-
-# Add the cron handler to OpenHAB
-OpenHAB::DSL::Rules::Triggers::CronHandler.add_script_cron_handler

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

@@ -1,40 +1,19 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module OpenHAB
   module DSL
     module Rules
-      #
-      # Module holds rule triggers
-      #
       module Triggers
+        # @!visibility private
         #
         # Class for creating and managing triggers
         #
         class Trigger
           extend Forwardable
 
-          # Provide backwards compatibility for these fields
-          delegate :append_trigger => :@rule_triggers
-
-          #
-          # Separates groups from items, and flattens any nested arrays of items
-          #
-          # @param [Array] item_array Array of items passed to a trigger
-          #
-          # @return [Array] A new flat array with any GroupMembers object left intact
-          #
-          def self.flatten_items(item_array)
-            # we want to support anything that can be flattened... i.e. responds to to_ary
-            # we want to be more lenient than only things that are currently Array,
-            # but Enumerable is too lenient because Array#flatten won't traverse interior
-            # Enumerables
-            return item_array unless item_array.find { |item| item.respond_to?(:to_ary) }
-
-            groups, items = item_array.partition { |item| item.is_a?(OpenHAB::DSL::Items::GroupItem::GroupMembers) }
-            groups + flatten_items(items.flatten(1))
-          end
+          delegate append_trigger: :@rule_triggers
 
           #
           # Creates a new Trigger
@@ -54,9 +33,9 @@ module OpenHAB
           # @return [Array] Trigger and config for thing
           #
           def trigger_for_thing(thing:, type:, to: nil, from: nil)
-            config = { 'thingUID' => thing.uid.to_s }
-            config['status'] = trigger_state_from_symbol(to).to_s if to
-            config['previousStatus'] = trigger_state_from_symbol(from).to_s if from
+            config = { "thingUID" => thing.to_s }
+            config["status"] = trigger_state_from_symbol(to).to_s if to
+            config["previousStatus"] = trigger_state_from_symbol(from).to_s if from
             [type, config]
           end
 
@@ -68,7 +47,7 @@ module OpenHAB
           # @return [String] Upcased symbol as string
           #
           def trigger_state_from_symbol(sym)
-            sym.to_s.upcase if (sym.is_a? Symbol) || sym
+            sym.to_s.upcase if sym.is_a?(Symbol) || sym
           end
         end
       end