openhab-scripting 2.26.1 → 2.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e85c64c68c9d566c3c4cf1070ea994fae3e3b57dda312c0854da87bff393ae1c
-  data.tar.gz: 9934d415111e5a680f1a8a7630ef1b08e0ed537cc537631100ee3dd73b1ce70d
+  metadata.gz: 2076584e55cc649fda227034943f6a412fb7a43a52479aec0ff3f33452266cc4
+  data.tar.gz: a7eb3154b9f436987883106bd39ab2a6574190abd2236d7c4898420624cbea87
 SHA512:
-  metadata.gz: dfe0d9a8e3ec9a4e4ed2121958d508f3ce0d552db041dbfa8099168f4e2963f5c823b68931a04a796d7311f138fcd64fd8733ad81ef859b7d8b751526e52cc1c
-  data.tar.gz: 440dd0f36d20abf8a27cab1b87f5f73c90c7b852ed7496fdfb2abd3f6d7e76add9fbf6f6c5ecccfad125a6e56182ba85839d2d14e218037d9ad073648226afe4
+  metadata.gz: 5e1923dd15436484c0bd72c9aa83ab4a72d554e7cc17c7d9c06e4eda0b335a13b283405acdf8282e75bb1488c245c890b9b7151c0de03f8316d6367ad7e5be6f
+  data.tar.gz: f7e218fbf8b28b27ef154bcfa42dc167f0cf4bede89fe4772489a4aa8cec77d9827be83d32e748b663876a5286649217322d840b638ea73a37200ef82cfe34a9

data/lib/openhab/core/entity_lookup.rb

@@ -87,25 +87,25 @@ module OpenHAB
       # @return [Object] the ruby wrapper for the item
       #
       # rubocop: disable Metrics/MethodLength
-      # 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
           decorate_group(item)
-        when Java::Org.openhab.core.library.items::NumberItem
+        when Java::OrgOpenhabCoreLibraryItems::NumberItem
           OpenHAB::DSL::Items::NumberItem.new(item)
-        when Java::Org.openhab.core.library.items::StringItem
+        when Java::OrgOpenhabCoreLibraryItems::StringItem
           OpenHAB::DSL::Items::StringItem.new(item)
-        when Java::Org.openhab.core.library.items::DateTimeItem
+        when Java::OrgOpenhabCoreLibraryItems::DateTimeItem
           OpenHAB::DSL::Items::DateTimeItem.new(item)
-        when Java::Org.openhab.core.library.items::RollershutterItem
+        when Java::OrgOpenhabCoreLibraryItems::RollershutterItem
           OpenHAB::DSL::Items::RollershutterItem.new(item)
+        when Java::OrgOpenhabCoreLibraryItems::PlayerItem
+          OpenHAB::DSL::Items::PlayerItem.new(item)
         else
           item
         end
       end
-      # rubocop: enable Metrics/AbcSize
       # rubocop: enable Metrics/MethodLength
 
       #

data/lib/openhab/dsl/dsl.rb

@@ -15,6 +15,7 @@ require 'openhab/dsl/things'
 require 'openhab/dsl/items/items'
 require 'openhab/dsl/items/datetime_item'
 require 'openhab/dsl/items/number_item'
+require 'openhab/dsl/items/player_item'
 require 'openhab/dsl/time_of_day'
 require 'openhab/dsl/gems'
 require 'openhab/dsl/persistence'

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'java'
+require 'openhab/log/logger'
 
 module OpenHAB
   module DSL
@@ -9,19 +10,25 @@ module OpenHAB
       # 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)
+        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.class}")
             define_method(command_method) do
               self.command(command)
             end
@@ -37,14 +44,17 @@ module OpenHAB
         #
         # @param [Java::JavaLang::Enum] command_enum Enumeration to create methods for each value
         #   to check if current state matches that enum
-        # @yield [state] Optional block that can be used to transform state prior to comparison
+        # @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)
+        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.class}")
             define_method(status_method) do
               state? && state.as(command_enum) == command
             end
@@ -57,14 +67,18 @@ module 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)
+        def item_type(item_class, methods = {})
           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) }
-          item_class.ACCEPTED_COMMAND_TYPES.select(&:is_enum).grep_v(UnDefType).each do |type|
-            item_command(type.ruby_class)
-          end
+          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 { |type| item_command(type.ruby_class, methods) }
         end
       end
     end

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

@@ -33,7 +33,7 @@ module OpenHAB
         alias key? include?
       end
 
-      java_import org.openhab.core.items.GroupItem
+      java_import Java::OrgOpenhabCoreItems::GroupItem
       # Fetches all non-group items from the item registry
       # @return [OpenHAB::DSL::Items::Items]
       def items

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'java'
+require 'openhab/dsl/items/item_command'
+require 'openhab/dsl/items/item_delegate'
+
+module OpenHAB
+  module DSL
+    module Items
+      #
+      # Delegator to OpenHAB Player Item
+      #
+      class PlayerItem
+        extend OpenHAB::DSL::Items::ItemCommand
+        extend OpenHAB::DSL::Items::ItemDelegate
+        extend Forwardable
+
+        def_item_delegator :@player_item
+
+        item_type Java::OrgOpenhabCoreLibraryItems::PlayerItem, play?: :playing?, pause?: :paused?,
+                                                                rewind?: :rewinding?, fastforward?: :fastforwarding?
+
+        # rubocop: disable Style/Alias
+        # Disabled because 'alias' does not work with the dynamically defined methods
+        alias_method :fast_forward, :fastforward
+        alias_method :fast_forwarding?, :fastforwarding?
+        # rubocop: enable Style/Alias
+
+        #
+        # Creates a new PlayerItem
+        #
+        # @param [Java::OrgOpenhabCoreLibraryItems::PlayerItem] player_item
+        #   The OpenHAB PlayerItem to delegate to
+        #
+        def initialize(player_item)
+          logger.trace("Wrapping #{player_item}")
+          @player_item = player_item
+
+          item_missing_delegate { @player_item }
+
+          super()
+        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.26.1'
+  VERSION = '2.27.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 2.26.1
+  version: 2.27.0
 platform: ruby
 authors:
 - Brian O'Connell
@@ -44,6 +44,7 @@ files:
 - lib/openhab/dsl/items/item_delegate.rb
 - lib/openhab/dsl/items/items.rb
 - lib/openhab/dsl/items/number_item.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/monkey_patch/actions/actions.rb