openhab-scripting 5.6.0 → 5.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c8baeb1d9f83c584fd3affe173ceecd5d00fedb8547701c134cc7f1e7e8b924
-  data.tar.gz: b202b62cba639b270e60a73c405b6de5ede001a8bd6ee4fa065363156497b396
+  metadata.gz: 9d58174285c7861dfffd3bdb108f6d9c01af149a4f53aab9b9dd331be7f0f022
+  data.tar.gz: 6bdb6e115927aea3396ca05be97ecb1ee9d8afc9bc493689c32f7fcd19a7e71a
 SHA512:
-  metadata.gz: 06a58a345353b826ca398943d50295dd54a137b42d6fb803058507f6df19e673a27cacdfdaf7f7fa445d881468122535178e0a0f4f00eaa831ebe78bb4b060de
-  data.tar.gz: 5572ccf8e1e094d7b1eec9415e8d39b1f18b468e99d661b25f4064b1fde0d34a89d85163c4ce77b7f97b32f1532249d66cff310377e0850de0a1388f1e7f44a3
+  metadata.gz: 454fb750a412b8e153ce7df0320738b1f9729e1313d6d8e9aaaaa7c720c8c0cda7f704a35d78952705e7f21718551daae2c01e0dcf0b7e26c1fbfa2481d5ab6b
+  data.tar.gz: 0a1e62ecb2bcce48a207bed5899bd0e7913492836a5c953a4b22756fa149b353ee8db229e3b5b71f48d503db1d7bfaa4f8baa94abe92469047b386ab3d438da6

data/lib/openhab/core/actions/audio.rb

@@ -23,8 +23,11 @@ module OpenHAB
           #
           def play_sound(filename, sink: nil, volume: nil)
             volume = PercentType.new(volume) unless volume.is_a?(PercentType) || volume.nil?
-            java_send :playSound, [java.lang.String, java.lang.String, PercentType.java_class],
-                      sink, filename.to_s, volume
+            java_send :playSound,
+                      [java.lang.String, java.lang.String, PercentType.java_class],
+                      sink,
+                      filename.to_s,
+                      volume
           end
 
           #

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

@@ -308,7 +308,7 @@ module OpenHAB
                 raise ArgumentError, "Additional options can only be specified when creating one tag"
               end
 
-              synonyms = Array.wrap(synonyms).map(&:to_s).map(&:strip)
+              synonyms = Array.wrap(synonyms).map { |s| s.to_s.strip }
 
               tags.map do |name, parent|
                 # @deprecated OH4.0.0.M4 missing registry
@@ -317,7 +317,9 @@ module OpenHAB
                   next if lookup(name)
                   next unless parent
 
-                  new_tag = org.openhab.core.semantics.SemanticTagImpl.new("#{parent.uid}_#{name}", label, description,
+                  new_tag = org.openhab.core.semantics.SemanticTagImpl.new("#{parent.uid}_#{name}",
+                                                                           label,
+                                                                           description,
                                                                            synonyms)
                   Provider.instance.add(new_tag)
                   lookup(name)

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

@@ -13,7 +13,8 @@ module OpenHAB
         def_delegators :__getobj__, :class, :is_a?, :kind_of?
 
         # @!visibility private
-        EVENTS = [Events::ThingAddedEvent::TYPE, Events::ThingUpdatedEvent::TYPE,
+        EVENTS = [Events::ThingAddedEvent::TYPE,
+                  Events::ThingUpdatedEvent::TYPE,
                   Events::ThingRemovedEvent::TYPE].freeze
         # @!visibility private
         UID_METHOD = :uid

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

@@ -144,7 +144,8 @@ module OpenHAB
         def coerce(other)
           logger.trace("Coercing #{self} as a request from #{other.class}")
           return [other, zoned_date_time] if other.respond_to?(:to_zoned_date_time)
-          return [DateTimeType.new(other), self] if other.respond_to?(:to_time)
+
+          [DateTimeType.new(other), self] if other.respond_to?(:to_time)
         end
 
         #

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

@@ -28,7 +28,8 @@ module OpenHAB
         # @return [OpenClosedType] {OPEN} if {closed?}, {CLOSED} if {open?}
         def !
           return CLOSED if open?
-          return OPEN if closed?
+
+          OPEN if closed?
         end
       end
     end

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

@@ -63,7 +63,7 @@ module OpenHAB
         #
         def coerce(other)
           logger.trace("Coercing #{self} as a request from #{other.class}")
-          return [other.to_str, self] if other.respond_to?(:to_str)
+          [other.to_str, self] if other.respond_to?(:to_str)
         end
 
         # any method that exists on String gets forwarded to to_s

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

@@ -37,7 +37,8 @@ module OpenHAB
         #
         def !
           return UP if down?
-          return DOWN if up?
+
+          DOWN if up?
         end
       end
     end

data/lib/openhab/core/value_cache.rb

@@ -107,10 +107,11 @@ module OpenHAB
 
       # @see https://docs.ruby-lang.org/en/master/Hash.html#method-i-assoc Hash#assoc
       def assoc(key)
-        [key, fetch(key) do
-          # return nil directly, without storing a value to the cache
-          return nil
-        end]
+        [key,
+         fetch(key) do
+           # return nil directly, without storing a value to the cache
+           return nil
+         end]
       end
 
       # @see https://docs.ruby-lang.org/en/master/Hash.html#method-i-dig Hash#dig

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

@@ -64,7 +64,8 @@ module OpenHAB
         #
         def coerce(other)
           return [other.seconds, self] if other.is_a?(Numeric)
-          return [other.to_i.seconds, self] if other.is_a?(Period)
+
+          [other.to_i.seconds, self] if other.is_a?(Period)
         end
 
         {

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

@@ -56,12 +56,14 @@ module OpenHAB
             return raw_parse(string, formatter) if formatter
 
             format = /(am|pm)$/i.match?(string) ? "h[:mm[:ss][.S]][ ]a" : "H[:mm[:ss][.S]]"
-            java_send(:parse, [java.lang.CharSequence, java.time.format.DateTimeFormatter],
-                      string, java.time.format.DateTimeFormatterBuilder.new
-                              .parse_case_insensitive
-                              .parse_lenient
-                              .append_pattern(format)
-                              .to_formatter(java.util.Locale::ENGLISH))
+            java_send(:parse,
+                      [java.lang.CharSequence, java.time.format.DateTimeFormatter],
+                      string,
+                      java.time.format.DateTimeFormatterBuilder.new
+                                                               .parse_case_insensitive
+                                                               .parse_lenient
+                                                               .append_pattern(format)
+                                                               .to_formatter(java.util.Locale::ENGLISH))
           end
         end
 

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

@@ -21,7 +21,8 @@ module OpenHAB
           #
           def parse(string)
             logger.trace("#{self.class}.parse #{string} (#{string.class})")
-            java_send(:parse, [java.lang.CharSequence, java.time.format.DateTimeFormatter],
+            java_send(:parse,
+                      [java.lang.CharSequence, java.time.format.DateTimeFormatter],
                       string.to_s,
                       java.time.format.DateTimeFormatter.ofPattern("[--]M-d"))
           end

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

@@ -47,7 +47,7 @@ module OpenHAB
         # @return [Array, nil]
         #
         def coerce(other)
-          return [other.seconds, to_i.seconds] if other.is_a?(Numeric)
+          [other.seconds, to_i.seconds] if other.is_a?(Numeric)
         end
 
         {

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

@@ -190,6 +190,7 @@ module OpenHAB
       # Integer already has #|, so we have to prepend it here
       ::Integer.prepend(QuantityTypeConversion)
       ::Numeric.include(Numeric)
+      java.math.BigDecimal.include(QuantityTypeConversion)
     end
   end
 end

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

@@ -270,7 +270,9 @@ module OpenHAB
         #   Homekit metadata (see {ItemBuilder#homekit})
         # @param metadata [Hash<String, Hash>] Generic metadata (see {ItemBuilder#metadata})
         # @param state [State] Initial state
-        def initialize(type, name = nil, label = nil,
+        def initialize(type,
+                       name = nil,
+                       label = nil,
                        provider:,
                        dimension: nil,
                        unit: nil,

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

@@ -70,7 +70,8 @@ module OpenHAB
             builder = BuilderDSL.new(binding || block.binding)
             builder.uid(id)
             builder.instance_exec(builder, &block)
-            builder.guard = Guard.new(run_context: builder.caller, only_if: builder.only_if,
+            builder.guard = Guard.new(run_context: builder.caller,
+                                      only_if: builder.only_if,
                                       not_if: builder.not_if)
 
             name ||= NameInference.infer_rule_name(builder)
@@ -1075,28 +1076,50 @@ module OpenHAB
         #
         # @overload cron(second: nil, minute: nil, hour: nil, dom: nil, month: nil, dow: nil, year: nil, attach: nil)
         #   The trigger can be created by specifying each field as keyword arguments.
-        #   Omitted fields will default to `*` or `?` as appropriate.
+        #
+        #   When certain fields were omitted:
+        #     - The more specific fields will default to `0` for `hour`, `minute`, and `second`,
+        #       to `MON` for `dow`, and to `1` for `dom` and `month`.
+        #     - The less specific fields will default to `*` or `?` as appropriate.
         #
         #   Each field is optional, but at least one must be specified.
         #
         #   The same rules for the standard
         #   [cron expression](https://www.quartz-scheduler.org/documentation/quartz-2.2.2/tutorials/tutorial-lesson-06.html)
         #   apply for each field. For example, multiple values can be separated
-        #   with a comma within a string.
-        #
-        #   @param [Integer, String, nil] second
-        #   @param [Integer, String, nil] minute
-        #   @param [Integer, String, nil] hour
-        #   @param [Integer, String, nil] dom
-        #   @param [Integer, String, nil] month
-        #   @param [Integer, String, nil] dow
-        #   @param [Integer, String, nil] year
+        #   with a comma within a string, and ranges can be specified with a dash or with
+        #   a Ruby Range.
+        #
+        #   @param [Integer, String, Range, nil] second
+        #   @param [Integer, String, Range, nil] minute
+        #   @param [Integer, String, Range, nil] hour
+        #   @param [Integer, String, Symbol, Range, nil] dom
+        #   @param [Integer, String, Symbol, Range, nil] month
+        #   @param [Integer, String, Symbol, Range, nil] dow
+        #   @param [Integer, String, Range, nil] year
         #   @param [Object] attach object to be attached to the trigger
-        #   @example
+        #
+        #   @example Using String values
         #     # Run every 3 minutes on Monday to Friday
         #     # equivalent to the cron expression "0 */3 * ? * MON-FRI *"
         #     rule "Using cron fields" do
-        #       cron second: 0, minute: "*/3", dow: "MON-FRI"
+        #       cron minute: "*/3", dow: "MON-FRI"
+        #       run { logger.info "Cron rule executed" }
+        #     end
+        #
+        #   @example Defaults for unspecified fields
+        #     # Run at midnight on the first day of January, February, and March
+        #     # equivalent to the cron expression "0 0 0 1 JAN-MAR ? *"
+        #     rule "Using cron fields" do
+        #       cron month: "JAN-MAR"
+        #       run { logger.info "Cron rule executed" }
+        #     end
+        #
+        #   @example Using Ruby Range values
+        #     # Run on the hour, every hour between 1pm and 5pm
+        #     # equivalent to the cron expression "0 0 13-17 ? * ? *"
+        #     rule "Using cron fields" do
+        #       cron hour: 13..17
         #       run { logger.info "Cron rule executed" }
         #     end
         #
@@ -1559,8 +1582,12 @@ module OpenHAB
           # @deprecated OH3.4 - OH3 config uses eventXXX vs OH4 uses `topic`, `source`, and `types`
           # See https://github.com/openhab/openhab-core/pull/3299
           trigger("core.GenericEventTrigger",
-                  eventTopic: topic, eventSource: source, eventTypes: types, # @deprecated OH3.4
-                  topic: topic, source: source, types: types,
+                  eventTopic: topic,
+                  eventSource: source,
+                  eventTypes: types, # @deprecated OH3.4
+                  topic: topic,
+                  source: source,
+                  types: types,
                   attach: attach)
         end
 
@@ -1831,10 +1858,11 @@ module OpenHAB
           types = [binding.local_variable_get(:for)].flatten
 
           WatchHandler::WatchTriggerHandlerFactory.instance # ensure it's registered
-          trigger(WatchHandler::WATCH_TRIGGER_MODULE_ID, path: path.to_s,
-                                                         types: types.map(&:to_s),
-                                                         glob: glob.to_s,
-                                                         attach: attach)
+          trigger(WatchHandler::WATCH_TRIGGER_MODULE_ID,
+                  path: path.to_s,
+                  types: types.map(&:to_s),
+                  glob: glob.to_s,
+                  attach: attach)
         end
 
         # @!endgroup

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

@@ -29,7 +29,7 @@ module OpenHAB
             # @param [Hash] inputs inputs from trigger
             # @return [true, false] if the conditions passed (and therefore the block was run)
             #
-            def process(mod:, inputs:) # rubocop:disable Lint/UnusedMethodArgument - mod is unused here but required
+            def process(mod:, inputs:)
               logger.trace("Checking #{inputs} against condition trigger #{self}")
               unless check_value(Conditions.old_state_from(inputs), @from) &&
                      check_value(Conditions.new_state_from(inputs), @to) &&

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

@@ -26,16 +26,15 @@ module OpenHAB
           # @return [Hash] Map with symbols for :seconds, :minute, :hour, :dom, :month, :dow
           #   configured to fire every second
           #
-          CRON_EXPRESSION_MAP =
-            {
-              second: "*",
-              minute: "*",
-              hour: "*",
-              dom: "?",
-              month: "*",
-              dow: "?",
-              year: "*"
-            }.freeze
+          CRON_EXPRESSION_MAP = {
+            second: "*",
+            minute: "*",
+            hour: "*",
+            dom: "?",
+            month: "*",
+            dow: "?",
+            year: "*"
+          }.freeze
           private_constant :CRON_EXPRESSION_MAP
 
           # @return [Hash] Map of days of the week from symbols to to openHAB cron strings
@@ -52,7 +51,6 @@ module OpenHAB
 
           # @return [Hash] Converts the DAY_OF_WEEK_MAP to map used by Cron Expression
           DAY_OF_WEEK_EXPRESSION_MAP = DAY_OF_WEEK_MAP.transform_values { |v| CRON_EXPRESSION_MAP.merge(dow: v) }
-
           private_constant :DAY_OF_WEEK_EXPRESSION_MAP
 
           # @return [Hash] Create a set of cron expressions based on different time intervals
@@ -65,9 +63,12 @@ module OpenHAB
             month: CRON_EXPRESSION_MAP.merge(second: "0", minute: "0", hour: "0", dom: "1"),
             year: CRON_EXPRESSION_MAP.merge(second: "0", minute: "0", hour: "0", dom: "1", month: "1")
           }.merge(DAY_OF_WEEK_EXPRESSION_MAP).freeze
-
           private_constant :EXPRESSION_MAP
 
+          # @return [Hash] Translate cron field names to expression keys
+          FIELD_TO_EXPRESSION_KEY = Hash.new { |_, key| key }.merge({ dow: :week, dom: :day })
+          private_constant :FIELD_TO_EXPRESSION_KEY
+
           #
           # Create a cron map from a duration
           #
@@ -124,10 +125,28 @@ module OpenHAB
                     "unknown keyword#{"s" if extra_fields.size > 1}: #{extra_fields.map(&:inspect).join(", ")}"
             end
 
-            fields = fields.transform_values { |value| value.to_s.delete(" ") }
+            fields = fields.to_h do |key, value|
+              if value.is_a?(Range)
+                if value.exclude_end?
+                  raise ArgumentError,
+                        "Range must be inclusive for '#{key}'. Try '#{value.begin}..#{value.end}' instead"
+                end
+
+                unless value.begin && value.end
+                  raise ArgumentError,
+                        "Range must have a beginning and ending for '#{key}'"
+                end
+
+                [key, "#{value.begin.to_s.upcase}-#{value.end.to_s.upcase}".delete(" ")]
+              else
+                [key, value.to_s.delete(" ").upcase]
+              end
+            end
+            # convert fields' key dow->week, dom->day to look into EXPRESSION_MAP
+            fields_expression = fields.transform_keys { |key| FIELD_TO_EXPRESSION_KEY[key] }
             # find the first expression map that has a field from fields.
             # this ensure more-specific fields get set to 0, not *
-            base_key = EXPRESSION_MAP.keys.find { |field, _| fields.key?(field) }
+            base_key = EXPRESSION_MAP.keys.find { |field, _| fields_expression.key?(field) }
             base_expression = EXPRESSION_MAP[base_key]
             expression_map = base_expression.merge(fields)
 

data/lib/openhab/dsl/things/builder.rb

@@ -187,7 +187,8 @@ module OpenHAB
           configuration = Core::Configuration.new(config)
           if thing_type
             self.class.thing_factory_helper.apply_default_configuration(
-              configuration, thing_type,
+              configuration,
+              thing_type,
               self.class.config_description_registry
             )
           end
@@ -200,7 +201,8 @@ module OpenHAB
 
           if thing_type
             # can't use with_channels, or it will wipe out custom channels from above
-            self.class.thing_factory_helper.create_channels(thing_type, uid,
+            self.class.thing_factory_helper.create_channels(thing_type,
+                                                            uid,
                                                             self.class.config_description_registry).each do |channel|
               builder.with_channel(channel)
             end

data/lib/openhab/dsl/version.rb

@@ -4,6 +4,6 @@ module OpenHAB
   module DSL
     # Version of openHAB helper libraries
     # @return [String]
-    VERSION = "5.6.0"
+    VERSION = "5.6.1"
   end
 end

data/lib/openhab/osgi.rb

@@ -46,7 +46,7 @@ module OpenHAB
 
         bundle = org.osgi.framework.FrameworkUtil.get_bundle(interfaces.first.java_class)
         bundle.bundle_context.register_service(
-          interfaces.map(&:java_class).map(&:name).to_java(java.lang.String),
+          interfaces.map { |i| i.java_class.name }.to_java(java.lang.String),
           instance,
           java.util.Hashtable.new(properties)
         )

data/lib/openhab/rspec/karaf.rb

@@ -154,7 +154,9 @@ module OpenHAB
         klass.field_accessor :classLoader, :activatorManager
         klass.field_writer :framework
         klass.field_reader :LOG
-        org.apache.karaf.main.ConfigProperties.field_reader :props, :defaultBundleStartlevel, :karafEtc,
+        org.apache.karaf.main.ConfigProperties.field_reader :props,
+                                                            :defaultBundleStartlevel,
+                                                            :karafEtc,
                                                             :defaultStartLevel
         klass.class_eval do
           def send_private(method_name, *args)
@@ -472,7 +474,8 @@ module OpenHAB
               thf = Mocks::ThingHandlerFactory.instance
               bundle = org.osgi.framework.FrameworkUtil.get_bundle(org.openhab.core.thing.Thing.java_class)
               Mocks::BundleResolver.instance.register_class(thf.class, bundle)
-              bundle.bundle_context.register_service(org.openhab.core.thing.binding.ThingHandlerFactory.java_class, thf,
+              bundle.bundle_context.register_service(org.openhab.core.thing.binding.ThingHandlerFactory.java_class,
+                                                     thf,
                                                      nil)
             end
           end

data/lib/openhab/rspec/openhab/core/actions.rb

@@ -3,7 +3,6 @@
 module OpenHAB
   module Core
     module Actions
-      # rubocop:disable Lint/UnusedMethodArgument
       # redefine these to do nothing so that rules won't fail
 
       module_function
@@ -31,8 +30,6 @@ module OpenHAB
           end
         end
       end
-
-      # rubocop:enable Lint/UnusedMethodArgument
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 5.6.0
+  version: 5.6.1
 platform: ruby
 authors:
 - Brian O'Connell
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-08 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -214,14 +214,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.9
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.9
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: persistent_httparty
   requirement: !ruby/object:Gem::Requirement
@@ -279,33 +279,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.11'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-inst
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement