openhab-scripting 2.16.1 → 2.18.0

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,7 +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 'openhab/core/dsl/monkey_patch/ruby/string'
-require 'bigdecimal/util'

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

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require 'openhab/core/dsl/types/quantity'
-
-module OpenHAB
-  module Core
-    module DSL
-      module MonkeyPatch
-        module Ruby
-          #
-          # Extend String class
-          #
-          module StringExtensions
-            include OpenHAB::Core
-
-            #
-            # Compares String to another object
-            #
-            # @param [Object] other object to compare to
-            #
-            # @return [Boolean]  true if the two objects contain the same value, false otherwise
-            #
-            def ==(other)
-              case other
-              when OpenHAB::Core::DSL::Types::Quantity, QuantityType
-                other == self
-              else
-                super
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
-
-#
-# Prepend String class with comparison extensions
-#
-class String
-  prepend OpenHAB::Core::DSL::MonkeyPatch::Ruby::StringExtensions
-end

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

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-
-#
-# MonkeyPatching Decimal Type
-#
-# rubocop:disable Style/ClassAndModuleChildren
-class Java::OrgOpenhabCoreLibraryTypes::DecimalType
-  # rubocop:enable Style/ClassAndModuleChildren
-
-  #
-  # Compare DecimalType 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 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
-  #
-  # @param [Object] other object to compare to
-  #
-  # @return [Boolean] True if equals
-  #
-  def ==(other)
-    logger.trace("#{self.class} #{self} == #{other} (#{other.class})")
-    (self <=> 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/quantity_type.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-
-#
-# MonkeyPatching QuantityType
-#
-# rubocop:disable Style/ClassAndModuleChildren
-class Java::OrgOpenhabCoreLibraryTypes::QuantityType
-  # rubocop:enable Style/ClassAndModuleChildren
-
-  #
-  # 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::Core::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