openhab-scripting 3.2.0 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0be2b09569b3f3e96c5a79dbec4c6b0be6616a46d013831650c1e5d60cee374f
-  data.tar.gz: f71890c321e188f6322191e0c40099a6de22bc086d89085743b0c20f6b211649
+  metadata.gz: f309bd0e53d6ef4d8e738fb95507b79a3467e386b031a7e087c15502c20442cf
+  data.tar.gz: 0fbf71682ac4809b5d804f47ff3e847f8632d91a2749514c04abb6e7b5e02713
 SHA512:
-  metadata.gz: ff1e955329247a70b39158dff4a3694f51e2974fb11ce18260ff7048b686ac1181a99c7e941299def6f77697cacdaabf8f67e72d5c8bc0193f3b4334df761f94
-  data.tar.gz: db0fb2c35af26aaa963107b7971e83bfbfdd43c42d951cc470dec1192e8f743978ed91e04859953b5970e076516c275f7133784d12545a842e856181e76ef5af
+  metadata.gz: 7b323582ae4bb7e8e5d5501353f0021437fa53f4170e098f51d518f30103d6a4241474678f80d1330d1c6257de354e58633ad16ea3e5e928315a2235aba51389
+  data.tar.gz: 56ea9c5ec2b80d16c4f9ccdd08fbab04a45aee6460947de4df219c800e2120fa6f169290886984c25b942408ebc62c13913f03bd9a7e54aa52468e5b7e308c72

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

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 require 'base64'
+require 'pathname'
 require 'net/http'
 require 'java'
-require 'mimemagic'
+require 'marcel'
 require 'openhab/dsl/items/item_command'
 require 'openhab/dsl/items/item_delegate'
 
@@ -57,7 +58,7 @@ module OpenHAB
         #
         def update_from_file(file, mime_type: nil)
           file_data = IO.binread(file)
-          mime_type ||= (MimeMagic.by_path(file) || MimeMagic.by_magic(file_data))&.type
+          mime_type ||= Marcel::MimeType.for(Pathname.new(file)) || Marcel::MimeType.for(file_data)
           update_from_bytes(file_data, mime_type: mime_type)
         end
 
@@ -130,7 +131,7 @@ module OpenHAB
         #
         def detect_mime_from_bytes(bytes:)
           logger.trace('Detecting mime type from file image contents')
-          MimeMagic.by_magic(bytes)&.type
+          Marcel::MimeType.for(bytes)
         end
       end
     end

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

@@ -30,7 +30,7 @@ module OpenHAB
 
             def initialize(metadata: nil, key: nil, value: nil, config: nil)
               @metadata = metadata || Metadata.new(key || MetadataKey.new('', ''), value&.to_s, config)
-              super(@metadata&.configuration)
+              super(to_ruby(@metadata&.configuration))
             end
 
             #
@@ -85,6 +85,44 @@ module OpenHAB
             def to_a
               [@metadata&.value, @metadata&.configuration || {}]
             end
+
+            private
+
+            #
+            # Recursively convert the supplied Hash object into a Ruby Hash and recreate the keys and values
+            #
+            # @param [Hash] Hash to convert
+            #
+            # @return [Hash] The converted hash
+            #
+            def to_ruby_hash(hash)
+              return unless hash.respond_to? :each_with_object
+
+              hash.each_with_object({}) { |(key, value), ruby_hash| ruby_hash[to_ruby(key)] = to_ruby(value) }
+            end
+
+            #
+            # Recursively convert the supplied array to a Ruby array and recreate all String values
+            #
+            # @param [Object] array to convert
+            #
+            # @return [Array] The converted array
+            #
+            def to_ruby_array(array)
+              return unless array.respond_to? :each_with_object
+
+              array.each_with_object([]) { |value, ruby_array| ruby_array << to_ruby(value) }
+            end
+
+            # Convert the given object to Ruby equivalent
+            def to_ruby(value)
+              case value
+              when Hash, Java::JavaUtil::Map then to_ruby_hash(value)
+              when Array, Java::JavaUtil::List then to_ruby_array(value)
+              when String then String.new(value)
+              else value
+              end
+            end
           end
 
           #

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

@@ -9,6 +9,18 @@ module OpenHAB
         #
         module Persistence
           java_import Java::OrgOpenhabCoreTypesUtil::UnitUtils
+
+          # A wrapper for OpenHAB's HistoricItem that returns the state directly
+          class HistoricState < SimpleDelegator
+            attr_reader :timestamp, :state
+
+            def initialize(state, timestamp)
+              @state = state
+              @timestamp = timestamp
+              super(@state)
+            end
+          end
+
           # All persistence methods that could return a Quantity
           QUANTITY_METHODS = %i[average_since
                                 delta_since
@@ -45,13 +57,18 @@ module OpenHAB
           #
           def previous_state(service = nil, skip_equal: false)
             service ||= persistence_service
-            PersistenceExtensions.previous_state(self, skip_equal, service&.to_s)
+            result = PersistenceExtensions.previous_state(self, skip_equal, service&.to_s)
+            HistoricState.new(quantify(result.state), result.timestamp)
           end
 
           PERSISTENCE_METHODS.each do |method|
             define_method(method) do |timestamp, service = nil|
               service ||= persistence_service
               result = PersistenceExtensions.public_send(method, self, to_zdt(timestamp), service&.to_s)
+              if result.is_a? Java::OrgOpenhabCorePersistence::HistoricItem
+                return HistoricState.new(quantify(result.state), result.timestamp)
+              end
+
               QUANTITY_METHODS.include?(method) ? quantify(result) : result
             end
           end

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

@@ -30,11 +30,8 @@ module OpenHAB
             dow: '?'
           }
         end
-        # Rubocop check is disabled because YARD cannot process the method if placed in front of
-        #   the method definition
-        # rubocop:disable Style/AccessModifierDeclarations
+
         module_function :cron_expression_map
-        # rubocop:enable Style/AccessModifierDeclarations
 
         # @return [Hash] Map of days of the week from symbols to to OpenHAB cron strings
         DAY_OF_WEEK_MAP = {

data/lib/openhab/dsl/things.rb

@@ -11,6 +11,7 @@ module OpenHAB
     # Support for OpenHAB Things
     #
     module Things
+      java_import Java::OrgOpenhabCoreThing::ThingStatus
       include OpenHAB::Log
 
       #
@@ -25,6 +26,22 @@ module OpenHAB
           define_action_methods
         end
 
+        #
+        # Defines boolean thing status methods
+        #   uninitialized?
+        #   initializing?
+        #   unknown?
+        #   online?
+        #   offline?
+        #   removing?
+        #   removed?
+        #
+        # @return [Boolean] true if the thing status matches the name
+        #
+        ThingStatus.constants.each do |thingstatus|
+          define_method("#{thingstatus.to_s.downcase}?") { status == ThingStatus.value_of(thingstatus) }
+        end
+
         private
 
         java_import 'org.openhab.core.automation.annotation.RuleAction'

data/lib/openhab/log/logger.rb

@@ -22,9 +22,21 @@ module OpenHAB
       #
       # Regex for matching internal calls in a stack trace
       #
-      INTERNAL_CALL_REGEX = %r{(openhab-scripting-.*/lib)|(org/jruby/)}.freeze
+      INTERNAL_CALL_REGEX = %r{(openhab-scripting-.*/lib)|org[./]jruby}.freeze
       private_constant :INTERNAL_CALL_REGEX
 
+      #
+      # Regex for matching internal calls in a java stack trace
+      #
+      EXCLUDED_JAVA_PACKAGES = /jdk\.internal\.reflect|java\.lang\.reflect|org\.openhab|java\.lang\.Thread\.run/.freeze
+      private_constant :EXCLUDED_JAVA_PACKAGES
+
+      #
+      # Regex for matching internal calls in a java stack trace
+      #
+      JAVA_INTERNAL_CALL_REGEX = Regexp.union(INTERNAL_CALL_REGEX, EXCLUDED_JAVA_PACKAGES).freeze
+      private_constant :JAVA_INTERNAL_CALL_REGEX
+
       #
       # Create a new logger
       #
@@ -60,8 +72,13 @@ module OpenHAB
       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))
+        if error.respond_to? :backtrace_locations
+          backtrace = error.backtrace_locations.map(&:to_s).reject { |line| INTERNAL_CALL_REGEX.match? line }
+          error.set_backtrace(backtrace)
+        elsif error.respond_to? :stack_trace
+          backtrace = error.stack_trace.reject { |line| JAVA_INTERNAL_CALL_REGEX.match? line.to_s }
+          error.set_stack_trace(backtrace)
+        end
         error
       end
 

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.4.2
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: mimemagic
+  name: marcel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
 description: JRuby Helper Libraries for OpenHAB Scripting
 email:
 - broconne@gmail.com