openhab-scripting 5.2.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d56223cd6766da527070ec31571d7a22cffa7d69ec754a1a1dbeb06c9354d56
-  data.tar.gz: c635cf86c119c54c4b665f28cd91b0804a58c868d23f7a99420d4183f60bf195
+  metadata.gz: 0522f086fca640c17a05634e13924dd9e39fc0630fba03954d4c0ffcfc1739c7
+  data.tar.gz: 9c01b1545d9e999ecc9ff0836691ef858794085ffb09433a3636c7594251e13b
 SHA512:
-  metadata.gz: 79e7ac98695e1fb75a6bf100226a555d2d1d8f7a96efa0779b42439e262bfb63777ee99545782885f509c08f21dc77b2b504fd13078a5e5bc1d82ce456e3cca9
-  data.tar.gz: d735f987f2540cba7b358a4f0550ed723ef807b0a4c5e12ab21177cc844f65a2eec1080778b996e702cd72a5d744b1a7c97fe52ba5679a17a13b4988ccd2bf76
+  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/core_ext/ruby/object.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module CoreExt
+    module Ruby
+      # @!visibility private
+      module Object
+        class << self
+          attr_reader :top_self
+        end
+
+        # @!visibility private
+        module ClassMethods
+          # capture methods defined at top level (which get added to Object)
+          def method_added(method)
+            return super unless equal?(::Object)
+
+            if DSL.private_instance_methods.include?(method)
+              # Duplicate methods that conflict with DSL onto `main`'s singleton class,
+              # so that they'll take precedence over DSL's method.
+              Object.top_self.singleton_class.define_method(method, instance_method(method))
+            end
+
+            super
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -22,6 +22,12 @@ module OpenHAB
       #     group_item Equipment, tags: Semantics::HVAC, thing: "binding:thing"
       #       string_item Mode, tags: Semantics::Control, channel: "mode"
       #     end
+      #
+      #     # dimension Temperature inferred
+      #     number_item OutdoorTemp, format: "%.1f %unit%", unit: "°F"
+      #
+      #     # unit lx, dimension Illuminance, format "%s %unit%" inferred
+      #     number_item OutdoorBrightness, state: 10_000 | "lx"
       #   end
       #
       module Builder
@@ -156,9 +162,22 @@ module OpenHAB
         # @return [String, nil]
         attr_accessor :label
         # Unit dimension (for number items only)
+        #
+        # If {unit} is provided, and {dimension} is not, it will be inferred.
+        #
         # @return [String, nil]
         attr_accessor :dimension
+        # Unit (for number items only)
+        #
+        # Due to {format} inference, setting the unit is cross-compatible with
+        # openHAB 3.4 and 4.0.
+        #
+        # @return [String, nil]
+        attr_reader :unit
         # The formatting pattern for the item's state
+        #
+        # If {unit} is provided, and {format} is not, it will be inferred.
+        #
         # @return [String, nil]
         attr_accessor :format
         # The icon to be associated with the item
@@ -179,13 +198,16 @@ module OpenHAB
         # @return [Core::Items::Metadata::NamespaceHash]
         attr_reader :metadata
         # Initial state
+        #
+        # If {state} is set to a {QuantityType}, and {unit} is not set, it will be inferred.
+        #
         # @return [Core::Types::State]
-        attr_accessor :state
+        attr_reader :state
 
         class << self
           # @!visibility private
           def item_factory
-            @item_factory ||= org.openhab.core.library.CoreItemFactory.new
+            @item_factory ||= OpenHAB::OSGi.service("org.openhab.core.items.ItemFactory")
           end
 
           #
@@ -214,6 +236,7 @@ module OpenHAB
         end
 
         # @param dimension [Symbol, nil] The unit dimension for a {NumberItem} (see {ItemBuilder#dimension})
+        # @param unit [Symbol, String, nil] The unit for a {NumberItem} (see {ItemBuilder#unit})
         # @param format [String, nil] The formatting pattern for the item's state (see {ItemBuilder#format})
         # @param icon [Symbol, nil] The icon to be associated with the item (see {ItemBuilder#icon})
         # @param group [String,
@@ -246,6 +269,7 @@ module OpenHAB
         def initialize(type, name = nil, label = nil,
                        provider:,
                        dimension: nil,
+                       unit: nil,
                        format: nil,
                        icon: nil,
                        group: nil,
@@ -274,6 +298,7 @@ module OpenHAB
           @label = label
           @dimension = dimension
           @format = format
+          self.unit = unit
           @icon = icon
           @groups = []
           @tags = []
@@ -291,7 +316,7 @@ module OpenHAB
           self.alexa(alexa) if alexa
           self.ga(ga) if ga
           self.homekit(homekit) if homekit
-          @state = state
+          self.state = state
 
           self.group(*group)
           self.group(*groups)
@@ -434,6 +459,39 @@ module OpenHAB
           @expire += ",command=#{command}" if command
         end
 
+        # @!attribute [w] unit
+        #
+        # Unit (for number items only).
+        #
+        # If dimension or format are not yet set, they will be inferred.
+        #
+        # @return [String, nil]
+        def unit=(unit)
+          @unit = unit
+
+          self.dimension ||= unit && org.openhab.core.types.util.UnitUtils.parse_unit(unit)&.then do |u|
+            org.openhab.core.types.util.UnitUtils.get_dimension_name(u)
+          end
+          self.format ||= unit && (if Gem::Version.new(Core::VERSION) >= Gem::Version.new("4.0.0.M3")
+                                     "%s %unit%"
+                                   else
+                                     "%s #{unit.gsub("%", "%%")}"
+                                   end)
+        end
+
+        # @!attribute [w] state
+        #
+        # Initial state
+        #
+        # If {state} is set to a {QuantityType}, and {unit} is not set, it will be inferred.
+        #
+        # @return [Core::Types::State]
+        def state=(state)
+          @state = state
+
+          self.unit ||= state.unit.to_s if state.is_a?(QuantityType)
+        end
+
         # @!visibility private
         def build
           item = create_item
@@ -450,6 +508,7 @@ module OpenHAB
           item.metadata["autoupdate"] = autoupdate.to_s unless autoupdate.nil?
           item.metadata["expire"] = expire if expire
           item.metadata["stateDescription"] = { "pattern" => format } if format
+          item.metadata["unit"] = unit if unit
           item.state = item.format_update(state) unless state.nil?
           item
         end
@@ -488,6 +547,12 @@ module OpenHAB
       class GroupItemBuilder < ItemBuilder
         include Builder
 
+        # This has to be duplicated here, since {Builder} includes DSL, so DSL#unit
+        # will be seen first, but we really want ItemBuilder#unit
+
+        # (see ItemBuilder#unit)
+        attr_reader :unit
+
         Builder.public_instance_methods.each do |m|
           next unless Builder.instance_method(m).owner == Builder
 

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.2.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) }
@@ -975,5 +980,8 @@ OpenHAB::Core::Items.import_into_global_namespace
 
 # Extend `main` with DSL methods
 singleton_class.include(OpenHAB::DSL)
+# Patch Object to work around https://github.com/openhab/openhab-jruby/issues/4
+Object.extend(OpenHAB::CoreExt::Ruby::Object::ClassMethods)
+OpenHAB::CoreExt::Ruby::Object.instance_variable_set(:@top_self, self)
 
 logger.debug "openHAB JRuby Scripting Library Version #{OpenHAB::DSL::VERSION} Loaded"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.4.0
 platform: ruby
 authors:
 - Brian O'Connell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-02 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
@@ -504,6 +505,7 @@ files:
 - lib/openhab/core_ext/ruby/date_time.rb
 - lib/openhab/core_ext/ruby/module.rb
 - lib/openhab/core_ext/ruby/numeric.rb
+- lib/openhab/core_ext/ruby/object.rb
 - lib/openhab/core_ext/ruby/range.rb
 - lib/openhab/core_ext/ruby/symbol.rb
 - lib/openhab/core_ext/ruby/time.rb