openhab-scripting 4.28.1 → 4.28.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 824e2af85aba6737c05884f3f6ca06adc1873a388b8091062781b274290c6476
-  data.tar.gz: 159ed6ce10d55640c37b61429a937f4dafaecf529479b3423552bff9d929d30d
+  metadata.gz: 7c9d9745b2590c4152baf18a82dbe0063ac4c73c94f6f452d9d848790d8eb06a
+  data.tar.gz: 276152f1a79cf44fb539f4bb0c73618263db8d4a944cf367fa0ef1db167d989a
 SHA512:
-  metadata.gz: 3f6f18504814c73aad6e9c5d5a7548ae17165dff3d4f85a618103f79574389d201c82a528ec09b27b37e975b05b47bb0cd78e958ba0a4bb3b094314f842b9c0e
-  data.tar.gz: d0baf3b51e76656b68e24faa3ceb8d0e76e6afea89b2ba6f81c152ce0f2ddb560fe1942af225f8f1b7ace9c5d3e9c1605c83a1654bddecdceb16f57d47c93b6e
+  metadata.gz: d66efa237735b6a754e97eb933a301cb5dd639fa7cc715fa7d36c3e6f7ed14c11a3da874ea707792cb0913bb9e57396b33532746b7a63b08acf50ff15d4fc9f0
+  data.tar.gz: b2fcbb63e5e9da86909dd7b7b2bcb054b29aea1b80ae59fb26555a7aa678a7f4ebe04ee36dda69413c7cc8fbe08c7beeeaa5ad333e09d4bac08bbe2b769e85e7

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
@@ -70,44 +69,14 @@ module OpenHAB
       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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.28.1
+  version: 4.28.2
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-15 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