openhab-scripting 5.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2826f669c876cc9b59863c2107bc8b1af62327d22c4551ef062f1b7bc97aabb
-  data.tar.gz: 61bd119ddc94019361d0150ed8bc1e92b5b42de9f610599f1305fbf04055cb14
+  metadata.gz: 68c866fadb2ec59386b79d7cf485f943291ca68670d473f5986ca8dc07880ff3
+  data.tar.gz: 9e8fb64b69836d4c09151182fe141abd3edf89335fef740da61c6d0dee568966
 SHA512:
-  metadata.gz: 0bf813e7b4aba75c75979c05fc317982dfb1ca94b0eae9de656ed342b1861b293ebb8912ed7935ba709b90506a169be6013b92278281ab4dafdb3205e215f927
-  data.tar.gz: 74a35427271bcae3fd179c3ffd1710f145457e8ae1010481b27310aa28bf710c359f784c6893ed630f2737f1f029c43b7c5f925ceed7cb119239c7cfe77a77e7
+  metadata.gz: 1c8d424bc4c0a225e667d29db37feb0b401de28bc2034de483e67d0b437818645fff89db102a911a2612041058c38229cdafd6e4934159a5e9a19734e53ea5e0
+  data.tar.gz: ee0579104e4b8e33aa31de24c9a61d4a1d77e53250ca8ad3f2063f0bdd0efe81dcf1b69a75c9da5ab090e8f85a6a9f57979f11d0bad41e574f9987234fa5dbf9

data/lib/openhab/core/actions/audio.rb

@@ -23,7 +23,14 @@ module OpenHAB
           #
           def play_sound(filename, sink: nil, volume: nil)
             volume = PercentType.new(volume) unless volume.is_a?(PercentType) || volume.nil?
-            playSound(sink&.to_s, filename.to_s, volume)
+            # JRuby calls the wrong overloaded method when volume is given, but sink is nil
+            # will call playSound(String, String, float) instead of playSound(String, String, PercentType)
+            # and end up with argument type mismatched. So we need to give it a bit of help here.
+            if sink
+              playSound(sink.to_s, filename.to_s, volume)
+            else
+              playSound(filename.to_s, volume)
+            end
           end
 
           #

data/lib/openhab/core/events/item_state_updated_event.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "item_state_event"
+
+module OpenHAB
+  module Core
+    module Events
+      begin
+        java_import org.openhab.core.items.events.ItemStateUpdatedEvent
+
+        #
+        # {AbstractEvent} sent when an item's state has updated.
+        #
+        class ItemStateUpdatedEvent < ItemEvent
+          include ItemState
+        end
+      rescue NameError
+        # @deprecated OH3.4 OH3 will raise an error ItemStateUpdatedEvent is only in OH4
+      end
+    end
+  end
+end

data/lib/openhab/core/rules/registry.rb

@@ -70,6 +70,24 @@ module OpenHAB
 
           provider.remove(rule_uid)
         end
+
+        #
+        # Returns all Scenes (rules tagged with "Scene")
+        #
+        # @return [Array<Rule>] A list of all the scenes
+        #
+        def scenes
+          tagged("Scene")
+        end
+
+        #
+        # Returns all Scripts (rules tagged with "Script")
+        #
+        # @return [Array<Rule>] A list of all the scripts
+        #
+        def scripts
+          tagged("Script")
+        end
       end
     end
   end

data/lib/openhab/core/rules/rule.rb

@@ -11,6 +11,15 @@ module OpenHAB
       # met, enabling the core dynamic functionality of openHAB.
       #
       module Rule
+        # @!attribute [r] name
+        #   @return [String,nil] The rule's human-readable name
+
+        # @!attribute [r] description
+        #   @return [String,nil] The rule's description
+
+        # @!attribute [r] tags
+        #   @return [Array<Tag>] The rule's list of tags
+
         #
         # @!method visible?
         #   Check if visibility == `VISIBLE`
@@ -102,12 +111,27 @@ module OpenHAB
           info.nil? || info.status_detail == RuleStatusDetail::DISABLED
         end
 
+        #
+        # Checks if this rule has at least one of the given tags.
+        #
+        # (see Items::Item#tagged)
+        #
+        # @example Find rules tagged with "Halloween"
+        #   rules.tagged?("Halloweed")
+        #
+        def tagged?(*tags)
+          tags.map! do |tag|
+            tag.is_a?(::Module) ? tag.simple_name : tag # ::Module to distinguish against Rule::Module!
+          end
+          !(self.tags.to_a & tags).empty?
+        end
+
         #
         # @!attribute [r] status
-        # @return [RuleStatus nil]
+        # @return [RuleStatus, nil]
         #
         def status
-          Rules.manager.get_status(uid)
+          Rules.manager&.get_status(uid)
         end
 
         #
@@ -115,7 +139,7 @@ module OpenHAB
         # @return [RuleStatusInfo, nil]
         #
         def status_info
-          Rules.manager.get_status_info(uid)
+          Rules.manager&.get_status_info(uid)
         end
 
         # @return [String]

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

@@ -76,8 +76,10 @@ module OpenHAB
         # This method gets called in rspec's SuspendRules as well
         def execute!(mod, inputs)
           ThreadLocal.thread_local(**@thread_locals) do
-            logger.trace { "Execute called with mod (#{mod&.to_string}) and inputs (#{inputs.inspect})" }
-            logger.trace { "Event details #{inputs["event"].inspect}" } if inputs&.key?("event")
+            if logger.trace?
+              logger.trace("Execute called with mod (#{mod&.to_string}) and inputs (#{inputs.inspect})")
+              logger.trace("Event details #{inputs["event"].inspect}") if inputs&.key?("event")
+            end
             trigger_conditions(inputs).process(mod: mod, inputs: inputs) do
               event = extract_event(inputs)
               @debouncer.call { process_queue(create_queue(event), mod, event) }

data/lib/openhab/dsl/version.rb

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

data/lib/openhab/dsl.rb

@@ -500,7 +500,7 @@ module OpenHAB
     # @example Prevent door bell from ringing repeatedly
     #   # This can be called from a UI rule.
     #   # For file based rule, use the `only_every` rule guard
-    #   only_every(30.seconds) do { Audio.play_sound("doorbell.mp3") }
+    #   only_every(30.seconds) { Audio.play_sound("doorbell.mp3") }
     #
     # @see Rules::BuilderDSL#debounce_for Rule builder's debounce_for for a detailed description
     # @see Rules::BuilderDSL#only_every

data/lib/openhab/yard/html_helper.rb

@@ -45,7 +45,7 @@ module OpenHAB
         html.css("h1, h2, h3, h4, h5, h6").each do |header|
           next if header["id"]
 
-          id = header.text.strip.downcase.delete(%(.?"')).tr(" ", "-")
+          id = header.text.strip.downcase.delete(%(.?"')).gsub(/[ ,]+/, "-")
           header["id"] = id
           header.prepend_child(%(<a href="##{id}" class="header-anchor">#</a>))
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Brian O'Connell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -379,6 +379,7 @@ files:
 - lib/openhab/core/events/item_event.rb
 - lib/openhab/core/events/item_state_changed_event.rb
 - lib/openhab/core/events/item_state_event.rb
+- lib/openhab/core/events/item_state_updated_event.rb
 - lib/openhab/core/events/thing_status_info_event.rb
 - lib/openhab/core/items.rb
 - lib/openhab/core/items/accepted_data_types.rb