openhab-scripting 5.3.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a914cbf39d73f385d8f250fb88a72737cabec9106871009f0b4679176251680a
-  data.tar.gz: 402616a86763701e48146d24581c340287c060bb8e86fb28e9c2e1947e19b129
+  metadata.gz: 0522f086fca640c17a05634e13924dd9e39fc0630fba03954d4c0ffcfc1739c7
+  data.tar.gz: 9c01b1545d9e999ecc9ff0836691ef858794085ffb09433a3636c7594251e13b
 SHA512:
-  metadata.gz: a860c8a2969e3a10b513650f265a3291f1cc5b91fa0b9d1775f40e254904175fe6e077881cb24ebef13677085705c3ae2248420064154da61a7ced4af4a91c67
-  data.tar.gz: 13e3da787706aee119334f4e768a9af3d2eaefc38afb8b2e6618e74e6591bc8cfcfa7ff137fa514d2bed2831e416f6112d8a27b7a6a8a205fdf8eefdbaafff31
+  metadata.gz: c1c7e125bb92764cc330924cacc30b03bf8759633bf34e51000897614af32efa2bcddfd2c48e5514be160d6c2d625eb38449c4d6203c5ca418bf67868d302aa2
+  data.tar.gz: 61742a93f67041588c6f6af954f95dd7515d8ee2d913812f5ac32212a8ddc49f979da4712125d1b15ca327b130ec81102308edbe5689f43e386d24b46f185357

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

@@ -74,19 +74,19 @@ module OpenHAB
         #
         # Returns all Scenes (rules tagged with "Scene")
         #
-        # @return [Array<Rule>] A list of all the scenes
+        # @return [TaggedArray] A list of all the scenes
         #
         def scenes
-          tagged("Scene")
+          @scenes ||= TaggedArray.new("Scene")
         end
 
         #
         # Returns all Scripts (rules tagged with "Script")
         #
-        # @return [Array<Rule>] A list of all the scripts
+        # @return [TaggedArray] A list of all the scripts
         #
         def scripts
-          tagged("Script")
+          @scripts ||= TaggedArray.new("Script")
         end
       end
     end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module OpenHAB
+  module Core
+    module Rules
+      #
+      # Provides access to a set of openHAB {Rule rules}, and acts like an array.
+      #
+      class TaggedArray
+        include LazyArray
+
+        def initialize(tag)
+          @tag = tag
+        end
+
+        #
+        # Gets a specific Rule
+        #
+        # @param [String] uid Rule UID
+        # @return [Rule, nil]
+        #
+        def [](uid)
+          rule = $rules.get(uid)
+          rule.tagged?(@tag) ? rule : nil
+        end
+        alias_method :include?, :[]
+        alias_method :key?, :[]
+        # @deprecated
+        alias_method :has_key?, :[]
+
+        #
+        # Explicit conversion to array
+        #
+        # @return [Array<Rule>]
+        #
+        def to_a
+          $rules.all.to_a.tagged(@tag)
+        end
+      end
+    end
+  end
+end

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

@@ -35,8 +35,7 @@ module OpenHAB
           super()
           set_name(config.name)
           set_description(config.description)
-          tags = DSL::Items::ItemBuilder.normalize_tags(*config.tags)
-          set_tags(tags.to_set)
+          set_tags(config.tags.to_set)
           set_triggers(config.triggers)
           self.uid = config.uid
           @run_context = config.caller

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

@@ -104,7 +104,37 @@ module OpenHAB
           ThreadLocal.thread_local(openhab_rule_type: "script", openhab_rule_uid: id) do
             builder = BuilderDSL.new(block.binding)
             builder.uid(id)
-            builder.tags(["Script"])
+            builder.tags("Script")
+            builder.name(name)
+            builder.script(&block)
+            logger.trace { builder.inspect }
+            builder.build(provider, script)
+          end
+        end
+
+        #
+        # Create a new scene
+        #
+        # A scene is a rule with no triggers. It can be called by various other actions,
+        # such as the Run Rules action.
+        #
+        # @param [String] name A descriptive name
+        # @param [String] id The script's ID
+        # @yield [] Block executed when the script is executed.
+        # @return [Core::Rules::Rule]
+        #
+        def scene(name = nil, id: nil, script: nil, &block)
+          raise ArgumentError, "Block is required" unless block
+
+          id ||= NameInference.infer_rule_id_from_block(block)
+          name ||= id
+          script ||= block.source rescue nil # rubocop:disable Style/RescueModifier
+
+          builder = nil
+          ThreadLocal.thread_local(openhab_rule_type: "script", openhab_rule_uid: id) do
+            builder = BuilderDSL.new(block.binding)
+            builder.uid(id)
+            builder.tags("Scene")
             builder.name(name)
             builder.script(&block)
             logger.trace { builder.inspect }
@@ -354,7 +384,7 @@ module OpenHAB
         prop :description
 
         #
-        # @!method tags(tags)
+        # @!method tags(*tags)
         #
         # Set the rule's tags.
         #
@@ -1082,6 +1112,7 @@ module OpenHAB
 
           raise ArgumentError, "Missing cron expression or elements" unless expression
 
+          add_tag("Schedule")
           cron = Cron.new(rule_triggers: @rule_triggers)
           cron.trigger(config: { "cronExpression" => expression }, attach: attach)
         end
@@ -1180,6 +1211,7 @@ module OpenHAB
           if value == :day && at.is_a?(Item)
             raise ArgumentError, "Attachments are not supported with dynamic datetime triggers" unless attach.nil?
 
+            add_tag("Schedule")
             return trigger("timer.DateTimeTrigger", itemName: at.name, timeOnly: true)
           end
 
@@ -1561,6 +1593,7 @@ module OpenHAB
         #
         def at(item)
           item = item.name if item.is_a?(Item)
+          add_tag("Schedule")
           trigger("timer.DateTimeTrigger", itemName: item.to_s)
         end
 
@@ -1847,6 +1880,15 @@ module OpenHAB
 
         private
 
+        # Adds a single tag to this rule
+        # @param [String] tag The tag (it will not be normalized)
+        # @return [void]
+        def add_tag(tag)
+          # have to normalize tags first
+          @tags = DSL::Items::ItemBuilder.normalize_tags(*tags)
+          @tags << tag unless @tags.include?(tag)
+        end
+
         # Calls the on_load block, with a delay if specified
         # @yield block to execute on load time
         # @yieldparam [String] module The module ID that identifies this on_load event
@@ -1871,7 +1913,8 @@ module OpenHAB
         # @return [true,false] true if it should be created, false otherwise
         #
         def create_rule?
-          return true if tags.include?("Script")
+          @tags = DSL::Items::ItemBuilder.normalize_tags(*tags)
+          return true unless (tags & %w[Script Scene]).empty?
 
           if !triggers?
             logger.warn "Rule '#{uid}' has no triggers, not creating rule"

data/lib/openhab/dsl/rules/triggers/cron/cron_handler.rb

@@ -51,7 +51,7 @@ module OpenHAB
             # @return [CronAdjuster]
             #
             def getTemporalAdjuster # rubocop:disable Naming/MethodName
-              org.openhab.core.scheduler.CronAdjuster.new(expression)
+              org.openhab.core.scheduler.CronAdjuster.new(@expression)
             end
 
             #

data/lib/openhab/dsl/version.rb

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

data/lib/openhab/dsl.rb

@@ -59,6 +59,11 @@ module OpenHAB
       rules.build { rule(name, **kwargs, &block) }
     end
 
+    # (see Rules::Builder#scene)
+    def scene(name = nil, id: nil, **kwargs, &block)
+      rules.build { scene(name, id: id, **kwargs, &block) }
+    end
+
     # (see Rules::Builder#script)
     def script(name = nil, id: nil, **kwargs, &block)
       rules.build { script(name, id: id, **kwargs, &block) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.4.0
 platform: ruby
 authors:
 - Brian O'Connell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-31 00:00:00.000000000 Z
+date: 2023-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -447,6 +447,7 @@ files:
 - lib/openhab/core/rules/provider.rb
 - lib/openhab/core/rules/registry.rb
 - lib/openhab/core/rules/rule.rb
+- lib/openhab/core/rules/tagged_array.rb
 - lib/openhab/core/script_handling.rb
 - lib/openhab/core/things.rb
 - lib/openhab/core/things/channel.rb