rdoc-markdown 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '04187562054e01d97859f87c42e588055506e1d0ab78669835b5f65a7e14c593'
-  data.tar.gz: a820cbc371a8162c16d9890bac3314f8b7ae48d04b94008ceae9fd6bdcf5e97f
+  metadata.gz: df1f3da8afd7010551e9edbaf2f33de617d63584760e3c59120c6f3b38232f19
+  data.tar.gz: 82b591023300cf619230ef8786b3ae10ed3cb5d2aadae9afcd43b5da4c0528b7
 SHA512:
-  metadata.gz: ee0a7344183d0fe1a18c73f405788992f17f049dea350fc2f9a6160796d0504eadbaf4776ffb12a5aa647e161b8ef286d52d2b471547a5de7afe529638c76216
-  data.tar.gz: c3ac8c7a7de779783384a36474419e80bbddcf219727ed13694ad238055c7b9ca88b7d86deda629f6c1861cfe0f1d2453d20dc9ab98b5b9f46a0cbf83fe19369
+  metadata.gz: ac5335f705812d01d5bd24488cda5fb77ce69f8fa6b32677b13f048aab476062c0845681324f3b05de9c0965bbcc2c0f1c64dbb5e4f58dc5ee8a8c4a8906dd33
+  data.tar.gz: b682c9b99cace11662bff88be24560b370a2b8a084ec9fac47a854e90a0bfdfafd246e4c62d9c84055c426bcaf3572d1f69bb2e0d02aacc838a7be46e6da8b01

data/Gemfile

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

data/Gemfile.lock

@@ -1,45 +1,60 @@
 PATH
   remote: .
   specs:
-    rdoc-markdown (0.4.2)
-      erb (~> 2.0)
-      extralite-bundle (~> 1.0)
-      rdoc (~> 6.0)
-      reverse_markdown (~> 2.0)
-      unindent (~> 1.0)
+    rdoc-markdown (0.5.0)
+      csv
+      erb
+      rdoc
+      reverse_markdown
+      unindent
 
 GEM
   remote: https://rubygems.org/
   specs:
-    cgi (0.3.3)
-    erb (2.2.3)
-      cgi
-    extralite-bundle (1.17)
-    mini_portile2 (2.8.4)
-    minitest (5.16.3)
-    nokogiri (1.13.9)
-      mini_portile2 (~> 2.8.0)
-      racc (~> 1.4)
-    prettier_print (1.2.1)
-    psych (4.0.6)
+    cgi (0.4.1)
+    csv (3.3.2)
+    date (3.4.1)
+    erb (4.0.4)
+      cgi (>= 0.3.3)
+    minitest (5.25.4)
+    nokogiri (1.18.0-aarch64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.0-aarch64-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.0-arm-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.0-arm-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.0-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.0-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.0-x86_64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.0-x86_64-linux-musl)
+      racc (~> 1.4)
+    psych (5.2.2)
+      date
       stringio
-    racc (1.6.0)
-    rake (13.0.6)
-    rdiscount (2.2.7)
-    rdoc (6.4.0)
+    racc (1.8.1)
+    rake (13.2.1)
+    rdiscount (2.2.7.3)
+    rdoc (6.10.0)
       psych (>= 4.0.0)
-    reverse_markdown (2.1.1)
+    reverse_markdown (3.0.0)
       nokogiri
-    stringio (3.0.2)
-    syntax_tree (6.1.1)
-      prettier_print (>= 1.2.0)
-    syntax_tree-disable_ternary (1.0.0)
+    stringio (3.1.2)
     unindent (1.0)
 
 PLATFORMS
-  arm64-darwin-21
-  arm64-darwin-22
-  x86_64-linux
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
 
 DEPENDENCIES
   bundler (~> 2.0)
@@ -47,8 +62,6 @@ DEPENDENCIES
   rake (~> 13.0)
   rdiscount (~> 2.0)
   rdoc-markdown!
-  syntax_tree
-  syntax_tree-disable_ternary
 
 BUNDLED WITH
-   2.4.19
+   2.6.1

data/README.md

@@ -1,9 +1,6 @@
 # RDoc-Markdown
 RDoc plugin to generate markdown documentation and search index backed by sqlite database.
 
-## Motivation
-I'm trying to depend less on software with GUI, instead using software that could be used through console. **Documentation in markdown format allows me to review documentation in console**, instead of browser or GUI software like DevDocs.
-
 ## Installation
 
 Install gem and add to application's Gemfile by executing:

data/example/index.csv

@@ -0,0 +1,16 @@
+name,type,path
+Bird,Class,Bird.md
+Bird.speak,Method,Bird.md#method-i-speak
+Bird.fly,Method,Bird.md#method-i-fly
+Duck,Class,Duck.md
+Duck.speak,Method,Duck.md#method-i-speak
+Duck.rubber_ducks,Method,Duck.md#method-c-rubber_ducks
+Duck.new,Method,Duck.md#method-c-new
+Duck.useful?,Method,Duck.md#method-i-useful-3F
+Duck.MAX_VELOCITY,Constant,Duck.md#MAX_VELOCITY
+Duck.domestic,Attribute,Duck.md#attribute-i-domestic
+Duck.rubber,Attribute,Duck.md#attribute-i-rubber
+Object,Class,Object.md
+Object.DEFAULT_DUCK_VELOCITY,Constant,Object.md#DEFAULT_DUCK_VELOCITY
+Waterfowl,Module,Waterfowl.md
+Waterfowl.swim,Method,Waterfowl.md#method-i-swim

data/lib/rdoc/generator/markdown.rb

@@ -5,8 +5,8 @@ gem "rdoc"
 require "pathname"
 require "erb"
 require "reverse_markdown"
-require "extralite"
 require "unindent"
+require "csv"
 
 class RDoc::Generator::Markdown
   RDoc::RDoc.add_generator self
@@ -60,8 +60,6 @@ class RDoc::Generator::Markdown
   # Generates markdown files and search index file
 
   def generate
-    # TODO: Make sure to set --markup parameter to 'markdown'.
-
     debug("Setting things up #{@output_dir}")
 
     setup
@@ -70,9 +68,9 @@ class RDoc::Generator::Markdown
 
     emit_classfiles
 
-    debug("Generate search index in #{output_dir}/index.db")
+    debug("Generate index file in #{@output_dir}")
 
-    emit_sqlite
+    emit_csv_index
   end
 
   private
@@ -94,62 +92,52 @@ class RDoc::Generator::Markdown
   # This class emits a search index for generated documentation as sqlite database
   #
 
-  def emit_sqlite(name = "index.db")
-    db = Extralite::Database.new("#{output_dir}/#{name}")
-
-    db.execute <<-SQL
-      create table contentIndex (
-        id INTEGER PRIMARY KEY,
-        name TEXT,
-        type TEXT,
-        path TEXT
-      );
-    SQL
-
-    result = []
-
-    @classes.map do |klass|
-      result << {
-        name: klass.full_name,
-        type: klass.type.capitalize,
-        path: turn_to_path(klass.full_name),
-      }
-
-      klass.method_list.each do |method|
-        next if method.visibility.to_s.eql?("private")
-
-        result << {
-          name: "#{klass.full_name}.#{method.name}",
-          type: "Method",
-          path: "#{turn_to_path(klass.full_name)}##{method.aref}",
-        }
-      end
+  def emit_csv_index(name = "index.csv")
+    filepath = "#{output_dir}/#{name}"
 
-      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
+    CSV.open(filepath, "wb") do |csv|
+       csv << %w[name type path]
+
+      @classes.map do |klass|
+        csv << [
+          klass.full_name,
+          klass.type.capitalize,
+          turn_to_path(klass.full_name),
+        ]
 
-      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}",
-          }
+        klass.method_list.each do |method|
+          next if method.visibility.to_s.eql?("private")
+          next if method.visibility.to_s.eql?("protected")
+
+          csv << [
+            "#{klass.full_name}.#{method.name}",
+            "Method",
+            "#{turn_to_path(klass.full_name)}##{method.aref}",
+          ]
         end
-    end
 
-    result.each do |rec|
-      db.execute "insert into contentIndex (name, type, path) values (:name, :type, :path)", rec
+        klass
+          .constants
+          .sort_by { |x| x.name }
+          .each do |const|
+            csv << [
+              "#{klass.full_name}.#{const.name}",
+              "Constant",
+              "#{turn_to_path(klass.full_name)}##{const.name}",
+            ]
+          end
+
+        klass
+          .attributes
+          .sort_by { |x| x.name }
+          .each do |attr|
+            csv << [
+              "#{klass.full_name}.#{attr.name}",
+              "Attribute",
+              "#{turn_to_path(klass.full_name)}##{attr.aref}",
+            ]
+          end
+      end
     end
   end
 

data/lib/rdoc/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module Rdoc
   module Markdown
-    VERSION = "0.4.2"
+    VERSION = "0.5.0"
   end
 end

data/rdoc-markdown.gemspec

@@ -31,11 +31,11 @@ Gem::Specification.new do |spec|
   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_dependency "rdoc"
+  spec.add_dependency "erb"
+  spec.add_dependency "reverse_markdown"
+  spec.add_dependency "unindent"
+  spec.add_dependency "csv"
 
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "rake", "~> 13.0"

metadata

@@ -1,85 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-15 00:00:00.000000000 Z
+date: 2024-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: erb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: reverse_markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: extralite-bundle
+  name: unindent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: unindent
+  name: csv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -145,8 +144,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
-- ".standard.yml"
-- ".streerc"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -156,13 +153,8 @@ files:
 - 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/TestGenerator.md
 - example/Waterfowl.md
-- example/index.db
+- example/index.csv
 - lib/markdown.rb
 - lib/rdoc/discover.rb
 - lib/rdoc/generator/markdown.rb
@@ -177,7 +169,6 @@ metadata:
   homepage_uri: https://poshtui.com
   source_code_uri: https://github.com/skatkov/rdoc-markdown
   changelog_uri: https://github.com/skatkov/rdoc-markdown
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -192,8 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: RDoc plugin to generate markdown documentation
 test_files: []

data/.standard.yml

@@ -1,10 +0,0 @@
-# For available configuration options, see:
-#   https://github.com/testdouble/standard
-ruby_version: 2.7
-parallel: true
-format: progress
-
-ignore:
- - 'docs/example.rb'
- - '**/*':
-    - Style/GlobalVars

data/.streerc

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

data/example/RDoc/Generator/Markdown.md

@@ -1,30 +0,0 @@
-# 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

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

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)
- 

data/example/TestGenerator.md

@@ -1,10 +0,0 @@
-# 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)
-