yard-markdown 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd90bdd01f08225188020b4f84a23b978c37416b6b0081c65056c10c5040d3e6
-  data.tar.gz: 548d5b5cd91b4e95d9f212d18aa8c3a24c8c9be71c256cfda226ecd8ba5cdd61
+  metadata.gz: 9c561fb4adb1a813dee7cc4f1793ecee708627115f85aab396933822e4886cb0
+  data.tar.gz: 17e36c633008becd1b8ead5af645e58182d5be5959736cfb34280f4c7a077848
 SHA512:
-  metadata.gz: fc7dff8536243860024a82e98eb8a0a26057f0db61aef58431302d73058372dcb206cbca9ea926e94c879b43113caf1065c4bd8cd06af6a78b9d501e5da810f2
-  data.tar.gz: b7cda956cf500503d138d9eeba8d336dce374605870334b28df162fd61c0d2a539603bf8f40518ca0e9b659a0303a224a4238e154b923ec681be72c5956eec0f
+  metadata.gz: 1c472b473610259d5067deceacbdc08ba3e2f68b00e07947d9b0aa55657623d28fccaf65237f213fc01f03b1f5d4674094fdfbe825f1829d17dadcc6c6efec69
+  data.tar.gz: abd879a66a9334c633120f9a1ee486cffa42dd4d08b184fe321bbea27a6f002a626b9adb76c46efc5637a3d489e3f365bdbea6b75f9901b3a22f8694bd73fbcc

data/.yardopts

@@ -1,4 +1,4 @@
---load ./lib/yard/markdown.rb
+--load ./lib/yard-markdown.rb
 --format markdown
 --markup markdown
 --output-dir example

data/README.md

@@ -14,7 +14,7 @@ gem 'yard-markdown'
 ```
 And run `bundle install`
 
-Run yardoc with `--format=markdown` parameter.
+Run yardoc with `--format=markdown --plugin=markdown` parameters.
 
 ## Backstory
 Successor to rdoc-mardown gem that was authored by me. So there is a lot of similarities between two - [example](https://github.com/skatkov/rdoc-markdown/tree/main/example).

data/example/Bird.md

@@ -8,7 +8,7 @@
 The base class for all birds.
 
 # Constants
-## DEFAULT_DUCK_VELOCITY =
+## DEFAULT_DUCK_VELOCITY = [](#constant-DEFAULT_DUCK_VELOCITY)
 (70) Default velocity for a flying duck.
 
 

data/example/Duck.md

@@ -21,7 +21,7 @@ Features:
    * swim
 
 # Constants
-## DEFAULT_DUCK_VELOCITY =
+## DEFAULT_DUCK_VELOCITY = [](#constant-DEFAULT_DUCK_VELOCITY)
 (70) Default velocity for a flying duck.
 
 

data/example/Waterfowl.md

@@ -7,7 +7,7 @@
 A mixin for waterfowl creatures.
 
 # Constants
-## DEFAULT_DUCK_VELOCITY =
+## DEFAULT_DUCK_VELOCITY = [](#constant-DEFAULT_DUCK_VELOCITY)
 (70) Default velocity for a flying duck.
 
 

data/example/index.csv

@@ -0,0 +1,18 @@
+name,type,path
+Waterfowl,Module,Waterfowl.md
+DEFAULT_DUCK_VELOCITY,Constant,Waterfowl.md#constant-DEFAULT_DUCK_VELOCITY
+swim,Method,Waterfowl.md#method-i-swim
+Bird,Class,Bird.md
+DEFAULT_DUCK_VELOCITY,Constant,Bird.md#constant-DEFAULT_DUCK_VELOCITY
+_fly_impl,Method,Bird.md#method-i-_fly_impl
+fly,Method,Bird.md#method-i-fly
+speak,Method,Bird.md#method-i-speak
+Duck,Class,Duck.md
+DEFAULT_DUCK_VELOCITY,Constant,Duck.md#constant-DEFAULT_DUCK_VELOCITY
+initialize,Method,Duck.md#method-i-initialize
+speak,Method,Duck.md#method-i-speak
+swim,Method,Duck.md#method-i-swim
+useful?,Method,Duck.md#method-i-useful?
+rubber_ducks,Method,Duck.md#method-c-rubber_ducks
+domestic,Attribute,Duck.md#attribute-i-domestic
+rubber,Attribute,Duck.md#attribute-i-rubber

data/lib/yard-markdown.rb

@@ -1,15 +1,10 @@
 # frozen_string_literal: true
 
-dir = File.dirname(__FILE__)
-$LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
-
 require "yard"
-require_relative "markdown/version"
 
 module YARD
   module Markdown
   end
 end
 
-puts "YARD::Markdown loaded"
-YARD::Templates::Engine.register_template_path dir + '/../templates'
+YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/../templates'

data/templates/default/fulldoc/markdown/setup.rb

@@ -30,6 +30,45 @@ def init
       log.backtrace(e)
     end
   end
+
+  serialize_index(objects)
+end
+
+
+require 'csv'
+
+def serialize_index(objects)
+  filepath = "#{options.serializer.basepath}/index.csv"
+
+  CSV.open(filepath, 'wb') do |csv|
+    csv << %w[name type path]
+
+    objects.each do |object|
+      next if object.name == :root
+
+      if object.type == :class
+        csv << [object.name, 'Class', options.serializer.serialized_path(object)]
+      elsif object.type == :module
+        csv << [object.name, 'Module', options.serializer.serialized_path(object)]
+      end
+
+      if constant_listing.size.positive?
+        constant_listing.each { |cnst| csv << [cnst.name(false), 'Constant', (options.serializer.serialized_path(object) + "#" +aref(cnst))] }
+      end
+
+      if (insmeths = public_instance_methods(object)).size > 0
+        insmeths.each { |item| csv << [item.name(false), 'Method', options.serializer.serialized_path(object) + "#" + aref(item)] }
+      end
+
+      if (pubmeths = public_class_methods(object)).size > 0
+        pubmeths.each { |item| csv << [item.name(false), 'Method', options.serializer.serialized_path(object) + '#' + aref(item)]}
+      end
+
+      if (attrs = attr_listing(object)).size > 0
+        attrs.each { |item| csv << [item.name(false), 'Attribute', options.serializer.serialized_path(object) + "#" + aref(item)]}
+      end
+    end
+  end
 end
 
 def serialize(object)
@@ -56,7 +95,7 @@ def serialize(object)
 <% groups(constant_listing, "Constants") do |list, name| %>
   # <%= name %>
   <% list.each do |cnst| %>
-  ## <%= cnst.name %> =
+  ## <%= cnst.name %> = [](#<%=aref(cnst)%>)
   (<%= cnst.value %>) <%= cnst.docstring %>
   <% end %>
 <% end %>
@@ -88,13 +127,15 @@ def serialize(object)
 
   <% end %>
 <% end %>
-  '.gsub(/^  /, ""), trim_mode: "%<>")
+  '.gsub(/^  /, ''), trim_mode: '%<>')
 
   template.result(binding)
 end
 
 def aref(object)
-  if !object.attr_info.nil?
+  if object.type == :constant
+    "constant-#{object.name(false)}"
+  elsif !object.attr_info.nil?
     "attribute-#{object.scope[0]}-#{object.name(false)}"
   else
     "#{object.type}-#{object.scope[0]}-#{object.name(false)}"
@@ -103,6 +144,7 @@ end
 
 def constant_listing
   return @constants if defined?(@constants) && @constants
+
   @constants = object.constants(included: false, inherited: false)
   @constants += object.cvars
   @constants

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-26 00:00:00.000000000 Z
+date: 2023-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: yard theme plugin that generates markdown documentation for gems
+description: yard plugin to generates markdown documentation for gems
 email:
 - yard-markdown@skatkov.com
 executables: []
@@ -41,8 +41,8 @@ files:
 - example/Bird.md
 - example/Duck.md
 - example/Waterfowl.md
+- example/index.csv
 - lib/yard-markdown.rb
-- lib/yard/markdown/version.rb
 - sig/yard/markdown.rbs
 - templates/default/fulldoc/markdown/setup.rb
 homepage: https://poshtui.com
@@ -69,5 +69,5 @@ requirements: []
 rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
-summary: yard theme plugin that generates markdown documentation for gems
+summary: yard plugin to generate markdown documentation
 test_files: []

data/lib/yard/markdown/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module YARD
-  module Markdown
-    VERSION = "0.1.1"
-  end
-end