rdoc-markdown 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16494339df3b522fae317e9010c0a9ee8cae1a7f4452595c8fde01e238421c64
-  data.tar.gz: 1dec9b05ccdea281811213800b2301a4f89097dcaacbf72ac59fa7c85aeff676
+  metadata.gz: 99635a266dfc1546b1a4a41750981273801ce18843b28ac988bc3f5c15574bb9
+  data.tar.gz: d57652a1afeeec572a6af5261d05a4873c2a2cf92ab2902a5da43674a62ad6ba
 SHA512:
-  metadata.gz: 30b4a879efd549f01f627558c390b34b05aece87ce14fe46293770e342c90fdaf176457b50fad52f215de6aa91b7477607601530d8874f60869570e9990b043d
-  data.tar.gz: 76947d62302a58b3ceeb41d78be86dcbe7d6032fa41579e9287567aecda5bf23c7271bfb453c8125d9dd6d6b934bd5de996637145a2ba377f068f8198909c82a
+  metadata.gz: 952daaa29c6f9cf001a3e355c311decc519eebe65197f38cdcf997990e6ca1cc6dacd21c999de6b48a7a14fd2d2d770c771f0030c1dacd70981dc9deab116d10
+  data.tar.gz: 18f3c998cb1a7a0ec875c30713fcc63fdbe4d61c762256e9175e96364c9eff4ca8f877a7db0c572e35c12eff4775ef33b097ee108fa78252491fa41db775c403

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    rdoc-markdown (0.2.1)
-      activesupport (~> 7.0)
+    rdoc-markdown (0.3)
       erb (~> 2.0)
       extralite-bundle (~> 1.0)
       rdoc (~> 6.0)
@@ -12,19 +11,11 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
     ast (2.4.2)
     cgi (0.3.3)
-    concurrent-ruby (1.1.10)
     erb (2.2.3)
       cgi
     extralite-bundle (1.16)
-    i18n (1.12.0)
-      concurrent-ruby (~> 1.0)
     json (2.6.2)
     minitest (5.16.3)
     nokogiri (1.13.9-arm64-darwin)
@@ -66,8 +57,6 @@ GEM
       rubocop (= 1.35.1)
       rubocop-performance (= 1.14.3)
     stringio (3.0.2)
-    tzinfo (2.0.5)
-      concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
     unindent (1.0)
 

data/README.md

@@ -1,9 +1,12 @@
-# Rdoc::Markdown
-Rdoc Generator plugin to generate markdown documentation and search index as sqlite database that goes along with it.
+# 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 the gem and add to the application's Gemfile by executing:
+Install gem and add to application's Gemfile by executing:
 
     $ bundle add rdoc-markdown
 
@@ -12,10 +15,13 @@ If bundler is not being used to manage dependencies, install the gem by executin
     $ gem install rdoc-markdown
 
 ## 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.
+
+Run following command in directory with ruby source code:
 
 `rdoc --format=markdown`
 
-No additional parameters are currently available, but that may change.
+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.
 
 ## Development
 Biggest issue is testing this locally, but that's not as hard to do these days.
@@ -34,22 +40,19 @@ or you can do the same, but through gemfile:
 gem 'rdoc-markdown`, path: "../rdoc-markdown/`
 ```
 
-I have scripted entire process in [rm-reload.sh script](https://github.com/skatkov/gum/blob/master/rm-reload.sh). But it assumes, that you have [gum library](https://github.com/charmbracelet/gum) installed.
-
 ## Testing
-Testing is not excessive, just verifies that basic functionality is operational. Following command should run entire testsuit:
-
+Following command should run entire testsuit:
 ```
 rake test
 ```
-
+Testing is not excessive, just verifies that basic functionality is operational.
 ## Release
 ```
 gem build rdoc-markdown.gemspec
 gem push rdoc-markdown-0.1.2.gem
 ```
 
-There is `./publish.sh` script that does that. But it assumes, that you have [gum library](https://github.com/charmbracelet/gum) installed.
+There is `./bin/publish.sh` script that does that. But it assumes, that you have [gum library](https://github.com/charmbracelet/gum) installed.
 
 ## Contributing
 

data/lib/rdoc/generator/markdown.rb

@@ -5,9 +5,8 @@ gem "rdoc"
 require "pathname"
 require "erb"
 require "reverse_markdown"
-require 'extralite'
-require 'active_support/core_ext/string/inflections'
-require 'unindent'
+require "extralite"
+require "unindent"
 
 class RDoc::Generator::Markdown
   RDoc::RDoc.add_generator self
@@ -95,7 +94,7 @@ class RDoc::Generator::Markdown
   # This class emits a search index for generated documentation as sqlite database
   #
 
-  def emit_sqlite(name="index.db")
+  def emit_sqlite(name = "index.db")
     db = Extralite::Database.new("#{output_dir}/#{name}")
 
     db.execute <<-SQL
@@ -130,7 +129,7 @@ class RDoc::Generator::Markdown
         result << {
           name: "#{klass.full_name}.#{const.name}",
           type: "Constant",
-          path: "#{turn_to_path(klass.full_name)}##{ActiveSupport::Inflector.parameterize const.name}"
+          path: "#{turn_to_path(klass.full_name)}##{const.name}"
         }
       end
 
@@ -150,19 +149,6 @@ class RDoc::Generator::Markdown
 
   def emit_classfiles
     @classes.each do |klass|
-      klass_methods = []
-      instance_methods = []
-
-      klass.method_list.each do |method|
-        next if method.visibility.to_s.eql?("private")
-
-        if method.type == "class"
-          klass_methods << method
-        else
-          instance_methods << method
-        end
-      end
-
       template = ERB.new File.read(File.join(TEMPLATE_DIR, "classfile.md.erb"))
 
       out_file = Pathname.new("#{output_dir}/#{turn_to_path klass.full_name}")
@@ -185,25 +171,21 @@ class RDoc::Generator::Markdown
   # Converts HTML string into a Markdown string with some cleaning and improvements.
 
   def markdownify(input)
-    md= ReverseMarkdown.convert input, github_flavored: true
+    md = ReverseMarkdown.convert input
 
     # unintent multiline strings
     md.unindent!
 
     # Replace .html to .md extension in all markdown links
-    md = md.gsub(/\[(.+)\]\((.+).html(.*)\)/) do |_|
+    md.gsub(/\[(.+)\]\((.+).html(.*)\)/) do |_|
       match = Regexp.last_match
 
       "[#{match[1]}](#{match[2]}.md#{match[3]})"
     end
-
-    # clean up things, to make it look neat.
-
-    md.gsub("[↑](#top)", "").lstrip
   end
 
   # Aliasing a shorter method name for use in templates
-  alias_method  :h, :markdownify
+  alias_method :h, :markdownify
 
   ##
   # Prepares for document generation, by creating required folders and initializing variables.
@@ -219,14 +201,4 @@ class RDoc::Generator::Markdown
 
     @classes = @store.all_classes_and_modules.sort
   end
-
-  ##
-  # Return a list of the documented modules sorted by salience first, then
-  # by name.
-
-  def get_sorted_module_list classes
-    classes.select do |klass|
-      klass.display?
-    end.sort
-  end
 end

data/lib/rdoc/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module Rdoc
   module Markdown
-    VERSION = "0.2.1"
+    VERSION = "0.3.1"
   end
 end

data/lib/templates/classfile.md.erb

@@ -1,23 +1,31 @@
-# <% 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 %>
+# <%= klass.type %> <%= klass.full_name.strip %> [](#<%= klass.aref.strip %>) [](#top)
 <%= h klass.description %>
-<% unless klass.constants.empty? %>
-| Constants | Description |
-| ------------- | ------------- |
-<% klass.constants.sort_by { |x| x.name }.each do |const| %> |**[<%= const.name %>](#<%= ActiveSupport::Inflector.parameterize const.name%>)** | <%= h const.description %> |
-<% end %><% end %>
-<% unless klass.attributes.empty? %>
+<% 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
+    <% klass.constants.each do |const| %>
+### <%= const.name.strip %>[](#<%= const.name.strip %>)
+<% if const.comment %> <%= h const.description %> <%else%> (Not documented) <% end %>
+    <% end %>
+  <% end %>
+  <% unless attributes&.empty? %>
 ## Attributes
-<% klass.attributes.sort_by { |x| x.name }.each do |attr| %>
-  [[**<%= attr.rw %>**] <%= attr.name %>](#<%= attr.aref %>)
-<% end %><% end %>
-<% unless klass_methods.empty? %>
-## Public Class Methods
-***
-<% klass_methods.each do |method| %>### [<%= method.name %><%= method.params %>](#<%= method.aref %>)
-
-<%= h method.description %><% end %><% end %>
-<% unless instance_methods.empty? %>
-## Public Instance Methods
-<% instance_methods.each do |method| %>### [<%= method.name %><%= method.params %>](#<%= method.aref %>)
-
-<%= h method.description %><% end %><% end %>
+    <% 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.strip %><%= method.param_seq.strip %> [](#<%= method.aref.strip %>)
+<% if method.comment %> <%= h method.description %>  <% else %> (Not documented) <%end%>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-23 00:00:00.000000000 Z
+date: 2022-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: unindent
   requirement: !ruby/object:Gem::Requirement
@@ -172,7 +158,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
 - ".editorconfig"
 - ".standard.yml"
 - CODE_OF_CONDUCT.md
@@ -181,15 +166,11 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- docs/example.rb
-- lib/.DS_Store
 - lib/markdown.rb
-- lib/rdoc/.DS_Store
 - lib/rdoc/discover.rb
 - lib/rdoc/generator/markdown.rb
 - lib/rdoc/markdown/version.rb
 - lib/templates/classfile.md.erb
-- publish.sh
 - sig/rdoc/markdown.rbs
 homepage: https://poshtui.com
 licenses:

data/docs/example.rb

@@ -1,142 +0,0 @@
-##
-# === RDoc::Generator::Markdown example.
-#
-# This example employs various RDoc features to demonstrate
-# generator output.
-#
-# ---
-#
-# Links:
-#
-#  1. {Project Home Page}[https://github.com/skatkov/rdoc-markdown)
-#  2. {RDoc Documentation}[http://ruby-doc.org/stdlib-2.0.0/libdoc/rdoc/rdoc/RDoc/Markup.html]
-#
-
-##
-# A mixin for waterfowl creatures.
-module Waterfowl
-    # Swimming helper.
-    def swim
-      puts 'swimming around'
-    end
-  end
-
-  ##
-  # The base class for all birds.
-  class Bird
-    ##
-    # Produce some noise.
-    #--
-    # FIXME: maybe extract this to a base class +Animal+?
-    #++
-    def speak # :yields: text
-      puts 'generic tweeting'
-      yield 'tweet'
-      yield 'tweet'
-    end
-
-    # Fly somewhere.
-    #
-    # Flying is the most critical feature of birds.
-    #
-    # :args: direction, velocity
-    #
-    # :call-seq:
-    #   Bird.fly(symbol, number) -> bool
-    #   Bird.fly(string, number) -> bool
-    #
-    # = Example
-    #
-    #   fly(:south, 70)
-    def fly(direction, velocity)
-      _fly_impl(direction, velocity)
-    end
-
-    def _fly_impl(_direction, _velocity) # :nodoc:
-      puts "flying away: direction=#{direction}, velocity=#{velocity}"
-    end
-  end
-
-  ##
-  # A duck is a Waterfowl Bird.
-  #
-  # Features:
-  #
-  #  bird::
-  #
-  #    * speak
-  #    * fly
-  #
-  #  waterfowl::
-  #
-  #    * swim
-  class Duck
-    extend Animal
-    include Waterfowl
-
-    # :section: Bird overrides
-
-    # Duck overrides generic implementation.
-    def speak
-      speech = quack
-      yield speech
-    end
-
-    # Implements quacking
-    def quack
-      'quack'
-    end
-
-    private :quack
-
-    # :section: Duck extensions
-
-    # True for domestic ducks.
-    attr_accessor :domestic
-
-    # True for rubber ducks.
-    attr_reader :rubber
-
-    MAX_VELOCITY = 130 # Maximum velocity for a flying duck.
-
-    ##
-    # Global list of all rubber ducks.
-    #
-    # Use when in trouble.
-    @@rubber_ducks = []
-
-    # Returns list of all rubber ducks.
-    def self.rubber_ducks
-      @@rubber_ducks
-    end
-
-    # Creates a new duck.
-    def initialize(domestic, rubber)
-      @domestic = domestic
-      @rubber = rubber
-      @@rubber_ducks << self if rubber
-    end
-
-    # Checks if this duck is a useful one.
-    #
-    # :call-seq:
-    #   Bird.useful? -> bool
-    def useful?
-      @domestic || @rubber
-    end
-  end
-
-  # Default velocity for a flying duck.
-  DEFAULT_DUCK_VELOCITY = 70
-
-  # Default rubber duck.
-  #
-  # *Note:*
-  #  Global variables are evil, but rubber ducks are worth it.
-  $default_rubber_duck = Duck.new(false, true)
-
-  # Domestic rubber duck.
-  #
-  # *Note:*
-  #  This is weird... Thus not making it global.
-  domestic_rubber_duck = Duck.new(true, true)

data/publish.sh

@@ -1,6 +0,0 @@
-#!/bin/sh
-
-gem build rdoc-markdown.gemspec
-GEM=$(gum choose $(ls *.gem))
-
-gum confirm "Publish $GEM?" && gem push $GEM