openhab-scripting 5.13.0 → 5.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfe5a24aad596dbbc699c68d39ffec4417b9199a75738a54292386d80e725525
-  data.tar.gz: 7aa7877384c2df3ee41588660e3db596f807fd5b2b7b781921528f14b0f9fdeb
+  metadata.gz: 29d5852ff9f0b047b5e70f69d8ece471770b59a86f4989a3120a7c6027fec1b9
+  data.tar.gz: 39c590e109e6c5349fd6b4b5eee9bf2e5a3058f4b8cf875b6b69f02bb89996df
 SHA512:
-  metadata.gz: 756ab20dcfdfce97ba6dfdcbf76d1f40c544607312622e0e013ddd38f7a0d201ae0fec69c13017300fba938d7081eb89f5be5d65ad59abcadf17380ae580dad8
-  data.tar.gz: d9facdcb106fe9fa3e2e51574fa2e52168b9c07eb9c1fad1498a6380e9bc783c8a63535c2a715956a894eb39a2b741ff6f9284fb1de71f9e083262b9f4ed42d0
+  metadata.gz: 41707220dfe28a3a7395b4d0b7c8538e8150448934d97f63d5b96a533f859f681b47d68bb83688cfa316737b34622f90c7da670915a454427a9c4c705d9cfa9e
+  data.tar.gz: 9c8ae71904b136e9aa2e11027e0de57101721b7096352994a2d636595f69b32a07e0992bf476a0200e0e6de5330a6a70d6e6f363f2e1f4c687ff1b033f013710

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/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

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

@@ -18,11 +18,12 @@ module OpenHAB
         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)
+        def sitemap(name, label: nil, icon: nil, &block)
+          sitemap = SitemapBuilder.new(name, label: label, icon: icon)
           sitemap.instance_eval_with_dummy_items(&block) if block
           sitemap = sitemap.build
           if @update && @provider.get(sitemap.uid)
@@ -1110,7 +1111,7 @@ module OpenHAB
         # @param label [String, nil]
         # @param icon [String, nil]
         # @!visibility private
-        def initialize(name, label = nil, icon: nil)
+        def initialize(name, label: nil, icon: nil)
           super(:sitemap, label: label, icon: icon)
 
           @name = name

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.14.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.14.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-05 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