openhab-scripting 5.15.0 → 5.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11409728d3f0ecb384da9099355fea4728020aa1de1d494d3085dddea518e16c
-  data.tar.gz: d4daa321f0b779b0c9f47ccc405cdafd3a71f55666e173cb29315a7f948b2029
+  metadata.gz: 66607fb79de6b8b718ddd8cc5cc10662809001e67915074b44360ba9f6408d31
+  data.tar.gz: e21976073a7323b4e8bfe05a09e8959472d950ad28df26534371c857fe64699f
 SHA512:
-  metadata.gz: b8eee772f02cf086af4db419ecaa5752b21393302533f6fea628a6e9bc50d7e986b1815e03c71de7acba63a13088f46d3e73e96d416a1869a7e2b9fe627764ea
-  data.tar.gz: 4ebdb8fb5d81c4429188163e4ced5aabf2ee8a33797b540a32e0e81024a67ac7143728b7679181ca26a4856f8e7e6ed291b5f4bb9427c1df2a744eb6fcb75dd1
+  metadata.gz: 815f05142db0071b36cd45b9f9e81c1c033cf759823150066f2c65ec4f5eb61fdf9b1bf4dbc0e8125adf3535eb9e83b71fbbf401c2e6f1a716838fe6f37cdd29
+  data.tar.gz: 4fe2bd7469d2d4489bd41ee9c62c6b4e7d53e6350e095c895b936813582d89e088b772bb0a44fde82aaecbfe5ff1c3fac320505001e24d0ac4519646abac5889

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

@@ -607,22 +607,31 @@ module Enumerable
   # @!group Filtering Methods
   #
 
-  # Returns a new array of items that are a semantics Location (optionally of the given type)
+  #
+  # Returns a new array of items that are a semantics Location (optionally of one of the given types)
   # @return [Array<Item>]
-  def locations(type = nil)
+  #
+  # @example Get all rooms
+  #   items.locations(Semantics::Room)
+  #
+  # @example Get all bedrooms and bathrooms
+  #   items.locations(Semantics::Bedroom, Semantics::Bathroom)
+  #
+  def locations(*types)
     begin
-      raise ArgumentError if type && !(type < Semantics::Location)
+      raise ArgumentError unless types.all? { |type| type < Semantics::Location }
     rescue ArgumentError, TypeError
       raise ArgumentError, "type must be a subclass of Location"
     end
 
     result = select(&:location?)
-    result.select! { |i| i.location_type <= type } if type
+    result.select! { |i| types.any? { |type| i.location_type <= type } } unless types.empty?
 
     result
   end
 
-  # Returns a new array of items that are a semantics equipment (optionally of the given type)
+  #
+  # Returns a new array of items that are a semantics equipment (optionally of one of the given types)
   #
   # @note As {Semantics::Equipment equipments} are usually
   #   {GroupItem GroupItems}, this method therefore returns an array of
@@ -633,16 +642,20 @@ module Enumerable
   # @return [Array<Item>]
   #
   # @example Get all TVs in a room
-  #   lGreatRoom.equipments(Semantics::Screen)
-  def equipments(type = nil)
+  #   lGreatRoom.equipments(Semantics::Television)
+  #
+  # @example Get all TVs and Speakers in a room
+  #   lGreatRoom.equipments(Semantics::Television, Semantics::Speaker)
+  #
+  def equipments(*types)
     begin
-      raise ArgumentError if type && !(type < Semantics::Equipment)
+      raise ArgumentError unless types.all? { |type| type < Semantics::Equipment }
     rescue ArgumentError, TypeError
       raise ArgumentError, "type must be a subclass of Equipment"
     end
 
     result = select(&:equipment?)
-    result.select! { |i| i.equipment_type <= type } if type
+    result.select! { |i| types.any? { |type| i.equipment_type <= type } } unless types.empty?
 
     result
   end
@@ -663,8 +676,8 @@ module Enumerable
 
     begin
       raise ArgumentError unless point_or_property_types.all? do |tag|
-                                   (tag < Semantics::Point ||
-                                    tag < Semantics::Property)
+                                   tag < Semantics::Point ||
+                                   tag < Semantics::Property
                                  end
     rescue ArgumentError, TypeError
       raise ArgumentError, "point_or_property_types must all be a subclass of Point or Property"

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

@@ -137,7 +137,7 @@ module OpenHAB
         #
 
         ThingStatus.constants.each do |thingstatus|
-          define_method("#{thingstatus.to_s.downcase}?") { status == ThingStatus.value_of(thingstatus) }
+          define_method(:"#{thingstatus.to_s.downcase}?") { status == ThingStatus.value_of(thingstatus) }
         end
 
         #

data/lib/openhab/core_ext/java/list.rb

@@ -311,7 +311,7 @@ module Java::JavaUtil::List # rubocop:disable Style/ClassAndModuleChildren
   end
 
   def rotate!(count = 1)
-    count = count % length
+    count %= length
     push(*shift(count))
     self
   end

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

@@ -125,7 +125,7 @@ module OpenHAB
             parameter = org.openhab.core.config.core.ConfigDescriptionParameterBuilder.create(name.to_s, type)
 
             p.each do |key, value|
-              parameter.send("with_#{key}", value) unless value.nil?
+              parameter.send(:"with_#{key}", value) unless value.nil?
             end
             parameter.build
           end

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

@@ -20,15 +20,15 @@ module OpenHAB
           #   in this module than instance variable belong to the module not the calling class
           define_method(name) do |*args, &block|
             if args.empty? && block.nil? == true
-              instance_variable_get("@#{name}")
+              instance_variable_get(:"@#{name}")
             else
               logger.trace("Property '#{name}' called with args(#{args}) and block(#{block})")
               if args.length == 1
-                instance_variable_set("@#{name}", args.first)
+                instance_variable_set(:"@#{name}", args.first)
               elsif args.length > 1
-                instance_variable_set("@#{name}", args)
+                instance_variable_set(:"@#{name}", args)
               elsif block
-                instance_variable_set("@#{name}", block)
+                instance_variable_set(:"@#{name}", block)
               end
             end
           end
@@ -47,7 +47,7 @@ module OpenHAB
           define_method(name) do |*args, &block|
             array_name ||= name
             if args.empty? && block.nil? == true
-              instance_variable_get("@#{array_name}")
+              instance_variable_get(:"@#{array_name}")
             else
               logger.trace("Property '#{name}' called with args(#{args}) and block(#{block})")
               if args.length == 1
@@ -59,14 +59,14 @@ module OpenHAB
               end
               yield insert if block_given?
               insert = wrapper.new(insert) if wrapper
-              instance_variable_set("@#{array_name}", (instance_variable_get("@#{array_name}") || []) << insert)
+              instance_variable_set(:"@#{array_name}", (instance_variable_get(:"@#{array_name}") || []) << insert)
             end
           end
 
           return unless array_name
 
           define_method(array_name) do
-            instance_variable_get("@#{array_name}")
+            instance_variable_get(:"@#{array_name}")
           end
         end
       end

data/lib/openhab/dsl/rules/triggers/cron/cron.rb

@@ -174,10 +174,10 @@ module OpenHAB
           def self.duration_to_map(duration)
             if duration.to_millis_part.zero? && duration.to_nanos_part.zero? && duration.to_days.zero?
               %i[second minute hour].each do |unit|
-                to_unit_part = duration.public_send("to_#{unit}s_part")
+                to_unit_part = duration.public_send(:"to_#{unit}s_part")
                 next unless to_unit_part.positive?
 
-                to_unit = duration.public_send("to_#{unit}s")
+                to_unit = duration.public_send(:"to_#{unit}s")
                 break unless to_unit_part == to_unit
 
                 return EXPRESSION_MAP[unit].merge(unit => "*/#{to_unit}")

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

@@ -116,7 +116,7 @@ module OpenHAB
                        icon_color: nil,
                        visibility: nil,
                        &block)
-          unless SitemapBuilder.factory.respond_to?("create_#{type}")
+          unless SitemapBuilder.factory.respond_to?(:"create_#{type}")
             raise ArgumentError,
                   "#{type} is not a valid widget type"
           end
@@ -144,12 +144,14 @@ module OpenHAB
           if @builder_proxy
             old_obj = @builder_proxy.__getobj__
             @builder_proxy.__setobj__(self)
-            yield @builder_proxy
+            begin
+              yield @builder_proxy
+            ensure
+              @builder_proxy.__setobj__(old_obj)
+            end
           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
@@ -181,7 +183,7 @@ module OpenHAB
 
         # @!visibility private
         def build
-          widget = SitemapBuilder.factory.send("create_#{@type}")
+          widget = SitemapBuilder.factory.send(:"create_#{@type}")
           item = @item
           item = item.name if item.respond_to?(:name)
           widget.item = item if item
@@ -279,9 +281,41 @@ module OpenHAB
       class SwitchBuilder < WidgetBuilder
         # Mappings from command to label
         #
-        # Keys can be any {Core::Types::Command command}, values are strings.
-        # If an array is given, the same value is used for both command and label.
+        # If a hash is given, the keys are the commands and the values are the labels.
+        # The keys can be any {Core::Types::Command command}, string or symbol.
+        # They will be converted to strings.
+        #
+        # If an array is given:
+        # - Scalar elements define the command, and the label is the same as the command.
+        # - Array elements contain the command, label, and optional third element for the icon.
+        # - Hash elements contain the command, label, and optional icon defined by the corresponding keys.
+        #
+        # @since openHAB 4.1 added support for icons
+        #
+        # @example A Hash to specify different command and label
+        #   switch mappings: { off: "Off", cool: "Cool", heat: "Heat" }
+        #
+        # @example A simple array with the same command and label
+        #   switch mappings: %w[off cool heat]
+        #
+        # @example An array of arrays containing the command, label, and icon
+        #   switch mappings: [
+        #     %w[off Off f7:power],
+        #     %w[cool Cool f7:snow],
+        #     %w[heat Heat f7:flame],
+        #     %w[auto Auto] # no icon
+        #   ]
+        #
+        # @example An array of hashes for the command, label, and icon
+        #   switch mappings: [
+        #     {command: "off", label: "Off", icon: "f7:power"},
+        #     {command: "cool", label: "Cool", icon: "f7:snow"},
+        #     {command: "heat", label: "Heat", icon: "f7:flame"},
+        #     {command: "auto", label: "Auto"} # no icon
+        #   ]
+        #
         # @return [Hash, Array, nil]
+        # @see LinkableWidgetBuilder#switch
         # @see https://www.openhab.org/docs/ui/sitemaps.html#mappings
         attr_accessor :mappings
 
@@ -298,10 +332,13 @@ module OpenHAB
         # @!visibility private
         def build
           widget = super
-          mappings&.each do |cmd, label|
+          mappings&.each do |cmd, label, icon|
             mapping = SitemapBuilder.factory.create_mapping
+            cmd, label, icon = cmd.values_at(:command, :label, :icon) if cmd.is_a?(Hash)
             mapping.cmd = cmd.to_s
             mapping.label = label&.to_s || cmd.to_s
+            # @deprecated OH 4.1 the if check is not needed in OH4.1+
+            mapping.icon = icon if icon
             widget.mappings.add(mapping)
           end
           widget
@@ -663,16 +700,18 @@ 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

data/lib/openhab/dsl/version.rb

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

data/lib/openhab/log.rb

@@ -210,7 +210,7 @@ module OpenHAB
       #   @return [true,false]
       #
       def def_level_predicate(level)
-        define_method("#{level}?") { @slf4j_logger.send("is_#{level}_enabled") }
+        define_method(:"#{level}?") { @slf4j_logger.send(:"is_#{level}_enabled") }
       end
     end
 
@@ -318,7 +318,7 @@ module OpenHAB
       raise ArgumentError, "Unknown Severity #{severity}" unless LEVELS.include? severity
 
       # Dynamically check enablement of underlying logger
-      return unless send("#{severity}?")
+      return unless send(:"#{severity}?")
 
       # Process block if no message provided
       msg = yield if msg.nil? && block_given?

data/lib/openhab/rspec/helpers.rb

@@ -449,10 +449,13 @@ module OpenHAB
 
       def parse_emacs_modeline(line)
         line[EMACS_MODELINE_REGEXP, 1]
-            &.split(";")
-            &.map(&:strip)
-            &.map { |l| l.split(":", 2).map(&:strip).tap { |a| a[1] ||= nil } }
-            &.to_h
+          &.split(";")
+          &.to_h do |l|
+            l.strip
+             .split(":", 2)
+             .map(&:strip)
+             .tap { |a| a[1] ||= nil }
+          end
       end
 
       def ruby_file?(script)

data/lib/openhab/yard/coderay.rb

@@ -7,7 +7,7 @@ module OpenHAB
     module CodeRay
       module HtmlHelper
         ::CodeRay::Scanners.list.each do |scanner|
-          define_method("html_syntax_highlight_#{scanner}") do |source|
+          define_method(:"html_syntax_highlight_#{scanner}") do |source|
             ::CodeRay.scan(source, scanner).html
           end
         end

data/lib/openhab/yard.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "byebug"
-
 Dir[File.expand_path("yard/**/*.rb", __dir__)].sort.each do |f|
   require f
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.15.0
+  version: 5.16.0
 platform: ruby
 authors:
 - Brian O'Connell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-06 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,20 +96,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: faraday-retry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
@@ -124,48 +110,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: guard-rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: guard-shell
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-- !ruby/object:Gem::Dependency
-  name: guard-yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -180,34 +124,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.20'
-- !ruby/object:Gem::Dependency
-  name: irb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: persistent_httparty
   requirement: !ruby/object:Gem::Requirement
@@ -264,48 +180,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.11'
-- !ruby/object:Gem::Dependency
-  name: rubocop-inst
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement