openhab-scripting 5.35.1 → 5.36.0

data/lib/openhab/core/profile_factory.rb

@@ -15,12 +15,7 @@ module OpenHAB
       include Singleton
 
       class Profile
-        # @deprecated OH 4.0 only include TimeSeriesProfile in OH 4.1, because it extends StateProfile
-        if OpenHAB::Core.version >= OpenHAB::Core::V4_1
-          include org.openhab.core.thing.profiles.TimeSeriesProfile
-        else
-          include org.openhab.core.thing.profiles.StateProfile
-        end
+        include org.openhab.core.thing.profiles.TimeSeriesProfile
         include org.openhab.core.thing.profiles.TriggerProfile
 
         def initialize(callback, context, uid, thread_locals, block)
@@ -43,7 +38,7 @@ module OpenHAB
 
         # @!visibility private
         def onCommandFromItem(command)
-          return unless process_event(:command_from_item, command: command) == true
+          return unless process_event(:command_from_item, command:) == true
 
           logger.trace("Forwarding original command")
           @callback.handle_command(command)
@@ -51,7 +46,7 @@ module OpenHAB
 
         # @!visibility private
         def onStateUpdateFromHandler(state)
-          return unless process_event(:state_from_handler, state: state) == true
+          return unless process_event(:state_from_handler, state:) == true
 
           logger.trace("Forwarding original update")
           @callback.send_update(state)
@@ -59,7 +54,7 @@ module OpenHAB
 
         # @!visibility private
         def onCommandFromHandler(command)
-          return unless process_event(:command_from_handler, command: command) == true
+          return unless process_event(:command_from_handler, command:) == true
 
           logger.trace("Forwarding original command")
           callback.send_command(command)
@@ -67,7 +62,7 @@ module OpenHAB
 
         # @!visibility private
         def onStateUpdateFromItem(state)
-          process_event(:state_from_item, state: state)
+          process_event(:state_from_item, state:)
         end
 
         # @!visibility private
@@ -75,12 +70,9 @@ module OpenHAB
           process_event(:trigger_from_handler, trigger: event)
         end
 
-        # @deprecated OH 4.0 guard is only needed for < OH 4.1
-        if OpenHAB::Core.version >= OpenHAB::Core::V4_1
-          # @!visibility private
-          def onTimeSeriesFromHandler(time_series)
-            process_event(:time_series_from_handler, time_series: time_series)
-          end
+        # @!visibility private
+        def onTimeSeriesFromHandler(time_series)
+          process_event(:time_series_from_handler, time_series:)
         end
 
         private
@@ -99,8 +91,7 @@ module OpenHAB
           params[:state] ||= nil
           params[:command] ||= nil
           params[:trigger] ||= nil
-          # @deprecated OH 4.0 guard is only needed for < OH 4.1
-          params[:time_series] ||= nil if OpenHAB::Core.version >= OpenHAB::Core::V4_1
+          params[:time_series] ||= nil
 
           kwargs = {}
           @block.parameters.each do |(param_type, name)|
@@ -154,10 +145,10 @@ module OpenHAB
 
         @profiles[uid] = {
           thread_locals: DSL::ThreadLocal.persist,
-          label: label,
-          type: type,
-          config_description: config_description,
-          block: block
+          label:,
+          type:,
+          config_description:,
+          block:
         }
         @uri_to_uid[uri] = uid
       end
@@ -175,7 +166,7 @@ module OpenHAB
 
       # @!visibility private
       def getProfileTypes(_locale)
-        @profiles.map do |uid, profile|
+        @profiles.filter_map do |uid, profile|
           next if profile[:label].nil?
 
           if profile[:type] == :trigger
@@ -183,12 +174,12 @@ module OpenHAB
           else
             org.openhab.core.thing.profiles.ProfileTypeBuilder.new_state(uid, "RUBY #{profile[:label]}").build
           end
-        end.compact
+        end
       end
 
       # @!visibility private
       def getConfigDescriptions(_locale)
-        @profiles.values.map { |profile| profile[:config_description] if profile[:label] }.compact
+        @profiles.values.filter_map { |profile| profile[:config_description] if profile[:label] }
       end
 
       # @!visibility private

data/lib/openhab/core/provider.rb

@@ -144,8 +144,8 @@ module OpenHAB
       end
 
       # @!visibility private
-      def each(&block)
-        @elements.each_value(&block)
+      def each(&)
+        @elements.each_value(&)
       end
 
       # @return [String]
@@ -225,8 +225,7 @@ module OpenHAB
       # @!visibility private
       def unregister
         clear
-        # @deprecated OH3.4 safe navigation only required for missing Semantics registry
-        self.class.registry&.remove_provider(self)
+        self.class.registry.remove_provider(self)
       end
 
       private

data/lib/openhab/core/proxy.rb

@@ -24,6 +24,14 @@ module OpenHAB
     # @!visibility private
     #
     module Proxy
+      # Error raised when an item is attempted to be accessed, but no longer
+      # exists
+      class StaleProxyError < RuntimeError
+        def initialize(type, uid)
+          super("#{type} #{uid} does not currently exist")
+        end
+      end
+
       #
       # Registers and listens to openHAB bus events for objects getting
       # added/updated/removed, and updates references from proxy objects
@@ -39,12 +47,15 @@ module OpenHAB
         def initialize
           @proxies = java.util.concurrent.ConcurrentHashMap.new
           @parent_module = Object.const_get(self.class.name.split("::")[0..-3].join("::"), false)
-          @object_type = @parent_module.name.split("::").last.downcase[0..-2].to_sym
+          object_type = @parent_module.name.split("::").last[0...-1]
+          @object_type = object_type.downcase.to_sym
+          @type = @parent_module.const_get(object_type, false)
 
           @event_types = @parent_module::Proxy::EVENTS
           @uid_method = @parent_module::Proxy::UID_METHOD
+          @uid_type = @parent_module::Proxy::UID_TYPE
           @registry = @parent_module::Provider.registry
-          @registration = OSGi.register_service(self, "event.topics": "openhab/*")
+          @registration = OSGi.register_service(self)
           ScriptHandling.script_unloaded { @registration.unregister }
         end
 
@@ -67,9 +78,10 @@ module OpenHAB
         #
         def receive(event)
           uid = event.__send__(@object_type).__send__(@uid_method)
-          object = @registry.get(uid) unless event.class.simple_name == @event_types.last
+          uid = @uid_type.new(uid) unless @uid_type == String
 
           @proxies.compute_if_present(uid) do |_, proxy_ref|
+            object = @registry.get(uid) unless event.class.simple_name == @event_types.last
             proxy = resolve_ref(proxy_ref)
             next nil unless proxy
 
@@ -84,7 +96,12 @@ module OpenHAB
         def fetch(object)
           result = nil
 
-          @proxies.compute(object.__send__(@uid_method)) do |_k, proxy_ref|
+          uid = if object.is_a?(@type)
+                  object.__send__(@uid_method)
+                else
+                  object
+                end
+          @proxies.compute(uid) do |_k, proxy_ref|
             result = resolve_ref(proxy_ref)
             proxy_ref = nil unless result
             result ||= yield
@@ -119,12 +136,151 @@ module OpenHAB
         klass.singleton_class.prepend(ClassMethods)
         # define a sub-class of EventSubscriber as a child class of the including class
         klass.const_set(:EventSubscriber, Class.new(EventSubscriber))
+        parent_module = Object.const_get(klass.name.split("::")[0..-2].join("::"), false)
+        object_type = parent_module.name.split("::").last[0...-1].to_sym
+        klass.const_set(:Type, parent_module.const_get(object_type, false))
       end
 
       # @!visibility private
       def to_java
         __getobj__
       end
+
+      KERNEL_CLASS = ::Kernel.instance_method(:class)
+      KERNEL_IVAR_SET = ::Kernel.instance_method(:instance_variable_set)
+      private_constant :KERNEL_CLASS, :KERNEL_IVAR_SET
+
+      # @!visibility private
+
+      def initialize(target)
+        @klass = KERNEL_CLASS.bind_call(self)
+
+        if target.is_a?(@klass::Type)
+          super
+          KERNEL_IVAR_SET.bind_call(self, :"@#{@klass::UID_METHOD}", target&.__send__(@klass::UID_METHOD))
+        else
+          # dummy items; we were just passed the item name
+          super(nil)
+          KERNEL_IVAR_SET.bind_call(self, :"@#{@klass::UID_METHOD}", target)
+        end
+      end
+
+      # @!visibility private
+      def __setobj__(target)
+        @target = target
+      end
+
+      # @!visibility private
+      def __getobj__
+        @target
+      end
+
+      # overwrite these methods to handle "dummy" items:
+      # if it's a dummy item, and the method exists on Item,
+      # raise a StaleProxyError when you try to call it.
+      # if it doesn't exist on item, just let it raise NoMethodError
+      # as usual
+      # @!visibility private
+      def method_missing(method, ...)
+        target = __getobj__
+        if target.nil? && @klass::Type.method_defined?(method)
+          __raise__ StaleProxyError.new(@klass.name.split("::")[-2][0...-1], __send__(@klass::UID_METHOD))
+        end
+
+        if target_respond_to?(target, method, false)
+          target.__send__(method, ...)
+        elsif ::Kernel.method_defined?(method) || ::Kernel.private_method_defined?(method)
+          ::Kernel.instance_method(method).bind_call(self, ...)
+        else
+          super
+        end
+      end
+
+      # @!visibility private
+      def respond_to_missing?(method, include_private)
+        target = __getobj__
+        return true if target.nil? && @klass::Type.method_defined?(method)
+
+        r = target_respond_to?(target, method, include_private)
+        if r && include_private && !target_respond_to?(target, method, false)
+          warn "delegator does not forward private method ##{method}", uplevel: 3
+          return false
+        end
+        r
+      end
+
+      # @!visibility private
+      def respond_to?(method, include_private = false) # rubocop:disable Style/OptionalBooleanParameter
+        target = __getobj__
+        return true if target.nil? && @klass::Type.method_defined?(method)
+
+        target_respond_to?(target, method, include_private) || super
+      end
+
+      #
+      # Need to check if `self` _or_ the delegate is an instance of the
+      # given class
+      #
+      # So that {#==} can work
+      #
+      # @return [true, false]
+      #
+      # @!visibility private
+      def instance_of?(klass)
+        __getobj__.instance_of?(klass) || super
+      end
+
+      #
+      # Check if delegates are equal for comparison
+      #
+      # Otherwise items can't be used in Java maps
+      #
+      # @return [true, false]
+      #
+      # @!visibility private
+      def ==(other)
+        return __getobj__ == other.__getobj__ if other.instance_of?(@klass)
+
+        super
+      end
+
+      #
+      # Non equality comparison
+      #
+      # @return [true, false]
+      #
+      # @!visibility private
+      def !=(other)
+        !(self == other) # rubocop:disable Style/InverseMethods
+      end
+
+      # @return [String]
+      def to_s
+        target = __getobj__
+        return __send__(@klass::UID_METHOD) if target.nil?
+
+        target.to_s
+      end
+
+      # @return [String]
+      def inspect
+        target = __getobj__
+        return target.inspect unless target.nil?
+
+        "#<#{self.class.name} #{__send__(@klass::UID_METHOD)}>"
+      end
+
+      #
+      # Supports inspect from IRB when we're a dummy
+      #
+      # @return [void]
+      # @!visibility private
+      def pretty_print(printer)
+        target = __getobj__
+        return target.pretty_print(printer) unless target.nil?
+
+        printer.text(inspect)
+      end
     end
   end
 end

data/lib/openhab/core/rules/registry.rb

@@ -41,8 +41,8 @@ module OpenHAB
         # @yield Block executed in the context of a {DSL::Rules::Builder}.
         # @return [Object] The result of the block.
         #
-        def build(preferred_provider = nil, &block)
-          DSL::Rules::Builder.new(preferred_provider).instance_eval_with_dummy_items(&block)
+        def build(preferred_provider = nil, &)
+          DSL::Rules::Builder.new(preferred_provider).instance_eval_with_dummy_items(&)
         end
 
         #

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

@@ -132,7 +132,7 @@ module OpenHAB
           tags.map! do |tag|
             tag.is_a?(::Module) ? tag.simple_name : tag # ::Module to distinguish against Rule::Module!
           end
-          !(self.tags.to_a & tags).empty?
+          !!self.tags.to_a.intersect?(tags)
         end
 
         #
@@ -178,16 +178,12 @@ module OpenHAB
         # @return [Hash] A copy of the rule context, including possible return values.
         #
         def trigger(event = nil, consider_conditions: false, **context)
-          begin
-            event ||= org.openhab.core.automation.events.AutomationEventFactory
-                         .createExecutionEvent(uid, nil, "manual")
-          rescue NameError
-            # @deprecated OH3.4 doesn't have AutomationEventFactory
-          end
+          event ||= org.openhab.core.automation.events.AutomationEventFactory
+                       .createExecutionEvent(uid, nil, "manual")
           context.transform_keys!(&:to_s)
           # Unwrap any proxies and pass raw objects (items, things)
           context.transform_values! { |value| value.is_a?(Delegator) ? value.__getobj__ : value }
-          context["event"] = event if event # @deprecated OH3.4 - remove if guard. In OH4 `event` will never be nil
+          context["event"] = event
           Rules.manager.run_now(uid, consider_conditions, context)
         end
         alias_method :run, :trigger

data/lib/openhab/core/script_handling.rb

@@ -90,7 +90,7 @@ module OpenHAB
       #
       # Executed when openHAB unloads a script file
       #
-      def scriptUnloaded # rubocop:disable Naming/MethodName method name dictated by openHAB
+      def scriptUnloaded # rubocop:disable Naming/MethodName -- method name dictated by openHAB
         logger.trace("Script unloaded")
         ScriptHandlingCallbacks.script_unloaded_hooks.sort_by(&:first).flat_map(&:last).each do |hook|
           hook.call
@@ -118,7 +118,7 @@ module OpenHAB
       #
       # Executed when openHAB loads a script file
       #
-      def scriptLoaded(filename) # rubocop:disable Naming/MethodName method name dictated by openHAB
+      def scriptLoaded(filename) # rubocop:disable Naming/MethodName -- method name dictated by openHAB
         logger.trace { "Script loaded: #{filename}" }
         ScriptHandlingCallbacks.script_loaded_hooks.each do |hook|
           hook.call

data/lib/openhab/core/sitemaps/provider.rb

@@ -130,7 +130,7 @@ module OpenHAB
         #
         def build(update: true, &block)
           builder_proxy = SimpleDelegator.new(nil) if block.arity == 1
-          builder = DSL::Sitemaps::Builder.new(self, builder_proxy, update: update)
+          builder = DSL::Sitemaps::Builder.new(self, builder_proxy, update:)
           if block.arity == 1
             builder_proxy.__setobj__(builder)
             DSL::ThreadLocal.thread_local(openhab_create_dummy_items: true) do

data/lib/openhab/core/things/channel.rb

@@ -176,34 +176,6 @@ module OpenHAB
 
           provider.remove(link_to_delete.uid)
         end
-
-        # @deprecated OH3.4 this whole section is not needed in OH4+. Also see Thing#config_eql?
-        if Core.version < Core::V4_0
-          # @!visibility private
-          module ChannelComparable
-            # @!visibility private
-            # This is only needed in OH3 because it is implemented in OH4 core
-            def ==(other)
-              return true if equal?(other)
-              return false unless other.is_a?(Channel)
-
-              %i[class
-                 uid
-                 label
-                 description
-                 kind
-                 channel_type_uid
-                 configuration
-                 properties
-                 default_tags
-                 auto_update_policy
-                 accepted_item_type].all? do |attr|
-                send(attr) == other.send(attr)
-              end
-            end
-          end
-          org.openhab.core.thing.binding.builder.ChannelBuilder.const_get(:ChannelImpl).prepend(ChannelComparable)
-        end
       end
     end
   end

data/lib/openhab/core/things/profile_callback.rb

@@ -18,7 +18,7 @@ module OpenHAB
             @dummy_channel_item = DSL::Items::ItemBuilder.item_factory.create_item(link.channel.accepted_item_type, "")
           end
           command = @dummy_channel_item.format_command(command) if @dummy_channel_item
-          super(command)
+          super
         end
 
         #
@@ -28,7 +28,7 @@ module OpenHAB
         #
         def send_command(command)
           command = link.item.format_command(command)
-          super(command)
+          super
         end
 
         #
@@ -38,7 +38,7 @@ module OpenHAB
         #
         def send_update(state)
           state = link.item.format_update(state)
-          super(state)
+          super
         end
 
         # @!method send_time_series(time_series)

data/lib/openhab/core/things/proxy.rb

@@ -3,6 +3,9 @@
 require "delegate"
 require "forwardable"
 
+require_relative "thing"
+require_relative "thing_uid"
+
 module OpenHAB
   module Core
     module Things
@@ -18,9 +21,14 @@ module OpenHAB
                   Events::ThingRemovedEvent::TYPE].freeze
         # @!visibility private
         UID_METHOD = :uid
+        # @!visibility private
+        UID_TYPE = ThingUID
 
         include Core::Proxy
 
+        # @return [ThingUID]
+        attr_reader :uid
+
         # Returns the list of channels associated with this Thing
         #
         # @note This is defined on this class, and not on {Thing}, because
@@ -42,57 +50,6 @@ module OpenHAB
         def properties
           Thing::Properties.new(self)
         end
-
-        #
-        # Set the proxy item (called by super)
-        #
-        def __setobj__(thing)
-          @uid = thing.uid
-        end
-
-        #
-        # Lookup thing from thing registry
-        #
-        def __getobj__
-          $things.get(@uid)
-        end
-
-        #
-        # Need to check if `self` _or_ the delegate is an instance of the
-        # given class
-        #
-        # So that {#==} can work
-        #
-        # @return [true, false]
-        #
-        # @!visibility private
-        def instance_of?(klass)
-          __getobj__.instance_of?(klass) || super
-        end
-
-        #
-        # Check if delegates are equal for comparison
-        #
-        # Otherwise items can't be used in Java maps
-        #
-        # @return [true, false]
-        #
-        # @!visibility private
-        def ==(other)
-          return __getobj__ == other.__getobj__ if other.instance_of?(Proxy)
-
-          super
-        end
-
-        #
-        # Non equality comparison
-        #
-        # @return [true, false]
-        #
-        # @!visibility private
-        def !=(other)
-          !(self == other) # rubocop:disable Style/InverseMethods
-        end
       end
     end
   end

data/lib/openhab/core/things/registry.rb

@@ -49,7 +49,7 @@ module OpenHAB
         #   wasn't created by the current provider.
         #
         def build(preferred_provider = nil, update: true, &block)
-          DSL::Things::Builder.new(preferred_provider, update: update).instance_eval(&block)
+          DSL::Things::Builder.new(preferred_provider, update:).instance_eval(&block)
         end
 
         #

data/lib/openhab/core/things/thing.rb

@@ -268,9 +268,7 @@ module OpenHAB
         # @return [true,false] true if all attributes are equal, false otherwise
         #
         def config_eql?(other)
-          # @deprecated OH3.4 - in OH4, channels can be included in the array and do not need to be compared separately
-          channels.to_a == other.channels.to_a &&
-            %i[uid label bridge_uid location configuration].all? { |method| send(method) == other.send(method) }
+          %i[uid label bridge_uid location configuration channels].all? { |method| send(method) == other.send(method) }
         end
 
         #
@@ -279,8 +277,8 @@ module OpenHAB
         # @example
         #   things['mail:smtp:local'].send_email('me@example.com', 'subject', 'message')
         #
-        def method_missing(method, *args, &block)
-          return actions.public_send(method, *args, &block) if actions.respond_to?(method)
+        def method_missing(method, ...)
+          return actions.public_send(method, ...) if actions.respond_to?(method)
 
           super
         end

data/lib/openhab/core/types/command_description.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module Core
+    module Types
+      CommandDescription = org.openhab.core.types.CommandDescription
+
+      # Describes commands you can send to an item
+      module CommandDescription
+        # @!attribute [r] options
+        # @return [Array<org.openhab.core.types.CommandOption>]
+        def options
+          command_options
+        end
+
+        # @return [String]
+        def inspect
+          s = "#<OpenHAB::Core::Types::CommandDescription options=["
+          command_options.each_with_index do |o, i|
+            s += ", " if i != 0
+
+            s += o.command.inspect
+
+            s += " (#{o.label.inspect})" if o.command != o.label && !o.label.nil?
+          end
+          s += "]>"
+        end
+      end
+    end
+  end
+end

data/lib/openhab/core/types/date_time_type.rb

@@ -60,12 +60,7 @@ module OpenHAB
         # @return [ZonedDateTime]
 
         # @!visibility private
-        def to_instant(_context = nil)
-          # @deprecated OH 3.4 getInstant() was added in OH 4.0
-          return get_instant if respond_to?(:get_instant)
-
-          zoned_date_time.to_instant
-        end
+        alias_method :to_instant, :get_instant
 
         # @!method to_instant
         # @return [Instant]
@@ -239,14 +234,14 @@ module OpenHAB
         # Forward missing methods to the `ZonedDateTime` object or a ruby `Time`
         # object representing the same instant
         #
-        def method_missing(method, *args, &block)
+        def method_missing(method, ...)
           # @deprecated OH 4.2 Remove version check when dropping OH 4.2
           if OpenHAB::Core.version >= OpenHAB::Core::V4_3 && to_instant.respond_to?(method)
-            return to_instant.send(method, *args, &block)
+            return to_instant.send(method, ...)
           end
 
-          return zoned_date_time.send(method, *args, &block) if zoned_date_time.respond_to?(method)
-          return to_time.send(method, *args, &block) if ::Time.instance_methods.include?(method.to_sym)
+          return zoned_date_time.send(method, ...) if zoned_date_time.respond_to?(method)
+          return to_time.send(method, ...) if ::Time.instance_methods.include?(method.to_sym)
 
           super
         end

data/lib/openhab/core/types/decimal_type.rb

@@ -139,7 +139,7 @@ module OpenHAB
           remainder: :%,
           pow: :**
         }.each do |java_op, ruby_op|
-          class_eval( # rubocop:disable Style/DocumentDynamicEvalDefinition https://github.com/rubocop/rubocop/issues/10179
+          class_eval( # rubocop:disable Style/DocumentDynamicEvalDefinition -- https://github.com/rubocop/rubocop/issues/10179
             # def +(other)
             #   if other.is_a?(DecimalType)
             #     self.class.new(to_big_decimal.add(other.to_big_decimal))