openhab-scripting 4.14.2 → 4.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a67cb8047adba1af368a416f5a40d624ec84657f62ad420c1388e8f9cd04d9a7
-  data.tar.gz: bc6455b6a27d5efc447fd004a9f6503ead46ae40480d93aaa3a22288288cbb0a
+  metadata.gz: 15ce3ee9beba70f7ec3bb9f22b7c805a3c73dfb08e8b13f8ca7eb9cf8625f367
+  data.tar.gz: 26afc00545927a29657b00ef76bcce40f3d6b831d01362d4a5e9d187c8a6c4b8
 SHA512:
-  metadata.gz: 78c076b90ba8a174019ac814172f377aa49c0e21339e35040220da6df66ebff1ad4edde36202c9d65ffd4d8e65e08ab73fc3802589685f7f40a84199699adc59
-  data.tar.gz: 8903933c828cfcd21f8c41d3524529e2e0cf96b5f4d307af8591dc36379774bba16c827ae5e5cd0258c953bffc2ec356c536467855b108e4f9f0a4de9fc54ce7
+  metadata.gz: e8db2e2ae436fb49c7de5de26c1570de4b32f279b43b26c5e5e445460c3b496feb9bbeb0a90acab7954de8b664b22d8051f32f4bd8d97fc0ae04e916cbbb9661
+  data.tar.gz: f43eaebacfb2bae1c84c9aa5b275d6256dfd10bffae4aa8722e84d6c83adca275a057080b98acb4875c001bb15c405ade84692008b25aef1d5df20ca87b3666a

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,6 +12,7 @@ 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'

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

@@ -131,6 +131,25 @@ module OpenHAB
           group_names.map { |name| Groups.groups[name] }
         end
 
+        # Return the item's thing if this item is linked with a thing. If an item is linked to more than one thing,
+        # this method only returns the first thing.
+        #
+        # @return [Thing] The thing associated with this item or nil
+        def thing
+          all_linked_things.first
+        end
+        alias linked_thing thing
+
+        # Returns all of the item's linked things.
+        #
+        # @return [Array] An array of things or an empty array
+        def things
+          registry = OpenHAB::Core::OSGI.service('org.openhab.core.thing.link.ItemChannelLinkRegistry')
+          channels = registry.get_bound_channels(name).to_a
+          channels.map(&:thing_uid).uniq.map { |tuid| Object.things[tuid] }
+        end
+        alias all_linked_things things
+
         #
         # Check equality without type conversion
         #

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

@@ -87,7 +87,7 @@ module OpenHAB
         # @return [Queue] <description>
         #
         def create_queue(inputs)
-          case check_guards(event: inputs&.dig('event'))
+          case check_guards(event: extract_event(inputs))
           when true
             @run_queue.dup.grep_v(RuleConfig::Otherwise)
           when false
@@ -95,13 +95,30 @@ module OpenHAB
           end
         end
 
+        #
+        # Extract the event object from inputs
+        # and merge other inputs keys/values into the event
+        #
+        # @param [Map] inputs rule inputs
+        #
+        # @return [Object] event object
+        #
+        def extract_event(inputs)
+          event = inputs&.dig('event')
+          unless event
+            event = Struct.new(:event, :attachment, :command).new
+            event.command = inputs&.dig('command')
+          end
+          add_attachment(event, inputs)
+        end
+
         #
         # Get the trigger_id for the trigger that caused the rule creation
         #
         # @return [Hash] Input hash potentially containing trigger id
         #
         def trigger_id(inputs)
-          inputs&.keys&.grep(/\.event$/)&.first&.chomp('.event')
+          inputs&.dig('module')
         end
 
         #
@@ -128,10 +145,6 @@ module OpenHAB
           attachment = @attachments[trigger_id(inputs)]
           return event unless attachment
 
-          # Some events, like those from cron triggers don't have an event
-          # so an event is created
-          event ||= Struct.new(:event).new
-
           event.attachment = attachment
           event
         end
@@ -301,11 +314,9 @@ module OpenHAB
         # @param [Map] inputs OpenHAB map object describing rule trigge
         #
         #
-        # rubocop:disable Metrics/MethodLength
         # No logical way to break this method up
         def process_queue(run_queue, mod, inputs)
-          event = inputs&.dig('event')
-          event = add_attachment(event, inputs)
+          event = extract_event(inputs)
 
           while (task = run_queue.shift)
             if task.is_a? RuleConfig::Delay
@@ -317,7 +328,6 @@ module OpenHAB
         rescue StandardError => e
           print_backtrace(e)
         end
-        # rubocop:enable Metrics/MethodLength
 
         #
         # Dispatch execution block tasks to different methods

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

@@ -38,7 +38,6 @@ module OpenHAB
         config.guard = Guard::Guard.new(only_if: config.only_if, not_if: config.not_if)
         logger.trace { config.inspect }
         process_rule_config(config)
-        config
       rescue StandardError => e
         re_raise_with_backtrace(e)
       end
@@ -89,6 +88,7 @@ module OpenHAB
         Rules.script_rules << rule
         add_rule(rule)
         rule.execute(nil, { 'event' => Struct.new(:attachment).new(config.start_attachment) }) if config.on_start?
+        rule
       end
 
       #

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

@@ -8,6 +8,7 @@ require 'openhab/dsl/rules/triggers/changed'
 require 'openhab/dsl/rules/triggers/channel'
 require 'openhab/dsl/rules/triggers/command'
 require 'openhab/dsl/rules/triggers/updated'
+require 'openhab/dsl/rules/triggers/generic'
 require 'openhab/dsl/rules/guard'
 require 'openhab/core/entity_lookup'
 require 'openhab/dsl/between'

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/generic.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'openhab/log/logger'
+
+module OpenHAB
+  module DSL
+    module Rules
+      #
+      # Module holds rule triggers
+      #
+      module Triggers
+        include OpenHAB::Log
+
+        #
+        # Create a generic trigger given the trigger type uid and a configuration hash
+        #
+        # @param [Type] Trigger type UID
+        # @param [Configuration] A hash containing the trigger configuration entries
+        #
+        # @return [Trigger] Trigger object
+        #
+        def trigger(type, attach: nil, **configuration)
+          logger.trace("Creating a generic trigger for type(#{type}) with configuration(#{configuration})")
+          append_trigger(type, configuration, attach: attach)
+        end
+      end
+    end
+  end
+end

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

@@ -48,6 +48,7 @@ module OpenHAB
         #
         def append_trigger(type, config, attach: nil)
           logger.trace("Creating trigger of type #{type} for #{config}")
+          config.transform_keys!(&:to_s)
           trigger = Trigger.trigger(type: type, config: config)
           @attachments[trigger.id] = attach if attach
           @triggers << trigger

data/lib/openhab/dsl/things.rb

@@ -21,6 +21,21 @@ module OpenHAB
       # 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
@@ -83,11 +104,11 @@ module OpenHAB
         include LazyArray
         include Singleton
 
-        # Gets a specific thing by name in the format binding_id:type_id:thing_id
-        # @return Thing specified by name or nil if name does not exist in thing registry
+        # Gets a specific thing by name in the format binding_id:type_id:thing_id or via the ThingUID
+        # @return Thing specified by name/UID or nil if name/UID does not exist in thing registry
         def [](uid)
-          thing_uid = org.openhab.core.thing.ThingUID.new(*uid.split(':'))
-          thing = $things.get(thing_uid) # rubocop: disable Style/GlobalVars
+          uid = generate_thing_uid(uid) unless uid.is_a?(org.openhab.core.thing.ThingUID)
+          thing = $things.get(uid) # rubocop: disable Style/GlobalVars
           return unless thing
 
           logger.trace("Retrieved Thing(#{thing}) from registry for uid: #{uid}")
@@ -100,6 +121,15 @@ module OpenHAB
         def to_a
           $things.getAll.map { |thing| Thing.new(thing) } # rubocop: disable Style/GlobalVars
         end
+
+        private
+
+        # Returns a ThingUID given a string like object
+        #
+        # @return ThingUID generated by given name
+        def generate_thing_uid(uid)
+          org.openhab.core.thing.ThingUID.new(*uid.split(':'))
+        end
       end
 
       #

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

@@ -30,11 +30,7 @@ module OpenHAB
         #
         # @return [QuantityType] This quantity converted to another unit
         #
-        def |(other)
-          other = org.openhab.core.types.util.UnitUtils.parse_unit(other) if other.is_a?(String)
-
-          to_unit(other)
-        end
+        alias | to_unit
 
         #
         # Comparison

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.14.2
+  version: 4.17.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2021-11-30 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
@@ -103,6 +104,7 @@ files:
 - lib/openhab/dsl/rules/triggers/channel.rb
 - lib/openhab/dsl/rules/triggers/command.rb
 - lib/openhab/dsl/rules/triggers/cron.rb
+- lib/openhab/dsl/rules/triggers/generic.rb
 - lib/openhab/dsl/rules/triggers/trigger.rb
 - lib/openhab/dsl/rules/triggers/updated.rb
 - lib/openhab/dsl/states.rb