openhab-scripting 4.13.4 → 4.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e794d663e6db42e9255f01cbdbae515562726ac8d6a27aebaf7210722a5811f2
-  data.tar.gz: 9ebdbe785492a7b9aabbc72a4b3fbf2f0a6396d9697d0422f292f99c71287ee0
+  metadata.gz: a67cb8047adba1af368a416f5a40d624ec84657f62ad420c1388e8f9cd04d9a7
+  data.tar.gz: bc6455b6a27d5efc447fd004a9f6503ead46ae40480d93aaa3a22288288cbb0a
 SHA512:
-  metadata.gz: 477e6446f83833e511d4219d40b31e2ed52110500a0b45ef31a7184e61d30e645056e4dd55b019536f63c89a23d47e64433fef736a0fc5228653598a6f62f50d
-  data.tar.gz: 601498e0008cd0b85c73cdecda6d96cf3250253931d912634bbfdb1139a7db8344f1a011ffa4a9fcfdd375cf529c3348731af315f0aa1b24118eb47b51b0fe13
+  metadata.gz: 78c076b90ba8a174019ac814172f377aa49c0e21339e35040220da6df66ebff1ad4edde36202c9d65ffd4d8e65e08ab73fc3802589685f7f40a84199699adc59
+  data.tar.gz: 8903933c828cfcd21f8c41d3524529e2e0cf96b5f4d307af8591dc36379774bba16c827ae5e5cd0258c953bffc2ec356c536467855b108e4f9f0a4de9fc54ce7

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/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/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.4'
+  VERSION = '4.14.2'
 end

data/lib/openhab.rb

@@ -20,6 +20,7 @@ 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
@@ -28,12 +29,14 @@ module OpenHAB
     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
     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.4
+  version: 4.14.2
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-10 00:00:00.000000000 Z
+date: 2021-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler