openhab-scripting 4.42.2 → 4.43.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08c9201c21983751d80e9c2e4df683c39cef20763a5321fd2f8fdcd355cdb6c5'
-  data.tar.gz: f0b2c25837d2396e70d11ba503920ff443992bd9cf007b18a2003f6857a17929
+  metadata.gz: a7ffe3540ffb1e1538b60f38b9943e5ed72bded20d313d0702884921d30b5843
+  data.tar.gz: bd72fa1f8a18b9a5fa5b06f57e50a5943ecd4252d091307cd21f4f50d0c50805
 SHA512:
-  metadata.gz: bff012a5dc7caf0e06fb9d0f3aede99afc9ad067004390ae606d392c34fe3662b017395fa3c200e759c2023e4801fb775ee097a29f0b90554f721d8fbbf9cf47
-  data.tar.gz: b862f6f69383d86e1a230d2c702c440c0b6dd465ed22ec16ad03a47166bd319004a8f82147eed2da514b301523f99c917c9d93de56f6ea7b9907ab5713f9d61d
+  metadata.gz: d980ee1aee7685e711b322baf8307f83e6bff963a59a8dcb00b012e66c6c0b104d3369e39337180554ae24d057ffb2d374654eb3f4ea9a5acf08d78237b2f210
+  data.tar.gz: 776d0d64562bb90461b6c87282311e4db548ead4eb8f5823b0ccd042880552f6b5b838b0fd9289adc481ccb988ee3212be583668df2b75e3cd2c03b1103c94a2

data/lib/openhab/core/entity_lookup.rb

@@ -73,9 +73,7 @@ module OpenHAB
         return if name.count('_') < 3
 
         name = name.tr('_', ':')
-        # rubocop: disable Style/GlobalVars
         $things.get(Java::OrgOpenhabCoreThing::ThingUID.new(name))
-        # rubocop: enable Style/GlobalVars
       end
 
       #
@@ -88,7 +86,7 @@ module OpenHAB
       def self.lookup_item(name)
         logger.trace("Looking up item(#{name})")
         name = name.to_s if name.is_a? Symbol
-        item = $ir.get(name) # rubocop: disable Style/GlobalVars
+        item = $ir.get(name)
         ItemProxy.new(item) unless item.nil?
       end
     end

data/lib/openhab/core/item_proxy.rb

@@ -22,7 +22,7 @@ module OpenHAB
       # Lookup item from item registry
       #
       def __getobj__
-        $ir.get(@item_name) # rubocop:disable Style/GlobalVars
+        $ir.get(@item_name)
       end
     end
   end

data/lib/openhab/core/osgi.rb

@@ -50,9 +50,7 @@ module OpenHAB
 
       # Get the OSGI Bundle for ScriptExtension Class
       def self.bundle
-        # rubocop: disable Style/GlobalVars
         @bundle ||= FrameworkUtil.getBundle($scriptExtension.class)
-        # rubocop: enable Style/GlobalVars
       end
       private_class_method :bundle
     end

data/lib/openhab/core/services.rb

@@ -11,7 +11,6 @@ module OpenHAB
 
     # Get the OpenHAB automation manager
     # @return [AutomationManager] OpenHAB Automation manager
-    # rubocop:disable Style/GlobalVars
     def self.automation_manager
       $scriptExtension.get('automationManager')
     end
@@ -21,6 +20,5 @@ module OpenHAB
     def self.rule_registry
       $scriptExtension.get('ruleRegistry')
     end
-    # rubocop:enable Style/GlobalVars
   end
 end

data/lib/openhab/core/thread_local.rb

@@ -33,7 +33,7 @@ module OpenHAB
       # @param [Hash] values Keys and values to set for running thread, if hash is nil no values are set
       #
       def thread_local(**values, &block)
-        ThreadLocal.thread_local(values, &block)
+        ThreadLocal.thread_local(**values, &block)
       end
     end
   end

data/lib/openhab/dsl/actions.rb

@@ -29,9 +29,7 @@ module OpenHAB
       # @return [Object] OpenHAB action
       #
       def actions(scope, thing_uid)
-        # rubocop: disable Style/GlobalVars
         $actions.get(scope, thing_uid)
-        # rubocop: enable Style/GlobalVars
       end
 
       #
@@ -43,9 +41,7 @@ module OpenHAB
       #
       def actions_for_thing(thing_uid)
         thing_uid = thing_uid.to_s
-        # rubocop: disable Style/GlobalVars
         action_keys = $actions.action_keys
-        # rubocop: enable Style/GlobalVars
         logger.trace("Registered actions: '#{action_keys}' for thing '#{thing_uid}'")
         action_keys.map { |action_key| action_key.split('-', 2) }
                    .select { |action_pair| action_pair.last == thing_uid }
@@ -101,6 +97,18 @@ module OpenHAB
         volume = Types::PercentType.new(volume) unless volume.is_a?(Types::PercentType) || volume.nil?
         Audio.playSound sink&.to_s, filename.to_s, volume
       end
+
+      #
+      # Play an audio stream from an URL to the given sink(s). Set url to nil if streaming should be stopped
+      #
+      # @param [String] url The URL of the audio stream
+      # @param [String] sink The audio sink, or nil to use the default audio sink
+      #
+      # @return [void]
+      #
+      def play_stream(url, sink: nil)
+        Audio.playStream sink&.to_s, url
+      end
     end
   end
 end

data/lib/openhab/dsl/group.rb

@@ -46,7 +46,7 @@ module OpenHAB
 
         # explicit conversion to array
         def to_a
-          $ir.items.grep(org.openhab.core.items.GroupItem) # rubocop:disable Style/GlobalVars
+          $ir.items.grep(org.openhab.core.items.GroupItem)
         end
       end
     end

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

@@ -51,6 +51,14 @@ module OpenHAB
         # @!method decrease
         #   Send the +DECREASE+ command to the item
         #   @return [DimmerItem] +self+
+
+        # raw numbers translate directly to PercentType, not a DecimalType
+        # @!visibility private
+        def format_type(command)
+          return Types::PercentType.new(command) if command.is_a?(Numeric)
+
+          super
+        end
       end
     end
   end

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

@@ -88,6 +88,7 @@ module OpenHAB
             @item.__send__(method, *args, &block)
           end
         end
+        ruby2_keywords :method_missing if respond_to? :ruby2_keywords
 
         # .
         def respond_to_missing?(method, include_private = false)

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

@@ -39,14 +39,14 @@ module OpenHAB
         # @param name [String] Item name to check
         # @return [Boolean] true if the item exists, false otherwise
         def include?(name)
-          !$ir.getItems(name).empty? # rubocop: disable Style/GlobalVars
+          !$ir.getItems(name).empty?
         end
         alias key? include?
 
         # Explicit conversion to array
         # @return [Array]
         def to_a
-          $ir.items.to_a # rubocop:disable Style/GlobalVars
+          $ir.items.to_a
         end
       end
     end

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

@@ -64,15 +64,10 @@ module OpenHAB
           return [other, state] if other.is_a?(Types::NumericType) || other.respond_to?(:to_d)
         end
 
-        # strip trailing zeros from commands
+        # raw numbers translate directly to DecimalType, not a string
         # @!visibility private
         def format_type(command)
-          # DecimalType and PercentType we want to make sure we don't have extra zeros
-          if command.instance_of?(Types::DecimalType) || command.instance_of?(Types::PercentType)
-            return command.to_big_decimal.strip_trailing_zeros.to_plain_string
-          end
-          # BigDecimal types have trailing zeros stripped
-          return command.to_java.strip_trailing_zeros.to_plain_string if command.is_a?(BigDecimal)
+          return Types::DecimalType.new(command) if command.is_a?(Numeric)
 
           super
         end

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

@@ -37,6 +37,14 @@ module OpenHAB
         # @!method move
         #   Send the +MOVE+ command to the item
         #   @return [RollershutterItem] +self+
+
+        # raw numbers translate directly to PercentType, not a DecimalType
+        # @!visibility private
+        def format_type(command)
+          return Types::PercentType.new(command) if command.is_a?(Numeric)
+
+          super
+        end
       end
     end
   end

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

@@ -173,14 +173,12 @@ module OpenHAB
             def execute(_mod = nil, inputs = nil)
               OpenHAB::DSL.import_presets
               @semaphore.synchronize do
-                thread_local(@thread_locals) do
+                thread_local(**@thread_locals) do
                   logger.trace "Canceling implicit timer #{@timed_command_details.timer} for "\
                                "#{@timed_command_details.item.id}  because received event #{inputs}"
                   @timed_command_details.timer.cancel
-                  # rubocop: disable Style/GlobalVars
                   # Disabled due to OpenHAB design
                   $scriptExtension.get('ruleRegistry').remove(@timed_command_details.rule_uid)
-                  # rubocop: enable Style/GlobalVars
                   TimedCommand.timed_commands.delete(@timed_command_details.item)
                   if @block
                     logger.trace 'Executing user supplied block on timed command cancelation'

data/lib/openhab/dsl/monkey_patch/actions/script_thing_actions.rb

@@ -12,7 +12,7 @@ module OpenHAB
         #
         # MonkeyPatching ScriptThingActions
         #
-        class << $actions # rubocop:disable Style/GlobalVars
+        class << $actions
           field_reader :THING_ACTIONS_MAP
 
           #

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

@@ -24,18 +24,21 @@ module OpenHAB
         include OpenHAB::Core::ThreadLocal
         include OpenHAB::DSL::Between
 
+        field_writer :uid
+
         #
         # Create a new Rule
         #
         # @param [Config] config Rule configuration
         #
         # Constructor sets a number of variables, no further decomposition necessary
-        def initialize(config:) # rubocop:disable Metrics/MethodLength
+        def initialize(config:) # rubocop:disable Metrics
           # Metrics disabled because only setters are called or defaults set.
           super()
           set_name(config.name)
           set_description(config.description)
           set_triggers(config.triggers)
+          self.uid = config.uid
           @run_context = config.caller
           @run_queue = config.run
           @guard = config.guard

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'method_source'
+
 require 'openhab/core/thread_local'
 require 'openhab/core/services'
 require 'openhab/log/logger'
@@ -32,6 +34,12 @@ module OpenHAB
 
         module_function
 
+        # get the block's source location, and simplify to a simple filename
+        def self.infer_rule_id_from_block(block)
+          file = File.basename(block.source_location.first)
+          "#{file}:#{block.source_location.last}"
+        end
+
         #
         # Create a new rule
         #
@@ -39,21 +47,25 @@ module OpenHAB
         # @yield [] Block executed in context of a RuleConfig
         #
         #
-        # rubocop:disable Metrics/MethodLength
-        def rule(rule_name, &block)
+        def rule(rule_name = nil, id: nil, script: nil, &block) # rubocop:disable Metrics
+          id ||= Rule.infer_rule_id_from_block(block)
+          rule_name ||= id
+          script ||= block.source rescue nil # rubocop:disable Style/RescueModifier
+
           OpenHAB::Core::ThreadLocal.thread_local(RULE_NAME: rule_name) do
             @rule_name = rule_name
+
             config = RuleConfig.new(rule_name, block.binding)
+            config.uid(id)
             config.instance_exec(config, &block)
             config.guard = Guard::Guard.new(run_context: config.caller, only_if: config.only_if,
                                             not_if: config.not_if)
             logger.trace { config.inspect }
-            process_rule_config(config)
+            process_rule_config(config, script)
           end
         rescue StandardError => e
           logger.log_exception(e, @rule_name)
         end
-        # rubocop:enable Metrics/MethodLength
 
         #
         # Cleanup rules in this script file
@@ -71,12 +83,15 @@ module OpenHAB
         # @param [RuleConfig] config for rule
         #
         #
-        def process_rule_config(config)
+        def process_rule_config(config, script) # rubocop:disable Metrics
           return unless create_rule?(config)
 
           rule = AutomationRule.new(config: config)
           Rule.script_rules << rule
           added_rule = add_rule(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)
 
           rule.execute(nil, { 'event' => Struct.new(:attachment).new(config.start_attachment) }) if config.on_start?
           added_rule
@@ -131,6 +146,12 @@ module OpenHAB
         #
         #
         def add_rule(rule)
+          base_uid = rule.uid
+          duplicate_index = 1
+          while $rules.get(rule.uid)
+            duplicate_index += 1
+            rule.uid = "#{base_uid} (#{duplicate_index})"
+          end
           logger.trace("Adding rule: #{rule.inspect}")
           Rule.automation_manager.addRule(rule)
         end

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

@@ -61,6 +61,7 @@ module OpenHAB
         prop_array :delay, :array_name => :run_queue, :wrapper => Delay
         prop_array :otherwise, :array_name => :run_queue, :wrapper => Otherwise
 
+        prop :uid
         prop :name
         prop :description
         prop :enabled

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

@@ -7,17 +7,44 @@ module OpenHAB
       module TerseRule
         %i[changed channel cron every updated received_command].each do |trigger|
           class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
-            def #{trigger}(*args, name: nil, **kwargs, &block)                   # def changed(*args, name: nil, **kwargs, &block)
-              # if no name is given, just default to the name of the rules file  #   # if no name is given, just default to the name of the rules file
-              name ||= File.basename(caller_locations.last.path)                 #   name ||= File.basename(caller_locations.last.path)
-              rule name do                                                       #   rule name do
-                #{trigger}(*args, **kwargs)                                      #     changed(*args, **kwargs)
-                run(&block)                                                      #     run(&block)
-              end                                                                #   end
-            end                                                                  # end
-            module_function #{trigger.inspect}                                   # module_function :changed
+            def #{trigger}(*args, name: nil, **kwargs, &block)            # def changed(*args, name: nil, **kwargs, &block)
+              name ||= infer_rule_name(#{trigger.inspect}, args, kwargs)  #   name ||= infer_rule_name(:changed, args, kwargs)
+              id = Rule.infer_rule_id_from_block(block)                   #   id = Rule.infer_rule_id_from_block(block)
+              name ||= id                                                 #   name ||= id
+              script = block.source rescue nil                            #   script = block.source rescue nil
+              rule name, id: id, script: script do                        #   rule name, id: id, script: script do
+                #{trigger}(*args, **kwargs)                               #     changed(*args, **kwargs)
+                run(&block)                                               #     run(&block)
+              end                                                         #   end
+            end                                                           # end
+            module_function #{trigger.inspect}                            # module_function :changed
           RUBY
         end
+
+        private
+
+        # formulate a readable rule name such as "TestSwitch received command ON" if possible
+        def infer_rule_name(trigger, args, kwargs) # rubocop:disable Metrics
+          return unless %i[changed updated received_command].include?(trigger) &&
+                        args.length == 1 &&
+                        (kwargs.keys - %i[from to command]).empty?
+          return if kwargs[:from].is_a?(Enumerable)
+          return if kwargs[:to].is_a?(Enumerable)
+          return if kwargs[:command].is_a?(Enumerable)
+
+          trigger_name = trigger.to_s.tr('_', ' ')
+          name = if args.first.is_a?(GroupItem::GroupMembers) # rubocop:disable Style/CaseLikeIf === doesn't work with GenericItem
+                   "#{args.first.group.name}.members #{trigger_name}"
+                 elsif args.first.is_a?(GenericItem)
+                   "#{args.first.name} #{trigger_name}"
+                 end
+          return unless name
+
+          name += " from #{kwargs[:from].inspect}" if kwargs[:from]
+          name += " to #{kwargs[:to].inspect}" if kwargs[:to]
+          name += " #{kwargs[:command].inspect}" if kwargs[:command]
+          name
+        end
       end
     end
   end

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

@@ -35,6 +35,7 @@ module OpenHAB
               from = Conditions::Proc.from_value(from)
               @conditions = Conditions::Proc.new(to: to, from: from)
               @duration = duration
+              @timer = nil
               logger.trace "Created Duration Condition To(#{to}) From(#{from}) "\
                            "Conditions(#{@conditions}) Duration(#{@duration})"
             end

data/lib/openhab/dsl/things.rb

@@ -108,7 +108,7 @@ module OpenHAB
         # @return Thing specified by name/UID or nil if name/UID does not exist in thing registry
         def [](uid)
           uid = generate_thing_uid(uid) unless uid.is_a?(org.openhab.core.thing.ThingUID)
-          thing = $things.get(uid) # rubocop: disable Style/GlobalVars
+          thing = $things.get(uid)
           return unless thing
 
           logger.trace("Retrieved Thing(#{thing}) from registry for uid: #{uid}")
@@ -119,7 +119,7 @@ module OpenHAB
 
         # explicit conversion to array
         def to_a
-          $things.getAll.map { |thing| Thing.new(thing) } # rubocop: disable Style/GlobalVars
+          $things.getAll.map { |thing| Thing.new(thing) }
         end
 
         private

data/lib/openhab/dsl/timers/timer.rb

@@ -82,7 +82,7 @@ module OpenHAB
           OpenHAB::DSL.import_presets
           semaphore.synchronize do
             Timers.timer_manager.delete(self)
-            thread_local(@thread_locals) do
+            thread_local(**@thread_locals) do
               yield(self)
             end
           end

data/lib/openhab/dsl/types/decimal_type.rb

@@ -36,14 +36,14 @@ module OpenHAB
           if value.is_a?(java.math.BigDecimal)
             super
           elsif value.is_a?(BigDecimal)
-            super(value.to_java)
+            super(value.to_java.strip_trailing_zeros)
           elsif value.is_a?(DecimalType)
             super(value.to_big_decimal)
           elsif value.is_a?(Items::NumericItem) ||
                 (value.is_a?(Items::GroupItem) && value.base_item.is_a?(Items::NumericItem))
             super(value.state)
           elsif value.respond_to?(:to_d)
-            super(value.to_d.to_java)
+            super(value.to_d.to_java.strip_trailing_zeros)
           else # rubocop:disable Lint/DuplicateBranch
             # duplicates the Java BigDecimal branch, but that needs to go first
             # in order to avoid unnecessary conversions

data/lib/openhab/log/logger.rb

@@ -212,7 +212,7 @@ module OpenHAB
               .then { |klass| java_klass(klass) }
               .then(&:name)
               .then { |name| filter_base_classes(name) }
-              .then { |name| name&.prepend('.') }
+              .then { |name| ".#{name}" unless name.nil? } # name is frozen in jruby 9.4
       end
 
       # Get the appropriate java class for the supplied klass if the supplied

data/lib/openhab/version.rb

@@ -5,5 +5,5 @@
 #
 module OpenHAB
   # @return [String] Version of OpenHAB helper libraries
-  VERSION = '4.42.2'
+  VERSION = '4.43.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.42.2
+  version: 4.43.2
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-29 00:00:00.000000000 Z
+date: 2022-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: JRuby Helper Libraries for OpenHAB Scripting
 email:
 - broconne@gmail.com