openhab-scripting 2.18.0 → 2.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44145354fe523ea40a69c6cf2ba81f2684e9982580fe5bc3996f07ab56202e71
-  data.tar.gz: ac579ab41fe3f005d7e5a87df7d18c7f32efa9f49c40f251e07620f238b9e65f
+  metadata.gz: 64cbcfa58ba3a4d63a88514b61fdbe811a317e3902c61e16119e0d97a89a3523
+  data.tar.gz: 075ca2dbc459da17c0c2f13b6a05bf6c8ffb829b5d0f96965b449820db59b216
 SHA512:
-  metadata.gz: 00026266f68f7d1c9b1ba442ffe0933ac90b5dbe80b61aa2db25470bf3c166c3f5f73067fbba4c292ad31eaeb6913e56299fc9c3625b1e7ce3efc8aaeac69665
-  data.tar.gz: 497fee2e97d90f9e64bd2ba324b9612ed44becb0aec7eb51d4706f1414e3313afeeb3242b5ece884be2fb15525c190a753116548fc2a022c0d4159cff2a8f559
+  metadata.gz: 4ae006b45842d227600eaaeb094285800bddf16935388d6c686112c31bd596ddc8d7fa53eebc6d1b83c0e4053c379662fbfcebab441794bdc183143c27004f92
+  data.tar.gz: 0506ac926852a72f400d8c47d701205e27a22b3514878a366eba39812b5226358c1a5e11a95bce3376b03fef2adceac9ccc1f76e5d3dca0a079b2883d565e8ea

data/lib/openhab/core/entity_lookup.rb

@@ -8,6 +8,7 @@ require 'openhab/log/logger'
 require 'openhab/dsl/items/number_item'
 require 'openhab/dsl/items/string_item'
 require 'openhab/dsl/items/datetime_item'
+require 'openhab/dsl/items/rollershutter_item'
 
 # Automation lookup and injection of OpenHab entities
 java_import org.openhab.core.items.GroupItem
@@ -86,7 +87,8 @@ module OpenHAB
       # @return [Object] the ruby wrapper for the item
       #
       # rubocop: disable Metrics/MethodLength
-      # Method length check disabled - case dispatch pattern
+      # rubocop: disable Metrics/AbcSize
+      # Disabled line length and branch size - case dispatch pattern
       private_class_method def self.decorate_item(item)
         case item
         when GroupItem
@@ -97,10 +99,13 @@ module OpenHAB
           OpenHAB::DSL::Items::StringItem.new(item)
         when Java::Org.openhab.core.library.items::DateTimeItem
           OpenHAB::DSL::Items::DateTimeItem.new(item)
+        when Java::Org.openhab.core.library.items::RollershutterItem
+          OpenHAB::DSL::Items::RollershutterItem.new(item)
         else
           item
         end
       end
+      # rubocop: enable Metrics/AbcSize
       # rubocop: enable Metrics/MethodLength
 
       #

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

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'java'
+
+module OpenHAB
+  module DSL
+    module Items
+      #
+      # Delegator to OpenHAB Rollershutter Item
+      #
+      class RollershutterItem < Numeric
+        extend Forwardable
+        include Comparable
+
+        def_delegator :@rollershutter_item, :to_s
+
+        java_import Java::OrgOpenhabCoreLibraryTypes::PercentType
+        java_import Java::OrgOpenhabCoreLibraryTypes::UpDownType
+        java_import Java::OrgOpenhabCoreLibraryTypes::StopMoveType
+
+        #
+        # Creates a new RollershutterItem
+        #
+        # @param [Java::OrgOpenhabCoreLibraryItems::RollershutterItem] rollershutter_item
+        #   The OpenHAB RollershutterItem to delegate to
+        #
+        def initialize(rollershutter_item)
+          logger.trace("Wrapping #{rollershutter_item}")
+          @rollershutter_item = rollershutter_item
+
+          super()
+        end
+
+        #
+        # Check if the rollershutter is up
+        #
+        # @return [Boolean] true if the rollershutter is up, false otherwise
+        #
+        def up?
+          state.as(UpDownType) == UpDownType::UP
+        end
+
+        #
+        # Check if the rollershutter is down
+        #
+        # @return [Boolean] true if the rollershutter is down, false otherwise
+        #
+        def down?
+          state.as(UpDownType) == UpDownType::DOWN
+        end
+
+        #
+        # Returns the rollershutter's position
+        #
+        # @return [Java::OrgOpenhabCoreLibraryTypes::PercentType] the position of the rollershutter
+        #
+        def position
+          state.as(PercentType)
+        end
+
+        #
+        # Compare the rollershutter's position against another object
+        #
+        # @param [Object] other object to compare against
+        #
+        # @return [Integer] -1, 0 or 1 depending on the result of the comparison
+        #
+        def <=>(other)
+          case other
+          when PercentType, Java::OrgOpenhabCoreLibraryTypes::DecimalType then position.compare_to(other)
+          when Numeric then position.int_value <=> other
+          when RollershutterItem then position.compare_to(other.position)
+          when UpDownType then state.as(UpDownType) == other
+          end
+        end
+
+        #
+        # Coerce self into other to enable calculations
+        #
+        # @param [Numeric] other Other numeric to coerce into
+        #
+        # @return [Array<Numeric>] an array of other and self coerced into other's type
+        #
+        def coerce(other)
+          raise ArgumentError, "Cannot coerce to #{other.class}" unless other.is_a? Numeric
+
+          case other
+          when Integer then [other, position.int_value]
+          when Float then [other, position.float_value]
+          end
+        end
+
+        #
+        # Case equality
+        #
+        # @param [Java::OrgOpenhabCoreLibraryTypes::UpDownType, Numeric] other Other object to compare against
+        #
+        # @return [Boolean] true if self can be defined as other, false otherwise
+        #
+        def ===(other)
+          super unless other.is_a? UpDownType
+
+          state.as(UpDownType).equals(other)
+        end
+
+        #
+        # Sends an UP command to the Item
+        #
+        def up
+          command UpDownType::UP
+        end
+
+        #
+        # Sends a DOWN command to the Item
+        #
+        def down
+          command UpDownType::DOWN
+        end
+
+        #
+        # Sends a STOP command to the Item
+        #
+        def stop
+          command StopMoveType::STOP
+        end
+
+        #
+        # Sends a MOVE command to the Item
+        #
+        def move
+          command StopMoveType::MOVE
+        end
+
+        #
+        # Define math operations
+        #
+        %i[+ - * / %].each do |operator|
+          define_method(operator) do |other|
+            right, left = coerce(other)
+            left.send(operator, right)
+          end
+        end
+
+        #
+        # Checks if this method responds to the missing method
+        #
+        # @param [String] meth Name of the method to check
+        # @param [Boolean] _include_private boolean if private methods should be checked
+        #
+        # @return [Boolean] true if this object will respond to the supplied method, false otherwise
+        #
+        def respond_to_missing?(meth, _include_private = false)
+          @rollershutter_item.respond_to?(meth) || position.respond_to?(meth)
+        end
+
+        #
+        # Forward missing methods to Openhab RollershutterItem or the PercentType representing it's state
+        #   if they are defined
+        #
+        # @param [String] meth method name
+        # @param [Array] args arguments for method
+        # @param [Proc] block <description>
+        #
+        # @return [Object] Value from delegated method in OpenHAB NumberItem
+        #
+        def method_missing(meth, *args, &block)
+          if @rollershutter_item.respond_to?(meth)
+            @rollershutter_item.__send__(meth, *args, &block)
+          elsif position.respond_to?(meth)
+            position.__send__(meth, *args, &block)
+          else
+            raise NoMethodError, "No method `#{meth}' defined for #{self.class}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,3 +6,4 @@ require 'openhab/dsl/monkey_patch/types/on_off_type'
 require 'openhab/dsl/monkey_patch/types/decimal_type'
 require 'openhab/dsl/monkey_patch/types/percent_type'
 require 'openhab/dsl/monkey_patch/types/quantity_type'
+require 'openhab/dsl/monkey_patch/types/up_down_type'

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'java'
+module OpenHAB
+  module DSL
+    module MonkeyPatch
+      #
+      # Patches OpenHAB types
+      #
+      module Types
+        java_import Java::OrgOpenhabCoreLibraryTypes::UpDownType
+
+        #
+        # MonkeyPatching UpDownType
+        #
+        class UpDownType
+          #
+          # Check if the supplied object is case equals to self
+          #
+          # @param [Object] other object to compare
+          #
+          # @return [Boolean] True if the other object is a RollershutterItem and has the same state
+          #
+          def ===(other)
+            super unless other.is_a? OpenHAB::DSL::Items::RollershutterItem
+
+            equals(other.state.as(UpDownType))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.18.0
+  version: 2.19.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-14 00:00:00.000000000 Z
+date: 2021-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,6 +42,7 @@ files:
 - lib/openhab/dsl/items/datetime_item.rb
 - lib/openhab/dsl/items/items.rb
 - lib/openhab/dsl/items/number_item.rb
+- lib/openhab/dsl/items/rollershutter_item.rb
 - lib/openhab/dsl/items/string_item.rb
 - lib/openhab/dsl/monkey_patch/actions/actions.rb
 - lib/openhab/dsl/monkey_patch/actions/script_thing_actions.rb
@@ -67,6 +68,7 @@ files:
 - lib/openhab/dsl/monkey_patch/types/percent_type.rb
 - lib/openhab/dsl/monkey_patch/types/quantity_type.rb
 - lib/openhab/dsl/monkey_patch/types/types.rb
+- lib/openhab/dsl/monkey_patch/types/up_down_type.rb
 - lib/openhab/dsl/persistence.rb
 - lib/openhab/dsl/rules/automation_rule.rb
 - lib/openhab/dsl/rules/guard.rb