rdoc-markdown 0.3.6 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc9298f0cd81d54367d58d68aa1cacead0c80be2e43ea591f5fe4bbf29e44ca5
-  data.tar.gz: 15b4e889626b4b06fe2cd98e910f26d974d849690cb11a351e6fcceae55aeae1
+  metadata.gz: '04187562054e01d97859f87c42e588055506e1d0ab78669835b5f65a7e14c593'
+  data.tar.gz: a820cbc371a8162c16d9890bac3314f8b7ae48d04b94008ceae9fd6bdcf5e97f
 SHA512:
-  metadata.gz: 779545ebd9dfdb19e8c474ff3ae851586ac9bddf069e74a828fe9cc2c482e4c1ca22fd11330065c35419099612d8977001b63940d4f583d3f6de838ccdbde25d
-  data.tar.gz: 2f2306bff2ca81fd87487db0f771ce24ecd4fbe4ceb8dfe379b538ea2d11689c7d7133dd91f380ce9248bafd51d3ac09bb1477f18e7adde4731444092b296415
+  metadata.gz: ee0a7344183d0fe1a18c73f405788992f17f049dea350fc2f9a6160796d0504eadbaf4776ffb12a5aa647e161b8ef286d52d2b471547a5de7afe529638c76216
+  data.tar.gz: c3ac8c7a7de779783384a36474419e80bbddcf219727ed13694ad238055c7b9ca88b7d86deda629f6c1861cfe0f1d2453d20dc9ab98b5b9f46a0cbf83fe19369

data/.streerc

@@ -0,0 +1,2 @@
+--print-width=100
+--plugins=plugin/trailing_comma,disable_ternary

data/Gemfile

@@ -8,5 +8,5 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
-
-gem "standard", "~> 1.3"
+gem "syntax_tree"
+gem "syntax_tree-disable_ternary"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rdoc-markdown (0.3.7)
+    rdoc-markdown (0.4.2)
       erb (~> 2.0)
       extralite-bundle (~> 1.0)
       rdoc (~> 6.0)
@@ -11,57 +11,34 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
     cgi (0.3.3)
     erb (2.2.3)
       cgi
     extralite-bundle (1.17)
-    json (2.6.2)
+    mini_portile2 (2.8.4)
     minitest (5.16.3)
-    nokogiri (1.13.9-arm64-darwin)
+    nokogiri (1.13.9)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    nokogiri (1.13.9-x86_64-linux)
-      racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.1.2.1)
-      ast (~> 2.4.1)
+    prettier_print (1.2.1)
     psych (4.0.6)
       stringio
     racc (1.6.0)
-    rainbow (3.1.1)
     rake (13.0.6)
     rdiscount (2.2.7)
     rdoc (6.4.0)
       psych (>= 4.0.0)
-    regexp_parser (2.6.1)
     reverse_markdown (2.1.1)
       nokogiri
-    rexml (3.2.5)
-    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.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.15.0)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
-    standard (1.18.0)
-      rubocop (= 1.39.0)
-      rubocop-performance (= 1.15.0)
     stringio (3.0.2)
-    unicode-display_width (2.3.0)
+    syntax_tree (6.1.1)
+      prettier_print (>= 1.2.0)
+    syntax_tree-disable_ternary (1.0.0)
     unindent (1.0)
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
@@ -70,7 +47,8 @@ DEPENDENCIES
   rake (~> 13.0)
   rdiscount (~> 2.0)
   rdoc-markdown!
-  standard (~> 1.3)
+  syntax_tree
+  syntax_tree-disable_ternary
 
 BUNDLED WITH
-   2.3.20
+   2.4.19

data/README.md

@@ -22,7 +22,7 @@ RDoc will auto-detect rdoc-markdown plugin if it was installed. You just need to
 
 Run following command in directory with ruby source code:
 
-`rdoc --format=markdown --markup=markdown`
+`rdoc --format=markdown`
 
 This will produce a tree of markdown documents and search index in `/doc` folder. Every class in library will have it's own markdown file.
 

data/Rakefile

@@ -1,6 +1,5 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
-require "standard/rake"
 
 Rake::TestTask.new do |t|
   t.verbose = true
@@ -8,4 +7,4 @@ Rake::TestTask.new do |t|
   t.test_files = FileList["test/test*.rb"]
 end
 
-task default: [:test, "standard:fix"]
+task default: [:test]

data/example/Bird.md

@@ -7,10 +7,11 @@ The base class for all birds.
 
 Flying is the most critical feature of birds.
 
-= Example
-
-fly(:south, 70)
+# Example[¶](#method-i-fly-label-Example) [↑](#top)
 
+```
+fly(:south,70)
+```
  ### speak() { |text| ... } [](#method-i-speak)
  Produce some noise.
 

data/example/Duck.md

@@ -3,21 +3,22 @@ A duck is a [`Waterfowl`](Waterfowl.html) [`Bird`](Bird.html).
 
 Features:
 
+```
 bird::
 
-- speak
-
-- fly
+ * speak
+ * fly
 
 waterfowl::
 
-- swim
-
+ * swim
+```
  ## Constants
  | Name | Description |
  | ---- | ----------- |
  | **MAX_VELOCITY[](#MAX_VELOCITY)** | Not documented |
- ## Bird overrides ## Constants
+ # Bird overrides
+ ## Constants
  | Name | Description |
  | ---- | ----------- |
  | **MAX_VELOCITY[](#MAX_VELOCITY)** | Not documented |
@@ -25,7 +26,8 @@ waterfowl::
  ### speak() { |speech| ... } [](#method-i-speak)
  [`Duck`](Duck.html) overrides generic implementation.
 
- ## Duck extensions ## Constants
+ # Duck extensions
+ ## Constants
  | Name | Description |
  | ---- | ----------- |
  | **MAX_VELOCITY[](#MAX_VELOCITY)** | Not documented |

data/example/Object.md

@@ -2,7 +2,5 @@
  ## Constants
  | Name | Description |
  | ---- | ----------- |
- | **DEFAULT_DUCK_VELOCITY[](#DEFAULT_DUCK_VELOCITY)** | Default velocity for a flying duck.
-
- |
+ | **DEFAULT_DUCK_VELOCITY[](#DEFAULT_DUCK_VELOCITY)** | Default velocity for a flying duck. |
  

data/example/RDoc/Generator/Markdown.md

@@ -2,9 +2,7 @@
  ## Constants
  | Name | Description |
  | ---- | ----------- |
- | **TEMPLATE_DIR[](#TEMPLATE_DIR)** | Defines a constant for directory where templates could be found
-
- |
+ | **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.

data/example/RDoc/Markdown.md

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

data/example/RDoc.md

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

data/lib/rdoc/discover.rb

@@ -1 +1,7 @@
-require "markdown"
+begin
+  require "markdown"
+rescue LoadError => error
+  puts error
+end
+
+puts "rdoc-markdown was discovered" if $DEBUG

data/lib/rdoc/generator/markdown.rb

@@ -14,9 +14,7 @@ class RDoc::Generator::Markdown
   ##
   # Defines a constant for directory where templates could be found
 
-  TEMPLATE_DIR = File.expand_path(
-    File.join(File.dirname(__FILE__), "..", "..", "templates")
-  )
+  TEMPLATE_DIR = File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "templates"))
 
   ##
   # The RDoc::Store that is the source of the generated content
@@ -114,7 +112,7 @@ class RDoc::Generator::Markdown
       result << {
         name: klass.full_name,
         type: klass.type.capitalize,
-        path: turn_to_path(klass.full_name)
+        path: turn_to_path(klass.full_name),
       }
 
       klass.method_list.each do |method|
@@ -123,25 +121,31 @@ class RDoc::Generator::Markdown
         result << {
           name: "#{klass.full_name}.#{method.name}",
           type: "Method",
-          path: "#{turn_to_path(klass.full_name)}##{method.aref}"
+          path: "#{turn_to_path(klass.full_name)}##{method.aref}",
         }
       end
 
-      klass.constants.sort_by { |x| x.name }.each do |const|
-        result << {
-          name: "#{klass.full_name}.#{const.name}",
-          type: "Constant",
-          path: "#{turn_to_path(klass.full_name)}##{const.name}"
-        }
-      end
-
-      klass.attributes.sort_by { |x| x.name }.each do |attr|
-        result << {
-          name: "#{klass.full_name}.#{attr.name}",
-          type: "Attribute",
-          path: "#{turn_to_path(klass.full_name)}##{attr.aref}"
-        }
-      end
+      klass
+        .constants
+        .sort_by { |x| x.name }
+        .each do |const|
+          result << {
+            name: "#{klass.full_name}.#{const.name}",
+            type: "Constant",
+            path: "#{turn_to_path(klass.full_name)}##{const.name}",
+          }
+        end
+
+      klass
+        .attributes
+        .sort_by { |x| x.name }
+        .each do |attr|
+          result << {
+            name: "#{klass.full_name}.#{attr.name}",
+            type: "Attribute",
+            path: "#{turn_to_path(klass.full_name)}##{attr.aref}",
+          }
+        end
     end
 
     result.each do |rec|
@@ -174,6 +178,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.6"
+    VERSION = "0.4.2"
   end
 end

data/lib/templates/classfile.md.erb

@@ -1,13 +1,17 @@
 # <%= 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%>
+  <% 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 %> <%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? %>

data/rdoc-markdown.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/rdoc/markdown/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rdoc-markdown"
+  spec.version = Rdoc::Markdown::VERSION
+  spec.authors = ["Stanislav (Stas) Katkov"]
+  spec.email = ["github@skatkov.com"]
+  spec.license = "GPL-3.0-or-later"
+
+  spec.summary = "RDoc plugin to generate markdown documentation  "
+  spec.description = "RDoc plugin to generate markdown documentation and search index as sqlite database for entire content."
+  spec.homepage = "https://poshtui.com"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/skatkov/rdoc-markdown"
+  spec.metadata["changelog_uri"] = "https://github.com/skatkov/rdoc-markdown"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rdoc", "~> 6.0"
+  spec.add_dependency "erb", "~> 2.0"
+  spec.add_dependency "reverse_markdown", "~> 2.0"
+  spec.add_dependency "extralite-bundle", "~> 1.0"
+  spec.add_dependency "unindent", "~> 1.0"
+
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rdiscount", "~> 2.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.2
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-20 00:00:00.000000000 Z
+date: 2023-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -122,20 +122,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: standard
-  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: rdiscount
   requirement: !ruby/object:Gem::Requirement
@@ -160,6 +146,7 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".standard.yml"
+- ".streerc"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -173,8 +160,6 @@ files:
 - 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
@@ -183,6 +168,7 @@ files:
 - lib/rdoc/generator/markdown.rb
 - lib/rdoc/markdown/version.rb
 - lib/templates/classfile.md.erb
+- rdoc-markdown.gemspec
 - sig/rdoc/markdown.rbs
 homepage: https://poshtui.com
 licenses:
@@ -206,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: RDoc plugin to generate markdown documentation

data/example/Rdoc/Markdown.md

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

data/example/Rdoc.md

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