openhab-scripting 3.1.2 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4238eb3161f714b74aed518a4a3e6d02f2aeed634fc21d7276df152f8aeead8
-  data.tar.gz: 57666ad4b06970ea2859ab252a19b5801c34657025e11becb766ad2876157a1b
+  metadata.gz: 3dc9b053a3ac139909642f0e790a231dbd4e0b370a94836b740af22283f60315
+  data.tar.gz: 9debccaf47bdf3d8b4c80e05d861d3e43f658f22ad569a9f60acf7a214bc0f37
 SHA512:
-  metadata.gz: 4617faef054fc5f6e388314ff2ab46c1a80ad525fb576fb1d2d2a89bde37f5f420a3ca77000da6bf62546f8b3ab2ba77d24ab271c9ea2c232c02d547677ad61f
-  data.tar.gz: bf889c204885dc28b6416138d8cba0d116e8d3c408bfd2720b481f47820ea51bb5e067c1492df352db13e2e0267b4f647b48ed3d68591a5a8d444972640d6270
+  metadata.gz: f04e70a4126f41f204b803617e757d66fe8e03f50543cc0a7a5c6c046b3567178f32d6cc6b97fbd9f0b0ca8b90c8c1fceb75b855bfe5565d4b8b7c8732e2efb8
+  data.tar.gz: 5b2092565032d2431b488250d6dc442178ecab80642f86495f56f2f199f5b05cae2f48a78b53dea118043f96c174811a0705af5596b26c9b784d315cd0bb720d

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

@@ -5,6 +5,7 @@ require 'java'
 require 'time'
 require 'openhab/dsl/types/datetime'
 require 'openhab/dsl/items/item_delegate'
+require 'openhab/dsl/items/item_command'
 
 module OpenHAB
   module DSL

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/contact_item.rb

@@ -36,6 +36,8 @@ module OpenHAB
           #   result from super if not supplied an OpenClosedType
           #
           def ==(other)
+            other = other.get_state_as(OpenClosedType) if other.respond_to?(:get_state_as)
+
             if other.is_a? OpenClosedType
               state? && state == other
             else

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/monkey_patch/items/switch_item.rb

@@ -56,6 +56,8 @@ module OpenHAB
           #   otherwise result from super
           #
           def ==(other)
+            other = other.get_state_as(OnOffType) if other.respond_to?(:get_state_as)
+
             if other.is_a? OnOffType
               state? && state == other
             else

data/lib/openhab/dsl/monkey_patch/ruby/string.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'openhab/dsl/types/quantity'
+require 'openhab/dsl/types/datetime'
+require 'openhab/dsl/items/datetime_item'
 
 module OpenHAB
   module DSL
@@ -21,7 +23,8 @@ module OpenHAB
           #
           def ==(other)
             case other
-            when OpenHAB::DSL::Types::Quantity, QuantityType, Java::OrgOpenhabCoreLibraryTypes::StringType
+            when OpenHAB::DSL::Types::Quantity, QuantityType, Java::OrgOpenhabCoreLibraryTypes::StringType,
+              OpenHAB::DSL::Types::DateTime, OpenHAB::DSL::Items::DateTimeItem
               other == self
             else
               super

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

@@ -44,6 +44,21 @@ module OpenHAB
             end
             # rubocop:enable Style/CaseLikeIf
           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?(:get_state_as)
+              self == other.get_state_as(OnOffType)
+            else
+              super
+            end
+          end
         end
       end
     end

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

@@ -33,6 +33,21 @@ module OpenHAB
               super
             end
           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?(:get_state_as)
+              self == other.get_state_as(OpenClosedType)
+            else
+              super
+            end
+          end
         end
       end
     end

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

@@ -30,6 +30,21 @@ module OpenHAB
               super
             end
           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?(:get_state_as)
+              self == other.get_state_as(UpDownType)
+            else
+              super
+            end
+          end
         end
       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/dsl/types/datetime.rb

@@ -75,13 +75,13 @@ module OpenHAB
         # @return [Integer] -1, 0 or 1 depending on the outcome
         #
         def <=>(other)
+          if other.respond_to?(:zoned_date_time)
+            return zoned_date_time.to_instant.compare_to(other.zoned_date_time.to_instant)
+          end
+
           case other
-          when DateTime, DateTimeType, DateTimeItem
-            zoned_date_time.to_instant.compare_to(other.zoned_date_time.to_instant)
-          when TimeOfDay::TimeOfDay, TimeOfDay::TimeOfDayRangeElement
-            to_tod <=> other
-          when String
-            self <=> DateTime.parse(DATE_ONLY_REGEX =~ other ? "#{other}'T'00:00:00#{zone}" : other)
+          when TimeOfDay::TimeOfDay, TimeOfDay::TimeOfDayRangeElement then to_tod <=> other
+          when String then self <=> DateTime.parse(DATE_ONLY_REGEX =~ other ? "#{other}'T'00:00:00#{zone}" : other)
           else
             self <=> DateTime.from(other)
           end

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.1.2'
+  VERSION = '3.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.4.1
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-09 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