rdoc-markdown 0.3.5 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb88e163756c49396b718459f7d5dafc96350d4326d6fd1e57a13fc3ac011116
-  data.tar.gz: 2a7477e2eb1b98af6cd06933e67f129892a492971b9ce60b64da4d296a42ac18
+  metadata.gz: 701b08501deaf21f981b61001ec79249d506f685a755b0931ccb40f19a93690f
+  data.tar.gz: e3d5b50d3599a08004aaa182426477adeaeb539ff0215a92cd10485007282c88
 SHA512:
-  metadata.gz: fa23545b89bfedd7cec08dd8f387727df15fb75c6cc532b35566fcb2ab2e53f85c94c7ec88e364edf59df15c6d2363b8ad3f54ec51627c6b1cac6592c83f2188
-  data.tar.gz: ac8f4cd2f344afb9ac357ecd16202e40c60527e2db149fba53cff7ca55682561082c1a8a56958b914b5ba7c09a5d1c66b40b60b89c87bc51c3e8ef1c1d963987
+  metadata.gz: 79c8b70b7e4a2e5b1a763d66cb8e8210c8b51250c1afdcb0de9fb5a96607f3347f060731540426b7641767d1cd6bd50ad8be3a56749facdc16e3cb8e93c4c704
+  data.tar.gz: 051f1cf3cc914fededfebb6db13d0c121b82e5e01de1b51f43a5af27f886929a0b6a3ddea27c7691ea6d46707778c290be142483e065146e2fc0e7db4b131b48

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rdoc-markdown (0.3.3)
+    rdoc-markdown (0.4)
       erb (~> 2.0)
       extralite-bundle (~> 1.0)
       rdoc (~> 6.0)
@@ -33,29 +33,29 @@ GEM
     rdiscount (2.2.7)
     rdoc (6.4.0)
       psych (>= 4.0.0)
-    regexp_parser (2.6.0)
+    regexp_parser (2.6.1)
     reverse_markdown (2.1.1)
       nokogiri
     rexml (3.2.5)
-    rubocop (1.35.1)
+    rubocop (1.39.0)
       json (~> 2.3)
       parallel (~> 1.10)
       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.20.1, < 2.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.14.3)
+    rubocop-performance (1.15.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
-    standard (1.16.1)
-      rubocop (= 1.35.1)
-      rubocop-performance (= 1.14.3)
+    standard (1.18.1)
+      rubocop (= 1.39.0)
+      rubocop-performance (= 1.15.1)
     stringio (3.0.2)
     unicode-display_width (2.3.0)
     unindent (1.0)

data/README.md

@@ -13,6 +13,9 @@ Install gem and add to application's Gemfile by executing:
 If bundler is not being used to manage dependencies, install the gem by executing:
 
     $ gem install rdoc-markdown
+## Examples
+Find examples in [/examples](/example/) folder. You can regenerate examples by running `./bin/generate.sh`, it will produce examples based on file in `test/data/*` folder.
+
 
 ## Usage
 RDoc will auto-detect rdoc-markdown plugin if it was installed. You just need to instruct RDoc to produce markdown output instead of standard HTML through `format` parameter.

data/example/Bird.md

@@ -0,0 +1,17 @@
+# class Bird [](#class-Bird) [](#top)
+The base class for all birds.
+
+ ## Public Instance Methods
+ ### fly(string, number) -> bool [](#method-i-fly)
+ Fly somewhere.
+
+Flying is the most critical feature of birds.
+
+= Example
+
+fly(:south, 70)
+
+ ### speak() { |text| ... } [](#method-i-speak)
+ Produce some noise.
+
+ 

data/example/Duck.md

@@ -0,0 +1,50 @@
+# class Duck [](#class-Duck) [](#top)
+A duck is a [`Waterfowl`](Waterfowl.html) [`Bird`](Bird.html).
+
+Features:
+
+bird::
+
+- speak
+
+- fly
+
+waterfowl::
+
+- swim
+
+ ## Constants
+ | Name | Description |
+ | ---- | ----------- |
+ | **MAX_VELOCITY[](#MAX_VELOCITY)** | Not documented |
+ ## Bird overrides ## Constants
+ | Name | Description |
+ | ---- | ----------- |
+ | **MAX_VELOCITY[](#MAX_VELOCITY)** | Not documented |
+ ## Public Instance Methods
+ ### speak() { |speech| ... } [](#method-i-speak)
+ [`Duck`](Duck.html) overrides generic implementation.
+
+ ## Duck extensions ## Constants
+ | Name | Description |
+ | ---- | ----------- |
+ | **MAX_VELOCITY[](#MAX_VELOCITY)** | Not documented |
+ ## Attributes
+ ### domestic[RW] [](#attribute-i-domestic)
+ True for domestic ducks.
+
+ ### rubber[R] [](#attribute-i-rubber)
+ True for rubber ducks.
+
+ ## Public Class Methods
+ ### new(domestic, rubber) [](#method-c-new)
+ Creates a new duck.
+
+ ### rubber_ducks() [](#method-c-rubber_ducks)
+ Returns list of all rubber ducks.
+
+ ## Public Instance Methods
+ ### useful? -> bool [](#method-i-useful-3F)
+ Checks if this duck is a useful one.
+
+ 

data/example/Object.md

@@ -0,0 +1,6 @@
+# class Object [](#class-Object) [](#top)
+ ## Constants
+ | Name | Description |
+ | ---- | ----------- |
+ | **DEFAULT_DUCK_VELOCITY[](#DEFAULT_DUCK_VELOCITY)** | Default velocity for a flying duck. |
+ 

data/example/RDoc/Generator/Markdown.md

@@ -0,0 +1,30 @@
+# class RDoc::Generator::Markdown [](#class-RDoc::Generator::Markdown) [](#top)
+ ## Constants
+ | Name | Description |
+ | ---- | ----------- |
+ | **TEMPLATE_DIR[](#TEMPLATE_DIR)** | Defines a constant for directory where templates could be found |
+ ## Attributes
+ ### base_dir[R] [](#attribute-i-base_dir)
+ The path to generate files into, combined with `--op` from the options for a full path.
+
+ ### classes[R] [](#attribute-i-classes)
+ Classes and modules to be used by this generator, not necessarily displayed.
+
+ ### store[R] [](#attribute-i-store)
+ The RDoc::Store that is the source of the generated content
+
+ ## Public Class Methods
+ ### new(store, options) [](#method-c-new)
+ Initializer method for Rdoc::Generator::Markdown
+
+ ## Public Instance Methods
+ ### class_dir() [](#method-i-class_dir)
+ Directory where generated class HTML files live relative to the output dir.
+
+ ### file_dir() [](#method-i-file_dir)
+ this alias is required for rdoc to work
+
+ ### generate() [](#method-i-generate)
+ Generates markdown files and search index file
+
+ 

data/example/RDoc/Generator.md

@@ -0,0 +1,2 @@
+# module RDoc::Generator [](#module-RDoc::Generator) [](#top)
+ 

data/example/RDoc/Markdown.md

@@ -0,0 +1,2 @@
+# class RDoc::Markdown [](#class-RDoc::Markdown) [](#top)
+ 

data/example/RDoc.md

@@ -0,0 +1,2 @@
+# module RDoc [](#module-RDoc) [](#top)
+ 

data/example/Rdoc/Markdown.md

@@ -0,0 +1,6 @@
+# module Rdoc::Markdown [](#module-Rdoc::Markdown) [](#top)
+ ## Constants
+ | Name | Description |
+ | ---- | ----------- |
+ | **VERSION[](#VERSION)** | Not documented |
+ 

data/example/Rdoc.md

@@ -0,0 +1,2 @@
+# module Rdoc [](#module-Rdoc) [](#top)
+ 

data/example/TestGenerator.md

@@ -0,0 +1,10 @@
+# class TestGenerator [](#class-TestGenerator) [](#top)
+ ## Constants
+ | Name | Description |
+ | ---- | ----------- |
+ | **CLASSES[](#CLASSES)** | Not documented |
+ ## Public Instance Methods
+ ### run_generator(file, title) { |options| ... } [](#method-i-run_generator)
+ ### source_file() [](#method-i-source_file)
+ ### test_generator() [](#method-i-test_generator)
+ 

data/example/Waterfowl.md

@@ -0,0 +1,8 @@
+# module Waterfowl [](#module-Waterfowl) [](#top)
+A mixin for waterfowl creatures.
+
+ ## Public Instance Methods
+ ### swim() [](#method-i-swim)
+ Swimming helper.
+
+ 

data/lib/rdoc/generator/markdown.rb

@@ -151,12 +151,14 @@ class RDoc::Generator::Markdown
 
   def emit_classfiles
     @classes.each do |klass|
-      template = ERB.new File.read(File.join(TEMPLATE_DIR, "classfile.md.erb"))
+      template_content = File.read(File.join(TEMPLATE_DIR, "classfile.md.erb"))
+
+      template = ERB.new template_content, trim_mode: ">"
 
       out_file = Pathname.new("#{output_dir}/#{turn_to_path klass.full_name}")
       out_file.dirname.mkpath
 
-      result = template.result(binding).squeeze(" ").gsub("\n ", "\n").squeeze("\n\n")
+      result = template.result(binding).squeeze("  ")
 
       File.write(out_file, result)
     end
@@ -172,6 +174,7 @@ class RDoc::Generator::Markdown
   ##
   # Converts HTML string into a Markdown string with some cleaning and improvements.
 
+  # FIXME: This could return string with newlines in the end, which is not good.
   def markdownify(input)
     # TODO: I should be able to set unknown_tags to "raise" for debugging purposes. Probably through rdoc parameters?
     # Allowed parameters:

data/lib/rdoc/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module Rdoc
   module Markdown
-    VERSION = "0.3.5"
+    VERSION = "0.4"
   end
 end

data/lib/templates/classfile.md.erb

@@ -7,8 +7,7 @@
 ## Constants
  | Name | Description |
  | ---- | ----------- |
-    <% klass.constants.each do |const| %>
- | **<%= const.name %>[](#<%= const.name %>)** | <% unless const.description.empty? %> <%= h const.description %> <%else%> Not documented <% end %> |
+<% klass.constants.each do |const| %> | **<%= const.name %>[](#<%= const.name %>)** | <% unless const.description.empty? %> <%= h(const.description).rstrip %> <%else%> Not documented <% end %> |
     <% end %>
   <% end %>
   <% unless attributes&.empty? %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: '0.4'
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-05 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -166,6 +166,18 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- example/Bird.md
+- example/Duck.md
+- example/Object.md
+- example/RDoc.md
+- example/RDoc/Generator.md
+- example/RDoc/Generator/Markdown.md
+- example/RDoc/Markdown.md
+- example/Rdoc.md
+- example/Rdoc/Markdown.md
+- example/TestGenerator.md
+- example/Waterfowl.md
+- example/index.db
 - lib/markdown.rb
 - lib/rdoc/discover.rb
 - lib/rdoc/generator/markdown.rb