yard-aggredator 1.0.4 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7afa8c8bbde7e00df07c5d8d0503c03dc81a503554d27ce08c5cd5037c929070
-  data.tar.gz: a7727651b4a1a862b32e338a0d38ab5979446c502ad5d96b3232024fa4b13861
+  metadata.gz: 867117aeeb58550f839e27b47609f5d49a2a494318ee25f67eeb2e3f55d8d2da
+  data.tar.gz: f601c9cf165ecaceed674ec338c6c65d6a82af75382b7f7914e7d39994db39a6
 SHA512:
-  metadata.gz: c7a136de38037eb861979cadf3e033b0fbdf078585a1e278f8aef0d93ccbe4e88b5e5121e182e1af4eaf8267e8422dc8e3325fabea90596e508ba10109339e3e
-  data.tar.gz: e01f362d44b71d3e4fee09f59674874ca849dfe68610378a83453fc347cc5809156182999ccf007aeadc29bfad07714d24c5c8410c15a5c0d14a30739b7c1554
+  metadata.gz: 74013f6b0f99768eaa5d32b77772c459818e1c1ced1d4be8af9ade6fde1696e8a16ad050b195d17f54ca00b7e9122756eeef9e1c6e2a6b40fe0a2accf7cb9b36
+  data.tar.gz: 38241dd4f4ae90374ace57788078b3224bf5d7767e3f91417b898e2635f3ed5b5462a2df5621191206db90d61f3132f928a75c8e04442ef5afce389253059e2c

data/{LICENSE.txt → LICENSE}

@@ -1,6 +1,4 @@
-The MIT License (MIT)
-
-Copyright (c) 2019 Ivan Godko
+Copyright (c) 2014-2025 Рнд Софт
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +7,13 @@ 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 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+
+# yard-aggredator плагин для YARD
+
+<div align="center">
+
+[![Gem Version](https://badge.fury.io/rb/yard-aggredator.svg)](https://rubygems.org/gems/yard-aggredator)
+[![Gitlab](https://badgen.net/badge/gitlab/ruby%2Fyard-aggredator/orange?icon=gitlab&label)](https://br.rnds.pro/ruby/yard-aggredator) 
+[![YARD](https://badgen.net/badge/YARD/doc/blue)](https://yard.rnds.local)
+
+</div>
+
+Очень полезные дополнения и справляения для генератор документации YARD.
+
+<div align="left">
+  <a href="https://rnds.pro/" >
+    <img src="https://library.rnds.pro/repository/public-blob/logo/RNDS.svg" alt="Supported by RNDSOFT"  height="60">
+  </a>
+</div>
+
+## Возможности / Features
+
+- Поддержка `mermaid`-диаграмма
+- Корректная работа `include:file` для статических ресурсов во всех режимах `Server`, `Static` и `Gems`
+- Новый тип ссылки `link:file` для указания на статические ресурсы
+- Совместимость `md`-ссылок YARD и Github/Gitlab
+- Корректная работа подсветки синтаксиса в блоках внутри `Markdown` разметки в документировании классов
+- Корректная генерация имён статических ресурсов, таких как множетсвенные `md`-файлы внутри подпапок
+
+
+## Примеры
+
+### `mermaid`-диаграммы
+
+```ruby
+  # MyClass
+  #
+  #  Диаграмма
+  #
+  # ```mermaid
+  #  flowchart LR
+  #    Start --> Stop
+  # ```
+  #
+  class MyClass
+  end
+```
+
+### `mermaid`-диаграммы
+
+```ruby
+  # MyClass
+  #
+  # @see link:file:schemas/my_class.json JSON-схема
+  #
+  class MyClass
+  end
+```
+
+### Вложенные `md`-файлы
+
+Например для такой стурктуры
+
+```sh
+├── lib
+│   └── api
+│       ├── v1
+│       │   └── README.md
+│       ├── v2
+│       │   └── README.md
+│       └── v3
+│           └── README.md
+├── README.md
+```
+
+```ruby
+  - [V3](lib/api/v3/README.md) - asdasdasda
+  # MyClass
+  #
+  # @see file:lib/api/v1/README.md Описание V1
+  # @see file:lib/api/v2/README.md Описание V2
+  # @see file:lib/api/v3/README.md Описание V3
+  #
+  # Либо в Markdown синтаксисе для совместимости с Gitlab/Github
+  #
+  # [Описание V1](lib/api/v1/README.md)
+  # [Описание V2](lib/api/v2/README.md)
+  # [Описание V3](lib/api/v3/README.md)
+  #
+  class MyClass
+  end
+```
+
+## Лицензия / License
+
+Библиотека доступна с открытым исходным кодом в соответствии с условиями [лицензии MIT](./LICENSE).
+
+---
+
+The gem is available as open source under the terms of the [MIT License](./LICENSE).

data/lib/yard/aggredator/plugin.rb

@@ -1,5 +1,6 @@
 require 'json'
-require 'coderay'
+require 'rouge'
+require 'yard/relative_markdown_links'
 
 YARD::Templates::Helpers::MarkupHelper::MARKUP_PROVIDERS[:plain] = []
 YARD::Templates::Helpers::MarkupHelper::MARKUP_EXTENSIONS[:plain] = %w[json txt text mermaid]
@@ -85,7 +86,7 @@ module YARD
             string
           else
             classes = ['code', language].compact.join(' ')
-            %(<pre class="#{classes}"><code class="#{language}">#{string}</code></pre>)
+            %(<pre class="#{classes} highlight"><code class="#{language}">#{string}</code></pre>)
           end
         end
       end
@@ -98,17 +99,40 @@ module YARD
       end
 
       def linkify(*args)
+        $d = false
+        if args.any?{|a| a.to_s['lib/aggredator/api/v3/README']}
+          $d = true
+          puts args.inspect
+        end
+
         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
+          if (serializer.class == YARD::Serializers::FileSystemSerializer)
+            # Это генерация статики. Например `yardoc` или `yard doc`
             link_url(url_for(relpath), args[1])
           else
+            # Это генерация динамики. Например `yard server`
             link_file(relpath, args[1])
           end
+        elsif args.first.is_a?(String) && /^file:(\S+)/.match(args.first)
+          file = ::Regexp.last_match(1)
+          relpath = File.relative_path(Dir.pwd, File.expand_path(file))
+          if File.file?(relpath)
+            if (serializer.class == YARD::Serializers::FileSystemSerializer)
+              # Это генерация статики. Например `yardoc` или `yard doc`
+              super
+            else
+              puts "SER2: #{args}" if $d
+              link_file(relpath, args[1])
+            end
+          else
+            super
+          end
         elsif args.first.is_a?(String) && /^include:file:(\S+)/.match(args.first)
           file = ::Regexp.last_match(1)
           root = YARD::Registry.send(:thread_local_store).file.to_s
+          puts "linkify 2: #{relpath}" if $d
           if root['.yardoc']
             file1 = root.sub('.yardoc', file)
             file2 = file1.sub('/doc/', '/gems/')
@@ -118,6 +142,7 @@ module YARD
           end
           super
         else
+          puts "linkify 3: #{args}" if $d
           super
         end
       end
@@ -139,6 +164,18 @@ module YARD
       #   super
       # end
     end
+
+    module RougeHighlighter
+      Rouge::Lexer.all.each do |lexer_class|
+        ([lexer_class.tag] + lexer_class.aliases).compact.uniq.each do |tag|
+          define_method("html_syntax_highlight_#{tag}") do |source|
+            formatter = Rouge::Formatters::HTMLInline.new('monokai.sublime')
+            lexer = lexer_class.new
+            formatter.format(lexer.lex(source))
+          end
+        end
+      end
+    end
   end
 
   module ExtraFileObjectPatch
@@ -154,4 +191,7 @@ end
 
 ::YARD::Templates::Engine.register_template_path(File.dirname(__FILE__) + '/../../../templates')
 ::YARD::Templates::Template.extra_includes << ::YARD::Aggredator::Helper
+::YARD::Templates::Template.extra_includes << ::YARD::Aggredator::RougeHighlighter
+::YARD::Templates::Template.extra_includes << ::YARD::RelativeMarkdownLinks
 ::YARD::CodeObjects::ExtraFileObject.prepend(::YARD::ExtraFileObjectPatch)
+

data/lib/yard/aggredator/version.rb

@@ -1,5 +1,5 @@
 module YARD
   module Aggredator
-    VERSION = '1.0.4'
+    VERSION = '1.0.6'
   end
 end

data/templates/default/fulldoc/html/css/README.md

@@ -0,0 +1,6 @@
+
+перегенерировать стиль:
+
+```sh
+rougify style monokai.sublime --scope="body #content .highlight" > common.css
+```

data/templates/default/fulldoc/html/css/common.css

@@ -0,0 +1,203 @@
+body #content .highlight table td { padding: 5px; }
+body #content .highlight table pre { margin: 0; }
+body #content .highlight .gh {
+  color: #999999;
+}
+body #content .highlight .sr {
+  color: #f6aa11;
+}
+body #content .highlight .go {
+  color: #888888;
+}
+body #content .highlight .gp {
+  color: #555555;
+}
+body #content .highlight .ge {
+  font-style: italic;
+}
+body #content .highlight .ges {
+  font-weight: bold;
+  font-style: italic;
+}
+body #content .highlight .gs {
+  font-weight: bold;
+}
+body #content .highlight .gu {
+  color: #aaaaaa;
+}
+body #content .highlight .nb {
+  color: #f6aa11;
+}
+body #content .highlight .cm {
+  color: #75715e;
+}
+body #content .highlight .cp {
+  color: #75715e;
+}
+body #content .highlight .c1 {
+  color: #75715e;
+}
+body #content .highlight .cs {
+  color: #75715e;
+}
+body #content .highlight .c, body #content .highlight .ch, body #content .highlight .cd, body #content .highlight .cpf {
+  color: #75715e;
+}
+body #content .highlight .err {
+  color: #960050;
+}
+body #content .highlight .gr {
+  color: #960050;
+}
+body #content .highlight .gt {
+  color: #960050;
+}
+body #content .highlight .gd {
+  color: #49483e;
+}
+body #content .highlight .gi {
+  color: #49483e;
+}
+body #content .highlight .kc {
+  color: #66d9ef;
+}
+body #content .highlight .kd {
+  color: #66d9ef;
+}
+body #content .highlight .kr {
+  color: #66d9ef;
+}
+body #content .highlight .no {
+  color: #66d9ef;
+}
+body #content .highlight .kt {
+  color: #66d9ef;
+}
+body #content .highlight .mf {
+  color: #ae81ff;
+}
+body #content .highlight .mh {
+  color: #ae81ff;
+}
+body #content .highlight .il {
+  color: #ae81ff;
+}
+body #content .highlight .mi {
+  color: #ae81ff;
+}
+body #content .highlight .mo {
+  color: #ae81ff;
+}
+body #content .highlight .m, body #content .highlight .mb, body #content .highlight .mx {
+  color: #ae81ff;
+}
+body #content .highlight .sc {
+  color: #ae81ff;
+}
+body #content .highlight .se {
+  color: #ae81ff;
+}
+body #content .highlight .ss {
+  color: #ae81ff;
+}
+body #content .highlight .sd {
+  color: #e6db74;
+}
+body #content .highlight .s2 {
+  color: #e6db74;
+}
+body #content .highlight .sb {
+  color: #e6db74;
+}
+body #content .highlight .sh {
+  color: #e6db74;
+}
+body #content .highlight .si {
+  color: #e6db74;
+}
+body #content .highlight .sx {
+  color: #e6db74;
+}
+body #content .highlight .s1 {
+  color: #e6db74;
+}
+body #content .highlight .s, body #content .highlight .sa, body #content .highlight .dl {
+  color: #e6db74;
+}
+body #content .highlight .na {
+  color: #a6e22e;
+}
+body #content .highlight .nc {
+  color: #a6e22e;
+}
+body #content .highlight .nd {
+  color: #a6e22e;
+}
+body #content .highlight .ne {
+  color: #a6e22e;
+}
+body #content .highlight .nf, body #content .highlight .fm {
+  color: #a6e22e;
+}
+body #content .highlight .vc {
+  color: #ffffff;
+  background-color: #272822;
+}
+body #content .highlight .nn {
+  color: #ffffff;
+  background-color: #272822;
+}
+body #content .highlight .nl {
+  color: #ffffff;
+  background-color: #272822;
+}
+body #content .highlight .ni {
+  color: #ffffff;
+  background-color: #272822;
+}
+body #content .highlight .bp {
+  color: #ffffff;
+  background-color: #272822;
+}
+body #content .highlight .vg {
+  color: #ffffff;
+  background-color: #272822;
+}
+body #content .highlight .vi {
+  color: #ffffff;
+  background-color: #272822;
+}
+body #content .highlight .nv, body #content .highlight .vm {
+  color: #ffffff;
+  background-color: #272822;
+}
+body #content .highlight .w {
+  color: #ffffff;
+  background-color: #272822;
+}
+body #content .highlight {
+  color: #ffffff;
+  background-color: #272822;
+}
+body #content .highlight .n, body #content .highlight .py, body #content .highlight .nx {
+  color: #ffffff;
+  background-color: #272822;
+}
+body #content .highlight .ow {
+  color: #f92672;
+}
+body #content .highlight .nt {
+  color: #f92672;
+}
+body #content .highlight .k, body #content .highlight .kv {
+  color: #f92672;
+}
+body #content .highlight .kn {
+  color: #f92672;
+}
+body #content .highlight .kp {
+  color: #f92672;
+}
+body #content .highlight .o {
+  color: #f92672;
+}

data/templates/default/layout/html/customjs.erb

@@ -1,3 +1,2 @@
 <script>
-console.log('custom js')
 </script>

data/templates/default/layout/html/setup.rb

@@ -7,4 +7,5 @@ end
 
 def javascripts
   super + ['js/mermaid.min.js']
-end
+end
+

data/yards-aggredator.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Samoilenko Yuri']
   spec.email         = ['kinnalru@gmail.com']
 
-  spec.summary       = 'YARD plugin for documenting Aggredator API gem'
+  spec.summary       = 'YARD plugin with useful fixes and tools'
   spec.description = '
    Различные вспомогательные функции: работа с Mermaid Diagram, работа с сылками на статические файлы и другая косметика'
 
@@ -18,10 +18,11 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://br.rnds.pro/ruby/yard-aggredator'
   spec.platform      = Gem::Platform::RUBY
 
-  spec.files         = Dir.glob('{lib,templates}/**/*') + ['LICENSE.txt', 'README.md', __FILE__]
+  spec.files         = Dir.glob('{lib,templates}/**/*') + ['LICENSE', 'README.md', __FILE__]
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'coderay'
+  spec.add_dependency 'rouge'
   spec.add_dependency 'json'
   spec.add_dependency 'yard'
+  spec.add_dependency 'yard-relative_markdown_links'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-aggredator
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.6
 platform: ruby
 authors:
 - Samoilenko Yuri
@@ -10,7 +10,7 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: coderay
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -51,6 +51,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard-relative_markdown_links
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |2-
 
      Различные вспомогательные функции: работа с Mermaid Diagram, работа с сылками на статические файлы и другая косметика
@@ -60,12 +74,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.txt
+- LICENSE
 - README.md
 - lib/yard-aggredator.rb
 - lib/yard/aggredator/plugin.rb
 - lib/yard/aggredator/version.rb
 - lib/yard_aggredator.rb
+- templates/default/fulldoc/html/css/README.md
+- templates/default/fulldoc/html/css/common.css
 - templates/default/fulldoc/html/js/mermaid.min.js
 - templates/default/layout/html/customjs.erb
 - templates/default/layout/html/setup.rb
@@ -90,5 +106,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: YARD plugin for documenting Aggredator API gem
+summary: YARD plugin with useful fixes and tools
 test_files: []