openhab-scripting 4.13.3 → 4.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8553ce88b82dd93b0b7765705c02bd395d60e73e8fba7d61c4eaac617f7b78c
-  data.tar.gz: 1a31fb278828c5e2d487baba5836b171ffbc24cb8617c707f3da6afe9acbe526
+  metadata.gz: 2e8b2919900c21200e8768fc3c940d0ef58dfba0aa8a48ed1b1864e242f9755c
+  data.tar.gz: b51e656ba68e02be1ae3dd7c0d0de0bfdf015de4173702129d23c94e68efe83c
 SHA512:
-  metadata.gz: c5bcf4d62caa96ad2160baaef8c05811f0ab423113547e5bab7455553f6e60db45da3ad12312e882eb1627e4e09529acc71b3e9d04e8a2063df17c4717d71a16
-  data.tar.gz: ccc18e9cabf4e3d4f2f690c15f6bb58690819ff226f7ddc55422779bc33e2b4d08d4434ec33df8dbae3a146ca633bf55118e2569bf99a8a6cdce64801339120d
+  metadata.gz: 8506cc8c0ec9ee580525320021c4f9b7525940ecce0ecb402b8366bbebb7df8e2b869ac6661e14e1115047ff4fcabe46ce6d3be2d2870438914822cfa9d6ac15
+  data.tar.gz: 267f062e3e87c1b193b4edb80bf2022b6d9748b2aa3398074fc85a844e9e14679564f908d73367e6ec0bce9c1c44fba78b237b678573221223001c59d24a5258

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

@@ -65,9 +65,9 @@ module OpenHAB
         end
 
         if email
-          NotificationAction.sendNotification email, msg
+          NotificationAction.sendNotification email.to_s, msg.to_s
         else
-          NotificationAction.sendBroadcastNotification msg
+          NotificationAction.sendBroadcastNotification msg.to_s
         end
       end
 
@@ -83,7 +83,7 @@ module OpenHAB
       #
       def say(text, voice: nil, sink: nil, volume: nil)
         volume = Types::PercentType.new(volume) unless volume.is_a?(Types::PercentType) || volume.nil?
-        Voice.say text, voice, sink, volume
+        Voice.say text.to_s, voice&.to_s, sink&.to_s, volume
       end
 
       #
@@ -97,7 +97,7 @@ module OpenHAB
       #
       def play_sound(filename, sink: nil, volume: nil)
         volume = Types::PercentType.new(volume) unless volume.is_a?(Types::PercentType) || volume.nil?
-        Audio.playSound sink, filename, volume
+        Audio.playSound sink&.to_s, filename.to_s, volume
       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/version.rb

@@ -5,5 +5,5 @@
 #
 module OpenHAB
   # @return [String] Version of OpenHAB helper libraries
-  VERSION = '4.13.3'
+  VERSION = '4.14.1'
 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.3
+  version: 4.14.1
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2021-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler