openhab-scripting 4.40.0 → 4.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aaa16073cb2b4d71edb5e80debef49282a864bad1e057fb307b5cd8b9ca7844
-  data.tar.gz: 641502dca198f6cf42d5a489153f6c04fd3bf70900d4a0873bfb01d686bea6b7
+  metadata.gz: 101fdd6964b1dd5eaefcf5ecaf528ecc01ca12c280440da11ce8646d10fbd67c
+  data.tar.gz: 40bf18765cc29aee28d9ae486cd7c965435f5cbcf8f47867559bb72ccec7f3d9
 SHA512:
-  metadata.gz: 978fe9d74ac7bc6481bb59cfb32a5c917f7707933e68d686be6119096f64daf78a49af1c9e4870abaecc0eec234e50314fae8093f1f04d1c38f6e15cdbe89bd9
-  data.tar.gz: b959d2aef01f436f90a56142e4e2c9a4a532de091bd846b97b799a609e16d849d5df2e3de77d91b0a2de588f0da6cf3e6904205b9236538c123484552484565f
+  metadata.gz: 8a8ce171ac466b46f28e5a5abc59cc2de62a20d16210e58fb7ea33b6ee5a6ad0b9399afb40491142d52396cbbee33b5be444f4d5530176b9ac34764f06a4ec5b
+  data.tar.gz: 57171fa39cfc71afaa8d8cb7488e184ea031cf6f8b01a135410a97317399e8a478d6cf9691ba81168d023882c488b07de5f47a921e516a05589bd198731da8b8

data/lib/openhab/dsl/items/comparable_item.rb

@@ -9,9 +9,12 @@ module OpenHAB
         #
         # Comparison
         #
-        # @param [GenericItem, Types::Type, Object] other object to
+        # @param [GenericItem, Types::Type, Object, GenericItemObject] other object to
         #   compare to
         #
+        #   When comparing GenericItemObject on either side, perform object comparison
+        #   return 0 if the object is equal, or nil otherwise.
+        #
         #   If this item is +NULL+ or +UNDEF+, and +other+ is nil, they are
         #   considered equal
         #
@@ -28,21 +31,30 @@ module OpenHAB
         #
         def <=>(other)
           logger.trace("(#{self.class}) #{self} <=> #{other} (#{other.class})")
-          # if we're NULL or UNDEF, implement special logic
-          unless state?
-            # if comparing to nil, consider ourselves equal
-            return 0 if other.nil?
-            # if the other object is an Item, only consider equal if we're
-            # in the same _kind_ of UnDefType state
-            return raw_state == other.raw_state if other.is_a?(GenericItem) && !other.state?
 
-            # otherwise, it's a non-nil thing comparing to nil, which is undefined
-            return nil
+          if is_a?(OpenHAB::DSL::GenericItemObject) || other.is_a?(OpenHAB::DSL::GenericItemObject)
+            return eql?(other) ? 0 : nil
           end
 
+          # if we're NULL or UNDEF, implement special logic
+          return nil_comparison unless state?
+
           # delegate to how the state compares to the other object
           state <=> other
         end
+
+        # Special logic for NULL/UNDEF state comparison
+        # @!visibility private
+        def nil_comparison
+          # if comparing to nil, consider ourselves equal
+          return 0 if other.nil?
+          # if the other object is an Item, only consider equal if we're
+          # in the same _kind_ of UnDefType state
+          return raw_state == other.raw_state if other.is_a?(GenericItem) && !other.state?
+
+          # otherwise, it's a non-nil thing comparing to nil, which is undefined
+          nil
+        end
       end
     end
   end

data/lib/openhab/dsl/items/semantics.rb

@@ -73,8 +73,7 @@ module OpenHAB
 
         # Gets the related Location Item of this Item.
         #
-        # Returns +self+ if this Item is a Location. Otherwise, checks ancestor
-        # groups one level at a time, returning the first Location Item found.
+        # Checks ancestor groups one level at a time, returning the first Location Item found.
         #
         # @return [GenericItem, nil]
         def location
@@ -92,8 +91,7 @@ module OpenHAB
 
         # Gets the related Equipment Item of this Item.
         #
-        # Returns +self+ if this Item is an Equipment. Otherwise, checks ancestor
-        # groups one level at a time, returning the first Equipment Item found.
+        # Checks ancestor groups one level at a time, returning the first Equipment Item found.
         #
         # @return [GenericItem, nil]
         def equipment
@@ -173,7 +171,7 @@ end
 # Additions to Enumerable to allow easily filtering groups of items based on the semantic model
 module Enumerable
   # Returns a new array of items that are a semantics Location (optionally of the given type)
-  def sublocations(type = nil)
+  def locations(type = nil)
     if type && !(type < OpenHAB::DSL::Items::Semantics::Location)
       raise ArgumentError, 'type must be a subclass of Location'
     end
@@ -183,6 +181,8 @@ module Enumerable
 
     result
   end
+  # @deprecated Please use {#locations}
+  alias sublocations locations
 
   # Returns a new array of items that are a semantics equipment (optionally of the given type)
   #

data/lib/openhab/log/logger.rb

@@ -54,7 +54,9 @@ module OpenHAB
         define_method(level) do |msg = nil, &block|
           log(severity: level, msg: msg, &block)
         end
-        define_method("#{level}_enabled?") { @sl4fj_logger.send("is_#{level}_enabled") }
+        define_method("#{level}?") { @sl4fj_logger.send("is_#{level}_enabled") }
+        # @deprecated
+        alias_method "#{level}_enabled?", "#{level}?"
       end
 
       #
@@ -62,7 +64,7 @@ module OpenHAB
       # @param [String] preamble to put at start of log message
       # @param [Hash] kwargs key and values to log
       def state(preamble = 'State:', **kwargs)
-        return unless trace_enabled?
+        return unless trace?
 
         states = kwargs.transform_keys(&:to_s)
                        .transform_keys(&:capitalize)
@@ -82,7 +84,7 @@ module OpenHAB
       # @return [Exception] the exception, potentially with a cleaned backtrace.
       #
       def clean_backtrace(error)
-        return error if debug_enabled?
+        return error if debug?
 
         if error.respond_to? :backtrace_locations
           backtrace = error.backtrace_locations.map(&:to_s).grep_v(INTERNAL_CALL_REGEX)
@@ -122,7 +124,7 @@ module OpenHAB
         raise ArgumentError, "Unknown Severity #{severity}" unless LEVELS.include? severity
 
         # Dynamically check enablement of underlying logger, this expands to "is_<level>_enabled"
-        return unless send("#{severity}_enabled?")
+        return unless send("#{severity}?")
 
         # Process block if no message provided
         msg = yield if msg.nil? && block_given?

data/lib/openhab/version.rb

@@ -5,5 +5,5 @@
 #
 module OpenHAB
   # @return [String] Version of OpenHAB helper libraries
-  VERSION = '4.40.0'
+  VERSION = '4.41.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.40.0
+  version: 4.41.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-24 00:00:00.000000000 Z
+date: 2022-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler