openhab-scripting 4.1.1 → 4.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2210f9eb88b639bd2ca594cce368ec87ee7746595f7b2f9c04e7bd1ebdf10fc3
-  data.tar.gz: 9dae7f3f53574ba089c37c52e35e110c596a09deb3005ced5a267d18d64b1f3b
+  metadata.gz: 4d752e22ac324370b7c63e7e38455cd919f3f64abece0fc7ab62fd29c72953b7
+  data.tar.gz: 34c7cd408a075c831e7ea75e55f907bd57203268da81f34e318657d18ad6a90f
 SHA512:
-  metadata.gz: be659fbac0f529674ffb4a38944e1f2365fa82a08bbc832edb0ad3a5f074ec683454980050758ba6810b52abaf42d8ab8f442d73276de4fe38d51a8984e7b61a
-  data.tar.gz: a58d4df593b831c3daf979b2d0094691e22d2be849a375c9bf7c0a30d78e9e4d71d36adfa85d918debd1a8e948ec9b6d7b57e933f9eb791cf9d769ee5ce02193
+  metadata.gz: bc29460c4a427f81fa6a8ce0760d746d0bf1513574e72f89a17c4d5647c22dc860abe12c60d4a0904f5c32927725bed03ff8ff62212bd45217e05d9b9e3fe01a
+  data.tar.gz: b29f6d50649f32134815cb71b9c2d42b466f9d0147a613bbc2225f99469f5c5d4194a7a5c47f81c20757b149c2e5bcc7133fc6b099025f43132ecef25bb2cfc2

data/lib/openhab/dsl/group.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
-require 'delegate'
-require 'forwardable'
+require 'java'
+require 'singleton'
+
 require 'openhab/core/entity_lookup'
 require 'openhab/dsl/items/group_item'
+require 'openhab/dsl/lazy_array'
 
 module OpenHAB
   module DSL
@@ -14,16 +16,27 @@ module OpenHAB
       #
       # Provide access to groups as a set
       #
-      class Groups < SimpleDelegator
+      class Groups
+        include LazyArray
+        include Singleton
+
         #
         # Get a OpenHAB Group by name
         # @param [String] name of the group to retrieve
         #
         # @return [Set] of OpenHAB Groups
         #
-        def[](name)
-          group = OpenHAB::Core::EntityLookup.lookup_item(name)
-          group.is_a?(OpenHAB::DSL::Items::GroupItem) ? group : nil
+        def [](name)
+          group = Core::EntityLookup.lookup_item(name)
+          group.is_a?(Items::GroupItem) ? group : nil
+        end
+        alias include? []
+        alias key? include?
+
+        # explicit conversion to array
+        def to_a
+          items = $ir.items.grep(org.openhab.core.items.GroupItem) # rubocop:disable Style/GlobalVars
+          Core::EntityLookup.decorate_items(items)
         end
       end
 
@@ -33,9 +46,7 @@ module OpenHAB
       # @return [Set] of OpenHAB Groups
       #
       def groups
-        # rubocop: disable Style/GlobalVars
-        Groups.new(OpenHAB::Core::EntityLookup.decorate_items($ir.items.grep(Java::OrgOpenhabCoreItems::GroupItem)))
-        # rubocop: enable Style/GlobalVars
+        Groups.instance
       end
     end
   end

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

@@ -3,9 +3,11 @@
 require 'delegate'
 require 'forwardable'
 require 'java'
+
+require 'openhab/core/entity_lookup'
 require 'openhab/dsl/items/item_command'
 require 'openhab/dsl/items/item_delegate'
-require 'openhab/core/entity_lookup'
+require 'openhab/dsl/lazy_array'
 
 module OpenHAB
   module DSL
@@ -14,7 +16,7 @@ module OpenHAB
       # Class for indicating to triggers that a group trigger should be used
       #
       class GroupMembers
-        include Enumerable
+        include LazyArray
 
         attr_reader :group
 
@@ -27,22 +29,10 @@ module OpenHAB
           @group = group_item
         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
 
       #

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

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require 'java'
-require 'openhab/core/entity_lookup'
 require 'singleton'
 
+require 'openhab/core/entity_lookup'
+require 'openhab/dsl/lazy_array'
+
 module OpenHAB
   module DSL
     #
@@ -14,7 +16,7 @@ module OpenHAB
       # Delegates to underlying set of all OpenHAB Items, provides convenience methods
       #
       class Items
-        include Enumerable
+        include LazyArray
         include Singleton
 
         # Fetches the named item from the the ItemRegistry
@@ -32,27 +34,13 @@ module OpenHAB
         def include?(name)
           !$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
+        alias key? []
 
         # 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
+          items = $ir.items.grep_v(org.openhab.core.items.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

data/lib/openhab/dsl/lazy_array.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module DSL
+    # common base class for array-like collections that have lookup
+    # methods to avoid instantiating the elements if you only use
+    # the lookup method
+    #
+    # your class should implement to_a
+    #
+    module LazyArray
+      include Enumerable
+
+      # 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)
+        to_a.each(&block)
+        self
+      end
+
+      # implicitly convertible to array
+      def to_ary
+        to_a
+      end
+
+      # delegate any other methods to the actual array
+      # exclude mutating methods though
+      def method_missing(method, *args, &block)
+        return to_a.send(method, *args, &block) if method[-1] != '!' && Array.instance_methods.include?(method)
+
+        super
+      end
+
+      # advertise that methods exist that would be delegated to Array
+      def respond_to_missing?(method, include_private = false)
+        return true if method[-1] != '!' && Array.instance_methods.include?(method.to_sym)
+
+        super
+      end
+    end
+  end
+end

data/lib/openhab/dsl/things.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
+require 'delegate'
 require 'java'
+require 'singleton'
+
 require 'openhab/log/logger'
 require 'openhab/dsl/actions'
-require 'delegate'
-require 'singleton'
+require 'openhab/dsl/lazy_array'
 
 module OpenHAB
   module DSL
@@ -78,44 +80,26 @@ module OpenHAB
       # Wraps all Things in a delegator to underlying set and provides lookup method
       #
       class Things
-        java_import org.openhab.core.thing.ThingUID
-
-        include Enumerable
+        include LazyArray
         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)
-          thing_uid = ThingUID.new(*uid.split(':'))
+          thing_uid = org.openhab.core.thing.ThingUID.new(*uid.split(':'))
           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
 
       #

data/lib/openhab/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-scripting
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.1.2
 platform: ruby
 authors:
 - Brian O'Connell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-07 00:00:00.000000000 Z
+date: 2021-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,6 +64,7 @@ files:
 - lib/openhab/dsl/items/player_item.rb
 - lib/openhab/dsl/items/rollershutter_item.rb
 - lib/openhab/dsl/items/string_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
 - lib/openhab/dsl/monkey_patch/events/events.rb