openhab-jrubyscripting 5.0.0.rc4 → 5.0.0.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e06b71ae524165363db99771e7ef601f542ed14c979572d152b079d70ad82a2
-  data.tar.gz: 0d6002391ed26a68bbb907d94787f510df30ef6ef9a3a7cd445ac9c47122851b
+  metadata.gz: d5963df56b31bb66f4d4cf5afa5927719d61740df847c5d5ff0965a188a73c62
+  data.tar.gz: 0011f05f77383e9618844437bc63b55d02e62ed9a402d775a76dbc75d20a8334
 SHA512:
-  metadata.gz: 05a3016219eaf41fc4af71f1476029e2b8d0b320afc7bed99e9777b7726afc6897328d9aa92f643132e66d647aae8742eca36f26c703ab3763e1738c55d249e1
-  data.tar.gz: d5a7d65543b3628e5c3abfa61cb2aa6d6f10e2ab2bb3334d9f38e1ee8952da655da6360c156d926bd53b25c013c86c7672dc1b492c85aaa056e898579a7be7dd
+  metadata.gz: ffdb129b03aac2d44365aa42a7f02889f5d8a20f662391b874cb795547b646d6d4f02d014284a73143862ca25f931f42429be012a25b645d02b1e713a02c073b
+  data.tar.gz: ca9804074c3092c6bcff87ed17bffe4543ef95b3ef0c230d4767811a266d368210658f36968d4d42b6ed2f320a8935ab28363a318a6bd0d2a7d393afab67a29a

data/lib/openhab/core/actions.rb

@@ -66,10 +66,22 @@ module OpenHAB
     #
     module Actions
       OSGi.services("org.openhab.core.model.script.engine.action.ActionService")&.each do |service|
-        klass = (java_import service.action_class.ruby_class).first
-        logger.trace("Loaded ACTION: #{service.action_class}")
-        Object.const_set(service.action_class.simple_name, klass)
+        action_class = service.action_class
+        module_name = action_class.simple_name
+        action = if action_class.interface?
+                   impl = OSGi.service(action_class)
+                   unless impl
+                     logger.error("Unable to find an implementation object for action service #{action_class}.")
+                     next
+                   end
+                   const_set(module_name, impl)
+                 else
+                   (java_import action_class.ruby_class).first
+                 end
+        logger.trace("Loaded ACTION: #{action_class}")
+        Object.const_set(module_name, action)
       end
+
       # Import common actions
       %w[Exec HTTP Ping].each do |action|
         klass = (java_import "org.openhab.core.model.script.actions.#{action}").first

data/lib/openhab/core/items/metadata/namespace_hash.rb

@@ -288,7 +288,7 @@ module OpenHAB
 
           # @!visibility private
           def hash
-            "metadata_namespace_hash".hash + @item_name.hash
+            ["metadata_namespace_hash", @item_name.hash]
           end
 
           # @!visibility private

data/lib/openhab/core/items/persistence.rb

@@ -40,16 +40,26 @@ module OpenHAB
       module Persistence
         GenericItem.prepend(self)
 
-        # A state class with an added timestamp attribute. This is used to hold OpenHAB's HistoricItem.
+        #
+        # A state class with an added timestamp attribute.
+        #
+        # This wraps {org.openhab.core.persistence.HistoricItem HistoricItem}
+        # to allow implicitly treating the object as its state, and wrapping of
+        # that state into a {QuantityType} as necessary.
+        #
         class HistoricState < SimpleDelegator
-          attr_reader :timestamp
-
           alias_method :state, :__getobj__
 
-          def initialize(state, timestamp)
-            @timestamp = timestamp
+          def initialize(state, historic_item)
+            @historic_item = historic_item
             super(state)
           end
+
+          # @!attribute [r] timestamp
+          # @return [ZonedDateTime]
+          def timestamp
+            @historic_item.timestamp
+          end
         end
 
         # All persistence methods that could return a QuantityType
@@ -245,7 +255,7 @@ module OpenHAB
         def previous_state(service = nil, skip_equal: false)
           service ||= persistence_service
           result = Actions::PersistenceExtensions.previous_state(self, skip_equal, service&.to_s)
-          HistoricState.new(quantify(result.state), result.timestamp)
+          HistoricState.new(quantify(result.state), result)
         end
 
         PERSISTENCE_METHODS.each do |method|
@@ -308,7 +318,7 @@ module OpenHAB
         def wrap_result(result, method)
           if result.is_a?(org.openhab.core.persistence.HistoricItem)
             return HistoricState.new(quantify(result.state),
-                                     result.timestamp)
+                                     result)
           end
           return quantify(result) if QUANTITY_METHODS.include?(method)
 

data/lib/openhab/core/items.rb

@@ -100,7 +100,7 @@ module OpenHAB
       constants.map { |c| const_get(c) }
                .grep(Module)
                .select { |k| k <= GenericItem && k != GroupItem && k != StringItem }
-               .sort { |a, b| a < b ? 1 : -1 }
+               .sort { |a, b| (a < b) ? 1 : -1 }
                .each do |klass|
         klass.field_reader :ACCEPTED_COMMAND_TYPES, :ACCEPTED_DATA_TYPES unless klass == GenericItem
 

data/lib/openhab/core/things/profile_callback.rb

@@ -19,7 +19,7 @@ module OpenHAB
           def def_state_parsing_method(method, param_name)
             class_eval <<~RUBY, __FILE__, __LINE__ + 1
               def #{method}(type)                                                             # def handle_command(type)
-                type = link.item.format_#{param_name == :state ? :update : param_name}(type)  #   type = link.item.format_command(type)
+                type = link.item.format_#{(param_name == :state) ? :update : param_name}(type)  #   type = link.item.format_command(type)
                 super(type)                                                                   #   super(type)
               end                                                                             # end
             RUBY

data/lib/openhab/core/timer.rb

@@ -8,8 +8,6 @@ module OpenHAB
     # Timer allows you to administer the block of code that
     # has been scheduled to run later with {OpenHAB::DSL.after after}.
     #
-    # @!attribute [r] execution_time
-    #   @return [ZonedDateTime] the scheduled execution time, or null if the timer was cancelled
     class Timer
       extend Forwardable
 
@@ -30,7 +28,7 @@ module OpenHAB
       #   @return [true,false]
 
       def_delegator :@timer, :has_terminated, :terminated?
-      def_delegators :@timer, :execution_time, :active?, :cancelled?, :running?
+      def_delegators :@timer, :active?, :cancelled?, :running?
 
       # @return [Object, nil]
       attr_accessor :id
@@ -51,13 +49,19 @@ module OpenHAB
         @id = id
         @thread_locals = thread_locals
         @block = block
-        @timer = org.openhab.core.model.script.actions.ScriptExecution.create_timer(
-          # create it far enough in the future so it won't execute until we finish setting it up
-          1.minute.from_now,
-          # when running in rspec, it may have troubles finding this class
-          # for auto-conversion of block to interface, so use .impl
-          org.eclipse.xtext.xbase.lib.Procedures::Procedure0.impl { execute }
-        )
+        @timer = if defined?(ScriptExecution)
+                   ScriptExecution.create_timer(1.minute.from_now) { execute }
+                 else # DEPRECATED: openHAB 3.4.0
+                   org.openhab.core.model.script.actions.ScriptExecution.create_timer(
+                     # create it far enough in the future so it won't execute until we finish setting it up
+                     1.minute.from_now,
+                     # when running in rspec, it may have troubles finding this class
+                     # for auto-conversion of block to interface, so use .impl
+                     org.eclipse.xtext.xbase.lib.Procedures::Procedure0.impl { execute }
+                   )
+                 end
+        # DEPRECATED: openHAB 3.4.0.M6
+        @timer.class.field_reader :future unless @timer.respond_to?(:future)
         reschedule(@time)
       end
 
@@ -74,6 +78,13 @@ module OpenHAB
       end
       alias_method :to_s, :inspect
 
+      # @!attribute [r] execution_time
+      # @return [ZonedDateTime, nil] the scheduled execution time, or `nil` if the timer was cancelled
+      def execution_time
+        # DEPRECATED: openHAB 3.4.0.M6 (just remove the entire method)
+        @timer.future.scheduled_time
+      end
+
       #
       # Reschedule timer
       #

data/lib/openhab/core/types/point_type.rb

@@ -21,7 +21,7 @@ module OpenHAB
               if value.is_a?(DecimalType) || value.is_a?(StringType)
                 value
               elsif value.is_a?(QuantityType)
-                unit = index == 2 ? DSL.unit(SIUnits::METRE.dimension) || SIUnits::METRE : Units::DEGREE_ANGLE
+                unit = (index == 2) ? DSL.unit(SIUnits::METRE.dimension) || SIUnits::METRE : Units::DEGREE_ANGLE
                 DecimalType.new(value.to_unit(unit).to_big_decimal)
               elsif value.respond_to?(:to_str)
                 StringType.new(value.to_str)

data/lib/openhab/core_ext/between.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module CoreExt
+    # Extensions that apply to both Date and Time classes
+    module Between
+      #
+      # Checks whether the the object falls between the given range.
+      #
+      # @overload between?(min, max)
+      #   @param [Object] min The minimum value to check, inclusive
+      #   @param [Object] max The maximum value to check, inclusive
+      #   @return [true,false]
+      #
+      # @overload between?(range)
+      #   @param [Range] range A range to check
+      #   @return [true,false]
+      #
+      def between?(min, max = nil)
+        range = if max
+                  Range.new(min, max, false)
+                else
+                  raise ArgumentError, "Expecting a range when given a single argument" unless min.is_a?(Range)
+
+                  min
+                end
+
+        OpenHAB::DSL.between(range).cover?(self)
+      end
+    end
+  end
+end

data/lib/openhab/core_ext/java/duration.rb

@@ -7,6 +7,7 @@ module OpenHAB
 
       # Extensions to Duration
       class Duration
+        include Between
         # @!parse include TemporalAmount
 
         alias_method :to_i, :seconds

data/lib/openhab/core_ext/java/local_date.rb

@@ -10,6 +10,7 @@ module OpenHAB
       # Extensions to LocalDate
       class LocalDate
         include Time
+        include Between
 
         class << self # rubocop:disable Lint/EmptyClass
           # @!attribute [r] now

data/lib/openhab/core_ext/java/local_time.rb

@@ -33,6 +33,7 @@ module OpenHAB
       #   end
       #
       class LocalTime
+        include Between
         # @!parse include Time
 
         # @!visibility private

data/lib/openhab/core_ext/java/month.rb

@@ -9,8 +9,19 @@ module OpenHAB
 
       # Extensions to Month
       class Month
+        include Between
         # @!parse include Time
 
+        # @return [Month]
+        def +(other)
+          plus(other)
+        end
+
+        # @return [Month]
+        def -(other)
+          minus(other)
+        end
+
         #
         # Returns the next month
         #
@@ -49,7 +60,7 @@ module OpenHAB
         #   during conversion. {ZonedDateTime.now} is assumed if not given.
         # @return [ZonedDateTime]
         def to_zoned_date_time(context = nil)
-          to_local_date(context).to_zoned_date_time
+          to_local_date(context).to_zoned_date_time(context)
         end
       end
     end

data/lib/openhab/core_ext/java/month_day.rb

@@ -9,6 +9,8 @@ module OpenHAB
 
       # Extensions to MonthDay
       class MonthDay
+        include Between
+
         class << self
           #
           # Parses strings in the form "M-d"

data/lib/openhab/core_ext/java/zoned_date_time.rb

@@ -10,6 +10,7 @@ module OpenHAB
       # Extensions to ZonedDateTime
       class ZonedDateTime
         include Time
+        include Between
 
         class << self # rubocop:disable Lint/EmptyClass
           # @!attribute [r] now
@@ -91,11 +92,10 @@ module OpenHAB
           # compare instants, otherwise it will differ by timezone, which we don't want
           # (use eql? if you care about that)
           if other.respond_to?(:to_zoned_date_time)
-            return to_instant.compare_to(other.to_zoned_date_time(self).to_instant)
+            to_instant.compare_to(other.to_zoned_date_time(self).to_instant)
+          elsif other.respond_to?(:coerce) && (lhs, rhs = other.coerce(self))
+            lhs <=> rhs
           end
-          return nil unless (lhs, rhs = other.coerce(self))
-
-          lhs <=> rhs
         end
 
         #

data/lib/openhab/core_ext/ruby/date.rb

@@ -4,6 +4,8 @@ require "date"
 
 # Extensions to Date
 class Date
+  include OpenHAB::CoreExt::Between
+
   #
   # Extends {#+} to allow adding a {java.time.temporal.TemporalAmount TemporalAmount}
   #
@@ -65,7 +67,7 @@ class Date
 
     return self <=> other.to_date(self) if other.is_a?(java.time.MonthDay)
 
-    if other.respond_to?(:coerce) && (lhs, rhs = coerce(self))
+    if other.respond_to?(:coerce) && (lhs, rhs = other.coerce(self))
       return lhs <=> rhs
     end
 

data/lib/openhab/core_ext/ruby/date_time.rb

@@ -10,6 +10,7 @@ require "forwardable"
 # Extensions to DateTime
 class DateTime < Date
   extend Forwardable
+  include OpenHAB::CoreExt::Between
 
   # (see Time#plus_with_temporal)
   def plus_with_temporal(other)

data/lib/openhab/core_ext/ruby/time.rb

@@ -5,6 +5,7 @@ require "forwardable"
 # Extensions to Time
 class Time
   extend Forwardable
+  include OpenHAB::CoreExt::Between
 
   #
   # @!method +(other)

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

@@ -211,7 +211,7 @@ module OpenHAB
           def execute(_mod = nil, inputs = nil)
             ThreadLocal.thread_local(**@thread_locals) do
               @timed_command_details.mutex.synchronize do
-                logger.trace "Canceling implicit timer #{@timed_command_details.timer} for "\
+                logger.trace "Canceling implicit timer #{@timed_command_details.timer} for " \
                              "#{@timed_command_details.item.name}  because received event #{inputs}"
                 @timed_command_details.timer.cancel
                 DSL.rules.remove(@timed_command_details.rule_uid)

data/lib/openhab/dsl/rules/automation_rule.rb

@@ -170,7 +170,7 @@ module OpenHAB
             now = Time.now
             return true if @between.cover? now
 
-            logger.trace("Skipped execution of rule '#{name}' because the current time #{now} "\
+            logger.trace("Skipped execution of rule '#{name}' because the current time #{now} " \
                          "is not between #{@between.begin} and #{@between.end}")
           else
             logger.trace("Skipped execution of rule '#{name}' because of guard #{@guard}")

data/lib/openhab/dsl/rules/name_inference.rb

@@ -110,7 +110,7 @@ module OpenHAB
 
           # formulate a readable rule name from a channel link trigger
           def infer_rule_name_from_channel_link_trigger(trigger)
-            trigger == :channel_linked ? "Channel linked to item" : "Channel unlinked from item"
+            (trigger == :channel_linked) ? "Channel linked to item" : "Channel unlinked from item"
           end
 
           # formulate a readable rule name from a thing added/updated/remove trigger

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

@@ -60,7 +60,7 @@ module OpenHAB
           #
           def wait_trigger(item:, duration:, to: nil, from: nil, attach: nil)
             item_name = item.respond_to?(:name) ? item.name : item.to_s
-            logger.trace("Creating Changed Wait Change Trigger for Item(#{item_name}) Duration(#{duration}) "\
+            logger.trace("Creating Changed Wait Change Trigger for Item(#{item_name}) Duration(#{duration}) " \
                          "To(#{to}) From(#{from}) Attach(#{attach})")
             conditions = Conditions::Duration.new(to: to, from: from, duration: duration)
             changed_trigger(item: item, to: nil, from: nil, attach: attach, conditions: conditions)

data/lib/openhab/dsl/rules/triggers/conditions/duration.rb

@@ -24,7 +24,7 @@ module OpenHAB
               @conditions = Conditions::Proc.new(to: to, from: from)
               @duration = duration
               @timer = nil
-              logger.trace "Created Duration Condition To(#{to}) From(#{from}) "\
+              logger.trace "Created Duration Condition To(#{to}) From(#{from}) " \
                            "Conditions(#{@conditions}) Duration(#{@duration})"
             end
 

data/lib/openhab/dsl/version.rb

@@ -4,6 +4,6 @@ module OpenHAB
   module DSL
     # Version of OpenHAB helper libraries
     # @return [String]
-    VERSION = "5.0.0.rc4"
+    VERSION = "5.0.0.rc5"
   end
 end

data/lib/openhab/dsl.rb

@@ -299,6 +299,8 @@ module OpenHAB
     # @example Create a time range
     #   between('7am'..'12pm').cover?(LocalTime.now)
     #
+    # @see CoreExt::Between#between? #between?
+    #
     def between(range)
       raise ArgumentError, "Supplied object must be a range" unless range.is_a?(Range)
 

data/lib/openhab/rspec/helpers.rb

@@ -124,7 +124,7 @@ module OpenHAB
       #
       def time_travel_and_execute_timers(duration)
         if self.class.mock_timers?
-          Timecop.travel(duration)
+          Timecop.frozen? ? Timecop.freeze(duration) : Timecop.travel(duration)
           execute_timers
         else
           sleep duration

data/lib/openhab/rspec/karaf.rb

@@ -351,8 +351,7 @@ module OpenHAB
       }.freeze
       private_constant :BLOCKED_COMPONENTS
 
-      START_LEVEL_OVERRIDES = {
-      }.freeze
+      START_LEVEL_OVERRIDES = {}.freeze
       private_constant :START_LEVEL_OVERRIDES
 
       def set_up_bundle_listener

data/lib/openhab/rspec/mocks/persistence_service.rb

@@ -19,6 +19,21 @@ module OpenHAB
           end
         end
 
+        module HistoricState
+          def timestamp
+            # PersistenceExtensions uses an anonymous class to wrap the current
+            # state if that happens to be an answer. Except it calls
+            # ZonedDateTime.now in Java land, bypassing Timecop.
+            # Detect that and make the call in Ruby
+            #
+            jc = @historic_item.class.java_class
+            return ZonedDateTime.now if jc.anonymous? && jc.enclosing_class == PersistenceExtensions.java_class
+
+            super
+          end
+        end
+        Core::Items::Persistence::HistoricState.prepend(HistoricState)
+
         attr_reader :id
 
         def initialize

data/lib/openhab/rspec/mocks/thing_handler.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# rubocop:disable Naming have to follow java interface names
+# rubocop:disable Naming/MethodName, Naming/AccessorMethodName
 
 require "singleton"
 
@@ -73,4 +73,4 @@ module OpenHAB
     end
   end
 end
-# rubocop:enable Naming
+# rubocop:enable Naming/MethodName, Naming/AccessorMethodName

data/lib/openhab/yard/html_helper.rb

@@ -16,8 +16,8 @@ module OpenHAB
 
       # have to completely replace this method. only change is the regex splitting
       # into parts now allows `.` as part of the identifier
-      # rubocop:disable Style
-      def format_types(typelist, brackets = true)
+      # rubocop:disable Style/NestedTernaryOperator, Style/StringConcatenation, Style/TernaryParentheses
+      def format_types(typelist, brackets = true) # rubocop:disable Style/OptionalBooleanParameter
         return unless typelist.is_a?(Array)
 
         list = typelist.map do |type|
@@ -27,7 +27,7 @@ module OpenHAB
         end
         list.empty? ? "" : (brackets ? "(#{list.join(", ")})" : list.join(", "))
       end
-      # rubocop:enable Style
+      # rubocop:enable Style/NestedTernaryOperator, Style/StringConcatenation, Style/TernaryParentheses
 
       def link_object(obj, title = nil, *)
         ::YARD::Handlers::JRuby::Base.infer_java_class(obj) if obj.is_a?(String)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-jrubyscripting
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc4
+  version: 5.0.0.rc5
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-28 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: cuke_linter
   requirement: !ruby/object:Gem::Requirement
@@ -198,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -409,6 +409,7 @@ files:
 - lib/openhab/core/types/up_down_type.rb
 - lib/openhab/core/uid.rb
 - lib/openhab/core_ext.rb
+- lib/openhab/core_ext/between.rb
 - lib/openhab/core_ext/java/class.rb
 - lib/openhab/core_ext/java/duration.rb
 - lib/openhab/core_ext/java/list.rb