openhab-scripting 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13732b675b80ad3a92e2346e56da3e7d63b6a4845f8409c5a545d1b5006ab999
-  data.tar.gz: a5b9d54c25a47857256805d849344cfde4602ad23408228cc595bfc574a04587
+  metadata.gz: a9ccae52c29da91b7fadc2ac7ba2459e9870a257396849535458497ba48601e5
+  data.tar.gz: 0015aca73a5c79082adefb486afcbb545e324c0695d492e15397d2e0d691a204
 SHA512:
-  metadata.gz: 9d8715ab0e0e84315b02a67aeb28f47ebcddb8b58ea5ea1043b53ef329f5f5017329fdae23961530cd1f0ac184e38acf8ad11fd9b1a7a41f77f486cf3d53f01c
-  data.tar.gz: 15a9babdc9a9d7179dda57fcad46356175c25933f534cc4ed1dad9566a56bdde08677b6ef0224c2761fdeb1dd9253f4d6a50cec5a5804bd703b6c843e438a66b
+  metadata.gz: 2db7c0a6f4182d3145871ab6936aa92d5acbe2a6d29e79f793a464d4fbb9514555021d9f0b103130ed99b04c9e149a414ea96df8f134f7db2fb71bade3824168
+  data.tar.gz: da447a4315a8d177db5fc6e476dd30ba93a071f06c6dc612a361f9d12a8539932f8a1659bdd919d8cdf61be2da759f720020d57fe399eaa1a2533bf5e1f56203

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

@@ -14,6 +14,7 @@ require_relative 'color_item'
 require_relative 'contact_item'
 require_relative 'group_item'
 require_relative 'image_item'
+require_relative 'location_item'
 require_relative 'number_item'
 require_relative 'player_item'
 require_relative 'rollershutter_item'

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+require_relative 'comparable_item'
+require 'openhab/dsl/types/point_type'
+
+module OpenHAB
+  module DSL
+    module Items
+      java_import org.openhab.core.library.items.LocationItem
+
+      # Adds methods to core OpenHAB NumberItem type to make it more natural in
+      # Ruby
+      class LocationItem < GenericItem
+        extend Forwardable
+        include ComparableItem
+
+        # !@visibility private
+        def ==(other)
+          # need to check if we're referring to the same item before
+          # forwarding to <=> (and thus checking equality with state)
+          return true if equal?(other) || eql?(other)
+
+          super
+        end
+
+        #
+        # Type Coercion
+        #
+        # Coerce object to a PointType
+        #
+        # @param [Types::PointType, String] other object to coerce to a
+        #   PointType
+        #
+        # @return [[Types::PointType, Types::PointType]]
+        #
+        def coerce(other)
+          logger.trace("Coercing #{self} as a request from #{other.class}")
+          return [other, nil] unless state?
+          return [other, state] if other.is_a?(Types::PointType) || other.respond_to?(:to_str)
+
+          raise TypeError, "can't convert #{other.class} into #{self.class}"
+        end
+
+        # OpenHAB has this method, but it _only_ accepts PointType, so remove it and delegate
+        remove_method :distance_from
+
+        # any method that exists on {Types::PointType} gets forwarded to +state+
+        delegate (Types::PointType.instance_methods - instance_methods) => :state
+      end
+    end
+  end
+end

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

@@ -91,7 +91,7 @@ module OpenHAB
 
             return super unless other.is_a?(javax.measure.Unit)
 
-            QuantityType.new(to_d.to_java, other)
+            Types::QuantityType.new(to_d.to_java, other)
           end
         end
       end

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

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module DSL
+    module Types
+      java_import org.openhab.core.library.types.PointType
+
+      # global scope
+      # @!visibility private
+      ::PointType = PointType
+
+      # Adds methods to core OpenHAB PointType to make it more natural in Ruby
+      class PointType
+        # @!parse include PrimitiveType
+
+        # @param latitude [DecimalType, QuantityType, StringType, Numeric]
+        # @param longitude [DecimalType, QuantityType, StringType, Numeric]
+        # @param altitude [DecimalType, QuantityType, StringType, Numeric]
+        def initialize(*args) # rubocop:disable Metrics
+          if (2..3).cover?(args.length)
+            args = args.each_with_index.map do |value, index|
+              if value.is_a?(DecimalType) || value.is_a?(StringType)
+                value
+              elsif value.is_a?(QuantityType)
+                unit = index == 2 ? Units.unit || 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)
+              elsif value.respond_to?(:to_d)
+                DecimalType.new(value)
+              end
+            end
+          end
+
+          super(*args)
+        end
+
+        #
+        # Check equality without type conversion
+        #
+        # @return [Boolean] if the same value is represented, without type
+        #   conversion
+        def eql?(other)
+          return false unless other.instance_of?(self.class)
+
+          equals(other.to_s).zero?
+        end
+
+        #
+        # Check equality with type conversion
+        #
+        # @param [PointType, Items::LocationItem, String]
+        #   other object to compare to
+        #
+        # @return [Boolean]
+        #
+        def ==(other) # rubocop:disable Metrics
+          logger.trace("(#{self.class}) #{self} == #{other} (#{other.class})")
+          if other.is_a?(Items::LocationItem) ||
+             (other.is_a?(Items::GroupItem) && other.base_item.is_a?(LocationItem))
+            return false unless other.state?
+
+            self == other.state
+          elsif other.respond_to?(:to_str)
+            self == PointType.new(other)
+          elsif other.respond_to?(:coerce)
+            lhs, rhs = other.coerce(self)
+            lhs == rhs
+          end
+        end
+
+        #
+        # Type Coercion
+        #
+        # Coerce object to a PointType
+        #
+        # @param [Items::LocationItem, String] other object to coerce to a
+        #   PointType
+        #
+        # @return [[PointType, PointType]]
+        #
+        def coerce(other)
+          [coerce_single(other), self]
+        end
+
+        # rename raw methods so we can overwrite them
+        # @!visibility private
+        alias raw_latitude latitude
+        # .
+        # @!visibility private
+        alias raw_longitude longitude
+        # .
+        # @!visibility private
+        alias raw_altitude altitude
+        # .
+        # @!visibility private
+        alias raw_distance_from distance_from
+
+        # @!attribute [r] latitude
+        # @return [QuantityType]
+        def latitude
+          QuantityType.new(raw_latitude.to_big_decimal, SIUnits::DEGREE_ANGLE)
+        end
+
+        # @!attribute [r] longitude
+        # @return [QuantityType]
+        def longitude
+          QuantityType.new(raw_longitude.to_big_decimal, SIUnits::DEGREE_ANGLE)
+        end
+
+        # @!attribute [r] altitude
+        # @return [QuantityType]
+        def altitude
+          QuantityType.new(raw_altitude.to_big_decimal, Units::METRE)
+        end
+
+        #
+        # Calculate the distance in meters from other, ignoring altitude.
+        #
+        # This algorithm also ignores the oblate spheroid shape of Earth and
+        # assumes a perfect sphere, so results are inexact.
+        #
+        # @return [QuantityType]
+        def distance_from(other)
+          logger.trace("(#{self}).distance_from(#{other} (#{other.class})")
+          QuantityType.new(raw_distance_from(coerce_single(other)), SIUnits::METRE)
+        end
+        alias - distance_from
+
+        private
+
+        # coerce an object to a PointType
+        # @return [PointType]
+        def coerce_single(other) # rubocop:disable Metrics/MethodLength
+          logger.trace("Coercing #{self} as a request from #{other.class}")
+          if other.is_a?(PointType)
+            other
+          elsif other.is_a?(Items::LocationItem)
+            raise TypeError, "can't convert #{other.raw_state} into #{self.class}" unless other.state?
+
+            other.state
+          elsif other.respond_to?(:to_str)
+            PointType.new(other.to_str)
+          else
+            raise TypeError, "can't convert #{other.class} into #{self.class}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,6 +11,7 @@ require_relative 'open_closed_type'
 require_relative 'on_off_type'
 require_relative 'percent_type'
 require_relative 'play_pause_type'
+require_relative 'point_type'
 require_relative 'quantity_type'
 require_relative 'refresh_type'
 require_relative 'rewind_fastforward_type'

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-19 00:00:00.000000000 Z
+date: 2021-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,7 @@ files:
 - lib/openhab/dsl/items/item_equality.rb
 - lib/openhab/dsl/items/item_registry.rb
 - lib/openhab/dsl/items/items.rb
+- lib/openhab/dsl/items/location_item.rb
 - lib/openhab/dsl/items/metadata.rb
 - lib/openhab/dsl/items/number_item.rb
 - lib/openhab/dsl/items/numeric_item.rb
@@ -114,6 +115,7 @@ files:
 - lib/openhab/dsl/types/open_closed_type.rb
 - lib/openhab/dsl/types/percent_type.rb
 - lib/openhab/dsl/types/play_pause_type.rb
+- lib/openhab/dsl/types/point_type.rb
 - lib/openhab/dsl/types/quantity_type.rb
 - lib/openhab/dsl/types/refresh_type.rb
 - lib/openhab/dsl/types/rewind_fastforward_type.rb