rdoc-markdown 0.1.8 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d00a1ac32eb71f6eff97e6ee46bb1756c5fad8d97125c269ca0a1a5ba69f8061
-  data.tar.gz: 34ee2b38e839454a19f197466248db8033076d5113fb4da9895a4ed5a9b00e98
+  metadata.gz: e8541f95990a90cf56b56fc4ac7ddc00ee027327023a127063c30cb1b87449b6
+  data.tar.gz: b00c270ed9c64a36120900e0bfb8eb794afda0ab1b28cdb4cbc51c016b9c4999
 SHA512:
-  metadata.gz: d0a1f0294c47c08f72134820afc998a5d01dc4a20d7588df73f9dcbde9ce1b778282480ac35d9d95fea3b73b738ba9e30166bbf861f493713e18b8b3c4b2a300
-  data.tar.gz: 3dc3972ce4e1ef10116c2fa1dcb04ad980e9a73068d79a6399e0abbcca3b49f16f28fe5db1855bc353643cedf92c781853c56e7e9a0bf09b4c55783d539537a8
+  metadata.gz: 58ba2c78a1f23cea5738a2e65df6468a4c70da00fb8654affd479cb2ed244930fa63c56d91451d83c0475c1c31102319af9970f3d9d7f000ea04bfecd146616a
+  data.tar.gz: 5960431dc78731a5b65b57a004b6982e7eac883ed1bc2306e92bf34f3948bd3bf33494e3daac4dab1685a1d19e6b8831993247cfd1d91ee8ae0852c483c79453

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    rdoc-markdown (0.1.7)
+    rdoc-markdown (0.1.10)
       erb (~> 2.0)
+      extralite-bundle (~> 1.0)
       rdoc (~> 6.0)
       reverse_markdown (~> 2.0)
 
@@ -13,6 +14,7 @@ GEM
     cgi (0.3.3)
     erb (2.2.3)
       cgi
+    extralite-bundle (1.16)
     json (2.6.2)
     minitest (5.16.3)
     nokogiri (1.13.8-arm64-darwin)

data/lib/rdoc/generator/markdown.rb

@@ -5,10 +5,8 @@ gem "rdoc"
 require "pathname"
 require "erb"
 require "reverse_markdown"
+require 'extralite'
 
-# Markdown generator.
-# Registers command line options and generates markdown files
-# RDoc documentation and options.
 class RDoc::Generator::Markdown
   RDoc::RDoc.add_generator self
 
@@ -33,21 +31,6 @@ class RDoc::Generator::Markdown
 
   attr_reader :classes
 
-  ##
-  # Files to be displayed by this generator
-
-  attr_reader :files
-
-  ##
-  # Methods to be displayed by this generator
-
-  attr_reader :methods
-
-  ##
-  # Sorted list of classes and modules to be displayed by this generator
-
-  attr_reader :modsort
-
   ##
   # Directory where generated class HTML files live relative to the output
   # dir.
@@ -66,9 +49,6 @@ class RDoc::Generator::Markdown
     @base_dir = Pathname.pwd.expand_path
 
     @classes = nil
-    @files = nil
-    @methods = nil
-    @modsort = nil
   end
 
   def generate
@@ -81,6 +61,10 @@ class RDoc::Generator::Markdown
     debug("Generate documentation in #{@output_dir}")
 
     emit_classfiles
+
+    debug("Generate index db file: #{output_dir}/index.db")
+
+    emit_sqlite
   end
 
   private
@@ -95,6 +79,29 @@ class RDoc::Generator::Markdown
     end
   end
 
+  def emit_sqlite
+    db = Extralite::Database.new("#{output_dir}/index.db")
+
+    db.execute <<-SQL
+      create table contentIndex (
+        id INTEGER PRIMARY KEY,
+        name TEXT,
+        type TEXT,
+        path TEXT
+      );
+    SQL
+
+    @classes.map do |klass|
+      {
+        name: klass.full_name,
+        type: klass.type.capitalize,
+        path: turn_to_path(klass.full_name)
+      }
+    end.each do |rec|
+      db.execute "insert into contentIndex (name, type, path) values (:name, :type, :path)", rec
+    end
+  end
+
   def emit_classfiles
     @classes.each do |klass|
       klass_methods = []
@@ -112,7 +119,7 @@ class RDoc::Generator::Markdown
 
       template = ERB.new File.read(File.join(TEMPLATE_DIR, "classfile.md.erb"))
 
-      out_file = Pathname.new("#{output_dir}/#{turn_to_path klass.full_name}.md")
+      out_file = Pathname.new("#{output_dir}/#{turn_to_path klass.full_name}")
       out_file.dirname.mkpath
 
       result = template.result(binding)
@@ -124,22 +131,27 @@ class RDoc::Generator::Markdown
 
   private
 
-  def replace_extensions_in_links(text)
-    text.gsub(/\[(.+)\]\((.+).html(.*)\)/) do |_|
+  def turn_to_path(class_name)
+    "#{class_name.gsub("::", "/")}.md"
+  end
+
+  def markdownify(input)
+    md= ReverseMarkdown.convert input, github_flavored: true
+
+    # Replace .html to .md extension in all markdown links
+    md = md.gsub(/\[(.+)\]\((.+).html(.*)\)/) do |_|
       match = Regexp.last_match
 
       "[#{match[1]}](#{match[2]}.md#{match[3]})"
     end
-  end
 
-  def turn_to_path(class_name)
-    class_name.gsub("::", "/")
-  end
+    # clean up things, to make it look neat.
 
-  def h(string)
-    replace_extensions_in_links ReverseMarkdown.convert string.strip, github_flavored: true
+    md.gsub("[↑](#top)", "").lstrip
   end
 
+  alias_method  :h, :markdownify
+
   def setup
     return if instance_variable_defined?(:@output_dir)
 
@@ -148,8 +160,6 @@ class RDoc::Generator::Markdown
     return unless @store
 
     @classes = @store.all_classes_and_modules.sort
-    @files = @store.all_files.sort
-    @methods = @classes.map(&:method_list).flatten.sort
     @modsort = get_sorted_module_list @classes
   end
 

data/lib/rdoc/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module Rdoc
   module Markdown
-    VERSION = "0.1.8"
+    VERSION = "0.1.12"
   end
 end

data/lib/templates/classfile.md.erb

@@ -1,5 +1,5 @@
-# <% if klass.type == 'class' %><%= klass.type.capitalize %>: **<%= klass.full_name %>**<% if klass.superclass %> < <% end %><% unless String === klass.superclass %><%= klass.superclass&.name %> <% else %> <%= klass.superclass %> <% end %> <% else %> <%= klass.type.capitalize %><%= klass&.name %> <% end %>
-  <% if klass.description && !klass.description.empty? %><%= h klass.description %><% end %>
+# <% if klass.type == 'class' %><%= klass.type.capitalize %>: **<%= klass.full_name %>**<% if klass.superclass %> < <% end %><% unless String === klass.superclass %><%= klass.superclass&.name %> <% else %> <%= klass.superclass %> <% end %> <% else %> <%= klass.type.capitalize %>: <%= klass&.name %> <% end %>
+<% if klass.description && !klass.description.empty? %><%= h klass.description %><% end %>
 <% unless klass.constants.empty? %>
 ## Constants
 ***

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.12
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-16 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: extralite-bundle
+  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