openhab-jrubyscripting 5.0.0.rc9 → 5.0.0.rc11

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "property"
-
 module OpenHAB
   module DSL
     module Rules
@@ -13,8 +11,8 @@ module OpenHAB
         #
         # Create a new Guard
         #
-        # @param [Object] only_if Item or Proc to use as guard
-        # @param [Object] not_if Item or Proc to use as guard
+        # @param [Array<Proc>] only_if Array of Procs to use as guard
+        # @param [Array<Proc>] not_if Array of Procs to use as guard
         #
         def initialize(run_context:, only_if: nil, not_if: nil)
           @run_context = run_context
@@ -40,74 +38,34 @@ module OpenHAB
         #
         def should_run?(event)
           logger.trace("Checking guards #{self}")
-          check(@only_if, check_type: :only_if,
-                          event: event) && check(@not_if, check_type: :not_if, event: event)
-        end
-
-        private
-
-        #
-        # Check if guard is satisfied
-        #
-        # @param [Array] conditions to check
-        # @param [Symbol] check_type type of check to perform (:only_if or :not_if)
-        # @param [Event] event openHAB event to see if it satisfies the guard
-        #
-        # @return [true,false] True if guard is satisfied, false otherwise
-        #
-        def check(conditions, check_type:, event:)
-          return true if conditions.nil? || conditions.empty?
+          return false unless check_only_if(event)
+          return false unless check_not_if(event)
 
-          procs, items = conditions.flatten.partition { |condition| condition.is_a?(Proc) }
-          logger.trace("Procs: #{procs} Items: #{items}")
-
-          items.each { |item| logger.trace { "#{item} truthy? #{item.truthy?}" } }
-
-          process_check(check_type: check_type, event: event, items: items, procs: procs)
+          true
         end
 
-        #
-        # Execute the guard check
-        #
-        # @param [Symbol] check_type :only_if or :not_if to check
-        # @param [Object] 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 [true,false] True if criteria are satisfied, false otherwise
-        #
-        def process_check(check_type:, event:, items:, procs:)
-          case check_type
-          when :only_if then process_only_if(event, items, procs)
-          when :not_if then  process_not_if(event, items, procs)
-          else raise ArgumentError, "Unexpected check type: #{check_type}"
-          end
-        end
+        private
 
         #
-        # Check not_if guard
+        # Check not_if guards
         #
         # @param [Object] event to check if meets guard
-        # @param [Array<Item>] items to check if satisfy criteria
-        # @param [Array] procs to check if satisfy criteria
         #
         # @return [true,false] True if criteria are satisfied, false otherwise
         #
-        def process_not_if(event, items, procs)
-          items.flatten.none?(&:truthy?) && procs.none? { |proc| @run_context.instance_exec(event, &proc) }
+        def check_not_if(event)
+          @not_if.nil? || @not_if.none? { |proc| @run_context.instance_exec(event, &proc) }
         end
 
         #
-        # Check only_if guard
+        # Check only_if guards
         #
         # @param [Object] event to check if meets guard
-        # @param [Array<Item>] items to check if satisfy criteria
-        # @param [Array] procs to check if satisfy criteria
         #
         # @return [true,false] True if criteria are satisfied, false otherwise
         #
-        def process_only_if(event, items, procs)
-          items.flatten.all?(&:truthy?) && procs.all? { |proc| @run_context.instance_exec(event, &proc) }
+        def check_only_if(event)
+          @only_if.nil? || @only_if.all? { |proc| @run_context.instance_exec(event, &proc) }
         end
       end
     end

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

@@ -60,6 +60,8 @@ module OpenHAB
               infer_rule_name_from_item_trigger(trigger, items, kwargs)
             when :channel_linked, :channel_unlinked
               infer_rule_name_from_channel_link_trigger(trigger)
+            when :item_added, :item_removed, :item_updated
+              infer_rule_name_from_item_registry_trigger(trigger)
             when :thing_added, :thing_removed, :thing_updated
               infer_rule_name_from_thing_trigger(trigger)
             when :on_start
@@ -116,6 +118,15 @@ module OpenHAB
             (trigger == :channel_linked) ? "Channel linked to item" : "Channel unlinked from item"
           end
 
+          # formulate a readable rule name from an item added/updated/remove trigger
+          def infer_rule_name_from_item_registry_trigger(trigger)
+            {
+              item_added: "Item added",
+              item_updated: "Item updated",
+              item_removed: "Item removed"
+            }[trigger]
+          end
+
           # formulate a readable rule name from a thing added/updated/remove trigger
           def infer_rule_name_from_thing_trigger(trigger)
             {

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

@@ -9,12 +9,11 @@ module OpenHAB
       # @visibility private
       module Property
         #
-        # Dynamically creates a property that acts and an accessor with no arguments
+        # Dynamically creates a property that acts as an accessor with no arguments
         # and a setter with any number of arguments or a block.
         #
         # @param [String] name of the property
         #
-        #
         def prop(name)
           # rubocop rules are disabled because this method is dynamically defined on the calling
           #   object making calls to other methods in this module impossible, or if done on methods
@@ -36,8 +35,8 @@ module OpenHAB
         end
 
         #
-        # Dynamically creates a property array acts and an accessor with no arguments
-        # and a pushes any number of arguments or a block onto they property array
+        # Dynamically creates a property array that acts as an accessor with no arguments
+        # and pushes any number of arguments or a block onto the property array
         # You can provide a block to this method which can be used to check if the provided value is acceptable.
         #
         # @param [String] name of the property

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

@@ -51,12 +51,15 @@ module OpenHAB
         def_terse_rule(:channel_unlinked)
         def_terse_rule(:cron)
         def_terse_rule(:every)
+        def_terse_rule(:item_added)
+        def_terse_rule(:item_updated)
+        def_terse_rule(:item_removed)
+        def_terse_rule(:on_start)
         def_terse_rule(:received_command)
         def_terse_rule(:thing_added)
         def_terse_rule(:thing_updated)
         def_terse_rule(:thing_removed)
         def_terse_rule(:updated)
-        def_terse_rule(:on_start)
       end
     end
   end

data/lib/openhab/dsl/rules/triggers/conditions/duration.rb

@@ -96,7 +96,7 @@ module OpenHAB
                 yield
               end
               rule.on_removal(self)
-              @tracking_to, = retrieve_states(inputs)
+              _, @tracking_from = retrieve_states(inputs)
             end
 
             #
@@ -106,12 +106,11 @@ module OpenHAB
             # @param [Hash] mod rule trigger mods
             #
             def process_active_timer(inputs, mod, &block)
-              state, = retrieve_states(inputs)
-              if state == @tracking_to
-                logger.trace("Item changed to #{state} for #{self}, rescheduling timer.")
-                @timer.reschedule(@duration)
+              new_state, old_state = retrieve_states(inputs)
+              if new_state != @tracking_from && @conditions.check_to(inputs: {})
+                logger.trace("Item changed from #{old_state} to #{new_state} for #{self}, keep waiting.")
               else
-                logger.trace("Item changed to #{state} for #{self}, canceling timer.")
+                logger.trace("Item changed from #{old_state} to #{new_state} for #{self}, canceling timer.")
                 @timer.cancel
                 # Reprocess trigger delay after canceling to track new state (if guards matched, etc)
                 process(mod: mod, inputs: inputs, &block)

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

@@ -186,6 +186,7 @@ module OpenHAB
           #
           #
           def trigger(config:, attach:)
+            CronHandler::CronTriggerHandlerFactory.instance # ensure it's registered
             append_trigger(type: CRON_TRIGGER_MODULE_ID, config: config, attach: attach)
           end
         end

data/lib/openhab/dsl/rules/triggers/cron/cron_handler.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "singleton"
+
 require_relative "cron"
 
 module OpenHAB
@@ -77,49 +79,35 @@ module OpenHAB
 
           # Implements the ScriptedTriggerHandlerFactory interface to create a new Cron Trigger Handler
           class CronTriggerHandlerFactory
+            include Singleton
             include org.openhab.core.automation.module.script.rulesupport.shared.factories.ScriptedTriggerHandlerFactory
 
-            # Invoked by openHAB core to get a trigger handler for the supllied trigger
-            # @param [org.openhab.core.automation.Trigger] trigger
-            #
-            # @return [WatchTriggerHandler] trigger handler for supplied trigger
-            def get(trigger)
-              CronTriggerHandler.new(trigger)
-            end
-          end
-
-          class << self
-            private
-
-            #
-            # Creates trigger types and trigger type factories for openHAB
-            #
-            def add_script_cron_handler
+            def initialize
               Core.automation_manager.add_trigger_handler(
                 Cron::CRON_TRIGGER_MODULE_ID,
-                CronTriggerHandlerFactory.new
+                self
               )
 
-              Core.automation_manager.add_trigger_type(cron_trigger_type)
+              Core.automation_manager.add_trigger_type(org.openhab.core.automation.type.TriggerType.new(
+                                                         Cron::CRON_TRIGGER_MODULE_ID,
+                                                         nil,
+                                                         "A specific instant occurs",
+                                                         "Triggers when the specified instant occurs",
+                                                         nil,
+                                                         org.openhab.core.automation.Visibility::VISIBLE,
+                                                         nil
+                                                       ))
               logger.trace("Added script cron trigger handler")
             end
 
+            # Invoked by openHAB core to get a trigger handler for the supplied trigger
+            # @param [org.openhab.core.automation.Trigger] trigger
             #
-            # Creates trigger types and trigger type factories for openHAB
-            #
-            def cron_trigger_type
-              org.openhab.core.automation.type.TriggerType.new(
-                Cron::CRON_TRIGGER_MODULE_ID,
-                nil,
-                "A specific instant occurs",
-                "Triggers when the specified instant occurs",
-                nil,
-                org.openhab.core.automation.Visibility::VISIBLE,
-                nil
-              )
+            # @return [WatchTriggerHandler] trigger handler for supplied trigger
+            def get(trigger)
+              CronTriggerHandler.new(trigger)
             end
           end
-          add_script_cron_handler
         end
       end
     end

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

@@ -44,6 +44,7 @@ module OpenHAB
           #
           #
           def trigger(config:, attach:)
+            WatchHandler::WatchTriggerHandlerFactory.instance # ensure it's registered
             append_trigger(type: WatchHandler::WATCH_TRIGGER_MODULE_ID,
                            config: config,
                            attach: attach)

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "singleton"
+
 module OpenHAB
   module DSL
     module Rules
@@ -9,21 +11,6 @@ module OpenHAB
         # Module for watching directories/files
         #
         module WatchHandler
-          #
-          # Creates trigger types and trigger type factories for openHAB
-          #
-          private_class_method def self.watch_trigger_type
-            org.openhab.core.automation.type.TriggerType.new(
-              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
-
           # Trigger ID for Watch Triggers
           WATCH_TRIGGER_MODULE_ID = "jsr223.jruby.WatchTrigger"
 
@@ -68,7 +55,7 @@ module OpenHAB
             # 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
+            # @param [java.nio.file.Path] path that had an event
             def processWatchEvent(_event, kind, path)
               @block.call(Events::WatchEvent.new(EVENT_TO_SYMBOL[kind], Pathname.new(path.to_s)))
             end
@@ -123,8 +110,27 @@ module OpenHAB
 
           # Implements the ScriptedTriggerHandlerFactory interface to create a new Trigger Handler
           class WatchTriggerHandlerFactory
+            include Singleton
             include org.openhab.core.automation.module.script.rulesupport.shared.factories.ScriptedTriggerHandlerFactory
 
+            def initialize
+              Core.automation_manager.add_trigger_handler(
+                WATCH_TRIGGER_MODULE_ID,
+                self
+              )
+
+              Core.automation_manager.add_trigger_type(org.openhab.core.automation.type.TriggerType.new(
+                                                         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
+                                                       ))
+              logger.trace("Added watch trigger handler")
+            end
+
             # Invoked by openHAB core to get a trigger handler for the supllied trigger
             # @param [org.openhab.core.automation.Trigger] trigger
             #
@@ -133,20 +139,6 @@ module OpenHAB
               WatchTriggerHandler.new(trigger)
             end
           end
-
-          #
-          # Creates trigger types and trigger type factories for openHAB
-          #
-          def self.add_watch_handler
-            Core.automation_manager.add_trigger_handler(
-              WATCH_TRIGGER_MODULE_ID,
-              WatchTriggerHandlerFactory.new
-            )
-
-            Core.automation_manager.add_trigger_type(watch_trigger_type)
-            logger.trace("Added watch trigger handler")
-          end
-          add_watch_handler
         end
       end
     end

data/lib/openhab/dsl/things/builder.rb

@@ -37,7 +37,7 @@ module OpenHAB
       # @see Items::Builder
       #
       class Builder
-        # @return [org.openhab.core.things.ManagedThingProvider]
+        # @return [org.openhab.core.thing.ManagedThingProvider]
         attr_reader :provider
 
         def initialize(provider)

data/lib/openhab/dsl/thread_local.rb

@@ -12,6 +12,7 @@ module OpenHAB
       # Keys to persist
       KNOWN_KEYS = %i[
         openhab_ensure_states
+        openhab_holiday_file
         openhab_persistence_service
         openhab_providers
         openhab_rule_uid

data/lib/openhab/dsl/version.rb

@@ -4,6 +4,6 @@ module OpenHAB
   module DSL
     # Version of openHAB helper libraries
     # @return [String]
-    VERSION = "5.0.0.rc9"
+    VERSION = "5.0.0.rc11"
   end
 end