checkoff 0.201.0 → 0.203.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27306c71eb86f04c2881f717bdb79bcaf5a98a500c2f98eac6e83de3d6a1e606
-  data.tar.gz: bdb66456ccb31155310b34244f3582fcfcf0a1e2403d7b9e431fbe26f18df49e
+  metadata.gz: eea1d4895348c513ce00ca2e7d494843632a1d3c0a35aa94325e6d9b3e57c608
+  data.tar.gz: e051b9884aaceef0bc7f4abf37c837b479a927df08c42ef71ec7b23da9af2d2d
 SHA512:
-  metadata.gz: be78a2c82ce183a0dc482ad207933aa03fdccf5791677d59b180b839ade298c14e2b370eec768f7467e57190542cbcdbeae0ed1d28a96461f94e49a61254b056
-  data.tar.gz: 88d394107f9de38d9c3df1ef179d1cc5b5c577bc66b1858618447b397d0a202edd698d76715d2714f7c49b91de0745beabd7935e721a342e5db94187af27cd70
+  metadata.gz: 349033744e36da910570c401c40064ecd5918c9a89dba561994e92d2f11fcea7603cd7f79eb4f4395564f13b8c4f925f329fb80fcdf22aece35be7995e68b19c
+  data.tar.gz: 4a63e30752560a27ce28534d2b6b5c1390302da99603a734ccaccbed5b1e9fa37adda4d732c36029c30f07601c6df762aebe7025d83fa739a2bb19f8f651a5e7

data/.circleci/config.yml

@@ -33,13 +33,23 @@ commands:
     description: "Install source environment"
     steps:
       - checkout
-      - run: |
-          sed -E -e 's/checkoff \([[:digit:]]+.[[:digit:]]+.[[:digit:]]+\)/checkoff (0.1.0)/g' \
-          Gemfile.lock > Gemfile.lock.deversioned
       - restore_cache:
-          key: gems-v2-{{ checksum "Gemfile.lock.deversioned" }}
+          keys:
+            - gems-v2-{{ checksum "Gemfile.lock" }}
+            - gems-v2-
+            - gems-
       - restore_cache:
-          key: wheels-v1-3.12.1-{{ checksum "requirements_dev.txt" }}
+          keys:
+            - solargraph-v2-{{ checksum "Gemfile.lock" }}-{{ .Branch }}
+            - solargraph-v2-{{ checksum "Gemfile.lock" }}-
+            - solargraph-v2-
+            - solargraph-
+      - restore_cache:
+          keys:
+            - wheels-v1-3.12.1-{{ checksum "requirements_dev.txt" }}
+            - wheels-v1-3.12.1-
+            - wheels-v1-
+            - wheels-
       - run:
           name: Initialize packages
           command: |
@@ -54,7 +64,7 @@ commands:
               exit 1
             fi
       - save_cache:
-          key: gems-v2-{{ checksum "Gemfile.lock.deversioned" }}
+          key: gems-v2-{{ checksum "Gemfile.lock" }}
           paths:
             - "vendor/bundle"
       - save_cache:
@@ -68,8 +78,8 @@ commands:
           command: |
             curl -fLSs \
             https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/master/install.sh | sudo bash
-  overcommit:
-    description: "Run overcommit"
+  quality:
+    description: "Quality checks"
     steps:
       - set_up_environment
       - run_with_languages:
@@ -81,33 +91,123 @@ commands:
             bundle exec overcommit --sign
             bundle exec overcommit --sign pre-commit
 
-            bundle exec overcommit --run
+            if [ $(git rev-parse --abbrev-ref HEAD) == "main" ]
+            then
+              bundle exec overcommit --run
+            else
+              bundle exec bin/overcommit_branch
+            fi
+      - run_with_languages:
+          label: Run brakeman
+          command: |
+            bundle exec brakeman --no-pager --force
+      - run_with_languages:
+          label: Ratchet rubocop quality
+          command: |
+            bundle exec rubocop --regenerate-todo --no-exclude-limit --auto-gen-only-exclude --no-auto-gen-timestamp
+            if [ -f .rubocop_todo.yml ]
+            then
+              git diff --exit-code .rubocop.yml
+              git diff --exit-code .rubocop_todo.yml
+            fi
+  update_dependencies:
+    description: "Update dependencies whose build may have triggered this build"
+    parameters:
+      gems:
+        type: string
+        description: "Space-separated list of gems to update"
+    steps:
+      - run_with_languages:
+          label: Update dependencies
+          command: |
+            set -x
+            for package in <<parameters.gems>>
+            do
+              REMOTE_VERSION=$(gem search "${package}" | \
+               grep "${package}" | cut -d\( -f2 | cut -d\) -f1)
+              BUNDLED_VERSION=$(bundle info "${package}" | \
+                 head -1 | cut -d\( -f2 | cut -d\) -f1)
+              if [ ${REMOTE_VERSION:?} == ${BUNDLED_VERSION:?} ]
+              then
+                continue
+              fi
+
+              bundle update --conservative "${package}"
+
+              BUNDLED_VERSION=$(bundle info "${package}" | \
+                 head -1 | cut -d\( -f2 | cut -d\) -f1)
+
+              if [ ${REMOTE_VERSION:?} == ${BUNDLED_VERSION:?} ]
+              then
+                continue
+              fi
+
+              echo "Waiting for ${package} v${REMOTE_VERSION} to be"\
+                   "available..."
+              sleep 20
+              bundle update "${package}"
+
+              BUNDLED_VERSION=$(bundle info "${package}" | \
+                 head -1 | cut -d\( -f2 | cut -d\) -f1)
+
 
+              if [ ${REMOTE_VERSION:?} != ${BUNDLED_VERSION:?} ]
+              then
+                >&2 echo "Manually upgrade to ${package}"\
+                         "v${REMOTE_VERSION}"
+                exit 1
+              fi
+            done
+            if [ -z "$(git status --porcelain Gemfile.lock)" ]
+            then
+              echo "No updates needed"
+              exit 0
+            fi
+            # Push any dependency gem updates
+            git config user.email 'vince@broz.cc'
+            git config user.name 'Vince Broz'
+            git status
+            # bundle exec so that overcommit is used from Gemfile for
+            # git hooks
+            #
+            # https://app.circleci.com/pipelines/github/apiology/"${package}"-rails/806/workflows/40fdf1ef-fa23-421b-a0f1-641ea0ed1641/jobs/1173
+            #
+            bundle exec overcommit --sign pre-commit
+            bundle exec git commit -m "Bump dependency releases" Gemfile.lock || true
+            OVERCOMMIT_DEBUG=1 bundle exec git push --set-upstream origin "${CIRCLE_BRANCH:?}"
+            echo "Avoiding double build after git push"
+            exit 1
 jobs:
-  overcommit:
+  quality:
     working_directory: ~/checkoff
     docker:
       - image: apiology/circleci-ruby:latest
     steps:
-      - when:
-          condition:
-            equal: [<< pipeline.git.branch >>, "main"]
-          steps:
-            - overcommit
-      - unless:
-          condition:
-            equal: [<< pipeline.git.branch >>, "main"]
-          steps:
-            - run: echo "overcommit only runs on main branch"
+      - quality
   build:
     working_directory: ~/checkoff
     docker:
       - image: apiology/circleci-ruby:latest
     steps:
       - set_up_environment
+      - when:
+          condition:
+            equal: [<< pipeline.git.branch >>, "main"]
+          steps:
+            - update_dependencies:
+                gems: checkoff
+      # - run_with_languages:
+      #     label: Typecheck
+      #     command: make citypecheck citypecoverage
       - run_with_languages:
-          label: test
-          command: make citest cicoverage
+          label: Test
+          command: |
+            make citest cicoverage
+      - save_cache:
+          key: solargraph-v2-{{ checksum "Gemfile.lock" }}-{{ .Branch }}
+          paths:
+            - ".yardoc"
+            - "/home/circleci/.cache/solargraph"
     # This seemed to shave 5ish% of the build time off when added
     resource_class: large
   publish_gem:
@@ -123,6 +223,8 @@ jobs:
           command: |
             set -x
 
+            echo $BUNDLE_PATH
+            ls -l vendor/bundle
             # Coax overcommit into working
             git config --global user.email "test@test.test"
             git config --global user.name "Test Test"
@@ -151,16 +253,16 @@ workflows:
                 - main
     jobs:
       - build
-      - overcommit
-  overcommit:
+      - quality
+  quality:
     jobs:
-      - overcommit
+      - quality
   build:
     jobs:
       - build
       - publish_gem:
           requires:
             - build
-          filters:
-            branches:
-              only: main
+#          filters: # TODO
+#            branches:
+#              only: main

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

@@ -15,9 +15,7 @@ module Overcommit
         def run
           errors = []
 
-          applicable_files.each do |file|
-            generate_errors_for_file(file, errors)
-          end
+          generate_errors_for_files(errors, *applicable_files)
 
           # output message to stderr
           errors
@@ -25,27 +23,30 @@ module Overcommit
 
         private
 
-        # @param file [String]
         # @param errors [Array<String>]
+        # @param file [String]
         # @return [void]
-        def generate_errors_for_file(file, errors)
-          result = execute(['bundle', 'exec', 'solargraph', 'typecheck', '--level', 'strong', file])
+        def generate_errors_for_files(errors, *files)
+          result = execute(['bundle', 'exec', 'solargraph', 'typecheck', '--level', 'strong', *files])
           return if result.success?
 
+          stderr = result.stderr.split("\n").reject { _1.include? '[WARN]' }
+          raise result.stderr unless stderr.empty?
+
           # @type [String]
           stdout = result.stdout
 
           stdout.split("\n").each do |error|
-            error = parse_error(file, error)
+            error = parse_error(error)
             errors << error unless error.nil?
           end
         end
 
-        # @param file [String]
         # @param error [String]
         # @return [Overcommit::Hook::Message, nil]
-        def parse_error(file, error)
-          # Parse the result for the line number                # @type [MatchData]
+        def parse_error(error)
+          # Parse the result for the line number
+          # @type [MatchData]
           match = error.match(/^(.+?):(\d+)/)
           return nil unless match
 
@@ -56,7 +57,7 @@ module Overcommit
           message = error.sub("#{file_path}:#{lineno} - ",
                               "#{file_path}:#{lineno}: ")
           # Emit the errors in the specified format
-          Overcommit::Hook::Message.new(:error, file, lineno.to_i, message)
+          Overcommit::Hook::Message.new(:error, file_path, lineno.to_i, message)
         end
       end
     end

data/.overcommit.yml

@@ -35,6 +35,7 @@ PreCommit:
       - '**/Rakefile'
       - 'bin/*'
       - 'exe/*'
+      - 'script/*'
     problem_on_unmodified_line: warn
     exclude:
       - db/migrate/*.rb
@@ -50,8 +51,11 @@ PreCommit:
       - '**/*.sh'
   YamlLint:
     enabled: true
-    flags: ['-c', '.yamllint.yml']
+    flags: ['-c', '.yamllint.yml', '--format=parsable', '--strict']
     on_warn: fail
+    exclude:
+      - '.rubocop_todo.yml' # generated
+      - 'sorbet/**/*' # generated
   CircleCi:
     required_executable: 'circleci'
     flags: ['config', 'validate']
@@ -62,13 +66,34 @@ PreCommit:
     enabled: true
     problem_on_unmodified_line: warn
     include:
-      - '**/*.rb'
+      # process first
+      - "config/annotations*.rb"
+      - "**/*.rb"
+      - "**/.*.rb"
+      - "lib/tasks/*.rake"
+      - ".git-hooks/**/*.rb"
+      - "script/*"
+      - "bin/*"
+      - "bin/overcommit_branch"
+    exclude:
+      - script/.rubocop.yml
+      - vendor/**/*
+      - spec/**/*
+      - feature/**/*
+      - test/**/*
+      - ".bundle/**/*"
+      - ".markdownlint_style.rb"
   Punchlist:
     command: ['bundle', 'exec', 'punchlist']
     enabled: true
     problem_on_unmodified_line: warn
+    exclude:
+      - 'sorbet/**/*'
 
 PrePush:
+  Brakeman:
+    enabled: true
+    flags: ['--exit-on-warn', '--quiet', '--summary', '--force']
   RakeTarget:
     enabled: true
     command: ['bundle', 'exec', 'rake']

data/.rubocop.yml

@@ -1,4 +1,6 @@
 ---
+inherit_from: .rubocop_todo.yml
+
 Gemspec/RequireMFA:
   # We publish via CI/CD, so MFA is not possible.
   Enabled: false
@@ -13,8 +15,10 @@ Lint/EmptyClass:
   # some workarounds for circular dependencies require empty classes
   AllowComments: true
 
+# conflicts with solargraph wanting every parameter documented with
+# actual name and subclassing
 Lint/UnusedMethodArgument:
-  AllowUnusedKeywordArguments: true
+  Enabled: false
 
 # https://stackoverflow.com/questions/40934345/rubocop-25-line-block-size-and-rspec-tests
 Metrics/BlockLength:
@@ -52,6 +56,7 @@ Naming/MethodParameterName:
     - e # exception
     - x # cartesian coordinates
     - y # cartesian coordinates
+    - n # number of things
 
 # by default (EnforcedStyle=NormalCase) this rule doesn't like
 # things like check_1, check_2, etc and wants check1, check2, etc. I
@@ -80,6 +85,11 @@ Style/CommentAnnotation:
     - "XX\
        X"
 
+Style/DocumentationMethod:
+  Enabled: true
+  Include:
+    - 'lib/checkoff/*.rb'
+
 Style/StringLiterals:
   EnforcedStyle: single_quotes
   SupportedStyles:
@@ -109,13 +119,21 @@ Style/TrailingCommaInHashLiteral:
 Style/TrivialAccessors:
   ExactNameMatch: true
 
+Lint:
+  Severity: error
+
+Metrics:
+  Severity: error
+
 AllCops:
   NewCops: enable
   TargetRubyVersion: 3.0
   Exclude:
     - 'bin/*'
     - 'vendor/**/*'
+    - 'sorbet/**/*'
 
 require:
-  - rubocop-rake
   - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rake

data/.rubocop_todo.yml

@@ -0,0 +1,90 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config --auto-gen-only-exclude --no-exclude-limit --no-auto-gen-timestamp`
+# using RuboCop version 1.59.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 20
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/checkoff/internal/asana_event_filter.rb'
+    - 'lib/checkoff/task_searches.rb'
+    - 'lib/checkoff/timelines.rb'
+    - 'test/unit/test_portfolios.rb'
+    - 'test/unit/test_task_selectors.rb'
+    - 'test/unit/test_tasks.rb'
+    - 'test/unit/test_timelines.rb'
+
+# Offense count: 9
+# Configuration parameters: CountComments, Max, CountAsOne.
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/checkoff/attachments.rb'
+    - 'lib/checkoff/custom_fields.rb'
+    - 'lib/checkoff/projects.rb'
+    - 'lib/checkoff/sections.rb'
+    - 'lib/checkoff/tasks.rb'
+    - 'lib/checkoff/timing.rb'
+    - 'test/unit/test_sections.rb'
+    - 'test/unit/test_tasks.rb'
+    - 'test/unit/test_timelines.rb'
+
+# Offense count: 4
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/checkoff/internal/asana_event_filter.rb'
+    - 'lib/checkoff/internal/task_timing.rb'
+    - 'lib/checkoff/timelines.rb'
+
+# Offense count: 12
+# Configuration parameters: CountComments, Max, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/checkoff/attachments.rb'
+    - 'lib/checkoff/internal/asana_event_filter.rb'
+    - 'lib/checkoff/internal/search_url/date_param_converter.rb'
+    - 'lib/checkoff/my_tasks.rb'
+    - 'lib/checkoff/task_searches.rb'
+    - 'lib/checkoff/tasks.rb'
+    - 'lib/checkoff/timelines.rb'
+    - 'lib/checkoff/timing.rb'
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/checkoff/timelines.rb'
+
+# Offense count: 2
+# Configuration parameters: MinSize.
+Performance/CollectionLiteralInLoop:
+  Exclude:
+    - 'lib/checkoff/tasks.rb'
+    - 'test/unit/test_helper.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Performance/InefficientHashSearch:
+  Exclude:
+    - 'lib/checkoff/internal/asana_event_filter.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: AllowRegexpMatch.
+Performance/RedundantEqualityComparisonBlock:
+  Exclude:
+    - 'lib/checkoff/internal/selector_classes/task.rb'
+
+# Offense count: 13
+# Configuration parameters: RequireForNonPublicMethods.
+Style/DocumentationMethod:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/checkoff/cli.rb'
+    - 'lib/checkoff/clients.rb'
+    - 'lib/checkoff/tags.rb'

data/.solargraph.yml

@@ -1,13 +1,22 @@
 ---
 include:
+  # process first
+  - "config/annotations*.rb"
   - "**/*.rb"
+  - "**/.*.rb"
+  - "lib/tasks/*.rake"
   - ".git-hooks/**/*.rb"
+  - "script/*"
+  - "bin/*"
+  - "bin/overcommit_branch"
 exclude:
+  - script/.rubocop.yml
+  - vendor/**/*
   - spec/**/*
   - feature/**/*
   - test/**/*
-  - vendor/**/*
   - ".bundle/**/*"
+  - ".markdownlint_style.rb"
 require: []
 domains: []
 reporters:

data/DEVELOPMENT.md

@@ -56,7 +56,7 @@ 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 --no-verify
 git push --tags
 ```
 

data/Gemfile

@@ -7,8 +7,10 @@ gemspec
 
 gem 'bump'
 gem 'bundler'
-gem 'fakeweb'
+
+gem 'brakeman'
 gem 'mdl'
+
 # not a direct dependency - but updates a lot and confuses
 # bump+overcommit+bundler when it unexpectedly updates during the
 # CircleCI publish step
@@ -18,21 +20,22 @@ gem 'mime-types', ['=3.5.1']
 gem 'minitest-profile'
 gem 'minitest-reporters'
 gem 'mocha', ['>= 2']
-# 0.58.0 and 0.57.0 don't seem super compatible with signatures, and
-# magit doesn't seem to want to use the bundled version at the moment,
-# so let's favor the more recent version...
-gem 'overcommit', ['>=0.60.0', '<0.61.0']
+gem 'ostruct'
+gem 'overcommit', ['>=0.64.0', '<0.65.0']
 gem 'pry'
-gem 'punchlist'
-gem 'rake', '~> 13.0'
+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', ['>=0.50.0']
+gem 'solargraph',
+    git: 'https://github.com/apiology/solargraph',
+    branch: 'master'
 gem 'undercover'
 gem 'webmock'
 gem 'yard'