openhab-scripting 4.16.0 → 4.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f765fc75455c9aace6d355e897477c727dcdc7e826bb3b16824979c2cf882f56
-  data.tar.gz: cfb0262989931a22e637e1e2f625ca3f5256da37587d8400b10f68ece4b6c358
+  metadata.gz: 96e1f3f4c2dd1c8239dcc6d72ac704fd06037f79367213210bd6854963449df0
+  data.tar.gz: 75199e81a2b830e125056280c54703aae2db59a7a63aa290efc03f1bc17fcbbc
 SHA512:
-  metadata.gz: 99b0f1896dd66a599449dd96b061f38cc6ad92694bd9502bf14b5b6767330d8eebd714ea41536bb49f730a6fdb9c48e64a04b77c7cb9d54e72d61d617336c2d9
-  data.tar.gz: ff13507c8f80c3f7dbae3089d8ef322e0c0fbaccf835cdb80ea58ea4e595ac8e92b2e440cf4a2c8c2bf9c9401f9da7f98219857ed88ead80adbe853f3b2f2b76
+  metadata.gz: 78c8cfe716265aaecb8f96ec3470fb177ff3fd80f0f94611515482254970669d6ac43a0a62033b7e16e887a49a9ca2a56b56b54632dfddd96b0c2919017963bc
+  data.tar.gz: e422f430aa68218e79b4f7b278fa613ea930361207da72ccfe467ff6597dd902b585e5ecb9e3a014eb20f10dd99132b294faeb380dd50768ccf001efcb6c8949

data/lib/openhab/dsl/channel.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module OpenHAB
+  module DSL
+    java_import org.openhab.core.thing.Channel
+    java_import org.openhab.core.thing.ChannelUID
+
+    # Adds methods to core OpenHAB Channel to make it more natural in Ruby
+    class Channel
+      extend Forwardable
+
+      delegate %i[thing item items] => :uid
+    end
+
+    # Adds methods to core OpenHAB ChannelUID to make it more natural in Ruby
+    class ChannelUID
+      # Return the thing this channel is associated with.
+      #
+      # @return [Thing] The thing associated with this channel or nil
+      def thing
+        things[thing_uid]
+      end
+
+      # Return the item if this channel is linked with an item. If a channel is linked to more than one item,
+      # this method only returns the first item.
+      #
+      # @return [GenericItem] The item associated with this channel or nil
+      def item
+        items.first
+      end
+
+      # Returns all of the channel's linked items.
+      #
+      # @return [Array<GenericItem>] An array of things or an empty array
+      def items
+        registry = OpenHAB::Core::OSGI.service('org.openhab.core.thing.link.ItemChannelLinkRegistry')
+        registry.get_linked_items(self).to_a
+      end
+    end
+  end
+end

data/lib/openhab/dsl/dsl.rb

@@ -12,12 +12,14 @@ require 'openhab/dsl/monkey_patch/actions/actions'
 require 'openhab/dsl/rules/rule'
 require 'openhab/dsl/rules/terse'
 require 'openhab/dsl/actions'
+require 'openhab/dsl/channel'
 require 'openhab/dsl/timers'
 require 'openhab/dsl/group'
 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/items/switch_item.rb

@@ -20,6 +20,14 @@ module OpenHAB
           on?
         end
 
+        # Convert boolean commands to ON/OFF
+        # @!visibility private
+        def format_type(command)
+          return Types::OnOffType.from(command) if [true, false].include?(command)
+
+          super
+        end
+
         #
         # Send a command to invert the state of the switch
         #

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

@@ -33,20 +33,56 @@ module OpenHAB
         def changed(*items, to: nil, from: nil, for: nil, attach: nil)
           separate_groups(items).map do |item|
             logger.trace("Creating changed trigger for entity(#{item}), to(#{to}), from(#{from})")
+
             # for is a reserved word in ruby, so use local_variable_get :for
-            if (wait_duration = binding.local_variable_get(:for))
-              changed_wait(item, to: to, from: from, duration: wait_duration, attach: attach)
-            else
-              # Place in array and flatten to support multiple to elements or single or nil
-              [to].flatten.map do |to_state|
-                [from].flatten.map { |from_state| create_changed_trigger(item, from_state, to_state, attach) }
-              end
+            wait_duration = binding.local_variable_get(:for)
+
+            each_state(from, to) do |from_state, to_state|
+              changed_or_wait(item, from_state, to_state, wait_duration, attach)
             end
           end.flatten
         end
 
         private
 
+        #
+        # Run block for each state combination
+        #
+        # @param [Item State, Array<Item State>] from state to restrict trigger to
+        # @param [Item State, Array<Item State>] to state to restrict trigger to
+        #
+        # @yieldparam [Item State] from_state from state
+        # @yieldparam [Item State] to_state to state
+        #
+        # @return [Array] array of block return values
+        #
+        def each_state(from, to)
+          [to].flatten.each_with_object([]) do |to_state, agg|
+            [from].flatten.each do |from_state|
+              agg.push(yield(from_state, to_state))
+            end
+          end
+        end
+
+        #
+        # Create regular or delayed trigger based on duration
+        #
+        # @param [Object] item item to create trigger for
+        # @param [Item State] from state to restrict trigger to
+        # @param [Item State] to state to restrict trigger to
+        # @param [OpenHAB::Core::Duration, nil] duration ruration to delay trigger until to state is met
+        # @param attach attachment
+        #
+        # @return [Trigger] OpenHAB triggers
+        #
+        def changed_or_wait(item, from, to, duration, attach)
+          if duration
+            changed_wait(item, from: from, to: to, duration: duration, attach: attach)
+          else
+            create_changed_trigger(item, from, to, attach)
+          end
+        end
+
         #
         # Create a TriggerDelay for for an item or group that is changed for a specific duration
         #

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,13 +14,28 @@ module OpenHAB
     # Support for OpenHAB Things
     #
     module Things
-      java_import Java::OrgOpenhabCoreThing::ThingStatus
+      java_import org.openhab.core.thing.ThingStatus
       include OpenHAB::Log
 
       #
       # Ruby Delegator for Thing
       #
       class Thing < SimpleDelegator
+        # Array wrapper class to allow searching a list of channels
+        # by channel id
+        class ChannelsArray < Array
+          # 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.
+          def [](index)
+            if index.respond_to?(:to_str)
+              key = index.to_str
+              return find { |channel| channel.uid.id == key }
+            end
+
+            super
+          end
+        end
+
         include OpenHAB::DSL::Actions
         include OpenHAB::Log
 
@@ -45,6 +60,12 @@ module OpenHAB
           define_method("#{thingstatus.to_s.downcase}?") { status == ThingStatus.value_of(thingstatus) }
         end
 
+        # Returns the list of channels associated with this Thing
+        # @return [Array] channels
+        def channels
+          ChannelsArray.new(super.to_a)
+        end
+
         private
 
         java_import org.openhab.core.automation.annotation.RuleAction

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.16.0'
+  VERSION = '4.19.1'
 end

data/lib/openhab.rb

@@ -20,23 +20,18 @@ module OpenHAB
   #
   #
   # Number of extensions and includes requires more lines
-  # rubocop: disable Metrics/MethodLength
   def self.extended(base)
     OpenHAB::Core.wait_till_openhab_ready
     base.extend Log
     base.extend OpenHAB::Core::ScriptHandling
     base.extend OpenHAB::Core::EntityLookup
     base.extend OpenHAB::DSL
-    base.extend OpenHAB::DSL::Between
 
     base.send :include, OpenHAB::Core::ScriptHandlingCallbacks
-    base.send :include, OpenHAB::DSL::Items
-    base.send :include, OpenHAB::DSL::Types
     logger.info "OpenHAB JRuby Scripting Library Version #{OpenHAB::VERSION} Loaded"
 
     OpenHAB::Core.add_rubylib_to_load_path
   end
-  # rubocop: enable Metrics/MethodLength
 end
 
 # Extend caller with OpenHAB methods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.16.0
+  version: 4.19.1
 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
@@ -54,6 +54,7 @@ files:
 - lib/openhab/core/thread_local.rb
 - lib/openhab/dsl/actions.rb
 - lib/openhab/dsl/between.rb
+- lib/openhab/dsl/channel.rb
 - lib/openhab/dsl/dsl.rb
 - lib/openhab/dsl/gems.rb
 - lib/openhab/dsl/group.rb
@@ -135,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