danger-toc 0.1.0

data/Rakefile

@@ -0,0 +1,23 @@
+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

@@ -0,0 +1,33 @@
+lib = File.expand_path('../lib', __FILE__)
+$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'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'listen', '3.0.7'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rubocop', '~> 0.41'
+  spec.add_development_dependency 'yard', '~> 0.8'
+end

data/lib/danger_plugin.rb

@@ -0,0 +1,3 @@
+require 'toc/markdown_file'
+require 'toc/config'
+require 'toc/plugin'

data/lib/danger_toc.rb

@@ -0,0 +1 @@
+require 'toc/gem_version'

data/lib/toc/config.rb

@@ -0,0 +1,29 @@
+module Danger
+  module Toc
+    module Config
+      extend self
+
+      attr_accessor :files
+
+      def files=(value)
+        @files = value
+      end
+
+      def reset
+        self.files = ['README.md']
+      end
+
+      reset
+    end
+
+    class << self
+      def configure
+        block_given? ? yield(Config) : Config
+      end
+
+      def config
+        Config
+      end
+    end
+  end
+end

data/lib/toc/constructor.rb

@@ -0,0 +1,40 @@
+require 'kramdown/converter'
+
+module Danger
+  module Toc
+    class Constructor < Kramdown::Converter::Toc
+      def flatten(el)
+        return [] unless el.type == :toc
+        result = []
+        if el.value
+          result << {
+            id: el.attr[:id],
+            text: el.value.options[:raw_text],
+            depth: el.value.options[:level]
+          }
+        end
+        if el.children
+          el.children.each do |child|
+            result.concat(flatten(child))
+          end
+        end
+        result
+      end
+
+      def convert(el)
+        toc = flatten(super(el))
+        has_toc = false
+        headers = []
+        toc.each do |line|
+          if !has_toc && line[:text] == 'Table of Contents' # TODO: make configurable
+            headers = [] # drop any headers prior to TOC
+            has_toc = true
+          else
+            headers << line
+          end
+        end
+        headers
+      end
+    end
+  end
+end

data/lib/toc/extractor.rb

@@ -0,0 +1,27 @@
+require 'kramdown/converter'
+
+module Danger
+  module Toc
+    class Extractor < Kramdown::Converter::Base
+      def initialize(root, options)
+        super
+        @toc_start = nil
+        @toc_end = nil
+        @in_toc = false
+      end
+
+      def convert(el)
+        if el.type == :header && el.options[:raw_text] == 'Table of Contents'
+          @in_toc = true
+          @toc_start = el.options[:location]
+        elsif el.type == :header
+          @toc_end = el.options[:location] if @in_toc && !@toc_end
+          @in_toc = false
+        else
+          el.children.each { |child| convert(child) }
+        end
+        [@toc_start, @toc_end]
+      end
+    end
+  end
+end

data/lib/toc/gem_version.rb

@@ -0,0 +1,3 @@
+module Toc
+  VERSION = '0.1.0'.freeze
+end

data/lib/toc/markdown_file.rb

@@ -0,0 +1,83 @@
+require 'active_support/core_ext/string/inflections'
+
+require_relative 'extractor'
+require_relative 'constructor'
+
+module Danger
+  module Toc
+    class MarkdownFile
+      attr_reader :filename
+      attr_reader :exists
+      attr_reader :toc
+      attr_reader :headers
+
+      def initialize(filename = 'README.md')
+        @filename = filename
+        @exists = File.exist?(filename)
+        if @exists
+          parse!
+          reduce!
+          validate!
+        end
+      end
+
+      def exists?
+        !!@exists
+      end
+
+      def bad?
+        !good?
+      end
+
+      def good?
+        !!@good
+      end
+
+      def has_toc?
+        !!@has_toc
+      end
+
+      def toc_from_headers
+        headers.map do |header|
+          [
+            ' ' * header[:depth] * 2,
+            "- [#{header[:text]}]",
+            "(##{header[:id]})"
+          ].compact.join
+        end
+      end
+
+      private
+
+      # Parse markdown file for TOC.
+      def parse!
+        md = File.read(filename)
+        doc = Kramdown::Document.new(md)
+
+        # extract toc
+        toc_start, toc_end = Danger::Toc::Extractor.convert(doc.root).first
+        @has_toc = toc_start && toc_end
+        @toc = md.split("\n")[toc_start, toc_end - toc_start - 1].reject(&:empty?) if @has_toc
+
+        # construct toc
+        @headers = Danger::Toc::Constructor.convert(doc.root).first
+      end
+
+      def reduce!
+        min_depth = nil
+        headers.each do |header|
+          min_depth = header[:depth] unless min_depth && min_depth < header[:depth]
+        end
+        if min_depth
+          headers.each do |header|
+            header[:depth] -= min_depth
+          end
+        end
+      end
+
+      def validate!
+        @good = (toc_from_headers == toc)
+      end
+    end
+  end
+end

data/lib/toc/plugin.rb

@@ -0,0 +1,68 @@
+module Danger
+  # Check whether the TOC in .md file(s) has been updated.
+  #
+  # @example Run all checks on the default README.md.
+  #
+  #          toc.check
+  #
+  # @example Customize filenames and remind the requester to update TOCs when necessary.
+  #
+  #          toc.filenames = ['README.md']
+  #          toc.is_toc_correct?
+  #
+  # @see  dblock/danger-toc
+  # @tags toc
+
+  class DangerToc < Plugin
+    # The toc filenames, defaults to `[README.md]`.
+    # @return [Array]
+    attr_accessor :filenames
+
+    def initialize(dangerfile)
+      @filenames = ['README.md']
+      super
+    end
+
+    # Run all checks.
+    # @return [void]
+    def check
+      is_toc_correct?
+    end
+
+    # Has the CHANGELOG file been modified?
+    # @return [boolean]
+    def toc_changes?
+      (git.modified_files & filename).any? || (git.added_files & filenames).any?
+    end
+
+    # Is the TOC format correct?
+    # @return [boolean]
+    def is_toc_correct?
+      filenames.all? do |filename|
+        toc_file = Danger::Toc::MarkdownFile.new(filename)
+        if !toc_file.exists?
+          messaging.fail("The #{filename} file does not exist.", sticky: false)
+          false
+        elsif toc_file.good?
+          true
+        else
+          markdown <<-MARKDOWN
+Here's the expected TOC for #{filename}:
+
+```markdown
+# Table of Contents
+
+#{toc_file.toc_from_headers.join("\n")}
+```
+MARKDOWN
+          if toc_file.has_toc?
+            messaging.fail("The TOC found in #{filename} doesn't match the sections of the file.", sticky: false)
+          else
+            messaging.fail("The #{filename} file is missing a TOC.", sticky: false)
+          end
+          false
+        end
+      end
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Danger::Toc::Config do
+  after(:each) do
+    described_class.reset
+  end
+
+  describe 'configure' do
+    describe 'files' do
+      context 'defailt' do
+        it 'assumes README.md' do
+          expect(Danger::Toc.config.files).to eq ['README.md']
+        end
+      end
+      context 'when valid' do
+        before do
+          Danger::Toc.configure do |config|
+            config.files = ['README.md', 'SOMETHING.md']
+          end
+        end
+
+        it 'saves configuration' do
+          expect(Danger::Toc.config.files).to eq ['README.md', 'SOMETHING.md']
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/markdown_file/ONE-SECTION-WITH-INVALID-TOC.md

@@ -0,0 +1,11 @@
+# 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-LEVEL.md

@@ -0,0 +1,11 @@
+# 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.md

@@ -0,0 +1,11 @@
+# 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.md

@@ -0,0 +1,5 @@
+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/WITH-QUOTED-EXAMPLE.md

@@ -0,0 +1,22 @@
+# 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
+# example config.ru
+
+require 'danger-toc'
+```
+
+# Conclusion
+
+The quick brown fox jumps over the lazy dog.

data/spec/markdown_file/danger_toc_readme_spec.rb

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