openhab-scripting 2.25.1 → 2.27.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7226c1329289ce5ce0f85f552c091a6c5f89cb27427b9e6419d528c77a792239
-  data.tar.gz: e92ad134d92584fed6ddeeef98984cabc56355cd94f4d205a5228263ac2677d1
+  metadata.gz: f73567aa2e4ca6070bbcb6963c46babc966e069f62d60f4def67fbca8aa0b70e
+  data.tar.gz: d01862005948c69fb130ba93a14732f6fa565528b40d13ce13252c6da7523359
 SHA512:
-  metadata.gz: '0519c68cec3b2316751c36ba27c208267ee86f76230a1722dcd3369d61e19da73a96b6616ed2a71838daf68beb3f64b88e1553f82f8cb00daec4de5c859ecb87'
-  data.tar.gz: f688f894e8a4bde1c3ee12facc846836a922cc7a1120ffd5d89ff41a6d6be1692608467265179543aaed1262394ea37aaa92d4bd5b03ad9eb33bcdd13b06c8dc
+  metadata.gz: bbdae9215b3347eabc65ea92eb70ac44834b374233ce7f31b15bfa8f99dcc05c9b85d2c1b7fad3c29d63be62100966648bac9e4255ab614edf40a2dd231b24a8
+  data.tar.gz: 5d8b30987d208674337ffddd43caaeee1c72596ae82e9a3792b74adbb0d7c82879040333173230c6016fb0552be191de877ec664566cbd61f9b14fc150ed4d9e

data/lib/openhab/core/entity_lookup.rb

@@ -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)
         case item
         when GroupItem
           decorate_group(item)
-        when Java::Org.openhab.core.library.items::NumberItem
+        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
 
       #

data/lib/openhab/dsl/dsl.rb

@@ -15,6 +15,7 @@ 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/time_of_day'
 require 'openhab/dsl/gems'
 require 'openhab/dsl/persistence'

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,7 +33,7 @@ module OpenHAB
         alias key? include?
       end
 
-      java_import org.openhab.core.items.GroupItem
+      java_import Java::OrgOpenhabCoreItems::GroupItem
       # Fetches all non-group items from the item registry
       # @return [OpenHAB::DSL::Items::Items]
       def items

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/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/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

@@ -62,10 +62,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/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/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.1'
+  VERSION = '2.27.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.25.1
+  version: 2.27.1
 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
@@ -44,6 +44,7 @@ files:
 - 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