danger-toc 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11cf1615f816fb91537d90ee61bf5e53123e1127
-  data.tar.gz: 8391ad24cabe41e7989ab2b8b154d3b6a45a900b
+  metadata.gz: 8d6f07178a26d9c1cc6267388640e6f4c21ad15b
+  data.tar.gz: 6cd82b36ca80b580f402cbbd2a31b5a319dfb9e3
 SHA512:
-  metadata.gz: 6331b825f408b1c52a9b70cce3a1532c1df3e8cc469a3048b695edf6b6af973e028abb77af0ed2356202933fe26518c133262e5efc5f32fbbdb8c0c7aedec7cd
-  data.tar.gz: 6ff29b16f78ecb185a433c2ddc12f3c22e65d4424d2e7550938024600214c4dd9bf0cd6752156d85a294824ffa69000d5f0ca29c013b9e3d681662b50fa2e3a2
+  metadata.gz: f41167916836adaea70857524473e43654cff465430046b6342a9a77049294c834c2be9f33d5ad0a5610a164dff0611c0a8cced4763985655450d923befcef13
+  data.tar.gz: 6713504e51a68041100b89c05e1210294172cd725032f5628ce51aa1b1e2539bc06f59ab0054a5d2f0c79a522847293a6b513616ccf4897a80d55828925f8659

data/.rubocop_todo.yml

@@ -27,7 +27,9 @@ Style/Documentation:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/toc/config.rb'
-    - 'lib/toc/constructor.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'

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Changelog
 
+### 0.1.2 (2018/04/02)
+
+* [#14](https://github.com/dblock/danger-toc/pull/14): Configure "Table of Contents" format with `toc.format`. Allow values: github (by default) and kramdown - [@mr-dxdy](https://github.com/mr-dxdy).
+
 ### 0.1.1 (2018/03/27)
 
 * [#3](https://github.com/dblock/danger-toc/issues/3): Configure "Table of Contents" header with `toc.header` - [@dblock](https://github.com/dblock).

data/RELEASING.md

@@ -31,7 +31,7 @@ Commit your changes.
 
 ```
 git add CHANGELOG.md lib/toc/gem_version.rb
-git commit -m "Preparing for release 0.2.2."
+git commit -m "Preparing for release, 0.2.2."
 git push origin master
 ```
 
@@ -61,7 +61,7 @@ Increment the third version number in [lib/toc/gem_version.rb](lib/toc/gem_versi
 Commit your changes.
 
 ```
-git add CHANGELOG.md lib/slack/version.rb
+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/lib/toc/config.rb

@@ -3,8 +3,8 @@ module Danger
     module Config
       extend self
 
-      attr_accessor :files
-      attr_accessor :header
+      attr_accessor :files, :header
+      attr_writer :format
 
       # Files to process
       def files=(value)
@@ -16,9 +16,18 @@ module Danger
         @header = value
       end
 
+      def format
+        @format ||= default_format
+      end
+
+      def default_format
+        :github
+      end
+
       def reset
         self.files = ['README.md']
         self.header = 'Table of Contents'
+        self.format = default_format
       end
 
       reset

data/lib/toc/constructors.rb

@@ -0,0 +1,16 @@
+require_relative 'constructors/kramdown_constructor'
+require_relative 'constructors/github_constructor'
+
+module Danger
+  module Toc
+    module Constructors
+      def self.get(name)
+        const_get "#{name.to_s.camelize}Constructor"
+      end
+
+      def self.current
+        get Danger::Toc.config.format
+      end
+    end
+  end
+end

data/lib/toc/constructors/github_constructor.rb

@@ -0,0 +1,17 @@
+module Danger
+  module Toc
+    module Constructors
+      class GithubConstructor < KramdownConstructor
+        PUNCTUATION_REGEXP = /[^\p{Word}\- ]/u
+
+        def basic_generate_id(str)
+          # Get source code from https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/toc_filter.rb#L38
+          id = str.downcase
+          id.gsub!(PUNCTUATION_REGEXP, '') # remove punctuation
+          id.tr!(' ', '-') # replace spaces with dash
+          id
+        end
+      end
+    end
+  end
+end

data/lib/toc/constructors/kramdown_constructor.rb

@@ -0,0 +1,42 @@
+require 'kramdown/converter'
+
+module Danger
+  module Toc
+    module Constructors
+      class KramdownConstructor < 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] == Danger::Toc.config.header
+              headers = [] # drop any headers prior to TOC
+              has_toc = true
+            else
+              headers << line
+            end
+          end
+          headers
+        end
+      end
+    end
+  end
+end

data/lib/toc/gem_version.rb

@@ -1,3 +1,3 @@
 module Toc
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/lib/toc/markdown_file.rb

@@ -1,7 +1,7 @@
 require 'active_support/core_ext/string/inflections'
 
 require_relative 'extractor'
-require_relative 'constructor'
+require_relative 'constructors'
 
 module Danger
   module Toc
@@ -60,7 +60,7 @@ module Danger
         @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
+        @headers = Danger::Toc::Constructors.current.convert(doc.root).first
       end
 
       def reduce!

data/spec/config_spec.rb

@@ -42,5 +42,25 @@ describe Danger::Toc::Config do
         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.configure do |config|
+            config.format = :kramdown
+          end
+        end
+
+        it 'is set' do
+          expect(Danger::Toc.config.format).to eq(:kramdown)
+        end
+      end
+    end
   end
 end

data/spec/constructors_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+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_with_underscore_in_name.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/markdown_file/with_underscore_in_section_name_spec.rb

@@ -0,0 +1,32 @@
+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', __FILE__)
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-toc
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - dblock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2018-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -204,23 +204,28 @@ files:
 - lib/danger_plugin.rb
 - lib/danger_toc.rb
 - lib/toc/config.rb
-- lib/toc/constructor.rb
+- lib/toc/constructors.rb
+- lib/toc/constructors/github_constructor.rb
+- lib/toc/constructors/kramdown_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/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
@@ -249,16 +254,19 @@ 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

data/lib/toc/constructor.rb

@@ -1,40 +0,0 @@
-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] == Danger::Toc.config.header
-            headers = [] # drop any headers prior to TOC
-            has_toc = true
-          else
-            headers << line
-          end
-        end
-        headers
-      end
-    end
-  end
-end