Support source in profiles (#485)

Only applicable to commands from items.

Dependent on openhab/openhab-core#4990

Signed-off-by: Cody Cutrer <cody@cutrer.us>

Author: ccutrer

lib/openhab/core.rb

@@ -15,6 +15,8 @@ module Core
     V4_3 = Gem::Version.new("4.3.0").freeze
     # @!visibility private
     V5_0 = Gem::Version.new("5.0.0").freeze
+    # @!visibility private
+    V5_1 = Gem::Version.new("5.1.0").freeze
 
     # @return [Gem::Version] Returns the current openHAB version as a Gem::Version object
     #   Note, this strips off snapshots, milestones and RC versions and returns the release version.

lib/openhab/core/profile_factory.rb

@@ -37,8 +37,8 @@ def getProfileTypeUID
         end
 
         # @!visibility private
-        def onCommandFromItem(command)
-          return unless process_event(:command_from_item, command:) == true
+        def onCommandFromItem(command, source = nil)
+          return unless process_event(:command_from_item, command:, source:) == true
 
           logger.trace("Forwarding original command")
           @callback.handle_command(command)
@@ -92,6 +92,7 @@ def process_event(event, **params)
           params[:command] ||= nil
           params[:trigger] ||= nil
           params[:time_series] ||= nil
+          params[:source] ||= nil
 
           kwargs = {}
           @block.parameters.each do |(param_type, name)|

lib/openhab/dsl.rb

@@ -158,6 +158,8 @@ def script!(name = nil, description: nil, id: nil, tag: nil, tags: nil, **kwargs
     # @yieldparam [Core::Things::ChannelUID] channel_uid The linked channel.
     # @yieldparam [Hash] configuration The profile configuration.
     # @yieldparam [org.openhab.core.thing.profiles.ProfileContext] context The profile context.
+    # @yieldparam [String, nil] source The source of the event.
+    #   @since openHAB 5.1
     # @yieldreturn [Boolean] Return true from the block in order to have default processing.
     # @return [void]
     #

spec/openhab/dsl_spec.rb

@@ -104,6 +104,23 @@
       SeasonColor << "0,100,100"
     end
 
+    it "receives the command source", if: OpenHAB::Core.version >= OpenHAB::Core::V5_1 do
+      profile :command_source do |item:, source:|
+        expect(source).to eql "test_source"
+        item.update("triggered")
+        false
+      end
+
+      items.build do
+        string_item MyString,
+                    channel: ["astro:sun:home:season#name", { profile: "ruby:command_source" }],
+                    autoupdate: false
+      end
+
+      MyString.command("foo", source: "test_source")
+      expect(MyString.state).to eq "triggered"
+    end
+
     context "with time series" do
       it "supports sending a time series" do
         profile :send_as_time_series do |event, callback:, command:|