danger-toc 0.2.0 → 0.3.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-toc
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - dblock
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-28 00:00:00.000000000 Z
+date: 2026-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: danger-plugin-api
+  name: kramdown-parser-gfm
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 description: A danger.systems plugin for your markdown TOC.
 email:
 - dblock@dblock.org
@@ -59,22 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- CONTRIBUTING.md
-- Dangerfile
-- Gemfile
-- Guardfile
 - LICENSE.txt
 - README.md
-- RELEASING.md
-- Rakefile
-- danger-toc.gemspec
-- images/toc-missing.png
 - lib/danger_plugin.rb
 - lib/danger_toc.rb
 - lib/toc/config.rb
@@ -85,28 +100,12 @@ files:
 - lib/toc/gem_version.rb
 - lib/toc/markdown_file.rb
 - lib/toc/plugin.rb
-- spec/config_spec.rb
-- spec/constructors_spec.rb
-- spec/fixtures/markdown_file/one_section.md
-- spec/fixtures/markdown_file/one_section_with_custom_toc.md
-- spec/fixtures/markdown_file/one_section_with_invalid_toc.md
-- spec/fixtures/markdown_file/one_section_with_toc.md
-- spec/fixtures/markdown_file/one_section_with_toc_level.md
-- spec/fixtures/markdown_file/one_section_with_underscore_in_name.md
-- spec/fixtures/markdown_file/with_quoted_example.md
-- spec/markdown_file/danger_toc_readme_spec.rb
-- spec/markdown_file/one_section_spec.rb
-- spec/markdown_file/one_section_with_toc_level_spec.rb
-- spec/markdown_file/one_section_with_toc_spec.rb
-- spec/markdown_file/with_quoted_example_spec.rb
-- spec/markdown_file/with_underscore_in_section_name_spec.rb
-- spec/spec_helper.rb
-- spec/toc_spec.rb
 homepage: https://github.com/dblock/danger-toc
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -114,32 +113,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
 summary: A danger.systems plugin for your markdown TOC.
-test_files:
-- spec/config_spec.rb
-- spec/constructors_spec.rb
-- spec/fixtures/markdown_file/one_section.md
-- spec/fixtures/markdown_file/one_section_with_custom_toc.md
-- spec/fixtures/markdown_file/one_section_with_invalid_toc.md
-- spec/fixtures/markdown_file/one_section_with_toc.md
-- spec/fixtures/markdown_file/one_section_with_toc_level.md
-- spec/fixtures/markdown_file/one_section_with_underscore_in_name.md
-- spec/fixtures/markdown_file/with_quoted_example.md
-- spec/markdown_file/danger_toc_readme_spec.rb
-- spec/markdown_file/one_section_spec.rb
-- spec/markdown_file/one_section_with_toc_level_spec.rb
-- spec/markdown_file/one_section_with_toc_spec.rb
-- spec/markdown_file/with_quoted_example_spec.rb
-- spec/markdown_file/with_underscore_in_section_name_spec.rb
-- spec/spec_helper.rb
-- spec/toc_spec.rb
+test_files: []

data/.gitignore

@@ -1,11 +0,0 @@
-.DS_Store
-pkg
-.idea/
-Gemfile.lock
-.yardoc
-
-# ignore the Ruby Version manager
-.rvmrc
-.ruby-version
-.ruby-gemset
-.rbenv

data/.rspec

@@ -1,2 +0,0 @@
---color
---format=documentation

data/.rubocop.yml

@@ -1,14 +0,0 @@
-AllCops:
-  Exclude:
-    - vendor/**/*
-
-Metrics/BlockLength:
-  Enabled: fale
-
-Metrics/LineLength:
-  Enabled: fale
-
-Style/ModuleFunction:
-  Enabled: false
-
-inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -1,81 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2019-07-28 16:26:13 -0400 using RuboCop version 0.58.2.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
-Layout/IndentHeredoc:
-  Exclude:
-    - 'lib/toc/plugin.rb'
-    - 'spec/toc_spec.rb'
-
-# Offense count: 4
-Metrics/AbcSize:
-  Max: 19
-
-# Offense count: 8
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
-Metrics/BlockLength:
-  Max: 109
-
-# Offense count: 3
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 21
-
-# Offense count: 2
-# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist, MethodDefinitionMacros.
-# NamePrefix: is_, has_, have_
-# NamePrefixBlacklist: is_, has_, have_
-# NameWhitelist: is_a?
-# MethodDefinitionMacros: define_method, define_singleton_method
-Naming/PredicateName:
-  Exclude:
-    - 'spec/**/*'
-    - 'lib/toc/markdown_file.rb'
-    - 'lib/toc/plugin.rb'
-
-# Offense count: 3
-# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
-# AllowedNames: io, id, to, by, on, in, at, ip
-Naming/UncommunicativeMethodParamName:
-  Exclude:
-    - 'lib/toc/constructors/kramdown_constructor.rb'
-    - 'lib/toc/extractor.rb'
-
-# Offense count: 8
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/toc/config.rb'
-    - 'lib/toc/constructors.rb'
-    - 'lib/toc/constructors/github_constructor.rb'
-    - 'lib/toc/constructors/kramdown_constructor.rb'
-    - 'lib/toc/extractor.rb'
-    - 'lib/toc/markdown_file.rb'
-    - 'lib/toc/plugin.rb'
-
-# Offense count: 3
-Style/DoubleNegation:
-  Exclude:
-    - 'lib/toc/markdown_file.rb'
-
-# Offense count: 2
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Exclude:
-    - 'lib/toc/markdown_file.rb'
-
-# Offense count: 26
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 123

data/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-
-cache:
-  directories:
-    - bundle
-
-rvm:
-  - 2.4.1
-
-before_script:
-    - bundle exec danger
-
-script:
-    - bundle exec rake spec

data/CONTRIBUTING.md

@@ -1,125 +0,0 @@
-# Contributing to Danger-Toc
-
-This project is work of [many contributors](https://github.com/dblock/danger-toc/graphs/contributors).
-
-You're encouraged to submit [pull requests](https://github.com/dblock/danger-toc/pulls), [propose features and discuss issues](https://github.com/dblock/danger-toc/issues).
-
-In the examples below, substitute your Github username for `contributor` in URLs.
-
-### Fork the Project
-
-Fork the [project on Github](https://github.com/dblock/danger-toc) and check out your copy.
-
-```
-git clone https://github.com/contributor/danger-toc.git
-cd danger-toc
-git remote add upstream https://github.com/dblock/danger-toc.git
-```
-
-### Bundle Install and Test
-
-Ensure that you can build the project and run tests.
-
-```
-bundle install
-bundle exec rake
-```
-
-## Contribute Code
-
-### Create a Topic Branch
-
-Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
-
-```
-git checkout master
-git pull upstream master
-git checkout -b my-feature-branch
-```
-
-### Write Tests
-
-Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add tests to [spec](spec).
-
-We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
-
-### Write Code
-
-Implement your feature or bug fix.
-
-Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ingored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
-
-Make sure that `bundle exec rake` completes without errors.
-
-### Write Documentation
-
-Document any external behavior in the [README](README.md).
-
-### Update Toc
-
-Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Don't remove *Your contribution here*.
-
-Make it look like every other line, including a link to the issue being fixed, your name and link to your Github account.
-
-### Commit Changes
-
-Make sure git knows your name and email address:
-
-```
-git config --global user.name "Your Name"
-git config --global user.email "contributor@example.com"
-```
-
-Writing good commit logs is important. A commit log should describe what changed and why.
-
-```
-git add ...
-git commit
-```
-
-### Push
-
-```
-git push origin my-feature-branch
-```
-
-### Make a Pull Request
-
-Go to https://github.com/contributor/danger-toc and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
-
-### Update CHANGELOG Again
-
-Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
-
-```
-* [#123](https://github.com/dblock/danger-toc/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
-```
-
-Amend your previous commit and force push the changes.
-
-```
-git commit --amend
-git push origin my-feature-branch -f
-```
-
-### Rebase
-
-If you've been working on a change for a while, rebase with upstream/master.
-
-```
-git fetch upstream
-git rebase upstream/master
-git push origin my-feature-branch -f
-```
-
-### Check on Your Pull Request
-
-Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
-
-### Be Patient
-
-It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
-
-## Thank You
-
-Please do know that we really appreciate and value your time and work. We love you, really.

data/Dangerfile

@@ -1,4 +0,0 @@
-# danger.systems
-
-changelog.check!
-toc.check!

data/Gemfile

@@ -1,16 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :development, :test do
-  gem 'bundler'
-  gem 'danger-changelog', '~> 0.6.0'
-  gem 'guard', '~> 2.14'
-  gem 'guard-rspec', '~> 4.7'
-  gem 'listen'
-  gem 'pry'
-  gem 'rake', '~> 10.0'
-  gem 'rspec', '~> 3.4'
-  gem 'rubocop', '0.58.2'
-  gem 'yard'
-end

data/Guardfile

@@ -1,19 +0,0 @@
-# A guardfile for making Danger Plugins
-# For more info see https://github.com/guard/guard#readme
-
-# To run, use `bundle exec guard`.
-
-guard :rspec, cmd: 'bundle exec rspec' do
-  require 'guard/rspec/dsl'
-  dsl = Guard::RSpec::Dsl.new(self)
-
-  # RSpec files
-  rspec = dsl.rspec
-  watch(rspec.spec_helper) { rspec.spec_dir }
-  watch(rspec.spec_support) { rspec.spec_dir }
-  watch(rspec.spec_files)
-
-  # Ruby files
-  ruby = dsl.ruby
-  dsl.watch_spec_files_for(ruby.lib_files)
-end

data/RELEASING.md

@@ -1,67 +0,0 @@
-# Releasing Danger-Toc
-
-There're no hard rules about when to release danger-toc. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
-
-### Release
-
-Install bundle, run tests, check that all tests succeed locally.
-
-```
-bundle install
-rake
-```
-
-Check that the last build succeeded in [Travis CI](https://travis-ci.org/dblock/danger-toc) for all supported platforms.
-
-Increment the version, modify [lib/toc/gem_version.rb](lib/toc/gem_version.rb).
-
-Following the [Semantic Versioning](http://semver.org/):
-*  Increment the third number if the release has bug fixes and/or very minor features with backward compatibility, only (eg. change `0.2.1` to `0.2.2`).
-*  Increment the second number if the release contains major features or breaking API changes (eg. change `0.2.1` to `0.3.0`).
-
-Create a new version and mark it as Next in [CHANGELOG.md](CHANGELOG.md).
-
-```
-### 0.2.2 (12/03/2016)
-```
-
-Remove the line with "* Your contribution here.", since there will be no more contributions to this release.
-
-Commit your changes.
-
-```
-git add CHANGELOG.md lib/toc/gem_version.rb
-git commit -m "Preparing for release, 0.2.2."
-git push origin master
-```
-
-Release.
-
-```
-$ rake release
-
-danger-toc 0.2.2 built to pkg/danger-toc-0.2.2.gem.
-Tagged v0.2.2.
-Pushed git commits and tags.
-Pushed danger-toc 0.2.2 to rubygems.org.
-```
-
-### Prepare for the Next Version
-
-Add the next release to [CHANGELOG.md](CHANGELOG.md).
-
-```
-### 0.2.3 (Next)
-
-* Your contribution here.
-```
-
-Increment the third version number in [lib/toc/gem_version.rb](lib/toc/gem_version.rb).
-
-Commit your changes.
-
-```
-git add CHANGELOG.md lib/toc/gem_version.rb
-git commit -m "Preparing for next development iteration, 0.2.3."
-git push origin master
-```

data/Rakefile

@@ -1,23 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-RSpec::Core::RakeTask.new(:specs)
-
-task default: %i[rubocop specs]
-
-task :spec do
-  Rake::Task['specs'].invoke
-  Rake::Task['rubocop'].invoke
-  Rake::Task['spec_docs'].invoke
-end
-
-desc 'Run RuboCop on the lib/specs directory'
-RuboCop::RakeTask.new(:rubocop) do |task|
-  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
-end
-
-desc 'Ensure that the plugin passes `danger plugins lint`'
-task :spec_docs do
-  sh 'bundle exec danger plugins lint'
-end

data/danger-toc.gemspec

@@ -1,23 +0,0 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'toc/gem_version.rb'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'danger-toc'
-  spec.version       = Toc::VERSION
-  spec.authors       = ['dblock']
-  spec.email         = ['dblock@dblock.org']
-  spec.description   = 'A danger.systems plugin for your markdown TOC.'
-  spec.summary       = 'A danger.systems plugin for your markdown TOC.'
-  spec.homepage      = 'https://github.com/dblock/danger-toc'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'activesupport'
-  spec.add_dependency 'kramdown'
-  spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
-end

data/spec/config_spec.rb

@@ -1,60 +0,0 @@
-require File.expand_path('spec_helper', __dir__)
-
-describe Danger::Toc::Config do
-  after(:each) do
-    described_class.reset
-  end
-
-  describe 'configure' do
-    describe 'files' do
-      context 'default' do
-        it 'assumes README.md' do
-          expect(Danger::Toc.config.files).to eq ['README.md']
-        end
-      end
-      context 'custom value' do
-        before do
-          Danger::Toc.config.files = ['README.md', 'SOMETHING.md']
-        end
-
-        it 'is set' do
-          expect(Danger::Toc.config.files).to eq ['README.md', 'SOMETHING.md']
-        end
-      end
-    end
-    describe 'header' do
-      context 'default' do
-        it 'assumes Table of Contents' do
-          expect(Danger::Toc.config.header).to eq 'Table of Contents'
-        end
-      end
-      context 'custom value' do
-        before do
-          Danger::Toc.config.header = 'Custom TOC'
-        end
-
-        it 'is set' do
-          expect(Danger::Toc.config.header).to eq 'Custom TOC'
-        end
-      end
-    end
-
-    describe 'format' do
-      context 'default' do
-        it 'assumes github' do
-          expect(Danger::Toc.config.format).to eq(:github)
-        end
-      end
-
-      context 'custom value' do
-        before do
-          Danger::Toc.config.format = :kramdown
-        end
-
-        it 'is set' do
-          expect(Danger::Toc.config.format).to eq(:kramdown)
-        end
-      end
-    end
-  end
-end

data/spec/constructors_spec.rb

@@ -1,23 +0,0 @@
-require File.expand_path('spec_helper', __dir__)
-
-describe Danger::Toc::Constructors do
-  describe '.get' do
-    it 'should return constructor for kramdown' do
-      expect(
-        described_class.get(:kramdown)
-      ).to eq(Danger::Toc::Constructors::KramdownConstructor)
-    end
-
-    it 'should return constructor for github' do
-      expect(
-        described_class.get(:github)
-      ).to eq(Danger::Toc::Constructors::GithubConstructor)
-    end
-
-    it 'should return error if not found constructor' do
-      expect do
-        described_class.get :unknown
-      end.to raise_error(NameError)
-    end
-  end
-end

data/spec/fixtures/markdown_file/one_section.md

@@ -1,5 +0,0 @@
-The quick brown fox jumps over the lazy dog.
-
-# What is This?
-
-The quick brown fox jumps over the lazy dog.

data/spec/fixtures/markdown_file/one_section_with_custom_toc.md

@@ -1,11 +0,0 @@
-# Prelude
-
-The quick brown fox jumps over the lazy dog.
-
-# Custom TOC
-
-- [What is This?](#what-is-this)
-
-# What is This?
-
-The quick brown fox jumps over the lazy dog.