openhab-scripting 4.1.4 → 4.2.0

data/lib/openhab/dsl/monkey_patch/items/persistence.rb

@@ -1,123 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      module Items
-        #
-        # Persistence extension for Items
-        #
-        module Persistence
-          java_import Java::OrgOpenhabCoreTypesUtil::UnitUtils
-
-          # A wrapper for OpenHAB's HistoricItem that returns the state directly
-          class HistoricState < SimpleDelegator
-            attr_reader :timestamp, :state
-
-            def initialize(state, timestamp)
-              @state = state
-              @timestamp = timestamp
-              super(@state)
-            end
-          end
-
-          # All persistence methods that could return a Quantity
-          QUANTITY_METHODS = %i[average_since
-                                delta_since
-                                deviation_since
-                                sum_since
-                                variance_since].freeze
-
-          # All persistence methods that require a timestamp
-          PERSISTENCE_METHODS = (QUANTITY_METHODS +
-                                %i[changed_since
-                                   evolution_rate
-                                   historic_state
-                                   maximum_since
-                                   minimum_since
-                                   updated_since]).freeze
-
-          %i[persist last_update].each do |method|
-            define_method(method) do |service = nil|
-              service ||= persistence_service
-              PersistenceExtensions.public_send(method, self, service&.to_s)
-            end
-          end
-
-          #
-          # Return the previous state of the item
-          #
-          # @param skip_equal [Boolean] if true, skips equal state values and
-          #        searches the first state not equal the current state
-          # @param service [String] the name of the PersistenceService to use
-          #
-          # @return the previous state or nil if no previous state could be found,
-          #         or if the default persistence service is not configured or
-          #         does not refer to a valid service
-          #
-          def previous_state(service = nil, skip_equal: false)
-            service ||= persistence_service
-            result = PersistenceExtensions.previous_state(self, skip_equal, service&.to_s)
-            HistoricState.new(quantify(result.state), result.timestamp)
-          end
-
-          PERSISTENCE_METHODS.each do |method|
-            define_method(method) do |timestamp, service = nil|
-              service ||= persistence_service
-              result = PersistenceExtensions.public_send(method, self, to_zdt(timestamp), service&.to_s)
-              if result.is_a? Java::OrgOpenhabCorePersistence::HistoricItem
-                return HistoricState.new(quantify(result.state), result.timestamp)
-              end
-
-              QUANTITY_METHODS.include?(method) ? quantify(result) : result
-            end
-          end
-
-          private
-
-          #
-          # Convert timestamp to ZonedDateTime if it's a TemporalAmount
-          #
-          # @param [Object] timestamp to convert
-          #
-          # @return [ZonedDateTime]
-          #
-          def to_zdt(timestamp)
-            if timestamp.is_a? Java::JavaTimeTemporal::TemporalAmount
-              logger.trace("Converting #{timestamp} (#{timestamp.class}) to ZonedDateTime")
-              Java::JavaTime::ZonedDateTime.now.minus(timestamp)
-            else
-              timestamp
-            end
-          end
-
-          #
-          # Convert value to Quantity if it is a DecimalType and a unit is defined
-          #
-          # @param [Object] value The value to convert
-          #
-          # @return [Object] Quantity or the original value
-          #
-          def quantify(value)
-            if value.is_a?(Java::OrgOpenhabCoreLibraryTypes::DecimalType) && state_description&.pattern
-              item_unit = UnitUtils.parse_unit(state_description.pattern)
-              logger.trace("Unitizing #{value} with unit #{item_unit}")
-              Quantity.new(Java::OrgOpenhabCoreLibraryTypes::QuantityType.new(value.to_big_decimal, item_unit))
-            else
-              value
-            end
-          end
-
-          #
-          # Get the specified persistence service from the current thread local variable
-          #
-          # @return [Object] Persistence service name as String or Symbol, or nil if not set
-          #
-          def persistence_service
-            Thread.current.thread_variable_get(:persistence_service)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-require 'openhab/dsl/items/item_command'
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB items
-      #
-      module Items
-        java_import Java::OrgOpenhabCoreLibraryItems::SwitchItem
-
-        # Alias class names for easy is_a? comparisons
-        ::Switch = SwitchItem
-
-        #
-        # Monkeypatching SwitchItem to add Ruby Support methods
-        #
-        class SwitchItem
-          extend OpenHAB::DSL::Items::ItemCommand
-
-          java_import Java::OrgOpenhabCoreLibraryTypes::OnOffType
-
-          item_type Java::OrgOpenhabCoreLibraryItems::SwitchItem
-
-          alias truthy? on?
-
-          #
-          # 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)
-            other = other.get_state_as(OnOffType) if other.respond_to?(:get_state_as)
-
-            if other.is_a? OnOffType
-              state? && state == other
-            else
-              super
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/openhab/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 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
-          java_import Java::OrgOpenhabCoreLibraryItems::DimmerItem
-
-          #
-          # 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
-
-#
-# Prepend Range class with RangeExtensions
-#
-class Range
-  prepend OpenHAB::DSL::MonkeyPatch::Ruby::RangeExtensions
-end

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

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      module Ruby
-        #
-        # Extend Time to make to_s return string parseable by OpenHAB
-        #
-        module TimeExtensions
-          include OpenHAB::Core
-
-          #
-          # Convert to ISO 8601 format
-          #
-          # @return [Java::JavaTime::Duration] Duration with number of units from self
-          #
-          def to_s
-            strftime '%FT%T.%N%:z'
-          end
-        end
-      end
-    end
-  end
-end
-
-#
-# Extend Time class with to_s method
-#
-class Time
-  prepend OpenHAB::DSL::MonkeyPatch::Ruby::TimeExtensions
-end

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

@@ -1,97 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB types
-      #
-      module Types
-        java_import Java::OrgOpenhabCoreLibraryTypes::DecimalType
-        java_import org.openhab.core.types.util.UnitUtils
-
-        #
-        # MonkeyPatching Decimal Type
-        #
-        class DecimalType
-          extend Forwardable
-
-          delegate %i[to_d zero?] => :to_big_decimal
-          delegate %i[positive? negative?] => :to_d
-
-          #
-          # @param [Object] other object to compare to
-          #
-          # @return [Integer] -1,0,1 or nil depending on value supplied,
-          #   nil comparison to supplied object is not possible.
-          #
-          def <=>(other)
-            logger.trace("#{self.class} #{self} <=> #{other} (#{other.class})")
-            case other
-            when Numeric
-              to_big_decimal.compare_to(other.to_d)
-            when Java::OrgOpenhabCoreTypes::UnDefType
-              1
-            else
-              other = other.state if other.respond_to? :state
-              compare_to(other)
-            end
-          end
-
-          #
-          # Coerce objects into a DecimalType
-          #
-          # @param [Object] other object to coerce to a DecimalType if possible
-          #
-          # @return [Object] Numeric when applicable
-          #
-          def coerce(other)
-            logger.trace("Coercing #{self} as a request from #{other.class}")
-            case other
-            when Numeric
-              [other.to_d, to_big_decimal]
-            else
-              [other, self]
-            end
-          end
-
-          #
-          # Compare self to other through the spaceship operator
-          # 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)
-            logger.trace("#{self.class} #{self} == #{other} (#{other.class})")
-            (self <=> other).zero?
-          end
-
-          #
-          # Convert DecimalType to a Quantity
-          #
-          # @param [Object] other String or Unit representing an OpenHAB Unit
-          #
-          # @return [OpenHAB::Core::DSL::Types::Quantity] NumberItem converted to supplied Unit
-          #
-          def |(other)
-            other = UnitUtils.parse_unit(other) if other.is_a? String
-            Quantity.new(QuantityType.new(to_big_decimal, other))
-          end
-
-          #
-          # Provide details about DecimalType object
-          #
-          # @return [String] Representing details about the DecimalType object
-          #
-          def inspect
-            to_string
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB types
-      #
-      module Types
-        java_import Java::OrgOpenhabCoreLibraryTypes::IncreaseDecreaseType
-
-        #
-        # Monkey patch for DSL use
-        #
-        class IncreaseDecreaseType
-          alias inspect to_s
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB types
-      #
-      module Types
-        java_import Java::OrgOpenhabCoreLibraryTypes::NextPreviousType
-
-        #
-        # Monkey patch for DSL use
-        #
-        class NextPreviousType
-          alias inspect to_s
-        end
-      end
-    end
-  end
-end

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

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB types
-      #
-      module Types
-        java_import Java::OrgOpenhabCoreLibraryTypes::OnOffType
-
-        #
-        # Monkey patching OnOffType
-        #
-        class OnOffType
-          #
-          # 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)
-            (on? && other.respond_to?(:on?) && other.on?) ||
-              (off? && other.respond_to?(:off?) && other.off?) ||
-              super
-          end
-
-          #
-          # Test for equality
-          #
-          # @param [Object] other Other object to compare against
-          #
-          # @return [Boolean] true if self and other can be considered equal, false otherwise
-          #
-          def ==(other)
-            if other.respond_to?(:get_state_as)
-              self == other.get_state_as(OnOffType)
-            else
-              super
-            end
-          end
-
-          #
-          # Check if the state is ON
-          #
-          # @return [Boolean] true if ON, false otherwise
-          #
-          def on?
-            self == ON
-          end
-
-          #
-          # Check if the state is OFF
-          #
-          # @return [Boolean] true if OFF, false otherwise
-          #
-          def off?
-            self == OFF
-          end
-
-          alias inspect to_s
-        end
-      end
-    end
-  end
-end

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

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB types
-      #
-      module Types
-        java_import Java::OrgOpenhabCoreLibraryTypes::OpenClosedType
-
-        #
-        # Monkey patch for DSL use
-        #
-        class OpenClosedType
-          java_import Java::OrgOpenhabCoreLibraryItems::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)
-            (open? && other.respond_to?(:open?) && other.open?) ||
-              (closed? && other.respond_to?(:closed?) && other.closed?) ||
-              super
-          end
-
-          #
-          # Test for equality
-          #
-          # @param [Object] other Other object to compare against
-          #
-          # @return [Boolean] true if self and other can be considered equal, false otherwise
-          #
-          def ==(other)
-            if other.respond_to?(:get_state_as)
-              self == other.get_state_as(OpenClosedType)
-            else
-              super
-            end
-          end
-
-          #
-          # Check if the state is OPEN
-          #
-          # @return [Boolean] true if OPEN, false otherwise
-          #
-          def open?
-            self == OPEN
-          end
-
-          #
-          # Check if the state is CLOSED
-          #
-          # @return [Boolean] true if CLOSED, false otherwise
-          #
-          def closed?
-            self == CLOSED
-          end
-
-          alias inspect to_s
-        end
-      end
-    end
-  end
-end

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

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB types
-      #
-      module Types
-        java_import Java::OrgOpenhabCoreLibraryTypes::PercentType
-
-        #
-        # MonkeyPatching PercentType
-        #
-        class PercentType
-          #
-          # 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
-
-          #
-          # Provide details about PercentType object
-          #
-          # @return [String] Representing details about the PercentType object
-          #
-          def inspect
-            "#{to_string}%"
-          end
-
-          #
-          # Check if the state is ON
-          #
-          # @return [Boolean] true if ON, false otherwise
-          #
-          def on?
-            as(OnOffType).on?
-          end
-
-          #
-          # Check if the state is OFF
-          #
-          # @return [Boolean] true if OFF, false otherwise
-          #
-          def off?
-            as(OnOffType).off?
-          end
-
-          #
-          # Check if the state is UP
-          #
-          # @return [Boolean] true if UP, false otherwise
-          #
-          def up?
-            !!as(UpDownType)&.up?
-          end
-
-          #
-          # Check if the state is DOWN
-          #
-          # @return [Boolean] true if DOWN, false otherwise
-          #
-          def down?
-            !!as(UpDownType)&.down?
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB types
-      #
-      module Types
-        java_import Java::OrgOpenhabCoreLibraryTypes::PlayPauseType
-
-        #
-        # Monkey patch for DSL use
-        #
-        class PlayPauseType
-          alias inspect to_s
-        end
-      end
-    end
-  end
-end