openhab-scripting 2.23.3 → 2.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2ae7c9c46b7dff785181b7846dc6e6e6b9f27d445d7f1b7cc108814e1e75531
-  data.tar.gz: fffb46ad699350c94c580a3cb8ee2545a3c7c5372a81d4c7dc867cb834ee33db
+  metadata.gz: ad2fe8201d5bb1fb3a8255e8b371f3413829dcf1218af8448d31fc5e0eab5c82
+  data.tar.gz: fed6a6f164eea7897f13e8bc491af2875ec7317eaf727157268c6c9a966bcc7c
 SHA512:
-  metadata.gz: 790a2b3838ce8847bf3dafe567336400c43dae0b9d638318c7c1d70539f60ed45714af3f376f2a93f27265b222dd35474b1fb477eb1c892258cea401ab3ff321
-  data.tar.gz: 5085945c207f2b00353ca899fab65a2e0990751c083b433729b22e3d798dac11b1a4e99a3d07fdaf6db439d5787e06b9d9a984661496b8a767d13d668f077b43
+  metadata.gz: 5002bb1c6e24fd9b42ff90baa7c752a1e40df5a845754f2dc911b5afbc535b15f523a1bd5ca3fcb885b3d0a1a348b1a804adcab8b226ee9ba1697ca6a9cff36a
+  data.tar.gz: df3ed1db10d9f660682e6cc600019546dbc4fb7b860cefcf27e8c74c2381dd183c8afd0e80aeafa628af8400cba4af01e1f380ebd18c7b0fba5e5068ea4e7213

data/lib/openhab/dsl/group.rb

@@ -47,7 +47,7 @@ module OpenHAB
       class Group < SimpleDelegator
         extend Forwardable
 
-        java_import org.openhab.core.items.GroupItem
+        java_import Java::OrgOpenhabCoreItems::GroupItem
 
         # @return [org.openhab.core.items.GroupItem] OpenHAB Java Group Item
         attr_accessor :group
@@ -56,8 +56,9 @@ module OpenHAB
         #   @!method $2
         #     Forwards to org.openhab.core.items.GroupItem
         #     @see org::openhab::core::items::GroupItem
-        def_delegator :@group, :name
-        def_delegator :@group, :label
+        %i[name label << command].each do |method|
+          def_delegator :@group, method
+        end
 
         #
         # Gets members of this group that are themselves a group
@@ -65,7 +66,7 @@ module OpenHAB
         # @return [Set] Set of members that are of type group
         #
         def groups
-          group.members.grep(org.openhab.core.items.GroupItem)
+          group.members.grep(GroupItem)
         end
 
         #

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

@@ -16,10 +16,13 @@ module OpenHAB
       #
       class DateTimeItem
         extend Forwardable
+        extend OpenHAB::DSL::Items::ItemDelegate
+        extend OpenHAB::DSL::Items::ItemCommand
         include Comparable
-        include OpenHAB::DSL::Items::ItemDelegate
 
-        def_delegator :@datetime_item, :to_s
+        def_item_delegator :@datetime_item
+
+        item_type Java::OrgOpenhabCoreLibraryItems::DateTimeItem
 
         #
         # Create a new DateTimeItem
@@ -29,8 +32,8 @@ module OpenHAB
         #
         def initialize(datetime_item)
           @datetime_item = datetime_item
-          item_delegate { @datetime_item }
-          item_delegate { to_dt }
+          item_missing_delegate { @datetime_item }
+          item_missing_delegate { to_dt }
         end
 
         #

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

@@ -51,6 +51,21 @@ module OpenHAB
           end
           # rubocop:enable Style/HashEachMethods
         end
+
+        #
+        # Extract the accepted state and command types from the specified OpenHAB
+        # Item class and pass them to item_state/item_command
+        #
+        # @param [Java::JavaLang::Class] item_class a Class that implements Java::OrgOpenhabCoreItems::Item
+        #
+        def item_type(item_class)
+          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
+        end
       end
     end
   end

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

@@ -2,6 +2,7 @@
 
 require 'java'
 require 'openhab/log/logger'
+require 'forwardable'
 
 module OpenHAB
   module DSL
@@ -12,6 +13,36 @@ module OpenHAB
       module ItemDelegate
         include OpenHAB::Log
 
+        # @return [Array<Symbol>] Array of methods that by default will be forwarded to an OpenHAB Item.
+        DEFAULT_DELEGATION_METHODS = %i[to_s groups].freeze
+        private_constant :DEFAULT_DELEGATION_METHODS
+
+        #
+        # Extends calling object with DSL and helper methods
+        #
+        # @param [Object] base Object to decorate with DSL and helper methods
+        #
+        #
+        def self.extended(base)
+          base.extend Forwardable
+          base.include OpenHAB::DSL::Items::ItemDelegate
+        end
+
+        #
+        # Delegate a set of methods to the supplied delegator
+        #
+        # @param [Java::OrgOpenhabCoreItems::GenericItem] item to delegate methods to
+        # @param [Symbol] methods to delegate, if not supplied default methods are used
+        #
+        #
+        def def_item_delegator(item, *methods)
+          methods = DEFAULT_DELEGATION_METHODS if methods.size.zero?
+          methods.each do |method|
+            logger.trace("Creating delegate for (#{method}) to #{item}) for #{self.class}")
+            def_delegator item, method
+          end
+        end
+
         #
         # Delegates methods to the object returned from the supplied block if
         #   they don't exist in the object this is included in.  If the supplied block returns nil, no delegation occurs
@@ -22,7 +53,7 @@ module OpenHAB
         # @param [Proc] &delegate delgegate block
         #
         #
-        def item_delegate(&delegate)
+        def item_missing_delegate(&delegate)
           @delegates ||= []
           @delegates << delegate
         end

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

@@ -16,17 +16,18 @@ module OpenHAB
       # Disabled because this class has a single responsibility, there does not appear a logical
       # way of breaking it up into multiple classes
       class NumberItem < Numeric
-        extend Forwardable
+        extend OpenHAB::DSL::Items::ItemDelegate
+        extend OpenHAB::DSL::Items::ItemCommand
 
-        include OpenHAB::DSL::Items::ItemDelegate
-
-        def_delegator :@number_item, :to_s
+        def_item_delegator :@number_item
 
         java_import org.openhab.core.library.types.DecimalType
         java_import org.openhab.core.library.types.QuantityType
         java_import 'tec.uom.se.format.SimpleUnitFormat'
         java_import 'tec.uom.se.AbstractUnit'
 
+        item_type Java::OrgOpenhabCoreLibraryItems::NumberItem
+
         #
         # Create a new NumberItem
         #
@@ -34,7 +35,7 @@ module OpenHAB
         #
         def initialize(number_item)
           @number_item = number_item
-          item_delegate { @number_item }
+          item_missing_delegate { @number_item }
           super()
         end
 

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

@@ -14,18 +14,12 @@ module OpenHAB
       class RollershutterItem < Numeric
         extend Forwardable
         extend OpenHAB::DSL::Items::ItemCommand
-        include OpenHAB::DSL::Items::ItemDelegate
+        extend OpenHAB::DSL::Items::ItemDelegate
         include Comparable
 
-        def_delegator :@rollershutter_item, :to_s
+        def_item_delegator :@rollershutter_item
 
-        java_import Java::OrgOpenhabCoreLibraryTypes::PercentType
-        java_import Java::OrgOpenhabCoreLibraryTypes::UpDownType
-        java_import Java::OrgOpenhabCoreLibraryTypes::StopMoveType
-
-        item_command Java::OrgOpenhabCoreLibraryTypes::StopMoveType
-        item_command Java::OrgOpenhabCoreLibraryTypes::UpDownType
-        item_state   Java::OrgOpenhabCoreLibraryTypes::UpDownType
+        item_type Java::OrgOpenhabCoreLibraryItems::RollershutterItem
 
         #
         # Creates a new RollershutterItem
@@ -37,8 +31,8 @@ module OpenHAB
           logger.trace("Wrapping #{rollershutter_item}")
           @rollershutter_item = rollershutter_item
 
-          item_delegate { @rollershutter_item }
-          item_delegate { position }
+          item_missing_delegate { @rollershutter_item }
+          item_missing_delegate { position }
 
           super()
         end

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

@@ -13,15 +13,17 @@ module OpenHAB
       #
       class StringItem
         extend Forwardable
-
+        extend OpenHAB::DSL::Items::ItemCommand
         include Comparable
-        include OpenHAB::DSL::Items::ItemDelegate
+        extend OpenHAB::DSL::Items::ItemDelegate
 
         # @return [Regex] Regular expression matching blank strings
         BLANK_RE = /\A[[:space:]]*\z/.freeze
         private_constant :BLANK_RE
 
-        def_delegator :@string_item, :to_s
+        def_item_delegator :@string_item
+
+        item_type Java::OrgOpenhabCoreLibraryItems::StringItem
 
         #
         # Create a new StringItem
@@ -31,8 +33,8 @@ module OpenHAB
         def initialize(string_item)
           @string_item = string_item
 
-          item_delegate { @string_item }
-          item_delegate { @string_item.state&.to_full_string&.to_s }
+          item_missing_delegate { @string_item }
+          item_missing_delegate { @string_item.state&.to_full_string&.to_s }
 
           super()
         end

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

@@ -25,7 +25,7 @@ module OpenHAB
 
           java_import Java::OrgOpenhabCoreLibraryTypes::OpenClosedType
 
-          item_state Java::OrgOpenhabCoreLibraryTypes::OpenClosedType
+          item_type Java::OrgOpenhabCoreLibraryItems::ContactItem
 
           #
           # Compares contacts to OpenClosedTypes

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

@@ -30,8 +30,7 @@ module OpenHAB
           extend Forwardable
           extend OpenHAB::DSL::Items::ItemCommand
 
-          item_state Java::OrgOpenhabCoreLibraryTypes::OnOffType
-          item_command Java::OrgOpenhabCoreLibraryTypes::IncreaseDecreaseType
+          item_type Java::OrgOpenhabCoreLibraryItems::DimmerItem
 
           def_delegator :state, :to_s
 

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

@@ -115,6 +115,15 @@ module OpenHAB
           def inspect
             toString
           end
+
+          #
+          # Return all groups that this item is part of
+          #
+          # @return [Array<Group>] All groups that this item is part of
+          #
+          def groups
+            group_names.map { |name| OpenHAB::DSL::Groups.groups[name] }
+          end
         end
 
         java_import Java::OrgOpenhabCoreItems::GenericItem

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

@@ -23,8 +23,7 @@ module OpenHAB
 
           java_import Java::OrgOpenhabCoreLibraryTypes::OnOffType
 
-          item_command Java::OrgOpenhabCoreLibraryTypes::OnOffType
-          item_state Java::OrgOpenhabCoreLibraryTypes::OnOffType
+          item_type Java::OrgOpenhabCoreLibraryItems::SwitchItem
 
           alias truthy? on?
 

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/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/types/datetime.rb

@@ -22,11 +22,14 @@ module OpenHAB
 
         def_delegator :datetime, :to_s
         def_delegator :zoned_date_time, :month_value, :month
+        def_delegator :zoned_date_time, :day_of_month, :mday
+        def_delegator :zoned_date_time, :day_of_year, :yday
         def_delegator :zoned_date_time, :minute, :min
         def_delegator :zoned_date_time, :second, :sec
         def_delegator :zoned_date_time, :nano, :nsec
         def_delegator :zoned_date_time, :to_epoch_second, :to_i
         alias inspect to_s
+        alias day mday
 
         java_import Java::OrgOpenhabCoreLibraryTypes::DateTimeType
         java_import java.time.ZonedDateTime
@@ -181,6 +184,15 @@ module OpenHAB
           utc_offset.zero?
         end
 
+        #
+        # Returns an integer representing the day of the week, 0..6, with Sunday == 0.
+        #
+        # @return [Integer] The day of week
+        #
+        def wday
+          zoned_date_time.day_of_week.value % 7
+        end
+
         #
         # The timezone
         #

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.23.3'
+  VERSION = '2.26.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.23.3
+  version: 2.26.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-21 00:00:00.000000000 Z
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler