openhab-scripting 5.16.0 → 5.18.0

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

@@ -1,120 +1,118 @@
 # frozen_string_literal: true
 
 # @deprecated OH3.4 this module is not needed in OH4+
-if Gem::Version.new(OpenHAB::Core::VERSION) < Gem::Version.new("4.0.0")
-
-  require "singleton"
-
-  require_relative "cron"
-
-  module OpenHAB
-    module DSL
-      module Rules
-        module Triggers
-          # @!visibility private
-          #
-          # Cron trigger handler that provides trigger ID
-          #
-          module CronHandler
-            # 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 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 [org.openhab.core.automation.Trigger] trigger openHAB trigger associated with handler
-              #
-              def initialize(trigger)
-                @trigger = trigger
-                @scheduler = OSGi.service("org.openhab.core.scheduler.CronScheduler")
-                @schedule = nil
-                @expression = trigger.configuration.get("cronExpression")
-                super(trigger)
-              end
+return unless OpenHAB::Core.version < OpenHAB::Core::V4_0
+
+require "singleton"
+
+require_relative "cron"
+
+module OpenHAB
+  module DSL
+    module Rules
+      module Triggers
+        # @!visibility private
+        #
+        # Cron trigger handler that provides trigger ID
+        #
+        module CronHandler
+          # 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 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 [org.openhab.core.automation.Trigger] trigger openHAB trigger associated with handler
+            #
+            def initialize(trigger)
+              @trigger = trigger
+              @scheduler = OSGi.service("org.openhab.core.scheduler.CronScheduler")
+              @schedule = nil
+              @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)
-                  @schedule = @scheduler.schedule(self, @expression)
-                  logger.trace("Scheduled cron job '#{@expression}' for trigger '#{@trigger.id}'.")
-                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)
+                @schedule = @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
+            #
+            # 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
+            #
+            # Execute the callback
+            #
+            def run
+              callback&.triggered(@trigger, { "module" => @trigger.id })
+            end
 
-              #
-              # Dispose of the handler
-              # cancel the cron scheduled task
-              #
-              def dispose
-                synchronized do
-                  super
-                  return unless @schedule
+            #
+            # Dispose of the handler
+            # cancel the cron scheduled task
+            #
+            def dispose
+              synchronized do
+                super
+                return unless @schedule
 
-                  @schedule.cancel(true)
-                  @schedule = nil
-                end
-                logger.trace("cancelled job for trigger '#{@trigger.id}'.")
+                @schedule.cancel(true)
+                @schedule = nil
               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 Singleton
-              include org.openhab.core.automation.module.script.rulesupport.shared.factories.ScriptedTriggerHandlerFactory # rubocop:disable Layout/LineLength
-
-              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
+          # 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
+
+            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)
-                CronTriggerHandler.new(trigger)
-              end
+            # Invoked by openHAB core to get a trigger handler for the supplied trigger
+            # @param [org.openhab.core.automation.Trigger] trigger
+            #
+            # @return [CronTriggerHandler] trigger handler for supplied trigger
+            def get(trigger)
+              CronTriggerHandler.new(trigger)
             end
           end
         end
       end
     end
   end
-
 end

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

@@ -301,7 +301,7 @@ module OpenHAB
               Core.automation_manager.add_trigger_type(org.openhab.core.automation.type.TriggerType.new(
                                                          WATCH_TRIGGER_MODULE_ID,
                                                          nil,
-                                                         "A path change event is detected",
+                                                         "a path change event is detected",
                                                          "Triggers when a path change event is detected",
                                                          nil,
                                                          org.openhab.core.automation.Visibility::VISIBLE,
@@ -310,7 +310,7 @@ module OpenHAB
               logger.trace("Added watch trigger handler")
             end
 
-            # Invoked by openHAB core to get a trigger handler for the supllied trigger
+            # 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

data/lib/openhab/dsl/sitemaps/builder.rb

@@ -144,7 +144,7 @@ module OpenHAB
           if @builder_proxy
             old_obj = @builder_proxy.__getobj__
             @builder_proxy.__setobj__(self)
-            begin
+            DSL::ThreadLocal.thread_local(openhab_create_dummy_items: true) do
               yield @builder_proxy
             ensure
               @builder_proxy.__setobj__(old_obj)

data/lib/openhab/dsl/version.rb

@@ -4,6 +4,6 @@ module OpenHAB
   module DSL
     # Version of openHAB helper libraries
     # @return [String]
-    VERSION = "5.16.0"
+    VERSION = "5.18.0"
   end
 end

data/lib/openhab/dsl.rb

@@ -56,8 +56,14 @@ module OpenHAB
     # @!group Rule Creation
 
     # (see Rules::Builder#rule)
-    def rule(name = nil, **kwargs, &block)
-      rules.build { rule(name, **kwargs, &block) }
+    def rule(name = nil, id: nil, **kwargs, &block)
+      rules.build { rule(name, id: id, **kwargs, &block) }
+    end
+
+    # Creates a rule that will remove existing rules with the same id, even when the id has been inferred.
+    # @see rule
+    def rule!(name = nil, id: nil, **kwargs, &block)
+      rules.build { rule(name, id: id, replace: true, **kwargs, &block) }
     end
 
     # (see Rules::Builder#scene)
@@ -65,11 +71,27 @@ module OpenHAB
       rules.build { scene(name, description: description, id: id, tag: tag, tags: tags, **kwargs, &block) }
     end
 
+    # Creates a scene that will remove existing rules/scenes with the same id, even when the id has been inferred.
+    # @see scene
+    def scene!(name = nil, description: nil, id: nil, tag: nil, tags: nil, **kwargs, &block)
+      rules.build do
+        scene(name, description: description, id: id, tag: tag, tags: tags, replace: true, **kwargs, &block)
+      end
+    end
+
     # (see Rules::Builder#script)
     def script(name = nil, description: nil, id: nil, tag: nil, tags: nil, **kwargs, &block)
       rules.build { script(name, description: description, id: id, tag: tag, tags: tags, **kwargs, &block) }
     end
 
+    # Creates a script that will remove existing rules/scripts with the same id, even when the id has been inferred.
+    # @see script
+    def script!(name = nil, description: nil, id: nil, tag: nil, tags: nil, **kwargs, &block)
+      rules.build do
+        script(name, description: description, id: id, tag: tag, tags: tags, replace: true, **kwargs, &block)
+      end
+    end
+
     # @!group Rule Support
 
     # rubocop:disable Layout/LineLength
@@ -84,14 +106,17 @@ module OpenHAB
     # @param [String, nil] label The label for the profile. When nil, the profile will not be visible in the UI.
     # @param [org.openhab.core.config.core.ConfigDescription, nil] config_description
     #   The configuration description for the profile so that it can be configured in the UI.
-    # @yield [event, command: nil, state: nil, callback:, link:, item:, channel_uid:, configuration:, context:]
+    # @yield [event, command: nil, state: nil, time_series: nil, callback:, link:, item:, channel_uid:, configuration:, context:]
     #   All keyword params are optional. Any that aren't defined won't be passed.
-    # @yieldparam [:command_from_item, :state_from_item, :command_from_handler, :state_from_handler] event
+    # @yieldparam [:command_from_item, :state_from_item, :command_from_handler, :state_from_handler, :time_series_from_handler] event
     #   The event that needs to be processed.
     # @yieldparam [Command, nil] command
     #   The command being sent for `:command_from_item` and `:command_from_handler` events.
     # @yieldparam [State, nil] state
     #   The state being sent for `:state_from_item` and `:state_from_handler` events.
+    # @yieldparam [TimeSeries] time_series
+    #   The time series for `:time_series_from_handler` events.
+    #   Only available since openHAB 4.1.
     # @yieldparam [Core::Things::ProfileCallback] callback
     #   The callback to be used to customize the action taken.
     # @yieldparam [Core::Things::ItemChannelLink] link
@@ -105,6 +130,7 @@ module OpenHAB
     #
     # @see org.openhab.core.thing.profiles.Profile
     # @see org.openhab.core.thing.profiles.StateProfile
+    # @see org.openhab.core.thing.profiles.TimeSeriesProfile
     #
     # @example Vetoing a command
     #   profile(:veto_closing_shades) do |event, item:, command:|

data/lib/openhab/rspec/mocks/persistence_service.rb

@@ -7,6 +7,15 @@ module OpenHAB
         include org.openhab.core.persistence.ModifiablePersistenceService
         include Singleton
 
+        OPERATOR_TO_SYMBOL = {
+          EQ: :==,
+          NEQ: :!=,
+          GT: :>,
+          LT: :<,
+          GTE: :>=,
+          LTE: :<=
+        }.freeze
+
         class HistoricItem
           include org.openhab.core.persistence.HistoricItem
 
@@ -134,9 +143,7 @@ module OpenHAB
 
           range = first_index...last_index
 
-          operator = filter.operator.symbol
-          operator = "==" if operator == "="
-
+          operator = OPERATOR_TO_SYMBOL[filter.operator]
           block = lambda do |i|
             next if filter.state && !item_history[i].state.send(operator, filter.state)
 

data/lib/openhab/rspec/mocks/synchronous_executor.rb

@@ -21,7 +21,8 @@ module OpenHAB
         attr_accessor :main_thread
 
         def initialize
-          super(1)
+          # Allocate a (hopefully) big enough pool size to accommodate scheduled tasks
+          super(10)
         end
 
         def submit(runnable)

data/lib/openhab/rspec/mocks/thing_handler.rb

@@ -37,6 +37,10 @@ module OpenHAB
           callback&.state_updated(channel_uid, command) if command.is_a?(Core::Types::State)
         end
 
+        def send_time_series(channel_uid, time_series)
+          @callback&.send_time_series(channel_uid, time_series)
+        end
+
         def set_callback(callback)
           @callback = callback
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.16.0
+  version: 5.18.0
 platform: ruby
 authors:
 - Brian O'Connell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
+date: 2024-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -258,6 +258,7 @@ files:
 - lib/openhab/core/events/item_state_changed_event.rb
 - lib/openhab/core/events/item_state_event.rb
 - lib/openhab/core/events/item_state_updated_event.rb
+- lib/openhab/core/events/item_time_series_updated_event.rb
 - lib/openhab/core/events/thing_status_info_event.rb
 - lib/openhab/core/events/timer_event.rb
 - lib/openhab/core/items.rb
@@ -348,6 +349,7 @@ files:
 - lib/openhab/core/types/rewind_fastforward_type.rb
 - lib/openhab/core/types/stop_move_type.rb
 - lib/openhab/core/types/string_type.rb
+- lib/openhab/core/types/time_series.rb
 - lib/openhab/core/types/type.rb
 - lib/openhab/core/types/un_def_type.rb
 - lib/openhab/core/types/up_down_type.rb
@@ -357,6 +359,7 @@ files:
 - lib/openhab/core_ext/ephemeris.rb
 - lib/openhab/core_ext/java/class.rb
 - lib/openhab/core_ext/java/duration.rb
+- lib/openhab/core_ext/java/instant.rb
 - lib/openhab/core_ext/java/list.rb
 - lib/openhab/core_ext/java/local_date.rb
 - lib/openhab/core_ext/java/local_time.rb
@@ -482,7 +485,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
 summary: JRuby Helper Libraries for openHAB Scripting