openhab-scripting 5.13.0 → 5.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfe5a24aad596dbbc699c68d39ffec4417b9199a75738a54292386d80e725525
-  data.tar.gz: 7aa7877384c2df3ee41588660e3db596f807fd5b2b7b781921528f14b0f9fdeb
+  metadata.gz: 11409728d3f0ecb384da9099355fea4728020aa1de1d494d3085dddea518e16c
+  data.tar.gz: d4daa321f0b779b0c9f47ccc405cdafd3a71f55666e173cb29315a7f948b2029
 SHA512:
-  metadata.gz: 756ab20dcfdfce97ba6dfdcbf76d1f40c544607312622e0e013ddd38f7a0d201ae0fec69c13017300fba938d7081eb89f5be5d65ad59abcadf17380ae580dad8
-  data.tar.gz: d9facdcb106fe9fa3e2e51574fa2e52168b9c07eb9c1fad1498a6380e9bc783c8a63535c2a715956a894eb39a2b741ff6f9284fb1de71f9e083262b9f4ed42d0
+  metadata.gz: b8eee772f02cf086af4db419ecaa5752b21393302533f6fea628a6e9bc50d7e986b1815e03c71de7acba63a13088f46d3e73e96d416a1869a7e2b9fe627764ea
+  data.tar.gz: 4ebdb8fb5d81c4429188163e4ced5aabf2ee8a33797b540a32e0e81024a67ac7143728b7679181ca26a4856f8e7e6ed291b5f4bb9427c1df2a744eb6fcb75dd1

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

@@ -252,10 +252,10 @@ module OpenHAB
         end
 
         # @!attribute thing [r]
-        # Return the item's thing if this item is linked with a thing. If an item is linked to more than one thing,
+        # Return the item's thing if this item is linked with a thing. If an item is linked to more than one channel,
         # this method only returns the first thing.
         #
-        # @return [Thing] The thing associated with this item or nil
+        # @return [Things::Thing, nil]
         def thing
           all_linked_things.first
         end
@@ -264,12 +264,46 @@ module OpenHAB
         # @!attribute things [r]
         # Returns all of the item's linked things.
         #
-        # @return [Array<Thing>] An array of things or an empty array
+        # @return [Array<Things::Thing>] An array of things or an empty array
         def things
           Things::Links::Provider.registry.get_bound_things(name).map { |thing| Things::Proxy.new(thing) }
         end
         alias_method :all_linked_things, :things
 
+        # @!attribute channel_uid [r]
+        # Return the UID of the channel this item is linked to. If an item is linked to more than one channel,
+        # this method only returns the first channel.
+        #
+        # @return [Things::ChannelUID, nil]
+        def channel_uid
+          channel_uids.first
+        end
+
+        # @!attribute channel_uids [r]
+        # Return the UIDs of all of the channels this item is linked to.
+        #
+        # @return [Array<Things::ChannelUID>]
+        def channel_uids
+          Things::Links::Provider.registry.get_bound_channels(name)
+        end
+
+        # @!attribute channel [r]
+        # Return the the channel this item is linked to. If an item is linked to more than one channel,
+        # this method only returns the first channel.
+        #
+        # @return [Things::Channel, nil]
+        def channel
+          channel_uids.first&.channel
+        end
+
+        # @!attribute channels [r]
+        # Return all of the channels this item is linked to.
+        #
+        # @return [Array<Things::Channel>]
+        def channels
+          channel_uids.map(&:channel)
+        end
+
         #
         # @!attribute links [r]
         # Returns all of the item's links (channels and link configurations).
@@ -290,30 +324,43 @@ module OpenHAB
         end
 
         #
-        # Links the item to a channel.
+        # @return [Things::ItemChannelLink, nil]
         #
-        # @param [String, Things::Channel, Things::ChannelUID] channel The channel to link to.
-        # @param [Hash] config The configuration for the link.
+        # @overload link
+        #   Returns the item's link. If an item is linked to more than one channel,
+        #   this method only returns the first link.
         #
-        # @return [Things::ItemChannelLink] The created link.
+        #   @return [Things::ItemChannelLink, nil]
         #
-        # @example Link an item to a channel
-        #   LivingRoom_Light_Power.link("mqtt:topic:livingroom-light:power")
+        # @overload link(channel, config = {})
         #
-        # @example Link to a Thing's channel
-        #   LivingRoom_Light_Power.link(things["mqtt:topic:livingroom-light"].channels["power"])
+        #   Links the item to a channel.
         #
-        # @example Specify a link configuration
-        #   High_Temperature_Alert.link(
-        #     "mqtt:topic:outdoor-thermometer:temperature",
-        #     profile: "system:hysteresis",
-        #     lower: "29 °C",
-        #     upper: "30 °C")
+        #   @param [String, Things::Channel, Things::ChannelUID] channel The channel to link to.
+        #   @param [Hash] config The configuration for the link.
         #
-        # @see links
-        # @see unlink
+        #   @return [Things::ItemChannelLink] The created link.
+        #
+        #   @example Link an item to a channel
+        #     LivingRoom_Light_Power.link("mqtt:topic:livingroom-light:power")
         #
-        def link(channel, config = {})
+        #   @example Link to a Thing's channel
+        #     LivingRoom_Light_Power.link(things["mqtt:topic:livingroom-light"].channels["power"])
+        #
+        #   @example Specify a link configuration
+        #     High_Temperature_Alert.link(
+        #       "mqtt:topic:outdoor-thermometer:temperature",
+        #       profile: "system:hysteresis",
+        #       lower: "29 °C",
+        #       upper: "30 °C")
+        #
+        #   @see links
+        #   @see unlink
+        #
+        def link(channel = nil, config = nil)
+          return Things::Links::Provider.registry.get_links(name).first if channel.nil? && config.nil?
+
+          config ||= {}
           Core::Things::Links::Provider.create_link(self, channel, config).tap do |new_link|
             provider = Core::Things::Links::Provider.current
             if !(current_link = provider.get(new_link.uid))

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

@@ -193,4 +193,12 @@ module Enumerable
   def ensure
     OpenHAB::DSL::Items::Ensure::ItemDelegate.new(self)
   end
+
+  #
+  # Send a toggle command to every item in the collection
+  # @return [self]
+  #
+  def toggle
+    each(&:toggle)
+  end
 end

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

@@ -63,7 +63,7 @@ module OpenHAB
         #
         # @example
         #   sitemaps.build do
-        #     sitemap "default", "My Residence" do
+        #     sitemap "default", label: "My Residence" do
         #       frame label: "Control" do
         #         text label: "Climate", icon: "if:mdi:home-thermometer-outline" do
         #           frame label: "Main Floor" do
@@ -112,8 +112,30 @@ module OpenHAB
         #     end
         #   end
         #
+        # @example
+        #   def add_tv(builder, tv)
+        #     builder.frame label: tv.location.label do
+        #       builder.switch item: tv.points(Semantics::Switch), label: "Power"
+        #     end
+        #   end
+        #
+        #   sitemaps.build do |builder|
+        #     builder.sitemap "tvs", label: "TVs" do
+        #       items.equipments(Semantics::TV).each do |tv|
+        #         add_tv(builder, tv)
+        #       end
+        #     end
+        #   end
+        #
         def build(update: true, &block)
-          DSL::Sitemaps::Builder.new(self, update: update).instance_eval(&block)
+          builder_proxy = SimpleDelegator.new(nil) if block.arity == 1
+          builder = DSL::Sitemaps::Builder.new(self, builder_proxy, update: update)
+          if block.arity == 1
+            builder_proxy.__setobj__(builder)
+            yield builder_proxy
+          else
+            builder.instance_eval(&block)
+          end
         end
 
         # For use in specs

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

@@ -33,6 +33,13 @@ module OpenHAB
         end
 
         alias_method :channel_uid, :linked_uid
+
+        # @return [String]
+        def inspect
+          r = "#<OpenHAB::Core::Things::ItemChannelLink item_name=#{item_name} channel_uid=#{channel_uid}"
+          r += " configuration=#{configuration.properties.to_h}" unless configuration.properties.empty?
+          "#{r}>"
+        end
       end
     end
   end

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

@@ -12,18 +12,19 @@ module OpenHAB
       # Base sitemap builder DSL
       class Builder
         # @!visibility private
-        def initialize(provider, update:)
+        def initialize(provider, builder_proxy, update:)
           @provider = provider
+          @builder_proxy = builder_proxy
           @update = update
         end
 
         # (see SitemapBuilder#initialize)
+        # @!method sitemap(name, label: nil, icon: nil, &block)
         # @yield Block executed in the context of a {SitemapBuilder}
         # @return [SitemapBuilder]
         # @!visibility public
-        def sitemap(name, label = nil, icon: nil, &block)
-          sitemap = SitemapBuilder.new(name, label, icon: icon)
-          sitemap.instance_eval_with_dummy_items(&block) if block
+        def sitemap(name, label: nil, icon: nil, &block)
+          sitemap = SitemapBuilder.new(name, @builder_proxy, label: label, icon: icon, &block)
           sitemap = sitemap.build
           if @update && @provider.get(sitemap.uid)
             @provider.update(sitemap)
@@ -105,6 +106,7 @@ module OpenHAB
         #   One or more visibility rules (see {#visibility})
         # @!visibility private
         def initialize(type,
+                       builder_proxy,
                        item: nil,
                        label: nil,
                        icon: nil,
@@ -112,13 +114,15 @@ module OpenHAB
                        label_color: nil,
                        value_color: nil,
                        icon_color: nil,
-                       visibility: nil)
+                       visibility: nil,
+                       &block)
           unless SitemapBuilder.factory.respond_to?("create_#{type}")
             raise ArgumentError,
                   "#{type} is not a valid widget type"
           end
 
           @type = type
+          @builder_proxy = builder_proxy
           @item = item
           @label = label
           @icon = icon
@@ -132,6 +136,20 @@ module OpenHAB
           self.value_color(value_color) if value_color
           self.icon_color(icon_color) if icon_color
           self.visibility(*visibility) if visibility
+
+          return unless block
+
+          @builder_proxy ||= SimpleDelegator.new(nil) if block.arity == 1
+
+          if @builder_proxy
+            old_obj = @builder_proxy.__getobj__
+            @builder_proxy.__setobj__(self)
+            yield @builder_proxy
+          else
+            instance_eval_with_dummy_items(&block)
+          end
+        ensure
+          @builder_proxy&.__setobj__(old_obj)
         end
 
         # Adds one or more new rules for setting the label color
@@ -271,8 +289,8 @@ module OpenHAB
         # @!method initialize(item: nil, label: nil, icon: nil, static_icon: nil, mappings: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil)
         # @param mappings [Hash, Array, nil] Mappings from command to label (see {SwitchBuilder#mappings})
         # @!visibility private
-        def initialize(type, mappings: nil, **kwargs)
-          super(type, **kwargs)
+        def initialize(type, builder_proxy, mappings: nil, **kwargs, &block)
+          super(type, builder_proxy, **kwargs, &block)
 
           @mappings = mappings
         end
@@ -312,8 +330,8 @@ module OpenHAB
         # @param range [Range, nil] Allowed range of the value (see {SetpointBuilder#range})
         # @param step [Numeric,nil] How far the value will change with each button press (see {SetpointBuilder#step})
         # @!visibility private
-        def initialize(type, range: nil, step: nil, **kwargs)
-          super(type, **kwargs)
+        def initialize(type, builder_proxy, range: nil, step: nil, **kwargs, &block)
+          super(type, builder_proxy, **kwargs, &block)
 
           @range = range
           @step = step
@@ -348,8 +366,8 @@ module OpenHAB
         # @param frequency [Numeric, nil]
         #   How often to send requests (in seconds) (see {SliderBuilder#frequency})
         # @!visibility private
-        def initialize(type, switch: nil, frequency: nil, **kwargs)
-          super(type, **kwargs)
+        def initialize(type, builder_proxy, switch: nil, frequency: nil, **kwargs, &block)
+          super(type, builder_proxy, **kwargs, &block)
 
           @switch = switch
           @frequency = frequency
@@ -387,8 +405,8 @@ module OpenHAB
         # @param [String, nil] url (see {VideoBuilder#url})
         # @param [:mjpeg, :hls, nil] encoding (see {VideoBuilder#encoding})
         # @!visibility private
-        def initialize(type, url: nil, encoding: nil, **kwargs)
-          super(type, **kwargs)
+        def initialize(type, builder_proxy, url: nil, encoding: nil, **kwargs, &block)
+          super(type, builder_proxy, **kwargs, &block)
 
           @url = url
           self.encoding = encoding
@@ -456,14 +474,16 @@ module OpenHAB
         #   Formatting string for values on the y axis (see {ChartBuilder#y_axis_pattern})
         # @!visibility private
         def initialize(type,
+                       builder_proxy,
                        service: nil,
                        refresh: nil,
                        period: nil,
                        legend: nil,
                        group: nil,
                        y_axis_pattern: nil,
-                       **kwargs)
-          super(type, **kwargs)
+                       **kwargs,
+                       &block)
+          super(type, builder_proxy, **kwargs, &block)
 
           @service = service
           self.refresh = refresh
@@ -513,8 +533,8 @@ module OpenHAB
         # @!method initialize(item: nil, label: nil, icon: nil, static_icon: nil, height: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil)
         # @param height [Integer] The number of element rows to fill (see {DefaultBuilder#height})
         # @!visibility private
-        def initialize(type, height: nil, **kwargs)
-          super(type, **kwargs)
+        def initialize(type, builder_proxy, height: nil, **kwargs, &block)
+          super(type, builder_proxy, **kwargs, &block)
 
           @height = height
         end
@@ -538,8 +558,8 @@ module OpenHAB
         # @!method initialize(item: nil, label: nil, icon: nil, static_icon: nil, url: nil, height: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil)
         # @param url [String, nil] (see {WebviewBuilder#url})
         # @!visibility private
-        def initialize(type, url: nil, **kwargs)
-          super(type, **kwargs)
+        def initialize(type, builder_proxy, url: nil, **kwargs, &block)
+          super(type, builder_proxy, **kwargs, &block)
 
           @url = url
         end
@@ -564,8 +584,8 @@ module OpenHAB
         # @!method initialize(item: nil, label: nil, icon: nil, static_icon: nil, frequency: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil)
         # @param frequency [Numeric, nil] How often to send requests (see {ColorpickerBuilder#frequency})
         # @!visibility private
-        def initialize(type, frequency: nil, **kwargs)
-          super(type, **kwargs)
+        def initialize(type, builder_proxy, frequency: nil, **kwargs, &block)
+          super(type, builder_proxy, **kwargs, &block)
 
           @frequency = frequency
         end
@@ -600,8 +620,8 @@ module OpenHAB
         # @param [:text, :number, :date, :time, :datetime, nil] hint
         #   Gives a hint to the user interface to use a widget adapted to a specific use (see {InputBuilder#hint})
         # @!visibility private
-        def initialize(type, hint: nil, **kwargs)
-          super(type, **kwargs)
+        def initialize(type, builder_proxy, hint: nil, **kwargs, &block)
+          super(type, builder_proxy, **kwargs, &block)
 
           self.hint = hint
         end
@@ -657,10 +677,10 @@ module OpenHAB
         #
         # @see https://www.openhab.org/docs/ui/sitemaps.html#element-type-buttongrid
         # @!visibility private
-        def initialize(type, buttons: [], **kwargs)
-          super(type, **kwargs)
-          buttons.each { |button| validate_button(button) }
+        def initialize(type, builder_proxy, buttons: [], **kwargs, &block)
           @buttons = buttons
+          super(type, builder_proxy, **kwargs, &block)
+          buttons.each { |button| validate_button(button) }
         end
 
         #
@@ -997,9 +1017,10 @@ module OpenHAB
           class_eval <<~RUBY, __FILE__, __LINE__ + 1
             def #{method}(*args, **kwargs, &block)                         # def frame(*args, **kwargs, &block)
               widget = #{method.capitalize}Builder.new(#{method.inspect},  #   widget = FrameBuilder.new(:frame,
+                                                       @builder_proxy,     #                             @builder_proxy,
                                                        *args,              #                             *args,
-                                                       **kwargs)           #                             **kwargs)
-              widget.instance_eval_with_dummy_items(&block) if block       #   widget.instance_eval_with_dummy_items(&block) if block
+                                                       **kwargs,           #                             **kwargs,
+                                                       &block)             #                             &block)
               children << widget                                           #   children << widget
               widget                                                       #   widget
             end                                                            # end
@@ -1010,9 +1031,9 @@ module OpenHAB
         # @!method initialize(item: nil, label: nil, icon: nil, static_icon: nil, label_color: nil, value_color: nil, icon_color: nil, visibility: nil)
         # @!visibility private
         def initialize(*, **)
-          super
-
           @children = []
+
+          super
         end
 
         # @!visibility private
@@ -1061,8 +1082,8 @@ module OpenHAB
         # @param url [String, nil] The URL for the image (see {ImageBuilder#url})
         # @param refresh [Numeric, nil] How often to refresh the image (see {ImageBuilder#refresh})
         # @!visibility private
-        def initialize(type, url: nil, refresh: nil, **kwargs)
-          super(type, **kwargs)
+        def initialize(type, builder_proxy, url: nil, refresh: nil, **kwargs, &block)
+          super(type, builder_proxy, **kwargs, &block)
 
           @url = url
           @refresh = refresh
@@ -1110,8 +1131,8 @@ module OpenHAB
         # @param label [String, nil]
         # @param icon [String, nil]
         # @!visibility private
-        def initialize(name, label = nil, icon: nil)
-          super(:sitemap, label: label, icon: icon)
+        def initialize(name, builder_proxy, label: nil, icon: nil)
+          super(:sitemap, builder_proxy, label: label, icon: icon)
 
           @name = name
         end

data/lib/openhab/dsl/version.rb

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

data/lib/openhab/osgi.rb

@@ -33,20 +33,25 @@ module OpenHAB
       # Register a new service instance with OSGi
       #
       # @param [Object] instance The service instance
-      # @param [Module] interfaces The interfaces to register this service for.
+      # @param [Module, String] interfaces The interfaces to register this service for.
       #   If not provided, it will default to all Java interfaces the instance
       #   implements.
+      # @param [org.osgi.framework.Bundle, nil] bundle The bundle to register
+      #   the service from. If not provided, it will default to the bundle of the first
+      #   interface.
       # @param [Hash] properties The service registration properties.
       # @return [org.osgi.framework.ServiceRegistration]
       #
-      def register_service(instance, *interfaces, **properties)
+      def register_service(instance, *interfaces, bundle: nil, **properties)
         if interfaces.empty?
           interfaces = instance.class.ancestors.select { |k| k.respond_to?(:java_class) && k.java_class&.interface? }
         end
 
-        bundle = org.osgi.framework.FrameworkUtil.get_bundle(interfaces.first.java_class)
+        bundle_class = interfaces.first.is_a?(Module) ? interfaces.first : instance
+        bundle ||= org.osgi.framework.FrameworkUtil.get_bundle(bundle_class.java_class)
+        interfaces.map! { |i| i.is_a?(String) ? i : i.java_class.name }
         bundle.bundle_context.register_service(
-          interfaces.map { |i| i.java_class.name }.to_java(java.lang.String),
+          interfaces.to_java(java.lang.String),
           instance,
           java.util.Hashtable.new(properties)
         )
@@ -63,6 +68,32 @@ module OpenHAB
       def bundle
         @bundle ||= org.osgi.framework.FrameworkUtil.getBundle($scriptExtension.java_class)
       end
+
+      # @!visibility private
+      SCR_NAMESPACE = "http://www.osgi.org/xmlns/scr/v1.4.0"
+      private_constant :SCR_NAMESPACE
+
+      # @!visibility private
+      def service_component_classes(bundle)
+        require "nokogiri"
+
+        component_paths = bundle.headers.get(
+          org.osgi.service.component.ComponentConstants::SERVICE_COMPONENT
+        )&.split(",") || []
+        component_paths.filter_map do |path|
+          stream = bundle.get_entry(path).open_stream
+          xml = Nokogiri::XML(String.from_java_bytes(stream.read_all_bytes))
+
+          class_name = xml.at_xpath("scr:component/implementation", scr: SCR_NAMESPACE)&.[]("class")
+          next unless class_name
+
+          services = xml.xpath("scr:component/service/provide", scr: SCR_NAMESPACE).map { |p| p["interface"] }
+
+          [bundle.load_class(class_name), services]
+        ensure
+          stream&.close
+        end.to_h
+      end
     end
   end
 end

data/lib/openhab/rspec/helpers.rb

@@ -77,23 +77,37 @@ module OpenHAB
       #
       # @return [void]
       #
+      # @deprecated
       def autoupdate_all_items
-        if instance_variable_defined?(:@autoupdated_items)
-          raise RuntimeError "You should only call `autoupdate_all_items` once per spec"
-        end
-
-        @autoupdated_items = []
-        @spec_metadata_provider = Core::Items::Metadata::Provider.current
+        # no-op
+      end
 
-        $ir.for_each do |_provider, item|
-          if (hash = item.metadata["autoupdate"])
-            provider = Core::Items::Metadata::Provider.registry.provider_for(hash.uid)
-            provider.remove(hash.uid)
-            @autoupdated_items << [provider, hash]
-            provider(@spec_metadata_provider) do
-              item.metadata["autoupdate"] = "true"
-            end
+      #
+      # Force things to come online that are missing their thing type
+      #
+      # As of openHAB 4.0, things that are missing their thing type will not
+      # come online immediately. This especially impacts bindings that
+      # dynamically generate their thing types, but don't persist those
+      # thing types. You can use this method to force them to come online
+      # immediately.
+      #
+      # @return [void]
+      #
+      def initialize_missing_thing_types
+        thing_manager = OpenHAB::OSGi.service("org.openhab.core.thing.ThingManager")
+        thing_manager.class.field_reader :missingPrerequisites
+        first = true
+        thing_manager.missingPrerequisites.each_value do |prereq|
+          if first
+            prereq.class.field_accessor :timesChecked
+            first = false
           end
+          prereq.timesChecked = 60
+        end
+        m = thing_manager.class.java_class.get_declared_method(:checkMissingPrerequisites)
+        m.accessible = true
+        suspend_rules do
+          m.invoke(thing_manager)
         end
       end
 
@@ -226,8 +240,11 @@ module OpenHAB
         require_relative "openhab/core/actions"
 
         ps = Mocks::PersistenceService.instance
-        bundle = org.osgi.framework.FrameworkUtil.get_bundle(org.openhab.core.persistence.PersistenceService.java_class)
-        bundle.bundle_context.register_service(org.openhab.core.persistence.PersistenceService.java_class, ps, nil)
+        persistence_bundle = org.osgi.framework.FrameworkUtil
+                                .get_bundle(org.openhab.core.persistence.PersistenceService.java_class)
+        persistence_bundle.bundle_context.register_service(org.openhab.core.persistence.PersistenceService.java_class,
+                                                           ps,
+                                                           nil)
 
         rs = OSGi.service("org.openhab.core.service.ReadyService")
 
@@ -240,6 +257,33 @@ module OpenHAB
           rs.register_tracker(org.openhab.core.service.ReadyService::ReadyTracker.impl { continue.call }, filter)
         end
 
+        begin
+          # load storage based type providers
+          ast = org.openhab.core.thing.binding.AbstractStorageBasedTypeProvider
+          ast_bundle = org.osgi.framework.FrameworkUtil.get_bundle(ast.java_class)
+          storage_service = OSGi.service("org.openhab.core.storage.StorageService")
+          require_relative "mocks/abstract_storage_based_type_provider_wrapped_storage_service"
+
+          OSGi.bundle_context.bundles.each do |bundle|
+            OSGi.service_component_classes(bundle)
+                .select { |klass, _services| klass.ancestors.include?(ast.java_class) }
+                .each do |klass, services|
+              new_ast_klass = Class.new(ast)
+              new_ast_klass.become_java!
+              wrapped_storage_service = Mocks::AbstractStorageBasedTypeProviderWrappedStorageService
+                                        .new(storage_service,
+                                             new_ast_klass.java_class,
+                                             klass)
+              new_ast = new_ast_klass.new(wrapped_storage_service)
+
+              services -= [klass.name]
+              OSGi.register_service(new_ast, *services, bundle: ast_bundle)
+            end
+          end
+        rescue NameError
+          # @deprecated OH 4.0
+        end
+
         # RSpec additions
         require_relative "suspend_rules"
 
@@ -422,32 +466,6 @@ module OpenHAB
           .gsub(%r{(?:_|(/))([a-z\d]*)}) { "#{$1}#{$2.capitalize}" }
           .split("/")
       end
-
-      # need to transfer autoupdate metadata from GenericMetadataProvider to ManagedMetadataProvider
-      # so that we can mutate it in the future
-      def set_up_autoupdates
-        registry = Core::Items::Metadata::Provider.registry
-        registry.class.field_reader :identifierToElement
-
-        autoupdate_provider = Core::Items::Metadata::Provider.send(:new)
-        registry.all.each do |metadata|
-          next unless metadata.uid.namespace == "autoupdate"
-
-          # tweak the registry to allow us to overwrite this element
-          registry.identifierToElement.delete(metadata.uid)
-          autoupdate_provider.add(metadata)
-        end
-      end
-
-      def restore_autoupdate_items
-        return unless instance_variable_defined?(:@autoupdated_items)
-
-        @autoupdated_items.each do |(provider, hash)|
-          @spec_metadata_provider.remove(hash.uid)
-          provider.add(hash.instance_variable_get(:@metadata))
-        end
-        @autoupdated_items = nil
-      end
     end
 
     if defined?(::RSpec)

data/lib/openhab/rspec/hooks.rb

@@ -38,7 +38,6 @@ module OpenHAB
           end
 
           Helpers.autorequires unless Configuration.private_confdir
-          Helpers.send(:set_up_autoupdates)
           Helpers.load_transforms
           Helpers.load_rules
 
@@ -52,6 +51,10 @@ module OpenHAB
           end
         end
 
+        config.around do |example|
+          Mocks::Timer.mock_timers(self.class.mock_timers?, &example)
+        end
+
         config.before do
           suspend_rules do
             $ir.for_each do |_provider, item|
@@ -88,8 +91,6 @@ module OpenHAB
           @profile_factory = Core::ProfileFactory.send(:new)
           allow(Core::ProfileFactory).to receive(:instance).and_return(@profile_factory)
 
-          stub_const("OpenHAB::Core::Timer", Mocks::Timer) if self.class.mock_timers?
-
           log_line = "rspec #{example.location} # #{example.full_description}"
           logger.info(log_line)
           Logger.events.info(log_line)
@@ -103,7 +104,6 @@ module OpenHAB
           # wipe this
           DSL::Items::TimedCommand.timed_commands.clear
           Timecop.return
-          restore_autoupdate_items
           Mocks::PersistenceService.instance.reset
           Hooks.cache_script_extension.sharedCache.clear if DSL.shared_cache
           DSL.persistence!(nil)

data/lib/openhab/rspec/karaf.rb

@@ -537,6 +537,10 @@ module OpenHAB
 
       def add_class_loader(bundle)
         return if @class_loaders.include?(bundle.symbolic_name)
+        # this bundle sometimes has an invalid internal jar (geronimo-osgi-locator.jar) which will
+        # spam the logs with useless errors. it's doubtful we'll need to access a class from this
+        # bundle directly
+        return if bundle.symbolic_name == "org.apache.aries.javax.jax.rs-api"
 
         @class_loaders << bundle.symbolic_name
         ::JRuby.runtime.instance_config.add_loader(JRuby::OSGiBundleClassLoader.new(bundle))

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "delegate"
+
+module OpenHAB
+  module RSpec
+    # @!visibility private
+    module Mocks
+      class AbstractStorageBasedTypeProviderWrappedStorageService < SimpleDelegator
+        include org.openhab.core.storage.StorageService
+
+        def initialize(parent, ruby_klass, java_klass)
+          super(parent)
+          @ruby_klass = ruby_klass
+          @java_klass = java_klass
+        end
+
+        def getStorage(name, _class_loader) # rubocop:disable Naming/MethodName
+          super(name.sub(@ruby_klass.name, @java_klass.name), @java_klass.class_loader)
+        end
+      end
+    end
+  end
+end

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

@@ -29,7 +29,13 @@ module OpenHAB
           @thing = thing
         end
 
-        def handle_command(channel, command); end
+        def handle_command(channel_uid, command)
+          channel = thing.get_channel(channel_uid)
+          return unless channel
+          return if channel.auto_update_policy == org.openhab.core.thing.type.AutoUpdatePolicy::VETO
+
+          callback&.state_updated(channel_uid, command) if command.is_a?(Core::Types::State)
+        end
 
         def set_callback(callback)
           @callback = callback

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

@@ -72,6 +72,42 @@ module OpenHAB
         end
         Timecop::TimeStackItem.prepend(TimeCopStackItem)
 
+        class << self
+          # If timers are currently mocked
+          # @return [true, false]
+          def mock_timers?
+            @mock_timers
+          end
+
+          #
+          # Temporarily mock or unmock timers
+          #
+          # @param [true, false] mock_timers if timers should be mocked
+          # @yield
+          # @return [Object] the block's return value
+          def mock_timers(mock_timers)
+            old_mock_timers = @mock_timers
+            @mock_timers = mock_timers
+            yield
+          ensure
+            @mock_timers = old_mock_timers
+          end
+        end
+
+        @mock_timers = true
+
+        # @!visibility private
+        module ClassMethods
+          # @!visibility private
+          def new(*args, **kwargs)
+            return super if self == Timer
+            return Timer.new(*args, **kwargs) if Timer.mock_timers?
+
+            super
+          end
+        end
+        Core::Timer.singleton_class.prepend(ClassMethods)
+
         attr_reader :execution_time, :id, :block
 
         def initialize(time, id:, thread_locals:, block:) # rubocop:disable Lint/MissingSuper

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.13.0
+  version: 5.15.0
 platform: ruby
 authors:
 - Brian O'Connell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-04 00:00:00.000000000 Z
+date: 2024-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -546,6 +546,7 @@ files:
 - lib/openhab/rspec/hooks.rb
 - lib/openhab/rspec/jruby.rb
 - lib/openhab/rspec/karaf.rb
+- lib/openhab/rspec/mocks/abstract_storage_based_type_provider_wrapped_storage_service.rb
 - lib/openhab/rspec/mocks/bundle_install_support.rb
 - lib/openhab/rspec/mocks/bundle_resolver.rb
 - lib/openhab/rspec/mocks/event_admin.rb
@@ -607,7 +608,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.4
 signing_key: 
 specification_version: 4
 summary: JRuby Helper Libraries for openHAB Scripting