openhab-jrubyscripting 5.0.0.rc5 → 5.0.0.rc6

data/lib/openhab/rspec/helpers.rb

@@ -52,7 +52,7 @@ module OpenHAB
   module RSpec
     #
     # Provides helper methods for use in specs, to easily work with and adjust
-    # the OpenHAB environment.
+    # the openHAB environment.
     #
     # These methods are automatically available in RSpec spec blocks, as well
     # as other per-spec hooks like `before` and `after`. You can also call them
@@ -175,7 +175,7 @@ module OpenHAB
       end
 
       #
-      # Require all files configured to be autorequired with the jrubyscripting addon in OpenHAB.
+      # Require all files configured to be autorequired with the jrubyscripting addon in openHAB.
       #
       # This method is normally called by RSpec hooks.
       #
@@ -306,7 +306,7 @@ module OpenHAB
       end
 
       #
-      # Install an OpenHAB addon
+      # Install an openHAB addon
       #
       # @param [String] addon_id The addon id, such as "binding-mqtt"
       # @param [true,false] wait Wait until OSGi has confirmed the bundle is installed and running before returning.
@@ -348,7 +348,7 @@ module OpenHAB
         end
       end
 
-      # @return [String] The filename of the OpenHAB log.
+      # @return [String] The filename of the openHAB log.
       def log_file
         "#{java.lang.System.get_property("openhab.logdir", nil)}/openhab.log"
       end

data/lib/openhab/rspec/hooks.rb

@@ -3,7 +3,7 @@
 module OpenHAB
   #
   # This module contains helper methods, hooks, and infrastracture to
-  # boot OpenHAB inside of JRuby, and run RSpec (or other Ruby processes)
+  # boot openHAB inside of JRuby, and run RSpec (or other Ruby processes)
   # in that context.
   #
   # @see file:testing.md Testing Your Rules
@@ -11,6 +11,14 @@ module OpenHAB
   module RSpec
     Object.include Helpers if defined?(IRB)
 
+    # @!visibility private
+    module Hooks
+      class << self
+        attr_accessor :cache_script_extension
+      end
+      self.cache_script_extension = nil
+    end
+
     Helpers.launch_karaf(
       include_bindings: Configuration.include_bindings,
       include_jsondb: Configuration.include_jsondb,
@@ -28,6 +36,15 @@ module OpenHAB
           Helpers.send(:set_up_autoupdates)
           Helpers.load_transforms
           Helpers.load_rules
+
+          if DSL.shared_cache
+            Hooks.cache_script_extension = OSGi.service(
+              "org.openhab.core.automation.module.script.ScriptExtensionProvider",
+              filter:
+                "(component.name=org.openhab.core.automation.module.script.rulesupport.internal.CacheScriptExtension)"
+            )
+            Hooks.cache_script_extension.class.field_reader :sharedCache
+          end
         end
 
         config.before do
@@ -79,6 +96,7 @@ module OpenHAB
           Timecop.return
           restore_autoupdate_items
           Mocks::PersistenceService.instance.reset
+          Hooks.cache_script_extension.sharedCache.clear if DSL.shared_cache
         end
       end
     end

data/lib/openhab/rspec/karaf.rb

@@ -20,6 +20,14 @@ module OpenHAB
         def get(type)
           @manager.get(type, "jruby")
         end
+
+        def default_presets
+          @manager.default_presets
+        end
+
+        def import_preset(preset)
+          @manager.find_preset(preset, "rspec")
+        end
       end
       private_constant :ScriptExtensionManagerWrapper
 
@@ -73,7 +81,7 @@ module OpenHAB
         service = org.apache.karaf.instance.core.internal.InstanceServiceImpl.new
         settings = org.apache.karaf.instance.core.InstanceSettings.new(0, 0, 0, path, nil, nil, nil)
         root_instance = service.instances.find(&:root?)
-        raise ArgumentError "No root instance found to clone... has OpenHAB run yet?" unless root_instance
+        raise ArgumentError "No root instance found to clone... has openHAB run yet?" unless root_instance
 
         return if service.get_instance("rspec")
 
@@ -121,7 +129,7 @@ module OpenHAB
         launch_karaf
         at_exit do
           @main.destroy
-          # OSGi/OpenHAB leave a ton of threads around. Kill ourselves ASAP
+          # OSGi/openHAB leave a ton of threads around. Kill ourselves ASAP
           code = if $!.nil? || ($!.is_a?(SystemExit) && $!.success?)
                    0
                  elsif $!.is_a?(SystemExit)
@@ -566,21 +574,6 @@ module OpenHAB
         wait_for_service("org.openhab.core.automation.module.script.internal.ScriptExtensionManager") do |sem|
           # since we're not created by the ScriptEngineManager, this never gets set; manually set it
           $se = $scriptExtension = ScriptExtensionManagerWrapper.new(sem)
-          scope_values = sem.find_default_presets("rspec")
-          scope_values = scope_values.entry_set.to_a
-
-          scope_values.each do |entry|
-            key = entry.key
-            value = entry.value
-            # convert Java classes to Ruby classes
-            value = value.ruby_class if value.is_a?(java.lang.Class) # rubocop:disable Lint/UselessAssignment
-            # variables are globals; constants go into the global namespace
-            key = case key[0]
-                  when "a".."z" then "$#{key}"
-                  when "A".."Z" then "::#{key}"
-                  end
-            eval("#{key} = value unless defined?(#{key})", nil, __FILE__, __LINE__) # rubocop:disable Security/Eval
-          end
         end
       end
 
@@ -731,7 +724,7 @@ module OpenHAB
         sls = OSGi.service("org.openhab.core.service.StartLevelService")
 
         unless sls
-          # try a different (hacky!) way to get it, since in OpenHAB 3.2.0 it's not exposed as a service
+          # try a different (hacky!) way to get it, since in openHAB 3.2.0 it's not exposed as a service
           scr = OSGi.service("org.osgi.service.component.runtime.ServiceComponentRuntime")
           scr.class.field_reader :componentRegistry
           cr = scr.componentRegistry
@@ -771,7 +764,7 @@ module OpenHAB
         File.write("#{oh_userdata}/etc/org.apache.karaf.features.xml", <<~XML)
           <?xml version="1.0" encoding="UTF-8"?>
           <featuresProcessing xmlns="http://karaf.apache.org/xmlns/features-processing/v1.0.0" xmlns:f="http://karaf.apache.org/xmlns/features/v1.6.0">
-              <!-- From OpenHAB 3.2.0 -->
+              <!-- From openHAB 3.2.0 -->
               <bundleReplacements>
                 <bundle originalUri="mvn:org.ops4j.pax.logging/pax-logging-api/[0,2.0.13)" replacement="mvn:org.ops4j.pax.logging/pax-logging-api/2.0.13" mode="maven" />
                 <bundle originalUri="mvn:org.ops4j.pax.logging/pax-logging-log4j2/[0,2.0.13)" replacement="mvn:org.ops4j.pax.logging/pax-logging-log4j2/2.0.13" mode="maven" />

data/lib/openhab/rspec/suspend_rules.rb

@@ -18,7 +18,8 @@ module OpenHAB
             logger.trace { "Execute called with mod (#{mod&.to_string}) and inputs (#{inputs.inspect})" }
             logger.trace { "Event details #{inputs["event"].inspect}" } if inputs&.key?("event")
             trigger_conditions(inputs).process(mod: mod, inputs: inputs) do
-              process_queue(create_queue(inputs), mod, inputs)
+              event = extract_event(inputs)
+              process_queue(create_queue(event), mod, event)
             end
           rescue Exception => e
             raise if defined?(::RSpec) && ::RSpec.current_example.example_group.propagate_exceptions?

data/lib/openhab/yard/base_helper.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module OpenHAB
+  module YARD
+    # @!visibility private
+    module BaseHelper
+      def preprocess(text)
+        html = Nokogiri::HTML5.fragment(text)
+
+        context = if ENV["ADDON"]
+                    :addon
+                  else
+                    :yard
+                  end
+
+        # process directives on which content is supposed to be included in this context
+        node = html.children.first
+        loop do
+          break unless node
+
+          next_node = node.next
+
+          if node.comment? && (directive = MarkdownDirective.new(node)).directive?
+            next_node = directive.process(context) || next_node
+          end
+          node = next_node
+        end
+
+        html.to_s
+      end
+
+      def link_object(obj, title = nil, *)
+        ::YARD::Handlers::JRuby::Base.infer_java_class(obj) if obj.is_a?(String)
+        obj = ::YARD::Registry.resolve(object, obj, true, true) if obj.is_a?(String)
+        if obj.is_a?(::YARD::CodeObjects::Java::Base) && (see = obj.docstring.tag(:see))
+          # link to the first see tag
+          return linkify(see.name, title&.to_s || see.text)
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/openhab/yard/markdown_directive.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module OpenHAB
+  module YARD
+    # @!visibility private
+    class MarkdownDirective
+      attr_reader :comment, :context
+
+      def initialize(comment)
+        @comment = comment
+        @lines = comment.text.split("\n")
+        directive_text = @lines.first.strip
+
+        @multiline = @lines.length > 1
+        @directive = false
+        return unless (match = directive_text.match(%r{^<(/)?(!)?([a-z]+)-only>$}))
+
+        @closing = match[1]
+        @context = match[3].to_sym
+        @inverted = match[2]
+
+        if closing? && multiline?
+          log.warn "In file `#{file}':#{line}: Multiline closing directives are not allowed (#{directive_text})."
+          return
+        end
+        @directive = true
+      end
+
+      def directive?
+        @directive
+      end
+
+      def multiline?
+        @multiline
+      end
+
+      def closing?
+        @closing
+      end
+
+      def inverted?
+        @inverted
+      end
+
+      def match?(context)
+        result = context == self.context
+        result = !result if inverted?
+        result
+      end
+
+      def closing_directive
+        return nil if multiline?
+
+        unless instance_variable_defined?(:@closing_directive)
+          next_node = @comment.next
+          loop do
+            return @closing_directive = nil unless next_node
+
+            if next_node.comment?
+              directive = MarkdownDirective.new(next_node)
+              if directive.directive? &&
+                 directive.closing? &&
+                 directive.context == context &&
+                 directive.inverted? == inverted?
+                return @closing_directive = next_node
+              end
+            end
+
+            next_node = next_node.next
+          end
+        end
+        @closing_directive
+      end
+
+      def process(context)
+        return unless directive?
+        return if closing?
+
+        matched = match?(context)
+
+        # if it's a matched multiline, extract the contents and insert them directly,
+        # and remove the comment
+        if multiline?
+          result = comment.next
+          comment.before(Nokogiri::HTML5.fragment(@lines[1..].join("\n"))) if matched
+          comment.remove
+          return result
+        end
+
+        unless closing_directive
+          log.warn "In file `#{file}':#{line}: Unmatched directive <#{"!" if inverted?}#{context}-only>."
+          return
+        end
+
+        result = closing_directive.next
+
+        unless matched
+          # remove all nodes between the opening and closing directives
+          comment.next.remove while comment.next != closing_directive
+        end
+        # now remove the directives themselves
+        closing_directive.remove
+        comment.remove
+        result
+      end
+
+      def file
+        ((defined?(@file) && @file) ? @file.filename : object.file) || "(unknown)"
+      end
+
+      def line
+        return @line if instance_variable_defined?(@line)
+
+        @line = (if defined?(@file) && @file
+                   1
+                 else
+                   (object.docstring.line_range ? object.docstring.line_range.first : 1)
+                 end) + (match ? $`.count("\n") : 0)
+        @line += comment.line - 1
+      end
+    end
+  end
+end

data/lib/openhab/yard/markdown_helper.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module OpenHAB
+  module YARD
+    # @!visibility private
+    module MarkdownHelper
+      # @group Linking Objects and URLs
+
+      def diskfile
+        preprocess(super)
+      end
+
+      # mostly copied from HTMLHelper
+      def resolve_links(text)
+        blockquotes = false
+        text.gsub(%r{(```)|(\\|!)?\{(?!\})(\S+?)(?:\s([^\}]*?\S))?\}(?=[\W<]|.+</|$)}m) do |str|
+          blockquote = $1
+          escape = $2
+          name = $3
+          title = $4
+          match = $&
+          if blockquote
+            blockquotes = !blockquotes
+            next str
+          end
+          next str if blockquotes
+
+          next(match[1..-1]) if escape
+
+          next(match) if name[0, 1] == '|'
+
+          if object.is_a?(String)
+            object
+          else
+            link = linkify(name, title)
+            if (link == name || link == title) && (name + ' ' + link !~ /\A<a\s.*>/)
+              match = /(.+)?(\{#{Regexp.quote name}(?:\s.*?)?\})(.+)?/.match(text)
+              file = (defined?(@file) && @file ? @file.filename : object.file) || '(unknown)'
+              line = (defined?(@file) && @file ? 1 : (object.docstring.line_range ? object.docstring.line_range.first : 1)) + (match ? $`.count("\n") : 0)
+              log.warn "In file `#{file}':#{line}: Cannot resolve link to #{name} from text" + (match ? ":" : ".") +
+                       "\n\t" + (match[1] ? '...' : '') + match[2].delete("\n") + (match[3] ? '...' : '') if match
+            end
+
+            link
+          end
+        end
+      end
+
+      # mostly copied from HTMLHelper
+      def link_object(obj, title = nil, anchor = nil, relative = true)
+        return title if obj.nil?
+
+        obj = Registry.resolve(object, obj, true, true) if obj.is_a?(String)
+
+        was_const = false
+        # Re-link references to constants that are aliases to their target. But keep
+        # their current title.
+        while obj.is_a?(CodeObjects::ConstantObject) && obj.target
+          title ||= h(object.relative_path(obj)).to_s
+          was_const = true
+          obj = obj.target
+        end
+        return link_object(obj, title, anchor, relative) if was_const
+
+        title = if title
+                  title.to_s
+                elsif object.is_a?(CodeObjects::Base)
+                  # Check if we're linking to a class method in the current
+                  # object. If we are, create a title in the format of
+                  # "CurrentClass.method_name"
+                  if obj.is_a?(CodeObjects::MethodObject) && obj.scope == :class && obj.parent == object
+                    h([object.name, obj.sep, obj.name].join)
+                  elsif obj.title != obj.path
+                    h(obj.title)
+                  else
+                    h(object.relative_path(obj))
+                  end
+                else
+                  h(obj.title)
+                end
+        return title unless serializer
+        return title if obj.is_a?(CodeObjects::Proxy)
+
+        link = url_for(obj, anchor, relative)
+        link ? link_url(link, title, title: h("#{obj.title} (#{obj.type})")) : title
+      rescue Parser::UndocumentableError
+        log.warn "The namespace of link #{obj.inspect} is a constant or invalid."
+        title || obj.to_s
+      end
+
+      def link_url(url, title = nil, _params = nil)
+        title ||= url
+        "[#{title}](#{url})"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-jrubyscripting
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc5
+  version: 5.0.0.rc6
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-29 00:00:00.000000000 Z
+date: 2022-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -327,6 +327,7 @@ extra_rdoc_files: []
 files:
 - lib/openhab/core.rb
 - lib/openhab/core/actions.rb
+- lib/openhab/core/dependency_tracking.rb
 - lib/openhab/core/entity_lookup.rb
 - lib/openhab/core/events.rb
 - lib/openhab/core/events/abstract_event.rb
@@ -346,6 +347,7 @@ files:
 - lib/openhab/core/items/generic_item.rb
 - lib/openhab/core/items/group_item.rb
 - lib/openhab/core/items/image_item.rb
+- lib/openhab/core/items/item.rb
 - lib/openhab/core/items/location_item.rb
 - lib/openhab/core/items/metadata.rb
 - lib/openhab/core/items/metadata/hash.rb
@@ -408,6 +410,7 @@ files:
 - lib/openhab/core/types/un_def_type.rb
 - lib/openhab/core/types/up_down_type.rb
 - lib/openhab/core/uid.rb
+- lib/openhab/core/value_cache.rb
 - lib/openhab/core_ext.rb
 - lib/openhab/core_ext/between.rb
 - lib/openhab/core_ext/java/class.rb
@@ -429,6 +432,7 @@ files:
 - lib/openhab/core_ext/ruby/date_time.rb
 - lib/openhab/core_ext/ruby/numeric.rb
 - lib/openhab/core_ext/ruby/range.rb
+- lib/openhab/core_ext/ruby/symbol.rb
 - lib/openhab/core_ext/ruby/time.rb
 - lib/openhab/dsl.rb
 - lib/openhab/dsl/events.rb
@@ -484,6 +488,7 @@ files:
 - lib/openhab/rspec/shell.rb
 - lib/openhab/rspec/suspend_rules.rb
 - lib/openhab/yard.rb
+- lib/openhab/yard/base_helper.rb
 - lib/openhab/yard/cli/stats.rb
 - lib/openhab/yard/code_objects/group_object.rb
 - lib/openhab/yard/code_objects/java/base.rb
@@ -498,6 +503,8 @@ files:
 - lib/openhab/yard/handlers/jruby/java_import_handler.rb
 - lib/openhab/yard/handlers/jruby/mixin_handler.rb
 - lib/openhab/yard/html_helper.rb
+- lib/openhab/yard/markdown_directive.rb
+- lib/openhab/yard/markdown_helper.rb
 - lib/openhab/yard/tags/constant_directive.rb
 - lib/openhab/yard/tags/group_directive.rb
 - lib/openhab/yard/tags/library.rb
@@ -528,5 +535,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
-summary: JRuby Helper Libraries for OpenHAB Scripting
+summary: JRuby Helper Libraries for openHAB Scripting
 test_files: []