openhab-jrubyscripting 5.0.0.rc3 → 5.0.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce249607265a008aa969e2edbd56302edd70a67a01dfebaec9ad67b7e5f1ad27
-  data.tar.gz: ac0c8d25509a8be8374a3f15fecd2e575da8cb08b82268aef41414f64f7a3b38
+  metadata.gz: 2e06b71ae524165363db99771e7ef601f542ed14c979572d152b079d70ad82a2
+  data.tar.gz: 0d6002391ed26a68bbb907d94787f510df30ef6ef9a3a7cd445ac9c47122851b
 SHA512:
-  metadata.gz: 7c082f0949b6bc55ebf48b1489eade3f6bbcf25181d6741e29697dbb5ef5221abf583c78fb8ad46596b5ea10957e9d4b5d2d5dfe35097eea004f005d06683d48
-  data.tar.gz: ee7e740d0dd1233462521313c31145971bed68e2830c765bad27b8762d064bdf154993a2d733fc7743240bd55aec9e0eecd8cb4f2d569dbd0c599e765140cd06
+  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/metadata/hash.rb

@@ -380,6 +380,7 @@ module OpenHAB
 
             [value, to_h].inspect
           end
+          remove_method :to_s
           alias_method :to_s, :inspect
 
           #
@@ -399,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

@@ -286,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.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

@@ -98,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
@@ -113,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

@@ -212,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

@@ -19,6 +19,21 @@ module OpenHAB
             $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

data/lib/openhab/core/script_handling.rb

@@ -29,9 +29,11 @@ module OpenHAB
       #   end
       #
       def script_loaded(&block)
-        Core::ScriptHandlingCallbacks.script_loaded_hooks << block
+        ScriptHandlingCallbacks.script_loaded_hooks << block
       end
 
+      #
+      # @!method script_unloaded(&block)
       #
       # Add a block of code to be executed when the script is unloaded.
       #
@@ -47,8 +49,10 @@ module OpenHAB
       #     logger.info 'Hi, this script has been unloaded'
       #   end
       #
-      def script_unloaded(&block)
-        Core::ScriptHandlingCallbacks.script_unloaded_hooks << block
+      def script_unloaded(before: nil, &block)
+        # `before` is as yet undocumented, because I'm not set on its interface
+        index = before.call(ScriptHandlingCallbacks.script_unloaded_hooks) if before
+        ScriptHandlingCallbacks.script_unloaded_hooks.insert(index || -1, block)
       end
     end
 
@@ -58,6 +62,13 @@ module OpenHAB
     # @!visibility private
     module ScriptHandlingCallbacks
       class << self
+        #
+        # Has the script completed loading?
+        #
+        # @!visibility private
+        # @return [true, false]
+        attr_accessor :script_loaded
+
         #
         # Return script_loaded_hooks
         #
@@ -74,6 +85,7 @@ module OpenHAB
           @script_unloaded_hooks ||= []
         end
       end
+      self.script_loaded = false
 
       #
       # Executed when OpenHAB unloads a script file
@@ -85,6 +97,22 @@ module OpenHAB
         rescue => e
           logger.error("Failed to call script_unloaded hook #{hook}: #{e}")
         end
+
+        return if ScriptHandlingCallbacks.script_loaded
+
+        # Make sure we terminate the main thread if it's still set up, in case
+        # it's timing out and that's why we're unloading.
+        #
+        # It would seem simpler to just record Thread.current when this file
+        # loads, but if the user is using the autorequire feature of the
+        # jrubyscripting addon, this file will load before the main script.
+        #
+        # Note that Thread.list only includes threads that have had Ruby
+        # execute in them, so we don't need to worry about accidentally killing
+        # a random Java thread.
+        #
+        main_thread = Thread.list.find { |t| t != Thread.current && t.name.include?("-safeCall-") }
+        main_thread&.raise(Interrupt.new)
       end
 
       #
@@ -97,6 +125,7 @@ module OpenHAB
         rescue => e
           logger.error("Failed to call script_loaded hook #{hook}: #{e}")
         end
+        ScriptHandlingCallbacks.script_loaded = true
       end
     end
   end

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

@@ -5,7 +5,7 @@ require_relative "time"
 module OpenHAB
   module CoreExt
     module Java
-      java_import java.time.Month
+      Month = java.time.Month
 
       # Extensions to Month
       class Month

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

@@ -87,5 +87,6 @@ class Date
     [other.to_date, self]
   end
 
+  remove_method :inspect
   alias_method :inspect, :to_s
 end

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

@@ -1417,7 +1417,7 @@ module OpenHAB
           added_rule = add_rule(provider, rule)
           # add config so that MainUI can show the script
           added_rule.actions.first.configuration.put("type", "application/x-ruby")
-          added_rule.actions.first.configuration.put("script", script)
+          added_rule.actions.first.configuration.put("script", script) if script
 
           rule.execute(nil, { "event" => Struct.new(:attachment).new(start_attachment) }) if on_start?
           added_rule

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

@@ -44,7 +44,7 @@ module OpenHAB
         def append_trigger(type:, config:, attach: nil, conditions: nil)
           config.transform_keys!(&:to_s)
           RuleTriggers.trigger(type: type, config: config).tap do |trigger|
-            logger.trace("Appending trigger (#{trigger}) attach (#{attach}) conditions(#{conditions})")
+            logger.trace("Appending trigger (#{trigger.inspect}) attach (#{attach}) conditions(#{conditions})")
             @triggers << trigger
             @attachments[trigger.id] = attach if attach
             @trigger_conditions[trigger.id] = conditions if conditions

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

@@ -109,7 +109,7 @@ module OpenHAB
               state, = retrieve_states(inputs)
               if state == @tracking_to
                 logger.trace("Item changed to #{state} for #{self}, rescheduling timer.")
-                @timer.reschedule(ZonedDateTime.now.plus(@duration))
+                @timer.reschedule(@duration)
               else
                 logger.trace("Item changed to #{state} for #{self}, canceling timer.")
                 @timer.cancel

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.rc3"
+    VERSION = "5.0.0.rc4"
   end
 end

data/lib/openhab/log.rb

@@ -235,12 +235,19 @@ module OpenHAB
     alias_method :to_s, :inspect
 
     # @!attribute [rw] level
+    #
+    # @note When a logger's level is modified, the logging infrastructure has
+    #   to reload, and logging may be completely unavailable for a short time.
+    #
     # @return [:error,:warn,:info,:debug,:trace] The current log level
+    #
     def level
       Logger.log_service.get_level(name)[name]&.downcase&.to_sym
     end
 
     def level=(level)
+      return if self.level == level
+
       Logger.log_service.set_level(name, level.to_s)
     end
 

data/lib/openhab/rspec/hooks.rb

@@ -57,9 +57,8 @@ module OpenHAB
           tm.class.field_reader :storage
           tm.storage.keys.each { |k| tm.storage.remove(k) } # rubocop:disable Style/HashEachMethods not a hash
 
-          profile_factory = Core::ProfileFactory.send(:new)
-          @profile_factory_registration = OSGi.register_service(profile_factory)
-          allow(Core::ProfileFactory).to receive(:instance).and_return(profile_factory)
+          @profile_factory = Core::ProfileFactory.send(:new)
+          allow(Core::ProfileFactory).to receive(:instance).and_return(@profile_factory)
 
           stub_const("OpenHAB::Core::Timer", Mocks::Timer) if self.class.mock_timers?
 
@@ -72,7 +71,7 @@ module OpenHAB
         config.after do
           Core::Items::Proxy.reset_cache
           Core::Things::Proxy.reset_cache
-          @profile_factory_registration.unregister
+          @profile_factory.unregister
           timers.cancel_all
           # timers and rules have already been canceled, so we can safely just
           # wipe this

data/lib/openhab/rspec/karaf.rb

@@ -429,6 +429,11 @@ module OpenHAB
 
               tm.bundleResolver = Mocks::BundleResolver.instance
 
+              require_relative "mocks/safe_caller"
+              field = tm.class.java_class.declared_field :safeCaller
+              field.accessible = true
+              field.set(tm, Mocks::SafeCaller.instance)
+
               require_relative "mocks/thing_handler"
               thf = Mocks::ThingHandlerFactory.instance
               bundle = org.osgi.framework.FrameworkUtil.get_bundle(org.openhab.core.thing.Thing)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-jrubyscripting
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc3
+  version: 5.0.0.rc4
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-26 00:00:00.000000000 Z
+date: 2022-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -369,6 +369,7 @@ files:
 - lib/openhab/core/provider.rb
 - lib/openhab/core/registry.rb
 - lib/openhab/core/rules.rb
+- lib/openhab/core/rules/module.rb
 - lib/openhab/core/rules/provider.rb
 - lib/openhab/core/rules/registry.rb
 - lib/openhab/core/rules/rule.rb
@@ -455,7 +456,6 @@ files:
 - lib/openhab/dsl/rules/triggers/updated.rb
 - lib/openhab/dsl/rules/triggers/watch/watch.rb
 - lib/openhab/dsl/rules/triggers/watch/watch_handler.rb
-- lib/openhab/dsl/script_handling.rb
 - lib/openhab/dsl/things/builder.rb
 - lib/openhab/dsl/thread_local.rb
 - lib/openhab/dsl/timer_manager.rb

data/lib/openhab/dsl/script_handling.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module DSL
-  end
-end