rdoc-markdown 0.1.14 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12c1ba51ac28269b904c171a33ced989e93a6ec55cdeb5b07cf1267bb73f288e
-  data.tar.gz: 816fce30041fc92080f14dfe722e27261b9bc65fbec97b00a9646962a6daa0b6
+  metadata.gz: 761747d3a9b32015fca088a58b871d0dbd1ab62b6239d2a4e6f6b3065a0e655e
+  data.tar.gz: e8948dfc980ee3a316699579d254fcb43c8f43549c07fd67ea7d4232bf16ae58
 SHA512:
-  metadata.gz: 47cae1695d164805c74056118cc2048594281e304fd73952a6e8a0602a89f360beae06f5a6cd01929bfb6b1d094716b59a68a748a9409f4544bb18df2cf8c6d5
-  data.tar.gz: 544b83ef2a0f8dbccc7fbba8ef046f5fccd160ea0f030f6dba237ee6d061e4a13cae0c04fbd701d650993ec1d966f202ce948330101c9077d160bfdf4ef9c089
+  metadata.gz: 4b7cce412555f74e6bb4798cdc1fe03d304f694144608ba20c71e8ea77e4b1caa2d791001ee3b58824d740bc55fe5634f8174a4b54be33a64d12f971ce55da7f
+  data.tar.gz: efea582acb0a4012734c1cdd974987c52df2cac297ca4c773cf268e84f6af325ae95e9391a10c0f89bd31e25a990cd64f1c990ba02c35c5d2dc23573c12ed7e9

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    rdoc-markdown (0.1.13)
+    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/
@@ -68,6 +69,7 @@ GEM
     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

@@ -7,10 +7,14 @@ 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")
   )
@@ -43,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
@@ -52,6 +59,9 @@ class RDoc::Generator::Markdown
     @classes = nil
   end
 
+  ##
+  # Generates markdown files and search index file
+
   def generate
     setup
 
@@ -73,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
@@ -80,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 (
@@ -159,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
@@ -181,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.14"
+    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.14
+  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
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !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