openhab-scripting 4.14.1 → 4.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e8b2919900c21200e8768fc3c940d0ef58dfba0aa8a48ed1b1864e242f9755c
-  data.tar.gz: b51e656ba68e02be1ae3dd7c0d0de0bfdf015de4173702129d23c94e68efe83c
+  metadata.gz: f765fc75455c9aace6d355e897477c727dcdc7e826bb3b16824979c2cf882f56
+  data.tar.gz: cfb0262989931a22e637e1e2f625ca3f5256da37587d8400b10f68ece4b6c358
 SHA512:
-  metadata.gz: 8506cc8c0ec9ee580525320021c4f9b7525940ecce0ecb402b8366bbebb7df8e2b869ac6661e14e1115047ff4fcabe46ce6d3be2d2870438914822cfa9d6ac15
-  data.tar.gz: 267f062e3e87c1b193b4edb80bf2022b6d9748b2aa3398074fc85a844e9e14679564f908d73367e6ec0bce9c1c44fba78b237b678573221223001c59d24a5258
+  metadata.gz: 99b0f1896dd66a599449dd96b061f38cc6ad92694bd9502bf14b5b6767330d8eebd714ea41536bb49f730a6fdb9c48e64a04b77c7cb9d54e72d61d617336c2d9
+  data.tar.gz: ff13507c8f80c3f7dbae3089d8ef322e0c0fbaccf835cdb80ea58ea4e595ac8e92b2e440cf4a2c8c2bf9c9401f9da7f98219857ed88ead80adbe853f3b2f2b76

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/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

@@ -83,11 +83,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 +100,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/dsl/types/type.rb

@@ -27,7 +27,7 @@ module OpenHAB
         #
         def coerce(other)
           logger.trace("Coercing #{self} (#{self.class}) as a request from #{other.class}")
-          return [other.as(self.class), self] if other.is_a?(Type)
+          return [other.as(self.class), self] if other.is_a?(Type) && other.respond_to?(:as)
         end
 
         #

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.14.1
+  version: 4.16.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-20 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,6 +103,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