danger-toc 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f762724f89edff7e76c51e6ffae851d257b1f4f5ef2fd668a9c7e28c5a62c0f
-  data.tar.gz: 9b9cd63986e67d85dda7a1067eb70abdd782ed27ad684ac72b781fb5145f5493
+  metadata.gz: 1d27e70d24b49b9cb6028e5f55a4315740babe9e9f51a73fe95d7c502e2c18b2
+  data.tar.gz: f58a7d7c22ae8f8746f9aa9318dbf461511149d5f3881bc9e927020723a80359
 SHA512:
-  metadata.gz: 18157fc64bfcc1efb3db474d650b771a314a90b15838bfe5d222a21ab344c18a80bb848b41f5623e1391f30921b3ae058f4f3c40e0076f5a5b7af2e840b02993
-  data.tar.gz: 932ac02e3ebaac4ada45b08fe6353bcbf7bc84b66f87e44e4c35f799e0a881db35843f6c31dafa6f22fcf0631a6b3551c8ce25cacffde51f81eb5a5ee8c7c255
+  metadata.gz: cb815bca9f3cf08a3f6b2a474cdd9c15d8eb3b92c7478e595c86c62a510b52e55e1ef542a6121ca06fa4210239d6dfa4dcb50c26366e3e2adaffc639e6ef66e5
+  data.tar.gz: 36cb65b82c3ba399ef44a45c2f461f7b7cad09d857eadcb86265f7758370314637550ec1777db7a2c8ea8fa0a44e43d5ede2f4169600cd0bb31efe2531f27c16

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-08-15 11:59:49 -0400 using RuboCop version 0.58.2.
+# on 2019-07-28 16:26:13 -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
@@ -15,11 +15,6 @@ Layout/IndentHeredoc:
     - '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
@@ -83,4 +78,4 @@ Style/GuardClause:
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 119
+  Max: 123

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Changelog
 
+### 0.2.0 (2019/07/28)
+
+* [#16](https://github.com/dblock/danger-toc/pull/16): Deprecate `check` in favor of `check!` - [@dblock](https://github.com/dblock).
+* [#16](https://github.com/dblock/danger-toc/pull/16): Deprecate `configure`, configure directly on `toc` - [@dblock](https://github.com/dblock).
+
 ### 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).

data/Dangerfile

@@ -1,4 +1,4 @@
 # danger.systems
 
-changelog.check
-toc.check
+changelog.check!
+toc.check!

data/Gemfile

@@ -2,4 +2,15 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'danger-changelog', '~> 0.2.0'
+group :development, :test do
+  gem 'bundler'
+  gem 'danger-changelog', '~> 0.6.0'
+  gem 'guard', '~> 2.14'
+  gem 'guard-rspec', '~> 4.7'
+  gem 'listen'
+  gem 'pry'
+  gem 'rake', '~> 10.0'
+  gem 'rspec', '~> 3.4'
+  gem 'rubocop', '0.58.2'
+  gem 'yard'
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017 Daniel Doubrovkine <dblock@dblock.org>
+Copyright (c) 2017-2019 Daniel Doubrovkine <dblock@dblock.org>
 
 MIT License
 

data/README.md

@@ -9,11 +9,9 @@ A plugin for [danger.systems](http://danger.systems) that makes sure your projec
 
 - [Installation](#installation)
 - [Usage](#usage)
-  - [Configuration](#configuration)
-  - [Methods and Attributes](#methods-and-attributes)
-    - [toc.files](#tocfiles)
-    - [toc.header](#tocheader)
-    - [toc.check](#toccheck)
+  - [toc.files](#tocfiles)
+  - [toc.header](#tocheader)
+  - [toc.check!](#toccheck)
 - [Contributing](#contributing)
 - [Copyright](#copyright)
 
@@ -31,32 +29,27 @@ Add `toc.check` to your Dangerfile. Make a pull request and see this plugin in a
 
 ## Usage
 
-### Configuration
+Methods and settings from this plugin are available in your `Dangerfile` under the `toc` namespace.
 
-The plugin supports following configuration options:
+### toc.files
+
+List of files to ensure TOC in, default is `README.md`.
 
 ```ruby
-Danger::Toc.configure do |config|
-  config.files = [ 'README.md' ]
-  config.header = 'Table of Contents'
-end
+config.files = [ 'README.md', 'DEV.md' ]
 ```
 
-### Methods and Attributes
-
-Methods and attributes from this plugin are available in your `Dangerfile` under the `toc` namespace.
-
-#### toc.files
-
-List of files to ensure TOC in, default is `README.md`.
-
-#### toc.header
+### toc.header
 
 The Table of Contents header, without `#`, default is `Table of Contents`.
 
-#### toc.check
+```ruby
+config.header = 'Custom Table of Contents'
+```
+
+### toc.check!
 
-Run all checks with defaults.
+Run all checks.
 
 ## Contributing
 
@@ -64,6 +57,6 @@ See [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Copyright
 
-Copyright (c) Daniel Doubrovkine, 2017
+Copyright (c) Daniel Doubrovkine, 2017-2019
 
 MIT License, see [LICENSE](LICENSE.txt) for details.

data/danger-toc.gemspec

@@ -20,14 +20,4 @@ Gem::Specification.new do |spec|
   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'
-  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.58.2'
-  spec.add_development_dependency 'yard'
 end

data/lib/toc/config.rb

@@ -3,7 +3,16 @@ module Danger
     module Config
       extend self
 
-      attr_accessor :files, :header
+      ATTRIBUTES = %i[
+        files
+        header
+      ].freeze
+
+      ACCESSORS = ATTRIBUTES.map { |name| "#{name}=".to_sym }
+
+      DELEGATORS = ATTRIBUTES + ACCESSORS
+
+      attr_accessor(*Config::ATTRIBUTES)
       attr_writer :format
 
       # Files to process
@@ -35,6 +44,7 @@ module Danger
 
     class << self
       def configure
+        warn '[DEPRECATION] `configure` is deprecated. Please directly configure the Danger plugin via `toc.xyz=` instead.'
         block_given? ? yield(Config) : Config
       end
 

data/lib/toc/gem_version.rb

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

data/lib/toc/plugin.rb

@@ -3,42 +3,44 @@ module Danger
   #
   # @example Run all checks on the default README.md.
   #
-  #          toc.check
+  #          toc.check!
   #
-  # @example Customize filenames and remind the requester to update TOCs when necessary.
+  # @example Customize files and remind the requester to update TOCs when necessary.
   #
-  #          toc.filenames = ['README.md']
+  #          toc.files = ['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
+    extend Forwardable
 
-    def initialize(dangerfile)
-      @filenames = ['README.md']
-      super
+    def_delegators Danger::Toc.config, *Danger::Toc::Config::DELEGATORS
+
+    # Run all checks.
+    # @return [void]
+    def check!
+      is_toc_correct?
     end
 
     # Run all checks.
     # @return [void]
     def check
-      is_toc_correct?
+      warn '[DEPRECATION] `check` is deprecated. Please use `check!` instead.'
+      check!
     end
 
     # Has the README file been modified?
     # @return [boolean]
     def toc_changes?
-      (git.modified_files & filenames).any? || (git.added_files & filenames).any?
+      (git.modified_files & files).any? || (git.added_files & files).any?
     end
 
     # Is the TOC format correct?
     # @return [boolean]
     def is_toc_correct?
-      filenames.all? do |filename|
+      files.all? do |filename|
         toc_file = Danger::Toc::MarkdownFile.new(filename)
         if !toc_file.exists?
           messaging.fail("The #{filename} file does not exist.", sticky: false)

data/spec/config_spec.rb

@@ -14,9 +14,7 @@ describe Danger::Toc::Config do
       end
       context 'custom value' do
         before do
-          Danger::Toc.configure do |config|
-            config.files = ['README.md', 'SOMETHING.md']
-          end
+          Danger::Toc.config.files = ['README.md', 'SOMETHING.md']
         end
 
         it 'is set' do
@@ -32,9 +30,7 @@ describe Danger::Toc::Config do
       end
       context 'custom value' do
         before do
-          Danger::Toc.configure do |config|
-            config.header = 'Custom TOC'
-          end
+          Danger::Toc.config.header = 'Custom TOC'
         end
 
         it 'is set' do
@@ -52,9 +48,7 @@ describe Danger::Toc::Config do
 
       context 'custom value' do
         before do
-          Danger::Toc.configure do |config|
-            config.format = :kramdown
-          end
+          Danger::Toc.config.format = :kramdown
         end
 
         it 'is set' do

data/spec/toc_spec.rb

@@ -13,7 +13,7 @@ describe Danger::Toc do
     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]
+      dangerfile.toc.files = [filename]
       dangerfile.toc
     end
     let(:status_report) { toc.status_report }
@@ -108,9 +108,7 @@ Here's the expected TOC for #{filename}:
 
       context 'with a custom toc header' do
         before do
-          Danger::Toc.configure do |config|
-            config.header = 'Custom TOC'
-          end
+          Danger::Toc.config.header = 'Custom TOC'
         end
 
         context 'with missing TOC' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-toc
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - dblock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-15 00:00:00.000000000 Z
+date: 2019-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,132 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-- !ruby/object:Gem::Dependency
-  name: listen
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.58.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.58.2
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: A danger.systems plugin for your markdown TOC.
 email:
 - dblock@dblock.org
@@ -247,8 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A danger.systems plugin for your markdown TOC.