openhab-scripting 5.5.0 → 5.6.0

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

@@ -230,9 +230,7 @@ module OpenHAB
             tags.compact.map do |tag|
               case tag
               when String then tag
-              when Symbol then tag.to_s
-              when old_semantics then tag.java_class.simple_name
-              when semantics then tag.name
+              when Symbol, semantics, old_semantics then tag.to_s
               else raise ArgumentError, "`#{tag}` must be a subclass of Semantics::Tag, a `Symbol`, or a `String`."
               end
             end
@@ -260,6 +258,8 @@ module OpenHAB
         # @param tags [String, Symbol, Semantics::Tag, Array<String, Symbol, Semantics::Tag>, nil]
         #        Fluent alias for `tag`.
         # @param autoupdate [true, false, nil] Autoupdate setting (see {ItemBuilder#autoupdate})
+        # @param thing [String, Core::Things::Thing, Core::Things::ThingUID, nil]
+        #   A Thing to be used as the base for the channel
         # @param channel [String, Core::Things::ChannelUID, nil] Channel to link the item to
         # @param expire [String] An expiration specification.
         # @param alexa [String, Symbol, Array<(String, Hash<String, Object>)>, nil]
@@ -281,6 +281,7 @@ module OpenHAB
                        tag: nil,
                        tags: nil,
                        autoupdate: nil,
+                       thing: nil,
                        channel: nil,
                        expire: nil,
                        alexa: nil,
@@ -310,6 +311,7 @@ module OpenHAB
           @metadata.merge!(metadata) if metadata
           @autoupdate = autoupdate
           @channels = []
+          @thing = thing
           @expire = nil
           if expire
             expire = Array(expire)
@@ -420,6 +422,7 @@ module OpenHAB
         #   end
         #
         def channel(channel, config = {})
+          channel = "#{@thing}:#{channel}" if @thing && !channel.include?(":")
           @channels << [channel, config]
         end
 
@@ -569,7 +572,7 @@ module OpenHAB
           RUBY
         end
 
-        FUNCTION_REGEX = /^([a-z]+)(?:\(([a-z]+)(?:,([a-z]+))*\))?/i.freeze
+        FUNCTION_REGEX = /^([a-z]+)(?:\((.*)\))?/i.freeze
         private_constant :FUNCTION_REGEX
 
         # The combiner function for this group
@@ -607,11 +610,13 @@ module OpenHAB
         def create_item
           base_item = super if type
           if function
+            require "csv"
+
             match = function.match(FUNCTION_REGEX)
 
             dto = org.openhab.core.items.dto.GroupFunctionDTO.new
             dto.name = match[1]
-            dto.params = match[2..]
+            dto.params = CSV.parse_line(match[2]) if match[2]
             function = org.openhab.core.items.dto.ItemDTOMapper.map_function(base_item, dto)
             Core::Items::GroupItem.new(name, base_item, function)
           else

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

@@ -74,6 +74,10 @@ module OpenHAB
 
         # This method gets called in rspec's SuspendRules as well
         def execute!(mod, inputs)
+          # Store the context in a thread variable. It is accessed through DSL#method_missing
+          # which is triggered when the context variable is referenced inside the run block.
+          # It is added to @thread_locals so it is also available in #process_task below.
+          @thread_locals[:openhab_context] = extract_context(inputs)
           ThreadLocal.thread_local(**@thread_locals) do
             if logger.trace?
               logger.trace("Execute called with mod (#{mod&.to_string}) and inputs (#{inputs.inspect})")
@@ -84,10 +88,12 @@ module OpenHAB
               @debouncer.call { process_queue(create_queue(event), mod, event) }
             end
           rescue Exception => e
-            raise if defined?(::RSpec) && ::RSpec.current_example.example_group.propagate_exceptions?
+            raise if defined?(::RSpec) && ::RSpec.current_example&.example_group&.propagate_exceptions?
 
             @run_context.send(:logger).log_exception(e)
           end
+        ensure
+          @thread_locals.delete(:openhab_context)
         end
 
         def cleanup
@@ -157,6 +163,24 @@ module OpenHAB
           struct_class.new(**inputs)
         end
 
+        #
+        # Converts inputs into context hash
+        # @return [Hash] Context hash.
+        #
+        def extract_context(inputs)
+          return unless inputs
+
+          inputs.reject { |key, _| key.include?(".") }
+                .to_h do |key, value|
+                  [key.to_sym,
+                   if value.is_a?(Item) && !value.is_a?(Core::Items::Proxy)
+                     Core::Items::Proxy.new(value)
+                   else
+                     value
+                   end]
+                end
+        end
+
         #
         # Get the trigger_id for the trigger that caused the rule creation
         #
@@ -230,7 +254,7 @@ module OpenHAB
           ThreadLocal.thread_local(**@thread_locals) do
             case task
             when BuilderDSL::Run then process_run_task(event, task)
-            when BuilderDSL::Script then process_script_task(task)
+            when BuilderDSL::Script then process_script_task(event, task)
             when BuilderDSL::Trigger then process_trigger_task(event, task)
             when BuilderDSL::Otherwise then process_otherwise_task(event, task)
             end
@@ -294,9 +318,9 @@ module OpenHAB
         #
         # @param [Script] task to execute
         #
-        def process_script_task(task)
-          logger.trace { "Executing script '#{name}' run block" }
-          @run_context.instance_exec(&task.block)
+        def process_script_task(event, task)
+          logger.trace { "Executing script '#{name}' run block with event(#{event})" }
+          @run_context.instance_exec(event, &task.block)
         end
 
         #

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

@@ -1112,7 +1112,6 @@ module OpenHAB
 
           raise ArgumentError, "Missing cron expression or elements" unless expression
 
-          add_tag("Schedule")
           cron = Cron.new(rule_triggers: @rule_triggers)
           cron.trigger(config: { "cronExpression" => expression }, attach: attach)
         end
@@ -1211,7 +1210,6 @@ module OpenHAB
           if value == :day && at.is_a?(Item)
             raise ArgumentError, "Attachments are not supported with dynamic datetime triggers" unless attach.nil?
 
-            add_tag("Schedule")
             return trigger("timer.DateTimeTrigger", itemName: at.name, timeOnly: true)
           end
 
@@ -1593,7 +1591,6 @@ module OpenHAB
         #
         def at(item)
           item = item.name if item.is_a?(Item)
-          add_tag("Schedule")
           trigger("timer.DateTimeTrigger", itemName: item.to_s)
         end
 

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

@@ -64,7 +64,7 @@ module OpenHAB
           org.openhab.core.automation.util.TriggerBuilder.create
              .with_id(uuid)
              .with_type_uid(type)
-             .with_configuration(org.openhab.core.config.core.Configuration.new(config))
+             .with_configuration(Core::Configuration.new(config))
              .build
         end
 

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

@@ -12,7 +12,12 @@ module OpenHAB
         #
         class Cron < Trigger
           # Trigger ID for Cron Triggers
-          CRON_TRIGGER_MODULE_ID = "jsr223.jruby.CronTrigger"
+          CRON_TRIGGER_MODULE_ID = if Gem::Version.new(OpenHAB::Core::VERSION) >= Gem::Version.new("4.0.0")
+                                     "timer.GenericCronTrigger"
+                                   else
+                                     # @deprecated OH3.4 We need to use a custom CronTrigger handler
+                                     "jsr223.jruby.CronTrigger"
+                                   end
 
           #
           # Returns a default map for cron expressions that fires every second
@@ -186,7 +191,10 @@ module OpenHAB
           #
           #
           def trigger(config:, attach:)
-            CronHandler::CronTriggerHandlerFactory.instance # ensure it's registered
+            # @deprecated OH3.4 needs a custom CronTriggerHandlerFactory
+            if Gem::Version.new(OpenHAB::Core::VERSION) < Gem::Version.new("4.0.0")
+              CronHandler::CronTriggerHandlerFactory.instance # ensure it's registered
+            end
             append_trigger(type: CRON_TRIGGER_MODULE_ID, config: config, attach: attach)
           end
         end

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

@@ -1,115 +1,120 @@
 # frozen_string_literal: true
 
-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
+# @deprecated OH3.4 this module is not needed in OH4+
+if Gem::Version.new(OpenHAB::Core::VERSION) < Gem::Version.new("4.0.0")
 
-            #
-            # 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
+  require "singleton"
 
-            #
-            # Get the temporal adjuster
-            # @return [CronAdjuster]
-            #
-            def getTemporalAdjuster # rubocop:disable Naming/MethodName
-              org.openhab.core.scheduler.CronAdjuster.new(@expression)
-            end
+  require_relative "cron"
 
-            #
-            # Execute the callback
-            #
-            def run
-              callback&.triggered(@trigger, { "module" => @trigger.id })
-            end
+  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
 
-            #
-            # Displose of the handler
-            # cancel the cron scheduled task
-            #
-            def dispose
-              synchronized do
-                super
-                return unless @schedule
+              # Provides access to protected fields
+              field_accessor :callback
 
-                @schedule.cancel(true)
+              # 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
+              end
+
+              #
+              # Get the temporal adjuster
+              # @return [CronAdjuster]
+              #
+              def getTemporalAdjuster # rubocop:disable Naming/MethodName
+                org.openhab.core.scheduler.CronAdjuster.new(@expression)
               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
-
-            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")
+              #
+              # 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
+
+                  @schedule.cancel(true)
+                  @schedule = nil
+                end
+                logger.trace("cancelled job for trigger '#{@trigger.id}'.")
+              end
             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)
+            # 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
+
+              # 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
             end
           end
         end
       end
     end
   end
+
 end

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

@@ -24,10 +24,10 @@ module OpenHAB
       #   things.build do
       #     thing("mqtt:topic:my-switch", "My Switch", bridge: "mqtt:bridge:mosquitto", config: thing_config) do
       #       channel("switch1", "switch", config: {
-      #         stateTopic: "stat/my-switch/switch1/state", commandTopic="cmnd/my-switch/switch1/command"
+      #         stateTopic: "stat/my-switch/switch1/state", commandTopic: "cmnd/my-switch/switch1/command"
       #       })
       #       channel("button1", "string", config: {
-      #         stateTopic: "stat/my-switch/button1/state", commandTopic="cmnd/my-switch/button1/command"
+      #         stateTopic: "stat/my-switch/button1/state", commandTopic: "cmnd/my-switch/button1/command"
       #       })
       #     end
       #   end
@@ -184,7 +184,7 @@ module OpenHAB
 
         # @!visibility private
         def build
-          configuration = org.openhab.core.config.core.Configuration.new(config)
+          configuration = Core::Configuration.new(config)
           if thing_type
             self.class.thing_factory_helper.apply_default_configuration(
               configuration, thing_type,
@@ -280,7 +280,7 @@ module OpenHAB
           org.openhab.core.thing.binding.builder.ChannelBuilder.create(uid)
              .with_kind(kind)
              .with_type(type)
-             .with_configuration(org.openhab.core.config.core.Configuration.new(config))
+             .with_configuration(Core::Configuration.new(config))
              .build
         end
 

data/lib/openhab/dsl/thread_local.rb

@@ -11,6 +11,7 @@ module OpenHAB
 
       # Keys to persist
       KNOWN_KEYS = %i[
+        openhab_context
         openhab_ensure_states
         openhab_holiday_file
         openhab_persistence_service

data/lib/openhab/dsl/timer_manager.rb

@@ -89,7 +89,7 @@ module OpenHAB
       # @param [Object] id
       # @param [java.time.temporal.TemporalAmount, #to_zoned_date_time, Proc, nil] duration
       #   When to reschedule the timer for. `nil` to retain its current interval.
-      # @return [Timer, nil] the timer if it was rescheduled, otherwise `nil`
+      # @return [Core::Timer, nil] the timer if it was rescheduled, otherwise `nil`
       #
       def reschedule(id, duration = nil)
         @timers_by_id.compute_if_present(id) do |_key, timer|
@@ -105,10 +105,10 @@ module OpenHAB
       # state. The timer is created in a thread-safe manner.
       #
       # @param [Object] id
-      # @yieldparam [Timer, nil] timer The existing timer with this id, if one exists.
-      # @yieldreturn [Timer, nil] A new timer to associate with this id, the existing
+      # @yieldparam [Core::Timer, nil] timer The existing timer with this id, if one exists.
+      # @yieldreturn [Core::Timer, nil] A new timer to associate with this id, the existing
       #   timer, or nil. If nil, any existing timer will be cancelled.
-      # @return [Timer, nil]
+      # @return [Core::Timer, nil]
       #
       # @example Extend an existing timer, or schedule a new one
       #   # This is technically the same functionality as just calling `after()` with an `id`,

data/lib/openhab/dsl/version.rb

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

data/lib/openhab/dsl.rb

@@ -2,6 +2,7 @@
 
 require "java"
 require "method_source"
+require "ruby2_keywords"
 
 require "bundler/inline"
 
@@ -77,16 +78,16 @@ module OpenHAB
     # Defines a new profile that can be applied to item channel links.
     #
     # @param [String, Symbol] id The id for the profile.
-    # @yield [event, command: nil, state: nil, link:, item:, channel_uid:, configuration:, context:]
+    # @yield [event, command: nil, state: nil, callback:, link:, item:, channel_uid:, configuration:, context:]
     #   All keyword params are optional. Any that aren't defined won't be passed.
-    # @yieldparam [Core::Things::ProfileCallback] callback
-    #   The callback to be used to customize the action taken.
     # @yieldparam [:command_from_item, :state_from_item, :command_from_handler, :state_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 [Core::Things::ProfileCallback] callback
+    #   The callback to be used to customize the action taken.
     # @yieldparam [Core::Things::ItemChannelLink] link
     #   The link between the item and the channel, including its configuration.
     # @yieldparam [Item] item The linked item.
@@ -115,7 +116,7 @@ module OpenHAB
     #   # Rollershutter MyShade { channel="thing:rollershutter"[profile="ruby:veto_closing_shades"] }
     #
     # @example Overriding units from a binding
-    #   profile(:set_uom) do |event, configuration:, state:, command:|
+    #   profile(:set_uom) do |event, callback:, configuration:, state:, command:|
     #     unless configuration["unit"]
     #       logger.warn("Unit configuration not provided for set_uom profile")
     #        next true
@@ -970,6 +971,24 @@ module OpenHAB
 
       raise exception
     end
+
+    #
+    # Provide access to the script context / variables
+    # see OpenHAB::DSL::Rules::AutomationRule#execute!
+    #
+    # @!visibility private
+    ruby2_keywords def method_missing(method, *args)
+      return super unless args.empty? && !block_given?
+      return super unless (context = Thread.current[:openhab_context]) && context.key?(method)
+
+      logger.trace("DSL#method_missing found context variable: '#{method}'")
+      context[method]
+    end
+
+    # @!visibility private
+    def respond_to_missing?(method, include_private = false)
+      Thread.current[:openhab_context]&.key?(method) || super
+    end
   end
 end
 

data/lib/openhab/rspec/karaf.rb

@@ -574,7 +574,7 @@ module OpenHAB
           bundle.fragment?
       end
 
-      def wait
+      def wait(timeout: 30)
         mutex = Mutex.new
         cond = ConditionVariable.new
         skip_wait = false
@@ -587,7 +587,7 @@ module OpenHAB
         end
         mutex.synchronize do
           yield continue
-          cond.wait(mutex) unless skip_wait
+          cond.wait(mutex, timeout) unless skip_wait
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.5.0
+  version: 5.6.0
 platform: ruby
 authors:
 - Brian O'Connell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-08 00:00:00.000000000 Z
+date: 2023-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -394,10 +394,12 @@ files:
 - lib/openhab/core/actions/ping.rb
 - lib/openhab/core/actions/transformation.rb
 - lib/openhab/core/actions/voice.rb
+- lib/openhab/core/configuration.rb
 - lib/openhab/core/dependency_tracking.rb
 - lib/openhab/core/dto.rb
 - lib/openhab/core/dto/item_channel_link.rb
 - lib/openhab/core/dto/thing.rb
+- lib/openhab/core/emulate_hash.rb
 - lib/openhab/core/entity_lookup.rb
 - lib/openhab/core/events.rb
 - lib/openhab/core/events/abstract_event.rb
@@ -409,6 +411,7 @@ files:
 - lib/openhab/core/events/item_state_event.rb
 - lib/openhab/core/events/item_state_updated_event.rb
 - lib/openhab/core/events/thing_status_info_event.rb
+- lib/openhab/core/events/timer_event.rb
 - lib/openhab/core/items.rb
 - lib/openhab/core/items/accepted_data_types.rb
 - lib/openhab/core/items/color_item.rb
@@ -416,6 +419,7 @@ files:
 - lib/openhab/core/items/date_time_item.rb
 - lib/openhab/core/items/dimmer_item.rb
 - lib/openhab/core/items/generic_item.rb
+- lib/openhab/core/items/group_function.rb
 - lib/openhab/core/items/group_item.rb
 - lib/openhab/core/items/image_item.rb
 - lib/openhab/core/items/item.rb