openhab-scripting 5.29.0 → 5.30.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 795ee1035ecfb1a7f38f50243ed0d28af8a578e7d586eedd97c8362d6f4cd03d
-  data.tar.gz: d1785eb66e599bb3b78a3ab473618a080bffa117a53ddaf13c506e298806d8ad
+  metadata.gz: 93b780d352d981919615e78e687910eb11ee024c6c567a6294db4538ddd8712a
+  data.tar.gz: dbdcb9b48ee07a0d626bf8aa5ef6da60273d330395c89647dd5a360b28bc3f1c
 SHA512:
-  metadata.gz: 3af8371312fdf0dce313b87513db7540545639ef440358c1256f03fe8018768c33636f5aff09bcc1cdceb9a04988492921651fd4ed269f824b18a330feec8088
-  data.tar.gz: 698841f7a0fd45ca777e1561b915e9c695c309ba9ac802d7a319733f6501539959d55ce2d6ddae8fd9cbee4c35d8d089da74d74fa6011c9b6978b68028449b1c
+  metadata.gz: 12c20ab4f52a6fac707f62d004c5eb9268ca6a00a9d9490f96892530091a7da6bc812d5b729b3041a51c1567690269b91dd77e31325a826b15ba3e2d32f5a53a
+  data.tar.gz: 718e2af872273b04125d64edce10d248883654388a14ca126c12fdcdaef68ebc25032466fa0bb20963b491fccb753406c668acdb1499ec9ac1567baeb02b10ff

data/lib/openhab/core/events/abstract_event.rb

@@ -13,8 +13,8 @@ module OpenHAB
         # @return [Hash]
         attr_accessor :inputs
 
-        # @return [String]
-        alias_method :inspect, :to_s
+        # @!attribute [r] source
+        # @return [String] The component that sent the event.
 
         #
         # Returns the event payload as a Hash.
@@ -26,6 +26,13 @@ module OpenHAB
           require "json"
           @payload ||= JSON.parse(get_payload, symbolize_names: true) unless get_payload.empty?
         end
+
+        # @return [String]
+        def inspect
+          s = "#<OpenHAB::Core::Events::#{self.class.simple_name} topic=#{topic} payload=#{payload.inspect}"
+          s += " source=#{source.inspect}" if source
+          "#{s}>"
+        end
       end
     end
   end

data/lib/openhab/core/events/channel_triggered_event.rb

@@ -24,6 +24,13 @@ module OpenHAB
 
         # @!attribute [r] event
         # @return [String] The event data
+
+        # @return [String]
+        def inspect
+          s = "#<OpenHAB::Core::Events::ChannelTriggeredEvent channel=#{channel} event=#{event.inspect}"
+          s += " source=#{source.inspect}" if source
+          "#{s}>"
+        end
       end
     end
   end

data/lib/openhab/core/events/item_command_event.rb

@@ -72,6 +72,13 @@ module OpenHAB
         # @!method previous?
         #   Check if {#command} is {PREVIOUS}
         #   @return [true, false]
+
+        # @return [String]
+        def inspect
+          s = "#<OpenHAB::Core::Events::ItemCommandEvent item=#{itemName} command=#{command.inspect}"
+          s += " source=#{source.inspect}" if source
+          "#{s}>"
+        end
       end
     end
   end

data/lib/openhab/core/events/item_state_changed_event.rb

@@ -69,6 +69,14 @@ module OpenHAB
         def was
           old_item_state if was?
         end
+
+        # @return [String]
+        def inspect
+          s = "#<OpenHAB::Core::Events::ItemStateChangedEvent item=#{item_name} " \
+              "state=#{item_state.inspect} was=#{old_item_state.inspect}"
+          s += " source=#{source.inspect}" if source
+          "#{s}>"
+        end
       end
     end
   end

data/lib/openhab/core/events/item_state_event.rb

@@ -68,6 +68,13 @@ module OpenHAB
         def state
           item_state if state?
         end
+
+        # @return [String]
+        def inspect
+          s = "#<OpenHAB::Core::Events::#{self.class.simple_name} item=#{item_name} state=#{item_state.inspect}"
+          s += " source=#{source.inspect}" if source
+          "#{s}>"
+        end
       end
 
       # {AbstractEvent} sent when an item's state is updated (regardless of if it changed or not).

data/lib/openhab/core/events/thing_status_info_event.rb

@@ -27,6 +27,14 @@ module OpenHAB
         def thing
           EntityLookup.lookup_thing(uid)
         end
+
+        # @return [String]
+        def inspect
+          s = "#<OpenHAB::Core::Events::ThingStatusInfoChangedEvent thing=#{uid} " \
+              "status=#{status.inspect} was=#{was.inspect}"
+          s += " source=#{source.inspect}" if source
+          "#{s}>"
+        end
       end
 
       # The {AbstractEvent} sent when a {Things::Thing}'s status is set.
@@ -49,6 +57,14 @@ module OpenHAB
         def thing
           EntityLookup.lookup_thing(uid)
         end
+
+        # @return [String]
+        def inspect
+          s = "#<OpenHAB::Core::Events::ThingStatusInfoEvent thing=#{uid} " \
+              "status=#{status.inspect}"
+          s += " source=#{source.inspect}" if source
+          "#{s}>"
+        end
       end
     end
   end

data/lib/openhab/core/events.rb

@@ -5,6 +5,14 @@ module OpenHAB
     # Contains objects sent to event handlers containing context around the
     # triggered event.
     module Events
+      class << self
+        # @!visibility private
+        def publisher
+          @publisher ||= OSGi.service("org.openhab.core.events.EventPublisher")
+        end
+      end
+
+      java_import org.openhab.core.items.events.ItemEventFactory
     end
   end
 end

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

@@ -137,6 +137,7 @@ module OpenHAB
         # @param [Command, #to_s] command command to send to the item.
         #   When given a {Command} argument, it will be passed directly.
         #   Otherwise, the result of `#to_s` will be parsed into a {Command}.
+        # @param [String, nil] source Optional string to identify what sent the event.
         # @return [self, nil] nil when `ensure` is in effect and the item was already in the same state,
         #   otherwise the item.
         #
@@ -156,10 +157,14 @@ module OpenHAB
         # @example Sending a string to a dimensioned {NumberItem}
         #   SetTemperature.command("22.5 °C") # The string will be parsed and converted to a QuantityType
         #
-        def command(command)
+        def command(command, source: nil)
           command = format_command(command)
-          logger.trace "Sending Command #{command} to #{name}"
-          $events.send_command(self, command)
+          logger.trace { "Sending Command #{command} to #{name}" }
+          if source
+            Events.publisher.post(Events::ItemEventFactory.create_command_event(name, command, source.to_s))
+          else
+            $events.send_command(self, command)
+          end
           Proxy.new(self)
         end
         alias_method :command!, :command
@@ -201,7 +206,7 @@ module OpenHAB
         #
         def update(state)
           state = format_update(state)
-          logger.trace "Sending Update #{state} to #{name}"
+          logger.trace { "Sending Update #{state} to #{name}" }
           $events.post_update(self, state)
           Proxy.new(self)
         end

data/lib/openhab/core/items/group_item.rb

@@ -131,10 +131,10 @@ module OpenHAB
 
         # Override because we want to send them to the base item if possible
         %i[command update].each do |method|
-          define_method(method) do |command|
-            return base_item.__send__(method, command) if base_item
+          define_method(method) do |command, **kwargs|
+            return base_item.__send__(method, command, **kwargs) if base_item
 
-            super(command)
+            super(command, **kwargs)
           end
         end
 

data/lib/openhab/core/items/semantics/enumerable.rb

@@ -103,10 +103,10 @@ module Enumerable
 
   # Send a command to every item in the collection, even when {OpenHAB::DSL.ensure_states! ensure_states!} is in effect.
   # @return [self]
-  def command!(command)
+  def command!(command, **kwargs)
     # We cannot alias this to #command above, otherwise it will call
     # DSL::Items::Ensure::Item#command which checks for ensure_states
-    each { |i| i.command!(command) }
+    each { |i| i.command!(command, **kwargs) }
     self
   end
 
@@ -198,7 +198,7 @@ module Enumerable
   # Send a toggle command to every item in the collection
   # @return [self]
   #
-  def toggle
-    each(&:toggle)
+  def toggle(source: nil)
+    each { |i| i.toggle(source: source) }
   end
 end

data/lib/openhab/core/items/switch_item.rb

@@ -49,10 +49,10 @@ module OpenHAB
         #
         # @return [self]
         #
-        def toggle
-          return on! unless state?
+        def toggle(source: nil)
+          return on!(source: source) unless state?
 
-          command!(!state)
+          command!(!state, source: source)
         end
 
         # @!method on?

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

@@ -35,10 +35,12 @@ module OpenHAB
           # check if this item is in the command's state before actually
           # sending the command
           %i[command update].each do |ensured_method|
-            # def command(state)
+            # rubocop:disable Style/IfUnlessModifier
+
+            # def command(state, **kwargs)
             #   # immediately send the command if it's a command, but not a state (like REFRESH)
-            #   return super(state) if state.is_a?(Command) && !state.is_a?(State)
-            #   return super(state) unless Thread.current[:openhab_ensure_states]
+            #   return super(state, **kwargs) if state.is_a?(Command) && !state.is_a?(State)
+            #   return super(state, **kwargs) unless Thread.current[:openhab_ensure_states]
             #
             #   formatted_state = format_command(state)
             #   logger.trace do
@@ -46,13 +48,13 @@ module OpenHAB
             #   end
             #   return if raw_state == formatted_state
             #
-            #   super(formatted_state)
+            #   super(formatted_state, **kwargs)
             # end
             class_eval <<~RUBY, __FILE__, __LINE__ + 1 # rubocop:disable Style/DocumentDynamicEvalDefinition
-              def #{ensured_method}(state)
+              def #{ensured_method}(state, **kwargs)
                 # immediately send the command if it's a command, but not a state (like REFRESH)
-                #{"return super(state) if state.is_a?(Command) && !state.is_a?(State)" if ensured_method == :command}
-                return super(state) unless Thread.current[:openhab_ensure_states]
+                #{"return super(state, **kwargs) if state.is_a?(Command) && !state.is_a?(State)" if ensured_method == :command}
+                return super(state, **kwargs) unless Thread.current[:openhab_ensure_states]
 
                 formatted_state = format_#{ensured_method}(state)
                 logger.trace do
@@ -60,9 +62,10 @@ module OpenHAB
                 end
                 return if raw_state.as(formatted_state.class) == formatted_state
 
-                super(formatted_state)
+                super(formatted_state, **kwargs)
               end
             RUBY
+            # rubocop:enable Style/IfUnlessModifier
           end
         end
 

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

@@ -149,9 +149,9 @@ module OpenHAB
         #     end
         #   end
         #
-        def command(command, for: nil, on_expire: nil, only_when_ensured: false, &block)
+        def command(command, for: nil, on_expire: nil, only_when_ensured: false, **kwargs, &block)
           duration = binding.local_variable_get(:for)
-          return super(command) unless duration
+          return super(command, **kwargs) unless duration
 
           on_expire = block if block
 
@@ -159,10 +159,10 @@ module OpenHAB
             on_expire ||= default_on_expire(command)
             if only_when_ensured
               DSL.ensure_states do
-                create_timed_command(command, duration: duration, on_expire: on_expire) if super(command)
+                create_timed_command(command, duration: duration, on_expire: on_expire) if super(command, **kwargs)
               end
             else
-              super(command)
+              super(command, **kwargs)
               create_timed_command(command, duration: duration, on_expire: on_expire)
             end
           end
@@ -180,12 +180,12 @@ module OpenHAB
                   create_ensured_timed_command.call
                 else
                   # timed command still pending; reset it
-                  logger.trace "Outstanding Timed Command #{timed_command_details} encountered - rescheduling"
+                  logger.trace { "Outstanding Timed Command #{timed_command_details} encountered - rescheduling" }
                   timed_command_details.on_expire = on_expire unless on_expire.nil?
                   timed_command_details.timer.reschedule(duration)
                   # disable the cancel rule while we send the new command
                   DSL.rules[timed_command_details.rule_uid].disable
-                  super(command) # This returns nil when "ensured"
+                  super(command, **kwargs) # This returns nil when "ensured"
                   DSL.rules[timed_command_details.rule_uid].enable
                   timed_command_details
                 end
@@ -209,7 +209,7 @@ module OpenHAB
           unmanaged_rule = Core.automation_manager.add_unmanaged_rule(cancel_rule)
           timed_command_details.rule_uid = unmanaged_rule.uid
           Core::Rules::Provider.current.add(unmanaged_rule)
-          logger.trace "Created Timed Command #{timed_command_details}"
+          logger.trace { "Created Timed Command #{timed_command_details}" }
           timed_command_details
         end
 
@@ -219,12 +219,14 @@ module OpenHAB
         def timed_command_timer(timed_command_details, duration)
           DSL.after(duration) do
             timed_command_details.mutex.synchronize do
-              logger.trace "Timed command expired - #{timed_command_details}"
+              logger.trace { "Timed command expired - #{timed_command_details}" }
               DSL.rules[timed_command_details.rule_uid].disable
               timed_command_details.resolution = :expired
               case timed_command_details.on_expire
               when Proc
-                logger.trace "Invoking block #{timed_command_details.on_expire} after timed command for #{name} expired"
+                logger.trace do
+                  "Invoking block #{timed_command_details.on_expire} after timed command for #{name} expired"
+                end
                 timed_command_details.on_expire.call(timed_command_details)
               when Core::Types::UnDefType
                 update(timed_command_details.on_expire)

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

@@ -20,7 +20,7 @@ module OpenHAB
           # @param [Object] thing to combine with channels and iterate over
           # @return [Enumerable] enumerable channel ids to trigger on
           def self.channels(channels:, thing:)
-            logger.trace "Creating Channel/Thing Pairs for channels #{channels.inspect} and things #{thing.inspect}"
+            logger.trace { "Creating Channel/Thing Pairs for channels #{channels.inspect} and things #{thing.inspect}" }
             channels.flatten.product([thing].flatten)
                     .map { |channel_thing| channel_id(*channel_thing) }
           end
@@ -47,7 +47,7 @@ module OpenHAB
           def trigger(channel:, trigger:, attach:)
             config = { "channelUID" => channel }
             config["event"] = trigger.to_s unless trigger.nil?
-            logger.trace "Creating Channel Trigger for channels #{channel.inspect} and config #{config.inspect}"
+            logger.trace { "Creating Channel Trigger for channels #{channel.inspect} and config #{config.inspect}" }
             append_trigger(type: CHANNEL_EVENT, config: config, attach: attach)
           end
         end

data/lib/openhab/dsl/thread_local.rb

@@ -41,7 +41,7 @@ module OpenHAB
       def thread_local(**values)
         old_values = values.to_h { |key, _value| [key, Thread.current[key]] }
         values.each { |key, value| Thread.current[key] = value }
-        logger.trace "Executing block with thread local context: #{values} - old context: #{old_values}"
+        logger.trace { "Executing block with thread local context: #{values} - old context: #{old_values}" }
         yield
       ensure
         old_values.each { |key, value| Thread.current[key] = value }

data/lib/openhab/dsl/version.rb

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

data/lib/openhab/dsl.rb

@@ -1087,4 +1087,4 @@ singleton_class.include(OpenHAB::DSL)
 Object.extend(OpenHAB::CoreExt::Ruby::Object::ClassMethods)
 OpenHAB::CoreExt::Ruby::Object.instance_variable_set(:@top_self, self)
 
-logger.debug "openHAB JRuby Scripting Library Version #{OpenHAB::DSL::VERSION} Loaded"
+logger.debug { "openHAB JRuby Scripting Library Version #{OpenHAB::DSL::VERSION} Loaded" }

data/lib/openhab/osgi.rb

@@ -24,7 +24,7 @@ module OpenHAB
       #
       def services(name, filter: nil)
         (bundle_context.get_service_references(name, filter) || []).map do |reference|
-          logger.trace "OSGi service found for '#{name}' using OSGi Service Reference #{reference}"
+          logger.trace { "OSGi service found for '#{name}' using OSGi Service Reference #{reference}" }
           bundle_context.get_service(reference)
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.29.0
+  version: 5.30.1
 platform: ruby
 authors:
 - Brian O'Connell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-19 00:00:00.000000000 Z
+date: 2024-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -490,7 +490,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.19
+rubygems_version: 3.5.20
 signing_key: 
 specification_version: 4
 summary: JRuby Helper Libraries for openHAB Scripting