openhab-scripting 4.6.0 → 4.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9ccae52c29da91b7fadc2ac7ba2459e9870a257396849535458497ba48601e5
-  data.tar.gz: 0015aca73a5c79082adefb486afcbb545e324c0695d492e15397d2e0d691a204
+  metadata.gz: e7e6ee3df4ad1f531639fff95e296f8ed489f5b4a47a01c713d63855b98b5e6c
+  data.tar.gz: 8fe4c12aee553c1d8a4aba1509a0b90fb1fc40edc6f75c2b9c814b610e6b98a5
 SHA512:
-  metadata.gz: 2db7c0a6f4182d3145871ab6936aa92d5acbe2a6d29e79f793a464d4fbb9514555021d9f0b103130ed99b04c9e149a414ea96df8f134f7db2fb71bade3824168
-  data.tar.gz: da447a4315a8d177db5fc6e476dd30ba93a071f06c6dc612a361f9d12a8539932f8a1659bdd919d8cdf61be2da759f720020d57fe399eaa1a2533bf5e1f56203
+  metadata.gz: f841778b56365cb9df2e8f3749d09c11626b2d528dcf6250d32b31e5733dfb9caead2a9987171808d20fdacd72fac62189f5391b538c48bc0e0e63c0b743a0ce
+  data.tar.gz: b64a487d9d4a3d6fcf4d7c6e8137ec4237ad75d6756fdc5b91546616db14c21833cf52156c0edfacbdaa0dc58c92bba2028cec98d58bf3df2e00f770f0a93fbf

data/lib/openhab/core/entity_lookup.rb

@@ -4,6 +4,8 @@ require 'pp'
 require 'java'
 require 'set'
 
+require 'openhab/log/logger'
+
 # Automation lookup and injection of OpenHab entities
 
 module OpenHAB
@@ -24,9 +26,6 @@ module OpenHAB
       # @return [Object] Item or Thing if found in registry
       #
       def method_missing(method, *args, &block)
-        return if method.to_s == 'scriptLoaded'
-        return if method.to_s == 'scriptUnloaded'
-
         logger.trace("method missing, performing OpenHab Lookup for: #{method}")
         EntityLookup.lookup_entity(method) || super
       end

data/lib/openhab/core/script_handling.rb

@@ -0,0 +1,39 @@
+# 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
+    #
+    module ScriptHandling
+      include OpenHAB::Log
+
+      #
+      # Executed when OpenHAB unloads a script file
+      #
+      # rubocop:disable Naming/MethodName
+      # method name dictacted by OpenHAB
+      def scriptUnloaded
+        logger.trace('Script unloaded')
+        OpenHAB::DSL::Rules.cleanup_rules
+        OpenHAB::DSL::Timers.cancel_all
+      end
+      # rubocop:enable Naming/MethodName
+
+      #
+      # Executed when OpenHAB loads a script file
+      #
+      # rubocop:disable Naming/MethodName
+      # method name dictacted by OpenHAB
+      def scriptLoaded(filename)
+        logger.trace("Script loaded: #{filename}")
+      end
+      # rubocop:enable Naming/MethodName
+    end
+  end
+end

data/lib/openhab/core/thread_local.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# OpenHAB main module
+module OpenHAB
+  module Core
+    #
+    # Manages thread local varaibles for access inside of blocks
+    #
+    module ThreadLocal
+      #
+      # Execute the supplied block with the supplied values set for the currently running thread
+      # The previous values for each key are restored after the block is executed
+      #
+      # @param [Hash] Keys and values to set for running thread
+      #
+      def thread_local(**values)
+        old_values = values.map { |key, _value| [key, Thread.current[key]] }.to_h
+        values.each { |key, value| Thread.current[key] = value }
+        yield
+      ensure
+        old_values.each { |key, value| Thread.current[key] = value }
+      end
+    end
+  end
+end

data/lib/openhab/dsl/items/items.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'openhab/dsl/monkey_patch/events/item_command'
+require 'openhab/dsl/types/types'
 
 require_relative 'item_registry'
 
@@ -27,6 +28,8 @@ module OpenHAB
     # Contains all OpenHAB *Item classes, as well as associated support
     # modules
     module Items
+      include OpenHAB::Log
+
       class << self
         private
 
@@ -44,7 +47,7 @@ module OpenHAB
             _command_predicate, state_predicate = Types::PREDICATE_ALIASES[state.to_s]
             next if klass.instance_methods.include?(state_predicate)
 
-            OpenHAB::Core.logger.trace("Defining #{klass}##{state_predicate} for #{state}")
+            logger.trace("Defining #{klass}##{state_predicate} for #{state}")
             klass.class_eval <<~RUBY, __FILE__, __LINE__ + 1
               def #{state_predicate}   # def on?
                 raw_state == #{state}  #   raw_state == ON
@@ -60,21 +63,21 @@ module OpenHAB
             command = Types::COMMAND_ALIASES[value.to_s]
             next if klass.instance_methods.include?(command)
 
-            OpenHAB::Core.logger.trace("Defining #{klass}##{command} for #{value}")
+            logger.trace("Defining #{klass}##{command} for #{value}")
             klass.class_eval <<~RUBY, __FILE__, __LINE__ + 1
               def #{command}       # def on
                 command(#{value})  #   command(ON)
               end                  # end
             RUBY
 
-            OpenHAB::Core.logger.trace("Defining GroupItem::GroupMembers##{command} for #{value}")
+            logger.trace("Defining GroupItem::GroupMembers##{command} for #{value}")
             GroupItem::GroupMembers.class_eval <<~RUBY, __FILE__, __LINE__ + 1
               def #{command}        # def on
                 each(&:#{command})  #   each(&:on)
               end                   # end
             RUBY
 
-            OpenHAB::Core.logger.trace("Defining ItemCommandEvent##{command}? for #{value}")
+            logger.trace("Defining ItemCommandEvent##{command}? for #{value}")
             MonkeyPatch::Events::ItemCommandEvent.class_eval <<~RUBY, __FILE__, __LINE__ + 1
               def #{command}?        # def refresh?
                 command == #{value}  #   command == REFRESH

data/lib/openhab/dsl/rules/automation_rule.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require 'java'
+require 'set'
+require 'openhab/core/thread_local'
+require 'openhab/log/logger'
 
 module OpenHAB
   module DSL
@@ -16,6 +19,7 @@ module OpenHAB
       # way of breaking it up into multiple classes
       class AutomationRule < Java::OrgOpenhabCoreAutomationModuleScriptRulesupportSharedSimple::SimpleRule
         include OpenHAB::Log
+        include OpenHAB::Core::ThreadLocal
         include OpenHAB::DSL::TimeOfDay
         java_import java.time.ZonedDateTime
 
@@ -24,6 +28,7 @@ module OpenHAB
         #
         # @param [Config] config Rule configuration
         #
+        # Constructor sets a number of variables, no further decomposition necessary
         def initialize(config:)
           super()
           set_name(config.name)
@@ -59,6 +64,14 @@ module OpenHAB
           end
         end
 
+        #
+        # Cleanup any resources associated with automation rule
+        #
+        def cleanup
+          logger.trace "Cancelling #{@trigger_delays.length} Trigger Delays(s) for rule '#{name}'"
+          @trigger_delays.each_value { |trigger_delay| trigger_delay.timer&.cancel }
+        end
+
         private
 
         #

data/lib/openhab/dsl/rules/rule.rb

@@ -13,6 +13,12 @@ module OpenHAB
     # Creates and manages OpenHAB Rules
     #
     module Rules
+      @script_rules = []
+
+      class << self
+        attr_reader :script_rules
+      end
+
       #
       # Create a new rule
       #
@@ -45,6 +51,13 @@ module OpenHAB
         end
       end
 
+      #
+      # Cleanup rules in this script file
+      #
+      def self.cleanup_rules
+        @script_rules.each(&:cleanup)
+      end
+
       private
 
       #
@@ -67,6 +80,7 @@ module OpenHAB
         return unless create_rule?(config)
 
         rule = AutomationRule.new(config: config)
+        Rules.script_rules << rule
         add_rule(rule)
         rule.execute if config.on_start?
       end

data/lib/openhab/dsl/rules/rule_config.rb

@@ -26,7 +26,7 @@ module OpenHAB
       class RuleConfig
         include OpenHAB::Log
         include OpenHAB::Core::EntityLookup
-        include OpenHAB::DSL::Rules::Triggers
+        prepend OpenHAB::DSL::Rules::Triggers
         include OpenHAB::DSL::Rules::Guard
         include OpenHAB::DSL::Rules::Property
         extend OpenHAB::DSL

data/lib/openhab/dsl/time_of_day.rb

@@ -2,6 +2,7 @@
 
 require 'openhab/log/logger'
 require 'openhab/dsl/types/date_time_type'
+require 'openhab/dsl/items/items'
 require 'time'
 
 module OpenHAB

data/lib/openhab/dsl/timers.rb

@@ -3,6 +3,7 @@
 require 'java'
 require 'delegate'
 require 'forwardable'
+require 'openhab/log/logger'
 
 module OpenHAB
   module DSL
@@ -10,15 +11,23 @@ module OpenHAB
     # Provides access to and ruby wrappers around OpenHAB timers
     #
     module Timers
+      include OpenHAB::Log
       java_import org.openhab.core.model.script.actions.ScriptExecution
       java_import java.time.ZonedDateTime
 
+      # Tracks active timers
+      @timers = Set.new
+      class << self
+        attr_accessor :timers
+      end
+
       # Ruby wrapper for OpenHAB Timer
       # This class implements delegator to delegate methods to the OpenHAB timer
       #
       # @author Brian O'Connell
       # @since 2.0.0
       class Timer < SimpleDelegator
+        include OpenHAB::Log
         extend Forwardable
 
         def_delegator :@timer, :is_active, :active?
@@ -31,20 +40,19 @@ module OpenHAB
         # @param [Duration] duration Duration until timer should fire
         # @param [Block] block Block to execute when timer fires
         #
-        def initialize(duration:)
+        def initialize(duration:, &block)
           @duration = duration
 
           # A semaphore is used to prevent a race condition in which calling the block from the timer thread
           # occurs before the @timer variable can be set resulting in @timer being nil
           semaphore = Mutex.new
 
-          timer_block = proc { semaphore.synchronize { yield(self) } }
-
           semaphore.synchronize do
             @timer = ScriptExecution.createTimer(
-              ZonedDateTime.now.plus(@duration), timer_block
+              ZonedDateTime.now.plus(@duration), timer_block(semaphore, &block)
             )
             super(@timer)
+            Timers.timers << self
           end
         end
 
@@ -53,12 +61,40 @@ module OpenHAB
         #
         # @param [Duration] duration
         #
-        # @return [<Type>] <description>
+        # @return [Timer] Rescheduled timer instances
         #
         def reschedule(duration = nil)
           duration ||= @duration
+          Timers.timers << self
           @timer.reschedule(ZonedDateTime.now.plus(duration))
         end
+
+        # Cancel timer
+        #
+        # @return [Boolean] True if cancel was successful, false otherwise
+        #
+        def cancel
+          Timers.timers.delete(self)
+          @timer.cancel
+        end
+
+        private
+
+        #
+        # Constructs a block to execute timer within
+        #
+        # @param [Semaphore] Semaphore to obtain before executing
+        #
+        # @return [Proc] Block for timer to execute
+        #
+        def timer_block(semaphore)
+          proc {
+            semaphore.synchronize do
+              Timers.timers.delete(self)
+              yield(self)
+            end
+          }
+        end
       end
 
       #
@@ -72,6 +108,14 @@ module OpenHAB
       def after(duration, &block)
         Timer.new(duration: duration, &block)
       end
+
+      #
+      # Cancels all active timers
+      #
+      def self.cancel_all
+        logger.trace("Cancelling #{@timers.length} timers")
+        @timers.each(&:cancel)
+      end
     end
   end
 end

data/lib/openhab/dsl/types/types.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'openhab/log/logger'
+
 require_relative 'type'
 
 require_relative 'date_time_type'
@@ -27,6 +29,8 @@ module OpenHAB
     # modules
     #
     module Types
+      include OpenHAB::Log
+
       # Hash taking a Enum value, and returning two symbols of
       # predicates to be defined for it. the first is the "command" form,
       # which should be defined on ItemCommandEvent, and on the Type itself.
@@ -65,7 +69,7 @@ module OpenHAB
           states = PREDICATE_ALIASES[value.to_s]
 
           ([command] | states).each do |method|
-            OpenHAB::Core.logger.trace("Defining #{klass}##{method} for #{value}")
+            logger.trace("Defining #{klass}##{method} for #{value}")
             klass.class_eval <<~RUBY, __FILE__, __LINE__ + 1
               def #{method}       # def on?
                 self == #{value}  #   self == ON

data/lib/openhab/version.rb

@@ -5,5 +5,5 @@
 #
 module OpenHAB
   # @return [String] Version of OpenHAB helper libraries
-  VERSION = '4.6.0'
+  VERSION = '4.6.1'
 end

data/lib/openhab.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'openhab/core/load_path'
+require 'openhab/core/entity_lookup'
+require 'openhab/core/script_handling'
 require 'openhab/core/openhab_setup'
 require 'openhab/log/logger'
 require 'openhab/dsl/dsl'
@@ -17,9 +19,12 @@ module OpenHAB
   # @param [Object] base Object to decorate with DSL and helper methods
   #
   #
+  # rubocop:disable  Metrics/MethodLength
+  # Number of extensions and includes requires more lines
   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::TimeOfDay
@@ -31,6 +36,7 @@ module OpenHAB
 
     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.6.0
+  version: 4.6.1
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
+date: 2021-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -50,6 +50,8 @@ files:
 - lib/openhab/core/load_path.rb
 - lib/openhab/core/openhab_setup.rb
 - lib/openhab/core/osgi.rb
+- lib/openhab/core/script_handling.rb
+- lib/openhab/core/thread_local.rb
 - lib/openhab/dsl/actions.rb
 - lib/openhab/dsl/dsl.rb
 - lib/openhab/dsl/gems.rb