punchlist 1.2.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/config.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Punchlist
+  # Configuration for punchlist gem
+  class Config
+    attr_reader :regexp, :glob, :exclude
+
+    def self.default_punchlist_line_regexp_string
+      'XXX|TODO|FIXME|OPTIMIZE|HACK|REVIEW|LATER|FIXIT'
+    end
+
+    def source_files
+      @source_file_globber.source_files_glob = glob if glob
+      @source_file_globber.source_files_exclude_glob = exclude if exclude
+      @source_file_globber.source_files_arr
+    end
+
+    def initialize(regexp: nil, glob: nil, exclude: nil,
+                   source_file_globber:)
+      @regexp = Regexp.new(regexp ||
+                           Config.default_punchlist_line_regexp_string)
+      @glob = glob
+      @exclude = exclude
+      @source_file_globber = source_file_globber
+    end
+  end
+end

data/lib/punchlist/inspector.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative 'offense'
+
+module Punchlist
+  # Inspects files for punchlist items
+  class Inspector
+    # @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
+      @filename = filename
+      @lines = []
+      @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)
+    rescue ArgumentError => e
+      if e.message != 'invalid byte sequence in UTF-8'
+        # not a simple binary file we should ignore
+        raise
+      end
+    end
+  end
+end

data/lib/punchlist/offense.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Punchlist
+  # Represents a discovered punchlist item in code
+  class Offense
+    attr_reader :filename, :line_num, :line
+    def initialize(filename, line_num, line)
+      @filename = filename
+      @line_num = line_num
+      @line = line
+    end
+
+    def ==(other)
+      other.class == self.class && other.state == state
+    end
+
+    protected
+
+    def state
+      [@filename, @line_num, @line]
+    end
+  end
+end

data/lib/punchlist/{options.rb → option_parser.rb}

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require 'optparse'
 require 'source_finder/option_parser'
+require_relative 'config'
 
 module Punchlist
   # Parse command line options
-  class Options
+  class OptionParser
     attr_reader :default_punchlist_line_regexp
 
     def initialize(args,
@@ -12,18 +15,10 @@ module Punchlist
       @source_finder_option_parser = source_finder_option_parser
     end
 
-    def self.default_punchlist_line_regexp_string
-      'XXX|TODO|FIXME|OPTIMIZE|HACK|REVIEW|LATER|FIXIT'
-    end
-
-    def self.default_punchlist_line_regexp
-      Regexp.new(default_punchlist_line_regexp_string)
-    end
-
     def parse_regexp(opts, options)
       opts.on('-r', '--regexp r',
-              'Regexp to trigger opon - default is ' \
-              "#{self.class.default_punchlist_line_regexp_string}") do |v|
+              'Regexp to trigger upon - default is ' \
+              "#{Config.default_punchlist_line_regexp_string}") do |v|
         options[:regexp] = v
       end
     end
@@ -36,12 +31,12 @@ module Punchlist
       options
     end
 
-    def parse_options
+    def generate_config(source_file_globber)
       options = nil
-      OptionParser.new do |opts|
+      ::OptionParser.new do |opts|
         options = setup_options(opts)
       end.parse!(@args)
-      options
+      Config.new(**options, source_file_globber: source_file_globber)
     end
   end
 end

data/lib/punchlist/renderer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Punchlist
+  # Render a text format of offenses
+  class CliRenderer
+    def render(output)
+      lines = output.map do |offense|
+        "#{offense.filename}:#{offense.line_num}: #{offense.line}"
+      end
+      out = lines.join("\n")
+      if out.empty?
+        out
+      else
+        out + "\n"
+      end
+    end
+  end
+end

data/lib/punchlist/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # Counts the number of 'todo' comments in your code ('Comment
 # annotations').
 module Punchlist
-  VERSION = '1.2.0'
+  VERSION = '1.3.1'
 end

data/lib/punchlist.rb

@@ -1,26 +1,25 @@
-require_relative 'punchlist/options'
+# frozen_string_literal: true
+
+require_relative 'punchlist/version'
+require_relative 'punchlist/option_parser'
+require_relative 'punchlist/inspector'
+require_relative 'punchlist/renderer'
 
 # XXX: need to include BUG in list
 # XXX: need to include BUG in my rubocop config
-# BUG need to fix the fact that we create blank lines on files with no issues
 module Punchlist
   # Counts the number of 'todo' comments in your code.
   class Punchlist
     def initialize(args,
                    outputter: STDOUT,
-                   file_opener: File,
-                   options_parser: Options.new(args),
+                   option_parser_class: OptionParser,
                    source_file_globber: SourceFinder::SourceFileGlobber.new)
-      @args = args
+      option_parser = option_parser_class.new(args)
+      @config = option_parser.generate_config(source_file_globber)
       @outputter = outputter
-      @file_opener = file_opener
-      @options_parser = options_parser
-      @source_file_globber = source_file_globber
     end
 
     def run
-      @options = @options_parser.parse_options
-
       analyze_files
 
       0
@@ -28,50 +27,18 @@ module Punchlist
 
     def analyze_files
       all_output = []
-      source_files.each do |filename|
+      @config.source_files.each do |filename|
         all_output.concat(look_for_punchlist_items(filename))
       end
       @outputter.print render(all_output)
     end
 
-    def source_files
-      if @options[:glob]
-        @source_file_globber.source_files_glob = @options[:glob]
-      end
-      if @options[:exclude]
-        @source_file_globber.source_files_exclude_glob = @options[:exclude]
-      end
-      @source_file_globber.source_files_arr
-    end
-
-    def punchlist_line_regexp
-      return @regexp if @regexp
-
-      regexp_string = @options[:regexp]
-      if regexp_string
-        @regexp = Regexp.new(regexp_string)
-      else
-        Options.default_punchlist_line_regexp
-      end
-    end
-
     def look_for_punchlist_items(filename)
-      lines = []
-      line_num = 0
-      @file_opener.open(filename, 'r') do |file|
-        file.each_line do |line|
-          line_num += 1
-          lines << [filename, line_num, line] if line =~ punchlist_line_regexp
-        end
-      end
-      lines
+      Inspector.new(@config.regexp, filename).run
     end
 
     def render(output)
-      lines = output.map do |filename, line_num, line|
-        "#{filename}:#{line_num}: #{line}"
-      end
-      lines.join
+      CliRenderer.new.render(output)
     end
   end
 end

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