openhab-scripting 4.1.4 → 4.5.0

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

@@ -1,338 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-require 'forwardable'
-require 'time'
-
-module OpenHAB
-  module DSL
-    module Types
-      #
-      # Ruby implementation for OpenHAB DateTimeType
-      #
-      # @author Anders Alfredsson
-      #
-      # 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 DateTime
-        extend Forwardable
-        include Comparable
-        include OpenHAB::Log
-
-        def_delegator :datetime, :to_s
-        def_delegator :zoned_date_time, :month_value, :month
-        def_delegator :zoned_date_time, :day_of_month, :mday
-        def_delegator :zoned_date_time, :day_of_year, :yday
-        def_delegator :zoned_date_time, :minute, :min
-        def_delegator :zoned_date_time, :second, :sec
-        def_delegator :zoned_date_time, :nano, :nsec
-        def_delegator :zoned_date_time, :to_epoch_second, :to_i
-        alias inspect to_s
-        alias day mday
-
-        java_import Java::OrgOpenhabCoreLibraryTypes::DateTimeType
-        java_import java.time.ZonedDateTime
-        java_import java.time.Instant
-        java_import java.time.ZoneId
-        java_import java.time.ZoneOffset
-        java_import java.time.Duration
-
-        #
-        # Regex expression to identify strings defining a time in hours, minutes and optionally seconds
-        #
-        TIME_ONLY_REGEX = /\A\d\d:\d\d(:\d\d)?\Z/.freeze
-
-        #
-        # Regex expression to identify strings defining a time in hours, minutes and optionally seconds
-        #
-        DATE_ONLY_REGEX = /\A\d{4}-\d\d-\d\d\Z/.freeze
-
-        attr_reader :datetime
-
-        #
-        # Create a new DateTime instance wrapping an OpenHAB DateTimeType
-        #
-        # @param [Java::org::openhab::core::library::types::DateTimeType] datetime The DateTimeType instance to
-        #   delegate to, or an object that can be converted to a DateTimeType
-        #
-        def initialize(datetime)
-          @datetime = case datetime
-                      when DateTimeType
-                        datetime
-                      when ZonedDateTime
-                        DateTimeType.new(datetime)
-                      else
-                        raise "Unexpected type #{datetime.class} provided to DateTime initializer"
-                      end
-        end
-
-        #
-        # Compare thes DateTime object to another
-        #
-        # @param [Object] other Other object to compare against
-        #
-        # @return [Integer] -1, 0 or 1 depending on the outcome
-        #
-        def <=>(other)
-          if other.respond_to?(:zoned_date_time)
-            return zoned_date_time.to_instant.compare_to(other.zoned_date_time.to_instant)
-          end
-
-          case other
-          when TimeOfDay::TimeOfDay, TimeOfDay::TimeOfDayRangeElement then to_tod <=> other
-          when String then self <=> DateTime.parse(DATE_ONLY_REGEX.match?(other) ? "#{other}'T'00:00:00#{zone}" : other)
-          else
-            self <=> DateTime.from(other)
-          end
-        end
-
-        #
-        # Adds another object to this DateTime
-        #
-        # @param [Object] other Object to add to this. Can be a Numeric, another DateTime/Time/DateTimeType, a
-        #   Duration or a String that can be parsed into a DateTimeType or Time object
-        #
-        # @return [DateTime] A new DateTime object representing the result of the calculation
-        #
-        def +(other)
-          logger.trace("Adding #{other} (#{other.class}) to #{self}")
-          case other
-          when Numeric then DateTime.from(to_time + other)
-          when DateTime, Time then self + other.to_f
-          when DateTimeType, String then self + DateTime.from(other).to_f
-          when Duration then DateTime.new(zoned_date_time.plus(other))
-          end
-        end
-
-        #
-        # Subtracts another object from this DateTime
-        #
-        # @param [Object] other Object to subtract fom this. Can be a Numeric, another DateTime/Time/DateTimeType, a
-        #   Duration or a String that can be parsed into a DateTimeType or Time object
-        #
-        # @return [DateTime, Float] A new DateTime object representing the result of the calculation, or a Float
-        #   representing the time difference in seconds if the subtraction is between two time objects
-        #
-        def -(other)
-          logger.trace("Subtracting #{other} (#{other.class}) from self")
-          case other
-          when Numeric then DateTime.from(to_time - other)
-          when String
-            dt = DateTime.parse(other)
-            TIME_ONLY_REGEX.match?(other) ? self - dt.to_f : time_diff(dt)
-          when Duration then DateTime.new(zoned_date_time.minus(other))
-          when Time, DateTime, DateTimeType, DateTimeItem then time_diff(other)
-          end
-        end
-
-        #
-        # Convert this DateTime to a ruby Time object
-        #
-        # @return [Time] A Time object representing the same instant and timezone
-        #
-        def to_time
-          Time.at(to_i, nsec, :nsec).localtime(utc_offset)
-        end
-
-        #
-        # Convert the time part of this DateTime to a TimeOfDay object
-        #
-        # @return [TimeOfDay] A TimeOfDay object representing the time
-        #
-        def to_time_of_day
-          TimeOfDay::TimeOfDay.new(h: hour, m: minute, s: second)
-        end
-
-        alias to_tod to_time_of_day
-
-        #
-        # Returns the value of time as a floating point number of seconds since the Epoch
-        #
-        # @return [Float] Number of seconds since the Epoch, with nanosecond presicion
-        #
-        def to_f
-          zoned_date_time.to_epoch_second + (zoned_date_time.nano / 1_000_000_000)
-        end
-
-        #
-        # The ZonedDateTime representing the state
-        #
-        # @return [Java::java::time::ZonedDateTime] ZonedDateTime representing the state
-        #
-        def zoned_date_time
-          @datetime.zonedDateTime
-        end
-
-        alias to_zdt zoned_date_time
-
-        #
-        # The offset in seconds from UTC
-        #
-        # @return [Integer] The offset from UTC, in seconds
-        #
-        def utc_offset
-          zoned_date_time.offset.total_seconds
-        end
-
-        #
-        # Returns true if time represents a time in UTC (GMT)
-        #
-        # @return [Boolean] true if utc_offset == 0, false otherwise
-        #
-        def utc?
-          utc_offset.zero?
-        end
-
-        #
-        # Returns an integer representing the day of the week, 0..6, with Sunday == 0.
-        #
-        # @return [Integer] The day of week
-        #
-        def wday
-          zoned_date_time.day_of_week.value % 7
-        end
-
-        #
-        # The timezone
-        #
-        # @return [String] The timezone in `[+-]hh:mm(:ss)` format ('Z' for UTC) or nil if the Item has no state
-        #
-        def zone
-          zoned_date_time.zone.id
-        end
-
-        #
-        # Check if missing method can be delegated to other contained objects
-        #
-        # @param [String, Symbol] meth the method name to check for
-        #
-        # @return [Boolean] true if DateTimeType, ZonedDateTime or Time responds to the method, false otherwise
-        #
-        def respond_to_missing?(meth, *)
-          @datetime.respond_to?(meth) ||
-            zoned_date_time.respond_to?(meth) ||
-            Time.instance_methods.include?(meth.to_sym)
-        end
-
-        #
-        # Forward missing methods to the OpenHAB DateTimeType, its ZonedDateTime object or a ruby Time
-        # object representing the same instant
-        #
-        # @param [String] meth method name
-        # @param [Array] args arguments for method
-        # @param [Proc] block <description>
-        #
-        # @return [Object] Value from delegated method in OpenHAB NumberItem
-        #
-        def method_missing(meth, *args, &block)
-          if @datetime.respond_to?(meth)
-            @datetime.__send__(meth, *args, &block)
-          elsif zoned_date_time.respond_to?(meth)
-            zoned_date_time.__send__(meth, *args, &block)
-          elsif Time.instance_methods.include?(meth.to_sym)
-            to_time.send(meth, *args, &block)
-          else
-            raise NoMethodError, "undefined method `#{meth}' for #{self.class}"
-          end
-        end
-
-        #
-        # Converts other objects to a DateTimeType
-        #
-        # @param [String, Numeric, Time] datetime an object that can be parsed or converted into
-        #   a DateTimeType
-        #
-        # @return [Java::org::openhab::core::library::types::DateTimeType] Object representing the same time
-        #
-        def self.from(datetime)
-          case datetime
-          when String
-            parse(datetime)
-          when Numeric
-            from_numeric(datetime)
-          when Time
-            from_time(datetime)
-          else
-            raise "Cannot convert #{datetime.class} to DateTime"
-          end
-        end
-
-        #
-        # Converts a Numeric into a DateTimeType
-        #
-        # @param [Numeric] numeric A Integer or Float representing the number of seconds since the epoch
-        #
-        # @return [Java::org::openhab::core::library::types::DateTimeType] Object representing the same time
-        #
-        def self.from_numeric(numeric)
-          case numeric
-          when Integer
-            DateTime.new(ZonedDateTime.ofInstant(Instant.ofEpochSecond(datetime), ZoneId.systemDefault))
-          else
-            DateTime.new(ZonedDateTime.ofInstant(Instant.ofEpochSecond(datetime.to_i,
-                                                                       ((datetime % 1) * 1_000_000_000).to_i),
-                                                 ZoneId.systemDefault))
-          end
-        end
-
-        #
-        # Converts a ruby Time object to an OpenHAB DateTimeType
-        #
-        # @param [Time] time The Time object to be converted
-        #
-        # @return [Java::org::openhab::core::library::types::DateTimeType] Object representing the same time
-        #
-        def self.from_time(time)
-          instant = Instant.ofEpochSecond(time.to_i, time.nsec)
-          zone_id = ZoneId.of_offset('UTC', ZoneOffset.of_total_seconds(time.utc_offset))
-          DateTime.new(ZonedDateTime.ofInstant(instant, zone_id))
-        end
-
-        #
-        # Parses a string representing a time into an OpenHAB DateTimeType. First tries to parse it
-        #   using the DateTimeType's parser, then falls back to the ruby Time.parse
-        #
-        # @param [String] time_string The string to be parsed
-        #
-        # @return [Java::org::openhab::core::library::types::DateTimeType] Object representing the same time
-        #
-        def self.parse(time_string)
-          time_string += 'Z' if TIME_ONLY_REGEX.match?(time_string)
-          DateTime.new(DateTimeType.new(time_string))
-        rescue Java::JavaLang::StringIndexOutOfBoundsException, Java::JavaLang::IllegalArgumentException
-          # Try ruby's Time.parse if OpenHAB's DateTimeType parser fails
-          begin
-            time = Time.parse(time_string)
-            DateTime.from(time)
-          rescue ArgumentError
-            raise "Unable to parse #{time_string} into a DateTime"
-          end
-        end
-
-        private
-
-        #
-        # Calculates the difference in time between this instance and another time object
-        #
-        # @param [Time, DateTime, DateTimeItem, Java::org::openhab::core::library::types::DateTimeType] time_obj
-        #   The other time object to subtract from self
-        #
-        # @return [Float] The time difference between the two objects, in seconds
-        #
-        def time_diff(time_obj)
-          logger.trace("Calculate time difference between #{self} and #{time_obj}")
-          case time_obj
-          when Time
-            to_time - time_obj
-          when DateTime, DateTimeItem
-            self - time_obj.to_time
-          when DateTimeType
-            self - DateTime.new(time_obj).to_time
-          end
-        end
-      end
-    end
-  end
-end
-# rubocop: enable Metrics/ClassLength

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

@@ -1,300 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-require 'forwardable'
-
-module OpenHAB
-  module DSL
-    #
-    # Ruby implementation of OpenHAB Types
-    #
-    module Types
-      #
-      # Ruby implementation for OpenHAB quantities
-      #
-      # 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 Quantity < Numeric
-        extend Forwardable
-        include OpenHAB::Log
-
-        def_delegator :@quantity, :to_s
-        def_delegators '@quantity.double_value', :positive?, :negative?, :zero?
-
-        java_import org.openhab.core.library.types.QuantityType
-        java_import org.openhab.core.library.types.DecimalType
-        java_import org.openhab.core.types.util.UnitUtils
-        java_import org.openhab.core.library.unit.Units
-
-        # @return [Hash] Mapping of operation symbols to BigDecimal methods
-        OPERATIONS = {
-          '+' => 'add',
-          '-' => 'subtract',
-          '*' => 'multiply',
-          '/' => 'divide'
-        }.freeze
-
-        private_constant :OPERATIONS
-
-        attr_reader :quantity
-
-        #
-        # Create a new Quantity
-        #
-        # @param [object] quantity String,QuantityType or Numeric to be this quantity
-        #
-        # Cop disabled, case statement is compact and idiomatic
-        def initialize(quantity)
-          @quantity = case quantity
-                      when String then QuantityType.new(quantity)
-                      when QuantityType then quantity
-                      when NumberItem, Numeric then QuantityType.new(quantity.to_d.to_java, Units::ONE)
-                      else raise ArgumentError, "Unexpected type #{quantity.class} provided to Quantity initializer"
-                      end
-          super()
-        end
-
-        #
-        # Convert this quantity into a another unit
-        #
-        # @param [Object] other String or Unit to convert to
-        #
-        # @return [Quantity] This quantity converted to another unit
-        #
-        def |(other)
-          other = UnitUtils.parse_unit(other) if other.is_a? String
-
-          Quantity.new(quantity.to_unit(other))
-        end
-
-        #
-        # Compare this quantity
-        #
-        # @param [Object] other object to compare to
-        #
-        # @return [Integer] -1,0,1 if this object is less than, equal to, or greater than the supplied object,
-        #   nil if it cannot be compared
-        #
-        def <=>(other)
-          logger.trace("Comparing #{self} to #{other}")
-          my_qt, other_qt = unitize(*to_qt(coerce(other).reverse))
-          my_qt.compare_to(other_qt)
-        end
-
-        #
-        # Coerce other object into a Quantity
-        #
-        # @param [Object] other object to convert to Quantity
-        #
-        # @return [Array] of self and other object as Quantity types, nil if object cannot be coerced
-        #
-        def coerce(other)
-          logger.trace("Coercing #{self} as a request from #{other.class}")
-          case other
-          when Quantity then [other.quantity, quantity]
-          when QuantityType then [other, quantity]
-          when DecimalType then [Quantity.new(other.to_big_decimal.to_d), quantity]
-          when NumberItem then [other.to_qt.quantity, quantity]
-          when Numeric, String then [Quantity.new(other), self]
-          end
-        end
-
-        #
-        # Forward missing methods to Openhab Quantity Item if they are defined
-        #
-        # @param [String] meth name of method invoked
-        # @param [Array] args arguments to invoked method
-        # @param [Proc] block block passed ot method
-        #
-        # @return [Object] result of delegation
-        #
-        def method_missing(meth, *args, &block)
-          logger.trace("Method missing, performing dynamic lookup for: #{meth}")
-          if quantity.respond_to?(meth)
-            quantity.__send__(meth, *args, &block)
-          elsif ::Kernel.method_defined?(meth) || ::Kernel.private_method_defined?(meth)
-            ::Kernel.instance_method(meth).bind_call(self, *args, &block)
-          else
-            super(meth, *args, &block)
-          end
-        end
-
-        #
-        # Checks if this method responds to the missing method
-        #
-        # @param [String] method_name Name of the method to check
-        # @param [Boolean] _include_private boolean if private methods should be checked
-        #
-        # @return [Boolean] true if this object will respond to the supplied method, false otherwise
-        #
-        def respond_to_missing?(method_name, _include_private = false)
-          quantity.respond_to?(method_name) ||
-            ::Kernel.method_defined?(method_name) ||
-            ::Kernel.private_method_defined?(method_name)
-        end
-
-        #
-        # Negate the quantity
-        #
-        # @return [Quantity] This quantity negated
-        #
-        def -@
-          Quantity.new(quantity.negate)
-        end
-
-        OPERATIONS.each do |operation, method|
-          define_method(operation) do |other|
-            logger.trace do
-              "Executing math operation '#{operation}' on quantity #{inspect} "\
-                "with other type #{other.class} and value #{other.inspect}"
-            end
-
-            a, b = to_qt(coerce(other).reverse)
-            logger.trace("Coerced a='#{a}' with b='#{b}'")
-            a, b = unitize(a, b, operation)
-            logger.trace("Unitized a='#{a}' b='#{b}'")
-            logger.trace("Performing operation '#{operation}' with method '#{method}' on a='#{a}' with b='#{b}'")
-            Quantity.new(a.public_send(method, b))
-          end
-        end
-
-        #
-        # Provide details about quantity object
-        #
-        # @return [String] Representing details about the quantity object
-        #
-        def inspect
-          if @quantity.unit == Units::ONE
-            "unit=#{@quantity.unit}, value=#{@quantity.to_string}"
-          else
-            @quantity.to_string
-          end
-        end
-
-        private
-
-        # @return [Array] Array of strings for operations for which the operands will not be unitized
-        DIMENSIONLESS_NON_UNITIZED_OPERATIONS = %w[* /].freeze
-
-        # Dimensionless numbers should only be unitzed for addition and subtraction
-
-        #
-        # Convert one or more Quantity obects to the underlying quantitytypes
-        #
-        # @param [Array] quanities Array of either Quantity or QuantityType objects
-        #
-        # @return [Array]  Array of QuantityType objects
-        #
-        def to_qt(*quantities)
-          [quantities].flatten.compact.map { |item| item.is_a?(Quantity) ? item.quantity : item }
-        end
-
-        #
-        # Checks if an item should be unitized
-        #
-        # @param [Quantity] quantity to check
-        # @param [String] operation quantity is being used with
-        #
-        # @return [Boolean] True if the quantity should be unitzed based on the unit and operation, false otherwise
-        #
-        def unitize?(quantity, operation)
-          !(quantity.unit == Units::ONE && DIMENSIONLESS_NON_UNITIZED_OPERATIONS.include?(operation))
-        end
-
-        #
-        # Convert the unit for the quantity
-        #
-        # @param [Quantity] quantity being converted
-        #
-        # @return [Quantity] Quantity coverted to unit set by unit block
-        #
-        def convert_unit(quantity)
-          return quantity unless unit?
-
-          case quantity.unit
-          when unit
-            quantity
-          when Units::ONE
-            convert_unit_from_dimensionless(quantity, unit)
-          else
-            convert_unit_from_dimensioned(quantity, unit)
-          end
-        end
-
-        #
-        # Converts a dimensioned quantity to a specific unit
-        #
-        # @param [Quantity] quantity to convert
-        # @param [Unit] unit to convert to
-        #
-        # @return [Java::org::openhab::core::library::types::QuantityType] converted quantity
-        #
-        def convert_unit_from_dimensioned(quantity, unit)
-          logger.trace("Converting dimensioned item #{inspect} to #{unit}")
-          quantity.to_unit(unit).tap do |converted|
-            raise "Conversion from #{quantity.unit} to #{unit} failed" unless converted
-          end
-        end
-
-        #
-        # Converts a dimensionless quantity to a unit
-        #
-        # @param [Quantity] quantity to convert
-        # @param [Unit] unit to convert to
-        #
-        # @return [Java::org::openhab::core::library::types::QuantityType] converted quantity
-        #
-        def convert_unit_from_dimensionless(quantity, unit)
-          logger.trace("Converting dimensionless #{quantity} to #{unit}")
-          QuantityType.new(quantity.to_big_decimal, unit)
-        end
-
-        #
-        # Convert quantities to appropriate units
-        #
-        # @param [Quantity] quantity_a Quantity on left side of operation
-        # @param [Quantity] quantity_b Quantity on right side of operation
-        # @param [String] operation Math operation
-        # @yield [quantity_a, quantity_b] yields unitized versions of supplied quantities
-        #
-        # @return [Array, Object] of quantites in correct units for the supplied operation and the unit
-        #   or the result of the block if a block is given
-        #
-        def unitize(quantity_a, quantity_b, operation = nil)
-          logger.trace("Unitizing (#{quantity_a}) and (#{quantity_b})")
-          quantity_a, quantity_b = [quantity_a, quantity_b].map do |qt|
-            unitize?(qt, operation) ? convert_unit(qt) : qt.to_big_decimal
-          end
-
-          # Make sure the operation is called on the QuantityType
-          if quantity_a.is_a?(Java::JavaMath::BigDecimal) && quantity_b.is_a?(QuantityType) && operation == '*'
-            quantity_a, quantity_b = [quantity_b, quantity_a]
-          end
-          return yield quantity_a, quantity_b if block_given?
-
-          [quantity_a, quantity_b]
-        end
-
-        #
-        # Get the unit from the current thread local variable
-        #
-        # @return [Object] Unit or string representation of Unit, or nil if not set
-        #
-        def unit
-          Thread.current.thread_variable_get(:unit)
-        end
-
-        #
-        # Is a unit set for this thread
-        #
-        # @return [boolean] true if a unit is set by this thread, false otherwise
-        #
-        def unit?
-          unit != nil
-        end
-      end
-    end
-  end
-end
-# rubocop: enable Metrics/ClassLength