openhab-scripting 5.14.0 → 5.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29d5852ff9f0b047b5e70f69d8ece471770b59a86f4989a3120a7c6027fec1b9
-  data.tar.gz: 39c590e109e6c5349fd6b4b5eee9bf2e5a3058f4b8cf875b6b69f02bb89996df
+  metadata.gz: a2150062e6b4a58f888b09bb106f39cb57c7e67749b85dfc13978a8437702e33
+  data.tar.gz: 22cfc6729962a702bae8ecc83d26280e4967834a8235bd7ee9ac8f3596796f50
 SHA512:
-  metadata.gz: 41707220dfe28a3a7395b4d0b7c8538e8150448934d97f63d5b96a533f859f681b47d68bb83688cfa316737b34622f90c7da670915a454427a9c4c705d9cfa9e
-  data.tar.gz: 9c8ae71904b136e9aa2e11027e0de57101721b7096352994a2d636595f69b32a07e0992bf476a0200e0e6de5330a6a70d6e6f363f2e1f4c687ff1b033f013710
+  metadata.gz: bfab71ec2435493bafdf61bf447a34a644e366494a9ccdf174a98d9035b1cc8fd9828ca174c5288d2c41a5798cb6ea2bad8bd78f492cb5564f0f3cbf6fcf7023
+  data.tar.gz: 36ff08d089054720805effeb0fa16557b767a87b8238c45d7c3c2e5d5fc12ac0dffae5b0f2f7226435e68c5ddfb03a252a8ad12e680f422695040869865716cb

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

@@ -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/dsl/sitemaps/builder.rb

@@ -12,8 +12,9 @@ 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
 
@@ -23,8 +24,7 @@ module OpenHAB
         # @return [SitemapBuilder]
         # @!visibility public
         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 = SitemapBuilder.new(name, @builder_proxy, label: label, icon: icon, &block)
           sitemap = sitemap.build
           if @update && @provider.get(sitemap.uid)
             @provider.update(sitemap)
@@ -106,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,
@@ -113,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
@@ -133,6 +136,22 @@ 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)
+            begin
+              yield @builder_proxy
+            ensure
+              @builder_proxy.__setobj__(old_obj)
+            end
+          else
+            instance_eval_with_dummy_items(&block)
+          end
         end
 
         # Adds one or more new rules for setting the label color
@@ -272,8 +291,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
@@ -313,8 +332,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
@@ -349,8 +368,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
@@ -388,8 +407,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
@@ -457,14 +476,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
@@ -514,8 +535,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
@@ -539,8 +560,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
@@ -565,8 +586,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
@@ -601,8 +622,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
@@ -644,24 +665,26 @@ module OpenHAB
         # @example
         #   # This creates a buttongrid to emulate a TV remote control
         #   sitemaps.build do
-        #     buttongrid item: LivingRoom_TV_RCButton, buttons: [
-        #       [1, 1, "BACK", "Back", "f7:return"],
-        #       [1, 2, "HOME", "Menu", "material:apps"],
-        #       [1, 3, "YELLOW", "Search", "f7:search"],
-        #       [2, 2, "UP", "Up", "f7:arrowtriangle_up"],
-        #       [4, 2, "DOWN", "Down", "f7:arrowtriangle_down"],
-        #       [3, 1, "LEFT", "Left", "f7:arrowtriangle_left"],
-        #       [3, 3, "RIGHT", "Right", "f7:arrowtriangle_right"],
-        #       [3, 2, "ENTER", "Enter", "material:adjust"]
-        #     ]
+        #     sitemap "remote", label: "TV Remote Control" do
+        #       buttongrid item: LivingRoom_TV_RCButton, buttons: [
+        #         [1, 1, "BACK", "Back", "f7:return"],
+        #         [1, 2, "HOME", "Menu", "material:apps"],
+        #         [1, 3, "YELLOW", "Search", "f7:search"],
+        #         [2, 2, "UP", "Up", "f7:arrowtriangle_up"],
+        #         [4, 2, "DOWN", "Down", "f7:arrowtriangle_down"],
+        #         [3, 1, "LEFT", "Left", "f7:arrowtriangle_left"],
+        #         [3, 3, "RIGHT", "Right", "f7:arrowtriangle_right"],
+        #         [3, 2, "ENTER", "Enter", "material:adjust"]
+        #       ]
+        #     end
         #   end
         #
         # @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
 
         #
@@ -998,9 +1021,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
@@ -1011,9 +1035,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
@@ -1062,8 +1086,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
@@ -1111,8 +1135,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.14.0"
+    VERSION = "5.15.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.14.0
+  version: 5.15.1
 platform: ruby
 authors:
 - Brian O'Connell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-05 00:00:00.000000000 Z
+date: 2024-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler