openhab-scripting 2.16.2 → 2.19.0

data/lib/openhab/dsl/units.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'java'
+
+# Import Imperial and SI Units overriding provided values
+%i[Units ImperialUnits SIUnits].each do |type|
+  Object.send(:remove_const, type)
+  java_import "org.openhab.core.library.unit.#{type}"
+end
+
+Object.send(:remove_const, :QuantityType)
+java_import org.openhab.core.library.types.QuantityType
+
+module OpenHAB
+  module DSL
+    #
+    # Provides support for interacting with OpenHAB Units of Measurement
+    #
+    module Units
+      java_import 'tec.uom.se.format.SimpleUnitFormat'
+
+      #
+      # Sets a thread local variable to the supplied unit such that classes operating inside the block
+      # can perform automatic conversions to the supplied unit for NumberItems
+      #
+      # @param [Object] unit OpenHAB Unit or String representing unit
+      # @yield [] Block executed in context of the supplied unit
+      #
+      #
+      def unit(unit)
+        unit = SimpleUnitFormat.instance.unitFor(unit) if unit.is_a? String
+        Thread.current.thread_variable_set(:unit, unit)
+        yield
+      ensure
+        Thread.current.thread_variable_set(:unit, nil)
+      end
+    end
+  end
+end

data/lib/openhab/log/configuration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  # Supports Logging
+  module Log
+    # This module holds global configuration values
+    module Configuration
+      # -*- coding: utf-8 -*-
+      LOG_PREFIX = 'jsr223.jruby'
+
+      #
+      # Gets the log prefix
+      #
+      # @return [String] Prefix for all log entries
+      #
+      def self.log_prefix
+        LOG_PREFIX
+      end
+    end
+  end
+end

data/lib/openhab/log/logger.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require 'openhab/log/configuration'
+require 'java'
+require 'pp'
+
+module OpenHAB
+  #
+  # Provides access to the OpenHAB logging using a Ruby logging methods
+  #
+  module Log
+    #
+    # Ruby Logger that forwards messages at appropriate levels to OpenHAB Logger
+    #
+    class Logger
+      java_import org.slf4j.LoggerFactory
+
+      # @return [Array] Supported logging levels
+      LEVELS = %i[TRACE DEBUG WARN INFO ERROR].freeze
+
+      #
+      # Create a new logger
+      #
+      # @param [String] name of the logger
+      #
+      def initialize(name)
+        @sl4fj_logger = LoggerFactory.getLogger(name)
+      end
+
+      # Dynamically define the methods for each level as identified by the levels constant
+      # This creates a method for each level that looks like this
+      # def <level>(msg=nil, &block)
+      #   log(severity: <level>, msg: msg, &block)
+      # end
+      LEVELS.each do |level|
+        method = level.to_s.downcase
+        define_method(method.to_s) do |msg = nil, &block|
+          log(severity: level, msg: msg, &block)
+        end
+      end
+
+      private
+
+      #
+      # Log a message to the OpenHAB Logger
+      #
+      # @param [Symbol] severity Severity to log message at
+      # @param [Object] msg to log, if no msg supplied and a block is provided,
+      #   the msg is taken from the result of the block
+      #
+      def log(severity:, msg: nil)
+        severity = severity.to_sym
+
+        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")
+
+        # Process block if no message provided
+        msg = yield if msg.nil? && block_given?
+
+        msg = message_to_string(msg: msg)
+
+        # Dynamically invoke underlying logger, this expands to "<level>(message)"
+        @sl4fj_logger.send(severity.to_s.downcase, msg)
+      end
+
+      #
+      # Conver the supplied message object to a String
+      #
+      # @param [object] msg object to convert
+      #
+      # @return [String] Msg object as a string
+      #
+      def message_to_string(msg:)
+        case msg
+        when ::String
+          msg
+        when ::Exception
+          "#{msg.message} (#{msg.class})\n#{msg.backtrace&.join("\n")}"
+        else
+          msg.inspect
+        end
+      end
+    end
+
+    @loggers = {}
+
+    # Return a logger with the configured log prefix plus the calling scripts name
+
+    #
+    # Create a logger for the current class
+    #
+    # @return [Logger] for the current class
+    #
+    def logger
+      Log.logger(self.class.name)
+    end
+
+    class << self
+      #
+      # Injects a logger into the base class
+      #
+      # @param [String] name of the logger
+      #
+      # @return [Logger] for the supplied name
+      #
+      def logger(name)
+        name ||= self.class.name
+        @loggers[name] ||= Log.logger_for(name)
+      end
+
+      #
+      # Configure a logger for the supplied class name
+      #
+      # @param [String] classname to configure logger for
+      #
+      # @return [Logger] for the supplied classname
+      #
+      def logger_for(classname)
+        configure_logger_for(classname)
+      end
+
+     private
+
+      #
+      # Configure a logger for the supplied classname
+      #
+      # @param [String] classname to create logger for
+      #
+      # @return [Logger] Logger for the supplied classname
+      #
+      def configure_logger_for(classname)
+        log_prefix = Configuration.log_prefix
+        log_prefix += if classname
+                        ".#{classname}"
+                      else
+                        ".#{log_caller}"
+                      end
+        Logger.new(log_prefix)
+      end
+
+      #
+      # Figure out the log prefix
+      #
+      # @return [String] Prefix for log messages
+      #
+      def log_caller
+        caller_locations.map(&:path)
+                        .grep_v(%r{openhab/core/})
+                        .grep_v(/rubygems/)
+                        .grep_v(%r{lib/ruby})
+                        .first
+                        .yield_self { |caller| File.basename(caller, '.*') }
+      end
+   end
+
+    #
+    # Add logger method to the object that includes this module
+    #
+    # @param [Object] base Object to add method to
+    #
+    #
+    def self.included(base)
+      class << base
+        def logger
+          Log.logger(self.class.name)
+        end
+      end
+    end
+  end
+end

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.16.2
+  version: 2.19.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-11 00:00:00.000000000 Z
+date: 2021-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -32,62 +32,64 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/openhab.rb
-- lib/openhab/configuration.rb
-- lib/openhab/core/cron.rb
-- lib/openhab/core/debug.rb
-- lib/openhab/core/dsl.rb
-- lib/openhab/core/dsl/actions.rb
-- lib/openhab/core/dsl/entities.rb
-- lib/openhab/core/dsl/gems.rb
-- lib/openhab/core/dsl/group.rb
-- lib/openhab/core/dsl/items/items.rb
-- lib/openhab/core/dsl/items/number_item.rb
-- lib/openhab/core/dsl/items/string_item.rb
-- lib/openhab/core/dsl/monkey_patch/actions/actions.rb
-- lib/openhab/core/dsl/monkey_patch/actions/script_thing_actions.rb
-- lib/openhab/core/dsl/monkey_patch/events.rb
-- lib/openhab/core/dsl/monkey_patch/events/item_command.rb
-- lib/openhab/core/dsl/monkey_patch/events/item_state_changed.rb
-- lib/openhab/core/dsl/monkey_patch/events/thing_status_info.rb
-- lib/openhab/core/dsl/monkey_patch/items/contact_item.rb
-- lib/openhab/core/dsl/monkey_patch/items/dimmer_item.rb
-- lib/openhab/core/dsl/monkey_patch/items/group_item.rb
-- lib/openhab/core/dsl/monkey_patch/items/items.rb
-- lib/openhab/core/dsl/monkey_patch/items/metadata.rb
-- lib/openhab/core/dsl/monkey_patch/items/persistence.rb
-- lib/openhab/core/dsl/monkey_patch/items/switch_item.rb
-- lib/openhab/core/dsl/monkey_patch/ruby/number.rb
-- lib/openhab/core/dsl/monkey_patch/ruby/range.rb
-- lib/openhab/core/dsl/monkey_patch/ruby/ruby.rb
-- lib/openhab/core/dsl/monkey_patch/ruby/string.rb
-- lib/openhab/core/dsl/monkey_patch/types/decimal_type.rb
-- lib/openhab/core/dsl/monkey_patch/types/on_off_type.rb
-- lib/openhab/core/dsl/monkey_patch/types/open_closed_type.rb
-- lib/openhab/core/dsl/monkey_patch/types/percent_type.rb
-- lib/openhab/core/dsl/monkey_patch/types/quantity_type.rb
-- lib/openhab/core/dsl/monkey_patch/types/types.rb
-- lib/openhab/core/dsl/persistence.rb
-- lib/openhab/core/dsl/property.rb
-- lib/openhab/core/dsl/rule/automation_rule.rb
-- lib/openhab/core/dsl/rule/guard.rb
-- lib/openhab/core/dsl/rule/rule.rb
-- lib/openhab/core/dsl/rule/rule_config.rb
-- lib/openhab/core/dsl/rule/triggers/changed.rb
-- lib/openhab/core/dsl/rule/triggers/channel.rb
-- lib/openhab/core/dsl/rule/triggers/command.rb
-- lib/openhab/core/dsl/rule/triggers/cron.rb
-- lib/openhab/core/dsl/rule/triggers/trigger.rb
-- lib/openhab/core/dsl/rule/triggers/updated.rb
-- lib/openhab/core/dsl/states.rb
-- lib/openhab/core/dsl/things.rb
-- lib/openhab/core/dsl/time_of_day.rb
-- lib/openhab/core/dsl/timers.rb
-- lib/openhab/core/dsl/types/quantity.rb
-- lib/openhab/core/dsl/units.rb
-- lib/openhab/core/log.rb
-- lib/openhab/core/patch_load_path.rb
-- lib/openhab/core/startup_delay.rb
-- lib/openhab/osgi.rb
+- lib/openhab/core/entity_lookup.rb
+- lib/openhab/core/openhab_setup.rb
+- lib/openhab/core/osgi.rb
+- lib/openhab/dsl/actions.rb
+- lib/openhab/dsl/dsl.rb
+- lib/openhab/dsl/gems.rb
+- lib/openhab/dsl/group.rb
+- lib/openhab/dsl/items/datetime_item.rb
+- lib/openhab/dsl/items/items.rb
+- lib/openhab/dsl/items/number_item.rb
+- lib/openhab/dsl/items/rollershutter_item.rb
+- lib/openhab/dsl/items/string_item.rb
+- lib/openhab/dsl/monkey_patch/actions/actions.rb
+- lib/openhab/dsl/monkey_patch/actions/script_thing_actions.rb
+- lib/openhab/dsl/monkey_patch/events/events.rb
+- lib/openhab/dsl/monkey_patch/events/item_command.rb
+- lib/openhab/dsl/monkey_patch/events/item_state_changed.rb
+- 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
+- lib/openhab/dsl/monkey_patch/items/switch_item.rb
+- lib/openhab/dsl/monkey_patch/ruby/number.rb
+- lib/openhab/dsl/monkey_patch/ruby/range.rb
+- lib/openhab/dsl/monkey_patch/ruby/ruby.rb
+- lib/openhab/dsl/monkey_patch/ruby/string.rb
+- lib/openhab/dsl/monkey_patch/ruby/time.rb
+- lib/openhab/dsl/monkey_patch/types/decimal_type.rb
+- lib/openhab/dsl/monkey_patch/types/on_off_type.rb
+- lib/openhab/dsl/monkey_patch/types/open_closed_type.rb
+- lib/openhab/dsl/monkey_patch/types/percent_type.rb
+- lib/openhab/dsl/monkey_patch/types/quantity_type.rb
+- lib/openhab/dsl/monkey_patch/types/types.rb
+- lib/openhab/dsl/monkey_patch/types/up_down_type.rb
+- lib/openhab/dsl/persistence.rb
+- lib/openhab/dsl/rules/automation_rule.rb
+- lib/openhab/dsl/rules/guard.rb
+- lib/openhab/dsl/rules/property.rb
+- lib/openhab/dsl/rules/rule.rb
+- lib/openhab/dsl/rules/rule_config.rb
+- lib/openhab/dsl/rules/triggers/changed.rb
+- lib/openhab/dsl/rules/triggers/channel.rb
+- lib/openhab/dsl/rules/triggers/command.rb
+- lib/openhab/dsl/rules/triggers/cron.rb
+- lib/openhab/dsl/rules/triggers/trigger.rb
+- lib/openhab/dsl/rules/triggers/updated.rb
+- lib/openhab/dsl/states.rb
+- lib/openhab/dsl/things.rb
+- lib/openhab/dsl/time_of_day.rb
+- lib/openhab/dsl/timers.rb
+- lib/openhab/dsl/types/datetime.rb
+- lib/openhab/dsl/types/quantity.rb
+- lib/openhab/dsl/units.rb
+- lib/openhab/log/configuration.rb
+- lib/openhab/log/logger.rb
 - lib/openhab/version.rb
 homepage: https://boc-tothefuture.github.io/openhab-jruby/
 licenses: []

data/lib/openhab/configuration.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-# This module holds global configuration values
-module Configuration
-  # -*- coding: utf-8 -*-
-  LOG_PREFIX = 'jsr223.jruby'
-
-  #
-  # Gets the log prefix
-  #
-  # @return [String] Prefix for all log entries
-  #
-  def self.log_prefix
-    LOG_PREFIX
-  end
-end

data/lib/openhab/core/cron.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module OpenHAB
-  module Core
-    #
-    # Module for Cron related methods
-    #
-    module Cron
-      #
-      # Retruns a default map for cron expressions that fires every second
-      # This map is usually updated via merge by other methods to refine cron type triggers.
-      #
-      # @return [Map] Map with symbols for :seconds, :minute, :hour, :dom, :month, :dow configured to fire every second
-      #
-      def cron_expression_map
-        {
-          second: '*',
-          minute: '*',
-          hour: '*',
-          dom: '?',
-          month: '*',
-          dow: '?'
-        }
-      end
-    end
-  end
-end

data/lib/openhab/core/debug.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require 'pp'
-require 'core/log'
-require 'core/dsl/things'
-
-#
-# Module to support debugging information about the Ruby or OpenHAB environment
-#
-module Debug
-  include Logging
-  include OpenHAB::Core::DSL::Things
-
-  #
-  # Print the loadpath, instance and global variables
-  #
-  def debug_variables
-    pp "Instance #{instance_variables}"
-    pp "Global #{global_variables}"
-    pp "Load Path #{$LOAD_PATH}"
-    # pp "Constants #{Module.constants}"
-  end
-
-  #
-  # Print information about the OpenHAB instance
-  #
-  def debug_openhab
-    logger.debug { "Things - Count #{things.size}" }
-    things.each do |thing|
-      logger.debug { "Thing:(#{thing.label})  UID:(#{thing.uid}) Channels(#{thing.channels.map(&:uid).join(', ')})" }
-    end
-    # logger.debug { $things.getAll.join(", ") }
-  end
-end