openhab-jrubyscripting 5.0.0.rc2 → 5.0.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e925ebd72648fa8efb76592f6053d12f2fe9151173fa91d3f47a2d298f268fc
-  data.tar.gz: 6d84217a8505a72e2da686188a741d6644eee645255595d5d2cf455a2840e015
+  metadata.gz: 2e06b71ae524165363db99771e7ef601f542ed14c979572d152b079d70ad82a2
+  data.tar.gz: 0d6002391ed26a68bbb907d94787f510df30ef6ef9a3a7cd445ac9c47122851b
 SHA512:
-  metadata.gz: 5330bd233b45839cf1780815e86d170ff8a33b4093debfe85cae7e09e631d7a14c7bb2c7e84500da6a41fd0b89f81a160e4279659312323e6fb207bd0da6e632
-  data.tar.gz: 28f42c9a625aa33ef258f4d789e9fe116a1bf36e63bc58e2574d1a884ed8bde74bac03484566abd04909462ec4c9bdef543973416a2420fa02fea274122e3889
+  metadata.gz: 05a3016219eaf41fc4af71f1476029e2b8d0b320afc7bed99e9777b7726afc6897328d9aa92f643132e66d647aae8742eca36f26c703ab3763e1738c55d249e1
+  data.tar.gz: d5a7d65543b3628e5c3abfa61cb2aa6d6f10e2ab2bb3334d9f38e1ee8952da655da6360c156d926bd53b25c013c86c7672dc1b492c85aaa056e898579a7be7dd

data/lib/openhab/core/actions.rb

@@ -66,11 +66,15 @@ module OpenHAB
     #
     module Actions
       OSGi.services("org.openhab.core.model.script.engine.action.ActionService")&.each do |service|
-        java_import service.action_class.ruby_class
+        klass = (java_import service.action_class.ruby_class).first
         logger.trace("Loaded ACTION: #{service.action_class}")
+        Object.const_set(service.action_class.simple_name, klass)
       end
       # Import common actions
-      %w[Exec HTTP Ping].each { |action| java_import "org.openhab.core.model.script.actions.#{action}" }
+      %w[Exec HTTP Ping].each do |action|
+        klass = (java_import "org.openhab.core.model.script.actions.#{action}").first
+        Object.const_set(action, klass)
+      end
 
       module_function
 

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

@@ -65,16 +65,23 @@ module OpenHAB
         #
         # Send a command to this item
         #
+        # When this method is chained after the {OpenHAB::DSL::Items::Ensure::Ensurable#ensure ensure}
+        # method, or issued inside an {OpenHAB::DSL.ensure_states ensure_states} block,
+        # the command will only be sent if the item is not already in the same state.
+        #
         # @param [Command] command command to send to the item
-        # @return [self]
+        # @return [self, nil] nil when `ensure` is in effect and the item was already in the same state,
+        #   otherwise the item.
         #
-        # @see DSL::Items::TimedCommand#command
+        # @see DSL::Items::TimedCommand#command Timed Command
+        # @see OpenHAB::DSL.ensure_states ensure_states
+        # @see DSL::Items::Ensure::Ensurable#ensure ensure
         #
         def command(command)
           command = format_command(command)
           logger.trace "Sending Command #{command} to #{name}"
           $events.send_command(self, command)
-          self
+          Proxy.new(self)
         end
 
         # not an alias to allow easier stubbing and overriding
@@ -88,13 +95,14 @@ module OpenHAB
         # Send an update to this item
         #
         # @param [State] state
-        # @return [self]
+        # @return [self, nil] nil when `ensure` is in effect and the item was already in the same state,
+        #   otherwise the item.
         #
         def update(state)
           state = format_update(state)
           logger.trace "Sending Update #{state} to #{name}"
           $events.post_update(self, state)
-          self
+          Proxy.new(self)
         end
 
         #

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

@@ -26,7 +26,7 @@ module OpenHAB
 
           extend Forwardable
           def_delegators :@metadata, :configuration, :hash, :to_s, :uid, :value
-          protected :configuration
+          private :configuration
 
           # @!method to_hash
           #   Implicit conversion to {::Hash}.
@@ -37,6 +37,9 @@ module OpenHAB
           # still others (mutators) must be manually implemented below.
           def_delegators :configuration,
                          :any?,
+                         :compact,
+                         :compare_by_identity?,
+                         :deconstruct_keys,
                          :default,
                          :default_proc,
                          :each,
@@ -47,6 +50,8 @@ module OpenHAB
                          :filter,
                          :flatten,
                          :has_value?,
+                         :invert,
+                         :key,
                          :keys,
                          :length,
                          :rassoc,
@@ -57,8 +62,10 @@ module OpenHAB
                          :to_a,
                          :to_h,
                          :to_hash,
+                         :transform_keys,
+                         :transform_values,
+                         :values,
                          :value?
-          def_delegators :to_h, :invert, :merge, :transform_keys, :transform_values
 
           def_delegator :uid, :namespace
 
@@ -88,7 +95,7 @@ module OpenHAB
           end
 
           # @!visibility private
-          def initialize(metadata)
+          def initialize(metadata = nil)
             @metadata = metadata
           end
 
@@ -156,7 +163,7 @@ module OpenHAB
               return false unless value == other.value
             end
 
-            to_h < other
+            configuration < other
           end
 
           # @!visibility private
@@ -166,7 +173,7 @@ module OpenHAB
               return false unless value == other.value
             end
 
-            to_h <= other
+            configuration <= other
           end
 
           # @!visibility private
@@ -176,7 +183,7 @@ module OpenHAB
 
               return configuration == other.configuration
             elsif value.empty? && other.respond_to?(:to_hash)
-              return configuration.to_h == other.to_hash
+              return configuration == other.to_hash
             end
             false
           end
@@ -188,7 +195,7 @@ module OpenHAB
               return false unless value == other.value
             end
 
-            to_h > other
+            configuration > other
           end
 
           # @!visibility private
@@ -198,7 +205,7 @@ module OpenHAB
               return false unless value == other.value
             end
 
-            to_h >= other
+            configuration >= other
           end
 
           # @!visibility private
@@ -226,13 +233,9 @@ module OpenHAB
             replace({})
           end
 
-          # @!visibility private
-          alias_method :compact, :to_h
-
           # @!visibility private
           def compact!
-            # no action; impossible to have nil keys
-            self
+            replace(compact)
           end
 
           # @!visibility private
@@ -240,16 +243,6 @@ module OpenHAB
             raise NotImplementedError
           end
 
-          # @!visibility private
-          def compare_by_identity?
-            false
-          end
-
-          # @!visibility private
-          def deconstruct_keys
-            self
-          end
-
           # @!visibility private
           def default=(*)
             raise NotImplementedError
@@ -304,11 +297,6 @@ module OpenHAB
             self
           end
 
-          # @!visibility private
-          def key(value)
-            rassoc(value)&.first
-          end
-
           # @!visibility private
           def key?(key)
             configuration.key?(key.to_s)
@@ -360,7 +348,7 @@ module OpenHAB
 
           # @!visibility private
           def slice(*keys)
-            to_h.slice(*keys.map(&:to_s))
+            configuration.slice(*keys.map(&:to_s))
           end
 
           # @!visibility private
@@ -380,11 +368,6 @@ module OpenHAB
             replace(transform_values(&block))
           end
 
-          # @!visibility private
-          def values
-            configuration.values.to_a
-          end
-
           # @!visibility private
           def values_at(*keys)
             configuration.values_at(*keys.map(&:to_s))
@@ -397,6 +380,7 @@ module OpenHAB
 
             [value, to_h].inspect
           end
+          remove_method :to_s
           alias_method :to_s, :inspect
 
           #
@@ -416,7 +400,7 @@ module OpenHAB
               return preferred_provider unless provider
 
               unless provider.is_a?(org.openhab.core.common.registry.ManagedProvider)
-                raise FrozenError, "Cannot modify metadata from provider #{provider.inspect}"
+                raise FrozenError, "Cannot modify metadata from provider #{provider.inspect} for #{uid}."
               end
 
               if preferred_provider != provider

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "delegate"
+
 require_relative "generic_item"
 
 module OpenHAB
@@ -284,7 +286,7 @@ module OpenHAB
         # @return [Object] QuantityType or the original value
         #
         def quantify(value)
-          if value.is_a?(DecimalType) && unit
+          if value.is_a?(DecimalType) && respond_to?(:unit) && unit
             logger.trace("Unitizing #{value} with unit #{unit}")
             QuantityType.new(value.to_big_decimal, unit)
           else

data/lib/openhab/core/items/semantics/enumerable.rb

@@ -72,15 +72,17 @@ module Enumerable
   # @!group Items State and Command Methods
 
   # Send a command to every item in the collection
-  # @return [self]
+  # @return [self, nil] nil when `ensure` is in effect and all the items were already in the same state,
+  #   otherwise self
   def command(command)
-    each { |i| i.command(command) }
+    self if count { |i| i.command(command) }.positive?
   end
 
   # Update the state of every item in the collection
-  # @return [self]
+  # @return [self, nil] nil when `ensure` is in effect and all the items were already in the same state,
+  #   otherwise self
   def update(state)
-    each { |i| i.update(state) }
+    self if count { |i| i.update(state) }.positive?
   end
 
   # @!method refresh

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

@@ -187,11 +187,6 @@ module OpenHAB
         #   end
         #
 
-        # @!visibility private
-        # import the actual semantics action
-        SemanticsAction = org.openhab.core.model.script.actions.Semantics
-        private_constant :SemanticsAction
-
         # import all the semantics constants
         [org.openhab.core.semantics.model.point.Points,
          org.openhab.core.semantics.model.property.Properties,
@@ -223,6 +218,7 @@ module OpenHAB
         #   Property = org.openhab.core.semantics.Property
 
         # put ourself into the global namespace, replacing the action
+        Object.send(:remove_const, :Semantics)
         ::Semantics = self # rubocop:disable Naming/ConstantName
 
         #
@@ -234,7 +230,7 @@ module OpenHAB
         # @return [true, false]
         #
         def location?
-          SemanticsAction.location?(self)
+          Actions::Semantics.location?(self)
         end
 
         #
@@ -246,7 +242,7 @@ module OpenHAB
         # @return [true, false]
         #
         def equipment?
-          SemanticsAction.equipment?(self)
+          Actions::Semantics.equipment?(self)
         end
 
         # Checks if this Item is a {Point}
@@ -257,7 +253,7 @@ module OpenHAB
         # @return [true, false]
         #
         def point?
-          SemanticsAction.point?(self)
+          Actions::Semantics.point?(self)
         end
 
         #
@@ -280,7 +276,7 @@ module OpenHAB
         # @return [GenericItem, nil]
         #
         def location
-          SemanticsAction.get_location(self)&.then(&Proxy.method(:new))
+          Actions::Semantics.get_location(self)&.then(&Proxy.method(:new))
         end
 
         #
@@ -293,7 +289,7 @@ module OpenHAB
         # @return [Class, nil]
         #
         def location_type
-          SemanticsAction.get_location_type(self)&.ruby_class
+          Actions::Semantics.get_location_type(self)&.ruby_class
         end
 
         #
@@ -306,7 +302,7 @@ module OpenHAB
         # @return [GenericItem, nil]
         #
         def equipment
-          SemanticsAction.get_equipment(self)&.then(&Proxy.method(:new))
+          Actions::Semantics.get_equipment(self)&.then(&Proxy.method(:new))
         end
 
         #
@@ -319,7 +315,7 @@ module OpenHAB
         # @return [Class, nil]
         #
         def equipment_type
-          SemanticsAction.get_equipment_type(self)&.ruby_class
+          Actions::Semantics.get_equipment_type(self)&.ruby_class
         end
 
         #
@@ -330,7 +326,7 @@ module OpenHAB
         # @return [Class, nil]
         #
         def point_type
-          SemanticsAction.get_point_type(self)&.ruby_class
+          Actions::Semantics.get_point_type(self)&.ruby_class
         end
 
         #
@@ -341,7 +337,7 @@ module OpenHAB
         # @return [Class, nil]
         #
         def property_type
-          SemanticsAction.get_property_type(self)&.ruby_class
+          Actions::Semantics.get_property_type(self)&.ruby_class
         end
 
         # @!attribute [r] semantic_type
@@ -355,7 +351,7 @@ module OpenHAB
         # @return [Class, nil]
         #
         def semantic_type
-          SemanticsAction.get_semantic_type(self)&.ruby_class
+          Actions::Semantics.get_semantic_type(self)&.ruby_class
         end
 
         #
@@ -409,7 +405,7 @@ module Enumerable
   # Returns a new array of items that are a semantics Location (optionally of the given type)
   # @return [Array<GenericItem>]
   def locations(type = nil)
-    if type && (!type.is_a?(Module) || !(type < OpenHAB::Core::Items::Semantics::Location))
+    if type && (!type.is_a?(Module) || !(type < Semantics::Location))
       raise ArgumentError, "type must be a subclass of Location"
     end
 
@@ -432,7 +428,7 @@ module Enumerable
   # @example Get all TVs in a room
   #   lGreatRoom.equipments(Semantics::Screen)
   def equipments(type = nil)
-    if type && (!type.is_a?(Module) || !(type < OpenHAB::Core::Items::Semantics::Equipment))
+    if type && (!type.is_a?(Module) || !(type < Semantics::Equipment))
       raise ArgumentError, "type must be a subclass of Equipment"
     end
 
@@ -457,19 +453,19 @@ module Enumerable
     end
     unless point_or_property_types.all? do |tag|
              tag.is_a?(Module) &&
-             (tag < OpenHAB::Core::Items::Semantics::Point || tag < OpenHAB::Core::Items::Semantics::Property)
+             (tag < Semantics::Point || tag < Semantics::Property)
            end
       raise ArgumentError, "point_or_property_types must all be a subclass of Point or Property"
     end
-    if point_or_property_types.count { |tag| tag < OpenHAB::Core::Items::Semantics::Point } > 1 ||
-       point_or_property_types.count { |tag| tag < OpenHAB::Core::Items::Semantics::Property } > 1
+    if point_or_property_types.count { |tag| tag < Semantics::Point } > 1 ||
+       point_or_property_types.count { |tag| tag < Semantics::Property } > 1
       raise ArgumentError, "point_or_property_types cannot both be a subclass of Point or Property"
     end
 
     select do |point|
       point.point? && point_or_property_types.all? do |tag|
-        (tag < OpenHAB::Core::Items::Semantics::Point && point.point_type <= tag) ||
-          (tag < OpenHAB::Core::Items::Semantics::Property && point.property_type&.<=(tag))
+        (tag < Semantics::Point && point.point_type <= tag) ||
+          (tag < Semantics::Property && point.property_type&.<=(tag))
       end
     end
   end

data/lib/openhab/core/profile_factory.rb

@@ -87,6 +87,8 @@ module OpenHAB
           DSL::ThreadLocal.thread_local(**@thread_locals) do
             @block.call(event, **kwargs)
           rescue Exception => e
+            raise if defined?(::RSpec)
+
             @block.binding.eval("self").logger.log_exception(e)
           end
         end
@@ -96,6 +98,19 @@ module OpenHAB
 
       def initialize
         @profiles = {}
+
+        @registration = OSGi.register_service(self)
+        ScriptHandling.script_unloaded { unregister }
+      end
+
+      #
+      # Unregister the ProfileFactory OSGi service
+      #
+      # @!visibility private
+      # @return [void]
+      #
+      def unregister
+        @registration.unregister
       end
 
       # @!visibility private
@@ -111,8 +126,5 @@ module OpenHAB
         @profiles.keys
       end
     end
-
-    registration = OSGi.register_service(ProfileFactory.instance)
-    ScriptHandling.script_unloaded { registration.unregister }
   end
 end

data/lib/openhab/core/provider.rb

@@ -13,6 +13,7 @@ module OpenHAB
       TYPE_TO_PROVIDER_TYPE = {
         org.openhab.core.items.Item.java_class => :items,
         org.openhab.core.items.Metadata.java_class => :metadata,
+        org.openhab.core.automation.Rule.java_class => :rules,
         org.openhab.core.thing.Thing.java_class => :things,
         org.openhab.core.thing.link.ItemChannelLink.java_class => :links
       }.freeze
@@ -37,6 +38,7 @@ module OpenHAB
     # @abstract
     class Provider < org.openhab.core.common.registry.AbstractProvider
       include org.openhab.core.common.registry.ManagedProvider
+      include Enumerable
       include Singleton
       public_class_method :new
 
@@ -140,6 +142,11 @@ module OpenHAB
         end
       end
 
+      # @!visibility private
+      def each(&block)
+        @elements.each_value(&block)
+      end
+
       # @return [String]
       def inspect
         "#<#{self.class.name}:#{object_id}>"
@@ -192,7 +199,7 @@ module OpenHAB
       def update(element)
         old_element = @elements[element.uid]
         if old_element
-          @elements[element.uid]
+          @elements[element.uid] = element
           notify_listeners_about_updated_element(old_element, element)
         end
         old_element
@@ -205,11 +212,11 @@ module OpenHAB
 
       private
 
-      def initialize
-        super
+      def initialize(script_unloaded_before: nil)
+        super()
         @elements = {}
         self.class.registry.add_provider(self)
-        ScriptHandling.script_unloaded { unregister }
+        ScriptHandling.script_unloaded(before: script_unloaded_before) { unregister }
       end
     end
   end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module Core
+    module Rules
+      # @interface
+      java_import org.openhab.core.automation.Module
+
+      # @!visibility private
+      module Module
+        # @return [String]
+        def inspect
+          r = "#<OpenHAB::Core::Rules::#{self.class.simple_name} #{id} (#{type_uid})"
+          r += " #{label.inspect}" if label
+          r += " configuration=#{configuration.properties.to_h}" unless configuration.properties.empty?
+          "#{r}>"
+        end
+
+        # @return [String]
+        def to_s
+          id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module Core
+    module Rules
+      #
+      # Provides rules created in Ruby to openHAB
+      #
+      class Provider < Core::Provider
+        include org.openhab.core.automation.RuleProvider
+
+        class << self
+          #
+          # The Rule registry
+          #
+          # @return [org.openhab.core.automation.RuleRegistry]
+          #
+          def registry
+            $rules
+          end
+        end
+
+        def initialize
+          super(script_unloaded_before: lambda do |callbacks|
+            callbacks.index do |cb|
+              case cb.binding.receiver
+              when Items::Provider,
+                Things::Provider,
+                DSL::TimerManager
+                true
+              else
+                false
+              end
+            end
+          end)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module OpenHAB
+  module Core
+    module Rules
+      #
+      # Provides access to all OpenHAB {Rule rules}, and acts like an array.
+      #
+      class Registry
+        include LazyArray
+        include Singleton
+
+        #
+        # Gets a specific Rule
+        #
+        # @param [String] uid Rule UID
+        # @return [Rule, nil]
+        #
+        def [](uid)
+          $rules.get(uid)
+        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
+        end
+
+        #
+        # Enter the Rule Builder DSL.
+        # @param (see Core::Provider.current)
+        # @yield Block executed in the context of a {DSL::Rules::Builder}.
+        # @return [Object] The result of the block.
+        #
+        def build(preferred_provider = nil, &block)
+          DSL::Rules::Builder.new(preferred_provider).instance_eval(&block)
+        end
+
+        #
+        # Remove a Rule.
+        #
+        # The rule must be a managed thing (typically created by Ruby or in the UI).
+        #
+        # @param [String, Rule] rule_uid
+        # @return [Rule, nil] The removed rule, if found.
+        #
+        # @example
+        #   my_rule = rule do
+        #     every :day
+        #     run { nil }
+        #   end
+        #
+        #   rules.remove(my_rule)
+        #
+        def remove(rule_uid)
+          rule_uid = rule_uid.uid if rule_uid.is_a?(Rule)
+          provider = Provider.registry.provider_for(rule_uid)
+          unless provider.is_a?(org.openhab.core.common.registry.ManagedProvider)
+            raise "Cannot remove rule #{rule_uid} from non-managed provider #{provider.inspect}"
+          end
+
+          provider.remove(rule_uid)
+        end
+      end
+    end
+  end
+end