openhab-scripting 5.40.1 → 5.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d127126eee03f2bf40f89d87519dc43848d7a37fc270cf74f960571b0591a6a
-  data.tar.gz: 9798ed530ab09d88cb3698dff764c264cda7e2e0b85b0a57685006f33513203b
+  metadata.gz: e14c40c5db6a5210c78c66a315ab449cf71e2960f6de3675f01146b7dd441610
+  data.tar.gz: 7862488bf7df6e277c9833e11b15d0e5d54fe6eff3a62fa159dfe26641ab8aad
 SHA512:
-  metadata.gz: b9d52444551b2aa6c8a0e0cab506d2aef028e2fe59c983eaf71cac46ba01e8807f1541bc3d790501d555efb2c93f12ec9d3087c43bb72172f43220a37dcd5620
-  data.tar.gz: 9c4ec38935c532286b9e19a0325870dbccfbe35b6e52dc0d92a47ff30ce6729ce96afa9fdbe14ccf4b2cf6127c727d2e415fd0c3be9af95cb9c64f5a9055f116
+  metadata.gz: e72be1db208c31047b81bbba773e6e1f930c7eb47cf61740e151c2d4918e96e192a36fbc3ac94e3ecbece62811f01792574f4bc78d386e14015e66bf4ebf73af
+  data.tar.gz: 21a972d3941e63c8ca7729f660c7f60cba586f6d210bed9294c6d81cbfb33df6b9897aa7d4258cdf9f199188a8f90301ac3d353278fb96f4a3e86e0ec198d8d7

data/lib/openhab/core/items/item.rb

@@ -91,20 +91,30 @@ module OpenHAB
           label || name
         end
 
-        # @!attribute [r] formatted_state
+        # @!attribute [r] display_state
         #
         # Format the item's state according to its state description
         #
-        # This may include running a transformation.
+        # This may include running a transformation, if one is defined in the
+        # state description's pattern, otherwise it will format according to the
+        # pattern. If no state description is defined, the state will simply
+        # be returned as a string.
+        #
+        # @note While this method is also aliased to `#transformed_state` to
+        #   match the field available in the openHAB REST API, unlike the API it
+        #   will always return a value even if the state description has no
+        #   transformation.
         #
         # @return [String] The formatted state
         #
         # @example
-        #   logger.info(Exterior_WindDirection.formatted_state) # => "NE (36°)"
+        #   logger.info(Exterior_WindDirection.display_state) # => "NE (36°)"
         #
-        def formatted_state
+        def display_state
           Item.item_states_event_builder.get_display_state(self)
         end
+        alias_method :transformed_state, :display_state
+        alias_method :formatted_state, :display_state
 
         #
         # Send a command to this item

data/lib/openhab/core/items/metadata/provider.rb

@@ -40,7 +40,7 @@ module OpenHAB
             end
             nil
           end
-          alias_method :removeItemMetadata, :remove_item_metadata
+          alias_method :removeItemMetadata, :remove_item_metadata # rubocop:disable Naming/MethodName
         end
       end
     end

data/lib/openhab/core/profile_factory.rb

@@ -37,8 +37,8 @@ module OpenHAB
         end
 
         # @!visibility private
-        def onCommandFromItem(command)
-          return unless process_event(:command_from_item, command:) == true
+        def onCommandFromItem(command, source = nil)
+          return unless process_event(:command_from_item, command:, source:) == true
 
           logger.trace("Forwarding original command")
           @callback.handle_command(command)
@@ -92,6 +92,7 @@ module OpenHAB
           params[:command] ||= nil
           params[:trigger] ||= nil
           params[:time_series] ||= nil
+          params[:source] ||= nil
 
           kwargs = {}
           @block.parameters.each do |(param_type, name)|

data/lib/openhab/core/provider.rb

@@ -40,6 +40,7 @@ module OpenHAB
       include org.openhab.core.common.registry.ManagedProvider
       include Enumerable
       include Singleton
+
       public_class_method :new
 
       # Known supported provider types
@@ -183,7 +184,7 @@ module OpenHAB
       def all
         @elements.values
       end
-      alias_method :getAll, :all
+      alias_method :getAll, :all # rubocop:disable Naming/MethodName
 
       #
       # Remove an element from this provider

data/lib/openhab/core/sitemaps/provider.rb

@@ -25,7 +25,7 @@ module OpenHAB
         include org.openhab.core.model.sitemap.SitemapProvider
 
         # @!visibility private
-        alias_method :getSitemap, :get
+        alias_method :getSitemap, :get # rubocop:disable Naming/MethodName
 
         # rubocop:disable Naming/MethodName
 

data/lib/openhab/core/things/links/provider.rb

@@ -50,7 +50,7 @@ module OpenHAB
             end
             count
           end
-          alias_method :removeLinksForItem, :remove_links_for_item
+          alias_method :removeLinksForItem, :remove_links_for_item # rubocop:disable Naming/MethodName
 
           #
           # Removes all links to a given thing.
@@ -69,7 +69,7 @@ module OpenHAB
             end
             count
           end
-          alias_method :removeLinksForThing, :remove_links_for_thing
+          alias_method :removeLinksForThing, :remove_links_for_thing # rubocop:disable Naming/MethodName
         end
       end
     end

data/lib/openhab/core/things/proxy.rb

@@ -13,6 +13,7 @@ module OpenHAB
       # @!visibility private
       class Proxy < Delegator
         extend Forwardable
+
         def_delegators :__getobj__, :class, :is_a?, :kind_of?
 
         # @!visibility private

data/lib/openhab/core.rb

@@ -15,6 +15,8 @@ module OpenHAB
     V4_3 = Gem::Version.new("4.3.0").freeze
     # @!visibility private
     V5_0 = Gem::Version.new("5.0.0").freeze
+    # @!visibility private
+    V5_1 = Gem::Version.new("5.1.0").freeze
 
     # @return [Gem::Version] Returns the current openHAB version as a Gem::Version object
     #   Note, this strips off snapshots, milestones and RC versions and returns the release version.

data/lib/openhab/core_ext/java/duration.rb

@@ -16,6 +16,7 @@ module OpenHAB
       #
       class Duration
         include Between
+
         # @!parse include TemporalAmount
 
         #

data/lib/openhab/core_ext/java/local_time.rb

@@ -36,6 +36,7 @@ module OpenHAB
       #
       class LocalTime
         include Between
+
         # @!parse include Time
 
         class << self

data/lib/openhab/core_ext/java/month.rb

@@ -10,6 +10,7 @@ module OpenHAB
       # Extensions to {java.time.Month}
       class Month
         include Between
+
         # @!parse include Time
 
         # @return [Month]

data/lib/openhab/core_ext/ruby/numeric.rb

@@ -169,6 +169,7 @@ module OpenHAB
         include QuantityTypeConversion
         # non-Integer/Float (i.e. BigDecimal) can still be converted to Duration, via converting to float first
         extend Forwardable
+
         def_delegators :to_f,
                        :milliseconds,
                        :millisecond,

data/lib/openhab/dsl/rules/automation_rule.rb

@@ -120,10 +120,9 @@ module OpenHAB
         # @return [Queue] <description>
         #
         def create_queue(event)
-          case check_guards(event:)
-          when true
+          if check_guards?(event:)
             @run_queue.dup.grep_v(BuilderDSL::Otherwise)
-          when false
+          else
             @run_queue.dup.grep(BuilderDSL::Otherwise)
           end
         end
@@ -211,7 +210,7 @@ module OpenHAB
         # @return [true,false] True if guards says rule should execute, false otherwise
         #
         # Loggging inflates method length
-        def check_guards(event:)
+        def check_guards?(event:)
           return true if @guard.nil?
 
           unless @between.nil?

data/lib/openhab/dsl/rules/name_inference.rb

@@ -162,7 +162,7 @@ module OpenHAB
           def format_offset(offset)
             return "" unless offset&.nonzero?
 
-            " #{offset.positive? ? "+" : ""}#{offset.seconds.to_s.downcase[2..]}" # Remove "PT" from the ISO8601 string
+            " #{"+" if offset.positive?}#{offset.seconds.to_s.downcase[2..]}" # Remove "PT" from the ISO8601 string
           end
         end
       end

data/lib/openhab/dsl/rules/triggers/conditions/generic.rb

@@ -29,11 +29,11 @@ module OpenHAB
             # @param [Hash] inputs inputs from trigger
             # @return [true, false] if the conditions passed (and therefore the block was run)
             #
-            def process(mod:, inputs:)
+            def process(mod:, inputs:) # rubocop:disable Naming/PredicateMethod
               logger.trace { "Checking #{inputs} against condition trigger #{self}" }
-              unless check_value(Conditions.old_state_from(inputs), @from) &&
-                     check_value(Conditions.new_state_from(inputs), @to) &&
-                     check_value(inputs["command"], @command)
+              unless check_value?(Conditions.old_state_from(inputs), @from) &&
+                     check_value?(Conditions.new_state_from(inputs), @to) &&
+                     check_value?(inputs["command"], @command)
                 return false
               end
 
@@ -50,7 +50,7 @@ module OpenHAB
 
             private
 
-            def check_value(value, expected_value)
+            def check_value?(value, expected_value)
               return true if value.nil?
 
               return true if expected_value.nil?

data/lib/openhab/dsl/rules/triggers/watch/watch_handler.rb

@@ -26,6 +26,7 @@ module OpenHAB
           class Watcher
             # Use full java class name here to satisfy YARD linter
             include org.openhab.core.service.WatchService::WatchEventListener
+
             java_import org.openhab.core.service.WatchService
 
             # Hash of event symbols as strings to map to WatchService events

data/lib/openhab/dsl/version.rb

@@ -4,6 +4,6 @@ module OpenHAB
   module DSL
     # Version of openHAB helper libraries
     # @return [String]
-    VERSION = "5.40.1"
+    VERSION = "5.42.0"
   end
 end

data/lib/openhab/dsl.rb

@@ -58,6 +58,7 @@ module OpenHAB
     # include this before Core::Actions so that Core::Action's method_missing
     # takes priority
     include Core::EntityLookup
+
     #
     # @!parse
     #   include Core::Actions
@@ -157,6 +158,8 @@ module OpenHAB
     # @yieldparam [Core::Things::ChannelUID] channel_uid The linked channel.
     # @yieldparam [Hash] configuration The profile configuration.
     # @yieldparam [org.openhab.core.thing.profiles.ProfileContext] context The profile context.
+    # @yieldparam [String, nil] source The source of the event.
+    #   @since openHAB 5.1
     # @yieldreturn [Boolean] Return true from the block in order to have default processing.
     # @return [void]
     #

data/lib/openhab/log.rb

@@ -384,6 +384,7 @@ module OpenHAB
       end
 
       extend Forwardable
+
       def_delegators :current_logger, *(Logger.public_instance_methods.select do |m|
         Logger.instance_method(m).owner == Logger
       end - BasicObject.public_instance_methods)

data/lib/openhab/rspec/mocks/abstract_storage_based_type_provider_wrapped_storage_service.rb

@@ -15,7 +15,7 @@ module OpenHAB
           @java_klass = java_klass
         end
 
-        def getStorage(name, _class_loader) # rubocop:disable Naming/MethodName
+        def getStorage(name, _class_loader)
           super(name.sub(@ruby_klass.name, @java_klass.name), @java_klass.class_loader)
         end
       end

data/lib/openhab/rspec/mocks/event_admin.rb

@@ -97,7 +97,7 @@ module OpenHAB
           open
         end
 
-        def addingService(reference) # rubocop:disable Naming/MethodName
+        def addingService(reference)
           topics = Array(reference.get_property(org.osgi.service.event.EventConstants::EVENT_TOPIC))
           topics = nil if topics.empty? || topics.include?("*")
 
@@ -119,11 +119,11 @@ module OpenHAB
           service
         end
 
-        def postEvent(event) # rubocop:disable Naming/MethodName
+        def postEvent(event)
           sendEvent(event)
         end
 
-        def sendEvent(event) # rubocop:disable Naming/MethodName
+        def sendEvent(event)
           # prevent re-entrancy
           if (pending_events = Thread.current[:event_admin_pending_events])
             pending_events << event

data/lib/openhab/yard/markdown_helper.rb

@@ -5,6 +5,7 @@ module OpenHAB
     # @!visibility private
     module MarkdownHelper
       include ::YARD::Templates::Helpers::HtmlHelper
+
       # @group Linking Objects and URLs
 
       def diskfile
@@ -44,7 +45,7 @@ module OpenHAB
                       end) + (match ? $`.count("\n") : 0)
               if match
                 log.warn "In file `#{file}':#{line}: Cannot resolve link to #{name} from text#{match ? ":" : "."}\n" \
-                         "\t#{match[1] ? "..." : ""}#{match[2].delete("\n")}#{match[3] ? "..." : ""}"
+                         "\t#{"..." if match[1]}#{match[2].delete("\n")}#{"..." if match[3]}"
                 # Don't strip the link. This is so literals like {RUBY_ENGINE_VERSION} remain as they are,
                 # not stripped to "RUBY_ENGINE_VERSION"
                 next str

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.40.1
+  version: 5.42.0
 platform: ruby
 authors:
 - Brian O'Connell