yard-aggredator 0.9.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2329a8840dfbf9198aa25a5df489948156b7dbdbb4b84ee162ad6587dc40fbb9
+  data.tar.gz: 29fc1c6f471c11aa96ba7b1bb511c0055d3cee540e759e2b84a7d5b5dfa18d04
+SHA512:
+  metadata.gz: e23f535d3f9904679d4afdd5fe4ed712585b68cf099cb778e88aaad8f12e07c63e32e3eea5a0eb67c1c326276cb2507c05b250288bdd99d82d9137e03006f081
+  data.tar.gz: 6df5884a9b8351aefeec9ccd13df5533186d3510950977c9f30bb74ae078bc40e843cf128f95327d10648f085710a4713280afc5b3e545352c99e3b9d7d7d9e1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ivan Godko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/yard/aggredator/plugin.rb

@@ -0,0 +1,146 @@
+require 'json'
+require 'coderay'
+
+YARD::Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS[:plain] = []
+YARD::Templates::Helpers::MarkupHelper::MARKUP_EXTENSIONS[:plain] = %w[json txt text mermaid]
+
+module YARD
+  module Aggredator
+    module Helper
+      def htmlify(text, markup = options.markup)
+        detected_markup = plain_detect_markup(@current_linking_file || @file&.filename, markup)
+
+        return super if detected_markup == :markdown
+
+        if (detected_markup || %i[plain text
+                                  mermaid].include?(markup)) && text && respond_to?(:plain_pretty_include)
+          return plain_pretty_include(text, detected_markup, markup)
+        end
+
+        super
+      end
+
+      def plain_detect_markup(file, markup)
+        return nil unless file
+
+        case File.extname(file).downcase
+        when '.json'
+          :json
+        when '.txt', '.text', '.csv'
+          :text
+        when '.mermaid'
+          :mermaid
+        else
+          markup.to_sym
+        end
+      end
+
+      def html_syntax_highlight_mermaid(source)
+        # html="
+        #   <script type=\"module\">
+        #     import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
+        #     mermaid.initialize({ startOnLoad: false });
+        #     window.onload = function(){mermaid.init()};
+        #   </script><pre class=\"mermaid\">#{source}</pre>
+        #   "
+        "<pre class=\"mermaid\">#{source}</pre>"
+      end
+
+      def plain_pretty_include(text, detected_markup, markup)
+        markup = detected_markup || markup
+
+        pretty = case markup
+                 when :json
+                   begin
+                     JSON.pretty_generate(JSON.parse(text))
+                   rescue StandardError
+                     text
+                   end
+                 else
+                   text
+                 end
+
+        # html = "<pre>#{pretty}</pre>"
+        html = "<pre>\t!!!#{markup}\n#{pretty}</pre>"
+        if @file
+          # we are inside server layout rendering
+          parse_codeblocks(html)
+        else
+          html
+        end
+      end
+
+      def parse_codeblocks(html)
+        html.gsub(%r{<pre((?:\s+\w+="(?:.+?)")*)\s*>(?:\s*<code((?:\s+\w+="(?:.+?)")*)\s*>)?(.+?)(?:</code>\s*)?</pre>}m) do
+          string = ::Regexp.last_match(3)
+
+          # handle !!!LANG prefix to send to html_syntax_highlight_LANG
+          language, = parse_lang_for_codeblock(string)
+          language ||= detect_lang_in_codeblock_attributes(::Regexp.last_match(1), ::Regexp.last_match(2))
+          language ||= object.source_type
+
+          string = html_syntax_highlight(CGI.unescapeHTML(string), language) if options.highlight
+
+          if language == 'mermaid'
+            string
+          else
+            classes = ['code', language].compact.join(' ')
+            %(<pre class="#{classes}"><code class="#{language}">#{string}</code></pre>)
+          end
+        end
+      end
+
+      def link_include_file(file)
+        @current_linking_file = file
+        super
+      ensure
+        @current_linking_file = nil
+      end
+
+      def linkify(*args)
+        if args.first.is_a?(String) && /^link:file:(\S+)/.match(args.first)
+          file = ::Regexp.last_match(1)
+          relpath = File.relative_path(Dir.pwd, File.expand_path(file))
+          if serializer.class == YARD::Serializers::FileSystemSerializer
+            link_url(url_for(relpath), args[1])
+          else
+            link_file(relpath, args[1])
+          end
+        else
+          super
+        end
+      end
+
+      # Это рабочий код, но он меняет стандартное поведение
+      # def link_file(filename, title = nil, anchor = nil)
+      #   return super unless serializer.class == YARD::Serializers::FileSystemSerializer
+
+      #   if YARD::CodeObjects::ExtraFileObject === filename
+      #     file = filename
+      #   else
+      #     contents = File.file?(filename) ? nil : ''
+      #     relpath = File.relative_path(Dir.pwd, File.expand_path(filename))
+      #     file = YARD::CodeObjects::ExtraFileObject.new(filename, contents)
+      #     file.send(:ensure_parsed)
+      #     return link_url(url_for(relpath), title || file.title)
+      #   end
+
+      #   super
+      # end
+    end
+  end
+
+  module ExtraFileObjectPatch
+    def initialize(*args)
+      super
+      dirname = File.dirname(filename).strip.gsub('/', '_')
+      return unless !['', '.', '..'].include?(dirname) && !name[dirname]
+
+      self.name = "#{dirname}_#{name}"
+    end
+  end
+end
+
+::YARD::Templates::Engine.register_template_path(File.dirname(__FILE__) + '/../../../templates')
+::YARD::Templates::Template.extra_includes << ::YARD::Aggredator::Helper
+::YARD::CodeObjects::ExtraFileObject.prepend(::YARD::ExtraFileObjectPatch)

data/lib/yard/aggredator/version.rb

@@ -0,0 +1,5 @@
+module YARD
+  module Aggredator
+    VERSION = '0.9.9'
+  end
+end

data/lib/yard-aggredator.rb

@@ -0,0 +1,4 @@
+require 'yard'
+
+require_relative 'yard/aggredator/version'
+require_relative 'yard/aggredator/plugin'

data/lib/yard_aggredator.rb

@@ -0,0 +1 @@
+require_relative 'yard-aggredator'