openhab-scripting 4.13.2 → 4.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d2593c004c5de826f8b1d010fd4594e6b32911ad6291b2973f192bf7e7d2383
-  data.tar.gz: fbd14e4e0a1ae6622a6fa868dc2b5a006cbd2094c22922e36f95743f97683f9a
+  metadata.gz: e18ecb6c7855be5621a529eb7a7c35bfdf7afe8ec134a375e4ef0458f77c4edd
+  data.tar.gz: 862215cf6988193ec43bbd9a79e8ff16d6a50c91d832346f2d4eb180ba751129
 SHA512:
-  metadata.gz: 7035a6b5621606d072680ac7057ef69a1f60a78ea674a4ef5fea16307b8fe6fd2578da0c925b9b2243d84101e9e3505f0a944c69c7f32884ccc0e29d093d7d0a
-  data.tar.gz: 26758d8a9a8d14754364cbbf1e012e522cbc7d85f9506d7290e21deb675b985c00439ce1bdefacefbd6c43d7904b2a019b243fc9d5c241b62825493659d114d7
+  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/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.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.2'
+  VERSION = '4.14.0'
 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.2
+  version: 4.14.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2021-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler