rdoc-markdown 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dc08310ad6f937bfbcc7a72b7211a6edddbf648db128ce30ec4c587e9621a2f
-  data.tar.gz: 0b568a5565085bc5b43e03b0014c8348c5caac4728c767d2f2951ee16a4e3dba
+  metadata.gz: 2daaac73b6d46ee2f2905484aa1257b756a51ebafdbb44277e6a4ddf8f08aa75
+  data.tar.gz: 627b149db5aadce52067bc7d54d0b672d92f21729598497bea9160e2bca4f6a4
 SHA512:
-  metadata.gz: 41e397f9b061d8986711b312dd9c6253085aaa916af0d56e7cb51941baf8c306e04d9f6b30dcf21a859ffb87421e9de5893dbed433065cfdc897d2fb59c999a4
-  data.tar.gz: 888e34068d2755998ffba9e6d7054e8bb5bace927edce7bc8650f358a8a67fde40694ca3b8cb5f82c97bfd8b9d495e36949760e37ba3b43bdf88a927465d0c05
+  metadata.gz: 7f9e1802dee3d4c5c5e98977527951c24355b2ba17507e2cdda3a0b573b4fa8f830eb2224dbf13e9ee81848d4598a7c4d703c0db242dba0f6a081f950f917aa4
+  data.tar.gz: bf1e6cfb1f1f6e982d43dee939ce2c14323b664570e953d2248539899852e0c4f92c6fd3c20784844a12a54e19fe5fb5c5ac6f14fc217f90811dc87f16aeb713

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    rdoc-markdown (0.1.3)
+    rdoc-markdown (0.1.8)
       erb (~> 2.0)
       rdoc (~> 6.0)
+      reverse_markdown (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -13,14 +14,24 @@ GEM
     erb (2.2.3)
       cgi
     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)
+    rdoc (6.4.0)
+      psych (>= 4.0.0)
     regexp_parser (2.5.0)
+    reverse_markdown (2.1.1)
+      nokogiri
     rexml (3.2.5)
     rubocop (1.29.1)
       parallel (~> 1.10)
@@ -40,6 +51,7 @@ GEM
     standard (1.12.1)
       rubocop (= 1.29.1)
       rubocop-performance (= 1.13.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.3"
+    VERSION = "0.1.5"
   end
 end

data/lib/templates/classfile.md.erb

@@ -1,26 +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 %>
-<% unless klass.constants.empty? %><!-- Constants -->
+## <% 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 %>
-<% unless klass.attributes.empty? %><!-- Attributes -->
+<% klass.constants.sort_by { |x| x.name }.each do |const| %> <%= h 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| %><%= h attr.name %>
 <%= attr.rw %>
-<%= attr.description %>
-
-<% end %><% end %>
+<%= h attr.description %><% end %><% end %>
 <% unless klass_methods.empty? %>
-<!-- Class Methods -->
 ### Public Class Methods
-<% klass_methods.each do |method| %>[<%= method.name %><%= method.params %>](<%= method.aref %>)
-<%= method.description %><% end %>
-
-<% end %>
-<% unless instance_methods.empty? %><!-- Instance Methods -->
+<% klass_methods.each do |method| %>[<%= h method.name %><%= h 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| %>[<%= h method.name %><%= h 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.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-12 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
@@ -156,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.20
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: rdoc generator that produces markdown files