openhab-jrubyscripting 5.0.0.rc5 → 5.0.0.rc8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5963df56b31bb66f4d4cf5afa5927719d61740df847c5d5ff0965a188a73c62
-  data.tar.gz: 0011f05f77383e9618844437bc63b55d02e62ed9a402d775a76dbc75d20a8334
+  metadata.gz: 7a08d2ec63be7c6f1049ddc92de20e0184a9c4e959c6a20e97ce9c9214520d94
+  data.tar.gz: 90178ba5a194cc91e24381c91bb691ddbafae498a033284a687698a8406c3b68
 SHA512:
-  metadata.gz: ffdb129b03aac2d44365aa42a7f02889f5d8a20f662391b874cb795547b646d6d4f02d014284a73143862ca25f931f42429be012a25b645d02b1e713a02c073b
-  data.tar.gz: ca9804074c3092c6bcff87ed17bffe4543ef95b3ef0c230d4767811a266d368210658f36968d4d42b6ed2f320a8935ab28363a318a6bd0d2a7d393afab67a29a
+  metadata.gz: 659647412602ecb689524f4f760f1b4f6f054617190ffb8adee922daeb5a715b75f6e245a062f250e18b9262dc27667f7081ed2ca168454552ae1ca12fd24e0b
+  data.tar.gz: ac977120af8e531f0471d9f17601e7b59de9c9f44a40379d069b50227c4ec6d9674ab6f5a7791afb79f90174b6e532de3846f45d6f270459a94b2e12ecb47917

data/lib/openhab/core/actions.rb

@@ -5,7 +5,7 @@ module OpenHAB
     #
     # Access to global actions.
     #
-    # All OpenHAB's actions including those provided by add-ons are available, notably:
+    # All openHAB's actions including those provided by add-ons are available, notably:
     # * Audio
     # * Voice
     # * Things
@@ -17,7 +17,7 @@ module OpenHAB
     # From add-ons, e.g.:
     # * Transformation
     # * PersistenceExtensions (see {Items::Persistence})
-    # * NotificationAction (from [OpenHAB Cloud Connector](https://www.openhab.org/addons/integrations/openhabcloud/))
+    # * NotificationAction (from [openHAB Cloud Connector](https://www.openhab.org/addons/integrations/openhabcloud/))
     #
     # Global actions are available as "global" methods on {OpenHAB::DSL}, or
     # explicitly from this {Actions} module, or you can explicitly reference a
@@ -39,7 +39,7 @@ module OpenHAB
     #
     #   play_stream 'example.com'
     #
-    # @example Send a broadcast notification via the OpenHAB Cloud
+    # @example Send a broadcast notification via the openHAB Cloud
     #   rule 'Send an alert' do
     #     changed Alarm_Triggered, to: ON
     #     run { notify 'Red Alert!' }
@@ -102,7 +102,7 @@ module OpenHAB
       #
       def notify(msg, email: nil, icon: nil, severity: nil)
         unless Actions.const_defined?(:NotificationAction)
-          raise NoMethodError, "NotificationAction is not available. Please install the OpenHAB cloud addon"
+          raise NoMethodError, "NotificationAction is not available. Please install the openHAB cloud addon"
         end
 
         if email
@@ -113,7 +113,7 @@ module OpenHAB
       end
 
       #
-      # Say text via OpenHAB Text-To-Speech service, Voice.say()
+      # Say text via openHAB Text-To-Speech service, Voice.say()
       #
       # @param text [String] The text to say
       # @param voice [String] Specify a particular voice to use
@@ -128,7 +128,7 @@ module OpenHAB
       end
 
       #
-      # Play an audio file via OpenHAB sound service, Audio.playSound()
+      # Play an audio file via openHAB sound service, Audio.playSound()
       #
       # @param filename [String] The sound file to play
       # @param sink [String] Specify a particular sink to output the speech

data/lib/openhab/core/dependency_tracking.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+if defined?($dependencyListener)
+  require "jruby"
+
+  klass = Class.new(org.jruby.util.collections.StringArraySet) do
+    def initialize(other)
+      super(JRuby.runtime)
+      other.each { |feature| append(feature) }
+    end
+
+    def append(name)
+      $dependencyListener.accept(name)
+
+      super
+    end
+  end
+
+  JRuby.runtime.load_service.class.field_accessor :loadedFeatures
+  JRuby.runtime.load_service.loadedFeatures = klass.new(JRuby.runtime.load_service.loadedFeatures)
+
+  loaded_specs = Gem.loaded_specs
+  loaded_specs.each_key do |gem|
+    $dependencyListener.accept("gem:#{gem}")
+  end
+
+  def loaded_specs.[]=(gem, _spec)
+    super
+
+    $dependencyListener.accept("gem:#{gem}")
+  end
+else
+  logger.warn("Dependency listener not found; dependency tracking disabled.")
+end

data/lib/openhab/core/entity_lookup.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require "ruby2_keywords"
+
 module OpenHAB
   module Core
     #
-    # Manages access to OpenHAB entities
+    # Manages access to openHAB entities
     #
-    # You can access OpenHAB items and things directly using their name, anywhere `EntityLookup` is available.
+    # You can access openHAB items and things directly using their name, anywhere `EntityLookup` is available.
     #
     # @note Thing UIDs are separated by a colon `:`. Since it is not a valid symbol for an identifier,
     #   it must be replaced with an underscore `_`. So to access `astro:sun:home`, use `astro_sun_home`
@@ -16,7 +18,7 @@ module OpenHAB
     #
     # @example Accessing Items and Groups
     #   gAll_Lights       # Access the gAll_Lights group. It is the same as items["gAll_Lights"]
-    #   Kitchen_Light.on  # The OpenHAB object for the Kitchen_Light item and send an ON command
+    #   Kitchen_Light.on  # The openHAB object for the Kitchen_Light item and send an ON command
     #
     # @example Accessing Things
     #   smtp_mail_local.send_mail('me@example.com', 'Subject', 'Dear Person, ...')
@@ -24,110 +26,162 @@ module OpenHAB
     #   things['smtp:mail:local'].send_mail('me@example.com', 'Subject', 'Dear Person, ...')
     #
     module EntityLookup
-      #
-      # Automatically looks up OpenHAB items and things in appropriate registries
-      #
-      # @return [GenericItem, Things::Thing, nil]
-      #
-      def method_missing(method, *args, &block)
-        logger.trace("method missing, performing OpenHab Lookup for: #{method}")
-        EntityLookup.lookup_entity(method) || super
-      end
-
       # @!visibility private
-      def respond_to_missing?(method_name, _include_private = false)
-        logger.trace("Checking if OpenHAB entities exist for #{method_name}")
-        method_name = method_name.to_s if method_name.is_a?(Symbol)
+      module ClassMethods
+        # @!attribute [w] create_dummy_items
+        # @return [true,false]
+        def create_dummy_items=(value)
+          @create_dummy_items = value
+        end
+
+        # @return [Boolean] if dummy items should be created in this context
+        def create_dummy_items?
+          @create_dummy_items
+        end
+
+        # @!visibility private
+        def inherited(klass)
+          super
+
+          EntityLookup.included(klass)
+        end
 
-        method_name == "scriptLoaded" ||
-          method_name == "scriptUnloaded" ||
-          EntityLookup.lookup_entity(method_name) ||
+        # @!visibility private
+        def included(klass)
           super
+
+          EntityLookup.included(klass)
+        end
       end
 
-      #
-      # Looks up an OpenHAB entity
-      #  items are checked first, then things
-      #
       # @!visibility private
-      #
-      # @param [String] name of entity to lookup in item or thing registry
-      #
-      # @return [GenericItem, Things::Thing, nil]
-      #
-      def self.lookup_entity(name)
-        lookup_item(name) || lookup_thing_const(name)
+      def self.included(klass)
+        klass.singleton_class.prepend(ClassMethods)
+        klass.ancestors.each do |ancestor|
+          next unless ancestor.singleton_class.ancestors.include?(ClassMethods)
+          next if ancestor.create_dummy_items?.nil?
+
+          klass.create_dummy_items = ancestor.create_dummy_items?
+          break
+        end
       end
 
       #
-      # Looks up a Thing in the OpenHAB registry
-      #
-      # @!visibility private
-      #
-      # @param [String] uid name of Thing to lookup in Thing registry
+      # Automatically looks up openHAB items and things in appropriate registries
       #
-      # @return [Things::Thing, nil]
+      # @return [Item, Things::Thing, nil]
       #
-      def self.lookup_thing(uid)
-        logger.trace("Looking up thing '#{uid}'")
-        uid = uid.to_s if uid.is_a?(Symbol)
+      ruby2_keywords def method_missing(method, *args)
+        return super unless args.empty? && !block_given?
 
-        uid = Things::ThingUID.new(uid) unless uid.is_a?(Things::ThingUID)
-        thing = $things.get(uid)
-        return unless thing
+        logger.trace("method missing, performing openHAB Lookup for: #{method}")
+        EntityLookup.lookup_entity(method,
+                                   create_dummy_items: self.class.respond_to?(:create_dummy_items?) &&
+                                     self.class.create_dummy_items?) || super
+      end
 
-        logger.trace("Retrieved Thing(#{thing}) from registry for uid: #{uid}")
-        Things::Proxy.new(thing)
+      # @!visibility private
+      def respond_to_missing?(method, *)
+        logger.trace("Checking if openHAB entities exist for #{method}")
+        EntityLookup.lookup_entity(method) || super
       end
 
-      #
-      # Looks up a Thing in the OpenHAB registry replacing `_` with `:`
-      #
       # @!visibility private
-      #
-      # @param [String] name of Thing to lookup in Thing registry
-      #
-      # @return [Things::Thing, nil]
-      #
-      def self.lookup_thing_const(name)
-        name = name.to_s if name.is_a?(Symbol)
+      def instance_eval_with_dummy_items(&block)
+        DSL::ThreadLocal.thread_local(openhab_create_dummy_items: self.class.create_dummy_items?) do
+          instance_eval(&block)
+        end
+      end
+
+      class << self
+        #
+        # Looks up an openHAB entity
+        #  items are checked first, then things
+        #
+        # @!visibility private
+        #
+        # @param [String] name of entity to lookup in item or thing registry
+        # @param [true, false] create_dummy_items If a dummy {Item} should be created if an actual item can't be found
+        #
+        # @return [Item, Things::Thing, nil]
+        #
+        def lookup_entity(name, create_dummy_items: false)
+          # make sure we have a nil return
+          create_dummy_items = nil if create_dummy_items == false
+          lookup_item(name) || lookup_thing_const(name) || (create_dummy_items && Items::Proxy.new(name.to_sym))
+        end
+
+        #
+        # Looks up a Thing in the openHAB registry
+        #
+        # @!visibility private
+        #
+        # @param [String] uid name of Thing to lookup in Thing registry
+        #
+        # @return [Things::Thing, nil]
+        #
+        def lookup_thing(uid)
+          logger.trace("Looking up thing '#{uid}'")
+          uid = uid.to_s if uid.is_a?(Symbol)
 
-        if name.is_a?(String)
-          # Thing UIDs have at least 3 segments, separated by `_`
-          return if name.count("_") < 2
+          uid = Things::ThingUID.new(uid) unless uid.is_a?(Things::ThingUID)
+          thing = $things.get(uid)
+          return unless thing
 
-          # Convert from _ syntax to :
-          name = name.tr("_", ":")
+          logger.trace("Retrieved Thing(#{thing}) from registry for uid: #{uid}")
+          Things::Proxy.new(thing)
         end
-        lookup_thing(name)
-      end
 
-      #
-      # Lookup OpenHAB items in item registry
-      #
-      # @!visibility private
-      #
-      # @param [String] name of item to lookup
-      #
-      # @return [GenericItem, nil]
-      #
-      def self.lookup_item(name)
-        logger.trace("Looking up item '#{name}'")
-        name = name.to_s if name.is_a?(Symbol)
-        item = $ir.get(name)
-        Items::Proxy.new(item) unless item.nil?
+        #
+        # Looks up a Thing in the openHAB registry replacing `_` with `:`
+        #
+        # @!visibility private
+        #
+        # @param [String] name of Thing to lookup in Thing registry
+        #
+        # @return [Things::Thing, nil]
+        #
+        def lookup_thing_const(name)
+          name = name.to_s if name.is_a?(Symbol)
+
+          if name.is_a?(String)
+            # Thing UIDs have at least 3 segments, separated by `_`
+            return if name.count("_") < 2
+
+            # Convert from _ syntax to :
+            name = name.tr("_", ":")
+          end
+          lookup_thing(name)
+        end
+
+        #
+        # Lookup openHAB items in item registry
+        #
+        # @!visibility private
+        #
+        # @param [String] name of item to lookup
+        #
+        # @return [Item, nil]
+        #
+        def lookup_item(name)
+          logger.trace("Looking up item '#{name}'")
+          name = name.to_s if name.is_a?(Symbol)
+          item = $ir.get(name)
+          Items::Proxy.new(item) unless item.nil?
+        end
       end
     end
   end
 end
 
 #
-# Implements const_missing to return OpenHAB items or things if mapping to missing name if they exist
+# Implements const_missing to return openHAB items or things if mapping to missing name if they exist
 #
 # @param [String] name Capital string that was not set as a constant and to be looked up
 #
-# @return [Object] OpenHAB Item or Thing if their name exist in OpenHAB item and thing regestries
+# @return [Object] openHAB Item or Thing if their name exist in openHAB item and thing regestries
 #
 def Object.const_missing(name)
-  OpenHAB::Core::EntityLookup.lookup_entity(name) || super
+  OpenHAB::Core::EntityLookup.lookup_entity(name,
+                                            create_dummy_items: Thread.current[:openhab_create_dummy_items]) || super
 end

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

@@ -7,7 +7,7 @@ module OpenHAB
 
       # Strictly speaking this class isn't an event, but it's accessed from an AbstractItemChannelLinkEvent
 
-      # Adds methods to core OpenHAB ItemChannelLinkDTO to make it more natural in Ruby
+      # Adds methods to core openHAB ItemChannelLinkDTO to make it more natural in Ruby
       class ItemChannelLinkDTO
         #
         # @!attribute [r] item_name
@@ -17,7 +17,7 @@ module OpenHAB
 
         #
         # @!attribute [r] item
-        # @return [GenericItem] The item that was linked or unlinked
+        # @return [Item] The item that was linked or unlinked
         #
         def item
           EntityLookup.lookup_item(itemName)

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

@@ -7,7 +7,7 @@ module OpenHAB
     module Events
       java_import org.openhab.core.items.events.ItemCommandEvent
 
-      # Adds methods to core OpenHAB ItemCommandEvent to make it more natural in Ruby
+      # Adds methods to core openHAB ItemCommandEvent to make it more natural in Ruby
       class ItemCommandEvent < ItemEvent
         # @!attribute [r] command
         # @return [Type] The command sent to the item.

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

@@ -6,12 +6,12 @@ module OpenHAB
       java_import org.openhab.core.items.events.ItemEvent
 
       #
-      # Adds methods to core OpenHAB ItemEvent to make it more natural in Ruby
+      # Adds methods to core openHAB ItemEvent to make it more natural in Ruby
       #
       class ItemEvent < AbstractEvent
         #
         # @!attribute [r] item
-        # @return [GenericItem] The item that triggered this event.
+        # @return [Item] The item that triggered this event.
         #
         def item
           EntityLookup.lookup_item(item_name)

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

@@ -8,7 +8,7 @@ module OpenHAB
       java_import org.openhab.core.items.events.ItemStateChangedEvent
 
       #
-      # Adds methods to core OpenHAB ItemStateChangedEvent to make it more natural in Ruby
+      # Adds methods to core openHAB ItemStateChangedEvent to make it more natural in Ruby
       #
       class ItemStateChangedEvent < ItemEvent
         include ItemState

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

@@ -7,7 +7,7 @@ module OpenHAB
 
       # Strictly speaking this class isn't an event, but it's accessed from an AbstractThingRegistryEvent
 
-      # Adds methods to core OpenHAB AbstractThingDTO to make it more natural in Ruby
+      # Adds methods to core openHAB AbstractThingDTO to make it more natural in Ruby
       class AbstractThingDTO
         # @!method uid
         #   The thing's UID

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

@@ -13,12 +13,12 @@ module OpenHAB
       end
 
       module AcceptedDataTypes
-        # @see GenericItem#accepted_command_types
+        # @see Item#accepted_command_types
         def accepted_command_types
           super.map { |k| k.is_a?(java.lang.Class) ? k.ruby_class : k }
         end
 
-        # @see GenericItem#accepted_data_types
+        # @see Item#accepted_data_types
         def accepted_data_types
           super.map { |k| k.is_a?(java.lang.Class) ? k.ruby_class : k }
         end

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

@@ -18,7 +18,7 @@ module OpenHAB
       #
       # @example
       #   rule 'Log state of all doors on system startup' do
-      #     on_start
+      #     on_load
       #     run do
       #       Doors.each do |door|
       #         case door.state

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

@@ -48,7 +48,7 @@ module OpenHAB
       #
       # @example
       #   rule 'Dim a switch on system startup over 100 seconds' do
-      #     on_start
+      #     on_load
       #     100.times do
       #       run { DimmerSwitch.dim }
       #       delay 1.second
@@ -57,7 +57,7 @@ module OpenHAB
       #
       # @example
       #   rule 'Dim a switch on system startup by 5, pausing every second' do
-      #     on_start
+      #     on_load
       #     100.step(-5, 0) do |level|
       #       run { DimmerSwitch << level }
       #       delay 1.second