pronto-punchlist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e44ce72ea1916778cde6145c88eb5aca6678daec
+  data.tar.gz: f24deba1648c9440d8560ac5876626d4f0f02de7
+SHA512:
+  metadata.gz: 50067449b97dc9b36e1d22dadc948d077c46ac1ea78c69b8f094f95da672deed8c631fa526da4d31a7de4f387347e9b3eaf484ac663e1ad8969a4985c19abb59
+  data.tar.gz: 309d89d05ab6b0e3d1035633530833ef0acd7f83f55d0558b1822f72e220029f951952324d8874c0d89574b64e305b4af4987d8713b2c98fdcd283fa91933852

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/coverage/.resultset.json
+/coverage/.resultset.json.lock
+/coverage/assets/
+/coverage/index.html
+/pkg

data/.rubocop.yml

@@ -0,0 +1,73 @@
+# I like trailing commas in hashes.  They let me insert new elements and
+# see them as one line in a diff, not two.
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+# I use keyword arguments for a poor man's dependency injection to cut
+# down on the magic in my tests.
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+# If i'm using one function name and returning the contents of an
+# attribute, that's OK.  The alternative would be this, which I find
+# confusing and often not really what I mean:
+#
+# attr_reader :something_else
+# alias_method :something, :something_else
+Style/TrivialAccessors:
+   ExactNameMatch: true
+
+#
+# Add 'XX X' to the standard list
+#
+Style/CommentAnnotation:
+   Keywords:
+    - "TOD\
+       O"
+    - "FIXM\
+       E"
+    - "OPTIMIZ\
+       E"
+    - "HAC\
+       K"
+    - "REVIE\
+       W"
+    - "XX\
+       X"
+
+# https://stackoverflow.com/questions/40934345/rubocop-25-line-block-size-and-rspec-tests
+Metrics/BlockLength:
+  # Exclude DSLs
+  Exclude:
+    - 'Rakefile'
+    - '*.gemspec'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - 'feature/**/*.rb'
+
+# http://www.betterspecs.org/#single
+#
+# > in tests that are not isolated (e.g. ones that integrate with a
+# > DB, an external webservice, or end-to-end-tests), you take a
+# > massive performance hit to do the same setup over and over again,
+# > just to set a different expectation in each test. In these sorts
+# > of slower tests, I think it's fine to specify more than one
+# > isolated behavior.
+RSpec/MultipleExpectations:
+  Exclude:
+    - 'feature/**/*.rb'
+
+Style/StringLiterals:
+    EnforcedStyle: single_quotes
+    SupportedStyles:
+      - single_quotes
+      - double_quotes
+    ConsistentQuotesInMultiline: true
+
+AllCops:
+  TargetRubyVersion: 2.4
+
+require: rubocop-rspec

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.9

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+before_install:
+  # https://bundler.io/blog/2019/05/14/
+  #   solutions-for-cant-find-gem-bundler-with-executable-bundle.html
+  - gem update --system
+  - gem install bundler
+rvm:
+  - ruby-2.4
+  - ruby-2.5
+  - ruby-2.6
+  - ruby-2.7
+
+  # deprecation warnings blocking quality output counts
+  # https://travis-ci.com/apiology/pronto-punchlist/jobs/264907930
+  # - ruby-2.7.0-preview3
+
+  # JRuby error with native code build - possibly can be overcome?
+  # checking for main() in -lstdc++... RuntimeError: The compiler failed to generate
+  # https://travis-ci.com/apiology/pronto-punchlist/jobs/264907931
+  # - jruby-head
+
+  # deprecation warnings blocking quality output counts
+  # https://travis-ci.com/apiology/pronto-punchlist/jobs/264907932
+  # - ruby-head

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual
+  attention or advances
+* Trolling, insulting/derogatory comments, and personal or political
+  attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at vince.broz@bluelabs.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pronto-punchlist.gemspec
+gemspec
+
+gem 'source_finder'
+
+# gem 'punchlist', path: '/Users/broz/src/punchlist'

data/Gemfile.lock

@@ -0,0 +1,221 @@
+PATH
+  remote: .
+  specs:
+    pronto-punchlist (0.1.0)
+      pronto
+      punchlist (>= 1.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    bigfiles (0.1.3)
+      source_finder (>= 2)
+    brakeman (4.7.2)
+    bundler-audit (0.6.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 0.18)
+    cane (3.0.0)
+      parallel
+    charlock_holmes (0.7.7)
+    code_analyzer (0.4.8)
+      sexp_processor
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.1.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    equalizer (0.0.11)
+    erubis (2.7.0)
+    escape_utils (1.2.1)
+    faraday (0.17.1)
+      multipart-post (>= 1.2, < 3)
+    flay (2.12.1)
+      erubis (~> 2.7.0)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.6.4)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.8)
+    github-linguist (7.7.0)
+      charlock_holmes (~> 0.7.6)
+      escape_utils (~> 1.2.0)
+      mini_mime (~> 1.0)
+      rugged (>= 0.25.1)
+    gitlab (4.13.1)
+      httparty (~> 0.14, >= 0.14.0)
+      terminal-table (~> 1.5, >= 1.5.1)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    httparty (0.17.3)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.4)
+    json (2.3.0)
+    kramdown (2.1.0)
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    kwalify (0.7.2)
+    mdl (0.8.0)
+      kramdown (~> 2.0)
+      kramdown-parser-gfm (~> 1.0)
+      mixlib-cli (~> 2.1, >= 2.1.1)
+      mixlib-config (>= 2.2.1, < 4)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    mini_mime (1.0.2)
+    minitest (5.13.0)
+    mixlib-cli (2.1.5)
+    mixlib-config (3.0.5)
+      tomlrb
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    netrc (0.11.0)
+    octokit (4.14.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    parallel (1.19.1)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    path_expander (1.1.0)
+    pronto (0.10.0)
+      gitlab (~> 4.0, >= 4.0.0)
+      httparty (>= 0.13.7)
+      octokit (~> 4.7, >= 4.7.0)
+      rainbow (>= 2.2, < 4.0)
+      rugged (~> 0.24, >= 0.23.0)
+      thor (~> 0.20.0)
+    psych (3.1.0)
+    public_suffix (4.0.1)
+    punchlist (1.3.0)
+      source_finder (>= 2)
+    quality (36.0.0)
+      activesupport
+      bigfiles (>= 0.1)
+      brakeman
+      bundler-audit
+      cane (>= 2.6)
+      flay (>= 2.4, != 2.6.0)
+      flog (>= 4.1.1)
+      github-linguist
+      json
+      mdl
+      punchlist (>= 1.1)
+      rails_best_practices
+      reek (>= 1.3.4)
+      rest-client (>= 1.8.0)
+      rubocop (~> 0.78.0)
+      rubocop-rspec (>= 1.19.0)
+      ruby_parser (>= 3.2.2, != 3.6.6)
+    rails_best_practices (1.19.4)
+      activesupport
+      code_analyzer (>= 0.4.8)
+      erubis
+      i18n
+      json
+      require_all (~> 2.0)
+      ruby-progressbar
+    rainbow (3.0.0)
+    rake (10.5.0)
+    reek (5.5.0)
+      codeclimate-engine-rb (~> 0.4.0)
+      kwalify (~> 0.7.0)
+      parser (>= 2.5.0.0, < 2.7, != 2.5.1.1)
+      psych (~> 3.1.0)
+      rainbow (>= 2.0, < 4.0)
+    require_all (2.0.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.78.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.37.1)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    ruby_parser (3.14.1)
+      sexp_processor (~> 4.9)
+    rugged (0.28.4.1)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    sexp_processor (4.13.0)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    source_finder (3.2.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tomlrb (1.2.9)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+    unicode-display_width (1.6.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  pronto-punchlist!
+  quality (~> 36)
+  rake (~> 10.0)
+  rspec
+  simplecov
+  source_finder
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Vince Broz
+
+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/Makefile

@@ -0,0 +1,13 @@
+.PHONY: spec feature
+
+all:
+	@bundle exec rake localtest
+
+feature:
+	@bundle exec rake feature
+
+spec:
+	@bundle exec rake spec
+
+rubocop:
+	@bundle exec rake rubocop

data/README.md

@@ -0,0 +1,66 @@
+# Pronto::Punchlist
+
+[![Build Status](https://travis-ci.org/apiology/pronto-punchlist.svg?branch=master)](https://travis-ci.org/apiology/pronto-punchlist)
+
+Performs incremental quality reporting for the punchlist gem.
+Punchlist reports on any 'TOD O'-style comments in code; this gem plugs
+in with the 'pronto' gem, which does incremental reporting using a
+variety of quality tools.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pronto-punchlist'
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+Or install it yourself as:
+
+```sh
+gem install pronto-punchlist
+```
+
+## Usage
+
+This is typically used either as part a custom
+[pronto](https://github.com/prontolabs/pronto) rigging, sometimes as
+part of general use of the
+[quality](https://github.com/apiology/quality) gem.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install
+dependencies. You can also run `bin/console` for an interactive prompt
+that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake
+install`. To release a new version, update the version number in
+`version.rb`, and then run `bundle exec rake release`, which will
+create a git tag for the version, push git commits and tags, and push
+the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on
+[GitHub](https://github.com/apiology/pronto-punchlist). This project
+is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Pronto::Punchlist project’s codebases,
+issue trackers, chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/[USERNAME]/pronto-punchlist/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+desc 'Default: Run specs and check quality.'
+task default: [:localtest]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'pronto/punchlist'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/coverage/.last_run.json

@@ -0,0 +1,5 @@
+{
+  "result": {
+    "covered_percent": 100.0
+  }
+}

data/feature/feature_helper.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+# Add the bin directory, to allow testing of gem executables as if the gem is
+# already installed.
+root_dir = RSpec::Core::RubyProject.root
+exec_dir = File.join(File::SEPARATOR, root_dir, 'bin')
+ENV['PATH'] = [exec_dir, ENV['PATH']].join(File::PATH_SEPARATOR)
+
+# Courtesy of:
+# https://raw.github.com/cupakromer/tao-of-tdd/master/adder/spec/support/
+#    capture_exec.rb
+def exec_io(*cmd)
+  cmd = cmd.flatten
+  env = {
+    # Avoid spurious deprecation warnings in things which are out of
+    # our control
+    'RUBYOPT' => '-W0',
+  }
+  all_out, _exit_code = Open3.capture2e(env, *cmd)
+
+  all_out
+end
+
+RSpec.configure do |config|
+  config.filter_run_excluding :wip
+  config.run_all_when_everything_filtered = true
+  config.order = 'random'
+  config.alias_it_should_behave_like_to :has_behavior
+  config.alias_it_should_behave_like_to :it_has_behavior, 'has behavior:'
+end
+
+def let_double(*doubles)
+  doubles.each do |double_sym|
+    let(double_sym) { double(double_sym.to_s) }
+  end
+end

data/feature/pronto/punchlist_cli_spec.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative '../feature_helper'
+require 'pronto/punchlist'
+require 'tmpdir'
+
+describe Pronto::Punchlist do
+  let(:env) do
+    {
+      # Avoid spurious deprecation warnings in things which are out of
+      # our control
+      'RUBYOPT' => '-W0',
+    }
+  end
+
+  describe 'bundle exec pronto list' do
+    let(:expected_output) do
+      <<~OUTPUT
+        punchlist
+      OUTPUT
+    end
+
+    it 'lists this as a runner' do
+      out, exit_code = Open3.capture2e(env, 'bundle exec pronto list')
+      expect(out).to eq(expected_output)
+      expect(exit_code).to eq(0)
+    end
+  end
+
+  describe 'bundle exec pronto run --staged -r punchlist -f text' do
+    let(:pronto_command) do
+      'bundle exec pronto run --staged -r punchlist -f text'
+    end
+
+    around do |example|
+      Dir.mktmpdir do |dir|
+        Dir.chdir(dir) do
+          system('git init')
+          File.write('README.md', 'Initial commit contents')
+          system('git add .')
+          system('git commit -m "First commit"')
+          example_files.each do |filename, contents|
+            File.write(filename, contents)
+          end
+          system('git add .')
+          example.run
+        end
+      end
+    end
+
+    context 'with no annotation comments' do
+      let(:example_files) do
+        {
+          'boring.rb' => 'puts "hello world"',
+        }
+      end
+      let(:expected_output) { '' }
+
+      it 'runs and finds no files' do
+        out, exit_code = Open3.capture2e(env, pronto_command)
+        expect(out).to eq(expected_output)
+        expect(exit_code).to eq(0)
+      end
+    end
+
+    context 'with annotation comments' do
+      let(:example_files) do
+        {
+          'more_interesting.rb' =>
+          "puts 'hello world'\n# TOD" \
+          "O: Write more code",
+        }
+      end
+
+      let(:expected_output) do
+        "more_interesting.rb:2 W: " \
+        "Uncompleted punchlist item detected--consider resolving or " \
+        "moving this to your issue tracker\n"
+      end
+
+      it 'runs and finds files to run' do
+        out, exit_code = Open3.capture2e(env, pronto_command)
+        expect(out).to end_with(expected_output)
+        expect(exit_code).to eq(0)
+      end
+    end
+  end
+end

data/lib/pronto/punchlist.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'pronto/punchlist/version'
+require 'pronto/punchlist/patch_inspector'
+require 'pronto/punchlist/driver'
+require 'pronto/punchlist/patch_validator'
+require 'pronto'
+
+module Pronto
+  # Performs incremental quality reporting for the punchlist gem
+  class Punchlist < Runner
+    def initialize(patches, commit = nil,
+                   regexp_string: ::Punchlist::Config
+                     .default_punchlist_line_regexp_string,
+                   punchlist_regexp: Regexp.new(regexp_string),
+                   punchlist_driver: PunchlistDriver.new(punchlist_regexp),
+                   patch_inspector: PatchInspector.new(punchlist_driver:
+                                                         punchlist_driver),
+                   patch_validator: PatchValidator.new)
+      super(patches, commit)
+      @patch_inspector = patch_inspector
+      @patch_validator = patch_validator
+    end
+
+    class Error < StandardError; end
+    def run
+      @patches.flat_map { |patch| inspect_patch(patch) }
+    end
+
+    def valid_patch?(patch)
+      @patch_validator.valid_patch?(patch)
+    end
+
+    def inspect_patch(patch)
+      if valid_patch?(patch)
+        @patch_inspector.inspect_patch(patch)
+      else
+        []
+      end
+    end
+  end
+end

data/lib/pronto/punchlist/driver.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'pronto'
+require 'punchlist'
+
+module Pronto
+  class Punchlist < Runner
+    # Adapts the Punchlist gem for use
+    class PunchlistDriver
+      def initialize(punchlist_line_regexp,
+                     inspector_class: ::Punchlist::Inspector)
+        @punchlist_line_regexp = punchlist_line_regexp
+        @inspector_class = inspector_class
+      end
+
+      def inspect_filename(path)
+        @inspector_class.new(@punchlist_line_regexp, path).run
+      end
+    end
+  end
+end

data/lib/pronto/punchlist/file_classifier.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Pronto
+  class Punchlist < Runner
+    # Classify whether files are relevant to punchlist
+    class FileClassifier
+      def initialize(source_file_globber: SourceFinder::SourceFileGlobber.new)
+        @source_file_globber = source_file_globber
+      end
+
+      def non_binary?(path)
+        # https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch
+        # EXTGLOB enables ',' as part of glob language
+        File.fnmatch?(@source_file_globber.source_and_doc_files_glob,
+                      path,
+                      File::FNM_EXTGLOB)
+      end
+    end
+  end
+end

data/lib/pronto/punchlist/message_creator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'pronto'
+
+module Pronto
+  class Punchlist < Runner
+    # Creates Pronto messages
+    class MessageCreator
+      MESSAGE = 'Uncompleted punchlist item detected--' \
+                'consider resolving or moving this to ' \
+                'your issue tracker'
+
+      def create(path, line)
+        Message.new(path, line, :warning, MESSAGE, nil, Pronto::Punchlist)
+      end
+    end
+  end
+end

data/lib/pronto/punchlist/offense_matcher.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'pronto'
+require_relative 'message_creator'
+
+module Pronto
+  class Punchlist < Runner
+    # Matches up the given offense with potentially matching lines
+    class OffenseMatcher
+      def initialize(offense,
+                     message_creator: ::Pronto::Punchlist::MessageCreator.new)
+        @offense = offense
+        @message_creator = message_creator
+      end
+
+      def inspect_patch(patch)
+        patch.added_lines.each do |line|
+          message = inspect_line(line)
+          return message unless message.nil?
+        end
+        nil
+      end
+
+      def inspect_line(line)
+        return nil unless line.new_lineno == @offense.line_num
+
+        @message_creator.create(@offense.filename, line)
+      end
+    end
+  end
+end

data/lib/pronto/punchlist/patch_inspector.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'pronto'
+require_relative 'offense_matcher'
+
+module Pronto
+  class Punchlist < Runner
+    # Inspects a patch and reports any relevant offenses
+    class PatchInspector
+      def initialize(punchlist_driver:,
+                     offense_matcher_class: OffenseMatcher)
+        @punchlist_driver = punchlist_driver
+        @offense_matcher_class = offense_matcher_class
+      end
+
+      def inspect_patch(patch)
+        path = patch.new_file_full_path
+
+        offenses = @punchlist_driver.inspect_filename(path)
+
+        messages = []
+        offenses.each do |offense|
+          offense_matcher = @offense_matcher_class.new(offense)
+          message = offense_matcher.inspect_patch(patch)
+          messages << message unless message.nil?
+        end
+        messages
+      end
+    end
+  end
+end

data/lib/pronto/punchlist/patch_validator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'pronto'
+require_relative 'file_classifier'
+
+module Pronto
+  class Punchlist < Runner
+    # Determine if a patch contains analyzable files
+    class PatchValidator
+      def initialize(file_classifier: FileClassifier.new)
+        @file_classifier = file_classifier
+      end
+
+      def valid_patch?(patch)
+        return false if patch.additions < 1
+
+        path = patch.new_file_full_path
+
+        @file_classifier.non_binary?(path)
+      end
+    end
+  end
+end

data/lib/pronto/punchlist/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pronto
+  module PunchlistVersion
+    VERSION = '0.1.0'
+  end
+end

data/metrics/bigfiles_high_water_mark

@@ -0,0 +1 @@
+300

data/metrics/brakeman_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/bundle-audit_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/cane_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/eslint_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/flake8_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/flay_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/flog_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/jscs_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/mdl_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/punchlist_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/pycodestyle_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/rails_best_practices_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/rubocop_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/scalastyle_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/shellcheck_high_water_mark

@@ -0,0 +1 @@
+0

data/pronto-punchlist.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pronto/punchlist/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pronto-punchlist'
+  spec.version       = Pronto::PunchlistVersion::VERSION
+  spec.authors       = ['Vince Broz']
+  spec.email         = ['vince@broz.cc']
+
+  spec.summary       = 'Pronto plugin for the punchlist gem'
+  spec.description   = <<~DESCRIPTION
+    Performs incremental quality reporting for the punchlist gem.
+    Punchlist reports on comments in code indicating short-term work
+    hasn't been done; this gem plugs in with the 'pronto' gem, which does
+    incremental reporting using a variety of quality tools}
+  DESCRIPTION
+  spec.homepage      = 'https://github.com/apiology/pronto-punchlist'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] =
+    'https://github.com/apiology/pronto-punchlist'
+
+  # Specify which files should be added to the gem when it is
+  # released.  The `git ls-files -z` loads the files in the RubyGem
+  # that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'pronto'
+  # Punchlist internals were refactored in version 1.3.0 and a
+  # reasonable API exposed:
+  spec.add_dependency 'punchlist', '>= 1.3.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'quality', '~> 36'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+end

data/rakelib/ci.rake

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+task ci: :localtest

data/rakelib/clear_metrics.rake

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+task :clear_metrics do |_t|
+  ret =
+    system('git checkout coverage/.last_run.json metrics/*_high_water_mark')
+  raise unless ret
+end

data/rakelib/default.rake

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+task default: :localtest

data/rakelib/feature.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rspec/core/rake_task'
+
+desc 'Run features'
+RSpec::Core::RakeTask.new(:feature) do |task|
+  task.pattern = 'feature/**/*_spec.rb'
+  task.rspec_opts = '--format doc'
+end

data/rakelib/localtest.rake

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+task localtest: %i[clear_metrics spec feature quality]

data/rakelib/quality.rake

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'quality/rake/task'
+
+Quality::Rake::Task.new do |task|
+  task.exclude_files = ['Gemfile.lock']
+  task.skip_tools = %w[reek cane]
+  task.output_dir = 'metrics'
+  task.punchlist_regexp = 'XX' \
+                          'X|TOD' \
+                          'O|FIXM' \
+                          'E|OPTIMIZ' \
+                          'E|HAC' \
+                          'K|REVIE' \
+                          'W|LATE' \
+                          'R|FIXI' \
+                          'T|xi' \
+                          't '
+end

data/rakelib/spec.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+  task.rspec_opts = '--format doc'
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: pronto-punchlist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vince Broz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: punchlist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: quality
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '36'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '36'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: |
+  Performs incremental quality reporting for the punchlist gem.
+  Punchlist reports on comments in code indicating short-term work
+  hasn't been done; this gem plugs in with the 'pronto' gem, which does
+  incremental reporting using a variety of quality tools}
+email:
+- vince@broz.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- coverage/.last_run.json
+- feature/feature_helper.rb
+- feature/pronto/punchlist_cli_spec.rb
+- lib/pronto/punchlist.rb
+- lib/pronto/punchlist/driver.rb
+- lib/pronto/punchlist/file_classifier.rb
+- lib/pronto/punchlist/message_creator.rb
+- lib/pronto/punchlist/offense_matcher.rb
+- lib/pronto/punchlist/patch_inspector.rb
+- lib/pronto/punchlist/patch_validator.rb
+- lib/pronto/punchlist/version.rb
+- metrics/bigfiles_high_water_mark
+- metrics/brakeman_high_water_mark
+- metrics/bundle-audit_high_water_mark
+- metrics/cane_high_water_mark
+- metrics/eslint_high_water_mark
+- metrics/flake8_high_water_mark
+- metrics/flay_high_water_mark
+- metrics/flog_high_water_mark
+- metrics/jscs_high_water_mark
+- metrics/mdl_high_water_mark
+- metrics/punchlist_high_water_mark
+- metrics/pycodestyle_high_water_mark
+- metrics/rails_best_practices_high_water_mark
+- metrics/rubocop_high_water_mark
+- metrics/scalastyle_high_water_mark
+- metrics/shellcheck_high_water_mark
+- pronto-punchlist.gemspec
+- rakelib/ci.rake
+- rakelib/clear_metrics.rake
+- rakelib/default.rake
+- rakelib/feature.rake
+- rakelib/localtest.rake
+- rakelib/quality.rake
+- rakelib/spec.rake
+homepage: https://github.com/apiology/pronto-punchlist
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/apiology/pronto-punchlist
+  source_code_uri: https://github.com/apiology/pronto-punchlist
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.4
+signing_key: 
+specification_version: 4
+summary: Pronto plugin for the punchlist gem
+test_files: []