openhab-scripting 5.33.1 → 5.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96a5a45996611268693311513fde61baca47e46134e1184ac6556b29a567689f
-  data.tar.gz: 8a70e85d3d9b892cca7b3ee9b912751a9c702ff784dc4827ecc16ef816d58c5c
+  metadata.gz: 9300c92dc3d585e27528126b0a04b3b6f54a3af5e48ebbdd967b52b6b8d3efe8
+  data.tar.gz: 4f0a4331c7cd29d49c3013cee2033536ec5095471a82bd3b6e4fe6acfbf4fa8d
 SHA512:
-  metadata.gz: 04b505a18d90437f38ed06005efa1815601a67b471da37814f8284e62aa6f92e6ac7955c726f4c1455f210c5fe0afcb350ae0ddc23722adec2906be307741ec7
-  data.tar.gz: dd080606344af5b3e9eea7310a7dad12b38fa18dbd2d028e04c46275d316c60ee0e5a44a23b474120fced82eeee655b0e429e336027a3d49a115e779e94e0c0e
+  metadata.gz: bbd50fbc7ae916736accef799f512a2213995ed839c28117ad96eb3be9ac79344df192ad7d5e131deb58b2a49fdc1124f146f711aa1c784099b5947e62465e6d
+  data.tar.gz: 9610a22c54a861856349bbaf77c7a450f7905e3be390aa9a12389d30f17e07ba708fd8516079c89dfd13e79a76e2d99630e3da43bc9bc1dcbf98b7de942d0103

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

@@ -199,7 +199,10 @@ module OpenHAB
         end
 
         # Delegate missing methods to {base_item} if possible
-        def method_missing(method, *args, &block)
+        # Command methods and predicate methods for GroupItem are performed here
+        # instead of being statically defined in items.rb
+        # because base_item is needed to determine the command/data types but is not available in the static context
+        ruby2_keywords def method_missing(method, *args, &block)
           return base_item.__send__(method, *args, &block) if base_item&.respond_to?(method) # rubocop:disable Lint/RedundantSafeNavigation nil responds to :to_a
 
           super

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

@@ -50,9 +50,7 @@ module OpenHAB
         # @return [self]
         #
         def toggle(source: nil)
-          return on!(source: source) unless state?
-
-          command!(!state, source: source)
+          command!(!on?, source: source)
         end
 
         # @!method on?

data/lib/openhab/core/items.rb

@@ -74,13 +74,17 @@ module OpenHAB
               RUBY
 
               Enumerable.class_eval <<~RUBY, __FILE__, __LINE__ + 1
-                def #{command}         # def on
-                  each(&:#{command})   #   each(&:on)
-                end                    # end
-                                       #
-                def #{command}!        # def on!
-                  each(&:#{command}!)  #   each(&:on!)
-                end                    # end
+                ruby2_keywords def #{command}(*args, &block)    # ruby2_keywords def on(*args, &block)
+                  each do |member|                              #   each do |member|
+                    member.#{command}(*args, &block)            #     member.on(*args, &block)
+                  end                                           #   end
+                end                                             # end
+                                                                #
+                ruby2_keywords def #{command}!(*args, &block)   # ruby2_keywords def on!(*args, &block)
+                  each do |member|                              #   each do |member|
+                    member.#{command}!(*args, &block)           #     member.on!(*args, &block)
+                  end                                           #   end
+                end                                             # end
               RUBY
             else
               logger.trace { "Defining #{klass}/Enumerable##{command} for #{value}" }

data/lib/openhab/core/profile_factory.rb

@@ -142,7 +142,7 @@ module OpenHAB
       end
 
       # @!visibility private
-      def register(id, block, label: nil, config_description: nil)
+      def register(id, block, label: nil, type: :state, config_description: nil)
         uid = org.openhab.core.thing.profiles.ProfileTypeUID.new("ruby", id)
         uri = java.net.URI.new("profile", uid.to_s, nil)
         if config_description && config_description.uid != uri
@@ -155,6 +155,7 @@ module OpenHAB
         @profiles[uid] = {
           thread_locals: DSL::ThreadLocal.persist,
           label: label,
+          type: type,
           config_description: config_description,
           block: block
         }
@@ -177,7 +178,11 @@ module OpenHAB
         @profiles.map do |uid, profile|
           next if profile[:label].nil?
 
-          org.openhab.core.thing.profiles.ProfileTypeBuilder.new_state(uid, "RUBY #{profile[:label]}").build
+          if profile[:type] == :trigger
+            org.openhab.core.thing.profiles.ProfileTypeBuilder.new_trigger(uid, "RUBY #{profile[:label]}").build
+          else
+            org.openhab.core.thing.profiles.ProfileTypeBuilder.new_state(uid, "RUBY #{profile[:label]}").build
+          end
         end.compact
       end
 

data/lib/openhab/core/types/date_time_type.rb

@@ -43,14 +43,22 @@ module OpenHAB
           end
         end
 
-        # @param [ZonedDateTime, nil] context
-        #   A {ZonedDateTime} used to fill in missing
-        #   fields during conversion. Not used in this class.
-        # @return [ZonedTimeTime]
-        def to_zoned_date_time(context = nil) # rubocop:disable Lint/UnusedMethodArgument
-          zoned_date_time
+        # @deprecated OH 4.2 Just call zoned_date_time(ZoneId.system_default) in OH 4.3
+        if OpenHAB::Core.version >= OpenHAB::Core::V4_3
+          def to_zoned_date_time(context = nil) # rubocop:disable Lint/UnusedMethodArgument
+            zoned_date_time(ZoneId.system_default)
+          end
+        else
+          def to_zoned_date_time(context = nil) # rubocop:disable Lint/UnusedMethodArgument
+            zoned_date_time
+          end
         end
 
+        # @!method to_zoned_date_time(context = nil)
+        # @param [ZonedDateTime, nil] context
+        #   A {ZonedDateTime} used to fill in missing fields during conversion. Not used in this class.
+        # @return [ZonedDateTime]
+
         # @!visibility private
         def to_instant(_context = nil)
           # @deprecated OH 3.4 getInstant() was added in OH 4.0
@@ -62,6 +70,7 @@ module OpenHAB
         # @!method to_instant
         # @return [Instant]
 
+        # @deprecated These methods have been deprecated in openHAB 4.3.
         # act like a Ruby Time
         def_delegator :zoned_date_time, :month_value, :month
         def_delegator :zoned_date_time, :day_of_month, :mday
@@ -69,9 +78,14 @@ module OpenHAB
         def_delegator :zoned_date_time, :minute, :min
         def_delegator :zoned_date_time, :second, :sec
         def_delegator :zoned_date_time, :nano, :nsec
-        def_delegator :zoned_date_time, :to_epoch_second, :to_i
         def_delegator :zoned_date_time, :to_time
 
+        # NOTE: to_i is supported by both Instant and ZonedDateTime in #method_missing
+
+        # @!method to_i
+        # Returns the value of time as an integer number of seconds since the Epoch
+        # @return [Integer] Number of seconds since the Epoch
+
         # @!visibility private
         alias_method :day, :mday
 
@@ -84,6 +98,9 @@ module OpenHAB
           if value.nil?
             super()
             return
+          elsif OpenHAB::Core.version >= OpenHAB::Core::V4_3 && value.respond_to?(:to_instant)
+            super(value.to_instant)
+            return
           elsif value.respond_to?(:to_zoned_date_time)
             super(value.to_zoned_date_time)
             return
@@ -110,6 +127,9 @@ module OpenHAB
         def eql?(other)
           return false unless other.instance_of?(self.class)
 
+          # @deprecated OH 4.2 Call compare_to(other).zero? in OH 4.3 to avoid the deprecated getZonedDateTime()
+          return compare_to(other).zero? if OpenHAB::Core.version >= OpenHAB::Core::V4_3
+
           zoned_date_time.compare_to(other.zoned_date_time).zero?
         end
 
@@ -126,6 +146,9 @@ module OpenHAB
         def <=>(other)
           logger.trace { "(#{self.class}) #{self} <=> #{other} (#{other.class})" }
           if other.is_a?(self.class)
+            # @deprecated OH 4.2 Call compare_to(other) in OH 4.3 to avoid the deprecated getZonedDateTime()
+            return compare_to(other) if OpenHAB::Core.version >= OpenHAB::Core::V4_3
+
             zoned_date_time <=> other.zoned_date_time
           elsif other.respond_to?(:to_time)
             to_time <=> other.to_time
@@ -147,6 +170,7 @@ module OpenHAB
         #
         def coerce(other)
           logger.trace { "Coercing #{self} as a request from #{other.class}" }
+          return [other, to_instant] if other.respond_to?(:to_instant)
           return [other, zoned_date_time] if other.respond_to?(:to_zoned_date_time)
 
           [DateTimeType.new(other), self] if other.respond_to?(:to_time)
@@ -158,7 +182,7 @@ module OpenHAB
         # @return [Float] Number of seconds since the Epoch, with nanosecond presicion
         #
         def to_f
-          zoned_date_time.to_epoch_second + (zoned_date_time.nano / 1_000_000_000)
+          to_instant.then { |instant| instant.epoch_second + (instant.nano / 1_000_000_000) }
         end
 
         #
@@ -166,6 +190,7 @@ module OpenHAB
         #
         # @return [Integer] The offset from UTC, in seconds
         #
+        # @deprecated This method has been deprecated in openHAB 4.3.
         def utc_offset
           zoned_date_time.offset.total_seconds
         end
@@ -175,6 +200,7 @@ module OpenHAB
         #
         # @return [true,false] true if utc_offset == 0, false otherwise
         #
+        # @deprecated This method has been deprecated in openHAB 4.3.
         def utc?
           utc_offset.zero?
         end
@@ -184,6 +210,7 @@ module OpenHAB
         #
         # @return [Integer] The day of week
         #
+        # @deprecated This method has been deprecated in openHAB 4.3.
         def wday
           zoned_date_time.day_of_week.value % 7
         end
@@ -200,6 +227,8 @@ module OpenHAB
 
         # @!visibility private
         def respond_to_missing?(method, _include_private = false)
+          # @deprecated OH 4.2 Remove version check when dropping OH 4.2
+          return true if OpenHAB::Core.version >= OpenHAB::Core::V4_3 && to_instant.respond_to?(method)
           return true if zoned_date_time.respond_to?(method)
           return true if ::Time.instance_methods.include?(method.to_sym)
 
@@ -211,6 +240,11 @@ module OpenHAB
         # object representing the same instant
         #
         def method_missing(method, *args, &block)
+          # @deprecated OH 4.2 Remove version check when dropping OH 4.2
+          if OpenHAB::Core.version >= OpenHAB::Core::V4_3 && to_instant.respond_to?(method)
+            return to_instant.send(method, *args, &block)
+          end
+
           return zoned_date_time.send(method, *args, &block) if zoned_date_time.respond_to?(method)
           return to_time.send(method, *args, &block) if ::Time.instance_methods.include?(method.to_sym)
 

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

@@ -98,8 +98,6 @@ module OpenHAB
           result
         end
 
-        include DSL
-
         private
 
         def item(*args, **kwargs, &block)
@@ -159,10 +157,11 @@ module OpenHAB
 
             # make sure to add the item to the registry before linking it
             channel_uids = builder.channels.to_set do |(channel, config)|
-              # fill in partial channel names from group's thing id
+              channel = channel.to_s
+              # fill in partial channel names from item's or group's thing id
               if !channel.include?(":") &&
-                 (group = builder.groups.find { |g| g.is_a?(GroupItemBuilder) && g.thing })
-                thing = group.thing
+                 (thing = builder.thing ||
+                  thing = builder.groups.find { |g| g.is_a?(GroupItemBuilder) && g.thing }&.thing)
                 channel = "#{thing}:#{channel}"
               end
 
@@ -243,18 +242,12 @@ module OpenHAB
         # The icon to be associated with the item
         # @return [Symbol, String, nil]
         attr_accessor :icon
-        # Groups to which this item should be added
-        # @return [Array<String, GroupItem>]
-        attr_reader :groups
-        # Tags to apply to this item
-        # @return [Array<String, Semantics::Tag>]
-        attr_reader :tags
         # Autoupdate setting
         # @return [true, false, nil]
         attr_accessor :autoupdate
-        # {Core::Things::ChannelUID Channel} to link the item to
-        # @return [String, Core::Things::ChannelUID, nil]
-        attr_accessor :channels
+        # @return [String, Core::Things::Thing, Core::Things::ThingUID, nil]
+        #   {Core::Things::ThingUID Thing} from which to resolve relative channel ids
+        attr_accessor :thing
         # @return [Core::Items::Metadata::NamespaceHash]
         attr_reader :metadata
         # Initial state
@@ -264,6 +257,19 @@ module OpenHAB
         # @return [Core::Types::State]
         attr_reader :state
 
+        attr_writer :channels, :groups, :tags
+
+        # @!attribute [rw] channels
+        # @return [Array<String, Symbol, Core::Things::ChannelUID, Core::Things::Channel, Array>]
+        #   {Core::Things::ChannelUID Channel} to link the item to
+
+        # @!attribute [rw] groups
+        # @return [Array<String, GroupItem>] Groups to which this item should be added
+
+        # @!attribute [rw] tags
+        # @return [Array<String>] Tags to apply to this item
+
+        # This comment needs to exist otherwise YARD thinks the above attribute should apply to the metaclass
         class << self
           # @!visibility private
           def item_factory
@@ -352,6 +358,7 @@ module OpenHAB
                        autoupdate: nil,
                        thing: nil,
                        channel: nil,
+                       channels: nil,
                        expire: nil,
                        alexa: nil,
                        ga: nil, # rubocop:disable Naming/MethodParameterName
@@ -408,12 +415,13 @@ module OpenHAB
           self.state = state
 
           self.group(*group)
-          self.group(*groups)
+          self.groups(*groups)
 
           self.tag(*tag)
-          self.tag(*tags)
+          self.tags(*tags)
 
-          self.channel(*channel) if channel
+          self.channel(*channel)
+          self.channels(*channels)
         end
 
         #
@@ -428,20 +436,45 @@ module OpenHAB
         #
         # Tag item
         #
-        # @param tags [String, Symbol, Semantics::Tag]
-        # @return [void]
+        # @return [Array<String>]
+        #
+        # @overload tag(tag)
+        #   @param tag [String, Symbol, Semantics::Tag]
+        #   @return [Array<String>]
+        #
+        # @overload tags
+        #   @return [Array<String>]
+        #
+        # @overload tags(*tags)
+        #   @param tags [String, Symbol, Semantics::Tag]
+        #   @return [Array<String>]
         #
         def tag(*tags)
-          @tags += self.class.normalize_tags(*tags)
+          return @tags if tags.empty?
+
+          @tags.concat(self.class.normalize_tags(*tags))
         end
+        alias_method :tags, :tag
 
         #
         # Add this item to a group
         #
-        # @param groups [String, GroupItemBuilder, GroupItem]
-        # @return [void]
+        # @return [Array<String, GroupItemBulder, GroupItem>]
+        #
+        # @overload group(group)
+        #   @param group [String, GroupItemBuilder, GroupItem]
+        #   @return [Array<String, GroupItemBulder, GroupItem>]
+        #
+        # @overload groups
+        #   @return [Array<String, GroupItemBulder, GroupItem>]
+        #
+        # @overload groups(*groups)
+        #   @param groups [String, GroupItemBuilder, GroupItem]
+        #   @return [Array<String, GroupItemBulder, GroupItem>]
         #
         def group(*groups)
+          return @groups if groups.empty?
+
           unless groups.all? do |group|
                    group.is_a?(String) || group.is_a?(Core::Items::GroupItem) || group.is_a?(GroupItemBuilder)
                  end
@@ -450,6 +483,7 @@ module OpenHAB
 
           @groups.concat(groups)
         end
+        alias_method :groups, :group
 
         #
         # @!method alexa(value, config = nil)
@@ -494,10 +528,23 @@ module OpenHAB
         #
         # Add a channel link to this item.
         #
-        # @param channel [String, Symbol, Core::Things::ChannelUID, Core::Things::Channel]
-        #   Channel to link the item to. When thing is set, this can be a relative channel name.
-        # @param config [Hash] Additional configuration, such as profile
-        # @return [void]
+        # @return [Array<String, Symbol, Core::Things::ChannelUID, Core::Things::Channel, Array>]
+        #
+        # @overload channel(channel, config = {})
+        #   @param channel [String, Symbol, Core::Things::ChannelUID, Core::Things::Channel]
+        #     Channel to link the item to. When {thing} is set, this can be a relative channel name.
+        #   @param config [Hash] Additional configuration, such as profile
+        #   @return [Array<String, Symbol, Core::Things::ChannelUID, Core::Things::Channel, Array>]
+        #
+        # @overload channels
+        #   @return [Array<String, Symbol, Core::Things::ChannelUID, Core::Things::Channel, Array>]
+        #
+        # @overload channels(*channels)
+        #   @param channels [String, Symbol, Core::Things::ChannelUID, Core::Things::Channel, Array]
+        #     Channels to link the item to. When {thing} is set, these can be relative channel names.
+        #     Each array element can also be a two element array with the first element being the
+        #     channel, and the second element being a config hash.
+        #   @return [Array<String, Symbol, Core::Things::ChannelUID, Core::Things::Channel, Array>]
         #
         # @example
         #   items.build do
@@ -511,11 +558,46 @@ module OpenHAB
         #     switch_item Bedroom_Light, thing: "mqtt:topic:bedroom-light", channel: :power
         #   end
         #
-        def channel(channel, config = {})
-          channel = channel.to_s
-          channel = "#{@thing}:#{channel}" if @thing && !channel.include?(":")
-          @channels << [channel, config]
+        # @example Multiple channels
+        #   items.build do
+        #     dimmer_item DemoDimmer, channels: ["hue:0210:bridge:1:color", "knx:device:bridge:generic:controlDimmer"]
+        #   end
+        #
+        # @example Multiple channels in a block
+        #   items.build do
+        #     dimmer_item DemoDimmer do
+        #       channel "hue:0210:bridge:1:color"
+        #       channel "knx:device:bridge:generic:controlDimmer"
+        #     end
+        #   end
+        #
+        # @example Multiple channels with config
+        #   items.build do
+        #     dimmer_item DemoDimmer, channels: [["hue:0210:bridge:1:color", profile: "system:follow"],
+        #                                        "knx:device:bridge:generic:controlDimmer"]
+        #   end
+        #
+        def channel(*channels)
+          return @channels if channels.empty?
+
+          channels = [channels] if channels.length == 2 && channels[1].is_a?(Hash)
+
+          channels.each do |channel|
+            orig_channel = channel
+            channel = channel.first if channel.is_a?(Array)
+            next if channel.is_a?(String) ||
+                    channel.is_a?(Symbol) ||
+                    channel.is_a?(Core::Things::ChannelUID) ||
+                    channel.is_a?(Core::Things::Channel)
+
+            raise ArgumentError, "channel #{orig_channel.inspect} must be a `String`, `Symbol`, `ChannelUID`, or " \
+                                 "`Channel`, or a two element array with the first element those types, and the " \
+                                 "second element a Hash"
+          end
+
+          @channels.concat(channels)
         end
+        alias_method :channels, :channel
 
         #
         # @!method expire(duration, command: nil, state: nil, ignore_state_updates: nil, ignore_commands: nil)

data/lib/openhab/dsl/version.rb

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

data/lib/openhab/dsl.rb

@@ -106,6 +106,7 @@ module OpenHAB
     #
     # @param [String, Symbol] id The id for the profile.
     # @param [String, nil] label The label for the profile. When nil, the profile will not be visible in the UI.
+    # @param [:state, :trigger] type The type of profile.
     # @param [org.openhab.core.config.core.ConfigDescription, nil] config_description
     #   The configuration description for the profile so that it can be configured in the UI.
     # @yield [event, command: nil, state: nil, trigger: nil, time_series: nil, callback:, link:, item:, channel_uid:, configuration:, context:]
@@ -191,13 +192,13 @@ module OpenHAB
     #     (configuration["min"]..configuration["max"]).cover?(state)
     #   end
     #
-    def profile(id, label: nil, config_description: nil, &block)
+    def profile(id, label: nil, type: :state, config_description: nil, &block)
       raise ArgumentError, "Block is required" unless block
 
       id = id.to_s
 
       ThreadLocal.thread_local(openhab_rule_type: "profile", openhab_rule_uid: id) do
-        Core::ProfileFactory.instance.register(id, block, label: label, config_description: config_description)
+        Core::ProfileFactory.instance.register(id, block, label: label, type: type, config_description: config_description)
       end
     end
 

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.33.1
+  version: 5.34.0
 platform: ruby
-original_platform: ''
 authors:
 - Brian O'Connell
 - Cody Cutrer
 - Jimmy Tanagra
 bindir: bin
 cert_chain: []
-date: 2024-12-16 00:00:00.000000000 Z
+date: 2025-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -488,7 +487,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.0
+rubygems_version: 3.6.2
 specification_version: 4
 summary: JRuby Helper Libraries for openHAB Scripting
 test_files: []