danger-toc 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8d6f07178a26d9c1cc6267388640e6f4c21ad15b
-  data.tar.gz: 6cd82b36ca80b580f402cbbd2a31b5a319dfb9e3
+SHA256:
+  metadata.gz: 6f762724f89edff7e76c51e6ffae851d257b1f4f5ef2fd668a9c7e28c5a62c0f
+  data.tar.gz: 9b9cd63986e67d85dda7a1067eb70abdd782ed27ad684ac72b781fb5145f5493
 SHA512:
-  metadata.gz: f41167916836adaea70857524473e43654cff465430046b6342a9a77049294c834c2be9f33d5ad0a5610a164dff0611c0a8cced4763985655450d923befcef13
-  data.tar.gz: 6713504e51a68041100b89c05e1210294172cd725032f5628ce51aa1b1e2539bc06f59ab0054a5d2f0c79a522847293a6b513616ccf4897a80d55828925f8659
+  metadata.gz: 18157fc64bfcc1efb3db474d650b771a314a90b15838bfe5d222a21ab344c18a80bb848b41f5623e1391f30921b3ae058f4f3c40e0076f5a5b7af2e840b02993
+  data.tar.gz: 932ac02e3ebaac4ada45b08fe6353bcbf7bc84b66f87e44e4c35f799e0a881db35843f6c31dafa6f22fcf0631a6b3551c8ce25cacffde51f81eb5a5ee8c7c255

data/.rubocop.yml

@@ -1,6 +1,4 @@
 AllCops:
-  Include:
-    - Rakefile
   Exclude:
     - vendor/**/*
 
@@ -10,4 +8,7 @@ Metrics/BlockLength:
 Metrics/LineLength:
   Enabled: fale
 
+Style/ModuleFunction:
+  Enabled: false
+
 inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -1,27 +1,61 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-03-23 17:04:14 +0300 using RuboCop version 0.41.2.
+# on 2018-08-15 11:59:49 -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: 2
+Lint/DuplicateMethods:
+  Exclude:
+    - 'lib/toc/config.rb'
+
 # Offense count: 4
 Metrics/AbcSize:
   Max: 19
 
-# Offense count: 24
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 119
+# 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: 6
+# 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/**/*'
@@ -39,26 +73,14 @@ Style/DoubleNegation:
   Exclude:
     - 'lib/toc/markdown_file.rb'
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
     - 'lib/toc/markdown_file.rb'
 
-# Offense count: 1
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: module_function, extend_self
-Style/ModuleFunction:
-  Exclude:
-    - 'lib/toc/config.rb'
-
-# Offense count: 2
-# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist.
-# NamePrefix: is_, has_, have_
-# NamePrefixBlacklist: is_, has_, have_
-# NameWhitelist: is_a?
-Style/PredicateName:
-  Exclude:
-    - 'spec/**/*'
-    - 'lib/toc/markdown_file.rb'
-    - 'lib/toc/plugin.rb'
+# Offense count: 26
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 119

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Changelog
 
+### 0.1.3 (2018/08/15)
+
+* [#7](https://github.com/dblock/danger-toc/issues/7): Parse documents as Github Flavored Markdown by default - [@dblock](https://github.com/dblock).
+
 ### 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).

data/Rakefile

@@ -4,7 +4,7 @@ require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:specs)
 
-task default: %i(rubocop specs)
+task default: %i[rubocop specs]
 
 task :spec do
   Rake::Task['specs'].invoke

data/danger-toc.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'toc/gem_version.rb'
 
@@ -24,10 +24,10 @@ Gem::Specification.new do |spec|
   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 'listen'
   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.0'
-  spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'rubocop', '0.58.2'
+  spec.add_development_dependency 'yard'
 end

data/lib/toc/gem_version.rb

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

data/lib/toc/markdown_file.rb

@@ -52,7 +52,7 @@ module Danger
       # Parse markdown file for TOC.
       def parse!
         md = File.read(filename)
-        doc = Kramdown::Document.new(md)
+        doc = Kramdown::Document.new(md, input: 'GFM')
 
         # extract toc
         toc_start, toc_end = Danger::Toc::Extractor.convert(doc.root).first

data/lib/toc/plugin.rb

@@ -54,7 +54,7 @@ Here's the expected TOC for #{filename}:
 
 #{toc_file.toc_from_headers.join("\n")}
 ```
-MARKDOWN
+          MARKDOWN
           if toc_file.has_toc?
             messaging.fail("The TOC found in #{filename} doesn't match the sections of the file.", sticky: false)
           else

data/spec/config_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../spec_helper', __FILE__)
+require File.expand_path('spec_helper', __dir__)
 
 describe Danger::Toc::Config do
   after(:each) do

data/spec/constructors_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../spec_helper', __FILE__)
+require File.expand_path('spec_helper', __dir__)
 
 describe Danger::Toc::Constructors do
   describe '.get' do

data/spec/fixtures/markdown_file/with_quoted_example.md

@@ -12,7 +12,11 @@ The quick brown fox jumps over the lazy dog.
 The quick brown fox jumps over the lazy dog.
 
 ```ruby
-# example config.ru
+# one
+
+require 'danger-toc'
+
+# two
 
 require 'danger-toc'
 ```

data/spec/markdown_file/danger_toc_readme_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Danger::Toc::MarkdownFile do
   describe 'danger-toc README' do
-    let(:filename) { File.expand_path('../../../README.md', __FILE__) }
+    let(:filename) { File.expand_path('../../README.md', __dir__) }
     subject do
       Danger::Toc::MarkdownFile.new(filename)
     end

data/spec/markdown_file/one_section_spec.rb

@@ -2,7 +2,7 @@ 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', __FILE__) }
+    let(:filename) { File.expand_path('../fixtures/markdown_file/one_section.md', __dir__) }
     subject do
       Danger::Toc::MarkdownFile.new(filename)
     end

data/spec/markdown_file/one_section_with_toc_level_spec.rb

@@ -2,7 +2,7 @@ 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', __FILE__) }
+    let(:filename) { File.expand_path('../fixtures/markdown_file/one_section_with_toc_level.md', __dir__) }
     subject do
       Danger::Toc::MarkdownFile.new(filename)
     end

data/spec/markdown_file/one_section_with_toc_spec.rb

@@ -2,7 +2,7 @@ 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', __FILE__) }
+    let(:filename) { File.expand_path('../fixtures/markdown_file/one_section_with_toc.md', __dir__) }
     subject do
       Danger::Toc::MarkdownFile.new(filename)
     end

data/spec/markdown_file/with_quoted_example_spec.rb

@@ -2,7 +2,7 @@ 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', __FILE__) }
+    let(:filename) { File.expand_path('../fixtures/markdown_file/with_quoted_example.md', __dir__) }
     subject do
       Danger::Toc::MarkdownFile.new(filename)
     end

data/spec/markdown_file/with_underscore_in_section_name_spec.rb

@@ -3,7 +3,7 @@ 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__)
+      File.expand_path('../fixtures/markdown_file/one_section_with_underscore_in_name.md', __dir__)
     end
 
     subject do

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'pathname'
-ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+ROOT = Pathname.new(File.expand_path('..', __dir__))
 $LOAD_PATH.unshift((ROOT + 'lib').to_s)
 $LOAD_PATH.unshift((ROOT + 'spec').to_s)
 

data/spec/toc_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path('../spec_helper', __FILE__)
+require File.expand_path('spec_helper', __dir__)
 
 describe Danger::Toc do
   after(:each) do
@@ -10,7 +10,7 @@ describe Danger::Toc do
   end
 
   describe 'with Dangerfile' do
-    let(:filename) { File.expand_path('../fixtures/markdown_file/one_section_with_toc.md', __FILE__) }
+    let(:filename) { File.expand_path('fixtures/markdown_file/one_section_with_toc.md', __dir__) }
     let(:dangerfile) { testing_dangerfile }
     let(:toc) do
       dangerfile.toc.filenames = [filename]
@@ -69,7 +69,7 @@ describe Danger::Toc do
       end
 
       context 'with missing TOC' do
-        let(:filename) { File.expand_path('../fixtures/markdown_file/one_section.md', __FILE__) }
+        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."]
@@ -82,13 +82,13 @@ Here's the expected TOC for #{filename}:
 
 - [What is This?](#what-is-this)
 ```
-MARKDOWN
+          MARKDOWN
 ]
         end
       end
 
       context 'with invalid TOC' do
-        let(:filename) { File.expand_path('../fixtures/markdown_file/one_section_with_invalid_toc.md', __FILE__) }
+        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."]
@@ -101,7 +101,7 @@ Here's the expected TOC for #{filename}:
 
 - [What is This?](#what-is-this)
 ```
-MARKDOWN
+          MARKDOWN
 ]
         end
       end
@@ -114,7 +114,7 @@ MARKDOWN
         end
 
         context 'with missing TOC' do
-          let(:filename) { File.expand_path('../fixtures/markdown_file/one_section.md', __FILE__) }
+          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"
@@ -122,7 +122,7 @@ MARKDOWN
         end
 
         context 'with a custom TOC' do
-          let(:filename) { File.expand_path('../fixtures/markdown_file/one_section_with_custom_toc.md', __FILE__) }
+          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 []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-toc
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - dblock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-02 00:00:00.000000000 Z
+date: 2018-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -98,16 +98,16 @@ dependencies:
   name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.7
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.7
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -154,30 +154,30 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.41.0
+        version: 0.58.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.41.0
+        version: 0.58.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 description: A danger.systems plugin for your markdown TOC.
 email:
 - dblock@dblock.org
@@ -248,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A danger.systems plugin for your markdown TOC.