rdoc-markdown 0.1.10 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d08a05e31cacde411267507404584cf8b83a715e2001290e84f4b0ae3494106
-  data.tar.gz: cf679c7121051ed3c3dfe7615e9ef559d2ec8b023e2b1efd9666d9caa2de5ae7
+  metadata.gz: a38c23f0593e099cf817af08dbf8c2f73573462135c99eafae1c8d060bffbc26
+  data.tar.gz: c209b03ef83bc8d936d5638a775c15b8c1ff0626ec94bbdd138abc2596e73999
 SHA512:
-  metadata.gz: 9cbbf2f3f6fc21e199d426ed08d71c734f09daf155bb5bc9b37a65662094c735047f76cfe8d84e3ee92a3b998e21e3cbbf643b6f0702ab14a67467773b028ead
-  data.tar.gz: 4a9e28997fd4cda40d0510f29f9bc04a78a30140e5631dd0be4a38b7bfc9ae4a65d3fbae14de8d4d1853cac2c60b8ddf4a399653a171c757b605397368e193fc
+  metadata.gz: a16a238ac2090d2d60a3c998bff28a9787a5d123fe5215e813b01f410433f8ac5264be02cb5677248c239e5d72bc26613c5a9d6b837eae90fe3d232b4eb25bda
+  data.tar.gz: ed04a374783a90b072f757d39439e0749d52bac3e6ee6d13af0b90408746f96c2d3257e50a72452ad749689bcd3dbe767ac509bf6bc1b597c7ad7771810c4554

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/docs/example.rb

@@ -1,14 +1,14 @@
 ##
-# === RDoc::Generator::SolarFish example.
+# === RDoc::Generator::Markdown example.
 #
-# This example employs variois RDoc features to demonstrate
+# This example employs various RDoc features to demonstrate
 # generator output.
 #
 # ---
 #
 # Links:
 #
-#  1. {Project Home Page}[https://github.com/rbdoc/rdoc-generator-solarfish)
+#  1. {Project Home Page}[https://github.com/skatkov/rdoc-markdown)
 #  2. {RDoc Documentation}[http://ruby-doc.org/stdlib-2.0.0/libdoc/rdoc/rdoc/RDoc/Markup.html]
 #
 

data/lib/rdoc/generator/markdown.rb

@@ -5,6 +5,7 @@ gem "rdoc"
 require "pathname"
 require "erb"
 require "reverse_markdown"
+require 'extralite'
 
 class RDoc::Generator::Markdown
   RDoc::RDoc.add_generator self
@@ -60,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
@@ -74,6 +79,59 @@ 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
+
+    result = []
+
+    @classes.map do |klass|
+      result << {
+        name: klass.full_name,
+        type: klass.type.capitalize,
+        path: turn_to_path(klass.full_name)
+      }
+
+      klass.method_list.each do |method|
+        next if method.visibility.to_s.eql?("private")
+
+        result << {
+          name: "#{klass.full_name}.#{method.name}",
+          type: "Method",
+          path: turn_to_path(klass.full_name)
+        }
+      end
+
+      klass.constants.sort_by { |x| x.name }.each do |const|
+        result << {
+          name: "#{klass.full_name}.#{const.name}",
+          type: "Constant",
+          path: turn_to_path(klass.full_name)
+        }
+      end
+
+      klass.attributes.sort_by { |x| x.name }.each do |attr|
+        result << {
+          name: "#{klass.full_name}.#{attr.name}",
+          type: "Attribute",
+          path: turn_to_path(klass.full_name)
+        }
+      end
+    end
+
+    result.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 = []
@@ -91,7 +149,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)
@@ -104,7 +162,7 @@ class RDoc::Generator::Markdown
   private
 
   def turn_to_path(class_name)
-    class_name.gsub("::", "/")
+    "#{class_name.gsub("::", "/")}.md"
   end
 
   def markdownify(input)

data/lib/rdoc/markdown/version.rb

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

data/publish.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+gem build rdoc-markdown.gemspec
+GEM=$(gum choose $(ls *.gem))
+
+gum confirm "Publish $GEM?" && gem push $GEM

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.13
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-16 00:00:00.000000000 Z
+date: 2022-10-20 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
@@ -147,6 +161,7 @@ files:
 - lib/rdoc/generator/markdown.rb
 - lib/rdoc/markdown/version.rb
 - lib/templates/classfile.md.erb
+- publish.sh
 - sig/rdoc/markdown.rbs
 homepage: https://poshtui.com
 licenses: