rdoc-markdown 0.1.8 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d00a1ac32eb71f6eff97e6ee46bb1756c5fad8d97125c269ca0a1a5ba69f8061
-  data.tar.gz: 34ee2b38e839454a19f197466248db8033076d5113fb4da9895a4ed5a9b00e98
+  metadata.gz: 2d08a05e31cacde411267507404584cf8b83a715e2001290e84f4b0ae3494106
+  data.tar.gz: cf679c7121051ed3c3dfe7615e9ef559d2ec8b023e2b1efd9666d9caa2de5ae7
 SHA512:
-  metadata.gz: d0a1f0294c47c08f72134820afc998a5d01dc4a20d7588df73f9dcbde9ce1b778282480ac35d9d95fea3b73b738ba9e30166bbf861f493713e18b8b3c4b2a300
-  data.tar.gz: 3dc3972ce4e1ef10116c2fa1dcb04ad980e9a73068d79a6399e0abbcca3b49f16f28fe5db1855bc353643cedf92c781853c56e7e9a0bf09b4c55783d539537a8
+  metadata.gz: 9cbbf2f3f6fc21e199d426ed08d71c734f09daf155bb5bc9b37a65662094c735047f76cfe8d84e3ee92a3b998e21e3cbbf643b6f0702ab14a67467773b028ead
+  data.tar.gz: 4a9e28997fd4cda40d0510f29f9bc04a78a30140e5631dd0be4a38b7bfc9ae4a65d3fbae14de8d4d1853cac2c60b8ddf4a399653a171c757b605397368e193fc

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
@@ -124,22 +103,27 @@ class RDoc::Generator::Markdown
 
   private
 
-  def replace_extensions_in_links(text)
-    text.gsub(/\[(.+)\]\((.+).html(.*)\)/) do |_|
+  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
-  end
 
-  def turn_to_path(class_name)
-    class_name.gsub("::", "/")
-  end
+    # clean up things, to make it look neat.
 
-  def h(string)
-    replace_extensions_in_links ReverseMarkdown.convert string.strip, github_flavored: true
+    md.gsub("[↑](#top)", "").lstrip
   end
 
+  alias_method  :h, :markdownify
+
   def setup
     return if instance_variable_defined?(:@output_dir)
 
@@ -148,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.8"
+    VERSION = "0.1.10"
   end
 end

data/lib/templates/classfile.md.erb

@@ -1,5 +1,5 @@
-# <% 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
 ***

metadata

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