openhab-scripting 5.8.0 → 5.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00dfdfae614d0fc89c09ddfe86b16c4d0b41e94bc1c2e73889eb359ff09ada3c
-  data.tar.gz: ecafc5d2f33cf0b0015ac9e8c59449a57488e4f18316bd584e8dfe028d5ec4c7
+  metadata.gz: 6f531c0d4e77bbee531e574b759f56e458d4eacde89520b8cf9f810dd46e61d9
+  data.tar.gz: 7724b5709c56fb80f095c14930fd3077a2019111731865f1956f4b080a8039ab
 SHA512:
-  metadata.gz: eff4e5471afb074c92cd7d3fc01d9070a80db680ed79c4814dc8b88e14eb67c8f9215a77f80c6b1a9a5eb6f4e220b6ce5e38ba01f0287779821db918f81c0fef
-  data.tar.gz: f187e831d86e87fe4a2e91b311f8bdd3c4e046e9107054ff74c91cdf7644d4fa303d86d8abf3c5f80e8e8cb1762f5c436b89e3e841a86ef05af351c6f0d6abbb
+  metadata.gz: 11237012154342229a7b1a4b24a2e5e8f81833d758e81614b067c4a1187a598e5fbc45cfd300312ef0f039130a039e6df7c75f59e08e458d0bdf7761e2a85f8d
+  data.tar.gz: 3bd394f5d950d2ab5a0016a4219d7d1ac0cb9f4fbdca541d4f41c9e59406c01a1d0df242334cc95a4cf1668f546e1f0fc7aa03cd835f71384e4a3de4cace8304

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

@@ -32,9 +32,14 @@ module OpenHAB
         def inspect
           r = "#<OpenHAB::Core::Things::Channel #{uid}"
           r += " #{label.inspect}" if label
-          r += " auto_update_policy=#{auto_update_policy}" if auto_update_policy
+          r += " description=#{description.inspect}" if description
+          r += " kind=#{kind.inspect}"
+          r += " channel_type_uid=#{channel_type_uid.inspect}" if channel_type_uid
           r += " configuration=#{configuration.properties.to_h}" unless configuration.properties.empty?
           r += " properties=#{properties.to_h}" unless properties.empty?
+          r += " default_tags=#{default_tags.to_a}" unless default_tags.empty?
+          r += " auto_update_policy=#{auto_update_policy}" if auto_update_policy
+          r += " accepted_item_type=#{accepted_item_type}" if accepted_item_type
           "#{r}>"
         end
 
@@ -42,6 +47,34 @@ module OpenHAB
         def to_s
           uid.to_s
         end
+
+        # @deprecated OH3.4 this whole section is not needed in OH4+. Also see Thing#config_eql?
+        if Gem::Version.new(Core::VERSION) < Gem::Version.new("4.0.0")
+          # @!visibility private
+          module ChannelComparable
+            # @!visibility private
+            # This is only needed in OH3 because it is implemented in OH4 core
+            def ==(other)
+              return true if equal?(other)
+              return false unless other.is_a?(Channel)
+
+              %i[class
+                 uid
+                 label
+                 description
+                 kind
+                 channel_type_uid
+                 configuration
+                 properties
+                 default_tags
+                 auto_update_policy
+                 accepted_item_type].all? do |attr|
+                send(attr) == other.send(attr)
+              end
+            end
+          end
+          org.openhab.core.thing.binding.builder.ChannelBuilder.const_get(:ChannelImpl).prepend(ChannelComparable)
+        end
       end
     end
   end

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

@@ -29,7 +29,7 @@ module OpenHAB
         #
         # @return [Array] channels
         def channels
-          Thing::ChannelsArray.new(super.to_a)
+          Thing::ChannelsArray.new(self, super.to_a)
         end
 
         #

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

@@ -64,13 +64,17 @@ module OpenHAB
         # Array wrapper class to allow searching a list of channels
         # by channel id
         class ChannelsArray < Array
+          def initialize(thing, array)
+            super(array)
+            @thing = thing
+          end
+
           # Allows indexing by both integer as an array or channel id acting like a hash.
-          # @param [Integer, String] index Numeric index or string channel id to search for.
+          # @param [Integer, String, ChannelUID] index
+          #   Numeric index, string channel id, or a {ChannelUID} to search for.
           def [](index)
-            if index.respond_to?(:to_str)
-              key = index.to_str
-              return find { |channel| channel.uid.id == key }
-            end
+            return @thing.get_channel(index) if index.is_a?(ChannelUID)
+            return @thing.get_channel(index.to_str) if index.respond_to?(:to_str)
 
             super
           end
@@ -204,7 +208,9 @@ module OpenHAB
         # @return [true,false] true if all attributes are equal, false otherwise
         #
         def config_eql?(other)
-          %i[uid label channels bridge_uid location configuration].all? { |method| send(method) == other.send(method) }
+          # @deprecated OH3.4 - in OH4, channels can be included in the array and do not need to be compared separately
+          channels.to_a == other.channels.to_a &&
+            %i[uid label bridge_uid location configuration].all? { |method| send(method) == other.send(method) }
         end
 
         #

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

@@ -257,7 +257,14 @@ module OpenHAB
       # The ChannelBuilder DSL allows you to customize a channel
       class ChannelBuilder
         attr_accessor :label
-        attr_reader :uid, :config, :type
+        attr_reader :uid,
+                    :config,
+                    :type,
+                    :default_tags,
+                    :properties,
+                    :description,
+                    :auto_update_policy,
+                    :accepted_item_type
 
         #
         # Constructor for ChannelBuilder
@@ -269,10 +276,27 @@ module OpenHAB
         # @param [String] label The channel label.
         # @param [thing] thing The thing associated with this channel.
         #   This parameter is not needed for the {ThingBuilder#channel} method.
+        # @param [String] description The channel description.
         # @param [String] group The group name.
         # @param [Hash] config Channel configuration. The keys can be strings or symbols.
+        # @param [Hash] properties The channel properties.
+        # @param [String,Symbol,Semantics::Tag,Array<String,Symbol,Semantics::Tag>] default_tags
+        #   The default tags for this channel.
+        # @param [:default, :recommend, :veto, org.openhab.core.thing.type.AutoUpdatePolicy] auto_update_policy
+        #   The channel's auto update policy.
+        # @param [String] accepted_item_type The accepted item type.
         #
-        def initialize(uid, type, label = nil, thing:, group: nil, config: {})
+        def initialize(uid,
+                       type,
+                       label = nil,
+                       thing:,
+                       description: nil,
+                       group: nil,
+                       config: nil,
+                       properties: nil,
+                       default_tags: nil,
+                       auto_update_policy: nil,
+                       accepted_item_type: nil)
           @thing = thing
 
           uid = uid.to_s
@@ -292,7 +316,14 @@ module OpenHAB
           end
           @type = type
           @label = label
-          @config = config.transform_keys(&:to_s)
+          @config = config&.transform_keys(&:to_s)
+          @default_tags = Items::ItemBuilder.normalize_tags(*Array.wrap(default_tags))
+          @properties = properties&.transform_keys(&:to_s)
+          @description = description
+          @accepted_item_type = accepted_item_type
+          return unless auto_update_policy
+
+          @auto_update_policy = org.openhab.core.thing.type.AutoUpdatePolicy.value_of(auto_update_policy.to_s.upcase)
         end
 
         # @!visibility private
@@ -300,7 +331,15 @@ module OpenHAB
           org.openhab.core.thing.binding.builder.ChannelBuilder.create(uid)
              .with_kind(kind)
              .with_type(type)
-             .with_configuration(Core::Configuration.new(config))
+             .tap do |builder|
+               builder.with_label(label) if label
+               builder.with_configuration(Core::Configuration.new(config)) if config && !config.empty?
+               builder.with_default_tags(Set.new(default_tags).to_java) unless default_tags.empty?
+               builder.with_properties(properties) if properties
+               builder.with_description(description) if description
+               builder.with_auto_update_policy(auto_update_policy) if auto_update_policy
+               builder.with_accepted_item_type(accepted_item_type) if accepted_item_type
+             end
              .build
         end
 

data/lib/openhab/dsl/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.8.0
+  version: 5.9.0
 platform: ruby
 authors:
 - Brian O'Connell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-07 00:00:00.000000000 Z
+date: 2023-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler