punchlist 1.3.0 → 1.3.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/CONTRIBUTING.rst

@@ -0,0 +1,75 @@
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/apiology/punchlist/issues
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+and "help wanted" is open to whoever wants to implement a fix for it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+If you have a new feature in mind, please start it by filing an issue
+so we can discuss the need and approach before you invest time into
+coding it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+Punchlist could always use more documentation, whether as part of
+the official Punchlist docs, in docstrings, or even on the web in blog posts, articles,
+and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at
+https://github.com/apiology/punchlist/issues.
+
+If you are proposing a new feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute?  See DEVELOPMENT.md in this directory for details
+on how to set yourself up for local development.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+
+2. If the pull request adds functionality, the docs should be updated. Put your
+   new functionality into a function with a docstring, and add the feature to
+   the list in README.md.

data/ChangeLog.md

@@ -0,0 +1,8 @@
+## Changes since Punchlist 0.0.1
+
+# Fix extra newlines in output
+
+## Changes since Punchlist 0.0.1
+
+# Add --regexp argument
+

data/DEVELOPMENT.md

@@ -0,0 +1,31 @@
+# Development
+
+## fix.sh
+
+If you want to use rbenv/pyenv/etc to manage versions of tools,
+there's a `fix.sh` script which may be what you'd like to install
+dependencies.
+
+## Overcommit
+
+This project uses [overcommit](https://github.com/sds/overcommit) for
+quality checks.  `bundle exec overcommit --install` will install it.
+
+## direnv
+
+This project uses direnv to manage environment variables used during
+development.  See the `.envrc` file for detail.
+
+## Publishing
+
+To publish new version as a maintainer:
+
+```sh
+git checkout main && git pull
+git log "v$(bump current)..."
+# Set type_of_bump to patch, minor, or major
+bump --tag --tag-prefix=v ${type_of_bump:?}
+rake release
+git push
+git push --tags
+```

data/Gemfile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in punchlist.gemspec
+gemspec
+
+gem 'bump'
+gem 'bundler'
+gem 'fakeweb'
+gem 'mdl'
+gem 'overcommit', ['>=0.61.0', '<0.62.0']
+gem 'pry'
+gem 'rake', '~> 13.0'
+gem 'rspec', '>=3.4'
+gem 'rubocop', ['~> 1.52']
+gem 'rubocop-rake'
+# ensure version with RSpec/VerifiedDoubleReference
+gem 'rubocop-rspec', ['>=2.10.0']
+# ensure version with branch coverage
+gem 'simplecov', ['>=0.18.0']
+gem 'simplecov-lcov'
+gem 'solargraph', ['>=0.50.0']
+gem 'undercover'
+gem 'webmock'
+gem 'yard'

data/Gemfile.lock

@@ -0,0 +1,186 @@
+PATH
+  remote: .
+  specs:
+    punchlist (1.3.1)
+      source_finder (>= 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.3.0)
+    bigdecimal (3.1.8)
+    bump (0.10.0)
+    chef-utils (18.5.0)
+      concurrent-ruby
+    childprocess (4.1.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.4)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.1)
+    docile (1.4.1)
+    e2mmap (0.1.0)
+    fakeweb (1.3.0)
+    hashdiff (1.1.1)
+    imagen (0.2.0)
+      parser (>= 2.5, != 2.5.1.1)
+    iniparse (1.5.0)
+    jaro_winkler (1.6.0)
+    json (2.7.2)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    language_server-protocol (3.17.0.3)
+    mdl (0.13.0)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      mixlib-cli (~> 2.1, >= 2.1.1)
+      mixlib-config (>= 2.2.1, < 4)
+      mixlib-shellout
+    method_source (1.1.0)
+    mixlib-cli (2.1.8)
+    mixlib-config (3.0.27)
+      tomlrb
+    mixlib-shellout (3.2.8)
+      chef-utils
+    nokogiri (1.16.7-aarch64-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-arm-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86_64-linux)
+      racc (~> 1.4)
+    overcommit (0.61.0)
+      childprocess (>= 0.6.3, < 5)
+      iniparse (~> 1.4)
+      rexml (~> 3.2)
+    parallel (1.26.3)
+    parser (3.3.5.0)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rbs (2.8.4)
+    regexp_parser (2.9.2)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.3.8)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.1)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.66.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.32.3)
+      parser (>= 3.3.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (3.1.0)
+      rubocop (~> 1.61)
+    ruby-progressbar (1.13.0)
+    rugged (1.7.2)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov-lcov (0.8.0)
+    simplecov_json_formatter (0.1.4)
+    solargraph (0.50.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (~> 2.0)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      rbs (~> 2.0)
+      reverse_markdown (~> 2.0)
+      rubocop (~> 1.38)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    source_finder (3.2.1)
+    thor (1.3.2)
+    tilt (2.4.0)
+    tomlrb (2.0.3)
+    undercover (0.5.0)
+      bigdecimal
+      imagen (>= 0.1.8)
+      rainbow (>= 2.1, < 4.0)
+      rugged (>= 0.27, < 1.8)
+    unicode-display_width (2.6.0)
+    webmock (3.24.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.37)
+
+PLATFORMS
+  aarch64-linux
+  arm-linux
+  arm64-darwin
+  arm64-darwin-23
+  x86-linux
+  x86_64-darwin
+  x86_64-darwin-23
+  x86_64-linux
+  x86_64-linux-musl
+
+DEPENDENCIES
+  bump
+  bundler
+  fakeweb
+  mdl
+  overcommit (>= 0.61.0, < 0.62.0)
+  pry
+  punchlist!
+  rake (~> 13.0)
+  rspec (>= 3.4)
+  rubocop (~> 1.52)
+  rubocop-rake
+  rubocop-rspec (>= 2.10.0)
+  simplecov (>= 0.18.0)
+  simplecov-lcov
+  solargraph (>= 0.50.0)
+  undercover
+  webmock
+  yard
+
+BUNDLED WITH
+   2.3.27

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024, 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,104 @@
+.PHONY: clean clean-typecheck feature help localtest quality repl rubocop spec test
+.DEFAULT_GOAL := default
+
+define PRINT_HELP_PYSCRIPT
+import re, sys
+
+for line in sys.stdin:
+	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
+	if match:
+		target, help = match.groups()
+		print("%-20s %s" % (target, help))
+endef
+export PRINT_HELP_PYSCRIPT
+
+help:
+	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
+
+default: clean-coverage test coverage clean-typecoverage typecheck typecoverage quality ## run default typechecking, tests and quality
+
+clean-typecheck: ## Refresh information that type checking depends on
+	bundle install
+	bundle exec solargraph clear
+	rm -fr .yardoc/
+	bundle exec yard gems
+	bundle exec solargraph scan
+	echo all clear
+
+typecheck: ## validate types in code and configuration
+
+citypecheck: typecheck ## Run type check from CircleCI
+
+typecoverage: typecheck ## Run type checking and then ratchet coverage in metrics/
+
+clean-typecoverage: ## Clean out type-related coverage previous results to avoid flaky results
+
+citypecoverage: typecoverage ## Run type checking, ratchet coverage, and then complain if ratchet needs to be committed
+
+requirements_dev.txt.installed: requirements_dev.txt
+	pip install -q --disable-pip-version-check -r requirements_dev.txt
+	touch requirements_dev.txt.installed
+
+pip_install: requirements_dev.txt.installed ## Install Python dependencies
+
+# bundle install doesn't get run here so that we can catch it below in
+# fresh-checkout and fresh-rbenv cases
+Gemfile.lock: Gemfile
+
+# Ensure any Gemfile.lock changes ensure a bundle is installed.
+Gemfile.lock.installed: Gemfile.lock
+	bundle install
+	touch Gemfile.lock.installed
+
+bundle_install: Gemfile.lock.installed ## Install Ruby dependencies
+
+clear_metrics: ## remove or reset result artifacts created by tests and quality tools
+	bundle exec rake clear_metrics
+
+clean: clear_metrics ## remove all built artifacts
+
+test: spec ## run tests quickly
+
+citest: test ## Run unit tests from CircleCI
+
+overcommit: ## run precommit quality checks
+	bundle exec overcommit --run
+
+quality: overcommit ## run precommit quality checks
+
+spec: ## Run lower-level tests
+	@bundle exec rake spec
+
+feature: ## Run higher-level tests
+	@bundle exec rake feature
+
+localtest: ## run default local actions
+	@bundle exec rake localtest
+
+repl:  ## Load up punchlist in pry
+	@bundle exec rake repl
+
+clean-coverage:
+	@bundle exec rake clear_metrics
+
+coverage: test report-coverage ## check code coverage
+	@bundle exec rake undercover
+
+report-coverage: test ## Report summary of coverage to stdout, and generate HTML, XML coverage report
+
+cicoverage: coverage ## check code coverage
+
+update_from_cookiecutter: ## Bring in changes from template project used to create this repo
+	bundle exec overcommit --uninstall
+	cookiecutter_project_upgrader --help >/dev/null
+	IN_COOKIECUTTER_PROJECT_UPGRADER=1 cookiecutter_project_upgrader || true
+	git checkout cookiecutter-template && git push && git checkout main
+	git checkout main && git pull && git checkout -b update-from-cookiecutter-$$(date +%Y-%m-%d-%H%M)
+	git merge cookiecutter-template || true
+	bundle exec overcommit --install
+	@echo
+	@echo "Please resolve any merge conflicts below and push up a PR with:"
+	@echo
+	@echo '   gh pr create --title "Update from cookiecutter" --body "Automated PR to update from cookiecutter boilerplate"'
+	@echo
+	@echo

data/README.md

@@ -0,0 +1,27 @@
+# Punchlist
+
+[![CircleCI](https://circleci.com/gh/apiology/punchlist.svg?style=svg)](https://circleci.com/gh/apiology/punchlist)
+
+Counts the number of 'todo' comments in your code ('Comment
+annotations').  Use in combination with the 'quality' gem in your CI
+to keep the number of these 'punchlist' items under control.
+
+https://github.com/apiology/quality
+
+To test quality:
+  rake localtest
+
+To run tests alone:
+  rake spec
+
+## Contributions
+
+This project, as with all others, rests on the shoulders of a broad
+ecosystem supported by many volunteers doing thankless work, along
+with specific contributors.
+
+In particular I'd like to call out:
+
+* [Audrey Roy Greenfeld](https://github.com/audreyfeldroy) for the
+  cookiecutter tool and associated examples, which keep my many
+  projects building with shared boilerplate with a minimum of fuss.

data/Rakefile

@@ -1,51 +1,4 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'quality/rake/task'
-
-task :pronto do
-  formatter = '-f github_pr' if ENV.key? 'PRONTO_GITHUB_ACCESS_TOKEN'
-  if ENV.key? 'TRAVIS_PULL_REQUEST'
-    ENV['PRONTO_PULL_REQUEST_ID'] = ENV['TRAVIS_PULL_REQUEST']
-  elsif ENV.key? 'CIRCLE_PULL_REQUEST'
-    ENV['PRONTO_PULL_REQUEST_ID'] = ENV['CIRCLE_PULL_REQUEST'].split('/').last
-  end
-  puts "PRONTO_PULL_REQUEST_ID is #{ENV['PRONTO_PULL_REQUEST_ID']}"
-  sh "pronto run #{formatter} -c origin/master --no-exit-code --unstaged "\
-     '|| true'
-  sh "pronto run #{formatter} -c origin/master --no-exit-code --staged || true"
-  sh "pronto run #{formatter} -c origin/master --no-exit-code || true"
-end
-
-Quality::Rake::Task.new do |task|
-  task.skip_tools = %w[reek shellcheck]
-  task.output_dir = 'metrics'
-  # Add 'xit ' to the standard list, finding disabled tests
-  task.punchlist_regexp = 'XXX|TODO|FIXME|OPTIMIZE|HACK|REVIEW|LATER|FIXIT|xit '
-end
-
-task quality: %i[pronto]
-
-desc 'Run specs'
-RSpec::Core::RakeTask.new(:spec) do |task|
-  task.pattern = 'spec/**/*_spec.rb'
-  task.rspec_opts = '--format doc'
-end
-
-desc 'Run features'
-RSpec::Core::RakeTask.new(:feature) do |task|
-  task.pattern = 'feature/**/*_spec.rb'
-  task.rspec_opts = '--format doc'
-end
-
-task :clear_metrics do |_t|
-  ret =
-    system('git checkout coverage/.last_run.json metrics/*_high_water_mark')
-  raise unless ret
-end
-
-desc 'Default: Run specs and check quality.'
-task localtest: %i[clear_metrics spec feature quality]
-task test: %i[spec feature]
-task default: [:localtest]
+# Add your own tasks in files placed in rakelib/ ending in .rake,
+# for example rakelib/capistrano.rake, and they will automatically be available to Rake.