danger-toc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38ae0d61092888976e59f8da7acb132be0cd0284
-  data.tar.gz: cfd1e2d33f51048d8565908142ffbd35d7fe4803
+  metadata.gz: 11cf1615f816fb91537d90ee61bf5e53123e1127
+  data.tar.gz: 8391ad24cabe41e7989ab2b8b154d3b6a45a900b
 SHA512:
-  metadata.gz: ae85c1148f5440b7fc2bcb4843118ef32944688e38a5391478130bd325a038fdacea55467ddd2bc14218d314a2be042ca6b334e08d92aea64b82f6cd6585f909
-  data.tar.gz: 38b99caf0a4a221a698e918c513b614a882e2c5268eaa9323d1552c2324468ff85368135cfa870d1cc83c053d19481ea5f9be18a0c372a3920a5a9936480d35d
+  metadata.gz: 6331b825f408b1c52a9b70cce3a1532c1df3e8cc469a3048b695edf6b6af973e028abb77af0ed2356202933fe26518c133262e5efc5f32fbbdb8c0c7aedec7cd
+  data.tar.gz: 6ff29b16f78ecb185a433c2ddc12f3c22e65d4424d2e7550938024600214c4dd9bf0cd6752156d85a294824ffa69000d5f0ca29c013b9e3d681662b50fa2e3a2

data/.gitignore

@@ -3,3 +3,9 @@ pkg
 .idea/
 Gemfile.lock
 .yardoc
+
+# ignore the Ruby Version manager
+.rvmrc
+.ruby-version
+.ruby-gemset
+.rbenv

data/.rubocop_todo.yml

@@ -1,36 +1,17 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-11-05 10:44:59 -0500 using RuboCop version 0.51.0.
+# on 2018-03-23 17:04:14 +0300 using RuboCop version 0.41.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.
-# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
-Layout/IndentHeredoc:
-  Exclude:
-    - 'lib/toc/plugin.rb'
-    - 'spec/toc_spec.rb'
-
-# Offense count: 1
-Lint/DuplicateMethods:
-  Exclude:
-    - 'lib/toc/config.rb'
-
 # Offense count: 4
 Metrics/AbcSize:
-  Max: 18
+  Max: 19
 
-# Offense count: 5
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Max: 69
-
-# Offense count: 20
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# Offense count: 24
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 119
@@ -40,28 +21,6 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Max: 21
 
-# Offense count: 4
-# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
-# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
-Naming/FileName:
-  Exclude:
-    - 'Dangerfile'
-    - 'Gemfile'
-    - 'Guardfile'
-    - 'danger-toc.gemspec'
-
-# 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: 6
 Style/Documentation:
   Exclude:
@@ -78,7 +37,7 @@ Style/DoubleNegation:
   Exclude:
     - 'lib/toc/markdown_file.rb'
 
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
@@ -90,3 +49,14 @@ Style/GuardClause:
 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'

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Changelog
 
+### 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).
+* [#11](https://github.com/dblock/danger-toc/pull/11): Fix bug "undefined method #filename" in the method #toc_changes? - [@mr-dxdy](https://github.com/mr-dxdy).
+
 ### 0.1.0 (2017/11/5)
 
 * Initial public release - [@dblock](https://github.com/dblock).

data/README.md

@@ -12,6 +12,7 @@ A plugin for [danger.systems](http://danger.systems) that makes sure your projec
   - [Configuration](#configuration)
   - [Methods and Attributes](#methods-and-attributes)
     - [toc.files](#tocfiles)
+    - [toc.header](#tocheader)
     - [toc.check](#toccheck)
 - [Contributing](#contributing)
 - [Copyright](#copyright)
@@ -34,10 +35,10 @@ Add `toc.check` to your Dangerfile. Make a pull request and see this plugin in a
 
 The plugin supports following configuration options:
 
-You can configure plugin using following code:
 ```ruby
 Danger::Toc.configure do |config|
   config.files = [ 'README.md' ]
+  config.header = 'Table of Contents'
 end
 ```
 
@@ -47,7 +48,11 @@ Methods and attributes from this plugin are available in your `Dangerfile` under
 
 #### toc.files
 
-List of files to ensure TOC in.
+List of files to ensure TOC in, default is `README.md`.
+
+#### toc.header
+
+The Table of Contents header, without `#`, default is `Table of Contents`.
 
 #### toc.check
 

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

@@ -28,6 +28,6 @@ Gem::Specification.new do |spec|
   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 'rubocop', '~> 0.41.0'
   spec.add_development_dependency 'yard', '~> 0.8'
 end

data/lib/toc/config.rb

@@ -4,13 +4,21 @@ module Danger
       extend self
 
       attr_accessor :files
+      attr_accessor :header
 
+      # Files to process
       def files=(value)
         @files = value
       end
 
+      # Table of Contents Header
+      def header=(value)
+        @header = value
+      end
+
       def reset
         self.files = ['README.md']
+        self.header = 'Table of Contents'
       end
 
       reset

data/lib/toc/constructor.rb

@@ -26,7 +26,7 @@ module Danger
         has_toc = false
         headers = []
         toc.each do |line|
-          if !has_toc && line[:text] == 'Table of Contents' # TODO: make configurable
+          if !has_toc && line[:text] == Danger::Toc.config.header
             headers = [] # drop any headers prior to TOC
             has_toc = true
           else

data/lib/toc/extractor.rb

@@ -11,7 +11,7 @@ module Danger
       end
 
       def convert(el)
-        if el.type == :header && el.options[:raw_text] == 'Table of Contents'
+        if el.type == :header && el.options[:raw_text] == Danger::Toc.config.header
           @in_toc = true
           @toc_start = el.options[:location]
         elsif el.type == :header

data/lib/toc/gem_version.rb

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

data/lib/toc/plugin.rb

@@ -29,10 +29,10 @@ module Danger
       is_toc_correct?
     end
 
-    # Has the CHANGELOG file been modified?
+    # Has the README file been modified?
     # @return [boolean]
     def toc_changes?
-      (git.modified_files & filename).any? || (git.added_files & filenames).any?
+      (git.modified_files & filenames).any? || (git.added_files & filenames).any?
     end
 
     # Is the TOC format correct?
@@ -50,7 +50,7 @@ module Danger
 Here's the expected TOC for #{filename}:
 
 ```markdown
-# Table of Contents
+# #{Danger::Toc.config.header}
 
 #{toc_file.toc_from_headers.join("\n")}
 ```

data/spec/config_spec.rb

@@ -7,22 +7,40 @@ describe Danger::Toc::Config do
 
   describe 'configure' do
     describe 'files' do
-      context 'defailt' do
+      context 'default' do
         it 'assumes README.md' do
           expect(Danger::Toc.config.files).to eq ['README.md']
         end
       end
-      context 'when valid' do
+      context 'custom value' do
         before do
           Danger::Toc.configure do |config|
             config.files = ['README.md', 'SOMETHING.md']
           end
         end
 
-        it 'saves configuration' do
+        it 'is set' do
           expect(Danger::Toc.config.files).to eq ['README.md', 'SOMETHING.md']
         end
       end
     end
+    describe 'header' do
+      context 'default' do
+        it 'assumes Table of Contents' do
+          expect(Danger::Toc.config.header).to eq 'Table of Contents'
+        end
+      end
+      context 'custom value' do
+        before do
+          Danger::Toc.configure do |config|
+            config.header = 'Custom TOC'
+          end
+        end
+
+        it 'is set' do
+          expect(Danger::Toc.config.header).to eq 'Custom TOC'
+        end
+      end
+    end
   end
 end

data/spec/fixtures/markdown_file/one_section_with_custom_toc.md

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

data/spec/markdown_file/danger_toc_readme_spec.rb

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

data/spec/markdown_file/one_section_spec.rb

@@ -1,8 +1,8 @@
 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__) }
+  describe 'with a single section' do
+    let(:filename) { File.expand_path('../../fixtures/markdown_file/one_section.md', __FILE__) }
     subject do
       Danger::Toc::MarkdownFile.new(filename)
     end

data/spec/markdown_file/one_section_with_toc_level_spec.rb

@@ -1,8 +1,8 @@
 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__) }
+  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__) }
     subject do
       Danger::Toc::MarkdownFile.new(filename)
     end

data/spec/markdown_file/one_section_with_toc_spec.rb

@@ -1,8 +1,8 @@
 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__) }
+  describe 'one section with TOC' do
+    let(:filename) { File.expand_path('../../fixtures/markdown_file/one_section_with_toc.md', __FILE__) }
     subject do
       Danger::Toc::MarkdownFile.new(filename)
     end

data/spec/markdown_file/with_quoted_example_spec.rb

@@ -1,8 +1,8 @@
 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__) }
+  describe 'with a code example' do
+    let(:filename) { File.expand_path('../../fixtures/markdown_file/with_quoted_example.md', __FILE__) }
     subject do
       Danger::Toc::MarkdownFile.new(filename)
     end

data/spec/toc_spec.rb

@@ -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', __FILE__) }
     let(:dangerfile) { testing_dangerfile }
     let(:toc) do
       dangerfile.toc.filenames = [filename]
@@ -18,6 +18,29 @@ describe Danger::Toc do
     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?
@@ -46,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', __FILE__) }
         it 'reports errors' do
           expect(subject).to be false
           expect(status_report[:errors]).to eq ["The #{filename} file is missing a TOC."]
@@ -65,7 +88,7 @@ MARKDOWN
       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', __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."]
@@ -82,6 +105,32 @@ MARKDOWN
 ]
         end
       end
+
+      context 'with a custom toc header' do
+        before do
+          Danger::Toc.configure do |config|
+            config.header = 'Custom TOC'
+          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[: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', __FILE__) }
+          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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-toc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - dblock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-06 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.41'
+        version: 0.41.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.41'
+        version: 0.41.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -210,11 +210,12 @@ files:
 - 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/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/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
@@ -242,17 +243,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.11
 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/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/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