rdoc-markdown 0.5.0 → 0.7.0

data/lib/rdoc/markdown/version.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+# Gem metadata namespace.
 module Rdoc
+  # Version namespace for rdoc-markdown.
   module Markdown
-    VERSION = "0.5.0"
+    # Current gem version.
+    VERSION = "0.7.0"
   end
 end

data/lib/templates/classfile.md.erb

@@ -1,35 +1,56 @@
-# <%= klass.type %> <%= klass.full_name %> [](#<%= klass.aref.strip %>) [](#top)
-<%= h klass.description %>
-<% klass.each_section do |section, constants, attributes| %>
-  <% if section.title %># <%= section.title.strip %>
-
-  <% end %>
-  <% if section.comment %> <%=h  section.description %>
-
-  <%end%>
-  <% unless klass.constants.empty? %>
-## Constants
- | Name | Description |
- | ---- | ----------- |
-<% 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? %>
-## Attributes
-    <% attributes.each do |attr| %>
-### <%= attr.name %>[<%= attr.rw %>] [](#<%= attr.aref.strip %>)
-<% if attr.comment %> <%= h(attr.description) %> <%else%> Not documented <% end %>
-    <% end %>
-  <% end %>
-  <% klass.methods_by_type(section).each do |type, visibilities| %>
-    <% next if visibilities.empty? %>
-    <% visibilities.each do |visibility, methods| %>
-      <% next if methods.empty? %>
-##  <%= visibility.capitalize %> <%= type.capitalize %> Methods
-      <% methods.each do |method|%>
-### <%= method.name %><%= method.param_seq %> [](#<%= method.aref %>)
-<% if method.comment %> <%= h(method.description) %>  <% else %> Not documented <%end%>
-      <% end %>
-    <% end %>
-  <% end %>
-<% end %>
+# <%= klass.type.capitalize %> <%= display_name(klass) %>
+<%= anchor(klass.aref.strip) %>
+<%- class_description = describe(klass) -%>
+<%- unless class_description.empty? -%>
+
+<%= class_description %>
+<%- end -%>
+
+<% klass.each_section do |section, constants, attributes| -%>
+<%- section_title = section.title.to_s.strip -%>
+<%- unless section_title.empty? -%>
+
+## <%= section_title %>
+<%- end -%>
+<%- section_description = section_description(section, heading_level_offset: 2) -%>
+<%- unless section_description.empty? -%>
+
+<%= section_description %>
+<%- end -%>
+<%- unless constants.empty? -%>
+
+### Constants
+<% constants.sort_by(&:name).each do |const| -%>
+
+#### `<%= const.name %>`
+<%= anchor(const.name) %>
+
+<%= describe(const, fallback: "Not documented.", heading_level_offset: 4) %>
+<% end -%>
+<%- end -%>
+<%- unless attributes.empty? -%>
+
+### Attributes
+<% attributes.sort_by(&:name).each do |attr| -%>
+
+#### `<%= attr.name %>` [<%= attr.rw %>]
+<%= anchor(attr.aref.strip) %>
+
+<%= describe(attr, fallback: "Not documented.", heading_level_offset: 4) %>
+<% end -%>
+<%- end -%>
+<% klass.methods_by_type(section).each do |type, visibilities| -%>
+<% visibilities.each do |visibility, methods| -%>
+<% next if methods.empty? -%>
+
+### <%= visibility.capitalize %> <%= type.capitalize %> Methods
+<% methods.each do |method| -%>
+
+#### `<%= method.name %><%= method_signature(method) %>`
+<%= anchor(method.aref) %>
+
+<%= method_description(method, current_class: klass) %>
+<% end -%>
+<% end -%>
+<% end -%>
+<% end -%>

data/mutant.yml

@@ -0,0 +1,15 @@
+usage: opensource
+
+integration:
+  name: minitest
+
+includes:
+  - lib
+  - test
+
+requires:
+  - ./test/support/mutant.rb
+
+matcher:
+  subjects:
+    - RDoc::Generator::Markdown*

data/rdoc-markdown.gemspec

@@ -31,14 +31,16 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rdoc"
+  spec.add_dependency "csv"
   spec.add_dependency "erb"
+  spec.add_dependency "rdoc"
   spec.add_dependency "reverse_markdown"
-  spec.add_dependency "unindent"
-  spec.add_dependency "csv"
 
+  spec.add_development_dependency "bundler", ">= 2.0"
+  spec.add_development_dependency "commonmarker"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-strict", "~> 1.0"
   spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rdiscount", "~> 2.0"
+  spec.add_development_dependency "simplecov", "~> 0.22"
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 bindir: exe
 cert_chain: []
-date: 2024-12-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: csv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,7 +38,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: reverse_markdown
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: unindent
+  name: reverse_markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,13 +66,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: csv
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: commonmarker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -93,6 +107,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-strict
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +136,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rdiscount
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -122,19 +150,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rdiscount
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.22'
 description: RDoc plugin to generate markdown documentation and search index as sqlite
   database for entire content.
 email:
@@ -144,6 +172,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".erb_lint.yml"
+- ".erb_linters/no_embedded_assets.rb"
+- ".erb_linters/non_raw_html.rb"
+- ".standard.yml"
+- ".yard-lint.yml"
+- AGENTS.md
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -155,11 +190,13 @@ files:
 - example/Object.md
 - example/Waterfowl.md
 - example/index.csv
+- gemfiles/rdoc_head.gemfile
 - lib/markdown.rb
 - lib/rdoc/discover.rb
 - lib/rdoc/generator/markdown.rb
 - lib/rdoc/markdown/version.rb
 - lib/templates/classfile.md.erb
+- mutant.yml
 - rdoc-markdown.gemspec
 - sig/rdoc/markdown.rbs
 homepage: https://poshtui.com
@@ -183,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.10
 specification_version: 4
 summary: RDoc plugin to generate markdown documentation
 test_files: []