openhab-scripting 4.18.0 → 4.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 775d56e757a494c9b854b963f2c15393c2521597cd83e5d36452a41033508339
-  data.tar.gz: 9dfd101285ad28b310156016e524a370352b192147f3fbf87d130135b5a48b9d
+  metadata.gz: 7a1c3efdcd1a6b1b37802084ae9905afca8ea737cf870e1d51c0df7fabafd7f2
+  data.tar.gz: 3bf072ccd50f0271a2633d174e95e8fd4de112f669ba40e0c5f325be6b30946f
 SHA512:
-  metadata.gz: 773d6bc398e5b24a9aecfb265c6025c75c4863ddf80932e875e9cb60eea4e6fdbf8036803d17c25dfd429127fc5164f1264b4bc48f7fce2cee1cd3fde837372a
-  data.tar.gz: 2e19d2dd05b40da151bd85a253e022209c93819acd20872bd1a30f02d9ad96cdb931c81499f7c222c2c487f962cb56f9db851dee6e3c038a671bac4d44f5481d
+  metadata.gz: 9f3d963c6d2bc0b148dc122ec3483e301a04ee70c3f3cdf9b04a98b289f4dd823f1192344767aed9712d2745f01be7a51e62043d76a652dbdafd63ff7a98d065
+  data.tar.gz: d6a98e072d3462a1d74fd9d968c8a3eeeb66f7df747aee054640b6d2f9ca76358dc7e10bc93a2106b60bc508778f83ef649dfd2e3153f6d6c2e43590cfeeed53

data/lib/openhab/dsl/dsl.rb

@@ -19,6 +19,7 @@ require 'openhab/dsl/things'
 require 'openhab/dsl/between'
 require 'openhab/dsl/gems'
 require 'openhab/dsl/persistence'
+require 'openhab/dsl/uid'
 require 'openhab/dsl/units'
 require 'openhab/dsl/states'
 

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

@@ -15,16 +15,19 @@ module OpenHAB
         #
         # Creates a channel trigger
         #
-        # @param [Array] channels array to create triggers for on form of 'binding_id:type_id:thing_id#channel_id'
+        # @param [String, Channel, ChannelUID, Array<String, Channel, 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
-        # @param [thing] thing to create trigger for if not specified with the channel
-        # @param [String] triggered specific triggering condition to match for trigger
-        #
-        #
-        def channel(*channels, thing: nil, triggered: nil, attach: nil)
-          channels.flatten.each do |channel|
-            channel = [thing, channel].join(':') if thing
-            logger.trace("Creating channel trigger for channel(#{channel}), thing(#{thing}), trigger(#{triggered})")
+        # @param [String, Thing, ThingUID, Array<String, Thing, ThingUID>] thing
+        #   thing(s) to create trigger for if not specified with the channel
+        # @param [String, Array<String>] triggered specific triggering condition(s) to match for trigger
+        #
+        def channel(*channels, thing: nil, triggered: nil, attach: nil) # rubocop:disable Metrics/AbcSize
+          channels.flatten.product([thing].flatten).each do |(channel, t)|
+            channel = channel.uid if channel.is_a?(org.openhab.core.thing.Channel)
+            t = t.uid if t.is_a?(Thing)
+            channel = [t, channel].compact.join(':')
+            logger.trace("Creating channel trigger for channel(#{channel}), thing(#{t}), trigger(#{triggered})")
             [triggered].flatten.each do |trigger|
               create_channel_trigger(channel, trigger, attach)
             end
@@ -36,14 +39,13 @@ module OpenHAB
         #
         # Create a trigger for a channel
         #
-        # @param [Channel] channel to look for triggers
-        # @param [Trigger] trigger specific channel trigger to match
+        # @param [String] channel to look for triggers
+        # @param [String] trigger specific channel trigger to match
         #
         #
         def create_channel_trigger(channel, trigger, attach)
           config = { 'channelUID' => channel }
           config['event'] = trigger.to_s unless trigger.nil?
-          config['channelUID'] = channel
           logger.trace("Creating Change Trigger for #{config}")
           append_trigger(Trigger::CHANNEL_EVENT, config, attach: attach)
         end

data/lib/openhab/dsl/things.rb

@@ -14,7 +14,7 @@ module OpenHAB
     # Support for OpenHAB Things
     #
     module Things
-      java_import Java::OrgOpenhabCoreThing::ThingStatus
+      java_import org.openhab.core.thing.ThingStatus
       include OpenHAB::Log
 
       #

data/lib/openhab/dsl/types/type.rb

@@ -41,6 +41,20 @@ module OpenHAB
           equals(other)
         end
 
+        #
+        # Case equality
+        #
+        # @return [Boolean] if the values are of the same Type
+        #                   or item state of the same type
+        #
+        def ===(other)
+          logger.trace("(#{self.class}) #{self} === #{other} (#{other.class})")
+          other = other.state if other.respond_to?(:state)
+          return false unless instance_of?(other.class)
+
+          eql?(other)
+        end
+
         #
         # Check equality, including type conversion
         #

data/lib/openhab/dsl/uid.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module DSL
+    java_import org.openhab.core.common.AbstractUID
+    java_import org.openhab.core.thing.ThingTypeUID
+
+    # Adds methods to core OpenHAB AbstractUID to make it more natural in Ruby
+    class AbstractUID
+      # implicit conversion to string
+      alias to_str to_s
+      # inspect result is just the string representation
+      alias inspect to_s
+
+      # compares if equal to `other`, including string conversion
+      # @return [true, false]
+      def ==(other)
+        return true if equals(other)
+
+        to_s == other
+      end
+    end
+
+    # Adds methods to core OpenHAB ThingUID to make it more natural in Ruby
+    class ThingUID
+      # Returns the id of the binding this thing belongs to
+      # @return [String]
+      def binding_id
+        get_segment(0)
+      end
+    end
+
+    # Adds methods to core OpenHAB ThingTypeUID to make it more natural in Ruby
+    class ThingTypeUID
+      # Returns the id of the binding this thing type belongs to
+      # @return [String]
+      def binding_id
+        get_segment(0)
+      end
+    end
+
+    # have to remove == from all descendant classes so that they'll inherit
+    # the new implementation
+    [org.openhab.core.items.MetadataKey,
+     org.openhab.core.thing.UID,
+     org.openhab.core.thing.ChannelUID,
+     org.openhab.core.thing.ChannelGroupUID,
+     org.openhab.core.thing.ThingUID,
+     org.openhab.core.thing.ThingTypeUID,
+     org.openhab.core.thing.type.ChannelTypeUID,
+     org.openhab.core.thing.type.ChannelGroupTypeUID].each do |klass|
+      klass.remove_method(:==)
+    end
+  end
+end

data/lib/openhab/version.rb

@@ -5,5 +5,5 @@
 #
 module OpenHAB
   # @return [String] Version of OpenHAB helper libraries
-  VERSION = '4.18.0'
+  VERSION = '4.19.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.18.0
+  version: 4.19.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-30 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,7 @@ files:
 - lib/openhab/dsl/types/types.rb
 - lib/openhab/dsl/types/un_def_type.rb
 - lib/openhab/dsl/types/up_down_type.rb
+- lib/openhab/dsl/uid.rb
 - lib/openhab/dsl/units.rb
 - lib/openhab/log/configuration.rb
 - lib/openhab/log/logger.rb