rdoc-markdown 0.1.13 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a38c23f0593e099cf817af08dbf8c2f73573462135c99eafae1c8d060bffbc26
-  data.tar.gz: c209b03ef83bc8d936d5638a775c15b8c1ff0626ec94bbdd138abc2596e73999
+  metadata.gz: 761747d3a9b32015fca088a58b871d0dbd1ab62b6239d2a4e6f6b3065a0e655e
+  data.tar.gz: e8948dfc980ee3a316699579d254fcb43c8f43549c07fd67ea7d4232bf16ae58
 SHA512:
-  metadata.gz: a16a238ac2090d2d60a3c998bff28a9787a5d123fe5215e813b01f410433f8ac5264be02cb5677248c239e5d72bc26613c5a9d6b837eae90fe3d232b4eb25bda
-  data.tar.gz: ed04a374783a90b072f757d39439e0749d52bac3e6ee6d13af0b90408746f96c2d3257e50a72452ad749689bcd3dbe767ac509bf6bc1b597c7ad7771810c4554
+  metadata.gz: 4b7cce412555f74e6bb4798cdc1fe03d304f694144608ba20c71e8ea77e4b1caa2d791001ee3b58824d740bc55fe5634f8174a4b54be33a64d12f971ce55da7f
+  data.tar.gz: efea582acb0a4012734c1cdd974987c52df2cac297ca4c773cf268e84f6af325ae95e9391a10c0f89bd31e25a990cd64f1c990ba02c35c5d2dc23573c12ed7e9

data/Gemfile.lock

@@ -1,25 +1,35 @@
 PATH
   remote: .
   specs:
-    rdoc-markdown (0.1.10)
+    rdoc-markdown (0.1.14)
+      activesupport (~> 7.0)
       erb (~> 2.0)
       extralite-bundle (~> 1.0)
       rdoc (~> 6.0)
       reverse_markdown (~> 2.0)
+      unindent (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     ast (2.4.2)
     cgi (0.3.3)
+    concurrent-ruby (1.1.10)
     erb (2.2.3)
       cgi
     extralite-bundle (1.16)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
     json (2.6.2)
     minitest (5.16.3)
-    nokogiri (1.13.8-arm64-darwin)
+    nokogiri (1.13.9-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.8-x86_64-linux)
+    nokogiri (1.13.9-x86_64-linux)
       racc (~> 1.4)
     parallel (1.22.1)
     parser (3.1.2.1)
@@ -46,7 +56,7 @@ GEM
       rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
+    rubocop-ast (1.22.0)
       parser (>= 3.1.1.0)
     rubocop-performance (1.14.3)
       rubocop (>= 1.7.0, < 2.0)
@@ -56,7 +66,10 @@ GEM
       rubocop (= 1.35.1)
       rubocop-performance (= 1.14.3)
     stringio (3.0.2)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
+    unindent (1.0)
 
 PLATFORMS
   arm64-darwin-21

data/lib/rdoc/generator/markdown.rb

@@ -6,10 +6,15 @@ require "pathname"
 require "erb"
 require "reverse_markdown"
 require 'extralite'
+require 'active_support/core_ext/string/inflections'
+require 'unindent'
 
 class RDoc::Generator::Markdown
   RDoc::RDoc.add_generator self
 
+  ##
+  # Defines a constant for directory where templates could be found
+
   TEMPLATE_DIR = File.expand_path(
     File.join(File.dirname(__FILE__), "..", "..", "templates")
   )
@@ -42,6 +47,9 @@ class RDoc::Generator::Markdown
   # this alias is required for rdoc to work
   alias_method :file_dir, :class_dir
 
+  ##
+  # Initializer method for Rdoc::Generator::Markdown
+
   def initialize(store, options)
     @store = store
     @options = options
@@ -51,6 +59,9 @@ class RDoc::Generator::Markdown
     @classes = nil
   end
 
+  ##
+  # Generates markdown files and search index file
+
   def generate
     setup
 
@@ -72,6 +83,9 @@ class RDoc::Generator::Markdown
   attr_reader :options
   attr_reader :output_dir
 
+  ##
+  # This method is used to output debugging information in case rdoc is run with --debug parameter
+
   def debug(str = nil)
     if $DEBUG_RDOC
       puts "[rdoc-markdown] #{str}" if str
@@ -79,8 +93,12 @@ class RDoc::Generator::Markdown
     end
   end
 
-  def emit_sqlite
-    db = Extralite::Database.new("#{output_dir}/index.db")
+  ##
+  # This class emits a search index for generated documentation as sqlite database
+  #
+
+  def emit_sqlite(name="index.db")
+    db = Extralite::Database.new("#{output_dir}/#{name}")
 
     db.execute <<-SQL
       create table contentIndex (
@@ -106,7 +124,7 @@ class RDoc::Generator::Markdown
         result << {
           name: "#{klass.full_name}.#{method.name}",
           type: "Method",
-          path: turn_to_path(klass.full_name)
+          path: "#{turn_to_path(klass.full_name)}#meth-#{ActiveSupport::Inflector.parameterize method.name}"
         }
       end
 
@@ -114,7 +132,7 @@ class RDoc::Generator::Markdown
         result << {
           name: "#{klass.full_name}.#{const.name}",
           type: "Constant",
-          path: turn_to_path(klass.full_name)
+          path: "#{turn_to_path(klass.full_name)}#const-#{ActiveSupport::Inflector.parameterize const.name}"
         }
       end
 
@@ -122,7 +140,7 @@ class RDoc::Generator::Markdown
         result << {
           name: "#{klass.full_name}.#{attr.name}",
           type: "Attribute",
-          path: turn_to_path(klass.full_name)
+          path: "#{turn_to_path(klass.full_name)}#attr-#{ActiveSupport::Inflector.parameterize attr.name}"
         }
       end
     end
@@ -158,16 +176,22 @@ class RDoc::Generator::Markdown
     end
   end
 
-
-  private
+  ##
+  # Takes a class name and converts it into a Pathname
 
   def turn_to_path(class_name)
     "#{class_name.gsub("::", "/")}.md"
   end
 
+  ##
+  # Converts HTML string into a Markdown string with some cleaning and improvements.
+
   def markdownify(input)
     md= ReverseMarkdown.convert input, github_flavored: true
 
+    # unintent multiline strings
+    md.unindent!
+
     # Replace .html to .md extension in all markdown links
     md = md.gsub(/\[(.+)\]\((.+).html(.*)\)/) do |_|
       match = Regexp.last_match
@@ -180,8 +204,13 @@ class RDoc::Generator::Markdown
     md.gsub("[↑](#top)", "").lstrip
   end
 
+  # Aliasing a shorter method name for use in templates
   alias_method  :h, :markdownify
 
+  ##
+  # Prepares for document generation, by creating required folders and initializing variables.
+  # Could be called multiple times.
+
   def setup
     return if instance_variable_defined?(:@output_dir)
 

data/lib/rdoc/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module Rdoc
   module Markdown
-    VERSION = "0.1.13"
+    VERSION = "0.2"
   end
 end

data/lib/templates/classfile.md.erb

@@ -3,22 +3,22 @@
 <% unless klass.constants.empty? %>
 ## Constants
 ***
-<% klass.constants.sort_by { |x| x.name }.each do |const| %> **<%= const.name %>**
+<% klass.constants.sort_by { |x| x.name }.each do |const| %> **<%= const.name %>** [[⚓]](#const-<%= ActiveSupport::Inflector.parameterize const.name%>)
   <%= h const.description %>
 <% end %><% end %>
 <% unless klass.attributes.empty? %>
 ## Attributes
 <% klass.attributes.sort_by { |x| x.name }.each do |attr| %>
-  **[<%= attr.rw %>]** <%= attr.name %>
+  **[<%= attr.rw %>]** <%= attr.name %> [[⚓]](#attr-<%= ActiveSupport::Inflector.parameterize attr.name %>)
 <% end %><% end %>
 <% unless klass_methods.empty? %>
 ## Public Class Methods
 ***
-<% klass_methods.each do |method| %>### <%= method.name %><%= method.params %>
+<% klass_methods.each do |method| %>### <%= method.name %><%= method.params %> [[⚓]](#meth-<%= ActiveSupport::Inflector.parameterize method.name %>)
 
 <%= h method.description %><% end %><% end %>
 <% unless instance_methods.empty? %>
 ## Public Instance Methods
-<% instance_methods.each do |method| %>### <%= method.name %><%= method.params %>
+<% instance_methods.each do |method| %>### <%= method.name %><%= method.params %> [[⚓]](#meth-<%= ActiveSupport::Inflector.parameterize method.name %>)
 
 <%= h method.description %><% end %><% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: '0.2'
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-20 00:00:00.000000000 Z
+date: 2022-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: unindent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement