punchlist 1.3.0 → 1.3.1

data/fix.sh

@@ -0,0 +1,411 @@
+#!/bin/bash -eu
+
+set -o pipefail
+
+apt_upgraded=0
+
+update_apt() {
+  if [ "${apt_upgraded}" = 0 ]
+  then
+    sudo DEBIAN_FRONTEND=noninteractive apt-get update -y
+    apt_upgraded=1
+  fi
+}
+
+install_rbenv() {
+  if [ "$(uname)" == "Darwin" ]
+  then
+    HOMEBREW_NO_AUTO_UPDATE=1 brew install rbenv || true
+    if ! type rbenv 2>/dev/null
+    then
+      # https://github.com/pyenv/pyenv-installer/blob/master/bin/pyenv-installer
+      >&2 cat <<EOF
+WARNING: seems you still have not added 'rbenv' to the load path.
+
+# Load rbenv automatically by adding
+# the following to ~/.bashrc:
+
+export PATH="$HOME/.rbenv/bin:$PATH"
+eval "$(rbenv init -)"
+EOF
+    fi
+  else
+    git clone https://github.com/rbenv/rbenv.git ~/.rbenv
+  fi
+}
+
+set_rbenv_env_variables() {
+  export PATH="${HOME}/.rbenv/bin:$PATH"
+  eval "$(rbenv init -)"
+}
+
+install_ruby_build() {
+  if [ "$(uname)" == "Darwin" ]
+  then
+    HOMEBREW_NO_AUTO_UPDATE=1 brew install ruby-build || true
+  else
+    mkdir -p "$(rbenv root)"/plugins
+    git clone https://github.com/rbenv/ruby-build.git "$(rbenv root)"/plugins/ruby-build
+  fi
+}
+
+ensure_ruby_build() {
+  if ! type ruby-build >/dev/null 2>&1 && ! [ -d "${HOME}/.rbenv/plugins/ruby-build" ]
+  then
+    install_ruby_build
+  fi
+}
+
+ensure_rbenv() {
+  if ! type rbenv >/dev/null 2>&1 && ! [ -f "${HOME}/.rbenv/bin/rbenv" ]
+  then
+    install_rbenv
+  fi
+
+  set_rbenv_env_variables
+
+  ensure_ruby_build
+}
+
+latest_ruby_version() {
+  major_minor=${1}
+
+  # Double check that this command doesn't error out under -e
+  rbenv install --list >/dev/null 2>&1
+
+  # not sure why, but 'rbenv install --list' below exits with error code
+  # 1...after providing the same output the previous line gave when it
+  # exited with error code 0.
+  #
+  # https://github.com/rbenv/rbenv/issues/1441
+  set +e
+  rbenv install --list 2>/dev/null | cat | grep "^${major_minor}."
+  set -e
+}
+
+ensure_dev_library() {
+  header_file_name=${1:?header file name}
+  homebrew_package=${2:?homebrew package}
+  apt_package=${3:-${homebrew_package}}
+  if ! [ -f /usr/include/"${header_file_name}" ] && \
+      ! [ -f /usr/include/x86_64-linux-gnu/"${header_file_name}" ] && \
+      ! [ -f /usr/local/include/"${header_file_name}" ] && \
+      ! [ -f  /usr/local/opt/"${homebrew_package}"/include/"${header_file_name}" ]
+  then
+    install_package "${homebrew_package}" "${apt_package}"
+  fi
+}
+
+ensure_ruby_build_requirements() {
+  ensure_dev_library readline/readline.h readline libreadline-dev
+  ensure_dev_library zlib.h zlib zlib1g-dev
+  ensure_dev_library openssl/ssl.h openssl libssl-dev
+  ensure_dev_library yaml.h libyaml libyaml-dev
+}
+
+ensure_latest_ruby_build_definitions() {
+  ensure_rbenv
+
+  git -C "$(rbenv root)"/plugins/ruby-build pull
+}
+
+# You can find out which feature versions are still supported / have
+# been release here: https://www.ruby-lang.org/en/downloads/
+ensure_ruby_versions() {
+  ensure_latest_ruby_build_definitions
+
+  # You can find out which feature versions are still supported / have
+  # been release here: https://www.ruby-lang.org/en/downloads/
+  ruby_versions="$(latest_ruby_version 3.1)"
+
+  echo "Latest Ruby versions: ${ruby_versions}"
+
+  ensure_ruby_build_requirements
+
+  for ver in $ruby_versions
+  do
+    rbenv install -s "${ver}"
+    hash -r  # ensure we are seeing latest bundler etc
+  done
+}
+
+ensure_bundle() {
+  # Not sure why this is needed a second time, but it seems to be?
+  #
+  # https://app.circleci.com/pipelines/github/apiology/source_finder/21/workflows/88db659f-a4f4-4751-abc0-46f5929d8e58/jobs/107
+  set_rbenv_env_variables
+  bundle --version >/dev/null 2>&1 || gem install --no-document bundler
+  bundler_version=$(bundle --version | cut -d ' ' -f3)
+  bundler_version_major=$(cut -d. -f1 <<< "${bundler_version}")
+  bundler_version_minor=$(cut -d. -f2 <<< "${bundler_version}")
+  bundler_version_patch=$(cut -d. -f3 <<< "${bundler_version}")
+  # Version 2.1 of bundler seems to have some issues with nokogiri:
+  #
+  # https://app.asana.com/0/1107901397356088/1199504270687298
+
+  # Version <2.2.22 of bundler isn't compatible with Ruby 3.3:
+  #
+  # https://stackoverflow.com/questions/70800753/rails-calling-didyoumeanspell-checkers-mergeerror-name-spell-checker-h
+  #
+  #
+  # Version 2.5.5 fixed an issue in 2.2.22 with the 'bump' gem:
+  #
+  # https://app.circleci.com/pipelines/github/apiology/checkoff/1281/workflows/f667f909-c3fc-4ae2-8593-dde2b588a7a7/jobs/2491
+  need_better_bundler=false
+  if [ "${bundler_version_major}" -lt 2 ]
+  then
+    need_better_bundler=true
+  elif [ "${bundler_version_major}" -eq 2 ]
+  then
+    if [ "${bundler_version_minor}" -lt 5 ]
+    then
+      need_better_bundler=true
+    elif [ "${bundler_version_minor}" -eq 5 ]
+    then
+      if [ "${bundler_version_patch}" -lt 5 ]
+      then
+        need_better_bundler=true
+      fi
+    fi
+  fi
+  if [ "${need_better_bundler}" = true ]
+  then
+    >&2 echo "Original bundler version: ${bundler_version}"
+    # need to do this first before 'bundle update --bundler' will work
+    make bundle_install
+    bundle update --bundler
+    gem install bundler:2.5.5
+    >&2 echo "Updated bundler version: $(bundle --version)"
+    # ensure next step installs fresh bundle
+    rm -f Gemfile.lock.installed
+  fi
+  make bundle_install
+  # https://bundler.io/v2.0/bundle_lock.html#SUPPORTING-OTHER-PLATFORMS
+  #
+  # "If you want your bundle to support platforms other than the one
+  # you're running locally, you can run bundle lock --add-platform
+  # PLATFORM to add PLATFORM to the lockfile, force bundler to
+  # re-resolve and consider the new platform when picking gems, all
+  # without needing to have a machine that matches PLATFORM handy to
+  # install those platform-specific gems on.'
+  #
+  # This affects nokogiri, which will try to reinstall itself in
+  # Docker builds where it's already installed if this is not run.
+  for platform in arm64-darwin-23 x86_64-darwin-23 x86_64-linux x86_64-linux-musl
+  do
+    grep "${platform:?}" Gemfile.lock >/dev/null 2>&1 || bundle lock --add-platform "${platform:?}"
+  done
+}
+
+set_ruby_local_version() {
+  latest_ruby_version="$(cut -d' ' -f1 <<< "${ruby_versions}")"
+  echo "${latest_ruby_version}" > .ruby-version
+}
+
+latest_python_version() {
+  major_minor=${1}
+  # https://stackoverflow.com/questions/369758/how-to-trim-whitespace-from-a-bash-variable
+  pyenv install --list | grep "^  ${major_minor}." | grep -v -- -dev | tail -1 | xargs
+}
+
+install_pyenv() {
+  if [ "$(uname)" == "Darwin" ]
+  then
+    HOMEBREW_NO_AUTO_UPDATE=1 brew install pyenv || true
+    if ! type pyenv 2>/dev/null
+    then
+      # https://github.com/pyenv/pyenv-installer/blob/master/bin/pyenv-installer
+      >&2 cat <<EOF
+WARNING: seems you still have not added 'pyenv' to the load path.
+
+# Load pyenv automatically by adding
+# the following to ~/.bashrc:
+
+export PYENV_ROOT="${HOME}/.pyenv"
+export PATH="${PYENV_ROOT}/bin:$PATH"
+eval "$(pyenv init --path)"
+eval "$(pyenv virtualenv-init -)"
+EOF
+    fi
+  else
+    curl https://pyenv.run | bash
+  fi
+}
+
+set_pyenv_env_variables() {
+  # looks like pyenv scripts aren't -u clean:
+  #
+  # https://app.circleci.com/pipelines/github/apiology/cookiecutter-pypackage/15/workflows/10506069-7662-46bd-b915-2992db3f795b/jobs/15
+  set +u
+  export PYENV_ROOT="${HOME}/.pyenv"
+  export PATH="${PYENV_ROOT}/bin:$PATH"
+  eval "$(pyenv init --path)"
+  eval "$(pyenv virtualenv-init -)"
+  set -u
+}
+
+ensure_pyenv() {
+  if ! type pyenv >/dev/null 2>&1 && ! [ -f "${HOME}/.pyenv/bin/pyenv" ]
+  then
+    install_pyenv
+  fi
+
+  if ! type pyenv >/dev/null 2>&1
+  then
+    set_pyenv_env_variables
+  fi
+}
+
+install_package() {
+  homebrew_package=${1:?homebrew package}
+  apt_package=${2:-${homebrew_package}}
+  if [ "$(uname)" == "Darwin" ]
+  then
+    HOMEBREW_NO_AUTO_UPDATE=1 HOMEBREW_NO_INSTALL_UPGRADE=1 brew install "${homebrew_package}"
+  elif type apt-get >/dev/null 2>&1
+  then
+    if ! dpkg -s "${apt_package}" >/dev/null
+    then
+      update_apt
+      sudo DEBIAN_FRONTEND=noninteractive apt-get install -y "${apt_package}"
+    fi
+  else
+    >&2 echo "Teach me how to install packages on this plaform"
+    exit 1
+  fi
+}
+
+update_package() {
+  homebrew_package=${1:?homebrew package}
+  apt_package=${2:-${homebrew_package}}
+  if [ "$(uname)" == "Darwin" ]
+  then
+    brew install "${homebrew_package}"
+  elif type apt-get >/dev/null 2>&1
+  then
+    update_apt
+    sudo DEBIAN_FRONTEND=noninteractive apt-get install -y "${apt_package}"
+  else
+    >&2 echo "Teach me how to install packages on this plaform"
+    exit 1
+  fi
+}
+
+ensure_python_build_requirements() {
+  ensure_dev_library zlib.h zlib zlib1g-dev
+  ensure_dev_library bzlib.h bzip2 libbz2-dev
+  ensure_dev_library openssl/ssl.h openssl libssl-dev
+  ensure_dev_library ffi.h libffi libffi-dev
+  ensure_dev_library sqlite3.h sqlite3 libsqlite3-dev
+  ensure_dev_library lzma.h xz liblzma-dev
+  ensure_dev_library readline/readline.h readline libreadline-dev
+}
+
+# You can find out which feature versions are still supported / have
+# been release here: https://www.python.org/downloads/
+ensure_python_versions() {
+  # You can find out which feature versions are still supported / have
+  # been release here: https://www.python.org/downloads/
+  python_versions="$(latest_python_version 3.12)"
+
+  echo "Latest Python versions: ${python_versions}"
+
+  ensure_python_build_requirements
+
+  for ver in $python_versions
+  do
+    if [ "$(uname)" == Darwin ]
+    then
+      if [ -z "${HOMEBREW_OPENSSL_PREFIX:-}" ]
+      then
+        HOMEBREW_OPENSSL_PREFIX="$(brew --prefix openssl)"
+      fi
+      pyenv_install() {
+        CFLAGS="-I/usr/local/opt/zlib/include -I/usr/local/opt/bzip2/include -I${HOMEBREW_OPENSSL_PREFIX}/include" LDFLAGS="-L/usr/local/opt/zlib/lib -L/usr/local/opt/bzip2/lib -L${HOMEBREW_OPENSSL_PREFIX}/lib" pyenv install --skip-existing "$@"
+      }
+
+      major_minor="$(cut -d. -f1-2 <<<"${ver}")"
+      pyenv_install "${ver}"
+    else
+      pyenv install -s "${ver}"
+    fi
+  done
+}
+
+ensure_pyenv_virtualenvs() {
+  latest_python_version="$(cut -d' ' -f1 <<< "${python_versions}")"
+  virtualenv_name="punchlist-${latest_python_version}"
+  pyenv virtualenv "${latest_python_version}" "${virtualenv_name}" || true
+  # You can use this for your global stuff!
+  pyenv virtualenv "${latest_python_version}" mylibs || true
+  # shellcheck disable=SC2086
+  pyenv local "${virtualenv_name}" ${python_versions} mylibs
+}
+
+ensure_pip_and_wheel() {
+  # https://cve.mitre.org/cgi-bin/cvename.cgi?name=2023-5752
+  major_pip_version=$(pip --version | cut -d' ' -f2 | cut -d '.' -f 1)
+  minor_pip_version=$(pip --version | cut -d' ' -f2 | cut -d '.' -f 2)
+  if [[ major_pip_version -lt 23 ]]
+  then
+      pip install 'pip>=23.3'
+  elif [[ major_pip_version -eq 23 ]] && [[ minor_pip_version -lt 3 ]]
+  then
+      pip install 'pip>=23.3'
+  fi
+  # wheel is helpful for being able to cache long package builds
+  pip show wheel >/dev/null 2>&1 || pip install wheel
+}
+
+ensure_python_requirements() {
+  make pip_install
+}
+
+ensure_shellcheck() {
+  if ! type shellcheck >/dev/null 2>&1
+  then
+    install_package shellcheck
+  fi
+}
+
+ensure_overcommit() {
+  # don't run if we're in the middle of a cookiecutter child project
+  # test, or otherwise don't have a Git repo to install hooks into...
+  if [ -d .git ]
+  then
+    bundle exec overcommit --install
+    bundle exec overcommit --sign pre-commit
+  else
+    >&2 echo 'Not in a git repo; not installing git hooks'
+  fi
+}
+
+ensure_rugged_packages_installed() {
+  install_package icu4c libicu-dev # needed by rugged, needed by undercover
+  install_package pkg-config # needed by rugged, needed by undercover
+  install_package cmake # needed by rugged, needed by undercover
+}
+
+ensure_rbenv
+
+ensure_ruby_versions
+
+set_ruby_local_version
+
+ensure_rugged_packages_installed
+
+ensure_bundle
+
+ensure_pyenv
+
+ensure_python_versions
+
+ensure_pyenv_virtualenvs
+
+ensure_pip_and_wheel
+
+ensure_python_requirements
+
+ensure_shellcheck
+
+ensure_overcommit

data/lib/punchlist/inspector.rb

@@ -5,7 +5,9 @@ require_relative 'offense'
 module Punchlist
   # Inspects files for punchlist items
   class Inspector
-    attr_reader :punchlist_line_regexp, :filename
+    # @param punchlist_line_regexp [Regexp] a regular expression that matches punchlist items
+    # @param filename [String] the file to inspect
+    # @param file_opener [Class<File>] an object that responds to `open` like `File`
     def initialize(punchlist_line_regexp, filename, file_opener: File)
       @file_opener = file_opener
       @punchlist_line_regexp = punchlist_line_regexp
@@ -14,18 +16,36 @@ module Punchlist
       @line_num = 0
     end
 
+    # @return [Array<Offense>] punchlist items for the specified file
+    def run
+      @file_opener.open(filename, 'r') do |file|
+        file.each_line { |line| inspect_line(line) }
+      end
+      @lines
+    end
+
+    private
+
+    # @return [Regexp]
+    attr_reader :punchlist_line_regexp
+
+    # @return [String]
+    attr_reader :filename
+
+    # Inspects a line for punchlist items and stores it in this objects state
+    #
+    # @param line [String] the line to inspect
+    # @return [void]
     def inspect_line(line)
       @line_num += 1
       return unless line =~ punchlist_line_regexp
 
       @lines << Offense.new(filename, @line_num, line.chomp)
-    end
-
-    def run
-      @file_opener.open(filename, 'r') do |file|
-        file.each_line { |line| inspect_line(line) }
+    rescue ArgumentError => e
+      if e.message != 'invalid byte sequence in UTF-8'
+        # not a simple binary file we should ignore
+        raise
       end
-      @lines
     end
   end
 end

data/lib/punchlist/version.rb

@@ -3,5 +3,5 @@
 # Counts the number of 'todo' comments in your code ('Comment
 # annotations').
 module Punchlist
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

data/lib/punchlist.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'punchlist/version'
 require_relative 'punchlist/option_parser'
 require_relative 'punchlist/inspector'
 require_relative 'punchlist/renderer'

data/metrics/brakeman_high_water_mark

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

data/metrics/flake8_high_water_mark

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

data/metrics/jscs_high_water_mark

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

data/metrics/punchlist_high_water_mark

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

data/metrics/pycodestyle_high_water_mark

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

data/metrics/rails_best_practices_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 @@
+11

data/package.json

@@ -0,0 +1,9 @@
+{
+  "remarkConfig": {
+    "settings": {
+      "bullet": "*",
+      "listItemIndent": "one"
+    },
+    "plugins": []
+  }
+}

data/punchlist.gemspec

@@ -1,39 +1,33 @@
-# ; -*-Ruby-*-
+# coding: ascii
 # frozen_string_literal: true
 
-$LOAD_PATH.push File.join(File.dirname(__FILE__), 'lib')
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'punchlist/version'
 
-Gem::Specification.new do |s|
-  s.name = 'punchlist'
-  s.version = Punchlist::VERSION
+Gem::Specification.new do |spec|
+  spec.name          = 'punchlist'
+  spec.version       = Punchlist::VERSION
+  spec.authors       = ["Vince Broz"]
+  spec.email         = ['vince@broz.cc']
+  spec.summary       = "Counts the number of 'todo' comments in your code"
+  spec.homepage      = 'https://github.com/apiology/punchlist'
+  spec.license       = 'MIT license'
+  spec.required_ruby_version = '>= 3.0'
 
-  s.authors = ['Vince Broz']
-  s.description =
-    "punchlist lists your annotation comments--things like 'LATER/HACK/FIXIT'"
-  s.email = ['vince@broz.cc']
-  s.executables = ['punchlist']
-  # s.extra_rdoc_files = ["CHANGELOG", "License.txt"]
-  s.license = 'MIT'
-  s.files = Dir['License.txt', 'README.md',
-                'Rakefile',
-                'bin/punchlist',
-                '{lib}/**/*',
-                'punchlist.gemspec'] & `git ls-files -z`.split("\0")
-  # s.rdoc_options = ["--main", "README.md"]
-  s.require_paths = ['lib']
-  s.homepage = 'http://github.com/apiology/punchlist'
-  # s.rubyforge_project = %q{punchlist}
-  s.rubygems_version = '1.3.6'
-  s.summary = 'Finds largest source files in a project'
+  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']
 
-  s.add_dependency('source_finder', ['>=2'])
+  spec.add_dependency('source_finder', ['>=2'])
+  # spec.add_runtime_dependency 'activesupport'
 
-  s.add_development_dependency('bundler')
-  s.add_development_dependency('pronto')
-  s.add_development_dependency('pronto-rubocop')
-  s.add_development_dependency('quality', ['~> 36'])
-  s.add_development_dependency('rake')
-  s.add_development_dependency('rspec')
-  s.add_development_dependency('simplecov')
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true',
+  }
 end

data/rakelib/citest.rake

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+desc 'Run tasks to be done during a continuous integration (CI) build'
+task citest: %i[clear_metrics spec feature undercover]

data/rakelib/clear_metrics.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+desc 'Ensure that any locally ratcheted coverage metrics are cleared back ' \
+     'to git baseline'
+task :clear_metrics do |_t|
+  # Without this old lines which are removed are still counted,
+  # leading to inconsistent coverage percentages between runs.
+  raise unless system('rm -fr coverage/')
+end

data/rakelib/console.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+desc 'Load up punchlist in pry'
+task :console do |_t|
+  exec 'pry -I lib -r punchlist'
+end

data/rakelib/default.rake

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+desc 'Standard build'
+task default: :localtest

data/rakelib/doc.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+desc 'Push documentation updates to Dropbox'
+task :doc do
+  sh 'yard -p yard_templates -o docs/ --no-private'
+end

data/rakelib/feature.rake

@@ -0,0 +1,10 @@
+# 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 --default-path feature ' \
+                    '--require feature_helper'
+end

data/rakelib/gem_tasks.rake

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/rakelib/localtest.rake

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+desc 'Standard build when running on a workstation'
+task localtest: %i[clear_metrics spec feature undercover quality]

data/rakelib/overcommit.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+desc 'Run overcommit on current code'
+task :overcommit do
+  sh 'overcommit --run'
+end

data/rakelib/quality.rake

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+desc 'Run quality checks'
+task quality: :overcommit

data/rakelib/repl.rake

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+desc 'Load up punchlist in pry'
+task repl: [:console]

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 --require spec_helper'
+end

data/rakelib/undercover.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+desc 'Ensure PR changes are fully covered by tests'
+task :undercover do |_t|
+  ret =
+    system('if git branch -r | grep origin/main; then undercover --compare origin/main; fi')
+  raise unless ret
+end