rdoc-markdown 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9cdfb6613fd3bab8a492f7faa4338178df35489955e3282b70ab32002624be5
-  data.tar.gz: a09b470cfeb56feff5b7867fe9b59be2242ad6be49454d0198b33995c780c1aa
+  metadata.gz: d00a1ac32eb71f6eff97e6ee46bb1756c5fad8d97125c269ca0a1a5ba69f8061
+  data.tar.gz: 34ee2b38e839454a19f197466248db8033076d5113fb4da9895a4ed5a9b00e98
 SHA512:
-  metadata.gz: 8404bb773b50e88d87648e4cf516ac87bd9a8c0d0455f93980ba590d7d02912879d7abec888bbd04da88cb3c625f1c1c15d1cec7819c5fed717dbbd0b134f2cd
-  data.tar.gz: a8a8c38c3cbe9f93caf9dfe4f81d79ba568116f10d549cac561a794394273a3296afbcee54440ff0b1319cef62023b42ac5a299de055e6f6d8da48e63758dab8
+  metadata.gz: d0a1f0294c47c08f72134820afc998a5d01dc4a20d7588df73f9dcbde9ce1b778282480ac35d9d95fea3b73b738ba9e30166bbf861f493713e18b8b3c4b2a300
+  data.tar.gz: 3dc3972ce4e1ef10116c2fa1dcb04ad980e9a73068d79a6399e0abbcca3b49f16f28fe5db1855bc353643cedf92c781853c56e7e9a0bf09b4c55783d539537a8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rdoc-markdown (0.1.5)
+    rdoc-markdown (0.1.7)
       erb (~> 2.0)
       rdoc (~> 6.0)
       reverse_markdown (~> 2.0)

data/README.md

@@ -1,8 +1,8 @@
-!!! This is just experimental gem
-
 # 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.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -20,7 +20,7 @@ First thing to do, is to install a gem
 
 Then proceed to directory where you want to generate documentation:
 
-`rdoc --format=markdown"
+`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).
 
@@ -48,8 +48,8 @@ gem push rdoc-markdown-0.1.2.gem
 ```
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/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/[USERNAME]/rdoc-markdown/blob/master/CODE_OF_CONDUCT.md).
+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).
 
 ## Code of Conduct
 
-Everyone interacting in the Rdoc::Markdown project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rdoc-markdown/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Rdoc::Markdown project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/skatkov/rdoc-markdown/blob/master/CODE_OF_CONDUCT.md).

data/lib/rdoc/generator/markdown.rb

@@ -112,7 +112,7 @@ class RDoc::Generator::Markdown
 
       template = ERB.new File.read(File.join(TEMPLATE_DIR, "classfile.md.erb"))
 
-      out_file = Pathname.new("#{output_dir}/#{klass.full_name}.md")
+      out_file = Pathname.new("#{output_dir}/#{turn_to_path klass.full_name}.md")
       out_file.dirname.mkpath
 
       result = template.result(binding)
@@ -124,8 +124,20 @@ class RDoc::Generator::Markdown
 
   private
 
+  def replace_extensions_in_links(text)
+    text.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
+
   def h(string)
-    ReverseMarkdown.convert string.strip, github_flavored: true
+    replace_extensions_in_links ReverseMarkdown.convert string.strip, github_flavored: true
   end
 
   def setup

data/lib/rdoc/markdown/version.rb

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

data/lib/templates/classfile.md.erb

@@ -1,21 +1,24 @@
-# <%= 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 %>
+# <% 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
-<% klass.constants.sort_by { |x| x.name }.each do |const| %> <%= const.name %>
-<%= h const.description %>
+## Constants
+***
+<% 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 %>
-<%= attr.rw %>
-<%= h attr.description %><% end %><% end %>
+## Attributes
+<% klass.attributes.sort_by { |x| x.name }.each do |attr| %>
+  **[<%= attr.rw %>]** <%= attr.name %>
+<% end %><% end %>
 <% unless klass_methods.empty? %>
-### Public Class Methods
-<% klass_methods.each do |method| %>[<%= method.name %><%= method.params %>](<%= method.aref %>)
+## Public Class Methods
+***
+<% klass_methods.each do |method| %>### <%= method.name %><%= method.params %>
+
 <%= h method.description %><% end %><% end %>
 <% unless instance_methods.empty? %>
-### Public Instance Methods
-<% instance_methods.each do |method| %>[<%= method.name %><%= method.params %>](<%= method.aref %>)
-<% if method.name %><%= h method.description %><% end %><% end %><% end %>
+## Public Instance Methods
+<% instance_methods.each do |method| %>### <%= method.name %><%= method.params %>
+
+<%= h method.description %><% end %><% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-15 00:00:00.000000000 Z
+date: 2022-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc