openhab-scripting 5.47.2 → 5.47.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc01fc5b78f4277f109e3af749c00555137227e0b235b95e340b6f41e3c4cd53
-  data.tar.gz: 63b9c1f495c103fd771b2bff0a13f6cca34c7492da8260f4fc10830a67483f96
+  metadata.gz: 2fd2aa14f2bc1f8ac43aa9cd55dd95c24395367e95f16732b3911d77d707e12d
+  data.tar.gz: 35b524b0b291fd2fdec0f25290274be648697860e17df54ad8c06e0f643fbc0f
 SHA512:
-  metadata.gz: 1516bba75109008f02deb38963377bc594f6ea1e674077da2dbafb4cac8ccb113e69d38cbfd086c099f68616f07e56e06c40f974ad0bfd2370f4c27c9dae3740
-  data.tar.gz: b8d9c6b0fd41c49ab5f334fc45e6d7cf421ff898cb40555c6085cbff8f7bed29003530f420f72b29be2b603c521e4b1ccc92cc21764d99c36209725aba636adc
+  metadata.gz: 12f55e491a8c72447d539c45ddd74db196c80c92bbec37e0f0aa0277b53633f14c78d15634b5814b75fd715844096d53f324d443806e0d5f30895addc50c44b2
+  data.tar.gz: 3eec0b52f59468f948ee68269d47a3d537ff425795f018f6ed4dd493c6caf8912482125db293ef1f9aac571c93b3a02fd084417f0a6a9a1aafd2bbb7dd25bbd7

data/lib/openhab/core/items/metadata/hash.rb

@@ -264,7 +264,10 @@ module OpenHAB
           # in the meantime, force the serialization round-trip right now
           #
           def javaify
-            mapper = Provider.registry.managed_provider.get.storage.entityMapper
+            managed_provider = Provider.registry.managed_provider
+            # @deprecated remove the next line when dropping openHAB 5.1
+            managed_provider = managed_provider.get if managed_provider.is_a?(java.util.Optional)
+            mapper = managed_provider.storage.entityMapper
 
             @metadata = mapper.from_json(mapper.to_json_tree(@metadata), Metadata.java_class)
           end

data/lib/openhab/core/items/metadata/provider.rb

@@ -22,8 +22,11 @@ module OpenHAB
           end
 
           # see Hash#javaify
-          registry.managed_provider.get.class.field_reader :storage
-          registry.managed_provider.get.storage.class.field_reader :entityMapper
+          managed_provider = registry.managed_provider
+          # @deprecated remove the next line when dropping openHAB 5.1
+          managed_provider = managed_provider.get if managed_provider.is_a?(java.util.Optional)
+          managed_provider.class.field_reader :storage
+          managed_provider.storage.class.field_reader :entityMapper
 
           #
           # Removes all metadata of a given item.

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

@@ -35,6 +35,8 @@ module OpenHAB
           item
         end
 
+        private
+
         def initialize
           super(unload_priority: 50)
         end

data/lib/openhab/core/provider.rb

@@ -87,7 +87,10 @@ module OpenHAB
           when nil, :transient
             instance
           when :persistent
-            registry.managed_provider.get
+            provider = registry.managed_provider
+            # @deprecated remove the next line when dropping openHAB 5.1
+            provider = provider.get if provider.is_a?(java.util.Optional)
+            provider
           when org.openhab.core.common.registry.ManagedProvider
             preferred_provider
           else
@@ -122,6 +125,7 @@ module OpenHAB
           end
 
           r = provider = super()
+
           if block_given?
             if thread_provider
               DSL.provider(provider) do
@@ -226,7 +230,7 @@ module OpenHAB
       # @!visibility private
       def unregister
         clear
-        self.class.registry.remove_provider(self)
+        self.class.registry&.remove_provider(self)
       end
 
       private
@@ -236,7 +240,13 @@ module OpenHAB
         @elements = java.util.concurrent.ConcurrentHashMap.new
         self.class.registry&.add_provider(self)
         ScriptHandling.script_unloaded(priority: unload_priority) { unregister }
+        # @deprecated OH 5.2: Remove the rest of this method when dropping OH 5.1
+        extra_initialize
       end
+
+      # @deprecated OH 5.2: Remove this method when dropping OH 5.1
+      # See https://github.com/jruby/jruby/issues/9321 for why this is needed instead of just putting the code in Model::Provider#initialize
+      def extra_initialize; end
     end
   end
 end

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module Core
+    module Sitemaps
+      #
+      # Compatibility helpers for old model-backed sitemaps and the new core sitemap registry.
+      #
+      # @deprecated OH 5.2: Remove entire module when dropping OH 5.1, collapsing calls to match the registry branch
+      # Don't forget to remove the reference to it in .yardopts
+      # @!visibility private
+      module Compatibility
+        class << self
+          def factory
+            Provider.factory
+          end
+
+          if Provider.registry
+            def supported_widget_type?(type)
+              return true if type == :sitemap
+
+              factory.get_supported_widget_types.include?(camelize(type))
+            end
+
+            def create_sitemap(name)
+              factory.create_sitemap(name)
+            end
+
+            def create_widget(type, parent = nil)
+              parent ? factory.create_widget(camelize(type), parent) : factory.create_widget(camelize(type))
+            end
+
+            def create_rule(_type)
+              factory.create_rule
+            end
+
+            def set_condition(condition, sign:, state:)
+              condition.value = "#{sign}#{state}"
+            end
+          else
+            def supported_widget_type?(type)
+              factory.respond_to?(:"create_#{type}")
+            end
+
+            def create_sitemap(name)
+              factory.create_sitemap.tap { |sitemap| sitemap.name = name }
+            end
+
+            def create_widget(type, _parent = nil)
+              factory.public_send(:"create_#{type}")
+            end
+
+            def create_rule(type)
+              case type
+              when :visibility then factory.create_visibility_rule
+              when :icon then factory.create_icon_rule
+              when :color then factory.create_color_array
+              end
+            end
+
+            def set_condition(condition, sign:, state:)
+              condition.sign = sign
+              condition.state = state
+            end
+          end
+
+          private
+
+          def camelize(type)
+            type.to_s.split("_").map(&:capitalize).join
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+# @deprecated OH 5.2: Remove entire file when dropping OH 5.1
+# Don't forget to remove the reference to it in .yardopts
+return if OpenHAB::Core::Sitemaps::Provider.registry
+
+module OpenHAB
+  module Core
+    module Sitemaps
+      # Adds compatibility shims for the old Xtext based Sitemap model to the newer registry style
+      # @!visibility private
+      module Model
+        org.openhab.core.model.sitemap.sitemap.impl.SitemapImpl.alias_method :uid, :name
+        org.openhab.core.model.sitemap.sitemap.impl.SitemapImpl.alias_method :widgets, :children
+
+        org.openhab.core.model.sitemap.sitemap.impl.LinkableWidgetImpl.alias_method :widgets, :children
+
+        module Rule
+          org.openhab.core.model.sitemap.sitemap.impl.ColorArrayImpl.include(self)
+          org.openhab.core.model.sitemap.sitemap.impl.IconRuleImpl.include(self)
+
+          def argument = arg
+
+          def argument=(value)
+            self.arg = value
+          end
+        end
+
+        module Widget
+          org.openhab.core.model.sitemap.sitemap.impl.WidgetImpl.prepend(self)
+
+          def icon
+            static_icon || super
+          end
+
+          def icon=(value)
+            if instance_variable_defined?(:@static_icon) && @static_icon
+              self.static_icon = value
+              return
+            end
+            super
+          end
+
+          def static_icon=(value)
+            # Disable "instance vars on non-persistent Java type"
+            original_verbose = $VERBOSE
+            $VERBOSE = nil
+            if value == true
+              @static_icon = true
+              return
+            end
+
+            super
+          ensure
+            $VERBOSE = original_verbose
+          end
+        end
+
+        module Condition
+          org.openhab.core.model.sitemap.sitemap.impl.ConditionImpl.include(self)
+
+          def value = "#{sign}#{state}"
+        end
+
+        module Provider
+          def self.prepended(klass)
+            klass.include org.openhab.core.model.sitemap.SitemapProvider
+          end
+
+          SUFFIX = ".sitemap"
+          private_constant :SUFFIX
+
+          def getSitemap = get # rubocop:disable Naming/MethodName
+
+          # rubocop:disable Naming/MethodName
+          def getSitemapNames
+            @elements.key_set
+          end
+
+          def addModelChangeListener(listener)
+            @listeners.add(listener)
+          end
+
+          def removeModelChangeListener(listener)
+            @listeners.remove(listener)
+          end
+          # rubocop:enable Naming/MethodName
+
+          def unregister
+            clear
+            @registration.unregister
+          end
+
+          def update(sitemap)
+            if sitemap.respond_to?(:to_str)
+              sitemap = get(sitemap).tap do |obj|
+                raise ArgumentError, "Sitemap #{sitemap} not found" unless obj
+              end
+            end
+            super
+          end
+
+          def remove(sitemap)
+            sitemap = sitemap.uid if sitemap.respond_to?(:uid)
+            super
+          end
+
+          private
+
+          def notify_listeners_about_added_element(element)
+            model_name = "#{element.name}#{SUFFIX}"
+            @listeners.each do |listener|
+              listener.modelChanged(model_name, org.openhab.core.model.core.EventType::ADDED)
+              listener.modelChanged(model_name, org.openhab.core.model.core.EventType::MODIFIED)
+            end
+          end
+
+          def notify_listeners_about_removed_element(element)
+            model_name = "#{element.name}#{SUFFIX}"
+            @listeners.each { |listener| listener.modelChanged(model_name, org.openhab.core.model.core.EventType::REMOVED) }
+          end
+
+          def notify_listeners_about_updated_element(_old_element, element)
+            model_name = "#{element.name}#{SUFFIX}"
+            @listeners.each { |listener| listener.modelChanged(model_name, org.openhab.core.model.core.EventType::MODIFIED) }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "singleton"
-
 module OpenHAB
   module Core
     #
@@ -12,191 +10,65 @@ module OpenHAB
       # Provides sitemaps created in Ruby to openHAB
       #
       class Provider < Core::Provider
-        SUFFIX = ".sitemap"
-        private_constant :SUFFIX
-
         class << self
-          # @!visibility private
+          #
+          # The Sitemap registry
+          #
+          # @return [org.openhab.core.sitemap.registry.SitemapRegistry, nil]
+          #
+          # @since 5.2.0
+          #
           def registry
-            nil
+            return @registry if instance_variable_defined?(:@registry)
+
+            @registry = OSGi.service("org.openhab.core.sitemap.registry.SitemapRegistry")
+          end
+
+          # @!visibility private
+          def factory
+            # @deprecated OH 5.2: remove the non-registry branch when dropping OH 5.1
+            @factory ||= if registry
+                           OSGi.service("org.openhab.core.sitemap.registry.SitemapFactory")
+                         else
+                           org.openhab.core.model.sitemap.sitemap.SitemapFactory.eINSTANCE
+                         end
           end
         end
 
-        include org.openhab.core.model.sitemap.SitemapProvider
+        # @deprecated OH 5.2: remove the non-registry branch when dropping OH 5.1
+        if registry
+          require_relative "sitemap"
+
+          include org.openhab.core.sitemap.registry.SitemapProvider
+        else
+          require_relative "model"
+
+          prepend Model::Provider
+        end
 
-        # @!visibility private
         alias_method :getSitemap, :get # rubocop:disable Naming/MethodName
 
         # rubocop:disable Naming/MethodName
-
         # @!visibility private
         def getSitemapNames
           @elements.key_set
         end
-
-        # @!visibility private
-        def addModelChangeListener(listener)
-          @listeners.add(listener)
-        end
-
-        # @!visibility private
-        def removeModelChangeListener(listener)
-          @listeners.remove(listener)
-        end
-
         # rubocop:enable Naming/MethodName
 
-        # @!visibility private
-        # Override this because we don't have a registry
-        def unregister
-          clear
-          @registration.unregister
-        end
-
-        #
-        # Enter the Sitemap Builder DSL.
-        #
-        # @param update [true, false]  When true, existing sitemaps with the same name will be updated.
-        # @yield Block executed in the context of a {DSL::Sitemaps::Builder}
-        # @return [void]
-        #
-        # @see DSL::Sitemaps::Builder
-        #
-        # @example
-        #   sitemaps.build 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
-        #             # colors are set with a hash, with key being condition, and value being the color
-        #             # The :default key is used when no other condition matches
-        #             text item: MainFloor_AmbTemp,
-        #               label_color: "purple", # A simple string can be used when no conditions are needed
-        #               value_color: { ">=90" => "red", "<=70" => "blue", :default => "black" }
-        #
-        #             # If item name is not provided in the condition, it will default to the widget's Item
-        #             # The operator will default to == if not specified
-        #             switch item: MainFloorThermostat_TargetMode, label: "Mode",
-        #               mappings: %w[off auto cool heat],
-        #               value_color: { "cool" => "blue", "heat" => "red", :default => "black" }
-        #
-        #             # an array of conditions are AND'd together
-        #             setpoint item: MainFloorThermostat_SetPoint, label: "Set Point",
-        #               value_color: {
-        #                 ["MainFloorThermostat_TargetMode!=off", ">80"] => "red", # red if mode!=off AND setpoint > 80
-        #                 ["MainFloorThermostat_TargetMode!=off", ">74"] => "yellow",
-        #                 ["MainFloorThermostat_TargetMode!=off", ">70"] => "green",
-        #                 "MainFloorThermostat_TargetMode!=off" => "blue",
-        #                 :default => "gray"
-        #               }
-        #           end
-        #           frame label: "Basement" do
-        #             text item: Basement_AmbTemp
-        #             switch item: BasementThermostat_TargetMode, label: "Mode",
-        #               mappings: { OFF: "off", COOL: "cool", HEAT: "heat" }
-        #
-        #             # Conditions within a nested array are AND'd together (requires openHAB 4.1)
-        #             setpoint item: BasementThermostat_SetPoint, label: "Set Point",
-        #               visibility: [["BasementThermostat_TargetMode!=off", "Vacation_Switch==OFF"]]
-        #
-        #             # Additional elements are OR'd
-        #             # The following visibility conditions are evaluated as:
-        #             # (BasementThermostat_TargetMode!=off AND Vacation_Switch==OFF) OR Verbose_Mode==ON
-        #             setpoint item: BasementThermostat_SetPoint, label: "Set Point",
-        #               visibility: [
-        #                 ["BasementThermostat_TargetMode!=off", "Vacation_Switch==OFF"],
-        #                 "Verbose_Mode==ON"
-        #               ]
-        #           end
-        #         end
-        #       end
-        #     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)
-          builder_proxy = SimpleDelegator.new(nil) if block.arity == 1
-          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
-              yield builder_proxy
-            end
-          else
-            builder.instance_eval(&block)
-          end
-        end
-
-        #
-        # Notify listeners about updated sitemap
-        #
-        # @param [String, org.openhab.core.model.sitemap.sitemap.Sitemap] sitemap The sitemap to update.
-        # @return [void]
-        #
-        def update(sitemap)
-          if sitemap.respond_to?(:to_str)
-            sitemap = get(sitemap).tap do |obj|
-              raise ArgumentError, "Sitemap #{sitemap} not found" unless obj
-            end
-          end
-          super
-        end
-
-        #
-        # Remove a sitemap.
-        #
-        # @param [String, org.openhab.core.model.sitemap.sitemap.Sitemap] sitemap
-        # @return [Boolean] If a sitemap was removed
-        #
-        def remove(sitemap)
-          sitemap = sitemap.uid if sitemap.respond_to?(:uid)
-          super
-        end
-
         private
 
-        def initialize
-          super
-          @listeners = java.util.concurrent.CopyOnWriteArraySet.new
+        # @deprecated OH 5.2: Remove this entire method when dropping OH 5.1
+        # I can't put this in Model::Provider#initialize, due to https://github.com/jruby/jruby/issues/9321
+        def extra_initialize
+          return if self.class.registry
 
+          @listeners = java.util.concurrent.CopyOnWriteArraySet.new
           @registration = OSGi.register_service(self, org.openhab.core.model.sitemap.SitemapProvider)
         end
-
-        def notify_listeners_about_added_element(element)
-          model_name = "#{element.name}#{SUFFIX}"
-          @listeners.each do |l|
-            l.modelChanged(model_name, org.openhab.core.model.core.EventType::ADDED)
-            # Ensure that when a script is reloaded, the sitemap is updated.
-            # This is because our listener, org.openhab.core.io.rest.sitemap.SitemapSubscriptionService
-            # only handles MODIFIED events in its modelChanged() method.
-            l.modelChanged(model_name, org.openhab.core.model.core.EventType::MODIFIED)
-          end
-        end
-
-        def notify_listeners_about_removed_element(element)
-          model_name = "#{element.name}#{SUFFIX}"
-          @listeners.each { |l| l.modelChanged(model_name, org.openhab.core.model.core.EventType::REMOVED) }
-        end
-
-        def notify_listeners_about_updated_element(_old_element, element)
-          model_name = "#{element.name}#{SUFFIX}"
-          @listeners.each { |l| l.modelChanged(model_name, org.openhab.core.model.core.EventType::MODIFIED) }
-        end
       end
     end
   end
 end
+
+# @deprecated OH 5.2: Remove require when dropping OH 5.1
+require_relative "compatibility"

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

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+require_relative "provider"
+
+module OpenHAB
+  module Core
+    module Sitemaps
+      #
+      # Provides access to all openHAB sitemap definitions, and acts like an array.
+      #
+      class Registry
+        include LazyArray
+        include Singleton
+
+        #
+        # Gets a specific sitemap definition.
+        #
+        # @param [String] name Sitemap name
+        # @return [Sitemap, nil]
+        #
+        def [](name)
+          # @deprecated OH 5.2: Remove the registry check when dropping OH 5.1
+          Provider.registry ? Provider.registry.get(name) : Provider.current.get(name)
+        end
+        alias_method :include?, :[]
+        alias_method :key?, :[]
+        # @deprecated
+        alias_method :has_key?, :[]
+
+        #
+        # Explicit conversion to array.
+        #
+        # @return [Array<Sitemap>]
+        #
+        def to_a
+          # @deprecated OH 5.2: Remove the registry check when dropping OH 5.1
+          Provider.registry ? Provider.registry.all.to_a : Provider.current.all.to_a
+        end
+
+        #
+        # Enter the Sitemap Builder DSL.
+        #
+        # @param update [true, false]  When true, existing sitemaps with the same name will be updated.
+        # @yield Block executed in the context of a {DSL::Sitemaps::Builder}
+        # @return [void]
+        #
+        # @see DSL::Sitemaps::Builder
+        #
+        # @example
+        #   sitemaps.build 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
+        #             # colors are set with a hash, with key being condition, and value being the color
+        #             # The :default key is used when no other condition matches
+        #             text item: MainFloor_AmbTemp,
+        #               label_color: "purple", # A simple string can be used when no conditions are needed
+        #               value_color: { ">=90" => "red", "<=70" => "blue", :default => "black" }
+        #
+        #             # If item name is not provided in the condition, it will default to the widget's Item
+        #             # The operator will default to == if not specified
+        #             switch item: MainFloorThermostat_TargetMode, label: "Mode",
+        #               mappings: %w[off auto cool heat],
+        #               value_color: { "cool" => "blue", "heat" => "red", :default => "black" }
+        #
+        #             # an array of conditions are AND'd together
+        #             setpoint item: MainFloorThermostat_SetPoint, label: "Set Point",
+        #               value_color: {
+        #                 ["MainFloorThermostat_TargetMode!=off", ">80"] => "red", # red if mode!=off AND setpoint > 80
+        #                 ["MainFloorThermostat_TargetMode!=off", ">74"] => "yellow",
+        #                 ["MainFloorThermostat_TargetMode!=off", ">70"] => "green",
+        #                 "MainFloorThermostat_TargetMode!=off" => "blue",
+        #                 :default => "gray"
+        #               }
+        #           end
+        #           frame label: "Basement" do
+        #             text item: Basement_AmbTemp
+        #             switch item: BasementThermostat_TargetMode, label: "Mode",
+        #               mappings: { OFF: "off", COOL: "cool", HEAT: "heat" }
+        #
+        #             # Conditions within a nested array are AND'd together (requires openHAB 4.1)
+        #             setpoint item: BasementThermostat_SetPoint, label: "Set Point",
+        #               visibility: [["BasementThermostat_TargetMode!=off", "Vacation_Switch==OFF"]]
+        #
+        #             # Additional elements are OR'd
+        #             # The following visibility conditions are evaluated as:
+        #             # (BasementThermostat_TargetMode!=off AND Vacation_Switch==OFF) OR Verbose_Mode==ON
+        #             setpoint item: BasementThermostat_SetPoint, label: "Set Point",
+        #               visibility: [
+        #                 ["BasementThermostat_TargetMode!=off", "Vacation_Switch==OFF"],
+        #                 "Verbose_Mode==ON"
+        #               ]
+        #           end
+        #         end
+        #       end
+        #     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)
+          builder_proxy = SimpleDelegator.new(nil) if block.arity == 1
+          builder = DSL::Sitemaps::Builder.new(builder_proxy, update:)
+          if block.arity == 1
+            builder_proxy.__setobj__(builder)
+            DSL::ThreadLocal.thread_local(openhab_create_dummy_items: true) do
+              yield builder_proxy
+            end
+          else
+            builder.instance_eval(&block)
+          end
+        end
+
+        #
+        # Remove a sitemap.
+        #
+        # The sitemap must be managed by Ruby.
+        #
+        # @param [String, Sitemap] sitemap Sitemap or sitemap name
+        # @return [Sitemap] The removed sitemap.
+        # @raise [RuntimeError] if the sitemap cannot be removed.
+        #
+        def remove(sitemap)
+          sitemap = sitemap.uid if sitemap.respond_to?(:uid)
+          old_instance = Provider.current.remove(sitemap)
+          old_instance ||= Provider.registry&.remove(sitemap)
+
+          raise "Cannot remove sitemap #{sitemap}" unless old_instance
+
+          old_instance
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module Core
+    module Sitemaps
+      # @interface
+      java_import org.openhab.core.sitemap.Sitemap
+    end
+  end
+end

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

@@ -20,6 +20,8 @@ module OpenHAB
           end
         end
 
+        private
+
         def initialize
           super(unload_priority: 60)
         end

data/lib/openhab/core.rb

@@ -3,6 +3,11 @@
 module OpenHAB
   # Contains classes and modules that wrap actual openHAB objects
   module Core
+    module Sitemaps
+      autoload :Provider, "openhab/core/sitemaps/registry"
+      autoload :Registry, "openhab/core/sitemaps/registry"
+    end
+
     # The openHAB Version. >= 4.1 is required.
     # @return [String]
     VERSION = org.openhab.core.OpenHAB.version.freeze
@@ -163,8 +168,8 @@ require_relative "core/provider"
 Dir[File.expand_path("core/**/*.rb", __dir__)].each do |f|
   # already been run by either a binstub, or the addon
   next if f.end_with?("gem.rb")
-  # metadata is autoloaded
-  next if f.include?("/metadata/")
+  # autoloaded things
+  next if f.include?("/metadata/") || f.include?("/sitemaps/")
 
   require f
 end

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

@@ -2,7 +2,7 @@
 
 require "forwardable"
 
-Dir[File.expand_path("**/*.rb", __dir__)].each do |f|
+Dir[File.expand_path("**/*.rb", __dir__)].reject { |f| f == __FILE__ }.each do |f|
   require f
 end
 

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

@@ -6,9 +6,6 @@ module OpenHAB
     # Contains the various builders for sitemap elements.
     #
     module Sitemaps
-      # @!visibility private
-      org.openhab.core.model.sitemap.sitemap.impl.SitemapImpl.alias_method :uid, :name
-
       #
       # A sitemap builder allows you to dynamically create openHAB sitemaps at runtime.
       #
@@ -33,12 +30,12 @@ module OpenHAB
       #
       # @see https://www.openhab.org/docs/ui/sitemaps.html
       # @see OpenHAB::DSL.sitemaps
-      # @see OpenHAB::Core::Sitemaps::Provider#build sitemaps.build
+      # @see OpenHAB::Core::Sitemaps::Registry#build sitemaps.build
       #
       class Builder
         # @!visibility private
-        def initialize(provider, builder_proxy, update:)
-          @provider = provider
+        def initialize(builder_proxy, update:)
+          @provider = Core::Sitemaps::Provider.current
           @builder_proxy = builder_proxy
           @update = update
         end
@@ -144,7 +141,7 @@ module OpenHAB
                        icon_color: nil,
                        visibility: nil,
                        &block)
-          unless SitemapBuilder.factory.respond_to?(:"create_#{type}")
+          unless Core::Sitemaps::Compatibility.supported_widget_type?(type)
             raise ArgumentError,
                   "#{type} is not a valid widget type"
           end
@@ -211,7 +208,7 @@ module OpenHAB
 
         # @!visibility private
         def build
-          widget = SitemapBuilder.factory.send(:"create_#{@type}")
+          widget = create_widget
           item = @item
           item = item.name if item.respond_to?(:name)
           widget.item = item if item
@@ -220,7 +217,8 @@ module OpenHAB
           raise ArgumentError, "icon and static_icon are mutually exclusive" if icon && static_icon
 
           if static_icon
-            widget.static_icon = static_icon
+            widget.static_icon = true
+            widget.icon = static_icon
           elsif icon.is_a?(String)
             widget.icon = @icon
           elsif icon.is_a?(Hash)
@@ -233,7 +231,7 @@ module OpenHAB
           add_colors(widget, :value_color, value_colors)
           add_colors(widget, :icon_color, icon_colors)
 
-          add_conditions(widget, :visibility, visibilities, :create_visibility_rule)
+          add_conditions(widget, :visibility, visibilities, :visibility)
 
           widget
         end
@@ -250,29 +248,33 @@ module OpenHAB
 
         private
 
+        def create_widget
+          Core::Sitemaps::Compatibility.create_widget(@type)
+        end
+
         def add_colors(widget, method, colors)
           # ensure that the default color is at the end, and make the conditions nil (no conditions)
           colors.delete(:default)&.tap { |default_color| colors.merge!(nil => default_color) }
 
-          add_conditions(widget, method, colors.keys, :create_color_array) do |color_array, key|
-            color_array.arg = colors[key]
+          add_conditions(widget, method, colors.keys, :color) do |rule, key|
+            rule.argument = colors[key]
           end
         end
 
         def add_icons(widget)
           icon.delete(:default)&.tap { |default_icon| icon.merge!(nil => default_icon) }
-          add_conditions(widget, :icon_rules, icon.keys, :create_icon_rule) do |icon_array, key|
-            icon_array.arg = icon[key]
+          add_conditions(widget, :icon_rules, icon.keys, :icon) do |rule, key|
+            rule.argument = icon[key]
           end
         end
 
-        def add_conditions(widget, method, conditions, container_method)
+        def add_conditions(widget, method, conditions, rule_type)
           return if conditions.empty?
 
           object = widget.send(method)
 
           conditions.each do |sub_conditions|
-            container = SitemapBuilder.factory.send(container_method)
+            container = Core::Sitemaps::Compatibility.create_rule(rule_type)
 
             add_conditions_to_container(container, sub_conditions)
             yield container, sub_conditions if block_given?
@@ -293,8 +295,11 @@ module OpenHAB
             condition = SitemapBuilder.factory.create_condition
             condition.item = match["item"]
             condition.condition = match["condition"]
-            condition.sign = match["sign"]
-            condition.state = match["state"]
+            Core::Sitemaps::Compatibility.set_condition(
+              condition,
+              sign: match["sign"],
+              state: match["state"]
+            )
             container.conditions.add(condition)
           end
         end
@@ -1165,7 +1170,7 @@ module OpenHAB
           widget = super
 
           children.each do |child|
-            widget.children.add(child.build)
+            widget.widgets.add(child.build)
           end
 
           widget
@@ -1427,7 +1432,7 @@ module OpenHAB
         class << self
           # @!visibility private
           def factory
-            org.openhab.core.model.sitemap.sitemap.SitemapFactory.eINSTANCE
+            Core::Sitemaps::Provider.factory
           end
         end
 
@@ -1453,9 +1458,10 @@ module OpenHAB
           @name = name
         end
 
-        # @!visibility private
-        def build
-          super.tap { |sitemap| sitemap.name = name }
+        private
+
+        def create_widget
+          Core::Sitemaps::Compatibility.create_sitemap(name)
         end
       end
     end

data/lib/openhab/dsl/version.rb

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

data/lib/openhab/dsl.rb

@@ -40,7 +40,6 @@ module OpenHAB
 
     module Sitemaps
       autoload :Builder, "openhab/dsl/sitemaps/builder"
-      autoload :LinkableWidgetBuilder, "openhab/dsl/sitemaps/builder"
     end
 
     module Rules
@@ -289,9 +288,9 @@ module OpenHAB
       Core::Rules::Registry.instance
     end
 
-    # @return [Core::Sitemaps::Provider]
+    # @return [Core::Sitemaps::Registry]
     def sitemaps
-      Core::Sitemaps::Provider.instance
+      Core::Sitemaps::Registry.instance
     end
 
     #

data/lib/openhab/rspec/hooks.rb

@@ -70,10 +70,11 @@ module OpenHAB
          Core::Items::Metadata::Provider,
          Core::Items::Semantics::Provider,
          Core::Rules::Provider,
+         Core::Sitemaps::Provider,
          Core::Things::Provider,
          Core::Things::Links::Provider].each do |klass|
           config.around do |example|
-            klass.new(&example)
+            klass.send(:new, &example)
           end
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.47.2
+  version: 5.47.3
 platform: ruby
 authors:
 - Brian O'Connell
@@ -172,7 +172,11 @@ files:
 - lib/openhab/core/rules/rule.rb
 - lib/openhab/core/rules/tagged_array.rb
 - lib/openhab/core/script_handling.rb
+- lib/openhab/core/sitemaps/compatibility.rb
+- lib/openhab/core/sitemaps/model.rb
 - lib/openhab/core/sitemaps/provider.rb
+- lib/openhab/core/sitemaps/registry.rb
+- lib/openhab/core/sitemaps/sitemap.rb
 - lib/openhab/core/things.rb
 - lib/openhab/core/things/abstract_description_type.rb
 - lib/openhab/core/things/channel.rb
@@ -354,7 +358,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.5
+rubygems_version: 4.0.9
 specification_version: 4
 summary: JRuby Helper Libraries for openHAB Scripting
 test_files: []