openhab-scripting 4.25.0 → 4.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9311e047c09ea5409e82e4650a2ef22d26513e10a566445370772e568552e0bd
-  data.tar.gz: c21b7970c72bf749d6403b212b8e84ab255b1dd07ef3d695c7881e5205edd72a
+  metadata.gz: 6e4ca97d24c3811cfeba0faba93e2cdafb9a55f1ed7001cac8789baaf6a7f92c
+  data.tar.gz: 5eaeee1232c3e4252ae6396513e2a654727af1fd7075cb6ef9386c4b5e7b4c9a
 SHA512:
-  metadata.gz: 0f62960bbd5fc2e51064bc63c4a3cc7e2e9de322233a1f489311ca20c3df51381c04449a4af0dff455ceb998f4e43ab4ac2668101aa7838c3445e0c4093f6074
-  data.tar.gz: df255a6f1e8a5b573d6b37b0ec6637cd7ccdea4e6abdd937f19b0f8f484713406133cb86fb2c080bdb132717a3efa313c626c4b4cd89ea62baf4bca31b26f58b
+  metadata.gz: 0ee0e18e0e4bb8818d405998d2209f24b8b03651195a18fa76e97e417a0696b178cf3dcb431f7c42b3895dc15c29f3fb24d77bc3580ef35e6d37131725cc4ae8
+  data.tar.gz: 17afc1eed167b1d0dca764c2962727b770eeab95d53413fc85e54694bace8866260445d73a58da817ff65a1388c81999cc42fc05a25d22d0cd72028312a4dd63

data/lib/openhab/core/openhab_setup.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'openhab/log/logger'
+require 'openhab/core/services'
 
 module OpenHAB
   #
@@ -19,12 +20,10 @@ module OpenHAB
     #
     def self.wait_till_openhab_ready
       logger.trace('Checking readyness of OpenHAB')
-      # rubocop: disable Style/GlobalVars
-      until $scriptExtension.get('automationManager')
+      until OpenHAB::Core.automation_manager
         logger.trace("Automation manager not loaded, checking again in #{CHECK_DELAY} seconds.")
         sleep CHECK_DELAY
       end
-      # rubocop: enable Style/GlobalVars
       logger.trace 'Automation manager instantiated, OpenHAB ready for rule processing.'
     end
   end

data/lib/openhab/core/services.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  #
+  # Core support for OpenHAB JRuby Library
+  #
+  module Core
+    #
+    # Access OpenHAB services
+    #
+
+    # Get the OpenHAB automation manager
+    # @return [AutomationManager] OpenHAB Automation manager
+    # rubocop:disable Style/GlobalVars
+    def self.automation_manager
+      $scriptExtension.get('automationManager')
+    end
+
+    # Get the OpenHAB rule registry
+    # @return [Registory] OpenHAB rule registry
+    def self.rule_registry
+      $scriptExtension.get('ruleRegistry')
+    end
+    # rubocop:enable Style/GlobalVars
+  end
+end

data/lib/openhab/dsl/dsl.rb

@@ -11,17 +11,18 @@ require 'openhab/dsl/monkey_patch/events/events'
 require 'openhab/dsl/monkey_patch/actions/actions'
 require 'openhab/dsl/rules/rule'
 require 'openhab/dsl/rules/terse'
-require 'openhab/dsl/actions'
-require 'openhab/dsl/channel'
-require 'openhab/dsl/timers'
-require 'openhab/dsl/group'
-require 'openhab/dsl/things'
-require 'openhab/dsl/between'
-require 'openhab/dsl/gems'
-require 'openhab/dsl/persistence'
-require 'openhab/dsl/uid'
-require 'openhab/dsl/units'
-require 'openhab/dsl/states'
+require_relative 'actions'
+require_relative 'channel'
+require_relative 'timers'
+require_relative 'group'
+require_relative 'things'
+require_relative 'between'
+require_relative 'gems'
+require_relative 'persistence'
+require_relative 'uid'
+require_relative 'units'
+require_relative 'states'
+require_relative 'openhab'
 
 module OpenHAB
   #
@@ -34,6 +35,7 @@ module OpenHAB
     def self.extended(base)
       base.send :include, OpenHAB::DSL::Actions
       base.send :include, OpenHAB::DSL::Between
+      base.send :include, OpenHAB::DSL::Core
       base.send :include, OpenHAB::DSL::Groups
       base.send :include, OpenHAB::DSL::Items
       base.send :include, OpenHAB::DSL::Persistence

data/lib/openhab/dsl/group.rb

@@ -3,6 +3,7 @@
 require 'singleton'
 
 require 'openhab/dsl/lazy_array'
+require 'openhab/core/entity_lookup'
 
 module OpenHAB
   module DSL
@@ -24,7 +25,7 @@ module OpenHAB
         # @return [Set] of OpenHAB Groups
         #
         def [](name)
-          group = Core::EntityLookup.lookup_item(name)
+          group = OpenHAB::Core::EntityLookup.lookup_item(name)
           group.is_a?(Items::GroupItem) ? group : nil
         end
         alias include? []

data/lib/openhab/dsl/openhab.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module OpenHAB
+  module DSL
+    #
+    # Provides access to OpenHAB attributes
+    #
+    module Core
+      include OpenHAB::Log
+
+      #
+      # Return the OpenHAB conf directory as a ruby pathname
+      #
+      # @return [Pathname] OpenHAB conf path
+      #
+      def __conf__
+        Pathname.new(ENV['OPENHAB_CONF'])
+      end
+    end
+  end
+end

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

@@ -36,7 +36,8 @@ module OpenHAB
           # @param [Object] only_if Item or Proc to use as guard
           # @param [Object] not_if Item or Proc to use as guard
           #
-          def initialize(only_if: nil, not_if: nil)
+          def initialize(run_context:, only_if: nil, not_if: nil)
+            @run_context = run_context
             @only_if = only_if
             @not_if = not_if
           end
@@ -106,27 +107,27 @@ module OpenHAB
           #
           # Check not_if guard
           #
-          # @param [OpenHAB Event] event event to check if meets guard
+          # @param [OpenHAB Event] event to check if meets guard
           # @param [Array<Item>] items to check if satisfy criteria
           # @param [Array] procs to check if satisfy criteria
           #
           # @return [Boolean] True if criteria are satisfied, false otherwise
           #
           def process_not_if(event, items, procs)
-            items.flatten.none?(&:truthy?) && procs.none? { |proc| proc.call(event) }
+            items.flatten.none?(&:truthy?) && procs.none? { |proc| @run_context.instance_exec(event, &proc) }
           end
 
           #
           # Check only_if guard
           #
-          # @param [OpenHAB Event] event event to check if meets guard
+          # @param [OpenHAB Event] event to check if meets guard
           # @param [Array<Item>] items to check if satisfy criteria
           # @param [Array] procs to check if satisfy criteria
           #
           # @return [Boolean] True if criteria are satisfied, false otherwise
           #
           def process_only_if(event, items, procs)
-            items.flatten.all?(&:truthy?) && procs.all? { |proc| proc.call(event) }
+            items.flatten.all?(&:truthy?) && procs.all? { |proc| @run_context.instance_exec(event, &proc) }
           end
         end
       end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'openhab/core/thread_local'
+require 'openhab/core/services'
 require 'openhab/log/logger'
 require_relative 'rule_config'
 require_relative 'automation_rule'
@@ -21,14 +22,11 @@ module OpenHAB
 
       @script_rules = []
 
-      # rubocop: disable Style/GlobalVars
-      @automation_manager = $scriptExtension.get('automationManager')
-      @registry = $scriptExtension.get('ruleRegistry')
-      # rubocop: enable Style/GlobalVars
-
+      @automation_manager = OpenHAB::Core.automation_manager
+      @registry = OpenHAB::Core.rule_registry
       class << self
         attr_reader :script_rules, :automation_manager, :registry
-      end
+end
 
       #
       # Create a new rule
@@ -37,13 +35,13 @@ module OpenHAB
       # @yield [] Block executed in context of a RuleConfig
       #
       #
-      # rubocop: disable Metrics/MethodLength
+      # rubocop: disable Metrics
       def rule(rule_name, &block)
         thread_local(RULE_NAME: rule_name) do
           @rule_name = rule_name
           config = RuleConfig.new(rule_name, block.binding)
           config.instance_exec(config, &block)
-          config.guard = Guard::Guard.new(only_if: config.only_if, not_if: config.not_if)
+          config.guard = Guard::Guard.new(run_context: config.caller, only_if: config.only_if, not_if: config.not_if)
           logger.trace { config.inspect }
           process_rule_config(config)
           nil # Must return something other than the rule object. See https://github.com/boc-tothefuture/openhab-jruby/issues/438
@@ -52,7 +50,7 @@ module OpenHAB
         puts "#{e.class}: #{e.message}"
         re_raise_with_backtrace(e)
       end
-      # rubocop: enable Metrics/MethodLength
+      # rubocop: enable Metrics
 
       #
       # Cleanup rules in this script file

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

@@ -2,14 +2,15 @@
 
 require 'java'
 require 'pp'
-require 'openhab/dsl/rules/property'
-require 'openhab/dsl/rules/triggers/cron'
-require 'openhab/dsl/rules/triggers/changed'
-require 'openhab/dsl/rules/triggers/channel'
-require 'openhab/dsl/rules/triggers/command'
-require 'openhab/dsl/rules/triggers/updated'
-require 'openhab/dsl/rules/triggers/generic'
-require 'openhab/dsl/rules/guard'
+require_relative 'property'
+require_relative 'triggers/cron'
+require_relative 'triggers/changed'
+require_relative 'triggers/channel'
+require_relative 'triggers/command'
+require_relative 'triggers/updated'
+require_relative 'triggers/generic'
+require_relative 'triggers/watch'
+require_relative 'guard'
 require 'openhab/core/entity_lookup'
 require 'openhab/dsl/between'
 require 'openhab/dsl/dsl'

data/lib/openhab/dsl/rules/triggers/watch.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require 'java'
+require 'openhab/log/logger'
+require 'openhab/core/services'
+
+module OpenHAB
+  module DSL
+    module Rules
+      #
+      # Module holds rule triggers
+      #
+      module Triggers
+        #
+        # Module for watching directories/files
+        #
+        module Watch
+          include OpenHAB::Log
+
+          # Characters in an fnmatch compatible glob
+          GLOB_CHARS = ['**', '*', '?', '[', ']', '{', '}'].freeze
+
+          #
+          # Creates trigger types and trigger type factories for OpenHAB
+          #
+          def self.add_watch_handler
+            java_import org.openhab.core.automation.type.TriggerType
+            OpenHAB::Core.automation_manager.add_trigger_handler(
+              OpenHAB::DSL::Rules::Triggers::Watch::WATCH_TRIGGER_MODULE_ID,
+              OpenHAB::DSL::Rules::Triggers::Watch::WatchTriggerHandlerFactory.new
+            )
+
+            OpenHAB::Core.automation_manager.add_trigger_type(watch_trigger_type)
+            OpenHAB::Log.logger(self).trace('Added watch trigger handler')
+          end
+
+          #
+          # Creates trigger types and trigger type factories for OpenHAB
+          #
+          private_class_method def self.watch_trigger_type
+            TriggerType.new(
+              OpenHAB::DSL::Rules::Triggers::Watch::WATCH_TRIGGER_MODULE_ID,
+              nil,
+              'A path change event is detected',
+              'Triggers when a path change event is detected',
+              nil,
+              org.openhab.core.automation.Visibility::VISIBLE,
+              nil
+            )
+          end
+
+          # Struct for Watch Events
+          WatchEvent = Struct.new(:type, :path, :attachment)
+
+          # Trigger ID for Watch Triggers
+          WATCH_TRIGGER_MODULE_ID = 'jsr223.jruby.WatchTrigger'
+
+          # Extends the OpenHAB watch service to watch directories
+          #
+          # Must match java method name style
+          # rubocop:disable Naming/MethodName
+          class Watcher < org.openhab.core.service.AbstractWatchService
+            java_import java.nio.file.StandardWatchEventKinds
+
+            # Hash of event symbols as strings to map to NIO events
+            STRING_TO_EVENT = {
+              created: StandardWatchEventKinds::ENTRY_CREATE,
+              deleted: StandardWatchEventKinds::ENTRY_DELETE,
+              modified: StandardWatchEventKinds::ENTRY_MODIFY
+            }.transform_keys(&:to_s).freeze
+
+            # Hash of NIO event kinds to ruby symbols
+            EVENT_TO_SYMBOL = STRING_TO_EVENT.invert.transform_values(&:to_sym).freeze
+
+            # Creates a new Watch Service
+            def initialize(path, types, &block)
+              super(path)
+              @types = types.map { |type| STRING_TO_EVENT[type] }
+              @block = block
+            end
+
+            # Invoked by java super class to get type of events to watch for
+            # @param [String] _path ignored
+            #
+            # @return [Array] array of NIO event kinds
+            def getWatchEventKinds(_path)
+              @types
+            end
+
+            # Invoked by java super class to check if sub directories should be watched
+            # @return [false] false
+            def watchSubDirectories
+              false
+            end
+
+            # Invoked by java super class when an watch event occurs
+            # @param [String] _event ignored
+            # @param [StandardWatchEventKind] kind NIO watch event kind
+            # @param [java.nio.Path] Path that had an event
+            def processWatchEvent(_event, kind, path)
+              @block.call(WatchEvent.new(EVENT_TO_SYMBOL[kind], Pathname.new(path.to_s)))
+            end
+          end
+          # rubocop:enable Naming/MethodName
+
+          # Implements the OpenHAB TriggerHandler interface to process Watch Triggers
+          class WatchTriggerHandler
+            include OpenHAB::Log
+            include org.openhab.core.automation.handler.TriggerHandler
+
+            # Creates a new WatchTriggerHandler
+            # @param [Trigger] OpenHAB trigger associated with handler
+            #
+            def initialize(trigger)
+              @trigger = trigger
+              config = trigger.configuration.properties.to_hash.transform_keys(&:to_sym)
+              @path = config[:path]
+              @watcher = Watcher.new(@path, config[:types], &watch_event_handler(config[:glob]))
+              @watcher.activate
+              logger.trace("Created watcher for #{@path}")
+            end
+
+            # Create a lambda to use to invoke rule engine when file watch notification happens
+            # @param [String] glob to match for notification events
+            #
+            # @return [Lambda] lambda to execute on notification events
+            #
+            def watch_event_handler(glob)
+              lambda { |watch_event|
+                logger.trace("Received event(#{watch_event})")
+                if watch_event.path.fnmatch?(glob)
+                  @rule_engine_callback&.triggered(@trigger, { 'event' => watch_event })
+                else
+                  logger.trace("Event #{watch_event} did not match glob(#{glob})")
+                end
+              }
+            end
+
+            # Called by OpenHAB to set the rule engine to invoke when triggered
+            # Must match java method name style
+            # rubocop:disable Naming/MethodName
+            def setCallback(callback)
+              @rule_engine_callback = callback
+            end
+            # rubocop:enable Naming/MethodName
+
+            #
+            # Dispose of handler which deactivates watcher
+            #
+            def dispose
+              logger.trace("Deactivating watcher for #{@path}")
+              @watcher&.deactivate
+            end
+          end
+
+          # Implements the ScriptedTriggerHandlerFactory interface to create a new Trigger Handler
+          class WatchTriggerHandlerFactory
+            include org.openhab.core.automation.module.script.rulesupport.shared.factories.ScriptedTriggerHandlerFactory
+
+            # Invoked by the OpenHAB core to get a trigger handler for the supllied trigger
+            # @param [Trigger] OpenHAB trigger
+            #
+            # @return [WatchTriggerHandler] trigger handler for supplied trigger
+            def get(trigger)
+              WatchTriggerHandler.new(trigger)
+            end
+          end
+        end
+
+        #
+        # Create a trigger to watch a path
+        #
+        # @param [String] path to watch
+        #
+        # @return [Trigger] Trigger object
+        #
+        def watch(path, glob: '*', for: %i[created deleted modified], attach: nil)
+          glob, path = glob_for_path(Pathname.new(path), glob)
+          types = [binding.local_variable_get(:for)].flatten
+          conf = { path: path.to_s, types: types.map(&:to_s), glob: glob.to_s }
+
+          logger.trace("Creating a watch trigger for path(#{path}) with glob(#{glob}) for types(#{types})")
+          append_trigger(OpenHAB::DSL::Rules::Triggers::Watch::WATCH_TRIGGER_MODULE_ID,
+                         conf,
+                         attach: attach)
+        end
+
+        private
+
+        #
+        # Automatically creates globs for supplied paths if necessary
+        # @param [Pathname] path to check
+        # @param [String] specified glob
+        #
+        # @return [Pathname,String] Pathname to watch and glob to match
+        def glob_for_path(path, glob)
+          # Checks if the supplied pathname last element contains a glob char
+          if OpenHAB::DSL::Rules::Triggers::Watch::GLOB_CHARS.any? { |char| path.basename.to_s.include? char }
+            # Splits the supplied pathname into a glob string and parent path
+            [path.basename.to_s, path.parent]
+          elsif path.file? || !path.exist?
+            # glob string matching end of Pathname and parent path
+            ["*/#{path.basename}", path.parent]
+          else
+            [glob, path]
+          end
+        end
+      end
+    end
+  end
+end
+# Add the watch handler to OpenHAB
+OpenHAB::DSL::Rules::Triggers::Watch.add_watch_handler

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

@@ -2,11 +2,13 @@
 
 require 'forwardable'
 require 'time'
+require 'java'
 
 module OpenHAB
   module DSL
     module Types
       java_import org.openhab.core.library.types.DateTimeType
+      java_import java.time.ZonedDateTime
 
       # global alias
       ::DateTimeType = DateTimeType

data/lib/openhab/version.rb

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

data/lib/openhab.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'java'
 require 'openhab/core/load_path'
 require 'openhab/core/entity_lookup'
 require 'openhab/core/script_handling'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.25.0
+  version: 4.26.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2021-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -51,6 +51,7 @@ files:
 - lib/openhab/core/openhab_setup.rb
 - lib/openhab/core/osgi.rb
 - lib/openhab/core/script_handling.rb
+- lib/openhab/core/services.rb
 - lib/openhab/core/thread_local.rb
 - lib/openhab/dsl/actions.rb
 - lib/openhab/dsl/between.rb
@@ -92,6 +93,7 @@ files:
 - lib/openhab/dsl/monkey_patch/ruby/number.rb
 - lib/openhab/dsl/monkey_patch/ruby/ruby.rb
 - lib/openhab/dsl/monkey_patch/ruby/string.rb
+- lib/openhab/dsl/openhab.rb
 - lib/openhab/dsl/persistence.rb
 - lib/openhab/dsl/rules/automation_rule.rb
 - lib/openhab/dsl/rules/cron_trigger_rule.rb
@@ -108,6 +110,7 @@ files:
 - lib/openhab/dsl/rules/triggers/generic.rb
 - lib/openhab/dsl/rules/triggers/trigger.rb
 - lib/openhab/dsl/rules/triggers/updated.rb
+- lib/openhab/dsl/rules/triggers/watch.rb
 - lib/openhab/dsl/states.rb
 - lib/openhab/dsl/things.rb
 - lib/openhab/dsl/time/month_day.rb