openhab-scripting 2.25.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3deb9da52443a92a787b19c30a5e540bf45ffa1f2ce69e7b47554190468e311
-  data.tar.gz: eae005970cf7f0c47f896fa9e2ab194c1a8c23b8901b535cde8b66efcc864e1c
+  metadata.gz: 7eb19f2aa4bac30a6fb3b4f07953a9b78a54419795d4845c073432d803fa8629
+  data.tar.gz: 7528671d2c2db7a58ecdc46b33f9b94656ff2cfc878ab76bc2703fcff4c49a7b
 SHA512:
-  metadata.gz: 5fc8e075065e222e388a0c8b83a53644ea0b6d909f7c7c1109450f4be535a91e77319fa4d73e950df6ad9023bfc8051a242dcafcf51a1ff96934c6a43a9a8b51
-  data.tar.gz: b869685445af147f35ce27a793c8f533fdc39af25842935cd1c3265610383d0332830fae97edb4746a49dc96fd7f351debcb7e1eb28646c174dff03cef5e1c7f
+  metadata.gz: 6ef8331db3b6985bcc1ebb3b3b16fb251b61a482e10fc586e1d6bb2f7460ca197ecf8e38492613effd7fe6ff3f62f3975b443879f698373083c0b6ec192542d5
+  data.tar.gz: 20451cc85edb7a50ad3d5f7d80415b6b769129d5ce5b9cd246f98d51f1c588036340a7c1c9211184c396b1919a44c8d49fa303b3637d6182964b28cf76ca6edb

data/lib/openhab/core/entity_lookup.rb

@@ -9,9 +9,9 @@ require 'openhab/dsl/items/number_item'
 require 'openhab/dsl/items/string_item'
 require 'openhab/dsl/items/datetime_item'
 require 'openhab/dsl/items/rollershutter_item'
+require 'openhab/dsl/items/group_item'
 
 # Automation lookup and injection of OpenHab entities
-java_import org.openhab.core.items.GroupItem
 
 module OpenHAB
   module Core
@@ -87,25 +87,25 @@ module OpenHAB
       # @return [Object] the ruby wrapper for the item
       #
       # rubocop: disable Metrics/MethodLength
-      # rubocop: disable Metrics/AbcSize
       # Disabled line length and branch size - case dispatch pattern
-      private_class_method def self.decorate_item(item)
+      def self.decorate_item(item)
         case item
-        when GroupItem
-          decorate_group(item)
-        when Java::Org.openhab.core.library.items::NumberItem
+        when Java::OrgOpenhabCoreItems::GroupItem
+          OpenHAB::DSL::Items::GroupItem.new(item)
+        when Java::OrgOpenhabCoreLibraryItems::NumberItem
           OpenHAB::DSL::Items::NumberItem.new(item)
-        when Java::Org.openhab.core.library.items::StringItem
+        when Java::OrgOpenhabCoreLibraryItems::StringItem
           OpenHAB::DSL::Items::StringItem.new(item)
-        when Java::Org.openhab.core.library.items::DateTimeItem
+        when Java::OrgOpenhabCoreLibraryItems::DateTimeItem
           OpenHAB::DSL::Items::DateTimeItem.new(item)
-        when Java::Org.openhab.core.library.items::RollershutterItem
+        when Java::OrgOpenhabCoreLibraryItems::RollershutterItem
           OpenHAB::DSL::Items::RollershutterItem.new(item)
+        when Java::OrgOpenhabCoreLibraryItems::PlayerItem
+          OpenHAB::DSL::Items::PlayerItem.new(item)
         else
           item
         end
       end
-      # rubocop: enable Metrics/AbcSize
       # rubocop: enable Metrics/MethodLength
 
       #
@@ -144,19 +144,6 @@ module OpenHAB
         # rubocop: enable Style/GlobalVars
         decorate_item(item)
       end
-
-      #
-      # Decorate a group from an item base
-      #
-      # @param [OpenHAB item] item item to convert to a group item
-      #
-      # @return [OpenHAB::DSL::Groups::Group] Group created from supplied item
-      #
-      private_class_method def self.decorate_group(item)
-        group = OpenHAB::DSL::Groups::Group.new(Set.new(decorate_items(item.all_members.to_a)))
-        group.group = item
-        group
-      end
     end
   end
 end

data/lib/openhab/dsl/dsl.rb

@@ -15,6 +15,8 @@ require 'openhab/dsl/things'
 require 'openhab/dsl/items/items'
 require 'openhab/dsl/items/datetime_item'
 require 'openhab/dsl/items/number_item'
+require 'openhab/dsl/items/player_item'
+require 'openhab/dsl/items/group_item'
 require 'openhab/dsl/time_of_day'
 require 'openhab/dsl/gems'
 require 'openhab/dsl/persistence'

data/lib/openhab/dsl/group.rb

@@ -3,6 +3,7 @@
 require 'delegate'
 require 'forwardable'
 require 'openhab/core/entity_lookup'
+require 'openhab/dsl/items/group_item'
 
 module OpenHAB
   module DSL
@@ -10,11 +11,6 @@ module OpenHAB
     # Provides access to OpenHAB Groups
     #
     module Groups
-      #
-      # Indicator struct interpreted by rules to trigger based on items contained in a group
-      #
-      GroupItems = Struct.new(:group, keyword_init: true)
-
       #
       # Provide access to groups as a set
       #
@@ -27,7 +23,7 @@ module OpenHAB
         #
         def[](name)
           group = OpenHAB::Core::EntityLookup.lookup_item(name)
-          group.is_a?(Group) ? group : nil
+          group.is_a?(OpenHAB::DSL::Items::GroupItem) ? group : nil
         end
       end
 
@@ -38,64 +34,9 @@ module OpenHAB
       #
       def groups
         # rubocop: disable Style/GlobalVars
-        Groups.new(OpenHAB::Core::EntityLookup.decorate_items($ir.items.select { |item| item.is_a? GroupItem }))
+        Groups.new(OpenHAB::Core::EntityLookup.decorate_items($ir.items.grep(Java::OrgOpenhabCoreItems::GroupItem)))
         # rubocop: enable Style/GlobalVars
       end
-
-      # Group class that provides access to OpenHAB group object and delegates other methods to
-      # a set of group items
-      class Group < SimpleDelegator
-        extend Forwardable
-
-        java_import Java::OrgOpenhabCoreItems::GroupItem
-
-        # @return [org.openhab.core.items.GroupItem] OpenHAB Java Group Item
-        attr_accessor :group
-
-        # @!macro [attach] def_delegators
-        #   @!method $2
-        #     Forwards to org.openhab.core.items.GroupItem
-        #     @see org::openhab::core::items::GroupItem
-        %i[name label << command].each do |method|
-          def_delegator :@group, method
-        end
-
-        #
-        # Gets members of this group that are themselves a group
-        #
-        # @return [Set] Set of members that are of type group
-        #
-        def groups
-          group.members.grep(GroupItem)
-        end
-
-        #
-        # Wraps the group in a struct, this method is intended to be called
-        # as an indicator to the rule method that the user wishes to trigger
-        # based on changes to group items
-        #
-        # @return [GroupItems] Indicator struct used by rules engine to trigger based on item changes
-        #
-        def items
-          GroupItems.new(group: group)
-        end
-
-        #
-        # @return [String] List of groups seperated by commas
-        #
-        def to_s
-          "[#{map(&:to_s).join(',')}]"
-        end
-
-        #
-        # Get an ID for the group, using the label if set, otherwise group name
-        #
-        # @return [String] label if set otherwise name
-        #
-        def id
-          label || name
-        end
-      end
     end
   end
 end

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

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require 'delegate'
+require 'forwardable'
+require 'java'
+require 'openhab/dsl/items/item_command'
+require 'openhab/dsl/items/item_delegate'
+require 'openhab/core/entity_lookup'
+
+module OpenHAB
+  module DSL
+    module Items
+      #
+      # Class for indicating to triggers that a group trigger should be used
+      #
+      class GroupMembers < SimpleDelegator
+        attr_reader :group
+
+        #
+        # Create a new GroupMembers instance from a GroupItem
+        #
+        # @param [GroupItem] group_item GroupItem to use as trigger
+        #
+        def initialize(group_item)
+          @group = group_item
+          super(OpenHAB::Core::EntityLookup.decorate_items(@group.members.to_a))
+        end
+      end
+
+      #
+      # Delegator to OpenHAB Group Item
+      #
+      class GroupItem
+        extend OpenHAB::DSL::Items::ItemCommand
+        extend OpenHAB::DSL::Items::ItemDelegate
+        include Enumerable
+        include Comparable
+
+        def_item_delegator :@group_item
+
+        #
+        # @return [Hash] A hash of lambdas with default filters for `all_members`
+        #
+        DEFAULT_FILTERS = {
+          groups: ->(item) { item.is_a?(Java::OrgOpenhabCoreItems::GroupItem) },
+          all: -> { true }
+        }.freeze
+
+        private_constant :DEFAULT_FILTERS
+
+        #
+        # Create a new GroupItem
+        #
+        # @param [Java::Org::openhab::core::items::GroupItem] group_item OpenHAB GroupItem to delegate to
+        #
+        def initialize(group_item)
+          @group_item = group_item
+
+          item_missing_delegate { @group_item }
+          item_missing_delegate { OpenHAB::Core::EntityLookup.decorate_item(base_item) }
+        end
+
+        #
+        # Create a GroupMembers object for use in triggers
+        #
+        # @return [GroupMembers] A GroupMembers object
+        #
+        def members
+          GroupMembers.new(@group_item)
+        end
+
+        #
+        # Iterates through the direct members of the Group
+        #
+        def each(&block)
+          OpenHAB::Core::EntityLookup.decorate_items(@group_item.members.to_a).each(&block)
+        end
+
+        #
+        # Get all members of the group recursively. Optionally filter the items to only return
+        # Groups or regular Items
+        #
+        # @param [Symbol] filter Either :groups or :items
+        #
+        # @return [Array] An Array containing all descendants of the Group, optionally filtered
+        #
+        def all_members(filter = nil, &block)
+          predicate = DEFAULT_FILTERS[filter] || block
+
+          return OpenHAB::Core::EntityLookup.decorate_items(@group_item.all_members.to_a) unless predicate
+
+          OpenHAB::Core::EntityLookup.decorate_items(@group_item.get_members(&predicate).to_a)
+        end
+
+        #
+        # Test for equality
+        #
+        # @param [Object] other Other object to compare against
+        #
+        # @return [Boolean] true if self and other can be considered equal, false otherwise
+        #
+        def ==(other)
+          if other.respond_to?(:java_class) && accepted_data_types.include?(other.java_class)
+            get_state_as(other.class) == other
+          elsif other.respond_to?(:state)
+            base_item ? OpenHAB::Core::EntityLookup.decorate_item(base_item) == other.state : self == other.state
+          else
+            super
+          end
+        end
+
+        #
+        # Compare GroupItem to supplied object
+        #
+        # @param [Object] other object to compare to
+        #
+        # @return [Integer] -1,0,1 or nil depending on value supplied,
+        #   nil comparison to supplied object is not possible.
+        #
+        def <=>(other)
+          if base_item
+            OpenHAB::Core::EntityLookup.decorate_item(base_item) <=> other
+          elsif state?
+            -(other <=> state)
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'java'
+require 'openhab/log/logger'
 
 module OpenHAB
   module DSL
@@ -9,19 +10,25 @@ module OpenHAB
       # Holds methods to automatically generate commands and
       # accessors for items
       module ItemCommand
+        include OpenHAB::Log
+
         #
         # For every value in the supplied enumeration create a corresponding method mapped to the lowercase
         # string representation of the enum value For example, an enum with values of STOP and START
         # would create methods stop() and start() that send the corresponding STOP and START commands to the item
         #
         # @param [Java::JavaLang::Enum] command_enum Enumeration to create commands for
+        # @param [Hash] optional hash in which if a generated method name mactches a key, the value of that key
+        #   will be used as the method name instead, for example `:play? => :playing?`
         #
         #
-        def item_command(command_enum)
+        def item_command(command_enum, methods = {})
           # rubocop:disable Style/HashEachMethods
           # Disable rule because Java enum does not support each_value
           command_enum.values.each do |command|
             command_method = command.to_s.downcase
+            command_method = methods.transform_keys(&:to_sym).fetch(command_method.to_sym, command_method)
+            logger.trace("Creating command method (#{command_method}) for #{self.class}")
             define_method(command_method) do
               self.command(command)
             end
@@ -37,14 +44,17 @@ module OpenHAB
         #
         # @param [Java::JavaLang::Enum] command_enum Enumeration to create methods for each value
         #   to check if current state matches that enum
-        # @yield [state] Optional block that can be used to transform state prior to comparison
+        # @param [Hash] optional hash in which if a generated method name mactches a key, the value of that key
+        #   will be used as the method name instead, for example `:play? => :playing?`
         #
         #
-        def item_state(command_enum)
+        def item_state(command_enum, methods = {})
           # rubocop:disable Style/HashEachMethods
           # Disable rule because Java enum does not support each_value
           command_enum.values.each do |command|
             status_method = "#{command.to_s.downcase}?"
+            status_method = methods.transform_keys(&:to_sym).fetch(status_method.to_sym, status_method)
+            logger.trace("Creating status method (#{status_method}) for #{self.class}")
             define_method(status_method) do
               state? && state.as(command_enum) == command
             end
@@ -57,14 +67,18 @@ module OpenHAB
         # Item class and pass them to item_state/item_command
         #
         # @param [Java::JavaLang::Class] item_class a Class that implements Java::OrgOpenhabCoreItems::Item
+        # @param [Hash] optional hash in which if a generated method name mactches a key, the value of that key
+        #   will be used as the method name instead, for example `:play? => :playing?`
         #
-        def item_type(item_class)
+        def item_type(item_class, methods = {})
           item_class.field_reader(:ACCEPTED_DATA_TYPES)
           item_class.field_reader(:ACCEPTED_COMMAND_TYPES)
-          item_class.ACCEPTED_DATA_TYPES.select(&:is_enum).grep_v(UnDefType).each { |type| item_state(type.ruby_class) }
-          item_class.ACCEPTED_COMMAND_TYPES.select(&:is_enum).grep_v(UnDefType).each do |type|
-            item_command(type.ruby_class)
-          end
+          item_class.ACCEPTED_DATA_TYPES.select(&:is_enum)
+                    .grep_v(UnDefType)
+                    .each { |type| item_state(type.ruby_class, methods) }
+          item_class.ACCEPTED_COMMAND_TYPES.select(&:is_enum)
+                    .grep_v(UnDefType)
+                    .each { |type| item_command(type.ruby_class, methods) }
         end
       end
     end

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

@@ -33,12 +33,11 @@ module OpenHAB
         alias key? include?
       end
 
-      java_import org.openhab.core.items.GroupItem
       # Fetches all non-group items from the item registry
       # @return [OpenHAB::DSL::Items::Items]
       def items
         # rubocop: disable Style/GlobalVars
-        Items.new(OpenHAB::Core::EntityLookup.decorate_items($ir.items.reject { |item| item.is_a? GroupItem }))
+        Items.new(OpenHAB::Core::EntityLookup.decorate_items($ir.items.grep_v(Java::OrgOpenhabCoreItems::GroupItem)))
         # rubocop: enable Style/GlobalVars
       end
     end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'java'
+require 'openhab/dsl/items/item_command'
+require 'openhab/dsl/items/item_delegate'
+
+module OpenHAB
+  module DSL
+    module Items
+      #
+      # Delegator to OpenHAB Player Item
+      #
+      class PlayerItem
+        extend OpenHAB::DSL::Items::ItemCommand
+        extend OpenHAB::DSL::Items::ItemDelegate
+        extend Forwardable
+
+        def_item_delegator :@player_item
+
+        item_type Java::OrgOpenhabCoreLibraryItems::PlayerItem, :play? => :playing?,
+                                                                :pause? => :paused?,
+                                                                :rewind? => :rewinding?,
+                                                                :fastforward? => :fastforwarding?
+
+        # rubocop: disable Style/Alias
+        # Disabled because 'alias' does not work with the dynamically defined methods
+        alias_method :fast_forward, :fastforward
+        alias_method :fast_forwarding?, :fastforwarding?
+        # rubocop: enable Style/Alias
+
+        #
+        # Creates a new PlayerItem
+        #
+        # @param [Java::OrgOpenhabCoreLibraryItems::PlayerItem] player_item
+        #   The OpenHAB PlayerItem to delegate to
+        #
+        def initialize(player_item)
+          logger.trace("Wrapping #{player_item}")
+          @player_item = player_item
+
+          item_missing_delegate { @player_item }
+
+          super()
+        end
+      end
+    end
+  end
+end

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

@@ -10,7 +10,6 @@ require 'openhab/dsl/monkey_patch/items/persistence'
 require 'openhab/dsl/monkey_patch/items/contact_item'
 require 'openhab/dsl/monkey_patch/items/dimmer_item'
 require 'openhab/dsl/monkey_patch/items/switch_item'
-require 'openhab/dsl/monkey_patch/items/group_item'
 
 module OpenHAB
   module DSL

data/lib/openhab/dsl/monkey_patch/items/metadata.rb

@@ -103,8 +103,7 @@ module OpenHAB
             # @return [OpenHAB::DSL::MonkeyPatch::Items::MetadataItem], or nil if the namespace doesn't exist
             #
             def [](namespace)
-              logger.trace("Namespaces (#{NamespaceAccessor.registry.getAll})")
-              logger.trace("Namespace (#{NamespaceAccessor.registry.get(MetadataKey.new(namespace, @item_name))})")
+              logger.trace("Getting metadata for item: #{@item_name}, namespace '#{namespace}'")
               metadata = NamespaceAccessor.registry.get(MetadataKey.new(namespace, @item_name))
               MetadataItem.new(metadata: metadata) if metadata
             end

data/lib/openhab/dsl/monkey_patch/items/persistence.rb

@@ -8,6 +8,7 @@ module OpenHAB
         # Persistence extension for Items
         #
         module Persistence
+          java_import Java::OrgOpenhabCoreTypesUtil::UnitUtils
           # All persistence methods that could return a Quantity
           QUANTITY_METHODS = %i[average_since
                                 delta_since
@@ -81,9 +82,10 @@ module OpenHAB
           # @return [Object] Quantity or the original value
           #
           def quantify(value)
-            if value.is_a?(Java::OrgOpenhabCoreLibraryTypes::DecimalType) && respond_to?(:unit) && unit
-              logger.trace("Unitizing #{value} with unit #{unit}")
-              Quantity.new(Java::OrgOpenhabCoreLibraryTypes::QuantityType.new(value.to_big_decimal, unit))
+            if value.is_a?(Java::OrgOpenhabCoreLibraryTypes::DecimalType) && state_description&.pattern
+              item_unit = UnitUtils.parse_unit(state_description.pattern)
+              logger.trace("Unitizing #{value} with unit #{item_unit}")
+              Quantity.new(Java::OrgOpenhabCoreLibraryTypes::QuantityType.new(value.to_big_decimal, item_unit))
             else
               value
             end

data/lib/openhab/dsl/monkey_patch/types/open_closed_type.rb

@@ -25,9 +25,13 @@ module OpenHAB
           # @return [Boolean] True if the other object is a ContactItem and has the same state
           #
           def ===(other)
-            super unless other.is_a? ContactItem
-
-            self == other.state
+            if other.respond_to?(:state)
+              self == other.state
+            elsif other.is_a? OpenClosedType
+              self == other
+            else
+              super
+            end
           end
         end
       end

data/lib/openhab/dsl/monkey_patch/types/up_down_type.rb

@@ -22,9 +22,13 @@ module OpenHAB
           # @return [Boolean] True if the other object is a RollershutterItem and has the same state
           #
           def ===(other)
-            super unless other.is_a? OpenHAB::DSL::Items::RollershutterItem
-
-            equals(other.state.as(UpDownType))
+            if other.respond_to?(:state)
+              self == other.state&.as(UpDownType)
+            elsif other.is_a? UpDownType
+              self == other
+            else
+              super
+            end
           end
         end
       end

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

@@ -255,13 +255,28 @@ module OpenHAB
           event = inputs&.dig('event')
 
           while (task = run_queue.shift)
-            case task
-            when RuleConfig::Run then process_run_task(event, task)
-            when RuleConfig::Trigger then process_trigger_task(event, task)
-            when RuleConfig::Delay then process_delay_task(inputs, mod, run_queue, task)
-            when RuleConfig::Otherwise then process_otherwise_task(event, task)
+            if task.is_a? RuleConfig::Delay
+              process_delay_task(inputs, mod, run_queue, task)
+            else
+              process_task(event, task)
             end
           end
+        rescue StandardError => e
+          print_backtrace(e)
+        end
+
+        #
+        # Dispatch execution block tasks to different methods
+        #
+        # @param [OpenHab Event] event that triggered the rule
+        # @param [Task] task task containing otherwise block to execute
+        #
+        def process_task(event, task)
+          case task
+          when RuleConfig::Run then process_run_task(event, task)
+          when RuleConfig::Trigger then process_trigger_task(event, task)
+          when RuleConfig::Otherwise then process_otherwise_task(event, task)
+          end
         end
 
         #
@@ -316,6 +331,16 @@ module OpenHAB
           task.block.call(event)
         end
 
+        #
+        # Print error and stack trace without calls to internal classes
+        #
+        # @param [Exception] error A rescued error
+        #
+        def print_backtrace(error)
+          error = logger.clean_backtrace(error)
+          logger.error { "#{error.message} (#{error.class})\nIn rule: #{name}\n#{error.backtrace&.join("\n")}" }
+        end
+
         #
         # Create a new hash in which all elements are converted to strings
         #

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

@@ -59,7 +59,8 @@ module OpenHAB
           #
           def should_run?(event)
             logger.trace("Checking guards #{self}")
-            check(@only_if, check_type: :only_if, event: event) && check(@not_if, check_type: :not_if, event: event)
+            check(@only_if, :check_type => :only_if,
+                            :event => event) && check(@not_if, :check_type => :not_if, :event => event)
           end
 
           private
@@ -79,7 +80,7 @@ module OpenHAB
             procs, items = conditions.flatten.partition { |condition| condition.is_a? Proc }
             logger.trace("Procs: #{procs} Items: #{items}")
 
-            items.each { |item| logger.trace("#{item} truthy? #{item.truthy?}") }
+            items.each { |item| logger.trace { "#{item} truthy? #{item.truthy?}" } }
 
             process_check(check_type: check_type, event: event, items: items, procs: procs)
           end

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

@@ -27,6 +27,8 @@ module OpenHAB
         config.guard = Guard::Guard.new(only_if: config.only_if, not_if: config.not_if)
         logger.trace { config.inspect }
         process_rule_config(config)
+      rescue StandardError => e
+        re_raise_with_backtrace(e)
       end
 
       #
@@ -44,6 +46,16 @@ module OpenHAB
 
       private
 
+      #
+      # Re-raises a rescued error to OpenHAB with added rule name and stack trace
+      #
+      # @param [Exception] error A rescued error
+      #
+      def re_raise_with_backtrace(error)
+        error = logger.clean_backtrace(error)
+        raise error, "#{error.message}\nIn rule: #{@rule_name}\n#{error.backtrace.join("\n")}"
+      end
+
       #
       # Process a rule based on the supplied configuration
       #

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

@@ -31,8 +31,6 @@ module OpenHAB
         include OpenHAB::DSL::Rules::Property
         extend OpenHAB::DSL
 
-        java_import org.openhab.core.library.items.SwitchItem
-
         # @return [Array] Of triggers
         attr_reader :triggers
 
@@ -62,10 +60,10 @@ module OpenHAB
         #
         Delay = Struct.new(:duration)
 
-        prop_array :run, array_name: :run_queue, wrapper: Run
-        prop_array :triggered, array_name: :run_queue, wrapper: Trigger
-        prop_array :delay, array_name: :run_queue, wrapper: Delay
-        prop_array :otherwise, array_name: :run_queue, wrapper: Otherwise
+        prop_array :run, :array_name => :run_queue, :wrapper => Run
+        prop_array :triggered, :array_name => :run_queue, :wrapper => Trigger
+        prop_array :delay, :array_name => :run_queue, :wrapper => Delay
+        prop_array :otherwise, :array_name => :run_queue, :wrapper => Otherwise
 
         prop :name
         prop :description

data/lib/openhab/dsl/rules/triggers/changed.rb

@@ -31,7 +31,7 @@ module OpenHAB
         # @return [Trigger] OpenHAB trigger
         #
         def changed(*items, to: nil, from: nil, for: nil)
-          items.flatten.each do |item|
+          separate_groups(items).each do |item|
             logger.trace("Creating changed trigger for entity(#{item}), to(#{to}), from(#{from})")
             # for is a reserved word in ruby, so use local_variable_get :for
             if (wait_duration = binding.local_variable_get(:for))
@@ -73,7 +73,8 @@ module OpenHAB
         #
         def create_changed_trigger(item, from, to)
           trigger, config = case item
-                            when GroupItems then create_group_changed_trigger(item, from, to)
+                            when OpenHAB::DSL::Items::GroupItem::GroupMembers
+                              create_group_changed_trigger(item, from, to)
                             when Thing then create_thing_changed_trigger(item, from, to)
                             else create_item_changed_trigger(item, from, to)
                             end

data/lib/openhab/dsl/rules/triggers/command.rb

@@ -22,7 +22,7 @@ module OpenHAB
         #
         #
         def received_command(*items, command: nil, commands: nil)
-          items.flatten.each do |item|
+          separate_groups(items).flatten.each do |item|
             logger.trace("Creating received command trigger for item(#{item})"\
                          "command(#{command}) commands(#{commands})")
 
@@ -43,7 +43,7 @@ module OpenHAB
         #
         def create_received_trigger(commands, item)
           commands.each do |command|
-            if item.is_a? GroupItems
+            if item.is_a? OpenHAB::DSL::Items::GroupItem::GroupMembers
               config, trigger = create_group_command_trigger(item)
             else
               config, trigger = create_item_command_trigger(item)

data/lib/openhab/dsl/rules/triggers/trigger.rb

@@ -53,6 +53,20 @@ module OpenHAB
           trigger
         end
 
+        #
+        # Separates groups from items, and flattens any nested arrays of items
+        #
+        # @param [Array] item_array Array of items passed to a trigger
+        #
+        # @return [Array] A new flat array with any GroupMembers object left intact
+        #
+        def separate_groups(item_array)
+          return item_array if item_array.length <= 1 && item_array.grep(Array).length.zero?
+
+          groups, items = item_array.partition { |item| item.is_a? OpenHAB::DSL::Items::GroupItem::GroupMembers }
+          groups + separate_groups(items.flatten(1))
+        end
+
         #
         # Class for creating and managing triggers
         #

data/lib/openhab/dsl/rules/triggers/updated.rb

@@ -20,7 +20,7 @@ module OpenHAB
         # @return [Trigger] Trigger for updated entity
         #
         def updated(*items, to: nil)
-          items.flatten.each do |item|
+          separate_groups(items).flatten.each do |item|
             logger.trace("Creating updated trigger for item(#{item}) to(#{to})")
             [to].flatten.each do |to_state|
               trigger, config = create_update_trigger(item, to_state)
@@ -42,7 +42,7 @@ module OpenHAB
         #
         def create_update_trigger(item, to_state)
           case item
-          when GroupItems then group_update(item, to_state)
+          when OpenHAB::DSL::Items::GroupItem::GroupMembers then group_update(item, to_state)
           when Thing then thing_update(item, to_state)
           else item_update(item, to_state)
           end

data/lib/openhab/dsl/states.rb

@@ -48,8 +48,7 @@ module OpenHAB
       # @return [StateStorage] item states
       #
       def store_states(*items)
-        items = items.flatten.map { |item| item.is_a?(Group) ? item.group : item }
-        states = StateStorage.new(BusEvent.storeStates(*items).to_h)
+        states = StateStorage.new(BusEvent.storeStates(*items.flatten).to_h)
         if block_given?
           yield
           states.restore

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

@@ -144,8 +144,10 @@ module OpenHAB
 
         OPERATIONS.each do |operation, method|
           define_method(operation) do |other|
-            logger.trace("Executing math operation '#{operation}' on quantity #{inspect} "\
-                         "with other type #{other.class} and value #{other.inspect}")
+            logger.trace do
+              "Executing math operation '#{operation}' on quantity #{inspect} "\
+                         "with other type #{other.class} and value #{other.inspect}"
+            end
 
             a, b = to_qt(coerce(other).reverse)
             logger.trace("Coerced a='#{a}' with b='#{b}'")

data/lib/openhab/log/logger.rb

@@ -16,7 +16,14 @@ module OpenHAB
       java_import org.slf4j.LoggerFactory
 
       # @return [Array] Supported logging levels
-      LEVELS = %i[TRACE DEBUG WARN INFO ERROR].freeze
+      LEVELS = %i[trace debug warn info error].freeze
+      private_constant :LEVELS
+
+      #
+      # Regex for matching internal calls in a stack trace
+      #
+      INTERNAL_CALL_REGEX = %r{(openhab-scripting-.*/lib)|(org/jruby/)}.freeze
+      private_constant :INTERNAL_CALL_REGEX
 
       #
       # Create a new logger
@@ -32,11 +39,30 @@ module OpenHAB
       # def <level>(msg=nil, &block)
       #   log(severity: <level>, msg: msg, &block)
       # end
+      #
+      # Also creates methods to check if the different logging levels are enabled
+      #
       LEVELS.each do |level|
-        method = level.to_s.downcase
-        define_method(method.to_s) do |msg = nil, &block|
+        define_method(level) do |msg = nil, &block|
           log(severity: level, msg: msg, &block)
         end
+        define_method("#{level}_enabled?") { @sl4fj_logger.send("is_#{level}_enabled") }
+      end
+
+      #
+      # Cleans the backtrace of an error to remove internal calls. If logging is set
+      # to debug or lower, the full backtrace is kept
+      #
+      # @param [Exception] error An exception to be cleaned
+      #
+      # @return [Exception] the exception, potentially with a cleaned backtrace.
+      #
+      def clean_backtrace(error)
+        return error if debug_enabled?
+
+        backtrace = error.backtrace_locations.reject { |line| INTERNAL_CALL_REGEX.match? line.to_s }
+        error.set_backtrace(backtrace.map(&:to_s))
+        error
       end
 
       private
@@ -54,7 +80,7 @@ module OpenHAB
         raise ArgumentError, "Unknown Severity #{severity}" unless LEVELS.include? severity
 
         # Dynamically check enablement of underlying logger, this expands to "is_<level>_enabled"
-        return unless @sl4fj_logger.send("is_#{severity.to_s.downcase}_enabled")
+        return unless send("#{severity}_enabled?")
 
         # Process block if no message provided
         msg = yield if msg.nil? && block_given?
@@ -62,7 +88,7 @@ module OpenHAB
         msg = message_to_string(msg: msg)
 
         # Dynamically invoke underlying logger, this expands to "<level>(message)"
-        @sl4fj_logger.send(severity.to_s.downcase, msg)
+        @sl4fj_logger.send(severity, msg)
       end
 
       #
@@ -121,7 +147,7 @@ module OpenHAB
         configure_logger_for(classname)
       end
 
-     private
+      private
 
       #
       # Configure a logger for the supplied classname
@@ -153,7 +179,7 @@ module OpenHAB
                         .first
                         .yield_self { |caller| File.basename(caller, '.*') }
       end
-   end
+    end
 
     #
     # Add logger method to the object that includes this module

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.25.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-28 00:00:00.000000000 Z
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -40,10 +40,12 @@ files:
 - lib/openhab/dsl/gems.rb
 - lib/openhab/dsl/group.rb
 - lib/openhab/dsl/items/datetime_item.rb
+- lib/openhab/dsl/items/group_item.rb
 - lib/openhab/dsl/items/item_command.rb
 - lib/openhab/dsl/items/item_delegate.rb
 - lib/openhab/dsl/items/items.rb
 - lib/openhab/dsl/items/number_item.rb
+- lib/openhab/dsl/items/player_item.rb
 - lib/openhab/dsl/items/rollershutter_item.rb
 - lib/openhab/dsl/items/string_item.rb
 - lib/openhab/dsl/monkey_patch/actions/actions.rb
@@ -56,7 +58,6 @@ files:
 - lib/openhab/dsl/monkey_patch/events/thing_status_info.rb
 - lib/openhab/dsl/monkey_patch/items/contact_item.rb
 - lib/openhab/dsl/monkey_patch/items/dimmer_item.rb
-- lib/openhab/dsl/monkey_patch/items/group_item.rb
 - lib/openhab/dsl/monkey_patch/items/items.rb
 - lib/openhab/dsl/monkey_patch/items/metadata.rb
 - lib/openhab/dsl/monkey_patch/items/persistence.rb

data/lib/openhab/dsl/monkey_patch/items/group_item.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB items
-      #
-      module Items
-        java_import Java::OrgOpenhabCoreItems::GroupItem
-
-        #
-        # Monkey patch Group Item
-        #
-        class GroupItem
-          #
-          # Get all items in a group
-          #
-          # @return [Array] Array of items in the group
-          #
-          def items
-            to_a
-          end
-
-          #
-          # Get all items in the group as an Array
-          #
-          # @return [Array] All items in the group
-          #
-          def to_a
-            all_members.each_with_object([]) { |item, arr| arr << item }
-          end
-        end
-      end
-    end
-  end
-end