openhab-scripting 4.1.4 → 4.5.0

data/lib/openhab.rb

@@ -4,7 +4,6 @@ require 'openhab/core/load_path'
 require 'openhab/core/openhab_setup'
 require 'openhab/log/logger'
 require 'openhab/dsl/dsl'
-
 require 'openhab/version'
 
 #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.1.4
+  version: 4.5.0
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-11 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,16 +54,26 @@ files:
 - lib/openhab/dsl/dsl.rb
 - lib/openhab/dsl/gems.rb
 - lib/openhab/dsl/group.rb
-- lib/openhab/dsl/items/datetime_item.rb
+- lib/openhab/dsl/items/color_item.rb
+- lib/openhab/dsl/items/comparable_item.rb
+- lib/openhab/dsl/items/contact_item.rb
+- lib/openhab/dsl/items/date_time_item.rb
+- lib/openhab/dsl/items/dimmer_item.rb
+- lib/openhab/dsl/items/ensure.rb
+- lib/openhab/dsl/items/generic_item.rb
 - lib/openhab/dsl/items/group_item.rb
 - lib/openhab/dsl/items/image_item.rb
-- lib/openhab/dsl/items/item_command.rb
-- lib/openhab/dsl/items/item_delegate.rb
+- lib/openhab/dsl/items/item_equality.rb
+- lib/openhab/dsl/items/item_registry.rb
 - lib/openhab/dsl/items/items.rb
+- lib/openhab/dsl/items/metadata.rb
 - lib/openhab/dsl/items/number_item.rb
+- lib/openhab/dsl/items/numeric_item.rb
+- lib/openhab/dsl/items/persistence.rb
 - lib/openhab/dsl/items/player_item.rb
 - lib/openhab/dsl/items/rollershutter_item.rb
 - lib/openhab/dsl/items/string_item.rb
+- lib/openhab/dsl/items/switch_item.rb
 - lib/openhab/dsl/lazy_array.rb
 - lib/openhab/dsl/monkey_patch/actions/actions.rb
 - lib/openhab/dsl/monkey_patch/actions/script_thing_actions.rb
@@ -73,36 +83,16 @@ files:
 - lib/openhab/dsl/monkey_patch/events/item_state.rb
 - lib/openhab/dsl/monkey_patch/events/item_state_changed.rb
 - lib/openhab/dsl/monkey_patch/events/thing_status_info.rb
-- lib/openhab/dsl/monkey_patch/items/contact_item.rb
-- lib/openhab/dsl/monkey_patch/items/dimmer_item.rb
-- lib/openhab/dsl/monkey_patch/items/items.rb
-- lib/openhab/dsl/monkey_patch/items/metadata.rb
-- lib/openhab/dsl/monkey_patch/items/persistence.rb
-- lib/openhab/dsl/monkey_patch/items/switch_item.rb
 - lib/openhab/dsl/monkey_patch/ruby/number.rb
-- lib/openhab/dsl/monkey_patch/ruby/range.rb
 - lib/openhab/dsl/monkey_patch/ruby/ruby.rb
 - lib/openhab/dsl/monkey_patch/ruby/string.rb
-- lib/openhab/dsl/monkey_patch/ruby/time.rb
-- lib/openhab/dsl/monkey_patch/types/decimal_type.rb
-- lib/openhab/dsl/monkey_patch/types/increase_decrease_type.rb
-- lib/openhab/dsl/monkey_patch/types/next_previous_type.rb
-- lib/openhab/dsl/monkey_patch/types/on_off_type.rb
-- lib/openhab/dsl/monkey_patch/types/open_closed_type.rb
-- lib/openhab/dsl/monkey_patch/types/percent_type.rb
-- lib/openhab/dsl/monkey_patch/types/play_pause_type.rb
-- lib/openhab/dsl/monkey_patch/types/quantity_type.rb
-- lib/openhab/dsl/monkey_patch/types/refresh_type.rb
-- lib/openhab/dsl/monkey_patch/types/rewind_fastforward_type.rb
-- lib/openhab/dsl/monkey_patch/types/stop_move_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
 - lib/openhab/dsl/rules/property.rb
 - lib/openhab/dsl/rules/rule.rb
 - lib/openhab/dsl/rules/rule_config.rb
+- lib/openhab/dsl/rules/terse.rb
 - lib/openhab/dsl/rules/triggers/changed.rb
 - lib/openhab/dsl/rules/triggers/channel.rb
 - lib/openhab/dsl/rules/triggers/command.rb
@@ -113,8 +103,26 @@ files:
 - lib/openhab/dsl/things.rb
 - lib/openhab/dsl/time_of_day.rb
 - lib/openhab/dsl/timers.rb
-- lib/openhab/dsl/types/datetime.rb
-- lib/openhab/dsl/types/quantity.rb
+- lib/openhab/dsl/types/comparable_type.rb
+- lib/openhab/dsl/types/date_time_type.rb
+- lib/openhab/dsl/types/decimal_type.rb
+- lib/openhab/dsl/types/hsb_type.rb
+- lib/openhab/dsl/types/increase_decrease_type.rb
+- lib/openhab/dsl/types/next_previous_type.rb
+- lib/openhab/dsl/types/numeric_type.rb
+- lib/openhab/dsl/types/on_off_type.rb
+- 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/quantity_type.rb
+- lib/openhab/dsl/types/refresh_type.rb
+- lib/openhab/dsl/types/rewind_fastforward_type.rb
+- lib/openhab/dsl/types/stop_move_type.rb
+- lib/openhab/dsl/types/string_type.rb
+- lib/openhab/dsl/types/type.rb
+- lib/openhab/dsl/types/types.rb
+- lib/openhab/dsl/types/un_def_type.rb
+- lib/openhab/dsl/types/up_down_type.rb
 - lib/openhab/dsl/units.rb
 - lib/openhab/log/configuration.rb
 - lib/openhab/log/logger.rb

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

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require 'forwardable'
-require 'java'
-require 'time'
-require 'openhab/dsl/types/datetime'
-require 'openhab/dsl/items/item_delegate'
-require 'openhab/dsl/items/item_command'
-
-module OpenHAB
-  module DSL
-    module Items
-      #
-      # Delegation to OpenHAB DateTime Item
-      #
-      # @author Anders Alfredsson
-      #
-      class DateTimeItem
-        extend Forwardable
-        extend OpenHAB::DSL::Items::ItemDelegate
-        extend OpenHAB::DSL::Items::ItemCommand
-        include Comparable
-
-        def_item_delegator :@datetime_item
-
-        item_type Java::OrgOpenhabCoreLibraryItems::DateTimeItem
-
-        #
-        # Create a new DateTimeItem
-        #
-        # @param [Java::org::openhab::core::libarary::items::DateTimeItem] datetime_item Openhab DateTimeItem to
-        # delegate to
-        #
-        def initialize(datetime_item)
-          @datetime_item = datetime_item
-          item_missing_delegate { @datetime_item }
-          item_missing_delegate { to_dt }
-        end
-
-        #
-        # Return an instance of DateTime that wraps the DateTimeItem's state
-        #
-        # @return [OpenHAB::DSL::Types::DateTime] Wrapper for the Item's state, or nil if it has no state
-        #
-        def to_dt
-          OpenHAB::DSL::Types::DateTime.new(@datetime_item.state) if state?
-        end
-
-        #
-        # Compare the Item's state to another Item or object that can be compared
-        #
-        # @param [Object] other Other objet to compare against
-        #
-        # @return [Integer] -1, 0 or 1 depending on the result of the comparison
-        #
-        def <=>(other)
-          return unless state?
-
-          logger.trace("Comparing self (#{self.class}) to #{other} (#{other.class})")
-          other = other.to_dt if other.is_a? DateTimeItem
-          to_dt <=> other
-        end
-
-        #
-        # Get the time zone of the Item
-        #
-        # @return [String] The timezone in `[+-]hh:mm(:ss)` format or nil if the Item has no state
-        #
-        def zone
-          to_dt.zone if state?
-        end
-      end
-    end
-  end
-end

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

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-require 'openhab/log/logger'
-require 'openhab/dsl/monkey_patch/events/item_command'
-
-module OpenHAB
-  module DSL
-    module Items
-      #
-      # Holds methods to automatically generate commands and
-      # accessors for items
-      module ItemCommand
-        include OpenHAB::Log
-
-        #
-        # For every value in the supplied enumeration create a corresponding method mapped to the lowercase
-        # string representation of the enum value For example, an enum with values of STOP and START
-        # would create methods stop() and start() that send the corresponding STOP and START commands to the item
-        #
-        # @param [Java::JavaLang::Enum] command_enum Enumeration to create commands for
-        # @param [Hash] optional hash in which if a generated method name mactches a key, the value of that key
-        #   will be used as the method name instead, for example `:play? => :playing?`
-        #
-        #
-        def item_command(command_enum, methods = {})
-          # rubocop:disable Style/HashEachMethods
-          # Disable rule because Java enum does not support each_value
-          command_enum.values.each do |command|
-            command_method = command.to_s.downcase
-            command_method = methods.transform_keys(&:to_sym).fetch(command_method.to_sym, command_method)
-            logger.trace("Creating command method (#{command_method}) for #{self}")
-            define_method(command_method) do
-              self.command(command)
-            end
-          end
-          # rubocop:enable Style/HashEachMethods
-        end
-
-        #
-        # For every value in the supplied enumeration create a corresponding method mapped to the lowercase
-        # string representation appended with a question mark '?' of the enum value For example,
-        # an enum with values of UP and DOWN would create methods up? and down? that check
-        # if the current state matches the value of the enum
-        #
-        # @param [Java::JavaLang::Enum] command_enum Enumeration to create methods for each value
-        #   to check if current state matches that enum
-        # @param [Hash] optional hash in which if a generated method name mactches a key, the value of that key
-        #   will be used as the method name instead, for example `:play? => :playing?`
-        #
-        #
-        def item_state(command_enum, methods = {})
-          # rubocop:disable Style/HashEachMethods
-          # Disable rule because Java enum does not support each_value
-          command_enum.values.each do |command|
-            status_method = "#{command.to_s.downcase}?"
-            status_method = methods.transform_keys(&:to_sym).fetch(status_method.to_sym, status_method)
-            logger.trace("Creating status method (#{status_method}) for #{self}")
-            define_method(status_method) do
-              state? && state.as(command_enum) == command
-            end
-          end
-          # rubocop:enable Style/HashEachMethods
-        end
-
-        #
-        # Extract the accepted state and command types from the specified OpenHAB
-        # Item class and pass them to item_state/item_command
-        #
-        # @param [Java::JavaLang::Class] item_class a Class that implements Java::OrgOpenhabCoreItems::Item
-        # @param [Hash] optional hash in which if a generated method name mactches a key, the value of that key
-        #   will be used as the method name instead, for example `:play? => :playing?`
-        #
-        def item_type(item_class, methods = {}) # rubocop:disable Metrics/MethodLength
-          item_class.field_reader(:ACCEPTED_DATA_TYPES)
-          item_class.field_reader(:ACCEPTED_COMMAND_TYPES)
-          item_class.ACCEPTED_DATA_TYPES.select(&:is_enum)
-                    .grep_v(UnDefType)
-                    .each { |type| item_state(type.ruby_class, methods) }
-          item_class.ACCEPTED_COMMAND_TYPES.select(&:is_enum)
-                    .grep_v(UnDefType)
-                    .each do |type|
-                      item_command(type.ruby_class, methods)
-                      MonkeyPatch::Events::ItemCommandEvent.def_enum_predicates(type.ruby_class)
-                    end
-        end
-      end
-    end
-  end
-end

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

@@ -1,125 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-require 'openhab/log/logger'
-require 'forwardable'
-
-module OpenHAB
-  module DSL
-    module Items
-      #
-      # Holds methods to delegate to items
-      #
-      module ItemDelegate
-        include OpenHAB::Log
-
-        # @return [Array<Symbol>] Array of methods that by default will be forwarded to an OpenHAB Item.
-        DEFAULT_DELEGATION_METHODS = %i[to_s groups].freeze
-        private_constant :DEFAULT_DELEGATION_METHODS
-
-        #
-        # Extends calling object with DSL and helper methods
-        #
-        # @param [Object] base Object to decorate with DSL and helper methods
-        #
-        #
-        def self.extended(base)
-          base.extend Forwardable
-          base.include OpenHAB::DSL::Items::ItemDelegate
-        end
-
-        #
-        # Delegate a set of methods to the supplied delegator
-        #
-        # @param [Java::OrgOpenhabCoreItems::GenericItem] item to delegate methods to
-        # @param [Symbol] methods to delegate, if not supplied default methods are used
-        #
-        #
-        def def_item_delegator(item, *methods)
-          methods = DEFAULT_DELEGATION_METHODS if methods.size.zero?
-          methods.each do |method|
-            logger.trace("Creating delegate for (#{method}) to #{item}) for #{self.class}")
-            def_delegator item, method
-          end
-          define_method(:oh_item) { instance_variable_get(item) }
-          define_method(:hash) { oh_item.hash_code }
-          define_method(:eql?) { |other| hash == other.hash }
-        end
-
-        #
-        # Delegates methods to the object returned from the supplied block if
-        #   they don't exist in the object this is included in.  If the supplied block returns nil, no delegation occurs
-        # If this item is called more than once delegation occurs in the order of invocation, i.e. the object returned
-        #   by the first block is delegated to if it responds to the missing method,
-        #   then the second block is processed, etc.
-        #
-        # @param [Proc] &delegate delgegate block
-        #
-        #
-        def item_missing_delegate(&delegate)
-          @delegates ||= []
-          @delegates << delegate
-        end
-
-        #
-        # Delegate missing method calls to delegates supplied to item_delgate method
-        #  if no delegates exist or respond to missing method, super is invoked which will
-        #  throw the appropriate method missing error
-        #
-        # @param [String] meth misisng method
-        # @param [Array] *args Arguments to the missing method
-        # @param [Proc] &block supplied to the missing method
-        #
-        # @return [Object] Result of missing method invocation
-        #
-        def method_missing(meth, *args, &block)
-          logger.trace("Method (#{meth}) missing for item #{self.class}")
-          delegate = delegate_for(meth)
-          if delegate
-            logger.trace("Delegating #{meth} to #{delegate.class}")
-            delegate.__send__(meth, *args, &block)
-          else
-            super
-          end
-        end
-
-        #
-        # Checks if any of the supplied delgates respond to a specific method
-        #
-        # @param [String] meth method to check for
-        # @param [Boolean] _include_private if private methods should be checked
-        #
-        # @return [Boolean] True if any delegates respond to method, false otherwise
-        #
-        def respond_to_missing?(meth, _include_private = false)
-          logger.trace("Checking if (#{self.class}) responds to (#{meth})")
-          responds = !delegate_for(meth).nil?
-          logger.trace("(#{self.class}) responds to (#{meth}) (#{responds})")
-          responds
-        end
-
-        private
-
-        #
-        # Find a delegate for the supplied method
-        #
-        # @param [String] meth method to find delegate for
-        #
-        # @return [Boolean] True if any method responds to the supplied delegate, false otherwise
-        #
-        def delegate_for(meth)
-          (@delegates || []).each do |delegate_block|
-            delegate = delegate_block.call(meth)
-            logger.trace("Checking if delegate (#{delegate.class}) responds to (#{meth})")
-            if delegate.respond_to? meth
-              logger.trace("Delegate (#{delegate.class}) found for method (#{meth})")
-              return delegate
-            end
-          end
-          logger.trace("No delegate found for method (#{meth})")
-          nil
-        end
-      end
-    end
-  end
-end

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

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-require 'openhab/dsl/items/item_command'
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB items
-      #
-      module Items
-        java_import Java::OrgOpenhabCoreLibraryItems::ContactItem
-
-        #
-        # Alias class for ContactItem
-        #
-        ::Contact = ContactItem
-
-        #
-        # Monkey patch Contact Item with Ruby methods
-        #
-        class ContactItem
-          extend OpenHAB::DSL::Items::ItemCommand
-
-          java_import Java::OrgOpenhabCoreLibraryTypes::OpenClosedType
-
-          item_type Java::OrgOpenhabCoreLibraryItems::ContactItem
-
-          #
-          # Compares contacts to OpenClosedTypes
-          #
-          # @param [Object] other object to compare to
-          #
-          # @return [Boolean] True if contact has a state and state equals other, nil if no state,
-          #   result from super if not supplied an OpenClosedType
-          #
-          def ==(other)
-            other = other.get_state_as(OpenClosedType) if other.respond_to?(:get_state_as)
-
-            if other.is_a? OpenClosedType
-              state? && state == other
-            else
-              super
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,140 +0,0 @@
-# frozen_string_literal: true
-
-require 'java'
-require 'openhab/dsl/items/item_command'
-require 'forwardable'
-
-module OpenHAB
-  module DSL
-    module MonkeyPatch
-      #
-      # Patches OpenHAB items
-      #
-      module Items
-        java_import Java::OrgOpenhabCoreLibraryItems::DimmerItem
-        java_import Java::OrgOpenhabCoreItems::GenericItem
-
-        #
-        # Alias class for is_a? testing
-        #
-        ::Dimmer = DimmerItem
-
-        #
-        # Monkey Patch DimmerItem
-        #
-        class DimmerItem
-          include Comparable
-          java_import Java::OrgOpenhabCoreLibraryTypes::DecimalType
-          java_import Java::OrgOpenhabCoreLibraryTypes::IncreaseDecreaseType
-
-          extend Forwardable
-          extend OpenHAB::DSL::Items::ItemCommand
-
-          item_type Java::OrgOpenhabCoreLibraryItems::DimmerItem
-
-          def_delegator :state, :to_s
-
-          #
-          # Dim the dimmer
-          #
-          # @param [Integer] amount to dim by
-          #
-          # @return [Integer] level target for dimmer
-          #
-          def dim(amount = 1)
-            [state&.to_big_decimal&.intValue&.-(amount), 0].compact
-                                                           .max
-                                                           .tap { |target| command(target) }
-          end
-
-          #
-          # Brighten the dimmer
-          #
-          # @param [Integer] amount to brighten by
-          #
-          # @return [Integer] level target for dimmer
-          #
-          def brighten(amount = 1)
-            state&.to_big_decimal&.intValue&.+(amount)&.tap { |target| command(target) }
-          end
-
-          #
-          # Compare DimmerItem to supplied object
-          #
-          # @param [Object] other object to compare to
-          #
-          # @return [Integer] -1,0,1 or nil depending on value supplied,
-          #   nil comparison to supplied object is not possible.
-          #
-          def <=>(other)
-            logger.trace("Comparing #{self} to #{other}")
-            case other
-            when GenericItem, NumberItem then state <=> other.state
-            when DecimalType then state <=> other
-            when Numeric then state.to_big_decimal.to_d <=> other.to_d
-            else compare_to(other)
-            end
-          end
-
-          #
-          # Coerce objects into a DimmerItem
-          #
-          # @param [Object] other object to coerce to a DimmerItem if possible
-          #
-          # @return [Object] Numeric when applicable
-          #
-          def coerce(other)
-            logger.trace("Coercing #{self} as a request from  #{other.class}")
-            case other
-            when Numeric then [other, state.to_big_decimal.to_d]
-            else [other, state]
-            end
-          end
-
-          #
-          # Compare DimmerItem to supplied object.
-          # The == operator needs to be overridden because the parent java object
-          # has .equals which overrides the <=> operator above
-          #
-          # @param [Object] other object to compare to
-          #
-          # @return [Integer] true if the two objects contain the same value, false otherwise
-          #
-          def ==(other)
-            (self <=> other).zero?
-          end
-
-          #
-          # Define math operations
-          #
-          %i[+ - / *].each do |operator|
-            define_method(operator) do |other|
-              right, left = coerce(other)
-              left.send(operator, right)
-            end
-          end
-
-          #
-          # Check if dimmer has a state and state is not zero
-          #
-          # @return [Boolean] True if dimmer is not NULL or UNDEF and value is not 0
-          #
-          def truthy?
-            state? && state != DecimalType::ZERO
-          end
-
-          #
-          # Value of dimmer
-          #
-          # @return [Integer] Value of dimmer or nil if state is UNDEF or NULL
-          #
-          def to_i
-            state&.to_big_decimal&.intValue
-          end
-
-          alias to_int to_i
-        end
-      end
-    end
-  end
-end