danger-toc 0.1.0

data/spec/markdown_file/one_section_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Danger::Toc::MarkdownFile do
+  describe 'ONE-SECTION.md' do
+    let(:filename) { File.expand_path('../../fixtures/markdown_file/ONE-SECTION.md', __FILE__) }
+    subject do
+      Danger::Toc::MarkdownFile.new(filename)
+    end
+    it 'exists?' do
+      expect(subject.exists?).to be true
+    end
+    it 'has_toc?' do
+      expect(subject.has_toc?).to be false
+    end
+    it 'toc' do
+      expect(subject.toc).to be nil
+    end
+    it 'headers' do
+      expect(subject.headers).to eq([{ depth: 0, id: 'what-is-this', text: 'What is This?' }])
+    end
+    it 'good?' do
+      expect(subject.good?).to be false
+    end
+    it 'bad?' do
+      expect(subject.bad?).to be true
+    end
+  end
+end

data/spec/markdown_file/one_section_with_toc_level_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Danger::Toc::MarkdownFile do
+  describe 'ONE-SECTION-WITH-TOC-LEVEL.md' do
+    let(:filename) { File.expand_path('../../fixtures/markdown_file/ONE-SECTION-WITH-TOC-LEVEL.md', __FILE__) }
+    subject do
+      Danger::Toc::MarkdownFile.new(filename)
+    end
+    it 'exists?' do
+      expect(subject.exists?).to be true
+    end
+    it 'has_toc?' do
+      expect(subject.has_toc?).to be true
+    end
+    it 'toc' do
+      expect(subject.toc).to eq(['- [What is This?](#what-is-this)'])
+    end
+    it 'headers' do
+      expect(subject.headers).to eq([{ depth: 0, id: 'what-is-this', text: 'What is This?' }])
+    end
+    it 'good?' do
+      expect(subject.good?).to be true
+    end
+    it 'bad?' do
+      expect(subject.bad?).to be false
+    end
+  end
+end

data/spec/markdown_file/one_section_with_toc_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Danger::Toc::MarkdownFile do
+  describe 'ONE-SECTION-WITH-TOC.md' do
+    let(:filename) { File.expand_path('../../fixtures/markdown_file/ONE-SECTION-WITH-TOC.md', __FILE__) }
+    subject do
+      Danger::Toc::MarkdownFile.new(filename)
+    end
+    it 'exists?' do
+      expect(subject.exists?).to be true
+    end
+    it 'has_toc?' do
+      expect(subject.has_toc?).to be true
+    end
+    it 'toc' do
+      expect(subject.toc).to eq(['- [What is This?](#what-is-this)'])
+    end
+    it 'headers' do
+      expect(subject.headers).to eq([{ depth: 0, id: 'what-is-this', text: 'What is This?' }])
+    end
+    it 'good?' do
+      expect(subject.good?).to be true
+    end
+    it 'bad?' do
+      expect(subject.bad?).to be false
+    end
+  end
+end

data/spec/markdown_file/with_quoted_example_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Danger::Toc::MarkdownFile do
+  describe 'WITH-QUOTED-EXAMPLE.md' do
+    let(:filename) { File.expand_path('../../fixtures/markdown_file/WITH-QUOTED-EXAMPLE.md', __FILE__) }
+    subject do
+      Danger::Toc::MarkdownFile.new(filename)
+    end
+    it 'exists?' do
+      expect(subject.exists?).to be true
+    end
+    it 'has_toc?' do
+      expect(subject.has_toc?).to be true
+    end
+    it 'toc' do
+      expect(subject.toc).to eq(['- [Example](#example)', '- [Conclusion](#conclusion)'])
+    end
+    it 'headers' do
+      expect(subject.headers).to eq(
+        [
+          { depth: 0, id: 'example', text: 'Example' },
+          { depth: 0, id: 'conclusion', text: 'Conclusion' }
+        ]
+      )
+    end
+    it 'good?' do
+      expect(subject.good?).to be true
+    end
+    it 'bad?' do
+      expect(subject.bad?).to be false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$LOAD_PATH.unshift((ROOT + 'lib').to_s)
+$LOAD_PATH.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'pry'
+
+require 'rspec'
+require 'danger'
+
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace 'bundler'
+  config.color = true
+  config.tty = true
+end
+
+require 'danger_plugin'
+
+def testing_ui
+  Cork::Board.new(silent: true)
+end
+
+def testing_env
+  {
+    'HAS_JOSH_K_SEAL_OF_APPROVAL' => 'true',
+    'TRAVIS_PULL_REQUEST' => '800',
+    'TRAVIS_REPO_SLUG' => 'dblock/danger-toc',
+    'TRAVIS_COMMIT_RANGE' => '759adcbd0d8f...13c4dc8bb61d',
+    'DANGER_GITHUB_API_TOKEN' => '123sbdq54erfsd3422gdfio'
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

data/spec/toc_spec.rb

@@ -0,0 +1,87 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Danger::Toc do
+  after(:each) do
+    Danger::Toc::Config.reset
+  end
+
+  it 'is a Danger plugin' do
+    expect(Danger::DangerToc.new(nil)).to be_a Danger::Plugin
+  end
+
+  describe 'with Dangerfile' do
+    let(:filename) { File.expand_path('../fixtures/markdown_file/ONE-SECTION-WITH-TOC.md', __FILE__) }
+    let(:dangerfile) { testing_dangerfile }
+    let(:toc) do
+      dangerfile.toc.filenames = [filename]
+      dangerfile.toc
+    end
+    let(:status_report) { toc.status_report }
+
+    context 'is_toc_correct?' do
+      subject do
+        toc.is_toc_correct?
+      end
+
+      context 'without a file' do
+        let(:filename) { 'does-not-exist' }
+        it 'complains' do
+          expect(subject).to be false
+          expect(status_report[:errors]).to eq ['The does-not-exist file does not exist.']
+        end
+      end
+
+      context 'with changes' do
+        before do
+          allow(toc.git).to receive(:modified_files).and_return([filename])
+          allow(toc.git).to receive(:added_files).and_return([])
+        end
+
+        it 'has no complaints' do
+          expect(subject).to be true
+          expect(status_report[:errors]).to eq []
+          expect(status_report[:warnings]).to eq []
+          expect(status_report[:markdowns]).to eq []
+        end
+      end
+
+      context 'with missing TOC' do
+        let(:filename) { File.expand_path('../fixtures/markdown_file/ONE-SECTION.md', __FILE__) }
+        it 'reports errors' do
+          expect(subject).to be false
+          expect(status_report[:errors]).to eq ["The #{filename} file is missing a TOC."]
+          expect(status_report[:warnings]).to eq []
+          expect(status_report[:markdowns].map(&:message)).to eq [<<-MARKDOWN
+Here's the expected TOC for #{filename}:
+
+```markdown
+# Table of Contents
+
+- [What is This?](#what-is-this)
+```
+MARKDOWN
+]
+        end
+      end
+
+      context 'with invalid TOC' do
+        let(:filename) { File.expand_path('../fixtures/markdown_file/ONE-SECTION-WITH-INVALID-TOC.md', __FILE__) }
+        it 'reports errors' do
+          expect(subject).to be false
+          expect(status_report[:errors]).to eq ["The TOC found in #{filename} doesn't match the sections of the file."]
+          expect(status_report[:warnings]).to eq []
+          expect(status_report[:markdowns].map(&:message)).to eq [<<-MARKDOWN
+Here's the expected TOC for #{filename}:
+
+```markdown
+# Table of Contents
+
+- [What is This?](#what-is-this)
+```
+MARKDOWN
+]
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,262 @@
+--- !ruby/object:Gem::Specification
+name: danger-toc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dblock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: A danger.systems plugin for your markdown TOC.
+email:
+- dblock@dblock.org
+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
+- lib/toc/constructor.rb
+- lib/toc/extractor.rb
+- lib/toc/gem_version.rb
+- lib/toc/markdown_file.rb
+- lib/toc/plugin.rb
+- spec/config_spec.rb
+- spec/fixtures/markdown_file/ONE-SECTION-WITH-INVALID-TOC.md
+- spec/fixtures/markdown_file/ONE-SECTION-WITH-TOC-LEVEL.md
+- spec/fixtures/markdown_file/ONE-SECTION-WITH-TOC.md
+- spec/fixtures/markdown_file/ONE-SECTION.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/spec_helper.rb
+- spec/toc_spec.rb
+homepage: https://github.com/dblock/danger-toc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: A danger.systems plugin for your markdown TOC.
+test_files:
+- spec/config_spec.rb
+- spec/fixtures/markdown_file/ONE-SECTION-WITH-INVALID-TOC.md
+- spec/fixtures/markdown_file/ONE-SECTION-WITH-TOC-LEVEL.md
+- spec/fixtures/markdown_file/ONE-SECTION-WITH-TOC.md
+- spec/fixtures/markdown_file/ONE-SECTION.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/spec_helper.rb
+- spec/toc_spec.rb