kramdown-man 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 164ce0fc23aa69a61fb65b7c99d26e76a9ab76fc798962f06940412bb1dcbcfd
-  data.tar.gz: 2161ba26365fe958c5a0b5f063706dfe7566d9c1213cb6f84bc63b50dfae4030
+  metadata.gz: dda435844039b4d61396829d332060c2db27506a3a7eee5d9859e09d9bd49e42
+  data.tar.gz: 46fcc59f2081b7aef517ab9e0e280c4961d370aecca163d78f69a8b3f26298dc
 SHA512:
-  metadata.gz: 54bd2ea4c4b967a5af505900f6ea8f02edb00900f6e5e6d67d1c015e776e602fe81d1dc641c62f2d7b614fecb224b3cc6003330b38eaa322f80b7296ee96850c
-  data.tar.gz: 28a7d09d3e41e9f108c2a73e966d9ecf31a4343b98b4452c23eab9978b7af77f8ec63a2b870726bb2c39cd0ecd0490fd922ea4e389716c4863fb68fe02dafa3e
+  metadata.gz: d81ca83bdb40321fd8ab52f2c15dc7e94d585641bac442e214a5acb4e9840f2ac38c4e4cb180d6ac03fac6852c3aeacd723988ca93bf837a226912f30cbc2f9e
+  data.tar.gz: 218ca5e6ee857373114abe7d50747cfa89337c0f7a172ee599fbc4e82e60cfb66f12e6ed291dc7d37d904713c0692bde5d8b1fa191d132c1578aa528832de7a8

data/.github/workflows/ruby.yml

@@ -1,10 +1,6 @@
 name: CI
 
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: ['**']
+on: [ push, pull_request ]
 
 jobs:
   tests:
@@ -13,12 +9,11 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - 2.4
-          - 2.5
-          - 2.6
-          - 2.7
           - 3.0
+          - 3.1
+          - 3.2
           - jruby
+          - truffleruby
     name: Ruby ${{ matrix.ruby }}
     steps:
       - uses: actions/checkout@v2

data/ChangeLog.md

@@ -1,3 +1,9 @@
+### 0.1.9 / 2023-12-01
+
+* Allow markdown `man:file.ext` style links, since man pages can be named after
+  file names (ex: `shard.yml`).
+* Use the `.PP` roff macro instead of the deprecated `.HP` macro.
+
 ### 0.1.8 / 2020-12-26
 
 * Upgrade to kramdown 2.x.

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2020 Hal Brodigan
+Copyright (c) 2013-2023 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -3,7 +3,6 @@
 * [Homepage](https://github.com/postmodern/kramdown-man#readme)
 * [Issues](https://github.com/postmodern/kramdown-man/issues)
 * [Documentation](http://rubydoc.info/gems/kramdown-man/frames)
-* [Email](mailto:postmodern.mod3 at gmail.com)
 
 ## Description
 
@@ -17,10 +16,11 @@ A [Kramdown][kramdown] convert for converting Markdown files into man pages.
   * Supports bullet lists.
   * Supports multi-paragraph list items and blockquotes.
   * Supports horizontal rules.
-  * Supports converting `[bash](man:bash(1))` links into man page references.
+  * Supports converting `[bash](man:bash(1))` and `[bash](man:bash.1)` links
+    into man page references.
 * Provides Rake task for converting `man/*.md` into man pages.
 * Uses the pure-Ruby [Kramdown][kramdown] markdown parser.
-* Supports [Ruby] 2.0 and [JRuby].
+* Supports [Ruby] 3.x, [JRuby], and [TruffleRuby].
 
 ## Synopsis
 
@@ -67,9 +67,9 @@ Define a `man` and file tasks which render all `*.md` files within the
 
 Normal paragraph.
 
-    `command` [`--foo`] *FILE*
+    `command` [`--foo`] **FILE**
 
-`command` [`--foo`] *FILE*
+`command` [`--foo`] **FILE**
 
     `--tagged`
       Text here.
@@ -168,7 +168,7 @@ Email <bob@example.com>
 
 ## Copyright
 
-Copyright (c) 2013-2020 Hal Brodigan
+Copyright (c) 2013-2023 Hal Brodigan
 
 See {file:LICENSE.txt} for details.
 
@@ -177,3 +177,4 @@ See {file:LICENSE.txt} for details.
 
 [Ruby]: http://www.ruby-lang.org/
 [JRuby]: http://jruby.org/
+[TruffleRuby]: https://github.com/oracle/truffleruby#readme

data/Rakefile

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 begin
   require 'bundler/setup'

data/gemspec.yml

@@ -6,6 +6,13 @@ authors: Postmodern
 email: postmodern.mod3@gmail.com
 homepage: https://github.com/postmodern/kramdown-man#readme
 
+metadata:
+  documentation_uri: https://rubydoc.info/gems/kramdown-man
+  source_code_uri:   https://github.com/postmodern/kramdown-man
+  bug_tracker_uri:   https://github.com/postmodern/kramdown-man/issues
+  changelog_uri:     https://github.com/postmodern/kramdown-man/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
+
 dependencies:
   kramdown: ~> 2.0
 

data/kramdown-man.gemspec

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'yaml'
 
@@ -20,6 +20,7 @@ Gem::Specification.new do |gem|
   gem.authors     = Array(gemspec['authors'])
   gem.email       = gemspec['email']
   gem.homepage    = gemspec['homepage']
+  gem.metadata    = gemspec['metadata'] if gemspec['metadata']
 
   glob = lambda { |patterns| gem.files & Dir[*patterns] }
 

data/lib/kramdown/converter/man.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require_relative '../man/version'
 
 require 'kramdown/converter/base'
@@ -703,7 +704,7 @@ module Kramdown
 
             ".TP\n#{first_line}\n#{rest}"
           else
-            ".HP\n#{convert_children(children)}"
+            ".PP\n#{convert_children(children)}"
           end
         else
           ".PP\n#{convert_children(children)}"
@@ -760,20 +761,27 @@ module Kramdown
       #
       def convert_a(a)
         href = escape(a.attr['href'])
+        scheme, path = href.split(':',2)
+
         text = convert_children(a.children)
 
-        case href
-        when /^mailto:/
-          email = href[7..-1]
+        case scheme
+        when 'mailto'
+          email = path
 
-          unless text == email then "#{text}\n.MT #{email}\n.ME"
-          else                      "\n.MT #{email}\n.ME"
+          unless text == email
+            "#{text}\n.MT #{email}\n.ME"
+          else
+            "\n.MT #{email}\n.ME"
           end
-        when /^man:/
-          match = href.match(/man:([A-Za-z0-9_-]+)(?:\((\d[a-z]?)\))?/)
+        when 'man'
+          if (match = path.match(/\A(?<page>[A-Za-z0-9_-]+)(?:\((?<section>\d[a-z]?)\)|\\\.(?<section>\d[a-z]?))\z/))
+            page    = match[:page]
+            section = match[:section]
 
-          if match[2] then "\n.BR #{match[1]} (#{match[2]})"
-          else             "\n.BR #{match[1]}"
+            "\n.BR #{page} (#{section})"
+          else
+            "\n.BR #{path}"
           end
         else
           "#{text}\n.UR #{href}\n.UE"

data/lib/kramdown/man/task.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'kramdown'
 require_relative '../converter/man'
 

data/lib/kramdown/man/version.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Kramdown
   module Man
     # kramdown-man version
-    VERSION = "0.1.8"
+    VERSION = "0.1.9"
   end
 end

data/lib/kramdown/man.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'kramdown'
 
 # HACK: load our version of kramdown/converter/man.rb and not kramdown's

data/man/kramdown-man.1

@@ -1,7 +1,12 @@
-.\" Generated by kramdown-man 0.1.7
+.\" Generated by kramdown-man 0.1.9
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH kramdown-man.1 "April 2013" kramdown-man "User Manuals"
 .LP
+.SH SYNOPSIS
+.LP
+.PP
+\fBkramdown-man\fR \[lB]\fIoptions\fP\[rB] <\fIINPUT\fP >\fIOUTPUT\fP
+.LP
 .SH DESCRIPTION
 .LP
 .PP
@@ -9,6 +14,22 @@ A Kramdown
 .UR http:\[sl]\[sl]kramdown\.gettalong\.org\[sl]
 .UE plugin for converting Markdown files into man pages\.
 .LP
+.SH ARGUMENTS
+.LP
+.TP
+\fIINPUT\fP
+The input markdown file to convert\.
+.LP
+.TP
+\fIOUTPUT\fP
+The output file for the man page\.
+.LP
+.SH OPTIONS
+.LP
+.TP
+\fB-h\fR, \fB--help\fR
+Prints the usage for \fBkramdown-man\fR\.
+.LP
 .SH EXAMPLE
 .LP
 .nf
@@ -55,11 +76,11 @@ Normal paragraph\.
 Normal paragraph\.
 .LP
 .nf
-\`command\` \[lB]\`\-\-foo\`\[rB] *FILE*
+\`command\` \[lB]\`\-\-foo\`\[rB] **FILE**
 .fi
 .LP
-.HP
-\fBcommand\fR \[lB]\fB--foo\fR\[rB] \fIFILE\fP
+.PP
+\fBcommand\fR \[lB]\fB--foo\fR\[rB] \fBFILE\fP
 .LP
 .nf
 \`\-\-tagged\`
@@ -180,4 +201,4 @@ int main()
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
+.LP

data/man/kramdown-man.1.md

@@ -1,9 +1,26 @@
 # kramdown-man.1 "April 2013" kramdown-man "User Manuals"
 
+## SYNOPSIS
+
+`kramdown-man` [*options*] \<*INPUT* \>*OUTPUT*
+
 ## DESCRIPTION
 
 A [Kramdown][kramdown] plugin for converting Markdown files into man pages.
 
+## ARGUMENTS
+
+*INPUT*
+    The input markdown file to convert.
+
+*OUTPUT*
+    The output file for the man page.
+
+## OPTIONS
+
+`-h`, `--help`
+    Prints the usage for `kramdown-man`.
+
 ## EXAMPLE
 
     require 'kramdown'
@@ -35,9 +52,9 @@ A [Kramdown][kramdown] plugin for converting Markdown files into man pages.
 
 Normal paragraph.
 
-    `command` [`--foo`] *FILE*
+    `command` [`--foo`] **FILE**
 
-`command` [`--foo`] *FILE*
+`command` [`--foo`] **FILE**
 
     `--tagged`
       Text here.

data/spec/{kramdown/converter → converter}/man_spec.rb

@@ -1,8 +1,7 @@
-# encoding: utf-8
-require_relative '../../spec_helper'
+require 'spec_helper'
 
 # HACK: load our version of kramdown/converter/man.rb and not kramdown's
-require_relative '../../../lib/kramdown/converter/man'
+require_relative '../../lib/kramdown/converter/man'
 
 describe Kramdown::Converter::Man do
   let(:markdown) { File.read('man/kramdown-man.1.md') }
@@ -418,8 +417,8 @@ Hello world.
         context "when there is no newline" do
           let(:doc) { Kramdown::Document.new("`#{flag}` `#{option}`") }
 
-          it "should convert the p element into a '.HP\\n...'" do
-            expect(subject.convert_p(p)).to eq(".HP\n\\fB#{flag}\\fR \\fB#{option}\\fR")
+          it "should convert the p element into a '.PP\\n...'" do
+            expect(subject.convert_p(p)).to eq(".PP\n\\fB#{flag}\\fR \\fB#{option}\\fR")
           end
         end
       end
@@ -463,8 +462,8 @@ Hello world.
         context "when there is no newline" do
           let(:doc) { Kramdown::Document.new("*#{flag}* *#{option}*") }
 
-          it "should convert the p element into a '.HP\\n...'" do
-            expect(subject.convert_p(p)).to eq(".HP\n\\fI#{escaped_flag}\\fP \\fI#{escaped_option}\\fP")
+          it "should convert the p element into a '.PP\\n...'" do
+            expect(subject.convert_p(p)).to eq(".PP\n\\fI#{escaped_flag}\\fP \\fI#{escaped_option}\\fP")
           end
         end
       end
@@ -539,14 +538,32 @@ Hello world.
         expect(subject.convert_a(link)).to eq("\n.BR #{man}")
       end
 
-      context "when a section number is specified" do
+      context "and when the path is of the form 'page(section)'" do
         let(:section) { '1' }
         let(:doc)     { Kramdown::Document.new("[#{man}](man:#{man}(#{section}))") }
 
-        it "should convert the link elements into '.BR man (section)'" do
+        it "should convert the link elements into '.BR page (section)'" do
           expect(subject.convert_a(link)).to eq("\n.BR #{man} (#{section})")
         end
       end
+
+      context "and when the path is of the form 'page.section'" do
+        let(:section) { '1' }
+        let(:doc)     { Kramdown::Document.new("[#{man}](man:#{man}.#{section})") }
+
+        it "should convert the link elements into '.BR page (section)'" do
+          expect(subject.convert_a(link)).to eq("\n.BR #{man} (#{section})")
+        end
+      end
+
+      context "when the path ends with a file extension" do
+        let(:file) { 'shard.yml' }
+        let(:doc)  { Kramdown::Document.new("[#{man}](man:#{file})") }
+
+        it "should convert the link elements into '.BR file'" do
+          expect(subject.convert_a(link)).to eq("\n.BR #{file.gsub('.','\\.')}")
+        end
+      end
     end
   end
 

data/spec/{kramdown/document_spec.rb → document_spec.rb}

@@ -1,9 +1,9 @@
-require_relative '../spec_helper'
+require 'spec_helper'
 
 require 'kramdown/man'
 
 describe Kramdown::Document, :integration do
-  let(:man_dir)       { File.expand_path('../../../man',__FILE__) }
+  let(:man_dir)       { File.expand_path('../man',__dir__) }
   let(:markdown_path) { File.join(man_dir,'kramdown-man.1.md')    }
   let(:markdown)      { File.read(markdown_path)                  }
 

data/spec/{kramdown/man_spec.rb → man_spec.rb}

@@ -1,4 +1,4 @@
-require_relative '../spec_helper'
+require 'spec_helper'
 require 'kramdown/man'
 
 describe Kramdown::Man do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-man
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Postmodern
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-27 00:00:00.000000000 Z
+date: 2023-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -67,15 +67,20 @@ files:
 - lib/kramdown/man/version.rb
 - man/kramdown-man.1
 - man/kramdown-man.1.md
-- spec/kramdown/converter/man_spec.rb
-- spec/kramdown/document_spec.rb
-- spec/kramdown/man_spec.rb
+- spec/converter/man_spec.rb
+- spec/document_spec.rb
+- spec/man_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/postmodern/kramdown-man#readme
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  documentation_uri: https://rubydoc.info/gems/kramdown-man
+  source_code_uri: https://github.com/postmodern/kramdown-man
+  bug_tracker_uri: https://github.com/postmodern/kramdown-man/issues
+  changelog_uri: https://github.com/postmodern/kramdown-man/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -90,8 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Converts markdown to man pages
 test_files: []