openhab-scripting 4.28.0 → 4.30.0

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

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require 'openhab/log/logger'
+
+module OpenHAB
+  module DSL
+    module Rules
+      module Triggers
+        #
+        # Module for conditions for triggers
+        #
+        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
+
+            # Proc that doesn't check any fields
+            ANY = Proc.new.freeze
+
+            #
+            # Converts supplied ranges to procs that check range
+            # @param [Array] ranges objects to convert to range proc if they are ranges
+            # @return [Array] of procs or supplied arguments if argument was not of type Range
+            #
+            def self.range_procs(*ranges)
+              ranges.map { |range| range.is_a?(Range) ? range_proc(range) : range }
+            end
+
+            #
+            # Create a range proc for the supplied range object
+            # @param [Range] range to build proc for
+            #
+            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
+              end
+            end
+
+            #
+            # Create a range proc for the supplied range object
+            # @param [Range] range to build proc for
+            #
+            def self.equality_proc(value)
+              logger.trace("Creating equality proc for #{value}")
+              lambda do |state|
+                logger.trace("Equality proc comparing #{value} against #{state}")
+                value == state
+              end
+            end
+
+            #
+            # Constructs a proc for the specific value type
+            #  if the value is a proc return the proc
+            #  if the value is a range create a range proc
+            #  if the value is nil, return nil
+            #  otherwise create an equality proc
+            # @param [Object] value to construct proc from
+            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
+
+              equality_proc(value)
+            end
+
+            #
+            # Create a new Proc Condition that executes only if procs return true
+            # @param [Proc] from Proc to check against from value
+            # @param [Proc] to Proc to check against to value
+            #
+            def initialize(from: nil, to: nil)
+              @from = from
+              @to = to
+            end
+
+            #
+            # Process rule
+            # @param [Hash] inputs inputs from trigger
+            #
+            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)
+            end
+
+            #
+            # Check if from condition match the proc
+            # @param [Hash] inputs from trigger must be supplied if state is not supplied
+            # @param [String] state if supplied proc will be passed state value for comparision
+            # @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')
+              logger.trace "Checking from(#{@from}) against state(#{state})"
+              check_proc(proc: @from, state: state)
+            end
+
+            #
+            # Check if to conditions match the proc
+            # @param [Hash] inputs from trigger must be supplied if state is not supplied
+            # @param [String] state if supplied proc will be passed state value for comparision
+            # @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')
+              logger.trace "Checking to(#{@to}) against state(#{state})"
+              check_proc(proc: @to, state: state)
+            end
+
+            # Describe the Proc Condition as a string
+            # @return [String] string representation of proc condition
+            #
+            def to_s
+              "From:(#{@from}) To:(#{@to})"
+            end
+
+            private
+
+            # 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
+            # @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)
+
+              logger.trace("Skipped execution of rule because state #{state} evalulated false for (#{proc})")
+              false
+            end
+
+            # Get the first field from supplied fields in inputs
+            # @param [Hash] inputs containing fields
+            # @param [Array] fields array of fields to extract from inputs, first one found is returned
+            def input_state(inputs, *fields)
+              fields.map { |f| inputs[f] }.compact.first
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -164,7 +164,125 @@ module OpenHAB
           end
           expression_map
         end
+
+        #
+        # Cron trigger that provides trigger ID
+        #
+        module Cron
+          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::Cron::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
+
+          # Trigger ID for Watch Triggers
+          CRON_TRIGGER_MODULE_ID = 'jsr223.jruby.CronTrigger'
+
+          # Cron Trigger Handler that provides trigger IDs
+          # 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
+
+            # Provides access to protected fields
+            field_accessor :callback
+
+            # Creates a new CronTriggerHandler
+            # @param [Trigger] OpenHAB trigger associated with handler
+            #
+            def initialize(trigger)
+              @trigger = trigger
+              @scheduler = OpenHAB::Core::OSGI.service('org.openhab.core.scheduler.CronScheduler')
+              @expression = trigger.configuration.get('cronExpression')
+              super(trigger)
+            end
+
+            #
+            # Set the callback to execute when cron trigger fires
+            # @param [Object] callback to run
+            #
+            def setCallback(callback) # rubocop:disable Naming/MethodName
+              synchronized do
+                super(callback)
+                @scheduler.schedule(self, @expression)
+                logger.trace("Scheduled cron job '#{@expression}' for trigger '#{@trigger.id}'.")
+              end
+            end
+
+            #
+            # Get the temporal adjuster
+            # @return [CronAdjuster]
+            #
+            def getTemporalAdjuster # rubocop:disable Naming/MethodName
+              org.openhab.core.scheduler.CronAdjuster.new(expression)
+            end
+
+            #
+            # Execute the callback
+            #
+            def run
+              callback&.triggered(@trigger, { 'module' => @trigger.id })
+            end
+
+            #
+            # Displose of the handler
+            # cancel the cron scheduled task
+            #
+            def dispose
+              synchronized do
+                super
+                return unless @schedule
+
+                @schedule&.cancel(true)
+              end
+              logger.trace("cancelled job for trigger '#{@trigger.id}'.")
+            end
+          end
+
+          # Implements the ScriptedTriggerHandlerFactory interface to create a new Cron Trigger Handler
+          class CronTriggerHandlerFactory
+            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] OpenHAB trigger
+            #
+            # @return [WatchTriggerHandler] trigger handler for supplied trigger
+            def get(trigger)
+              CronTriggerHandler.new(trigger)
+            end
+          end
+        end
       end
     end
   end
 end
+
+# Add the cron handler to OpenHAB
+OpenHAB::DSL::Rules::Triggers::Cron.add_script_cron_handler

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

@@ -2,6 +2,7 @@
 
 require 'securerandom'
 require 'java'
+require_relative 'cron'
 
 module OpenHAB
   module DSL
@@ -111,7 +112,7 @@ module OpenHAB
           TIME_OF_DAY = 'timer.TimeOfDayTrigger'
 
           # @return [String] A cron trigger
-          CRON = 'timer.GenericCronTrigger'
+          CRON = OpenHAB::DSL::Rules::Triggers::Cron::CRON_TRIGGER_MODULE_ID
 
           #
           # Create a trigger

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'openhab/log/logger'
+require_relative 'trigger'
 
 module OpenHAB
   module DSL
@@ -23,29 +24,71 @@ module OpenHAB
           separate_groups(items).map do |item|
             logger.trace("Creating updated trigger for item(#{item}) to(#{to})")
             [to].flatten.map do |to_state|
-              trigger, config = create_update_trigger(item, to_state)
-              append_trigger(trigger, config, attach: attach)
+              update_trigger(item: item, to: to_state, attach: attach)
             end
           end.flatten
         end
 
         private
 
+        #
+        # Create the trigger
+        #
+        # @param [Object] item item to create trigger for
+        # @param [Item State] from state to restrict trigger to
+        # @param [Item State] to state to restrict trigger to
+        # @param attach attachment
+        #
+        # @return [Trigger] OpenHAB triggers
+        #
+        def update_trigger(item:, to:, attach:)
+          case to
+          when Range then create_update_range_trigger(item: item, to: to, attach: attach)
+          when Proc then create_update_proc_trigger(item: item, to: to, attach: attach)
+          else create_update_trigger(item: item, to: to, attach: attach)
+          end
+        end
+
+        #
+        # Creates a trigger with a range condition on the 'to' field
+        # @param [Object] item to create changed trigger on
+        # @param [Object] to state restrict trigger to
+        # @param [Object] attach to trigger
+        # @return [Trigger] OpenHAB trigger
+        #
+        def create_update_range_trigger(item:, to:, attach:)
+          to, * = Conditions::Proc.range_procs(to)
+          create_update_proc_trigger(item: item, to: to, attach: attach)
+        end
+
+        #
+        # Creates a trigger with a proc condition on the 'to' field
+        # @param [Object] item to create changed trigger on
+        # @param [Object] to state restrict trigger to
+        # @param [Object] attach to trigger
+        # @return [Trigger] OpenHAB trigger
+        #
+        def create_update_proc_trigger(item:, to:, attach:)
+          create_update_trigger(item: item, to: nil, attach: attach).tap do |trigger|
+            @trigger_conditions[trigger.id] = Conditions::Proc.new(to: to)
+          end
+        end
+
         #
         # Create a trigger for updates
         #
         # @param [Object] item Type of item [Group,Thing,Item] to create update trigger for
         # @param [State] to_state state restriction on trigger
         #
-        # @return [Array<Hash,String>] first element is a String specifying trigger type
-        #  second element is a Hash configuring trigger
+        # @return [Trigger] OpenHAB triggers
         #
-        def create_update_trigger(item, to_state)
-          case item
-          when OpenHAB::DSL::Items::GroupItem::GroupMembers then group_update(item, to_state)
-          when Thing then thing_update(item, to_state)
-          else item_update(item, to_state)
-          end
+        def create_update_trigger(item:, to:, attach:)
+          trigger, config = case item
+                            when OpenHAB::DSL::Items::GroupItem::GroupMembers then group_update(item: item, to: to)
+                            when Thing then thing_update(thing: item, to: to)
+                            else item_update(item: item, to: to)
+                            end
+          append_trigger(trigger, config, attach: attach)
         end
 
         #
@@ -57,9 +100,9 @@ module OpenHAB
         # @return [Array<Hash,String>] first element is a String specifying trigger type
         #  second element is a Hash configuring trigger
         #
-        def item_update(item, to_state)
+        def item_update(item:, to:)
           config = { 'itemName' => item.name }
-          config['state'] = to_state.to_s unless to_state.nil?
+          config['state'] = to.to_s unless to.nil?
           trigger = Trigger::ITEM_STATE_UPDATE
           [trigger, config]
         end
@@ -73,9 +116,9 @@ module OpenHAB
         # @return [Array<Hash,String>] first element is a String specifying trigger type
         #  second element is a Hash configuring trigger
         #
-        def group_update(item, to_state)
+        def group_update(item:, to:)
           config = { 'groupName' => item.group.name }
-          config['state'] = to_state.to_s unless to_state.nil?
+          config['state'] = to.to_s unless to.nil?
           trigger = Trigger::GROUP_STATE_UPDATE
           [trigger, config]
         end
@@ -89,8 +132,8 @@ module OpenHAB
         # @return [Array<Hash,String>] first element is a String specifying trigger type
         #  second element is a Hash configuring trigger
         #
-        def thing_update(thing, to_state)
-          trigger_for_thing(thing, Trigger::THING_UPDATE, to_state)
+        def thing_update(thing:, to:)
+          trigger_for_thing(thing, Trigger::THING_UPDATE, to)
         end
       end
     end

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

@@ -138,11 +138,9 @@ module OpenHAB
 
             # Called by OpenHAB to set the rule engine to invoke when triggered
             # Must match java method name style
-            # rubocop:disable Naming/MethodName
-            def setCallback(callback)
+            def setCallback(callback) # rubocop:disable Naming/MethodName
               @rule_engine_callback = callback
             end
-            # rubocop:enable Naming/MethodName
 
             #
             # Dispose of handler which deactivates watcher

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

@@ -7,8 +7,8 @@ require 'java'
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.DateTimeType
-      java_import java.time.ZonedDateTime
+      DateTimeType = org.openhab.core.library.types.DateTimeType
+      java_import java.time.ZonedDateTime # This is needed for the addon prior to ruby_class fix (OH 3.2.0)
 
       # global alias
       ::DateTimeType = DateTimeType

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

@@ -6,7 +6,7 @@ require_relative 'numeric_type'
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.DecimalType
+      DecimalType = org.openhab.core.library.types.DecimalType
 
       #
       # Add methods to core OpenHAB DecimalType to make it behave as a Ruby

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

@@ -6,7 +6,7 @@ require_relative 'percent_type'
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.HSBType
+      HSBType = org.openhab.core.library.types.HSBType
 
       # global alias
       ::HSBType = HSBType

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

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.IncreaseDecreaseType
+      IncreaseDecreaseType = org.openhab.core.library.types.IncreaseDecreaseType
 
       # Adds methods to core OpenHAB IncreaseDecreaseType to make it more
       # natural in Ruby

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

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.NextPreviousType
+      NextPreviousType = org.openhab.core.library.types.NextPreviousType
 
       # Adds methods to core OpenHAB NextPreviousType to make it more
       # natural in Ruby

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

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.OnOffType
+      OnOffType = org.openhab.core.library.types.OnOffType
 
       # Adds methods to core OpenHAB OnOffType to make it more natural in Ruby
       class OnOffType

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

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.OpenClosedType
+      OpenClosedType = org.openhab.core.library.types.OpenClosedType
 
       # Adds methods to core OpenHAB OpenClosedType to make it more natural in Ruby
       class OpenClosedType

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

@@ -5,7 +5,7 @@ require_relative 'decimal_type'
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.PercentType
+      PercentType = org.openhab.core.library.types.PercentType
 
       # global alias
       ::PercentType = PercentType

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

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.PlayPauseType
+      PlayPauseType = org.openhab.core.library.types.PlayPauseType
 
       # Adds methods to core OpenHAB PlayPauseType to make it more
       # natural in Ruby

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

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.PointType
+      PointType = org.openhab.core.library.types.PointType
 
       # global scope
       # @!visibility private

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

@@ -5,7 +5,7 @@ require_relative 'numeric_type'
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.QuantityType
+      QuantityType = org.openhab.core.library.types.QuantityType
 
       # global alias
       ::QuantityType = QuantityType

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

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.types.RefreshType
+      RefreshType = org.openhab.core.types.RefreshType
 
       # Adds methods to core OpenHAB RefreshType to make it more natural in Ruby
       class RefreshType # rubocop:disable Lint/EmptyClass

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

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.RewindFastforwardType
+      RewindFastforwardType = org.openhab.core.library.types.RewindFastforwardType
 
       # Adds methods to core OpenHAB RewindFastforwardType to make it more
       # natural in Ruby

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

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.StopMoveType
+      StopMoveType = org.openhab.core.library.types.StopMoveType
 
       # Adds methods to core OpenHAB StopMoveType to make it more
       # natural in Ruby

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

@@ -7,7 +7,7 @@ require_relative 'comparable_type'
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.StringType
+      StringType = org.openhab.core.library.types.StringType
 
       #
       # Add methods to core OpenHAB StringType to make it behave as a Ruby

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

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.types.UnDefType
+      UnDefType = org.openhab.core.types.UnDefType
 
       # Adds methods to core OpenHAB UnDefType to make it more natural in Ruby
       class UnDefType # rubocop:disable Lint/EmptyClass

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

@@ -3,7 +3,7 @@
 module OpenHAB
   module DSL
     module Types
-      java_import org.openhab.core.library.types.UpDownType
+      UpDownType = org.openhab.core.library.types.UpDownType
 
       # Adds methods to core OpenHAB UpDownType to make it more natural in Ruby
       class UpDownType

data/lib/openhab/log/configuration.rb

@@ -6,7 +6,7 @@ module OpenHAB
     # This module holds global configuration values
     module Configuration
       # -*- coding: utf-8 -*-
-      LOG_PREFIX = 'jsr223.jruby'
+      LOG_PREFIX = 'org.openhab.automation.jruby'
 
       #
       # Gets the log prefix

data/lib/openhab/log/logger.rb

@@ -82,6 +82,16 @@ module OpenHAB
         error
       end
 
+      #
+      # Print error and stack trace without calls to internal classes
+      #
+      # @param [Exception] error A rescued error
+      #
+      def log_exception(exception, rule_name)
+        exception = clean_backtrace(exception)
+        error { "#{exception.message} (#{exception.class})\nIn rule: #{rule_name}\n#{exception.backtrace&.join("\n")}" }
+      end
+
       private
 
       #

data/lib/openhab/version.rb

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