rdoc-markdown 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6496d719bac799f108e7504fb0eef463533e1aa3df50a0da4877d44ff514c7e
-  data.tar.gz: b1da8475d96bdec1615012f21bdfcdf6709597837974409f43923d1452f5f430
+  metadata.gz: b9cdfb6613fd3bab8a492f7faa4338178df35489955e3282b70ab32002624be5
+  data.tar.gz: a09b470cfeb56feff5b7867fe9b59be2242ad6be49454d0198b33995c780c1aa
 SHA512:
-  metadata.gz: 0a8f5ea92bad8e716b72b642831e948dcf97b4fc58375600b764361e3805665c0cb7ed5cd8d87986b4b909daa1c16b08a1053bacf63bbe0494e7b4b0d6f71035
-  data.tar.gz: e95317429aa6bc84be6c45304453c89602c29d50db68aa7b2aa5802c7916c4be6d0ad0ada196fbff48c265583919171cffdc2a5e37340d9a054f967fd6fad6de
+  metadata.gz: 8404bb773b50e88d87648e4cf516ac87bd9a8c0d0455f93980ba590d7d02912879d7abec888bbd04da88cb3c625f1c1c15d1cec7819c5fed717dbbd0b134f2cd
+  data.tar.gz: a8a8c38c3cbe9f93caf9dfe4f81d79ba568116f10d549cac561a794394273a3296afbcee54440ff0b1319cef62023b42ac5a299de055e6f6d8da48e63758dab8

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    rdoc-markdown (0.1.3)
+    rdoc-markdown (0.1.5)
       erb (~> 2.0)
       rdoc (~> 6.0)
+      reverse_markdown (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -12,34 +13,47 @@ GEM
     cgi (0.3.3)
     erb (2.2.3)
       cgi
+    json (2.6.2)
     minitest (5.16.3)
+    nokogiri (1.13.8-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.8-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
+    psych (4.0.6)
+      stringio
+    racc (1.6.0)
     rainbow (3.1.1)
     rake (13.0.6)
     rdiscount (2.2.0.2)
-    rdoc (6.2.1.1)
-    regexp_parser (2.5.0)
+    rdoc (6.4.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.6.0)
+    reverse_markdown (2.1.1)
+      nokogiri
     rexml (3.2.5)
-    rubocop (1.29.1)
+    rubocop (1.35.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.13.3)
+    rubocop-performance (1.14.3)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
-    standard (1.12.1)
-      rubocop (= 1.29.1)
-      rubocop-performance (= 1.13.3)
+    standard (1.16.1)
+      rubocop (= 1.35.1)
+      rubocop-performance (= 1.14.3)
+    stringio (3.0.2)
     unicode-display_width (2.3.0)
 
 PLATFORMS

data/lib/rdoc/generator/markdown.rb

@@ -4,6 +4,7 @@ gem "rdoc"
 
 require "pathname"
 require "erb"
+require "reverse_markdown"
 
 # Markdown generator.
 # Registers command line options and generates markdown files
@@ -114,10 +115,19 @@ class RDoc::Generator::Markdown
       out_file = Pathname.new("#{output_dir}/#{klass.full_name}.md")
       out_file.dirname.mkpath
 
-      File.write(out_file, template.result(binding))
+      result = template.result(binding)
+
+      File.write(out_file, result)
     end
   end
 
+
+  private
+
+  def h(string)
+    ReverseMarkdown.convert string.strip, github_flavored: true
+  end
+
   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.4"
+    VERSION = "0.1.6"
   end
 end

data/lib/templates/classfile.md.erb

@@ -1,22 +1,21 @@
-# <%= klass&.name %>
-## <% if klass.type == 'class' %><%= klass.type.capitalize %>[<%= klass.full_name %>](<%= klass&.path %>)<% if klass.superclass %> inherits from <% end %><% unless String === klass.superclass %> [<%= klass.superclass&.name %>](<%= klass.superclass&.path %>) <% else %> <%= klass.superclass %> <% end %> <% else %> <%= klass.type.capitalize %> [<%= klass&.name %>](<%= klass&.path %>) <% end %>
-<% if klass.description && !klass.description.empty? %><%= klass.description %><% end %>
+# <%= klass.name %>
+## <% if klass.type == 'class' %><%= klass.type.capitalize %> [<%= klass.full_name %>](<%= klass&.path %>)<% if klass.superclass %> inherits from <% end %><% unless String === klass.superclass %>[<%= klass.superclass&.name %>](<%= klass.superclass&.path %>) <% else %> <%= klass.superclass %> <% end %> <% else %> <%= klass.type.capitalize %>[<%= klass&.name %>](<%= klass&.path %>) <% end %>
+<% if klass.description && !klass.description.empty? %><%= h klass.description %><% end %>
 <% unless klass.constants.empty? %>
 ### Constants
-<% klass.constants.sort_by { |x| x&.name }.each do |const| %> <%= const&.name %> <% end %>
-<% end %>
+<% klass.constants.sort_by { |x| x.name }.each do |const| %> <%= const.name %>
+<%= h const.description %>
+<% end %><% end %>
 <% unless klass.attributes.empty? %>
 ### Attributes
-<% klass.attributes.sort_by { |x| x&.name }.each do |attr| %><%= attr&.name %>
+<% klass.attributes.sort_by { |x| x.name }.each do |attr| %><%= attr.name %>
 <%= attr.rw %>
-<%= attr.description %>
-<% end %><% end %>
+<%= h attr.description %><% end %><% end %>
 <% unless klass_methods.empty? %>
 ### Public Class Methods
-<% klass_methods.each do |method| %>[<%= method&.name %><%= method.params %>](<%= method.aref %>)
-<%= method.description %><% end %>
-<% end %>
+<% klass_methods.each do |method| %>[<%= method.name %><%= method.params %>](<%= method.aref %>)
+<%= h method.description %><% end %><% end %>
 <% unless instance_methods.empty? %>
 ### Public Instance Methods
-<% instance_methods.each do |method| %>[<%= method&.name %><%= method.params %>](<%= method.aref %>)
-<%= method.description %><% end %><% end %>
+<% instance_methods.each do |method| %>[<%= method.name %><%= method.params %>](<%= method.aref %>)
+<% if method.name %><%= h method.description %><% end %><% end %><% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-14 00:00:00.000000000 Z
+date: 2022-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: reverse_markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement