checkoff 0.207.0 → 0.208.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4713373a7b26b525f483da5a69475a54e581d88e9a2d62c248704253f1a7b9e
-  data.tar.gz: 7f3df307162f35d5ae06a744caac036aa758e2bdfa6b70c031c1cf9d873a0a24
+  metadata.gz: 7942023f02e281c392a83c840d17c775b34feeccf295822faae41b90fd1c866e
+  data.tar.gz: 563a27004a03f007de1a379ff2a612c0ee8e1c66a2edec2a23ed0ba9a3ec6f46
 SHA512:
-  metadata.gz: 340121e39c1a3189a732e0e12f2eeb2e0dde07ec6bf2455b12fe2e9ccb71ded6684895c301771567127bf0fb231a2e91908dba90371f70864bdc9458e19d79ee
-  data.tar.gz: cabcae1b4f49b00a039fc98c727df77d9fb5988198fd44086a3ddf4231808de9ec38e486e2d98de23b402684449b1d32cfb3ed66181a572c69e4e41416e8e5ab
+  metadata.gz: 1f3c0dddcaedb88b032b36635b726c53b9b4f7966d06d93a8bb9a84da425cf4611be202064deadc2a00338579d616f16d99f31e922ac7c7cfd712355eee82745
+  data.tar.gz: '087d1c0f801fc7864a6d4abb93ad7609f21b1c4a10bda4932c506aece41f8420df741c5b5e2bc5a4ac511dacaab4824e61fb4318f54a64535bff2d9cf32ee73c'

data/.circleci/config.yml

@@ -22,7 +22,8 @@ commands:
             eval "$(pyenv init --path)"
             eval "$(pyenv virtualenv-init -)"
             eval "$(rbenv init -)"
-            export BUNDLE_PATH=vendor/bundle
+            # keep this in a single place for both main and child builds for cachability
+            export BUNDLE_PATH="$(pwd)/vendor/bundle"
 
             <<parameters.command>>
           environment:
@@ -35,8 +36,8 @@ commands:
       - checkout
       - restore_cache:
           keys:
-            - gems-v2-{{ checksum "Gemfile.lock" }}
-            - gems-v2-
+            - gems-v3-{{ checksum "Gemfile.lock" }}-
+            - gems-v3-
             - gems-
       - restore_cache:
           keys:
@@ -53,8 +54,15 @@ commands:
       - run:
           name: Initialize packages
           command: |
-            export BUNDLE_PATH=vendor/bundle
+            # measuring slows down the script - only enable when you
+            # want to debug where this is spending time
+
+            # export FIX_SH_TIMING_LOG=/tmp/fix_sh_timing.log
+
+            export BUNDLE_PATH="$(pwd)/vendor/bundle"
             './fix.sh'
+      - store_artifacts:
+          path: /tmp/fix_sh_timing.log
       - run:
           name: Verify Gemfile.lock
           command: |
@@ -64,9 +72,10 @@ commands:
               exit 1
             fi
       - save_cache:
-          key: gems-v2-{{ checksum "Gemfile.lock" }}
+          key: gems-v3-{{ checksum "Gemfile.lock" }}-{{ checksum ".ruby-version" }}
           paths:
             - "vendor/bundle"
+            - ".yardoc"
       - save_cache:
           key: wheels-v1-3.12.1-{{ checksum "requirements_dev.txt" }}
           paths:
@@ -101,9 +110,14 @@ commands:
           label: Run brakeman
           command: |
             bundle exec brakeman --no-pager --force
+      - run_with_languages:
+          label: Run Rubocop
+          command: |
+            bundle exec rubocop
       - run_with_languages:
           label: Ratchet rubocop quality
           command: |
+            set -x
             bundle exec rubocop --regenerate-todo --no-exclude-limit --auto-gen-only-exclude --no-auto-gen-timestamp
             if [ -f .rubocop_todo.yml ]
             then
@@ -216,8 +230,6 @@ jobs:
       - image: apiology/circleci-ruby:latest
     steps:
       - set_up_environment
-      - run: git config user.email 'vince@broz.cc'
-      - run: git config user.name 'Vince Broz'
       - run_with_languages:
           label: Make RubyGems release
           command: |

data/.git-hooks/pre_commit/solargraph_typecheck.rb

@@ -23,6 +23,17 @@ module Overcommit
 
         private
 
+        # @param stderr [String]
+        #
+        # @return [Array<String>]
+        def remove_harmless_glitches(stderr)
+          stderr.split("\n").reject do |line|
+            line.include?('[WARN]') ||
+              line.include?('warning: parser/current is loading') ||
+              line.include?('Please see https://github.com/whitequark')
+          end
+        end
+
         # @param errors [Array<String>]
         # @param file [String]
         # @return [void]
@@ -30,7 +41,7 @@ module Overcommit
           result = execute(['bundle', 'exec', 'solargraph', 'typecheck', '--level', 'strong', *files])
           return if result.success?
 
-          stderr = result.stderr.split("\n").reject { _1.include? '[WARN]' }
+          stderr = remove_harmless_glitches(result.stderr)
           raise result.stderr unless stderr.empty?
 
           # @type [String]

data/Gemfile

@@ -5,11 +5,43 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in checkoff.gemspec
 gemspec
 
-gem 'bump'
-gem 'bundler'
+group :development, :test do
+  gem 'bundler'
+  gem 'mdl'
+  gem 'minitest'
+  gem 'minitest-profile'
+  gem 'minitest-reporters'
+  gem 'mocha', ['>= 2']
+  # ensure recent definitions
+  gem 'rbs'
+  # ensure version with branch coverage
+  gem 'simplecov', ['>=0.18.0']
+  gem 'simplecov-lcov'
+  gem 'undercover'
+  gem 'webmock'
+end
 
-gem 'brakeman'
-gem 'mdl'
+group :development do
+  gem 'brakeman'
+  gem 'bump'
+  gem 'overcommit', ['>=0.64.1', '<0.65.0']
+  gem 'punchlist', ['>=1.3.1']
+  gem 'rubocop', ['~> 1.52']
+  gem 'rubocop-minitest'
+  gem 'rubocop-performance'
+  gem 'rubocop-rake'
+  # ensure version with RSpec/VerifiedDoubleReference
+  gem 'rubocop-rspec', ['>=2.10.0']
+  # https://github.com/castwide/solargraph/pull/727
+  # gem "solargraph", [">=0.50.0"]
+  gem 'solargraph',
+      git: 'https://github.com/apiology/solargraph',
+      branch: 'master'
+  gem 'solargraph-rails',
+      git: 'https://github.com/apiology/solargraph-rails',
+      branch: 'main'
+  gem 'yard'
+end
 
 # not a direct dependency - but updates a lot and confuses
 # bump+overcommit+bundler when it unexpectedly updates during the
@@ -17,29 +49,8 @@ gem 'mdl'
 #
 # https://app.circleci.com/pipelines/github/apiology/checkoff/1209/workflows/863fa0ce-097e-4a6b-a49f-f6ed62b29908/jobs/2320
 gem 'mime-types', ['=3.5.1']
-gem 'minitest-profile'
-gem 'minitest-reporters'
-gem 'mocha', ['>= 2']
-gem 'ostruct'
-gem 'overcommit', ['>=0.64.0', '<0.65.0']
 gem 'pry'
-gem 'punchlist', ['>=1.3.1']
 gem 'rake'
-gem 'rbs'
-gem 'rubocop', ['~> 1.52']
-gem 'rubocop-minitest'
-gem 'rubocop-performance'
-gem 'rubocop-rake'
-# ensure version with branch coverage
-gem 'simplecov', ['>=0.18.0']
-gem 'simplecov-lcov'
-gem 'solargraph',
-    git: 'https://github.com/apiology/solargraph',
-    branch: 'master'
-gem 'undercover'
-gem 'webmock'
-gem 'yard'
-
 # ruby-asana gem is pending key bugfixes for checkoff as of
 # 2021-07-29:
 #

data/Gemfile.lock

@@ -31,10 +31,19 @@ GIT
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
 
+GIT
+  remote: https://github.com/apiology/solargraph-rails
+  revision: 9dc37915bd4f3b169046e34db6fb32193ab347d8
+  branch: main
+  specs:
+    solargraph-rails (1.1.0)
+      activesupport
+      solargraph
+
 PATH
   remote: .
   specs:
-    checkoff (0.207.0)
+    checkoff (0.208.0)
       activesupport
       asana (> 0.10.0)
       cache_method
@@ -128,7 +137,7 @@ GEM
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     language_server-protocol (3.17.0.3)
-    logger (1.6.1)
+    logger (1.6.2)
     mdl (0.13.0)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.1)
@@ -139,6 +148,7 @@ GEM
     mime-types (3.5.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2023.1205)
+    mini_portile2 (2.8.8)
     minitest (5.21.1)
     minitest-profile (0.0.2)
     minitest-reporters (1.6.1)
@@ -157,9 +167,10 @@ GEM
     multi_xml (0.6.0)
     multipart-post (2.3.0)
     mutex_m (0.3.0)
-    nokogiri (1.16.7-aarch64-linux)
+    nokogiri (1.16.7)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.16.7-arm-linux)
+    nokogiri (1.16.7-aarch64-linux)
       racc (~> 1.4)
     nokogiri (1.16.7-arm64-darwin)
       racc (~> 1.4)
@@ -173,11 +184,10 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 4)
-    ostruct (0.6.1)
-    overcommit (0.64.0)
+    overcommit (0.64.1)
       childprocess (>= 0.6.3, < 6)
       iniparse (~> 1.4)
-      rexml (~> 3.2)
+      rexml (>= 3.3.9)
     parallel (1.23.0)
     parser (3.2.2.4)
       ast (~> 2.4.1)
@@ -196,7 +206,7 @@ GEM
     regexp_parser (2.8.3)
     reverse_markdown (2.1.1)
       nokogiri
-    rexml (3.2.6)
+    rexml (3.3.9)
     rubocop (1.59.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
@@ -218,6 +228,8 @@ GEM
       rubocop-ast (>= 1.30.0, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
+    rubocop-rspec (3.0.0)
+      rubocop (~> 1.40)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     rugged (1.6.3)
@@ -263,11 +275,11 @@ DEPENDENCIES
   checkoff!
   mdl
   mime-types (= 3.5.1)
+  minitest
   minitest-profile
   minitest-reporters
   mocha (>= 2)
-  ostruct
-  overcommit (>= 0.64.0, < 0.65.0)
+  overcommit (>= 0.64.1, < 0.65.0)
   pry
   punchlist (>= 1.3.1)
   rake
@@ -276,12 +288,14 @@ DEPENDENCIES
   rubocop-minitest
   rubocop-performance
   rubocop-rake
+  rubocop-rspec (>= 2.10.0)
   simplecov (>= 0.18.0)
   simplecov-lcov
   solargraph!
+  solargraph-rails!
   undercover
   webmock
   yard
 
 BUNDLED WITH
-   2.3.27
+   2.5.23

data/Makefile

@@ -45,7 +45,7 @@ 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
+Gemfile.lock: Gemfile checkoff.gemspec
 
 # Ensure any Gemfile.lock changes ensure a bundle is installed.
 Gemfile.lock.installed: Gemfile.lock
@@ -98,6 +98,11 @@ update_from_cookiecutter: ## Bring in changes from template project used to crea
 	git checkout cookiecutter-template && git push --no-verify
 	git checkout main; overcommit --sign && overcommit --sign pre-commit && git checkout main && git pull && git checkout -b update-from-cookiecutter-$$(date +%Y-%m-%d-%H%M)
 	git merge cookiecutter-template || true
+	git checkout --ours Gemfile.lock || true
+	# update frequently security-flagged gems while we're here
+	bundle update --conservative rexml || true
+	git add Gemfile.lock || true
+	bundle install || true
 	bundle exec overcommit --install || true
 	@echo
 	@echo "Please resolve any merge conflicts below and push up a PR with:"

data/bin/overcommit_branch

@@ -4,86 +4,83 @@
 
 require 'overcommit'
 require 'optparse'
+require 'set'
 
 # frozen_string_literal: true
 
-require 'set'
-
-module Overcommit::HookContext
-  # Simulates a pre-commit context representing all commits on the
-  # current feature branch, useful for automated CI scripts in large
-  # projects where not all unchanged files are assumed to pass.
-  class FeatureBranch < Base
-    # @return [Array<String>]
-    def modified_files
-      # use git cli to get the list of files changed on this feature branch
-      # @sg-ignore
-      # @type [Array<String>]
-      @modified_files ||= begin
+module Overcommit
+  module HookContext
+    # Simulates a pre-commit context representing all commits on the
+    # current feature branch, useful for automated CI scripts in large
+    # projects where not all unchanged files are assumed to pass.
+    class FeatureBranch < Base
+      # @return [Array<String>]
+      def modified_files
+        # use git cli to get the list of files changed on this feature branch
         # @sg-ignore
         # @type [Array<String>]
-        relative_filenames = `git diff --name-only origin/main...HEAD`.split("\n")
-        absolute_filenames = relative_filenames.map { |f| File.expand_path(f) }
-        absolute_filenames.select { |f| File.exist?(f) }
+        @modified_files ||= begin
+          # @sg-ignore
+          # @type [Array<String>]
+          relative_filenames = `git diff --name-only origin/main...HEAD`.split("\n")
+          absolute_filenames = relative_filenames.map { |f| File.expand_path(f) }
+          absolute_filenames.select { |f| File.exist?(f) }
+        end
       end
-    end
 
-    # @param file [String]
-    #
-    # @return [Set]
-    def modified_lines_in_file(file)
-      modified_lines = Set.new
+      # @param file [String]
+      #
+      # @return [Set]
+      def modified_lines_in_file(file)
+        # use git cli to get the list of lines changed in this file on this feature branch
+        # @sg-ignore
+        # @type [Array<String>]
+        lines = `git diff -U0 origin/main...HEAD -- #{file}`.split("\n")
+
+        modified_lines = Set.new
 
-      # use git cli to get the list of lines changed in this file on this feature branch
-      # @sg-ignore
-      # @type [Array<String>]
-      lines = `git diff -U0 origin/main...HEAD -- #{file}`.split("\n")
+        lines.each do |line|
+          next unless line =~ /^@@ -\d+,\d+ \+(\d+),(\d+)/
 
-      lines.each do |line|
-        if line =~ /^@@ -\d+,\d+ \+(\d+),(\d+)/
           first_line = Regexp.last_match(1).to_i
           last_line = first_line + Regexp.last_match(2).to_i - 1
-          # add each line # to modified_lines
-          (first_line..last_line).each do |line_number|
-            modified_lines << line_number
-          end
+          this_file_lines = (first_line..last_line)
+          modified_lines.merge(this_file_lines)
         end
-      end
 
-      modified_lines
-    end
+        modified_lines.to_set
+      end
 
-    def hook_class_name
-      'PreCommit'
-    end
+      def hook_class_name
+        'PreCommit'
+      end
 
-    def hook_type_name
-      'pre_commit'
-    end
+      def hook_type_name
+        'pre_commit'
+      end
 
-    def hook_script_name
-      'pre-commit'
-    end
+      def hook_script_name
+        'pre-commit'
+      end
 
-    def initial_commit?
-      return @initial_commit unless @initial_commit.nil?
+      def initial_commit?
+        return @initial_commit unless @initial_commit.nil?
 
-      @initial_commit = Overcommit::GitRepo.initial_commit?
-    end
+        @initial_commit = Overcommit::GitRepo.initial_commit?
+      end
 
-    private
+      private
 
-    # @param file [IO]
-    #
-    # @return [Integer]
-    def count_lines(file)
-      File.foreach(file).count
+      # @param file [IO]
+      #
+      # @return [Integer]
+      def count_lines(file)
+        File.foreach(file).count
+      end
     end
   end
 end
 
-# Returns the configuration for this repository.
-
 # Used for ease of stubbing in tests
 # @param status [Integer] The exit status to return
 # @return [void]
@@ -94,7 +91,7 @@ end
 # @return [Overcommit::Logger]
 def log
   # @sg-ignore
-  @log ||= Overcommit::Logger.new(STDOUT)
+  @log ||= Overcommit::Logger.new($stdout)
 end
 
 # @param options [Hash]

data/config/annotations_misc.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 #
 # https://gist.github.com/castwide/28b349566a223dfb439a337aea29713e
 #

data/fix.sh

@@ -1,5 +1,22 @@
 #!/bin/bash -eu
 
+if [ -n "${FIX_SH_TIMING_LOG+x}" ]; then
+    rm -f "${FIX_SH_TIMING_LOG}"
+fi
+
+debug_timing() {
+  if [ -n "${FIX_SH_TIMING_LOG+x}" ]; then
+    # shellcheck disable=SC2034
+    _lastcmd=$(ruby -e "puts (Time.now.to_f * 1000).to_i")
+    last_command='start'
+    # shellcheck disable=SC2154
+    trap '_now=$(ruby -e "puts (Time.now.to_f * 1000).to_i"); duration=$((_now - _lastcmd)); echo ${duration} ms: $last_command >> '"${FIX_SH_TIMING_LOG}"'; last_command="$BASH_COMMAND" >> '"${FIX_SH_TIMING_LOG}"'; _lastcmd=$_now' DEBUG
+  fi
+}
+
+# copy this into any function you want to debug further
+debug_timing
+
 set -o pipefail
 
 apt_upgraded=0
@@ -98,6 +115,24 @@ ensure_dev_library() {
   fi
 }
 
+ensure_binary_library() {
+  library_base_name=${1:?library base name - like libfoo}
+  homebrew_package=${2:?homebrew package}
+  apt_package=${3:-${homebrew_package}}
+  if ! [ -f /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/usr/lib/"${library_base_name}*.dylib" ] && \
+      ! [ -f /opt/homebrew/lib/"${library_base_name}*.dylib" ] && \
+      ! [ -f /usr/lib/"${library_base_name}.so" ] && \
+      ! [ -f /usr/lib/x86_64-linux-gnu/"${library_base_name}.so" ] && \
+      ! [ -f /usr/local/lib/"${library_base_name}.so" ] && \
+      ! [ -f /usr/local/opt/"${homebrew_package}/lib/${library_base_name}*.dylib" ]
+  then
+      if ! compgen -G "/opt/homebrew/Cellar/${homebrew_package}"*/*/"lib/${library_base_name}"*.dylib
+      then
+        install_package "${homebrew_package}" "${apt_package}"
+      fi
+  fi
+}
+
 ensure_ruby_build_requirements() {
   ensure_dev_library readline/readline.h readline libreadline-dev
   ensure_dev_library zlib.h zlib zlib1g-dev
@@ -108,7 +143,12 @@ ensure_ruby_build_requirements() {
 ensure_latest_ruby_build_definitions() {
   ensure_rbenv
 
-  git -C "$(rbenv root)"/plugins/ruby-build pull
+#  last_pulled_unix_epoch="$(stat -f '%m' "$(rbenv root)"/plugins/ruby-build/.git/FETCH_HEAD)"
+#  # if not pulled in last 24 hours
+#  if [ $(( $(date +%s) - last_pulled_unix_epoch )) -gt $(( 24 * 60 * 60 )) ]
+#  then
+      git -C "$(rbenv root)"/plugins/ruby-build pull
+#  fi
 }
 
 # You can find out which feature versions are still supported / have
@@ -193,10 +233,7 @@ ensure_bundle() {
   #
   # 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 aarch64-linux arm64-linux
-  do
-    grep "${platform:?}" Gemfile.lock >/dev/null 2>&1 || bundle lock --add-platform "${platform:?}"
-  done
+  bundle lock --add-platform arm64-darwin-23 x86_64-darwin-23 x86_64-linux x86_64-linux-musl aarch64-linux arm64-linux
 }
 
 set_ruby_local_version() {
@@ -258,6 +295,20 @@ ensure_pyenv() {
   fi
 }
 
+ensure_package() {
+  homebrew_package=${1:?homebrew package}
+  apt_package=${2:-${homebrew_package}}
+  binary=${3:-${homebrew_package}}
+  if ! [ -f /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/usr/bin/"${binary}" ] && \
+      ! [ -f /opt/homebrew/bin/"${binary}" ] && \
+      ! [ -f /usr/bin/"${binary}" ] && \
+      ! [ -f /usr/local/bin/"${binary}" ] && \
+      ! [ -f /usr/local/opt/"${homebrew_package}"/bin/"${binary}" ]
+  then
+    install_package "${homebrew_package}" "${apt_package}"
+  fi
+}
+
 install_package() {
   homebrew_package=${1:?homebrew package}
   apt_package=${2:-${homebrew_package}}
@@ -337,9 +388,15 @@ ensure_python_versions() {
 ensure_pyenv_virtualenvs() {
   latest_python_version="$(cut -d' ' -f1 <<< "${python_versions}")"
   virtualenv_name="checkoff-${latest_python_version}"
-  pyenv virtualenv "${latest_python_version}" "${virtualenv_name}" || true
+  if ! [ -d ~/".pyenv/versions/${virtualenv_name}" ]
+  then
+    pyenv virtualenv "${latest_python_version}" "${virtualenv_name}" || true
+  fi
   # You can use this for your global stuff!
-  pyenv virtualenv "${latest_python_version}" mylibs || true
+  if ! [ -d ~/".pyenv/versions/mylibs" ]
+  then
+    pyenv virtualenv "${latest_python_version}" mylibs || true
+  fi
   # shellcheck disable=SC2086
   pyenv local "${virtualenv_name}" ${python_versions} mylibs
 }
@@ -376,6 +433,7 @@ ensure_overcommit() {
   if [ -d .git ]
   then
     bundle exec overcommit --install
+    bundle exec overcommit --sign
     bundle exec overcommit --sign pre-commit
   else
     >&2 echo 'Not in a git repo; not installing git hooks'
@@ -383,9 +441,9 @@ ensure_overcommit() {
 }
 
 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_binary_library libicuio icu4c libicu-dev # needed by rugged, needed by undercover
+  ensure_package pkg-config # needed by rugged, needed by undercover
+  ensure_package cmake # needed by rugged, needed by undercover
 }
 
 ensure_rbenv

data/lib/checkoff/version.rb

@@ -3,5 +3,5 @@
 # Command-line and gem client for Asana (unofficial)
 module Checkoff
   # Version of library
-  VERSION = '0.207.0'
+  VERSION = '0.208.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.207.0
+  version: 0.208.0
 platform: ruby
 authors:
 - Vince Broz