openhab-scripting 4.22.2 → 4.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 445030f6b4a4337bf93526051c00262a84695be09b3c9dea14f40ccd1c2e20d2
-  data.tar.gz: ff6198e6482c7650c3d9878f577ce89c17a5caf6d000f114dbc6a6e9f5483cf8
+  metadata.gz: 9311e047c09ea5409e82e4650a2ef22d26513e10a566445370772e568552e0bd
+  data.tar.gz: c21b7970c72bf749d6403b212b8e84ab255b1dd07ef3d695c7881e5205edd72a
 SHA512:
-  metadata.gz: d208d4623c547442f4d97c9f0ae663e18041e4f4b774b5124c96a92feb54ebd307160180f62de5c322a691f89dbd1f9315597cbf4eff98cbd01c02cf32df3b28
-  data.tar.gz: 8ad90301acb4144bfe816f1a4c83824d4e31ef9bed567a2032cb14a3b7e7287039906aae7ebf57770810d91e2fbf856f63452accb7c95090d7b51563adff8d0d
+  metadata.gz: 0f62960bbd5fc2e51064bc63c4a3cc7e2e9de322233a1f489311ca20c3df51381c04449a4af0dff455ceb998f4e43ab4ac2668101aa7838c3445e0c4093f6074
+  data.tar.gz: df255a6f1e8a5b573d6b37b0ec6637cd7ccdea4e6abdd937f19b0f8f484713406133cb86fb2c080bdb132717a3efa313c626c4b4cd89ea62baf4bca31b26f58b

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

@@ -48,10 +48,51 @@ module OpenHAB
         # convert it to an HSBType
         # @!visibility private
         def format_type(command)
+          return format_hash(command.to_hash) if command.respond_to?(:to_hash)
           return Types::HSBType.new(command) if command.respond_to?(:to_str)
 
           super
         end
+
+        #
+        # Convert the ColorItem to a hash
+        # @param [:hsb, :rgb] format for hash
+        # @return [Hash] in requested format
+        def to_h(format = :hsb)
+          values = to_a(format)
+          keys = (format == :hsb ? %i[hue saturation brightness] : %i[red green blue])
+          keys.zip(values).to_h
+        end
+
+        #
+        # Convert the ColorItem to an array of values
+        # @param [:hsb, :rgb] format for elements in the array
+        # @return [Array] of ColorItem components in requested format
+        def to_a(format = :hsb)
+          case format
+          when :hsb then [hue, saturation, brightness]
+          when :rgb then [red, green, blue].map(&:to_byte)
+          else
+            raise ArgumentError, "Unsupported format #{format}"
+          end
+        end
+
+        private
+
+        # Mapping of hash values sets to conversion methods
+        HASH_KEYS = { %i[r g b] => :from_rgb,
+                      %i[red green blue] => :from_rgb,
+                      %i[h s b] => :from_hsb,
+                      %i[hue saturation brightness] => :from_hsb }.freeze
+
+        def format_hash(hash)
+          hash = hash.transform_keys(&:to_sym)
+          HASH_KEYS.each do |key_set, method|
+            values = hash.values_at(*key_set).compact
+            return Types::HSBType.public_send(method, *values) if values.length == 3
+          end
+          raise ArgumentError, "Supplied hash (#{hash}) must contain one of the following keysets #{keys.keys}"
+        end
       end
     end
   end

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

@@ -25,7 +25,14 @@ module OpenHAB
           super
         end
 
-        #
+        # Support conversion to location items from a hash
+        # @!visibility private
+        def format_type(command)
+          return PointType.new(command.to_hash) if command.respond_to?(:to_hash)
+
+          super
+        end
+
         # Type Coercion
         #
         # Coerce object to a PointType

data/lib/openhab/dsl/time/month_day.rb

@@ -107,10 +107,28 @@ module OpenHAB
       # Extend MonthDay java object with some helper methods
       class MonthDay
         include OpenHAB::Log
+        java_import java.time.format.DateTimeFormatter
+
+        #
+        # Constructor
+        #
+        # @param [Integer] m month
+        # @param [Integer] d day of month
+        #
+        # @return [Object] MonthDay object
+        #
+        # rubocop: disable Naming/MethodParameterName
+        def self.new(m:, d:)
+          MonthDay.of(m, d)
+        end
+        # rubocop: enable Naming/MethodParameterName
+
         # Parse MonthDay string as defined with by Monthday class without leading double dash "--"
         def self.parse(string)
-          ##          string = "--#{string}" unless string.to_s.start_with? '--'
-          java_send :parse, [java.lang.CharSequence], "--#{string}"
+          logger.trace("#{self.class}.parse #{string} (#{string.class})")
+          java_send :parse, [java.lang.CharSequence, java.time.format.DateTimeFormatter],
+                    string.to_s,
+                    DateTimeFormatter.ofPattern('[--]M-d')
         end
 
         # Can the supplied object be parsed into a MonthDay
@@ -123,6 +141,9 @@ module OpenHAB
           to_string.delete_prefix('--')
         end
 
+        # remove the inherited #== method to use our <=> below
+        remove_method :==
+
         # Extends MonthDay comparison to support Strings
         # Necessary to support mixed ranges of Strings and MonthDay types
         # @return [Number, nil] -1,0,1 if other MonthDay is less than, equal to, or greater than this MonthDay

data/lib/openhab/dsl/timers/manager.rb

@@ -19,7 +19,7 @@ module OpenHAB
 
         def initialize
           # Track timer IDs
-          @timer_ids = Hash.new { |hash, key| hash[key] = Set.new }
+          @timer_ids = {}
 
           # Reentrant timer lookups
           @reentrant_timers = {}
@@ -39,6 +39,7 @@ module OpenHAB
 
           if timer.respond_to? :id
             logger.trace("Adding #{timer} with id #{timer.id.inspect} timer ids")
+            @timer_ids[timer.id] = Set.new unless @timer_ids[timer.id]
             @timer_ids[timer.id] << timer
           end
 
@@ -68,7 +69,10 @@ module OpenHAB
         def delete(timer)
           logger.trace("Removing #{timer} from timers")
           @timers.delete(timer)
-          @timer_ids[timer.id].delete(timer) if (timer.respond_to? :id) && (@timer_ids.key? timer.id)
+          if timer.respond_to? :id
+            @timer_ids[timer.id]&.delete(timer)
+            @timer_ids.delete(timer.id) unless @timer_ids[timer.id].any?
+          end
           @reentrant_timers.delete(timer.reentrant_id) if timer.respond_to? :reentrant_id
         end
 

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

@@ -17,6 +17,7 @@ module OpenHAB
         # @param longitude [DecimalType, QuantityType, StringType, Numeric]
         # @param altitude [DecimalType, QuantityType, StringType, Numeric]
         def initialize(*args) # rubocop:disable Metrics
+          args = from_hash(args.first.to_hash) if args.first.respond_to? :to_hash
           if (2..3).cover?(args.length)
             args = args.each_with_index.map do |value, index|
               if value.is_a?(DecimalType) || value.is_a?(StringType)
@@ -118,6 +119,13 @@ module OpenHAB
           QuantityType.new(raw_altitude.to_big_decimal, Units::METRE)
         end
 
+        #
+        # Convert the PointType to a hash
+        # @return [Hash] with keys latitude/longitude/altitude
+        def to_h
+          { latitude: latitude, longitude: longitude, altitude: altitude }
+        end
+
         #
         # Calculate the distance in meters from other, ignoring altitude.
         #
@@ -138,7 +146,7 @@ module OpenHAB
 
         # coerce an object to a PointType
         # @return [PointType]
-        def coerce_single(other)
+        def coerce_single(other) # rubocop:disable Metrics
           logger.trace("Coercing #{self} as a request from #{other.class}")
           if other.is_a?(PointType)
             other
@@ -148,7 +156,22 @@ module OpenHAB
             other.state
           elsif other.respond_to?(:to_str)
             PointType.new(other.to_str)
+          elsif other.respond_to?(:to_hash)
+            PointType.new(other.to_hash)
+          end
+        end
+
+        #
+        # Convert hash into ordered arguments for constructor
+        #
+        def from_hash(hash)
+          keys = [%i[lat long alt], %i[latitude longitude altitude]]
+          keys.each do |key_set|
+            values = hash.transform_keys(&:to_sym).values_at(*key_set)
+
+            return *values.compact if values[0..1].all?
           end
+          raise ArgumentError, "Supplied arguments (#{hash}) must contain one of the following sets #{keys}"
         end
       end
     end

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.22.2
+  version: 4.25.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-04 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler