danger-toc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38ae0d61092888976e59f8da7acb132be0cd0284
+  data.tar.gz: cfd1e2d33f51048d8565908142ffbd35d7fe4803
+SHA512:
+  metadata.gz: ae85c1148f5440b7fc2bcb4843118ef32944688e38a5391478130bd325a038fdacea55467ddd2bc14218d314a2be042ca6b334e08d92aea64b82f6cd6585f909
+  data.tar.gz: 38b99caf0a4a221a698e918c513b614a882e2c5268eaa9323d1552c2324468ff85368135cfa870d1cc83c053d19481ea5f9be18a0c372a3920a5a9936480d35d

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+pkg
+.idea/
+Gemfile.lock
+.yardoc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=documentation

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  Include:
+    - Rakefile
+  Exclude:
+    - vendor/**/*
+
+Metrics/BlockLength:
+  Enabled: fale
+
+Metrics/LineLength:
+  Enabled: fale
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,92 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-11-05 10:44:59 -0500 using RuboCop version 0.51.0.
+# 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
+
+# Offense count: 5
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 69
+
+# Offense count: 20
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 119
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+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:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/toc/config.rb'
+    - 'lib/toc/constructor.rb'
+    - 'lib/toc/extractor.rb'
+    - 'lib/toc/markdown_file.rb'
+    - 'lib/toc/plugin.rb'
+
+# Offense count: 3
+Style/DoubleNegation:
+  Exclude:
+    - 'lib/toc/markdown_file.rb'
+
+# 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'

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.4.1
+
+before_script:
+    - bundle exec danger
+
+script:
+    - bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## Changelog
+
+### 0.1.0 (2017/11/5)
+
+* Initial public release - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to Danger-Toc
+
+This project is work of [many contributors](https://github.com/dblock/danger-toc/graphs/contributors).
+
+You're encouraged to submit [pull requests](https://github.com/dblock/danger-toc/pulls), [propose features and discuss issues](https://github.com/dblock/danger-toc/issues).
+
+In the examples below, substitute your Github username for `contributor` in URLs.
+
+### Fork the Project
+
+Fork the [project on Github](https://github.com/dblock/danger-toc) and check out your copy.
+
+```
+git clone https://github.com/contributor/danger-toc.git
+cd danger-toc
+git remote add upstream https://github.com/dblock/danger-toc.git
+```
+
+### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+## Contribute Code
+
+### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add tests to [spec](spec).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+### Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ingored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
+
+Make sure that `bundle exec rake` completes without errors.
+
+### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+### Update Toc
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Don't remove *Your contribution here*.
+
+Make it look like every other line, including a link to the issue being fixed, your name and link to your Github account.
+
+### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+### Push
+
+```
+git push origin my-feature-branch
+```
+
+### Make a Pull Request
+
+Go to https://github.com/contributor/danger-toc and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/dblock/danger-toc/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+## Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Dangerfile

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'danger-changelog', '~> 0.2.0'

data/Guardfile

@@ -0,0 +1,19 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Daniel Doubrovkine <dblock@dblock.org>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# danger-toc
+
+A plugin for [danger.systems](http://danger.systems) that makes sure your project’s `README.md` has a TOC.
+
+[![Gem Version](https://badge.fury.io/rb/danger-toc.svg)](https://badge.fury.io/rb/danger-toc)
+[![Build Status](https://travis-ci.org/dblock/danger-toc.svg?branch=master)](https://travis-ci.org/dblock/danger-toc)
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Configuration](#configuration)
+  - [Methods and Attributes](#methods-and-attributes)
+    - [toc.files](#tocfiles)
+    - [toc.check](#toccheck)
+- [Contributing](#contributing)
+- [Copyright](#copyright)
+
+## Installation
+
+Add `danger-toc` to your Gemfile.
+
+```
+gem 'danger-toc', '~> 0.1'
+```
+
+Add `toc.check` to your Dangerfile. Make a pull request and see this plugin in action.
+
+<img src='images/toc-missing.png'>
+
+## Usage
+
+### Configuration
+
+The plugin supports following configuration options:
+
+You can configure plugin using following code:
+```ruby
+Danger::Toc.configure do |config|
+  config.files = [ 'README.md' ]
+end
+```
+
+### 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.
+
+#### toc.check
+
+Run all checks with defaults.
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+## Copyright
+
+Copyright (c) Daniel Doubrovkine, 2017
+
+MIT License, see [LICENSE](LICENSE.txt) for details.

data/RELEASING.md

@@ -0,0 +1,67 @@
+# Releasing Danger-Toc
+
+There're no hard rules about when to release danger-toc. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Install bundle, run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/dblock/danger-toc) for all supported platforms.
+
+Increment the version, modify [lib/toc/gem_version.rb](lib/toc/gem_version.rb).
+
+Following the [Semantic Versioning](http://semver.org/):
+*  Increment the third number if the release has bug fixes and/or very minor features with backward compatibility, only (eg. change `0.2.1` to `0.2.2`).
+*  Increment the second number if the release contains major features or breaking API changes (eg. change `0.2.1` to `0.3.0`).
+
+Create a new version and mark it as Next in [CHANGELOG.md](CHANGELOG.md).
+
+```
+### 0.2.2 (12/03/2016)
+```
+
+Remove the line with "* Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/toc/gem_version.rb
+git commit -m "Preparing for release 0.2.2."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+danger-toc 0.2.2 built to pkg/danger-toc-0.2.2.gem.
+Tagged v0.2.2.
+Pushed git commits and tags.
+Pushed danger-toc 0.2.2 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+### 0.2.3 (Next)
+
+* Your contribution here.
+```
+
+Increment the third version number in [lib/toc/gem_version.rb](lib/toc/gem_version.rb).
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/slack/version.rb
+git commit -m "Preparing for next development iteration, 0.2.3."
+git push origin master
+```