rdoc-markdown 0.1.7 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f30f6ccebebb94e820513965f5d8a7dece795f8fcc6fe94e209ceb89b465f653
-  data.tar.gz: 74bdeed8adbcc0a5c128ee77ebb65aee345f575eb76c52b59c63f5e611e74abe
+  metadata.gz: 2d08a05e31cacde411267507404584cf8b83a715e2001290e84f4b0ae3494106
+  data.tar.gz: cf679c7121051ed3c3dfe7615e9ef559d2ec8b023e2b1efd9666d9caa2de5ae7
 SHA512:
-  metadata.gz: 18daca03f85c417d3d87d5fe0247f5496acaa1d3454e327002a9c650c879646daee091012775cb95d066b941338a8c14f1e34969b9a3126476dffb9b9eb5208d
-  data.tar.gz: ec1f31981a90f6c5e09f83e51cf4fc6e6dbd2c3a701ba464d31a859746f403ab938b99b7cfcee38a56627a30f6df8cd325af8dafa00180eca2f347a9532cd6d8
+  metadata.gz: 9cbbf2f3f6fc21e199d426ed08d71c734f09daf155bb5bc9b37a65662094c735047f76cfe8d84e3ee92a3b998e21e3cbbf643b6f0702ab14a67467773b028ead
+  data.tar.gz: 4a9e28997fd4cda40d0510f29f9bc04a78a30140e5631dd0be4a38b7bfc9ae4a65d3fbae14de8d4d1853cac2c60b8ddf4a399653a171c757b605397368e193fc

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

@@ -6,9 +6,6 @@ require "pathname"
 require "erb"
 require "reverse_markdown"
 
-# Markdown generator.
-# Registers command line options and generates markdown files
-# RDoc documentation and options.
 class RDoc::Generator::Markdown
   RDoc::RDoc.add_generator self
 
@@ -33,21 +30,6 @@ class RDoc::Generator::Markdown
 
   attr_reader :classes
 
-  ##
-  # Files to be displayed by this generator
-
-  attr_reader :files
-
-  ##
-  # Methods to be displayed by this generator
-
-  attr_reader :methods
-
-  ##
-  # Sorted list of classes and modules to be displayed by this generator
-
-  attr_reader :modsort
-
   ##
   # Directory where generated class HTML files live relative to the output
   # dir.
@@ -66,9 +48,6 @@ class RDoc::Generator::Markdown
     @base_dir = Pathname.pwd.expand_path
 
     @classes = nil
-    @files = nil
-    @methods = nil
-    @modsort = nil
   end
 
   def generate
@@ -112,7 +91,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,10 +103,27 @@ class RDoc::Generator::Markdown
 
   private
 
-  def h(string)
-    ReverseMarkdown.convert string.strip, github_flavored: true
+  def turn_to_path(class_name)
+    class_name.gsub("::", "/")
   end
 
+  def markdownify(input)
+    md= ReverseMarkdown.convert input, github_flavored: true
+
+    # Replace .html to .md extension in all markdown links
+    md = md.gsub(/\[(.+)\]\((.+).html(.*)\)/) do |_|
+      match = Regexp.last_match
+
+      "[#{match[1]}](#{match[2]}.md#{match[3]})"
+    end
+
+    # clean up things, to make it look neat.
+
+    md.gsub("[↑](#top)", "").lstrip
+  end
+
+  alias_method  :h, :markdownify
+
   def setup
     return if instance_variable_defined?(:@output_dir)
 
@@ -136,8 +132,6 @@ class RDoc::Generator::Markdown
     return unless @store
 
     @classes = @store.all_classes_and_modules.sort
-    @files = @store.all_files.sort
-    @methods = @classes.map(&:method_list).flatten.sort
     @modsort = get_sorted_module_list @classes
   end
 

data/lib/rdoc/markdown/version.rb

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

data/lib/templates/classfile.md.erb

@@ -1,27 +1,24 @@
-# <% 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 %>
+# <% 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 %>
 <% end %><% end %>
 <% unless klass.attributes.empty? %>
 ## 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 %>
+<% 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 %>
+<% instance_methods.each do |method| %>### <%= method.name %><%= method.params %>
 
 <%= h method.description %><% end %><% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.10
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov