openhab-scripting 2.16.2 → 2.19.0

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

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

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-# Monkey patch types
-require 'core/dsl/monkey_patch/types/open_closed_type'
-require 'core/dsl/monkey_patch/types/on_off_type'
-require 'core/dsl/monkey_patch/types/decimal_type'
-require 'core/dsl/monkey_patch/types/percent_type'
-require 'core/dsl/monkey_patch/types/quantity_type'

data/lib/openhab/core/dsl/persistence.rb

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

data/lib/openhab/core/dsl/property.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-require 'core/log'
-
-#
-# Provides methods to support DSL properties
-#
-module DSLProperty
-  include Logging
-
-  #
-  # Extend the calling object with the property methods
-  #
-  # @param [Object] base object to extend
-  #
-  #
-  def self.included(base)
-    base.extend PropertyMethods
-  end
-
-  #
-  # Methods that support creating properties in the DSL
-  #
-  module PropertyMethods
-    #
-    # Dynamically creates a property that acts and an accessor with no arguments
-    # and a setter with any number of arguments or a block.
-    #
-    # @param [String] name of the property
-    #
-    #
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/PerceivedComplexity
-    def prop(name)
-      # rubocop rules are disabled because this method is dynamically defined on the calling
-      #   object making calls to other methods in this module impossible, or if done on methods
-      #   in this module than instance variable belong to the module not the calling class
-      define_method(name) do |*args, &block|
-        if args.length.zero? && block.nil? == true
-          instance_variable_get("@#{name}")
-        else
-          logger.trace("Property '#{name}' called with args(#{args}) and block(#{block})")
-          if args.length == 1
-            instance_variable_set("@#{name}", args.first)
-          elsif args.length > 1
-            instance_variable_set("@#{name}", args)
-          elsif block
-            instance_variable_set("@#{name}", block)
-          end
-        end
-      end
-    end
-
-    #
-    # Dynamically creates a property array acts and an accessor with no arguments
-    # and a pushes any number of arguments or a block onto they property array
-    # You can provide a block to this method which can be used to check if the provided value is acceptable.
-    #
-    # @param [String] name of the property
-    # @param [String] array_name name of the array to use, defaults to name of property
-    # @param [Class] wrapper object to put around elements added to the array
-    #
-    def prop_array(name, array_name: nil, wrapper: nil)
-      define_method(name) do |*args, &block|
-        array_name ||= name
-        if args.length.zero? && block.nil? == true
-          instance_variable_get("@#{array_name}")
-        else
-          logger.trace("Property '#{name}' called with args(#{args}) and block(#{block})")
-          if args.length == 1
-            insert = args.first
-          elsif args.length > 1
-            insert = args
-          elsif block
-            insert = block
-          end
-          yield insert if block_given?
-          insert = wrapper.new(insert) if wrapper
-          instance_variable_set("@#{array_name}", (instance_variable_get("@#{array_name}") || []) << insert)
-        end
-      end
-
-      return unless array_name
-
-      define_method(array_name) do
-        instance_variable_get("@#{array_name}")
-      end
-    end
-  end
-  # rubocop:enable Metrics/MethodLength
-  # rubocop:enable Metrics/AbcSize
-  # rubocop:enable Metrics/CyclomaticComplexity
-  # rubocop:enable Metrics/PerceivedComplexity
-end