openhab-scripting 4.13.5 → 4.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36ea22254771f9c0d47227ab45818c8eb460b78079134907a73347b09165d536
-  data.tar.gz: 8536ce77360c6156b654db1c2225128fa3aa5bb2373d8f05b4dedd47e0c0fc9c
+  metadata.gz: e18ecb6c7855be5621a529eb7a7c35bfdf7afe8ec134a375e4ef0458f77c4edd
+  data.tar.gz: 862215cf6988193ec43bbd9a79e8ff16d6a50c91d832346f2d4eb180ba751129
 SHA512:
-  metadata.gz: 4ccaa0e34778eaacb554c9c533b4d22db5cc62274df0d61e3f18adc00e3bdda0bb85e7d423967bf8ab27bab73591d0eee5f040232ef1fa973aa03e7c7d7065c1
-  data.tar.gz: 84b569a30270cc7458f4ff16210a773154c2fc3a8da46706106b13dad498b6ed1ae94c964694afe6478b275636078ac49eb79f294845202d1168aef3df1fe8c5
+  metadata.gz: 21a39ca9ec68afb322cd63fc7c76bd2e8eec26bb8076f0160b3f959465d08060f40516bc9a866251f0c6c1e29a8d2c1b5339645ed6e6726bcf054768e7f262cc
+  data.tar.gz: 20af639fd0bdf052e34a6eb73b94e0de96f1cdf31584bd2475a54d23d404354444536b7a5ebda83ea51ae0799486ca91d42e96eafb7e9ad260db487aeced166a

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

@@ -5,5 +5,5 @@
 #
 module OpenHAB
   # @return [String] Version of OpenHAB helper libraries
-  VERSION = '4.13.5'
+  VERSION = '4.14.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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.13.5
+  version: 4.14.0
 platform: ruby
 authors:
 - Brian O'Connell