openhab-scripting 4.13.5 → 4.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36ea22254771f9c0d47227ab45818c8eb460b78079134907a73347b09165d536
-  data.tar.gz: 8536ce77360c6156b654db1c2225128fa3aa5bb2373d8f05b4dedd47e0c0fc9c
+  metadata.gz: fa5e8f47863d4b84f260403bcfc62b027fe118a9db4475044c8d25e202a84837
+  data.tar.gz: 7e5b9b690dd7c734c2d4bebda07ed5280d0ff718be1c760ce5f2bfb7846a2c43
 SHA512:
-  metadata.gz: 4ccaa0e34778eaacb554c9c533b4d22db5cc62274df0d61e3f18adc00e3bdda0bb85e7d423967bf8ab27bab73591d0eee5f040232ef1fa973aa03e7c7d7065c1
-  data.tar.gz: 84b569a30270cc7458f4ff16210a773154c2fc3a8da46706106b13dad498b6ed1ae94c964694afe6478b275636078ac49eb79f294845202d1168aef3df1fe8c5
+  metadata.gz: 0a9e776aa7e5c784a62c803d6cbb99218ff592ffa60217b0f6604929aea5f3df4ce05a74647780592f87a673fed8cf120087d9bcb519446c3e1beb1072ce947a
+  data.tar.gz: b4d4d3dd48427e67be2dd19e1c91757b0ed8e44ab9550af1804aa2f60ec6beef507ffa316e120867371df83efc5f887092d9023107533e0961c24290a752736d

data/lib/openhab/core/script_handling.rb

@@ -1,39 +1,76 @@
 # frozen_string_literal: true
 
 require 'openhab/log/logger'
-require 'openhab/dsl/rules/rule'
-require 'openhab/dsl/timers'
 
 # OpenHAB main module
 module OpenHAB
   module Core
     #
-    # Manages script loading and unloading
+    # Provide callback mechanisms for script handling
     #
     module ScriptHandling
+      module_function
+
+      # Add a callback to be run when the script has been fully loaded
+      def script_loaded(&block)
+        ScriptHandlingCallbacks.script_loaded_hooks << block
+      end
+
+      # Add a callback to be run when the script is unloaded
+      def script_unloaded(&block)
+        ScriptHandlingCallbacks.script_unloaded_hooks << block
+      end
+    end
+
+    #
+    # Manages script loading and unloading
+    #
+    module ScriptHandlingCallbacks
       include OpenHAB::Log
 
+      class << self
+        #
+        # Return script_loaded_hooks
+        #
+        # @!visibility private
+        def script_loaded_hooks
+          @script_loaded_hooks ||= []
+        end
+
+        #
+        # Return script_unloaded_hooks
+        #
+        # @!visibility private
+        def script_unloaded_hooks
+          @script_unloaded_hooks ||= []
+        end
+      end
+
       #
       # Executed when OpenHAB unloads a script file
       #
-      # rubocop:disable Naming/MethodName
-      # method name dictacted by OpenHAB
-      def scriptUnloaded
+      # @!visibility private
+      def scriptUnloaded # rubocop:disable Naming/MethodName method name dictated by OpenHAB
         logger.trace('Script unloaded')
-        OpenHAB::DSL::Rules.cleanup_rules
-        OpenHAB::DSL::Timers.cancel_all
+        ScriptHandlingCallbacks.script_unloaded_hooks.each do |hook|
+          hook.call
+        rescue StandardError => e
+          logger.error("Failed to call script_unloaded hook #{hook}: #{e}")
+        end
       end
-      # rubocop:enable Naming/MethodName
 
       #
       # Executed when OpenHAB loads a script file
       #
-      # rubocop:disable Naming/MethodName
-      # method name dictacted by OpenHAB
-      def scriptLoaded(filename)
+      # @!visibility private
+      def scriptLoaded(filename) # rubocop:disable Naming/MethodName method name dictated by OpenHAB
         logger.trace("Script loaded: #{filename}")
+        ScriptHandlingCallbacks.script_loaded_hooks.each do |hook|
+          hook.call
+        rescue StandardError => e
+          logger.error("Failed to call script_loaded hook #{hook}: #{e}")
+        end
       end
-      # rubocop:enable Naming/MethodName
     end
   end
 end

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

@@ -62,6 +62,7 @@ module OpenHAB
       def self.cleanup_rules
         @script_rules.each(&:cleanup)
       end
+      Core::ScriptHandling.script_unloaded { cleanup_rules }
 
       private
 

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/timers/timer.rb

@@ -24,8 +24,6 @@ module OpenHAB
         include OpenHAB::Log
         extend Forwardable
 
-        def_delegator :@timer, :is_active, :active?
-        def_delegator :@timer, :is_running, :running?
         def_delegator :@timer, :has_terminated, :terminated?
 
         #

data/lib/openhab/dsl/timers.rb

@@ -47,6 +47,7 @@ module OpenHAB
       def self.cancel_all
         @timer_manager.cancel_all
       end
+      Core::ScriptHandling.script_unloaded { cancel_all }
 
       # Create or reschedule a reentrant time
       #

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.13.5'
+  VERSION = '4.15.0'
 end

data/lib/openhab.rb

@@ -20,20 +20,23 @@ 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
-    base.send :include, OpenHAB::Core::ScriptHandling
     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.13.5
+  version: 4.15.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-14 00:00:00.000000000 Z
+date: 2021-11-24 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