openhab-scripting 4.46.2 → 5.0.0

data/lib/openhab/dsl/monkey_patch/java/local_time.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'time_extensions'
-
-module OpenHAB
-  module DSL
-    # monkey patches
-    module MonkeyPatch
-      # extensions to Java objects
-      module JavaExtensions
-        #
-        # Extend LocalTime class to support arithmetic operators
-        #
-        module LocalTimeExtensions
-          include TimeExtensions
-          include OpenHAB::Log
-
-          # apply meta-programming methods to prepending class
-          # @!visibility private
-          def self.prepended(klass)
-            # remove the JRuby default == so that we can inherit the Ruby method
-            klass.remove_method :==
-          end
-
-          #
-          # Comparison
-          #
-          # @param [LocalTime,TimeOfDay] other object to compare to
-          #
-          # @return [Integer] -1, 0, +1 depending on whether +other+ is
-          #   less than, equal to, or greater than self
-          #
-          def compare_to(other)
-            logger.trace("(#{self.class}) #{self} compare_to #{other} (#{other.class})")
-            other = other.local_time if other.is_a?(TimeOfDay)
-            super
-          end
-        end
-      end
-    end
-  end
-end
-
-java.time.LocalTime.prepend(OpenHAB::DSL::MonkeyPatch::JavaExtensions::LocalTimeExtensions)

data/lib/openhab/dsl/monkey_patch/java/time_extensions.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module DSL
-    # monkey patches
-    module MonkeyPatch
-      # Extensions to Java objects
-      module JavaExtensions
-        # Common extensions to Java date/time classes
-        module TimeExtensions
-          #
-          # Add other TemporalAmount or Duration object
-          #
-          # @param [TemporalAmount] other the TemporalAmount to be added to this ZonedDateTime object
-          #
-          # @return [ZonedDateTime] The resulting ZonedDateTime object after adding {other}
-          #
-          def +(other)
-            plus(other)
-          end
-
-          #
-          # Subtract other TemporalAmount or Duration object
-          #
-          # @param [TemporalAmount] other the TemporalAmount to be subtracted from this ZonedDateTime object
-          #
-          # @return [ZonedDateTime] The resulting ZonedDateTime object after subtracting {other}
-          #
-          def -(other)
-            minus(other)
-          end
-
-          #
-          # Compare against another time object
-          #
-          # @param [Object] other The other time object to compare against.
-          #
-          # @return [Integer] -1, 0, +1 depending on whether +other+ is
-          #   less than, equal to, or greater than self
-          #
-          def <=>(other)
-            compare_to(other)
-          rescue StandardError
-            nil
-          end
-        end
-      end
-    end
-  end
-end

data/lib/openhab/dsl/monkey_patch/java/zoned_date_time.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'time_extensions'
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Extends the functionalities of Java classes
-      #
-      module JavaExtensions
-        #
-        # Extend ZonedDateTime class to support arithmetic operators
-        #
-        module ZonedDateTimeExtensions
-          include TimeExtensions
-          include OpenHAB::Log
-
-          # apply meta-programming methods to prepending class
-          # @!visibility private
-          def self.prepended(klass)
-            # remove the JRuby default == so that we can inherit the Ruby method
-            klass.remove_method :==
-          end
-
-          #
-          # Comparison
-          #
-          # @param [ZonedDateTime,Time] other object to compare to
-          #
-          # @return [Integer] -1, 0, +1 depending on whether +other+ is
-          #   less than, equal to, or greater than self
-          #
-          def compare_to(other)
-            logger.trace("(#{self.class}) #{self} compare_to #{other} (#{other.class})")
-            other = other.to_java(ZonedDateTime) if other.is_a? Time
-            super
-          end
-        end
-      end
-    end
-  end
-end
-
-ZonedDateTime.prepend(OpenHAB::DSL::MonkeyPatch::JavaExtensions::ZonedDateTimeExtensions)

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

@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      module Ruby
-        #
-        # Extend integer to create duration object
-        #
-        module IntegerExtensions
-          #
-          # Create Duration with the specified unit
-          #
-          # @return [java.time.Duration] Duration with number of units from self
-          #
-          %w[millis seconds minutes hours].each do |unit|
-            define_method(unit) { java.time.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
-
-        #
-        # Extend float to create duration object
-        #
-        module FloatExtensions
-          #
-          # Create Duration with number of milliseconds
-          #
-          # @return [java.time.Duration] Duration truncated to an integral number of milliseconds from self
-          #
-          def millis
-            java.time.Duration.of_millis(to_i)
-          end
-
-          #
-          # Create Duration with number of seconds
-          #
-          # @return [java.time.Duration] Duration with number of seconds from self
-          #
-          def seconds
-            (self * 1000).millis
-          end
-
-          #
-          # Create Duration with number of minutes
-          #
-          # @return [java.time.Duration] Duration with number of minutes from self
-          #
-          def minutes
-            (self * 60).seconds
-          end
-
-          #
-          # Create Duration with number of hours
-          #
-          # @return [java.time.Duration] Duration with number of hours from self
-          #
-          def hours
-            (self * 60).minutes
-          end
-
-          alias second seconds
-          alias millisecond millis
-          alias milliseconds millis
-          alias ms millis
-          alias minute minutes
-          alias hour hours
-        end
-
-        #
-        # Extend numeric to create quantity object
-        #
-        module NumericExtensions
-          #
-          # Convert Numeric to a QuantityType
-          #
-          # @param [Object] other String or Unit representing an OpenHAB Unit
-          #
-          # @return [Types::QuantityType] +self+ as a {Types::QuantityType} of the supplied Unit
-          #
-          def |(other)
-            other = org.openhab.core.types.util.UnitUtils.parse_unit(other.to_str) if other.respond_to?(:to_str)
-
-            return super unless other.is_a?(javax.measure.Unit)
-
-            Types::QuantityType.new(to_d.to_java, other)
-          end
-        end
-      end
-    end
-  end
-end
-
-Integer.prepend(OpenHAB::DSL::MonkeyPatch::Ruby::IntegerExtensions)
-Float.prepend(OpenHAB::DSL::MonkeyPatch::Ruby::FloatExtensions)
-Numeric.include(OpenHAB::DSL::MonkeyPatch::Ruby::NumericExtensions)
-# Integer already has #|, so we have to prepend it here
-Integer.prepend(OpenHAB::DSL::MonkeyPatch::Ruby::NumericExtensions)

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

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'number'
-require_relative 'string'
-require_relative 'time'
-require 'bigdecimal/util'

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

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require 'openhab/dsl/time/time_of_day'
-
-module OpenHAB
-  module DSL
-    # monkey patches
-    module MonkeyPatch
-      # extensions to core Ruby objects
-      module Ruby
-        # extend String class so that it will do semantic comparisons against
-        # DateTimeType and QuantityType, instead of converting the latter to
-        # String and doing an exact match
-        module StringExtensions
-          # {include:StringExtensions}
-          def ==(other)
-            case other
-            when Types::QuantityType,
-              Types::DateTimeType,
-              Items::DateTimeItem,
-              Items::NumericItem,
-              Between::TimeOfDay
-              other == self
-            else
-              super
-            end
-          end
-
-          # {include:StringExtensions}
-          def <=>(other)
-            case other
-            when Types::QuantityType,
-              Types::DateTimeType,
-              Items::DateTimeItem,
-              Items::NumericItem
-              (other <=> self)&.-@()
-            else
-              super
-            end
-          end
-        end
-      end
-    end
-  end
-end
-
-String.prepend(OpenHAB::DSL::MonkeyPatch::Ruby::StringExtensions)

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

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      module Ruby
-        # Extend Time class to allow adding/subtracting against Duration
-        module TimeExtensions
-          #
-          # Add time offset
-          #
-          # @param [Numeric,Duration] other The offset to add
-          #
-          # @return [Time] The resulting time after adding the given offset
-          #
-          def +(other)
-            other = to_seconds(other)
-            super
-          end
-
-          #
-          # Subtract time offset
-          #
-          # @param [Numeric,Duration] other The offset to subtract
-          #
-          # @return [Time] The resulting time after subtracting the given offset
-          #
-          def -(other)
-            other = to_seconds(other)
-            super
-          end
-
-          #
-          # Convert to ZonedDateTime
-          #
-          # @return [ZonedDateTime] The current time object converted to ZonedDateTime
-          #
-          def to_zdt
-            to_java(ZonedDateTime)
-          end
-
-          private
-
-          #
-          # Convert to floating point seconds if the given value reponds to to_nanos
-          #
-          # @param [Numeric,Duration] value The duration to convert into seconds.
-          #
-          # @return [Numeric] The number of seconds from the given value
-          #
-          def to_seconds(value)
-            value = value.to_nanos.to_f / 1_000_000_000 if value.respond_to? :to_nanos
-            value
-          end
-        end
-      end
-    end
-  end
-end
-
-Time.prepend(OpenHAB::DSL::MonkeyPatch::Ruby::TimeExtensions)

data/lib/openhab/dsl/openhab.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require 'pathname'
-
-module OpenHAB
-  #
-  # Return the OpenHAB conf directory as a ruby pathname
-  #
-  # @return [Pathname] OpenHAB conf path
-  #
-  def self.conf_root
-    Pathname.new(ENV.fetch('OPENHAB_CONF', nil))
-  end
-
-  module DSL
-    #
-    # Provides access to OpenHAB attributes
-    #
-    module Core
-      include OpenHAB::Log
-
-      module_function
-
-      # @deprecated Please use {OpenHAB.conf_root} instead
-      def __conf__
-        OpenHAB.conf_root
-      end
-    end
-  end
-end

data/lib/openhab/dsl/persistence.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module DSL
-    #
-    # Provides support for interacting with OpenHAB Persistence service
-    #
-    module Persistence
-      module_function
-
-      #
-      # Sets a thread local variable to set the default persistence service
-      # for method calls inside the block
-      #
-      # @param [Object] service 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

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

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module DSL
-    module Rules
-      #
-      # Extends OpenHAB events
-      #
-      module Events
-        java_import org.openhab.core.events.AbstractEvent
-
-        # Add attachments to ItemEvent
-        class AbstractEvent
-          attr_accessor :attachment
-        end
-      end
-    end
-  end
-end

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

@@ -1,160 +0,0 @@
-# frozen_string_literal: true
-
-require 'method_source'
-
-require 'openhab/core/thread_local'
-require 'openhab/core/services'
-require 'openhab/log/logger'
-require_relative 'rule_config'
-require_relative 'automation_rule'
-require_relative 'guard'
-require_relative 'name_inference'
-
-module OpenHAB
-  #
-  # Contains code to create an OpenHAB DSL
-  #
-  module DSL
-    #
-    # Creates and manages OpenHAB Rules
-    #
-    module Rules
-      #
-      # The main rule DSL method
-      #
-      module Rule
-        include OpenHAB::Log
-
-        @script_rules = []
-
-        @automation_manager = OpenHAB::Core.automation_manager
-        @registry = OpenHAB::Core.rule_registry
-        class << self
-          attr_reader :script_rules, :automation_manager, :registry
-        end
-
-        module_function
-
-        #
-        # Create a new rule
-        #
-        # @param [String] rule_name The rule name
-        # @yield [] Block executed in context of a RuleConfig
-        #
-        #
-        def rule(rule_name = nil, id: nil, script: nil, &block) # rubocop:disable Metrics
-          id ||= NameInference.infer_rule_id_from_block(block)
-          script ||= block.source rescue nil # rubocop:disable Style/RescueModifier
-
-          OpenHAB::Core::ThreadLocal.thread_local(RULE_NAME: rule_name) do
-            @rule_name = rule_name
-
-            config = RuleConfig.new(block.binding)
-            config.uid(id)
-            config.instance_exec(config, &block)
-            config.guard = Guard::Guard.new(run_context: config.caller, only_if: config.only_if,
-                                            not_if: config.not_if)
-
-            rule_name ||= NameInference.infer_rule_name(config)
-            rule_name ||= id
-
-            config.name(rule_name)
-            logger.trace { config.inspect }
-            process_rule_config(config, script)
-          end
-        rescue StandardError => e
-          logger.log_exception(e, @rule_name)
-        end
-
-        #
-        # Cleanup rules in this script file
-        #
-        def self.cleanup_rules
-          @script_rules.each(&:cleanup)
-        end
-        Core::ScriptHandling.script_unloaded { cleanup_rules }
-
-        private
-
-        #
-        # Process a rule based on the supplied configuration
-        #
-        # @param [RuleConfig] config for rule
-        #
-        #
-        def process_rule_config(config, script) # rubocop:disable Metrics
-          return unless create_rule?(config)
-
-          rule = AutomationRule.new(config: config)
-          Rule.script_rules << rule
-          added_rule = add_rule(rule)
-          # add config so that MainUI can show the script
-          added_rule.actions.first.configuration.put('type', 'application/x-ruby')
-          added_rule.actions.first.configuration.put('script', script)
-
-          rule.execute(nil, { 'event' => Struct.new(:attachment).new(config.start_attachment) }) if config.on_start?
-          added_rule
-        end
-
-        #
-        # Should a rule be created based on rule configuration
-        #
-        # @param [RuleConfig] config to check
-        #
-        # @return [Boolean] true if it should be created, false otherwise
-        #
-        def create_rule?(config)
-          if !triggers?(config)
-            logger.warn "Rule '#{config.name}' has no triggers, not creating rule"
-          elsif !execution_blocks?(config)
-            logger.warn "Rule '#{config.name}' has no execution blocks, not creating rule"
-          elsif !config.enabled
-            logger.trace "Rule '#{config.name}' marked as disabled, not creating rule."
-          else
-            return true
-          end
-          false
-        end
-
-        #
-        # Check if the rule has any triggers
-        #
-        # @param [RuleConfig] config to check for triggers
-        #
-        # @return [Boolean] True if rule has triggers, false otherwise
-        #
-        def triggers?(config)
-          config.on_start? || config.triggers.length.positive?
-        end
-
-        #
-        # Check if the rule has any execution blocks
-        #
-        # @param [RuleConfig] config to check for triggers
-        #
-        # @return [Boolean] True if rule has execution blocks, false otherwise
-        #
-        def execution_blocks?(config)
-          (config.run || []).length.positive?
-        end
-
-        #
-        # Add a rule to the automation managed
-        #
-        # @param [org.openhab.core.automation.module.script.rulesupport.shared.simple.SimpleRule] rule to add
-        #
-        #
-        def add_rule(rule)
-          base_uid = rule.uid
-          duplicate_index = 1
-          while $rules.get(rule.uid)
-            duplicate_index += 1
-            rule.uid = "#{base_uid} (#{duplicate_index})"
-          end
-          logger.trace("Adding rule: #{rule.inspect}")
-          Rule.automation_manager.addRule(rule)
-        end
-      end
-    end
-  end
-end