openhab-scripting 4.22.0 → 4.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '02875983081fc90123fdb23c933a77a5553255acf34904cb13bba5bfafc69f63'
-  data.tar.gz: c90dbef96592a4230b6a8a904493ef4db46f8a2654ac7352989111df97847638
+  metadata.gz: 2b0032a1e364c6042f9f01f21c8315f0cbaf2e3b311c7e227073eb26394f8f8a
+  data.tar.gz: c3c2279228081ec8f9a565dd9e3fd8a2d42b1c09d01c6de85951493a79f8f098
 SHA512:
-  metadata.gz: 4c8194316eee36dd5de3a10644abb991124f19a3ba4b9a079b1304bd0ee28a1ae95b0177cb6cad18f344da4ac7dceb6f3bbfde423b0c59f33f903265a4acd0cc
-  data.tar.gz: 3b6ba33eba28b704488d830c250a8b09ff67e7cd754179e6536b6752fb4fedf7be9c47c40358704bfdbbc27f33446116597c2ee711aea6758ef2120cb85f2c3c
+  metadata.gz: 9ac07684db4dc05fa66423d2d775d8bbddeb197b672d6e7bd87a3ff811e0c1d9ea1a93da26a9775bfa4d2fba3b07d915783caf3eadaace99d6e09b2fe65ceb2e
+  data.tar.gz: 9f5be2827c0dddc7224b91d2fb9afbeffeb276b9395ff2439910415aade2019c8f2f374e07e47b38719f8c70ace700d3c4f3b7d8509086404037d21f338e3c7f

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

@@ -152,7 +152,7 @@ module OpenHAB
               @thread_locals = Thread.current[:RULE_NAME] ? { RULE_NAME: Thread.current[:RULE_NAME] } : {}
               set_name("Cancels implicit timer for #{timed_command_details.item.id}")
               set_triggers([OpenHAB::DSL::Rules::Triggers::Trigger.trigger(
-                type: OpenHAB::DSL::Rules::Triggers::Trigger::ITEM_STATE_UPDATE,
+                type: OpenHAB::DSL::Rules::Triggers::Trigger::ITEM_STATE_CHANGE,
                 config: { 'itemName' => timed_command_details.item.name }
               )])
             end

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

@@ -107,10 +107,13 @@ module OpenHAB
       # Extend MonthDay java object with some helper methods
       class MonthDay
         include OpenHAB::Log
+        java_import java.time.format.DateTimeFormatter
         # 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 +126,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/types/hsb_type.rb

@@ -47,7 +47,7 @@ module OpenHAB
           # @param saturation [PercentType, Numeric] Saturation component (0-100%)
           # @param brightness [PercentType, Numeric] Brightness component (0-100%)
           # @return [HSBType]
-          def from_hsv(hue, saturation, brightness)
+          def from_hsb(hue, saturation, brightness)
             new(hue, saturation, brightness)
           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.0'
+  VERSION = '4.24.0'
 end

metadata

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