openhab-scripting 5.47.4 → 5.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5278818a9473735ac2ae2c0b85d09df5f5c5b9bc196915cde58fda8ff36fb604
-  data.tar.gz: d7daf509023b161958993d172cfbf77c5db589735c9b5340243d01cb26674e90
+  metadata.gz: ebd253fc1f0f462a281d219b0a102bb6f929e4fc9ae1555c60b8611e2e212487
+  data.tar.gz: fc0e411cf1a935d87999ceaaf3750d9ef8d6deee6ebd642c751cd2d1d5085054
 SHA512:
-  metadata.gz: 2b173a5be4a3c72e93c12f98de780a9e8d6211182a706f0a66003ff776d9db97d4f91a04282bcb9db6b6a224de76e08b4d33bb54ce9aef4d1ae020339237c737
-  data.tar.gz: 8b1a93d407a4a69faeceb40be50ef09654b7c95c8ceec213f6bac104041e33e72689e73b6a5a2dad20c19367131ec6aa4276d9b62c8e76510c2c42d560aca670
+  metadata.gz: 922a3b755a5258e853e4b3285d67f975d14acc03760adb9f3b66503068053dfa78377a83d60c366f43bac36784df03ff646794905a57883b9b1052b131486f2e
+  data.tar.gz: b59b65d06610d7acaa9724b84993ade4464d000d0efe3490b6caf1a4aaaac4082540dfc9a8f5238ab44da85118af8b4e424ce8abb91fd69670070c4c54bd38fd

data/lib/openhab/core/actions/notification.rb

@@ -15,7 +15,8 @@ module OpenHAB
           # openHAB Cloud Notification Action}.
           #
           # @param msg [String] The message to send.
-          # @param email [String, nil] The email address to send to. If `nil`, the message will be broadcasted.
+          # @param email [String, <String>, nil] The email address(es) to send to. If `nil`, the message will be
+          #   broadcast.
           # @param icon [String, Symbol, nil] The icon name
           #   (as described in {https://www.openhab.org/docs/configuration/items.html#icons Items}).
           # @param tag [String, Symbol, nil] a name to group the type or severity of the notification.
@@ -83,7 +84,21 @@ module OpenHAB
             end
 
             args = []
-            if email
+            if email.is_a?(Enumerable)
+              email.each do |e|
+                send(msg,
+                     email: e,
+                     icon:,
+                     tag:,
+                     severity:,
+                     id:,
+                     title:,
+                     on_click:,
+                     attachment:,
+                     buttons:)
+              end
+              return
+            elsif email
               args.push(:send_notification, email)
             else
               args.push(:send_broadcast_notification)
@@ -116,7 +131,7 @@ module OpenHAB
           # - Notifications matching the `id` will be hidden, and
           # - Notifications matching the `tag` will be hidden, independently from the given tag.
           #
-          # @param email [String, nil] The email address to hide notifications for.
+          # @param email [String, <String>, nil] The email address(es) to hide notifications for.
           #   If nil, hide broadcast notifications.
           # @param id [String, nil] hide notifications associated with the given reference ID.
           # @param tag [String, nil] hide notifications associated with the given tag.
@@ -130,7 +145,12 @@ module OpenHAB
             raise ArgumentError, "Either id or tag must be provided." unless id || tag
 
             args = []
-            if email
+            if email.is_a?(Enumerable)
+              email.each do |e|
+                hide(email: e, id:, tag:)
+              end
+              return
+            elsif email
               args.push(email)
               notification = :notification
             else

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module Core
+    module Sitemaps
+      # @interface
+      java_import org.openhab.core.sitemap.LinkableWidget
+
+      # @since openHAB 5.2.0
+      module LinkableWidget
+        # @!parse
+        #   include Widget
+
+        # @!attribute [r] widgets
+        # @return [<Widget>]
+
+        private
+
+        def inspect_details
+          children_count = widgets.size
+          " (#{children_count} child#{"ren" if children_count != 1})" if children_count.positive?
+        end
+      end
+    end
+  end
+end

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

@@ -37,7 +37,9 @@ module OpenHAB
 
         # @deprecated OH 5.2: remove the non-registry branch when dropping OH 5.1
         if registry
+          require_relative "linkable_widget"
           require_relative "sitemap"
+          require_relative "widget"
 
           include org.openhab.core.sitemap.registry.SitemapProvider
         else

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

@@ -5,6 +5,32 @@ module OpenHAB
     module Sitemaps
       # @interface
       java_import org.openhab.core.sitemap.Sitemap
+
+      # @since openHAB 5.2.0
+      module Sitemap
+        # @!attribute [r] name
+        # @return [String]
+
+        # @!attribute [r] label
+        # @return [String, nil]
+
+        # @!attribute [r] icon
+        # @return [String, nil]
+
+        # @!attribute [r] widgets
+        # @return [<Widget>]
+
+        # @return [String]
+        def to_s
+          r = "#<OpenHAB::Core::Sitemaps::Sitemap #{name}"
+          r += " #{label.inspect}" if label
+          r += " icon=#{icon.inspect}" if icon
+          children_count = widgets.size
+          r += " (#{children_count} child#{"ren" if children_count != 1})" if children_count.positive?
+          "#{r}>"
+        end
+        alias_method :inspect, :to_s
+      end
     end
   end
 end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module Core
+    module Sitemaps
+      # @interface
+      java_import org.openhab.core.sitemap.Widget
+
+      # @since openHAB 5.2.0
+      module Widget
+        # @!attribute [r] item
+        # @return [String, nil]
+
+        # @!attribute [r] label
+        # @return [String, nil]
+
+        # @!attribute [r] icon
+        # @return [String, nil]
+
+        # @!attribute [r] widget_type
+        # @return [String]
+
+        # @return [String]
+        def to_s
+          r = "#<OpenHAB::Core::Sitemaps::#{widget_type}"
+          r += " #{label.inspect}" if label
+          r += " item=#{item}" if item
+          r += inspect_details.to_s
+          "#{r}>"
+        end
+        alias_method :inspect, :to_s
+
+        private
+
+        def inspect_details; end
+      end
+    end
+  end
+end

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

@@ -897,6 +897,7 @@ module OpenHAB
         # @param [String, Core::Things::Channel, Core::Things::ChannelUID] channels
         #   channels to create triggers for in form of 'binding_id:type_id:thing_id#channel_id'
         #   or 'channel_id' if thing is provided.
+        #   A string that contains `*` and `?` wildcards are supported since openHAB 5.2.
         # @param [String, Core::Things::Thing, Core::Things::ThingUID] thing
         #   Thing(s) to create trigger for if not specified with the channel.
         # @param [String, Array<String>] triggered

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

@@ -1170,7 +1170,10 @@ module OpenHAB
           widget = super
 
           children.each do |child|
-            widget.widgets.add(child.build)
+            child = child.build
+            # @deprecated OH 5.2: Remove conditional when dropping OH 5.1
+            child.parent = widget if child.respond_to?(:parent=)
+            widget.widgets.add(child)
           end
 
           widget

data/lib/openhab/dsl/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.47.4
+  version: 5.48.0
 platform: ruby
 authors:
 - Brian O'Connell
@@ -173,10 +173,12 @@ files:
 - lib/openhab/core/rules/tagged_array.rb
 - lib/openhab/core/script_handling.rb
 - lib/openhab/core/sitemaps/compatibility.rb
+- lib/openhab/core/sitemaps/linkable_widget.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/sitemaps/widget.rb
 - lib/openhab/core/things.rb
 - lib/openhab/core/things/abstract_description_type.rb
 - lib/openhab/core/things/channel.rb
@@ -358,7 +360,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.9
+rubygems_version: 4.0.11
 specification_version: 4
 summary: JRuby Helper Libraries for openHAB Scripting
 test_files: []