openhab-scripting 4.1.4 → 4.5.0

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

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

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB types
-      #
-      module Types
-        java_import Java::OrgOpenhabCoreLibraryTypes::QuantityType
-
-        #
-        # MonkeyPatching QuantityType
-        #
-        class QuantityType
-          #
-          # Compare QuantityType to supplied object
-          #
-          # @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 Java::OrgOpenhabCoreTypes::UnDefType then 1
-            when String then self <=> Quantity.new(other)
-            when OpenHAB::DSL::Types::Quantity then self <=> other.quantity
-            else
-              other = other.state if other.respond_to? :state
-              compare_to(other)
-            end
-          end
-
-          #
-          # Coerce objects into a QuantityType
-          #
-          # @param [Object] other object to coerce to a QuantityType if possible
-          #
-          # @return [Object] Numeric when applicable
-          #
-          def coerce(other)
-            logger.trace("Coercing #{self} as a request from #{other.class}")
-            case other
-            when String
-              [Quantity.new(other), self]
-            else
-              [other, self]
-            end
-          end
-
-          #
-          # Compare self to other using the spaceship operator
-          #
-          # @param [Object] other object to compare to
-          #
-          # @return [Boolean] True if equals
-          #
-          def ==(other)
-            (self <=> other).zero?
-          end
-        end
-      end
-    end
-  end
-end

data/lib/openhab/dsl/monkey_patch/types/refresh_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::OrgOpenhabCoreTypes::RefreshType
-
-        #
-        # Monkey patch for DSL use
-        #
-        class RefreshType
-          alias inspect to_s
-        end
-      end
-    end
-  end
-end

data/lib/openhab/dsl/monkey_patch/types/rewind_fastforward_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::RewindFastforwardType
-
-        #
-        # Monkey patch for DSL use
-        #
-        class RewindFastforwardType
-          alias inspect to_s
-        end
-      end
-    end
-  end
-end

data/lib/openhab/dsl/monkey_patch/types/stop_move_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::StopMoveType
-
-        #
-        # Monkey patch for DSL use
-        #
-        class StopMoveType
-          alias inspect to_s
-        end
-      end
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-# Monkey patch types
-require 'openhab/dsl/monkey_patch/types/open_closed_type'
-require 'openhab/dsl/monkey_patch/types/on_off_type'
-require 'openhab/dsl/monkey_patch/types/decimal_type'
-require 'openhab/dsl/monkey_patch/types/increase_decrease_type'
-require 'openhab/dsl/monkey_patch/types/next_previous_type'
-require 'openhab/dsl/monkey_patch/types/percent_type'
-require 'openhab/dsl/monkey_patch/types/play_pause_type'
-require 'openhab/dsl/monkey_patch/types/quantity_type'
-require 'openhab/dsl/monkey_patch/types/refresh_type'
-require 'openhab/dsl/monkey_patch/types/rewind_fastforward_type'
-require 'openhab/dsl/monkey_patch/types/stop_move_type'
-require 'openhab/dsl/monkey_patch/types/up_down_type'

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

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB types
-      #
-      module Types
-        java_import Java::OrgOpenhabCoreLibraryTypes::UpDownType
-
-        #
-        # MonkeyPatching UpDownType
-        #
-        class UpDownType
-          #
-          # 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 RollershutterItem and has the same state
-          #
-          def ===(other)
-            if other.respond_to?(:state)
-              self == other.state&.as(UpDownType)
-            elsif other.is_a? UpDownType
-              self == other
-            else
-              super
-            end
-          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(UpDownType)
-            else
-              super
-            end
-          end
-
-          #
-          # Check if the state is UP
-          #
-          # @return [Boolean] true if UP, false otherwise
-          #
-          def up?
-            self == UP
-          end
-
-          #
-          # Check if the state is DOWN
-          #
-          # @return [Boolean] true if DOWN, false otherwise
-          #
-          def down?
-            self == DOWN
-          end
-
-          alias inspect to_s
-        end
-      end
-    end
-  end
-end