rdoc-markdown 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df97c53443f43093bb4d4d603805cd2fdab86d4b8f22a56e5997657054f71401
-  data.tar.gz: 75da9383aafa24c2dca008f048d5a833072450e20449c5f239312dc72f9425fd
+  metadata.gz: 2bd22f1897418114a7136727481ee4b70001e5b9b6314748da8d09303229812a
+  data.tar.gz: 1c82d1b8d074c7d714eeef4dedcffdc2f4f5c007056b98740d2026be621ffa29
 SHA512:
-  metadata.gz: 8272fa3b07ada1879d930beb615cc173d4ae69446aa269a92560097f26b68c50449e3088f5933a83f2c8430eac97431bddfc501ebdac69c0ea7b415d501e9dcf
-  data.tar.gz: 04220f6918002d8026049cce123f80a10bd706e7e727c5d1365b3c9714dd905826b21d99679993345e7e6e9e0f42e8e4c75be3cf8b72863beff4b05bd127223c
+  metadata.gz: cb0ce1049d602b43f8fb45cfbe569fbff6ec7c2e14db0ef5cf92bebff696a1817f1f04d5b2648612f16086f830ce7c5b67075e6362a36da2b8e98bd942ab20a2
+  data.tar.gz: 4106314ed71d6d0b387c60d9c338e912e646941476c96cf5aee7badb16ab043475d85fdbe907c1df740dc851f2858256ed3edd6e4545e275bc3005d96500c312

data/.editorconfig

@@ -0,0 +1,13 @@
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+# Two spaces for indenting
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+max_line_length = 120

data/.standard.yml

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

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    rdoc-markdown (0.1.2)
+      erb
+      rdoc (~> 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    cgi (0.3.3)
+    erb (2.2.3)
+      cgi
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rdiscount (2.2.0.2)
+    rdoc (6.2.1.1)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (1.29.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.12.1)
+      rubocop (= 1.29.1)
+      rubocop-performance (= 1.13.3)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rdiscount
+  rdoc-markdown!
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.20

data/README.md

@@ -24,6 +24,10 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## Release
+```
+gem build rdoc-markdown.gemspec
+```
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rdoc-markdown. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rdoc-markdown/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "standard/rake"
+
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.warning = false
+  t.test_files = FileList["test/test*.rb"]
+end
+
+task default: [:test, "standard:fix"]

data/docs/example.rb

@@ -0,0 +1,142 @@
+##
+# === RDoc::Generator::SolarFish example.
+#
+# This example employs variois RDoc features to demonstrate
+# generator output.
+#
+# ---
+#
+# Links:
+#
+#  1. {Project Home Page}[https://github.com/rbdoc/rdoc-generator-solarfish)
+#  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/lib/markdown.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-require "rdoc/rdoc"
 require "rdoc/generator/markdown"
-require_relative "rdoc/markdown/version"
-
-module Markdown
 
+class RDoc::Markdown
 end

data/lib/rdoc/discover.rb

@@ -1,4 +1 @@
-$stderr.puts "Discovered RDoc-Markdown!"
-
-# RDoc plugin hook
-require 'markdown'
+require "markdown"

data/lib/rdoc/generator/markdown.rb

@@ -1,20 +1,140 @@
-gem 'rdoc'
+# frozen_string_literal: true
 
-require 'rdoc/rdoc'
-require 'rdoc/generator/json_index'
+gem "rdoc"
 
+require "pathname"
+require "erb"
+
+# Markdown generator.
+# Registers command line options and generates markdown files
+# RDoc documentation and options.
 class RDoc::Generator::Markdown
-    RDoc::RDoc.add_generator self
+  RDoc::RDoc.add_generator self
+
+  TEMPLATE_DIR = File.expand_path(
+    File.join(File.dirname(__FILE__), '..', '..', 'templates'))
+
+  ##
+  # The RDoc::Store that is the source of the generated content
+
+  attr_reader :store
+
+  ##
+  # The path to generate files into, combined with <tt>--op</tt> from the
+  # options for a full path.
+
+  attr_reader :base_dir
+
+  ##
+  # Classes and modules to be used by this generator, not necessarily
+  # displayed.  See also #modsort
+
+  attr_reader :classes
+
+  ##
+  # Files to be displayed by this generator
+
+  attr_reader :files
+
+  ##
+  # Methods to be displayed by this generator
+
+  attr_reader :methods
+
+  ##
+  # Sorted list of classes and modules to be displayed by this generator
+
+  attr_reader :modsort
+
+  ##
+  # Directory where generated class HTML files live relative to the output
+  # dir.
+
+  def class_dir
+    nil
+  end
+
+  def initialize(store, options)
+    @store = store
+    @options = options
+
+    @base_dir = Pathname.pwd.expand_path
 
-    def initialize(store, options)
-        @store = store
-        @options = options
+    @classes = nil
+    @files = nil
+    @methods = nil
+    @modsort = nil
+  end
 
-        $stderr.puts("rdoc-markdown initialized")
+  def generate
+    setup
+
+    debug("Create directory #{@output_dir}")
+
+    output_dir.mkpath
+
+    debug("Generate documentation in #{@output_dir}")
+
+    emit_classfiles
+  end
+
+  private
+
+  attr_reader :options
+  attr_reader :output_dir
+
+  def debug(str = nil)
+    if $DEBUG_RDOC
+      puts "[rdoc-markdown] #{str}" if str
+      yield if block_given?
     end
+  end
+
+  def emit_classfiles
+    @classes.each do |klass|
+      klass_methods    = []
+      instance_methods = []
+
+      klass.method_list.each do |method|
+        next if 'private' == method.visibility.to_s
+        if method.type == 'class'
+          klass_methods << method
+        else
+          instance_methods << method
+        end
+      end
 
-    def generate
-        $stderr.puts("rdoc-markdown #generate called")
-        binding.irb
+      template = ERB.new File.read(File.join(TEMPLATE_DIR, 'classfile.md.erb'))
+
+      out_file = Pathname.new("#{output_dir}/#{klass.full_name}.md")
+      out_file.dirname.mkpath
+
+      File.open(out_file, 'wb') do |f|
+        f.write template.result binding
+      end
     end
-end
+  end
+
+  def setup
+    return if instance_variable_defined?(:@output_dir)
+
+    @output_dir = Pathname.new(@options.op_dir).expand_path(@base_dir)
+
+    return unless @store
+
+    @classes = @store.all_classes_and_modules.sort
+    @files = @store.all_files.sort
+    @methods = @classes.map(&:method_list).flatten.sort
+    @modsort = get_sorted_module_list @classes
+  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.1.1"
+    VERSION = "0.1.2"
   end
 end

data/lib/templates/classfile.md.erb

@@ -0,0 +1,26 @@
+# <%= klass.name %>
+## <% if klass.type == 'class' %><%= klass.type.capitalize %>[<%= klass.full_name %>](<%= klass.path %>)<% if klass.superclass %> inherits from <% end %><% unless String === klass.superclass %> [<%= klass.superclass.name %>](<%= klass.superclass.path %>) <% else %> <%= klass.superclass %> <% end %> <% else %> <%= klass.type.capitalize %> [<%= klass.name %>](<%= klass.path %>) <% end %>
+<% if klass.description && !klass.description.empty? %><%= klass.description %><% end %>
+<% unless klass.constants.empty? %><!-- Constants -->
+### Constants
+<% klass.constants.sort_by { |x| x.name }.each do |const| %> <%= const.name %> <% end %>
+
+<% end %>
+<% unless klass.attributes.empty? %><!-- Attributes -->
+### Attributes
+<% klass.attributes.sort_by { |x| x.name }.each do |attr| %><%= attr.name %>
+<%= attr.rw %>
+<%= attr.description %>
+
+<% end %><% end %>
+<% unless klass_methods.empty? %>
+<!-- Class Methods -->
+### Public Class Methods
+<% klass_methods.each do |method| %>[<%= method.name %><%= method.params %>](<%= method.aref %>)
+<%= method.description %><% end %>
+
+<% end %>
+<% unless instance_methods.empty? %><!-- Instance Methods -->
+### Public Instance Methods
+<% instance_methods.each do |method| %>[<%= method.name %><%= method.params %>](<%= method.aref %>)
+<%= method.description %><% end %><% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-01 00:00:00.000000000 Z
+date: 2022-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -24,6 +24,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: erb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: rdoc generator that produces markdown files
 email:
 - github@skatkov.com
@@ -32,21 +116,26 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".DS_Store"
+- ".editorconfig"
 - ".standard.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - 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
 - sig/rdoc/markdown.rbs
-homepage: https://github.com/skatkov/rdoc-markdown
+homepage: https://poshtui.com
 licenses: []
 metadata:
-  homepage_uri: https://github.com/skatkov/rdoc-markdown
+  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: