openhab-scripting 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf75e647f468a653d6848739cf2552ba57b9d1b1d81f33eed2f3719315d28d11
-  data.tar.gz: 8f6403a4642e1edd1eb3047d438939b5d127c0fd0eca57c8989e9a72bf0bdb39
+  metadata.gz: 4028b9fda2ff3ffa7005f730d7b876e136cf4c3dacc66f0f8950077c4a8f5ab9
+  data.tar.gz: dc819dea7d3f573299934da843ddadc597f98f59165426e6c88e321a1fd93200
 SHA512:
-  metadata.gz: 9e0ea6a8962334965162c95ff2db82a3fcf0485c6b80fefd2ea0814d0883678052bd52306093ea70e2cb0aec9e3fb8df42fd9290f9b9b21ddfb71db11649f104
-  data.tar.gz: 4d492998dd50c6b25fd845df988d7ef418e5d2a8a66c339bf5fabf990cd6380d6a588ee6fc899d47d697564b78c88397a77d362a39da0a6d7f9d7ba3c99d4c71
+  metadata.gz: 2839736ff1c0d15c6622e679e7ada29d6f34afe5bae7d9fa375ebe34e809b14eb0f54b447d95ff7548b3f97786f0c7f6f979cd8ce796fa84bdbb1b60312a7e73
+  data.tar.gz: 45b0ca416f63b8971fdd4f7ee7d86c449ac44b0d0acdf6a1ce6955d604c04bf12788900a180fde7ec49d9fafe8aa5a5b6a8d4271cc5a72ab4440ddbe9e7a2b8a

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

@@ -13,7 +13,9 @@ module OpenHAB
       #
       # Class for indicating to triggers that a group trigger should be used
       #
-      class GroupMembers < SimpleDelegator
+      class GroupMembers
+        include Enumerable
+
         attr_reader :group
 
         #
@@ -23,8 +25,24 @@ module OpenHAB
         #
         def initialize(group_item)
           @group = group_item
-          super(OpenHAB::Core::EntityLookup.decorate_items(@group.members.to_a))
         end
+
+        # Calls the given block once for each group member, passing that
+        # item as a parameter. Returns self.
+        #
+        # If no block is given, an Enumerator is returned.
+        def each(&block)
+          to_a.each(&block)
+          self
+        end
+
+        # explicit conversion to array
+        # more efficient than letting Enumerable do it
+        def to_a
+          OpenHAB::Core::EntityLookup.decorate_items(group.members.to_a)
+        end
+        # implicitly convertible to array
+        alias to_ary to_a
       end
 
       #
@@ -74,7 +92,7 @@ module OpenHAB
         # Iterates through the direct members of the Group
         #
         def each(&block)
-          OpenHAB::Core::EntityLookup.decorate_items(@group_item.members.to_a).each(&block)
+          members.each(&block)
         end
 
         #

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

@@ -2,6 +2,7 @@
 
 require 'java'
 require 'openhab/core/entity_lookup'
+require 'singleton'
 
 module OpenHAB
   module DSL
@@ -12,11 +13,14 @@ module OpenHAB
       #
       # Delegates to underlying set of all OpenHAB Items, provides convenience methods
       #
-      class Items < SimpleDelegator
+      class Items
+        include Enumerable
+        include Singleton
+
         # Fetches the named item from the the ItemRegistry
         # @param [String] name
         # @return Item from registry, nil if item missing or requested item is a Group Type
-        def[](name)
+        def [](name)
           OpenHAB::Core::EntityLookup.lookup_item(name)
         rescue Java::OrgOpenhabCoreItems::ItemNotFoundException
           nil
@@ -26,19 +30,35 @@ module OpenHAB
         # @param name [String] Item name to check
         # @return [Boolean] true if the item exists, false otherwise
         def include?(name)
-          # rubocop: disable Style/GlobalVars
-          !$ir.getItems(name).empty?
-          # rubocop: enable Style/GlobalVars
+          !$ir.getItems(name).empty? # rubocop: disable Style/GlobalVars
         end
         alias key? include?
+
+        # Calls the given block once for each Item, passing that Item as a
+        # parameter. Returns self.
+        #
+        # If no block is given, an Enumerator is returned.
+        def each(&block)
+          # ideally we would do this lazily, but until ruby 2.7
+          # there's no #eager method to convert back to a non-lazy
+          # enumerator
+          to_a.each(&block)
+        end
+
+        # explicit conversion to array
+        # more efficient than letting Enumerable do it
+        def to_a
+          items = $ir.items.grep_v(Java::OrgOpenhabCoreItems::GroupItem) # rubocop:disable Style/GlobalVars
+          OpenHAB::Core::EntityLookup.decorate_items(items)
+        end
+        # implicitly convertible to array
+        alias to_ary to_a
       end
 
       # Fetches all non-group items from the item registry
       # @return [OpenHAB::DSL::Items::Items]
       def items
-        # rubocop: disable Style/GlobalVars
-        Items.new(OpenHAB::Core::EntityLookup.decorate_items($ir.items.grep_v(Java::OrgOpenhabCoreItems::GroupItem)))
-        # rubocop: enable Style/GlobalVars
+        Items.instance
       end
     end
   end

data/lib/openhab/dsl/rules/triggers/command.rb

@@ -22,7 +22,7 @@ module OpenHAB
         #
         #
         def received_command(*items, command: nil, commands: nil)
-          separate_groups(items).flatten.each do |item|
+          separate_groups(items).each do |item|
             logger.trace("Creating received command trigger for item(#{item})"\
                          "command(#{command}) commands(#{commands})")
 

data/lib/openhab/dsl/rules/triggers/trigger.rb

@@ -61,9 +61,13 @@ module OpenHAB
         # @return [Array] A new flat array with any GroupMembers object left intact
         #
         def separate_groups(item_array)
-          return item_array if item_array.grep(Array).length.zero?
+          # we want to support anything that can be flattened... i.e. responds to to_ary
+          # we want to be more lenient than only things that are currently Array,
+          # but Enumerable is too lenient because Array#flatten won't traverse interior
+          # Enumerables
+          return item_array unless item_array.find { |item| item.respond_to?(:to_ary) }
 
-          groups, items = item_array.partition { |item| item.is_a? OpenHAB::DSL::Items::GroupItem::GroupMembers }
+          groups, items = item_array.partition { |item| item.is_a?(OpenHAB::DSL::Items::GroupItem::GroupMembers) }
           groups + separate_groups(items.flatten(1))
         end
 

data/lib/openhab/dsl/rules/triggers/updated.rb

@@ -20,7 +20,7 @@ module OpenHAB
         # @return [Trigger] Trigger for updated entity
         #
         def updated(*items, to: nil)
-          separate_groups(items).flatten.each do |item|
+          separate_groups(items).each do |item|
             logger.trace("Creating updated trigger for item(#{item}) to(#{to})")
             [to].flatten.each do |to_state|
               trigger, config = create_update_trigger(item, to_state)

data/lib/openhab/dsl/things.rb

@@ -4,6 +4,7 @@ require 'java'
 require 'openhab/log/logger'
 require 'openhab/dsl/actions'
 require 'delegate'
+require 'singleton'
 
 module OpenHAB
   module DSL
@@ -76,32 +77,54 @@ module OpenHAB
       #
       # Wraps all Things in a delegator to underlying set and provides lookup method
       #
-      class Things < SimpleDelegator
+      class Things
         java_import org.openhab.core.thing.ThingUID
 
+        include Enumerable
+        include Singleton
+
         # Gets a specific thing by name in the format binding_id:type_id:thing_id
         # @return Thing specified by name or nil if name does not exist in thing registry
-        def[](uid)
+        def [](uid)
           thing_uid = ThingUID.new(*uid.split(':'))
-          # rubocop: disable Style/GlobalVars
-          thing = $things.get(thing_uid)
-          # rubocop: enable Style/GlobalVars
+          thing = $things.get(thing_uid) # rubocop: disable Style/GlobalVars
           return unless thing
 
           logger.trace("Retrieved Thing(#{thing}) from registry for uid: #{uid}")
           Thing.new(thing)
         end
+
+        alias include? []
+        alias key? []
+
+        # Calls the given block once for each Thing, passing that Thing as a
+        # parameter. Returns self.
+        #
+        # If no block is given, an Enumerator is returned.
+        def each(&block)
+          # ideally we would do this lazily, but until ruby 2.7
+          # there's no #eager method to convert back to a non-lazy
+          # enumerator
+          to_a.each(&block)
+          self
+        end
+
+        # explicit conversion to array
+        # more efficient than letting Enumerable do it
+        def to_a
+          $things.getAll.map { |thing| Thing.new(thing) } # rubocop: disable Style/GlobalVars
+        end
+        # implicitly convertible to array
+        alias to_ary to_a
       end
 
       #
       # Get all things known to OpenHAB
       #
-      # @return [Set] of all Thing objects known to openhab
+      # @return [Things] all Thing objects known to OpenHAB
       #
       def things
-        # rubocop: disable Style/GlobalVars
-        Things.new($things.getAll.map { |thing| Thing.new(thing) }.to_set)
-        # rubocop: enable Style/GlobalVars
+        Things.instance
       end
     end
   end

data/lib/openhab/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Brian O'Connell