mdtoc 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b54718ab7b2f7bbc8e90ae473318895665986e0a7408674670db03294f12d6e
-  data.tar.gz: f1b251a78ba55942f8c85d82b99f614d3b9368541b7dcb1f144d1094e293d01f
+  metadata.gz: f092d7c28f783773c0c48be2f48ec708b986cb2bc059a5312420a15dd7e57878
+  data.tar.gz: c1af35b25f4c5c9596c232572b158074574ba16b154c72de1ad84c22d189ec40
 SHA512:
-  metadata.gz: 247816469ed9798906c93e6ca0c58bd4b863d379795d9f776b71fc6c7d3835d7eb4ee890372a408ee04981658336a5f924156d85456e66d90793e0d58b7bd9e2
-  data.tar.gz: 2c10991bfa7f4b95896d468f803bae94b44899fc695c1113bd6fa6d7d90c784f4303939a7c2637ed70cd6335bf51f66688d6c932b03a6c0d284f5060cc009646
+  metadata.gz: 0f20e8dbf0ce1d8ccc67ede27cdb15c8a6253d01e35c44780194b8322ccd3281e8f5c9fb8a3d311fcd4f91236988e1379cb639315711f87549f6dbd4fed44402
+  data.tar.gz: fa16fbf938973290b2724a8d1215aca328260813592083f2ea7adf9a6503c1d981702594260ab38969de05b13e78477e60ad56e201f1b7e754aa9759666899f8

data/lib/mdtoc.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require 'optparse'

data/lib/mdtoc/cli.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require 'optparse'

data/lib/mdtoc/markdown/header.rb

@@ -14,7 +14,7 @@ module Mdtoc
           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
 
@@ -28,13 +28,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,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require 'sorbet-runtime'

data/lib/mdtoc/node.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 require 'pathname'
@@ -45,33 +45,33 @@ module Mdtoc
     def label
       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.1.5'
 end

data/lib/mdtoc/writer.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module Mdtoc

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdtoc
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - andornaut
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2021-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -159,8 +159,13 @@ description: |
 
   ## 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
 
   ```
   task default: %w[mdtoc]
@@ -183,6 +188,8 @@ description: |
   end
   ```
 
+  See [andornaut/til](https://github.com/andornaut/til/blob/master/Rakefile) for an example.
+
   ## Development
 
   ### Installation