rdoc-markdown 0.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 022adabd6f2ced45f3d5ff3216b48376914f7ba7b80cc1b87d83e8d7507824d7
-  data.tar.gz: 5d9a514dbbcf570811d0a3f230a2eff9434d61413cf994500bb6fd1f1f49a5d2
+  metadata.gz: 99635a266dfc1546b1a4a41750981273801ce18843b28ac988bc3f5c15574bb9
+  data.tar.gz: d57652a1afeeec572a6af5261d05a4873c2a2cf92ab2902a5da43674a62ad6ba
 SHA512:
-  metadata.gz: 41604d7644f1e4a437f79c3fcbc868c71189355e4b4ae79be430bd313e7729970d8029af95e2d649c71226079acef183329a1b63c1ce500a00815fa82ef587c1
-  data.tar.gz: f0a44ac4166d92a26b5166c8a290cbcfe16970b8d20c4f8c92ea4f0b5c3a1ae9a23ffe0348f79323c22caad9687eddb0d82346da3a31ba5b7594aeb39dd5e971
+  metadata.gz: 952daaa29c6f9cf001a3e355c311decc519eebe65197f38cdcf997990e6ca1cc6dacd21c999de6b48a7a14fd2d2d770c771f0030c1dacd70981dc9deab116d10
+  data.tar.gz: 18f3c998cb1a7a0ec875c30713fcc63fdbe4d61c762256e9175e96364c9eff4ca8f877a7db0c572e35c12eff4775ef33b097ee108fa78252491fa41db775c403

data/README.md

@@ -1,9 +1,12 @@
-# Rdoc::Markdown
-RDoc plugin to generate markdown documentation and search index as sqlite database for entire content.
+# 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

@@ -177,7 +177,7 @@ class RDoc::Generator::Markdown
     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]})"

data/lib/rdoc/markdown/version.rb

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

data/lib/templates/classfile.md.erb

@@ -13,7 +13,7 @@
   <% unless attributes&.empty? %>
 ## Attributes
     <% attributes.each do |attr| %>
-### <%= attr.rw %><%=h attr.name.strip %>[](#<%= attr.aref.strip %>)
+### <%= attr.name %>[<%= attr.rw %>] [](#<%= attr.aref.strip %>)
 <% if attr.comment %> <%= h attr.description %> <%else%> (Not documented) <% end %>
     <% end %>
   <% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: 0.3.1
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2022-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -158,7 +158,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
 - ".editorconfig"
 - ".standard.yml"
 - CODE_OF_CONDUCT.md
@@ -167,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