openhab-scripting 4.9.0 → 4.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18381f7d16d590838748802e7535c611279c6b251fc5f782f9f11247f856074b
-  data.tar.gz: 1f339a40040d41445020eb2a460269eba1088554034a064c1a335e2e85f17be4
+  metadata.gz: 14f2ced679ac7bcaa331235fa8e86156b7c25d106628047f36d8bbd8c1ee2e0d
+  data.tar.gz: 164856fab952fec915c2e562b1ef7da5e545a560efb2001e286360d6b558da14
 SHA512:
-  metadata.gz: 3611a93e20e13b0c5a63354e8c1082466f279e7a9b83b5c352a2b357e09f45411035c6bb1baa79575f1c7e9480ae66a9f651a635dba3130b791dcdf9eb3c4f32
-  data.tar.gz: 69f57f2931d50f868742682fa8d400348dc93670dd8ba6f6172477bbc02d9e297203d6466030c52d6055cae740b1fa8f05e8889faf7bef655d650105587ccfc5
+  metadata.gz: 4d79581b46aa3606f63e79a7cc3a2ece846506f90c244a554df236bde8feb9f46067de014bbbff7639436716ec95b040949f632b60ecd86fc7580cc387039fe5
+  data.tar.gz: 2c3f012ee50964c35c6996253fb5001b1253c4cf155f5d677174ba16ff765e8f4982a90bd9907876883d37702d0b2b8ff6c76c37d362f05df4c21c82218456f5

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

@@ -5,6 +5,8 @@ require 'set'
 require 'openhab/core/thread_local'
 require 'openhab/log/logger'
 
+require_relative 'item_event'
+
 module OpenHAB
   module DSL
     #
@@ -29,6 +31,8 @@ module OpenHAB
         # @param [Config] config Rule configuration
         #
         # Constructor sets a number of variables, no further decomposition necessary
+        # rubocop:disable Metrics/MethodLength
+        # Metrics disabled because only setters are called or defaults set.
         def initialize(config:)
           super()
           set_name(config.name)
@@ -41,7 +45,9 @@ module OpenHAB
           @between = between || OpenHAB::DSL::TimeOfDay::ALL_DAY
           # Convert between to correct range or nil if not set
           @trigger_delays = config.trigger_delays
+          @attachments = config.attachments
         end
+        # rubocop:enable Metrics/MethodLength
 
         #
         # Execute the rule
@@ -51,7 +57,7 @@ module OpenHAB
         #
         #
         def execute(mod = nil, inputs = nil)
-          logger.trace { "Execute called with mod (#{mod&.to_string}) and inputs (#{inputs&.pretty_inspect}" }
+          logger.trace { "Execute called with mod (#{mod&.to_string}) and inputs (#{inputs&.pretty_inspect})" }
           logger.trace { "Event details #{inputs['event'].pretty_inspect}" } if inputs&.key?('event')
           if trigger_delay inputs
             trigger_delay = trigger_delay(inputs)
@@ -88,6 +94,15 @@ module OpenHAB
           end
         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')
+        end
+
         #
         # Returns trigger delay from inputs if it exists
         #
@@ -100,7 +115,24 @@ module OpenHAB
           # ["72698819-83cb-498a-8e61-5aab8b812623.event", "oldState", "module", \
           #  "72698819-83cb-498a-8e61-5aab8b812623.oldState", "event", "newState",\
           #  "72698819-83cb-498a-8e61-5aab8b812623.newState"]
-          @trigger_delays[inputs&.keys&.grep(/\.event$/)&.first&.chomp('.event')]
+          @trigger_delays[trigger_id(inputs)]
+        end
+
+        # If an attachment exists for the trigger for this event add it to the event object
+        # @param [Object] Event
+        # @param [Hash] Inputs into event
+        # @return [Object] Event with attachment added
+        #
+        def add_attachment(event, inputs)
+          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
 
         #
@@ -268,8 +300,11 @@ 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)
 
           while (task = run_queue.shift)
             if task.is_a? RuleConfig::Delay
@@ -281,6 +316,7 @@ 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/item_event.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module DSL
+    module Rules
+      #
+      # Extends OpenHAB events
+      #
+      module Events
+        java_import org.openhab.core.events.AbstractEvent
+
+        # Add attachments to ItemEvent
+        class AbstractEvent
+          attr_accessor :attachment
+        end
+      end
+    end
+  end
+end

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

@@ -87,7 +87,7 @@ module OpenHAB
         rule = AutomationRule.new(config: config)
         Rules.script_rules << rule
         add_rule(rule)
-        rule.execute if config.on_start?
+        rule.execute(nil, { 'event' => Struct.new(:attachment).new(config.start_attachment) }) if config.on_start?
       end
 
       #

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

@@ -37,6 +37,9 @@ module OpenHAB
         # @return [Array] Of trigger delays
         attr_reader :trigger_delays
 
+        # @return [Hash] Hash of trigger UIDs to attachments
+        attr_reader :attachments
+
         # @return [Array] Of trigger guards
         attr_accessor :guard
 
@@ -82,6 +85,7 @@ module OpenHAB
         def initialize(rule_name, caller_binding)
           @triggers = []
           @trigger_delays = {}
+          @attachments = {}
           @caller = caller_binding.eval 'self'
           enabled(true)
           on_start(false)
@@ -96,8 +100,8 @@ module OpenHAB
         #
         # rubocop: disable Style/OptionalBooleanParameter
         # Disabled cop due to use in a DSL
-        def on_start(run_on_start = true)
-          @on_start = run_on_start
+        def on_start(run_on_start = true, attach: nil)
+          @on_start = Struct.new(:enabled, :attach).new(run_on_start, attach)
         end
         # rubocop: enable Style/OptionalBooleanParameter
 
@@ -107,7 +111,16 @@ module OpenHAB
         # @return [Boolean] True if rule should run on start, false otherwise.
         #
         def on_start?
-          @on_start
+          @on_start.enabled
+        end
+
+        #
+        # Get the optional start attachment
+        #
+        # @return [Object] optional user provided attachment to the on_start method
+        #
+        def start_attachment
+          @on_start.attach
         end
 
         #
@@ -144,7 +157,8 @@ module OpenHAB
             "Run blocks: (#{run}) " \
             "on_start: (#{on_start?}) " \
             "Trigger Waits: #{trigger_delays} " \
-            "Trigger UIDs: #{triggers.map(&:id).join(', ')}"
+            "Trigger UIDs: #{triggers.map(&:id).join(', ')}" \
+            "Attachments: #{attachments} "
         end
       end
     end

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

@@ -30,16 +30,16 @@ module OpenHAB
         #
         # @return [Trigger] OpenHAB trigger
         #
-        def changed(*items, to: nil, from: nil, for: nil)
+        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)
+              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) }
+                [from].flatten.map { |from_state| create_changed_trigger(item, from_state, to_state, attach) }
               end
             end
           end.flatten
@@ -57,8 +57,8 @@ module OpenHAB
         #
         # @return [Trigger] OpenHAB trigger
         #
-        def changed_wait(item, duration:, to: nil, from: nil)
-          trigger = create_changed_trigger(item, nil, nil)
+        def changed_wait(item, duration:, to: nil, from: nil, attach: nil)
+          trigger = create_changed_trigger(item, nil, nil, attach)
           logger.trace("Creating Changed Wait Change Trigger for #{item}")
           @trigger_delays[trigger.id] = TriggerDelay.new(to: to, from: from, duration: duration)
           trigger
@@ -72,14 +72,14 @@ module OpenHAB
         # @param [String] to state restrict trigger to
         #
         #
-        def create_changed_trigger(item, from, to)
+        def create_changed_trigger(item, from, to, attach)
           trigger, config = case item
                             when OpenHAB::DSL::Items::GroupItem::GroupMembers
                               create_group_changed_trigger(item, from, to)
                             when Thing then create_thing_changed_trigger(item, from, to)
                             else create_item_changed_trigger(item, from, to)
                             end
-          append_trigger(trigger, config)
+          append_trigger(trigger, config, attach: attach)
         end
 
         #

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

@@ -21,12 +21,12 @@ module OpenHAB
         # @param [String] triggered specific triggering condition to match for trigger
         #
         #
-        def channel(*channels, thing: nil, triggered: nil)
+        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})")
             [triggered].flatten.each do |trigger|
-              create_channel_trigger(channel, trigger)
+              create_channel_trigger(channel, trigger, attach)
             end
           end
         end
@@ -40,12 +40,12 @@ module OpenHAB
         # @param [Trigger] trigger specific channel trigger to match
         #
         #
-        def create_channel_trigger(channel, trigger)
+        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}")
-          @triggers << Trigger.trigger(type: Trigger::CHANNEL_EVENT, config: config)
+          append_trigger(Trigger::CHANNEL_EVENT, config, attach: attach)
         end
       end
     end

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

@@ -21,14 +21,14 @@ module OpenHAB
         # @param [Array] commands commands to match for trigger
         #
         #
-        def received_command(*items, command: nil, commands: nil)
+        def received_command(*items, command: nil, commands: nil, attach: nil)
           separate_groups(items).map do |item|
             logger.trace("Creating received command trigger for item(#{item})"\
                          "command(#{command}) commands(#{commands})")
 
             # Combine command and commands, doing union so only a single nil will be in the combined array.
             combined_commands = combine_commands(command, commands)
-            create_received_trigger(combined_commands, item)
+            create_received_trigger(combined_commands, item, attach)
           end.flatten
         end
 
@@ -41,7 +41,7 @@ module OpenHAB
         # @param [Object] item to create trigger for
         #
         #
-        def create_received_trigger(commands, item)
+        def create_received_trigger(commands, item, attach)
           commands.map do |command|
             if item.is_a? OpenHAB::DSL::Items::GroupItem::GroupMembers
               config, trigger = create_group_command_trigger(item)
@@ -49,7 +49,7 @@ module OpenHAB
               config, trigger = create_item_command_trigger(item)
             end
             config['command'] = command.to_s unless command.nil?
-            append_trigger(trigger, config)
+            append_trigger(trigger, config, attach: attach)
           end
         end
 

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

@@ -46,9 +46,10 @@ module OpenHAB
         #
         # @return [Trigger] OpenHAB trigger
         #
-        def append_trigger(type, config)
+        def append_trigger(type, config, attach: nil)
           logger.trace("Creating trigger of type #{type} for #{config}")
           trigger = Trigger.trigger(type: type, config: config)
+          @attachments[trigger.id] = attach if attach
           @triggers << trigger
           trigger
         end

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

@@ -19,12 +19,12 @@ module OpenHAB
         #
         # @return [Trigger] Trigger for updated entity
         #
-        def updated(*items, to: nil)
+        def updated(*items, to: nil, attach: nil)
           separate_groups(items).map do |item|
             logger.trace("Creating updated trigger for item(#{item}) to(#{to})")
             [to].flatten.map do |to_state|
               trigger, config = create_update_trigger(item, to_state)
-              append_trigger(trigger, config)
+              append_trigger(trigger, config, attach: attach)
             end
           end.flatten
         end

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.9.0
+  version: 4.10.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-01 00:00:00.000000000 Z
+date: 2021-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,6 +93,7 @@ files:
 - lib/openhab/dsl/persistence.rb
 - lib/openhab/dsl/rules/automation_rule.rb
 - lib/openhab/dsl/rules/guard.rb
+- lib/openhab/dsl/rules/item_event.rb
 - lib/openhab/dsl/rules/property.rb
 - lib/openhab/dsl/rules/rule.rb
 - lib/openhab/dsl/rules/rule_config.rb