openhab-scripting 2.15.0 → 2.16.4

data/lib/openhab/core/dsl/monkey_patch/items/switch_item.rb

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-java_import org.openhab.core.library.items.SwitchItem
-
-# Alias class names for easy is_a? comparisons
-Switch = SwitchItem
-
-#
-# Monkeypatching SwitchItem to add Ruby Support methods
-#
-# rubocop:disable Style/ClassAndModuleChildren
-class Java::OrgOpenhabCoreLibraryItems::SwitchItem
-  java_import org.openhab.core.library.types.OnOffType
-  # rubocop:enable Style/ClassAndModuleChildren
-
-  #
-  # Send the OFF command to the switch
-  #
-  #
-  def off
-    command(OnOffType::OFF)
-  end
-
-  #
-  # Send the OFF command to the switch
-  #
-  #
-  def on
-    command(OnOffType::ON)
-  end
-
-  #
-  # Check if a switch is on
-  #
-  # @return [Boolean] True if the switch is on, false otherwise
-  #
-  def on?
-    state? && state == OnOffType::ON
-  end
-
-  alias truthy? on?
-
-  #
-  # Check if a switch is off
-  #
-  # @return [Boolean] True if the switch is off, false otherwise
-  #
-  def off?
-    state? && state == OnOffType::OFF
-  end
-
-  #
-  # Send a command to invert the state of the switch
-  #
-  # @return [OnOffType] Inverted state
-  #
-  def toggle
-    self << !self
-  end
-
-  #
-  # Return the inverted state of the switch: ON if the switch is OFF, UNDEF or NULL; OFF if the switch is ON
-  #
-  # @return [OnOffType] Inverted state
-  #
-  def !
-    return !state if state?
-
-    OnOffType::ON
-  end
-
-  #
-  # Check for equality against supplied object
-  #
-  # @param [Object] other object to compare to
-  #
-  # @return [Boolean] True if other is a OnOffType and other equals state for this switch item,
-  #   otherwise result from super
-  #
-  def ==(other)
-    if other.is_a? OnOffType
-      state? && state == other
-    else
-      super
-    end
-  end
-end

data/lib/openhab/core/dsl/monkey_patch/ruby/number.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module Core
-    module DSL
-      module MonkeyPatch
-        module Ruby
-          #
-          # Extend integer to create duration object
-          #
-          module IntegerExtensions
-            include OpenHAB::Core
-
-            #
-            # Create Duration with the specified unit
-            #
-            # @return [Java::JavaTime::Duration] Duration with number of units from self
-            #
-            %w[millis seconds minutes hours].each do |unit|
-              define_method(unit) { Java::JavaTime::Duration.public_send("of_#{unit}", self) }
-            end
-
-            alias second seconds
-            alias millisecond millis
-            alias milliseconds millis
-            alias ms millis
-            alias minute minutes
-            alias hour hours
-          end
-        end
-      end
-    end
-  end
-end
-
-#
-# Prepend Integer class with duration extensions
-#
-class Integer
-  prepend OpenHAB::Core::DSL::MonkeyPatch::Ruby::IntegerExtensions
-end

data/lib/openhab/core/dsl/monkey_patch/ruby/range.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-
-# Monkey patch range to support case equality of OpenHab "Numeric" Objects
-
-module OpenHAB
-  module Core
-    module DSL
-      #
-      # MonkeyPatch both Ruby and OpenHAB Objects to support DSL
-      #
-      module MonkeyPatch
-        #
-        # MonkeyPatch ruby object to support DSL
-        #
-        module Ruby
-          #
-          # Extensions for Range Class to support DimmerItems
-          #
-          module RangeExtensions
-            #
-            # Override range === method to support DimmerItems
-            #
-            # @param [Object] other object to compare for case equals
-            #
-            # @return [Boolean] if other is DimmerItem and state is covered by range,
-            #   result from parent Range class if not DimmerItem
-            #
-            def ===(other)
-              return super unless other.is_a? DimmerItem
-
-              cover? other.state.to_i
-            end
-          end
-        end
-      end
-    end
-  end
-end
-
-#
-# Prepend Range class with RangeExtensions
-#
-class Range
-  prepend OpenHAB::Core::DSL::MonkeyPatch::Ruby::RangeExtensions
-end

data/lib/openhab/core/dsl/monkey_patch/ruby/ruby.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-# Monkey patch ruby
-require 'openhab/core/dsl/monkey_patch/ruby/range'
-require 'openhab/core/dsl/monkey_patch/ruby/number'
-require 'bigdecimal/util'

data/lib/openhab/core/dsl/monkey_patch/types/decimal_type.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-
-#
-# MonkeyPatching Decimal Type
-#
-# rubocop:disable Style/ClassAndModuleChildren
-class Java::OrgOpenhabCoreLibraryTypes::DecimalType
-  # rubocop:enable Style/ClassAndModuleChildren
-
-  #
-  # Compare self to other using Java BigDecimal compare method
-  #
-  # @param [Object] other object to compare to
-  #
-  # @return [Boolean] True if have the same BigDecimal representation, false otherwise
-  #
-  def ==(other)
-    return equals(other) unless other.is_a? Integer
-
-    to_big_decimal.compare_to(Java::JavaMath::BigDecimal.new(other)).zero?
-  end
-end

data/lib/openhab/core/dsl/monkey_patch/types/on_off_type.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-
-#
-# Monkey patching OnOffType
-#
-# rubocop:disable Style/ClassAndModuleChildren
-class Java::OrgOpenhabCoreLibraryTypes::OnOffType
-  # rubocop:enable Style/ClassAndModuleChildren
-
-  #
-  # Invert the type
-  #
-  # @return [Java::OrgOpenhabCoreLibraryTypes::OnOffType] OFF if ON, ON if OFF
-  #
-  def !
-    return OFF if self == ON
-    return ON if self == OFF
-  end
-
-  # Check if the supplied object is case equals to self
-  #
-  # @param [Object] other object to compare
-  #
-  # @return [Boolean] True if the other object responds to on?/off? and is in the same state as this object,
-  #  nil if object cannot be compared
-  #
-  def ===(other)
-    # A case statement here causes and infinite loop
-    # rubocop:disable Style/CaseLikeIf
-    if self == ON
-      other.on? if other.respond_to? :on?
-    elsif self == OFF
-      other.off? if other.respond_to?('off?')
-    else
-      false
-    end
-    # rubocop:enable Style/CaseLikeIf
-  end
-end

data/lib/openhab/core/dsl/monkey_patch/types/open_closed_type.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-
-#
-# Monkey patch for DSL use
-#
-# rubocop:disable Style/ClassAndModuleChildren
-class Java::OrgOpenhabCoreLibraryTypes::OpenClosedType
-  # rubocop:enable Style/ClassAndModuleChildren
-  java_import org.openhab.core.library.items.ContactItem
-
-  #
-  # Check if the supplied object is case equals to self
-  #
-  # @param [Object] other object to compare
-  #
-  # @return [Boolean] True if the other object is a ContactItem and has the same state
-  #
-  def ===(other)
-    super unless other.is_a? ContactItem
-
-    self == other.state
-  end
-end

data/lib/openhab/core/dsl/monkey_patch/types/percent_type.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-
-#
-# MonkeyPatching PercentType
-#
-# rubocop:disable Style/ClassAndModuleChildren
-class Java::OrgOpenhabCoreLibraryTypes::PercentType
-  # rubocop:enable Style/ClassAndModuleChildren
-
-  #
-  # Need to override and point to super because default JRuby implementation doesn't point to == of parent class
-  #
-  # @param [Object] other object to check equality for
-  # @return [Boolean] True if other equals self, false otherwise
-  #
-  # rubocop:disable Lint/UselessMethodDefinition
-  def ==(other)
-    super
-  end
-  # rubocop:enable Lint/UselessMethodDefinition
-end

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

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-# Monkey patch types
-require 'core/dsl/monkey_patch/types/open_closed_type'
-require 'core/dsl/monkey_patch/types/on_off_type'
-require 'core/dsl/monkey_patch/types/decimal_type'
-require 'core/dsl/monkey_patch/types/percent_type'

data/lib/openhab/core/dsl/persistence.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module Core
-    module DSL
-      #
-      # Provides support for interacting with OpenHAB Persistence service
-      #
-      module Persistence
-        #
-        # Sets a thread local variable to set the default persistence service
-        # for method calls inside the block
-        #
-        # @param [Object] Persistence service either as a String or a Symbol
-        # @yield [] Block executed in context of the supplied persistence service
-        #
-        #
-        def persistence(service)
-          Thread.current.thread_variable_set(:persistence_service, service)
-          yield
-        ensure
-          Thread.current.thread_variable_set(:persistence_service, nil)
-        end
-      end
-    end
-  end
-end

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

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-require 'core/log'
-
-#
-# Provides methods to support DSL properties
-#
-module DSLProperty
-  include Logging
-
-  #
-  # Extend the calling object with the property methods
-  #
-  # @param [Object] base object to extend
-  #
-  #
-  def self.included(base)
-    base.extend PropertyMethods
-  end
-
-  #
-  # Methods that support creating properties in the DSL
-  #
-  module PropertyMethods
-    #
-    # Dynamically creates a property that acts and an accessor with no arguments
-    # and a setter with any number of arguments or a block.
-    #
-    # @param [String] name of the property
-    #
-    #
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/PerceivedComplexity
-    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
-      #   in this module than instance variable belong to the module not the calling class
-      define_method(name) do |*args, &block|
-        if args.length.zero? && block.nil? == true
-          instance_variable_get("@#{name}")
-        else
-          logger.trace("Property '#{name}' called with args(#{args}) and block(#{block})")
-          if args.length == 1
-            instance_variable_set("@#{name}", args.first)
-          elsif args.length > 1
-            instance_variable_set("@#{name}", args)
-          elsif block
-            instance_variable_set("@#{name}", block)
-          end
-        end
-      end
-    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
-    # 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
-    # @param [String] array_name name of the array to use, defaults to name of property
-    # @param [Class] wrapper object to put around elements added to the array
-    #
-    def prop_array(name, array_name: nil, wrapper: nil)
-      define_method(name) do |*args, &block|
-        array_name ||= name
-        if args.length.zero? && block.nil? == true
-          instance_variable_get("@#{array_name}")
-        else
-          logger.trace("Property '#{name}' called with args(#{args}) and block(#{block})")
-          if args.length == 1
-            insert = args.first
-          elsif args.length > 1
-            insert = args
-          elsif block
-            insert = block
-          end
-          yield insert if block_given?
-          insert = wrapper.new(insert) if wrapper
-          instance_variable_set("@#{array_name}", (instance_variable_get("@#{array_name}") || []) << insert)
-        end
-      end
-
-      return unless array_name
-
-      define_method(array_name) do
-        instance_variable_get("@#{array_name}")
-      end
-    end
-  end
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/CyclomaticComplexity
-  # rubocop:enable Metrics/PerceivedComplexity
-end

data/lib/openhab/core/dsl/rule/automation_rule.rb

@@ -1,348 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-
-module OpenHAB
-  module Core
-    module DSL
-      #
-      # Creates and manages OpenHAB Rules
-      #
-      module Rule
-        #
-        # JRuby extension to OpenHAB Rule
-        #
-        # rubocop: disable Metrics/ClassLength
-        # Disabled because this class has a single responsibility, there does not appear a logical
-        # way of breaking it up into multiple classes
-        class AutomationRule < Java::OrgOpenhabCoreAutomationModuleScriptRulesupportSharedSimple::SimpleRule
-          include Logging
-          include OpenHAB::Core::DSL::Tod
-          java_import java.time.ZonedDateTime
-
-          #
-          # Create a new Rule
-          #
-          # @param [Config] config Rule configuration
-          #
-          def initialize(config:)
-            super()
-            set_name(config.name)
-            set_description(config.description)
-            set_triggers(config.triggers)
-            @run_queue = config.run
-            @guard = config.guard
-            between = config.between&.yield_self { between(config.between) }
-            @between = between || OpenHAB::Core::DSL::Tod::ALL_DAY
-            # Convert between to correct range or nil if not set
-            @trigger_delays = config.trigger_delays
-          end
-
-          #
-          # Execute the rule
-          #
-          # @param [Map] mod map provided by OpenHAB rules engine
-          # @param [Map] inputs map provided by OpenHAB rules engine containing event and other information
-          #
-          #
-          def execute(mod = nil, inputs = nil)
-            logger.trace { "Execute called with mod (#{mod&.to_string}) and inputs (#{inputs&.pretty_inspect}" }
-            logger.trace { "Event details #{inputs['event'].pretty_inspect}" } if inputs&.key?('event')
-            if trigger_delay inputs
-              trigger_delay = trigger_delay(inputs)
-              process_trigger_delay(trigger_delay, mod, inputs)
-            else
-              # If guards are satisfied execute the run type blocks
-              # If they are not satisfied, execute the Othewise blocks
-              queue = create_queue(inputs)
-              process_queue(queue, mod, inputs)
-            end
-          end
-
-          private
-
-          #
-          # Create the run queue based on guards
-          #
-          # @param [Map] inputs rule inputs
-          #
-          # @return [Queue] <description>
-          #
-          def create_queue(inputs)
-            case check_guards(event: inputs&.dig('event'))
-            when true
-              @run_queue.dup
-            when false
-              @run_queue.dup.grep(RuleConfig::Otherwise)
-            end
-          end
-
-          #
-          # Returns trigger delay from inputs if it exists
-          #
-          # @param [Map] inputs map from OpenHAB containing UID
-          #
-          # @return [Array] Array of trigger delays that match rule UID
-          #
-          def trigger_delay(inputs)
-            # Parse this to get the trigger UID:
-            # ["72698819-83cb-498a-8e61-5aab8b812623.event", "oldState", "module", \
-            #  "72698819-83cb-498a-8e61-5aab8b812623.oldState", "event", "newState",\
-            #  "72698819-83cb-498a-8e61-5aab8b812623.newState"]
-            @trigger_delays[inputs&.keys&.grep(/\.event$/)&.first&.chomp('.event')]
-          end
-
-          #
-          # Check if trigger guards prevent rule execution
-          #
-          # @param [Delay] trigger_delay rules delaying trigger because of
-          # @param [Map] inputs OpenHAB map object describing rule trigger
-          #
-          # @return [Boolean] True if the rule should execute, false if trigger guard prevents execution
-          #
-          def check_trigger_guards(trigger_delay, inputs)
-            old_state = inputs['oldState']
-            new_state = inputs['newState']
-            if check_from(trigger_delay, old_state)
-              return true if check_to(trigger_delay, new_state)
-
-              logger.trace("Skipped execution of rule '#{name}' because to state #{new_state}"\
-                                   " does not equal specified state(#{trigger_delay.to})")
-            else
-              logger.trace("Skipped execution of rule '#{name}' because old state #{old_state}"\
-                                   " does not equal specified state(#{trigger_delay.from})")
-            end
-          end
-
-          #
-          # Check the from state against the trigger delay
-          #
-          # @param [TriggerDelay] trigger_delay Information about the trigger delay
-          # @param [Item State] state from state to check
-          #
-          # @return [Boolean] true if no from state is defined or defined state equals supplied state
-          #
-          def check_from(trigger_delay, state)
-            trigger_delay.from.nil? || trigger_delay.from == state
-          end
-
-          #
-          # Check the to state against the trigger delay
-          #
-          # @param [TriggerDelay] trigger_delay Information about the trigger delay
-          # @param [Item State] state to-state to check
-          #
-          # @return [Boolean] true if no to state is defined or defined state equals supplied state
-          #
-          def check_to(trigger_delay, state)
-            trigger_delay.to.nil? || trigger_delay.to == state
-          end
-
-          #
-          # Process any matching trigger delays
-          #
-          # @param [Map] mod OpenHAB map object describing rule trigger
-          # @param [Map] inputs OpenHAB map object describing rule trigger
-          #
-          #
-          def process_trigger_delay(trigger_delay, mod, inputs)
-            if check_trigger_guards(trigger_delay, inputs)
-              logger.trace("Trigger Guards Matched for #{trigger_delay}, delaying rule execution")
-              # Add timer and attach timer to delay object, and also state being tracked to so timer can be cancelled if
-              #   state changes
-              # Also another timer should not be created if changed to same value again but instead rescheduled
-              if trigger_delay.timer_active?
-                process_active_timer(inputs, mod, trigger_delay)
-              else
-                create_trigger_delay_timer(inputs, mod, trigger_delay)
-              end
-            else
-              logger.trace("Trigger Guards did not match for #{trigger_delay}, ignoring trigger.")
-            end
-          end
-
-          #
-          # Creatas a timer for trigger delays
-          #
-          # @param [Hash] inputs rule trigger inputs
-          # @param [Hash] mod rule trigger mods
-          # @param [TriggerDelay] trigger_delay specifications
-          #
-          #
-          def create_trigger_delay_timer(inputs, mod, trigger_delay)
-            logger.trace("Creating timer for rule #{name} and trigger delay #{trigger_delay}")
-            trigger_delay.timer = after(trigger_delay.duration) do
-              logger.trace("Delay Complete for #{trigger_delay}, executing rule")
-              trigger_delay.timer = nil
-              process_queue(@run_queue.dup, mod, inputs)
-            end
-            trigger_delay.tracking_to = inputs['newState']
-          end
-
-          #
-          # Process an active trigger timer
-          #
-          # @param [Hash] inputs rule trigger inputs
-          # @param [Hash] mod rule trigger mods
-          # @param [TriggerDelay] trigger_delay specifications
-          #
-          #
-          def process_active_timer(inputs, mod, trigger_delay)
-            state = inputs['newState']
-            if state == trigger_delay.tracking_to
-              logger.trace("Item changed to #{state} for #{trigger_delay}, rescheduling timer.")
-              trigger_delay.timer.reschedule(ZonedDateTime.now.plus(duration))
-            else
-              logger.trace("Item changed to #{state} for #{trigger_delay}, cancelling timer.")
-              trigger_delay.timer.cancel
-              # Reprocess trigger delay after cancelling to track new state (if guards matched, etc)
-              process_trigger_delay(trigger_delay, mod, inputs)
-            end
-          end
-
-          #
-          # Check if any guards prevent execution
-          #
-          # @param [Map] event OpenHAB rule trigger event
-          #
-          # @return [Boolean] True if guards says rule should execute, false otherwise
-          #
-          def check_guards(event:)
-            if @guard.should_run? event
-              now = TimeOfDay.now
-              return true if @between.cover? now
-
-              logger.trace("Skipped execution of rule '#{name}' because the current time #{now} "\
-                                   "is not between #{@between.begin} and #{@between.end}")
-            else
-              logger.trace("Skipped execution of rule '#{name}' because of guard #{@guard}")
-            end
-            false
-          end
-
-          #
-          # Patch event to include event.item when it doesn't exist
-          # This is to patch a bug see https://github.com/boc-tothefuture/openhab-jruby/issues/75
-          # It may be fixed in the openhab core in the future, in which case, this patch will no longer be necessary
-          #
-          # @param [OpenHAB Event] event to check for item accessor
-          # @param [OpenHAB Event Inputs] inputs inputs to running rule
-          #
-          def add_event_item(event, inputs)
-            return if event.nil? || defined?(event.item)
-
-            class << event
-              attr_accessor :item
-            end
-            event.item = inputs&.dig('triggeringItem')
-          end
-
-          #
-          # Process the run queue
-          #
-          # @param [Array] run_queue array of procs of various types to execute
-          # @param [Map] mod OpenHAB map object describing rule trigger
-          # @param [Map] inputs OpenHAB map object describing rule trigge
-          #
-          #
-          def process_queue(run_queue, mod, inputs)
-            event = inputs&.dig('event')
-
-            while (task = run_queue.shift)
-              case task
-              when RuleConfig::Run then process_run_task(event, inputs, task)
-              when RuleConfig::Trigger then process_trigger_task(event, task)
-              when RuleConfig::Delay then process_delay_task(inputs, mod, run_queue, task)
-              when RuleConfig::Otherwise then process_otherwise_task(event, task)
-              end
-            end
-          end
-
-          #
-          # Process an otherwise block
-          #
-          # @param [OpenHab Event] event that triggered the rule
-          # @param [Task] task task containing otherwise block to execute
-          #
-          #
-          def process_otherwise_task(event, task)
-            logger.trace { "Executing rule '#{name}' otherwise block with event(#{event})" }
-            task.block.call(event)
-          end
-
-          #
-          # Process delay task
-          #
-          # @param [Map] inputs Rule trigger inputs
-          # @param [Map] mod Rule modes
-          # @param [Queue] run_queue Queue of tasks for this rule
-          # @param [Delay] task to process
-          #
-          #
-          def process_delay_task(inputs, mod, run_queue, task)
-            remaining_queue = run_queue.slice!(0, run_queue.length)
-            after(task.duration) { process_queue(remaining_queue, mod, inputs) }
-          end
-
-          #
-          # Process a task that is caused by a group item
-          #
-          # @param [Map] event Rule event map
-          # @param [Trigger] task to execute
-          #
-          #
-          def process_trigger_task(event, task)
-            # rubocop: disable Style/GlobalVars
-            triggering_item = $ir.get(event&.itemName)
-            # rubocop: enable Style/GlobalVars
-            logger.trace { "Executing rule '#{name}' trigger block with item (#{triggering_item})" }
-            task.block.call(triggering_item) if triggering_item
-          end
-
-          #
-          # Process a run task
-          #
-          # @param [OpenHab Event] event information
-          # @param [Map] inputs of rule trigger information
-          # @param [Run] task to execute
-          #
-          #
-          def process_run_task(event, inputs, task)
-            add_event_item(event, inputs)
-            logger.trace { "Executing rule '#{name}' run block with event(#{event})" }
-            task.block.call(event)
-          end
-
-          #
-          # Create a new hash in which all elements are converted to strings
-          #
-          # @param [Map] hash in which all elements should be converted to strings
-          #
-          # @return [Map] new map with values converted to strings
-          #
-          def inspect_hash(hash)
-            hash.each_with_object({}) do |(key, value), new_hash|
-              new_hash[inspect_item(key)] = inspect_item(value)
-            end
-          end
-
-          #
-          # Convert an individual element into a string based on if it a Ruby or Java object
-          #
-          # @param [Object] item to convert to a string
-          #
-          # @return [String] representation of item
-          #
-          def inspect_item(item)
-            if item.respond_to? :to_string
-              item.to_string
-            elsif item.respond_to? :to_str
-              item.to_str
-            end
-          end
-        end
-      end
-    end
-  end
-end
-# rubocop: enable Metrics/ClassLength