mdtoc 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b54718ab7b2f7bbc8e90ae473318895665986e0a7408674670db03294f12d6e
-  data.tar.gz: f1b251a78ba55942f8c85d82b99f614d3b9368541b7dcb1f144d1094e293d01f
+  metadata.gz: 67fab334c40c8a785d1ac0bcca6234a1fc048ad479ed7fb4df093f0eb14c2116
+  data.tar.gz: c80647e458fd2ceaa60189688d0c7a831ad023a20cb471fcc37d512e382db627
 SHA512:
-  metadata.gz: 247816469ed9798906c93e6ca0c58bd4b863d379795d9f776b71fc6c7d3835d7eb4ee890372a408ee04981658336a5f924156d85456e66d90793e0d58b7bd9e2
-  data.tar.gz: 2c10991bfa7f4b95896d468f803bae94b44899fc695c1113bd6fa6d7d90c784f4303939a7c2637ed70cd6335bf51f66688d6c932b03a6c0d284f5060cc009646
+  metadata.gz: 2e6e9abb89b30d7abed179b42b00a8d871ab7b5ea6b96a4607ea5284bed3a1e1b2bb3355e0258d84498b78c8dba1463ab170f46e9c4c7963f4931b2efa910483
+  data.tar.gz: a3c414d2472f1f2ad976bc02eca284c9b4f522ee21624ad30534d33563242cb2ac04457cf33a4bc1998f2af232f4aa803c2051ee066f910444d6f881c7b69396

data/bin/mdtoc

@@ -2,5 +2,5 @@
 # typed: true
 # frozen_string_literal: true
 
-require 'mdtoc'
+require "mdtoc"
 Mdtoc.main(ARGV)

data/lib/mdtoc/cli.rb

@@ -1,9 +1,9 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
-require 'optparse'
-require 'sorbet-runtime'
-require 'tempfile'
+require "optparse"
+require "sorbet-runtime"
+require "tempfile"
 
 module Mdtoc
   module CLI
@@ -14,19 +14,19 @@ module Mdtoc
       def parse(args)
         parser = OptionParser.new do |parser_|
           parser_.banner = "Usage: #{parser_.program_name} [options] files or directories..."
-          parser_.on('-h', '--help', 'Show this message') do
+          parser_.on("-h", "--help", "Show this message") do
             puts parser_
             exit
           end
-          parser_.on('-o', '--output PATH', 'Update a table of contents in the file at PATH')
-          parser_.on('-a', '--[no-]append', 'Append to the --output file if a <!-- mdtoc --> tag isn\'t found')
-          parser_.on('-c', '--[no-]create', 'Create the --output file if it does not exist')
+          parser_.on("-o", "--output PATH", "Update a table of contents in the file at PATH")
+          parser_.on("-a", "--[no-]append", "Append to the --output file if a <!-- mdtoc --> tag isn't found")
+          parser_.on("-c", "--[no-]create", "Create the --output file if it does not exist")
         end
 
         options = Options.new
         options.paths = parser.parse(args, into: options)
         if options.paths.empty?
-          warn('Specify at least one file or directory to read')
+          warn("Specify at least one file or directory to read")
           exit(1)
         end
         options

data/lib/mdtoc/markdown/header.rb

@@ -1,7 +1,7 @@
 # typed: true
 # frozen_string_literal: true
 
-require 'sorbet-runtime'
+require "sorbet-runtime"
 
 module Mdtoc
   module Markdown
@@ -13,14 +13,15 @@ module Mdtoc
         if depth < 0
           raise ArgumentError, "Header depth must be >= 0, but was #{depth}"
         end
+
         @depth = depth
-        @label = label.strip.gsub(/\s+/, ' ')
+        @label = normalize_label(label)
         @url = url
       end
 
       sig { returns(String) }
       def to_s
-        prefix = ' ' * 2 * @depth
+        prefix = " " * 2 * @depth
         "#{prefix}* [#{@label}](#{@url})"
       end
 
@@ -28,13 +29,20 @@ module Mdtoc
       def top_level?(relative_to_depth)
         @depth == relative_to_depth
       end
+
+      private
+
+      def normalize_label(label)
+        label = label.strip.tr("\t\n\r", "") # Remove whitespace characters other than spaces.
+        label.gsub(/\[(.*)\]\(.*\)/, '\1') # Remove links
+      end
     end
 
     class HeaderWithFragment < Header
       sig { params(depth: Integer, label: String, url: String).void }
       def initialize(depth, label, url)
-        url = "#{url}##{label.strip.downcase.tr(' ', '-').gsub(/[^\w\-]/, '')}"
         super
+        @url += "##{@label.downcase.tr(" ", "-").gsub(/[^\w\-]/, "")}"
       end
     end
   end

data/lib/mdtoc/markdown/parser.rb

@@ -1,8 +1,8 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
-require 'sorbet-runtime'
-require_relative 'header'
+require "sorbet-runtime"
+require_relative "header"
 
 module Mdtoc
   module Markdown
@@ -22,10 +22,10 @@ module Mdtoc
         skip = T.let(false, T::Boolean)
         lines.filter_map do |line|
           # Skip code blocks.
-          if line.start_with?('```') && !T.must(line[3..]).strip.end_with?('```')
+          if line.start_with?("```") && !T.must(line[3..]).strip.end_with?("```")
             skip = !skip
           end
-          next if skip || !line.start_with?('#')
+          next if skip || !line.start_with?("#")
 
           header(line)
         end
@@ -36,9 +36,9 @@ module Mdtoc
       sig { params(line: String).returns(HeaderWithFragment) }
       def header(line)
         m = T.must(line.strip.match(/^(#+)\s*(.*)$/))
-        num_hashes = m[1]&.count('#') || 1
+        num_hashes = m[1]&.count("#") || 1
         depth = @depth + num_hashes - 1
-        label = m[2] || ''
+        label = m[2] || ""
         HeaderWithFragment.new(depth, label, @url)
       end
     end

data/lib/mdtoc/node.rb

@@ -1,10 +1,10 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
-require 'pathname'
-require 'sorbet-runtime'
-require_relative 'markdown/header'
-require_relative 'markdown/parser'
+require "pathname"
+require "sorbet-runtime"
+require_relative "markdown/header"
+require_relative "markdown/parser"
 
 module Mdtoc
   class Node
@@ -43,35 +43,35 @@ module Mdtoc
 
     sig { returns(String) }
     def label
-      File.basename(@path, File.extname(@path)).gsub(/_+/, ' ').gsub(/\s+/, ' ').capitalize
+      File.basename(@path, File.extname(@path)).gsub(/_+/, " ").gsub(/\s+/, " ").capitalize
     end
-  end
 
-  class DirNode < Node
-    sig { override.returns(T::Array[Mdtoc::Markdown::Header]) }
-    def headers
-      readme_path = T.let(nil, T.nilable(String))
-      child_headers = Dir
-        .each_child(@path)
-        .reject { |path| readme_path = File.join(@path, path) if path.casecmp?('readme.md') }
-        .sort!
-        .flat_map { |path| Node.for_path(File.join(@path, path), @depth + 1).headers }
-      return child_headers unless readme_path
+    class DirNode < Node
+      sig { override.returns(T::Array[Mdtoc::Markdown::Header]) }
+      def headers
+        readme_path = T.let(nil, T.nilable(String))
+        child_headers = Dir
+          .each_child(@path)
+          .reject { |path| readme_path = File.join(@path, path) if path.casecmp?("readme.md") }
+          .sort!
+          .flat_map { |path| Node.for_path(File.join(@path, path), @depth + 1).headers }
+        return child_headers unless readme_path
 
-      # Include the headers from the README at the beginning.
-      readme_headers = FileNode.new(readme_path, @depth).headers
-      readme_headers.push(*child_headers)
+        # Include the headers from the README at the beginning.
+        readme_headers = FileNode.new(readme_path, @depth).headers
+        readme_headers + child_headers
+      end
     end
-  end
 
-  class FileNode < Node
-    sig { override.returns(T::Array[Mdtoc::Markdown::Header]) }
-    def headers
-      parser = Markdown::Parser.new(@depth, @path)
-      headers = parser.headers(File.foreach(@path))
-      return headers if headers[0]&.top_level?(@depth)
+    class FileNode < Node
+      sig { override.returns(T::Array[Mdtoc::Markdown::Header]) }
+      def headers
+        parser = Markdown::Parser.new(@depth, @path)
+        headers = parser.headers(File.foreach(@path))
+        return headers if headers[0]&.top_level?(@depth)
 
-      headers.unshift(Mdtoc::Markdown::Header.new(@depth, label, @path))
+        headers.unshift(Mdtoc::Markdown::Header.new(@depth, label, @path))
+      end
     end
   end
 end

data/lib/mdtoc/version.rb

@@ -1,6 +1,6 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module Mdtoc
-  VERSION = '0.1.4'
+  VERSION = "0.2.0"
 end

data/lib/mdtoc/writer.rb

@@ -1,10 +1,10 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module Mdtoc
   module Writer
-    COMMENT_BEGIN = '<!-- mdtoc -->'
-    COMMENT_END = '<!-- mdtoc-end -->'
+    COMMENT_BEGIN = "<!-- mdtoc -->"
+    COMMENT_END = "<!-- mdtoc-end -->"
 
     class << self
       extend T::Sig
@@ -13,7 +13,7 @@ module Mdtoc
       def write(toc, path, append, create)
         validate_path(path, create)
         new_content = content(toc, path, append)
-        File.open(path, 'w') do |f|
+        File.open(path, "w") do |f|
           f.write(new_content)
         end
       end

data/lib/mdtoc.rb

@@ -1,11 +1,11 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
-require 'optparse'
-require 'tempfile'
-require_relative 'mdtoc/cli'
-require_relative 'mdtoc/node'
-require_relative 'mdtoc/writer'
+require "optparse"
+require "tempfile"
+require_relative "mdtoc/cli"
+require_relative "mdtoc/node"
+require_relative "mdtoc/writer"
 
 module Mdtoc
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdtoc
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - andornaut
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2025-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.25'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,56 +58,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.86'
+        version: '1.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.86'
+        version: '1.50'
 - !ruby/object:Gem::Dependency
   name: rubocop-shopify
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop-sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: unparser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.9
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.9
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -133,13 +133,13 @@ description: |
 
   * [Ruby](https://www.ruby-lang.org/en/) (see [.ruby-version](./.ruby-version))
 
-  ```
-  $ gem install mdtoc
+  ```bash
+  gem install mdtoc
   ```
 
   ## Usage
 
-  ```
+  ```bash
   $ mdtoc --help
   Usage: mdtoc [options] files or directories...
       -h, --help                       Show this message
@@ -149,67 +149,82 @@ description: |
   ```
 
   1. Add a `<!-- mdtoc -->` tag to a Markdown file.
+
+    ```bash
+    echo '<!-- mdtoc -->' >> README.md
     ```
-    $ echo '<!-- mdtoc -->` >> README.md
-    ```
+
   2. Run `mdtoc` and specify input files or directories (eg. the "test/samples" directory) and an output file (eg. "README.md").
-    ```
-    $ mdtoc -aco README.md test/samples
+
+    ```bash
+    mdtoc -aco README.md test/samples
     ```
 
   ## Example Rakefile
 
-  Run the [rake](https://github.com/ruby/rake) "mdtoc" task to update a table of contents.
-  See [andornaut/til](https://github.com/andornaut/til) for an example.
+  Create a `Rakefile` with the contents below, then run
+  [`rake`](https://github.com/ruby/rake) to:
 
-  ```
+  * `git pull`
+  * `git add` any *.md files
+  * Run `mdtoc` to update the generated table of contents in the ./README.md file
+  * Git commit and push any changes
+
+  ```ruby
   task default: %w[mdtoc]
 
   desc 'Update Markdown table of contents and push changes to the git repository'
-  task :mdtoc do |t|
-    command = <<~END
+  task :mdtoc do
+    command = <<~CMD
       set -e
-      git pull
       if [ -n "$(git diff --name-only --diff-filter=U)" ]; then
         echo 'Error: conflicts exist' >&2
         exit 1
       fi
       mdtoc --append --create --output README.md docs/
       git add *.md **/*.md
-      git commit -m 'Update TOC'
+      git commit -qm 'Update TOC' || true
+      git pull
       git push
-    END
-    %x|#{command}|
+    CMD
+    sh command, verbose: false do |ok, status|
+      unless ok
+        fail "Failed with status: #{status.exitstatus}"
+      end
+    end
   end
   ```
 
+  See [andornaut/til](https://github.com/andornaut/til/blob/master/Rakefile) for an example.
+
   ## Development
 
-  ### Installation
+  ### Setup
 
   Requirements:
 
   * [Bundler](https://bundler.io/)
 
-  ```
+  ```bash
   # Install dependencies
-  $ bundle
+  bundle
   ```
 
-  ### Usage
+  ### Tasks
 
-  ```
+  ```bash
   # List rake tasks
   $ rake -T
-  rake build                 # Build mdtoc-0.0.2.gem into the pkg directory
-  rake default               # Run the build, rubocop:auto_correct, sorbet and test tasks
-  rake install               # Build and install mdtoc-0.0.2.gem into system gems
-  rake install:local         # Build and install mdtoc-0.0.2.gem into system gems without...
-  rake release[remote]       # Create tag v0.0.2 and build and push mdtoc-0.0.2.gem to ru...
-  rake rubocop               # Run RuboCop
-  rake rubocop:auto_correct  # Auto-correct RuboCop offenses
-  rake sorbet                # Run the Sorbet type checker
-  rake test                  # Run tests
+  rake build                    # Build mdtoc-0.1.5.gem into the pkg directory
+  rake default                  # Run the build, rubocop:autocorrect_all, sorbet and test tasks
+  rake install                  # Build and install mdtoc-0.1.5.gem into system gems
+  rake install:local            # Build and install mdtoc-0.1.5.gem into system gems without network access
+  rake release[remote]          # Create tag v0.1.5 and build and push mdtoc-0.1.5.gem to rubygems.org
+  rake rubocop                  # Run RuboCop
+  rake rubocop:autocorrect      # Autocorrect RuboCop offenses (only when it's safe)
+  rake rubocop:autocorrect_all  # Autocorrect RuboCop offenses (safe and unsafe)
+  rake sorbet                   # Run the Sorbet type checker
+  rake test                     # Run tests
 
   # Run mdtoc with test inputs
   $ ruby -Ilib bin/mdtoc test/samples
@@ -250,7 +265,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Read Markdown files and output a table of contents