danger-toc 0.2.0 → 0.3.0

data/spec/fixtures/markdown_file/one_section_with_invalid_toc.md

@@ -1,11 +0,0 @@
-# Prelude
-
-The quick brown fox jumps over the lazy dog.
-
-# Table of Contents
-
-- [What is That?](#what-is-that)
-
-# What is This?
-
-The quick brown fox jumps over the lazy dog.

data/spec/fixtures/markdown_file/one_section_with_toc.md

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

data/spec/fixtures/markdown_file/one_section_with_toc_level.md

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

data/spec/fixtures/markdown_file/one_section_with_underscore_in_name.md

@@ -1,11 +0,0 @@
-# Prelude
-
-The quick brown fox jumps over the lazy dog.
-
-## Table of Contents
-
-- [What_is_this?](#what_is_this)
-
-## What_is_this?
-
-The quick brown fox jumps over the lazy dog.

data/spec/fixtures/markdown_file/with_quoted_example.md

@@ -1,26 +0,0 @@
-# Prelude
-
-The quick brown fox jumps over the lazy dog.
-
-# Table of Contents
-
-- [Example](#example)
-- [Conclusion](#conclusion)
-
-# Example
-
-The quick brown fox jumps over the lazy dog.
-
-```ruby
-# one
-
-require 'danger-toc'
-
-# two
-
-require 'danger-toc'
-```
-
-# Conclusion
-
-The quick brown fox jumps over the lazy dog.

data/spec/markdown_file/danger_toc_readme_spec.rb

@@ -1,19 +0,0 @@
-require 'spec_helper'
-
-describe Danger::Toc::MarkdownFile do
-  describe 'danger-toc README' do
-    let(:filename) { File.expand_path('../../README.md', __dir__) }
-    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 'good?' do
-      expect(subject.good?).to be true
-    end
-  end
-end

data/spec/markdown_file/one_section_spec.rb

@@ -1,28 +0,0 @@
-require 'spec_helper'
-
-describe Danger::Toc::MarkdownFile do
-  describe 'with a single section' do
-    let(:filename) { File.expand_path('../fixtures/markdown_file/one_section.md', __dir__) }
-    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

@@ -1,28 +0,0 @@
-require 'spec_helper'
-
-describe Danger::Toc::MarkdownFile do
-  describe 'one section that is not at the root level' do
-    let(:filename) { File.expand_path('../fixtures/markdown_file/one_section_with_toc_level.md', __dir__) }
-    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

@@ -1,28 +0,0 @@
-require 'spec_helper'
-
-describe Danger::Toc::MarkdownFile do
-  describe 'one section with TOC' do
-    let(:filename) { File.expand_path('../fixtures/markdown_file/one_section_with_toc.md', __dir__) }
-    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

@@ -1,33 +0,0 @@
-require 'spec_helper'
-
-describe Danger::Toc::MarkdownFile do
-  describe 'with a code example' do
-    let(:filename) { File.expand_path('../fixtures/markdown_file/with_quoted_example.md', __dir__) }
-    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/markdown_file/with_underscore_in_section_name_spec.rb

@@ -1,32 +0,0 @@
-require 'spec_helper'
-
-describe Danger::Toc::MarkdownFile do
-  describe 'with a underscore in section name' do
-    let(:filename) do
-      File.expand_path('../fixtures/markdown_file/one_section_with_underscore_in_name.md', __dir__)
-    end
-
-    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/spec_helper.rb

@@ -1,38 +0,0 @@
-require 'pathname'
-ROOT = Pathname.new(File.expand_path('..', __dir__))
-$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

@@ -1,134 +0,0 @@
-require File.expand_path('spec_helper', __dir__)
-
-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', __dir__) }
-    let(:dangerfile) { testing_dangerfile }
-    let(:toc) do
-      dangerfile.toc.files = [filename]
-      dangerfile.toc
-    end
-    let(:status_report) { toc.status_report }
-
-    context 'toc_changes?' do
-      it 'should find modified files' do
-        allow(toc.git).to receive(:modified_files).and_return([filename])
-        allow(toc.git).to receive(:added_files).and_return([])
-
-        expect(toc).to be_toc_changes
-      end
-
-      it 'should find added files' do
-        allow(toc.git).to receive(:modified_files).and_return([])
-        allow(toc.git).to receive(:added_files).and_return([filename])
-
-        expect(toc).to be_toc_changes
-      end
-
-      it 'should not found changed files' do
-        allow(toc.git).to receive(:modified_files).and_return([])
-        allow(toc.git).to receive(:added_files).and_return([])
-
-        expect(toc).not_to be_toc_changes
-      end
-    end
-
-    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', __dir__) }
-        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', __dir__) }
-        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
-
-      context 'with a custom toc header' do
-        before do
-          Danger::Toc.config.header = 'Custom TOC'
-        end
-
-        context 'with missing TOC' do
-          let(:filename) { File.expand_path('fixtures/markdown_file/one_section.md', __dir__) }
-          it 'reports errors' do
-            expect(subject).to be false
-            expect(status_report[:markdowns].first.message).to include "\n# Custom TOC\n"
-          end
-        end
-
-        context 'with a custom TOC' do
-          let(:filename) { File.expand_path('fixtures/markdown_file/one_section_with_custom_toc.md', __dir__) }
-          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
-      end
-    end
-  end
-end