openhab-scripting 4.27.0 → 4.28.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16eb15617a1a088c561a6d12e1f6e2ba39459491c9e831933ff235d3177ba225
-  data.tar.gz: 40f21e9e4bb53c04f1bd9e4ee51b834756783218584f05728e26860eb95d491c
+  metadata.gz: 7c9d9745b2590c4152baf18a82dbe0063ac4c73c94f6f452d9d848790d8eb06a
+  data.tar.gz: 276152f1a79cf44fb539f4bb0c73618263db8d4a944cf367fa0ef1db167d989a
 SHA512:
-  metadata.gz: ac79f5e48d51ec69530c88fe05541e3c6051df205858371a5f450a226d680940058023cab20df0037c148293f60e9b85e20768669c48657ead01ee828097a16a
-  data.tar.gz: e8b218bdd0ecedbb3910c9859bb43e8f06c5372ffc7aa94a6fae0abe7f5defeff8d3a3f6fdee1af9337e8a2684ea2ce194d9e09344f5144650c38b1e91c9f9ea
+  metadata.gz: d66efa237735b6a754e97eb933a301cb5dd639fa7cc715fa7d36c3e6f7ed14c11a3da874ea707792cb0913bb9e57396b33532746b7a63b08acf50ff15d4fc9f0
+  data.tar.gz: b2fcbb63e5e9da86909dd7b7b2bcb054b29aea1b80ae59fb26555a7aa678a7f4ebe04ee36dda69413c7cc8fbe08c7beeeaa5ad333e09d4bac08bbe2b769e85e7

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

@@ -53,7 +53,11 @@ module OpenHAB
           # sending the command
           def command(command)
             return super unless Thread.current[:ensure_states]
-            return if command == state
+
+            logger.trace do
+              "#{name} ensure #{command}, format_type_pre: #{format_type_pre(command)}, current state: #{state}"
+            end
+            return if state == format_type_pre(command)
 
             super
           end

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

@@ -135,7 +135,7 @@ module OpenHAB
         # @return [Array<Group>] All groups that this item is part of
         #
         def groups
-          group_names.map { |name| Groups.groups[name] }
+          group_names.map { |name| Groups.groups[name] }.compact
         end
 
         # Return the item's thing if this item is linked with a thing. If an item is linked to more than one thing,

data/lib/openhab/dsl/rules/automation_rule.rb

@@ -304,7 +304,7 @@ module OpenHAB
           end
           false
         rescue StandardError => e
-          print_backtrace(e)
+          logger.log_exception(e, name)
         end
         # rubocop:enable Metrics/MethodLength
 
@@ -328,7 +328,7 @@ module OpenHAB
             end
           end
         rescue StandardError => e
-          print_backtrace(e)
+          logger.log_exception(e, name)
         end
 
         #
@@ -399,16 +399,6 @@ module OpenHAB
           @run_context.instance_exec(event, &task.block)
         end
 
-        #
-        # Print error and stack trace without calls to internal classes
-        #
-        # @param [Exception] error A rescued error
-        #
-        def print_backtrace(error)
-          error = logger.clean_backtrace(error)
-          logger.error { "#{error.message} (#{error.class})\nIn rule: #{name}\n#{error.backtrace&.join("\n")}" }
-        end
-
         #
         # Create a new hash in which all elements are converted to strings
         #

data/lib/openhab/dsl/rules/rule.rb

@@ -5,7 +5,6 @@ require 'openhab/core/services'
 require 'openhab/log/logger'
 require_relative 'rule_config'
 require_relative 'automation_rule'
-require_relative 'cron_trigger_rule'
 require_relative 'guard'
 
 module OpenHAB
@@ -26,7 +25,7 @@ module OpenHAB
       @registry = OpenHAB::Core.rule_registry
       class << self
         attr_reader :script_rules, :automation_manager, :registry
-end
+      end
 
       #
       # Create a new rule
@@ -35,7 +34,7 @@ end
       # @yield [] Block executed in context of a RuleConfig
       #
       #
-      # rubocop: disable Metrics
+      # rubocop: disable Metrics/MethodLength
       def rule(rule_name, &block)
         thread_local(RULE_NAME: rule_name) do
           @rule_name = rule_name
@@ -47,10 +46,9 @@ end
           nil # Must return something other than the rule object. See https://github.com/boc-tothefuture/openhab-jruby/issues/438
         end
       rescue StandardError => e
-        puts "#{e.class}: #{e.message}"
-        re_raise_with_backtrace(e)
+        logger.log_exception(e, @rule_name)
       end
-      # rubocop: enable Metrics
+      # rubocop: enable Metrics/MethodLength
 
       #
       # Cleanup rules in this script file
@@ -62,16 +60,6 @@ end
 
       private
 
-      #
-      # Re-raises a rescued error to OpenHAB with added rule name and stack trace
-      #
-      # @param [Exception] error A rescued error
-      #
-      def re_raise_with_backtrace(error)
-        error = logger.clean_backtrace(error)
-        raise error, "#{error.message}\nIn rule: #{@rule_name}\n#{error.backtrace.join("\n")}"
-      end
-
       #
       # Process a rule based on the supplied configuration
       #
@@ -81,44 +69,14 @@ end
       def process_rule_config(config)
         return unless create_rule?(config)
 
-        cron_attach_triggers, other_triggers = partition_triggers(config)
-        logger.trace("Cron triggers: #{cron_attach_triggers} -  Other triggers: #{other_triggers}")
-        config.triggers = other_triggers
-
         rule = AutomationRule.new(config: config)
         Rules.script_rules << rule
         add_rule(rule)
 
-        process_cron_attach(cron_attach_triggers, config, rule)
-
         rule.execute(nil, { 'event' => Struct.new(:attachment).new(config.start_attachment) }) if config.on_start?
         rule
       end
 
-      #
-      # Add cron triggers with attachments to rules
-      # @param [Array] cron_attach_triggers cron type triggers with attachments
-      #
-      def process_cron_attach(cron_attach_triggers, config, rule)
-        cron_attach_triggers&.map { |trigger| CronTriggerRule.new(rule_config: config, rule: rule, trigger: trigger) }
-                            &.each { |trigger| add_rule(trigger) }
-      end
-
-      #
-      # Partitions triggers in a config, removing cron triggers with a corresponding attachment
-      # so they can be used with CronTriggerRules to support attachments
-      # @return [Array] Two element array the first element is cron triggers with attachments,
-      #   second element is other triggers
-      #
-      def partition_triggers(config)
-        config
-          .triggers
-          .partition do |trigger|
-          trigger.typeUID == OpenHAB::DSL::Rules::Triggers::Trigger::CRON &&
-            config.attachments.key?(trigger.id)
-        end
-      end
-
       #
       # Should a rule be created based on rule configuration
       #

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/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/timers/manager.rb

@@ -39,7 +39,7 @@ module OpenHAB
 
           if timer.respond_to? :id
             logger.trace("Adding #{timer} with id #{timer.id.inspect} timer ids")
-            @timer_ids[timer.id] = Set.new unless @timer_ids[timer.id]
+            @timer_ids[timer.id] = TimerSet.new unless @timer_ids[timer.id]
             @timer_ids[timer.id] << timer
           end
 
@@ -87,6 +87,19 @@ module OpenHAB
           @timers.clear
         end
       end
+
+      #
+      # Provide additional methods for the timers set
+      #
+      class TimerSet < Set
+        #
+        # A shorthand to cancel all the timer objects held within the set
+        # so that timers[timer_id].cancel_all is equivalent to timers[timer_id].each(&:cancel)
+        #
+        def cancel_all
+          each(&:cancel)
+        end
+      end
     end
   end
 end

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.27.0'
+  VERSION = '4.28.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.27.0
+  version: 4.28.2
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-06 00:00:00.000000000 Z
+date: 2022-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,7 +97,6 @@ files:
 - lib/openhab/dsl/openhab.rb
 - lib/openhab/dsl/persistence.rb
 - lib/openhab/dsl/rules/automation_rule.rb
-- lib/openhab/dsl/rules/cron_trigger_rule.rb
 - lib/openhab/dsl/rules/guard.rb
 - lib/openhab/dsl/rules/item_event.rb
 - lib/openhab/dsl/rules/property.rb

data/lib/openhab/dsl/rules/cron_trigger_rule.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-require 'openhab/log/logger'
-
-module OpenHAB
-  module DSL
-    #
-    # Creates and manages OpenHAB Rules
-    #
-    module Rules
-      #
-      # Specialized rule for cron triggers with attachments because OpenHAB does not provide trigger UID for cron rules
-      #
-      class CronTriggerRule < Java::OrgOpenhabCoreAutomationModuleScriptRulesupportSharedSimple::SimpleRule
-        include OpenHAB::Log
-
-        def initialize(rule_config:, rule:, trigger:)
-          super()
-          set_name("#{rule_config.name}-cron-#{trigger.id}")
-          set_triggers([trigger])
-          @rule = rule
-          @trigger = trigger
-          logger.trace("Created Cron Trigger Rule for #{@trigger}")
-        end
-
-        #
-        # Execute the rule
-        #
-        # @param [Map] mod map provided by OpenHAB rules engine
-        # @param [Map] inputs map provided by OpenHAB rules engine containing event and other information
-        #
-        #
-        def execute(mod = nil, _inputs = nil)
-          logger.trace "Trigger #{@trigger} fired for base rule #{@rule.inspect}"
-          inputs = { 'module' => @trigger.id }
-          @rule.execute(mod, inputs)
-        end
-      end
-    end
-  end
-end