openhab-jrubyscripting 5.0.0.rc9 → 5.0.0.rc11

data/lib/openhab/yard/markdown_helper.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module OpenHAB
+  module YARD
+    # @!visibility private
+    module MarkdownHelper
+      include ::YARD::Templates::Helpers::HtmlHelper
+      # @group Linking Objects and URLs
+
+      def diskfile
+        resolve_links(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..]) 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 = (if defined?(@file) && @file
+                        1
+                      else
+                        (object.docstring.line_range ? object.docstring.line_range.first : 1)
+                      end) + (match ? $`.count("\n") : 0)
+              if match
+                log.warn "In file `#{file}':#{line}: Cannot resolve link to #{name} from text#{match ? ":" : "."}\n" \
+                         "\t#{match[1] ? "..." : ""}#{match[2].delete("\n")}#{match[3] ? "..." : ""}"
+              end
+            end
+
+            link
+          end
+        end
+      end
+
+      # mostly copied from HTMLHelper
+      def link_object(obj, title = nil, anchor = nil, relative = true) # rubocop:disable Style/OptionalBooleanParameter
+        return title if obj.nil?
+
+        obj = ::YARD::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?(::YARD::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?(::YARD::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?(::YARD::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?(::YARD::CodeObjects::Proxy)
+
+        link = url_for(obj, anchor, relative)
+        link ? link_url(link, title, title: h("#{obj.title} (#{obj.type})")) : title
+      rescue ::YARD::Parser::UndocumentableError
+        log.warn "The namespace of link #{obj.inspect} is a constant or invalid."
+        title || obj.to_s
+      end
+
+      def url_for(obj, anchor = nil, relative = true) # rubocop:disable Style/OptionalBooleanParameter
+        link = nil
+        return link unless serializer
+        return link if obj.is_a?(::YARD::CodeObjects::Base) && run_verifier([obj]).empty?
+
+        if obj.is_a?(::YARD::CodeObjects::Base) && !obj.is_a?(::YARD::CodeObjects::NamespaceObject)
+          # If the obj is not a namespace obj make it the anchor.
+          anchor = obj
+          obj = obj.namespace
+        end
+
+        objpath = serializer.serialized_path(obj)
+        return link unless objpath
+
+        relative = false if object == ::YARD::Registry.root
+        if relative
+          fromobj = object
+          if object.is_a?(::YARD::CodeObjects::Base) &&
+             !object.is_a?(::YARD::CodeObjects::NamespaceObject)
+            fromobj = owner
+          end
+
+          from = serializer.serialized_path(fromobj)
+          link = File.relative_path(from, objpath)
+        else
+          link = File.join(serializer.basepath, objpath)
+        end
+
+        link + (anchor ? "##{urlencode(anchor_for(anchor))}" : "")
+      end
+
+      def link_url(url, title = nil, _params = nil)
+        title ||= url
+        "[#{title}](#{url})"
+      end
+    end
+  end
+end

data/lib/openhab/yard.rb

@@ -6,10 +6,16 @@ Dir[File.expand_path("yard/**/*.rb", __dir__)].sort.each do |f|
   require f
 end
 
+YARD::Templates::Template.extra_includes << OpenHAB::YARD::BaseHelper
+YARD::Templates::Template.extra_includes << ->(opts) { OpenHAB::YARD::CodeRay::HtmlHelper if opts.format == :html }
 YARD::Templates::Template.extra_includes << ->(opts) { OpenHAB::YARD::HtmlHelper if opts.format == :html }
+YARD::Templates::Template.extra_includes << ->(opts) { OpenHAB::YARD::MarkdownHelper if opts.format == :markdown }
+
 YARD::Templates::Engine.register_template_path File.expand_path("../../templates", __dir__)
 YARD::Tags::Library.define_tag "Java Interface", :interface
 
+YARD::Server.register_static_path(".")
+
 #
 # @!parse
 #   # @!visibility private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openhab-jrubyscripting
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc9
+  version: 5.0.0.rc11
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-06 00:00:00.000000000 Z
+date: 2022-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.9
 - !ruby/object:Gem::Dependency
   name: persistent_httparty
   requirement: !ruby/object:Gem::Requirement
@@ -327,16 +341,26 @@ extra_rdoc_files: []
 files:
 - lib/openhab/core.rb
 - lib/openhab/core/actions.rb
+- lib/openhab/core/actions/audio.rb
+- lib/openhab/core/actions/ephemeris.rb
+- lib/openhab/core/actions/exec.rb
+- lib/openhab/core/actions/http.rb
+- lib/openhab/core/actions/ping.rb
+- lib/openhab/core/actions/transformation.rb
+- lib/openhab/core/actions/voice.rb
 - lib/openhab/core/dependency_tracking.rb
+- lib/openhab/core/dto.rb
+- lib/openhab/core/dto/item_channel_link.rb
+- lib/openhab/core/dto/thing.rb
 - lib/openhab/core/entity_lookup.rb
 - lib/openhab/core/events.rb
 - lib/openhab/core/events/abstract_event.rb
-- lib/openhab/core/events/item_channel_link.rb
+- lib/openhab/core/events/abstract_item_registry_event.rb
+- lib/openhab/core/events/abstract_thing_registry_event.rb
 - lib/openhab/core/events/item_command_event.rb
 - lib/openhab/core/events/item_event.rb
 - lib/openhab/core/events/item_state_changed_event.rb
 - lib/openhab/core/events/item_state_event.rb
-- lib/openhab/core/events/thing.rb
 - lib/openhab/core/events/thing_status_info_event.rb
 - lib/openhab/core/items.rb
 - lib/openhab/core/items/accepted_data_types.rb
@@ -369,6 +393,7 @@ files:
 - lib/openhab/core/lazy_array.rb
 - lib/openhab/core/profile_factory.rb
 - lib/openhab/core/provider.rb
+- lib/openhab/core/proxy.rb
 - lib/openhab/core/registry.rb
 - lib/openhab/core/rules.rb
 - lib/openhab/core/rules/module.rb
@@ -413,6 +438,7 @@ files:
 - lib/openhab/core/value_cache.rb
 - lib/openhab/core_ext.rb
 - lib/openhab/core_ext/between.rb
+- lib/openhab/core_ext/ephemeris.rb
 - lib/openhab/core_ext/java/class.rb
 - lib/openhab/core_ext/java/duration.rb
 - lib/openhab/core_ext/java/list.rb
@@ -435,6 +461,7 @@ files:
 - lib/openhab/core_ext/ruby/symbol.rb
 - lib/openhab/core_ext/ruby/time.rb
 - lib/openhab/dsl.rb
+- lib/openhab/dsl/debouncer.rb
 - lib/openhab/dsl/events.rb
 - lib/openhab/dsl/events/watch_event.rb
 - lib/openhab/dsl/gems.rb
@@ -477,8 +504,10 @@ files:
 - lib/openhab/rspec/mocks/bundle_install_support.rb
 - lib/openhab/rspec/mocks/bundle_resolver.rb
 - lib/openhab/rspec/mocks/event_admin.rb
+- lib/openhab/rspec/mocks/instance_method_stasher.rb
 - lib/openhab/rspec/mocks/persistence_service.rb
 - lib/openhab/rspec/mocks/safe_caller.rb
+- lib/openhab/rspec/mocks/space.rb
 - lib/openhab/rspec/mocks/synchronous_executor.rb
 - lib/openhab/rspec/mocks/thing_handler.rb
 - lib/openhab/rspec/mocks/timer.rb
@@ -488,6 +517,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
@@ -496,12 +526,14 @@ files:
 - lib/openhab/yard/code_objects/java/interface_object.rb
 - lib/openhab/yard/code_objects/java/package_object.rb
 - lib/openhab/yard/code_objects/java/proxy.rb
+- lib/openhab/yard/coderay.rb
 - lib/openhab/yard/handlers/jruby/base.rb
 - lib/openhab/yard/handlers/jruby/class_handler.rb
 - lib/openhab/yard/handlers/jruby/constant_handler.rb
 - 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_helper.rb
 - lib/openhab/yard/tags/constant_directive.rb
 - lib/openhab/yard/tags/group_directive.rb
 - lib/openhab/yard/tags/library.rb