rdoc-markdown 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 761747d3a9b32015fca088a58b871d0dbd1ab62b6239d2a4e6f6b3065a0e655e
-  data.tar.gz: e8948dfc980ee3a316699579d254fcb43c8f43549c07fd67ea7d4232bf16ae58
+  metadata.gz: 022adabd6f2ced45f3d5ff3216b48376914f7ba7b80cc1b87d83e8d7507824d7
+  data.tar.gz: 5d9a514dbbcf570811d0a3f230a2eff9434d61413cf994500bb6fd1f1f49a5d2
 SHA512:
-  metadata.gz: 4b7cce412555f74e6bb4798cdc1fe03d304f694144608ba20c71e8ea77e4b1caa2d791001ee3b58824d740bc55fe5634f8174a4b54be33a64d12f971ce55da7f
-  data.tar.gz: efea582acb0a4012734c1cdd974987c52df2cac297ca4c773cf268e84f6af325ae95e9391a10c0f89bd31e25a990cd64f1c990ba02c35c5d2dc23573c12ed7e9
+  metadata.gz: 41604d7644f1e4a437f79c3fcbc868c71189355e4b4ae79be430bd313e7729970d8029af95e2d649c71226079acef183329a1b63c1ce500a00815fa82ef587c1
+  data.tar.gz: f0a44ac4166d92a26b5166c8a290cbcfe16970b8d20c4f8c92ea4f0b5c3a1ae9a23ffe0348f79323c22caad9687eddb0d82346da3a31ba5b7594aeb39dd5e971

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    rdoc-markdown (0.1.14)
-      activesupport (~> 7.0)
+    rdoc-markdown (0.3)
       erb (~> 2.0)
       extralite-bundle (~> 1.0)
       rdoc (~> 6.0)
@@ -12,19 +11,11 @@ PATH
 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.9-arm64-darwin)
@@ -56,7 +47,7 @@ GEM
       rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.22.0)
+    rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
     rubocop-performance (1.14.3)
       rubocop (>= 1.7.0, < 2.0)
@@ -66,8 +57,6 @@ 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)
 

data/README.md

@@ -1,7 +1,5 @@
 # Rdoc::Markdown
-This gem is focused on spitting readable markdown files based on rdoc documentation. It should also come with sqlite database as an index (but this is so far only in plans). 
-
-It is still actively in development and while works as proof of concept, still has some quirks here and there.
+RDoc plugin to generate markdown documentation and search index as sqlite database for entire content.
 
 ## Installation
 
@@ -14,15 +12,10 @@ If bundler is not being used to manage dependencies, install the gem by executin
     $ gem install rdoc-markdown
 
 ## Usage
-First thing to do, is to install a gem
-
-`gem install rdoc-markdown`
-
-Then proceed to directory where you want to generate documentation:
 
 `rdoc --format=markdown`
 
-Don't forget to append `--debug` to have a bit more information in case thing fail (and they will probably do, because this entire thing is experimental).
+No additional parameters are currently available, but that may change.
 
 ## Development
 Biggest issue is testing this locally, but that's not as hard to do these days.
@@ -41,11 +34,23 @@ or you can do the same, but through gemfile:
 gem 'rdoc-markdown`, path: "../rdoc-markdown/`
 ```
 
+I have scripted entire process in [rm-reload.sh script](https://github.com/skatkov/gum/blob/master/rm-reload.sh). But it assumes, that you have [gum library](https://github.com/charmbracelet/gum) installed.
+
+## Testing
+Testing is not excessive, just verifies that basic functionality is operational. Following command should run entire testsuit:
+
+```
+rake test
+```
+
 ## Release
 ```
 gem build rdoc-markdown.gemspec
 gem push rdoc-markdown-0.1.2.gem
 ```
+
+There is `./publish.sh` script that does that. But it assumes, that you have [gum library](https://github.com/charmbracelet/gum) installed.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/skatkov/rdoc-markdown. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/skatkov/rdoc-markdown/blob/master/CODE_OF_CONDUCT.md).

data/lib/rdoc/generator/markdown.rb

@@ -5,9 +5,8 @@ gem "rdoc"
 require "pathname"
 require "erb"
 require "reverse_markdown"
-require 'extralite'
-require 'active_support/core_ext/string/inflections'
-require 'unindent'
+require "extralite"
+require "unindent"
 
 class RDoc::Generator::Markdown
   RDoc::RDoc.add_generator self
@@ -32,7 +31,7 @@ class RDoc::Generator::Markdown
 
   ##
   # Classes and modules to be used by this generator, not necessarily
-  # displayed.  See also #modsort
+  # displayed.
 
   attr_reader :classes
 
@@ -63,11 +62,9 @@ class RDoc::Generator::Markdown
   # Generates markdown files and search index file
 
   def generate
-    setup
-
-    debug("Create directory #{@output_dir}")
+    debug("Setting things up #{@output_dir}")
 
-    output_dir.mkpath
+    setup
 
     debug("Generate documentation in #{@output_dir}")
 
@@ -97,7 +94,7 @@ class RDoc::Generator::Markdown
   # This class emits a search index for generated documentation as sqlite database
   #
 
-  def emit_sqlite(name="index.db")
+  def emit_sqlite(name = "index.db")
     db = Extralite::Database.new("#{output_dir}/#{name}")
 
     db.execute <<-SQL
@@ -124,7 +121,7 @@ class RDoc::Generator::Markdown
         result << {
           name: "#{klass.full_name}.#{method.name}",
           type: "Method",
-          path: "#{turn_to_path(klass.full_name)}#meth-#{ActiveSupport::Inflector.parameterize method.name}"
+          path: "#{turn_to_path(klass.full_name)}##{method.aref}"
         }
       end
 
@@ -132,7 +129,7 @@ class RDoc::Generator::Markdown
         result << {
           name: "#{klass.full_name}.#{const.name}",
           type: "Constant",
-          path: "#{turn_to_path(klass.full_name)}#const-#{ActiveSupport::Inflector.parameterize const.name}"
+          path: "#{turn_to_path(klass.full_name)}##{const.name}"
         }
       end
 
@@ -140,7 +137,7 @@ class RDoc::Generator::Markdown
         result << {
           name: "#{klass.full_name}.#{attr.name}",
           type: "Attribute",
-          path: "#{turn_to_path(klass.full_name)}#attr-#{ActiveSupport::Inflector.parameterize attr.name}"
+          path: "#{turn_to_path(klass.full_name)}##{attr.aref}"
         }
       end
     end
@@ -152,19 +149,6 @@ class RDoc::Generator::Markdown
 
   def emit_classfiles
     @classes.each do |klass|
-      klass_methods = []
-      instance_methods = []
-
-      klass.method_list.each do |method|
-        next if method.visibility.to_s.eql?("private")
-
-        if method.type == "class"
-          klass_methods << method
-        else
-          instance_methods << method
-        end
-      end
-
       template = ERB.new File.read(File.join(TEMPLATE_DIR, "classfile.md.erb"))
 
       out_file = Pathname.new("#{output_dir}/#{turn_to_path klass.full_name}")
@@ -187,7 +171,7 @@ class RDoc::Generator::Markdown
   # Converts HTML string into a Markdown string with some cleaning and improvements.
 
   def markdownify(input)
-    md= ReverseMarkdown.convert input, github_flavored: true
+    md = ReverseMarkdown.convert input
 
     # unintent multiline strings
     md.unindent!
@@ -198,14 +182,10 @@ class RDoc::Generator::Markdown
 
       "[#{match[1]}](#{match[2]}.md#{match[3]})"
     end
-
-    # clean up things, to make it look neat.
-
-    md.gsub("[↑](#top)", "").lstrip
   end
 
   # Aliasing a shorter method name for use in templates
-  alias_method  :h, :markdownify
+  alias_method :h, :markdownify
 
   ##
   # Prepares for document generation, by creating required folders and initializing variables.
@@ -215,20 +195,10 @@ class RDoc::Generator::Markdown
     return if instance_variable_defined?(:@output_dir)
 
     @output_dir = Pathname.new(@options.op_dir).expand_path(@base_dir)
+    @output_dir.mkpath
 
     return unless @store
 
     @classes = @store.all_classes_and_modules.sort
-    @modsort = get_sorted_module_list @classes
-  end
-
-  ##
-  # Return a list of the documented modules sorted by salience first, then
-  # by name.
-
-  def get_sorted_module_list classes
-    classes.select do |klass|
-      klass.display?
-    end.sort
   end
 end

data/lib/rdoc/markdown/version.rb

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

data/lib/templates/classfile.md.erb

@@ -1,24 +1,31 @@
-# <% 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? %>
+# <%= klass.type %> <%= klass.full_name.strip %> [](#<%= klass.aref.strip %>) [](#top)
+<%= h klass.description %>
+<% klass.each_section do |section, constants, attributes| %>
+  <% if section.title %>## <%= section.title.strip %> <% end %>
+  <% if section.comment %> <%=h  section.description %><% end%>
+  <% unless klass.constants.empty? %>
 ## Constants
-***
-<% 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? %>
+    <% klass.constants.each do |const| %>
+### <%= const.name.strip %>[](#<%= const.name.strip %>)
+<% if const.comment %> <%= h const.description %> <%else%> (Not documented) <% end %>
+    <% end %>
+  <% end %>
+  <% unless attributes&.empty? %>
 ## Attributes
-<% klass.attributes.sort_by { |x| x.name }.each do |attr| %>
-  **[<%= 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 %> [[⚓]](#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 %> [[⚓]](#meth-<%= ActiveSupport::Inflector.parameterize method.name %>)
-
-<%= h method.description %><% end %><% end %>
+    <% attributes.each do |attr| %>
+### <%= attr.rw %><%=h attr.name.strip %>[](#<%= attr.aref.strip %>)
+<% if attr.comment %> <%= h attr.description %> <%else%> (Not documented) <% end %>
+    <% end %>
+  <% end %>
+  <% klass.methods_by_type(section).each do |type, visibilities| %>
+    <% next if visibilities.empty? %>
+    <% visibilities.each do |visibility, methods| %>
+      <% next if methods.empty? %>
+##  <%= visibility.capitalize %> <%= type.capitalize %> Methods
+      <% methods.each do |method|%>
+### <%= method.name.strip %><%= method.param_seq.strip %> [](#<%= method.aref.strip %>)
+<% if method.comment %> <%= h method.description %>  <% else %> (Not documented) <%end%>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-22 00:00:00.000000000 Z
+date: 2022-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -66,20 +66,6 @@ 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
@@ -164,8 +150,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: rdoc generator that produces markdown files and sqlite database with
-  index of all file
+description: RDoc plugin to generate markdown documentation and search index as sqlite
+  database for entire content.
 email:
 - github@skatkov.com
 executables: []
@@ -216,5 +202,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: rdoc generator that produces markdown files
+summary: RDoc plugin to generate markdown documentation
 test_files: []