punchlist 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f3a91cd04e344a758a88d1892086339492be3306
-  data.tar.gz: cea784b35403f68c784694e64101b342fc0328b5
+SHA256:
+  metadata.gz: e8aef2fe3d82b4fe162b643b0898f74e800ea607d806e6ce58bf45d0a3fd1e21
+  data.tar.gz: 73264d34929b8ad1fb6dd92dacaa131d7a0d6b9d71256fc901ab98f2f58f1450
 SHA512:
-  metadata.gz: c5327b956982854e55f5b4e620ab0060825cd39e70838cccb818490e9f48dca889ccbc7329b94c416c2fd0465b815caa15f1004718a526321992bad392319419
-  data.tar.gz: c7663708ff7dc748f159db4adb607e6267334396551abe8d74d82eb53bcfdf1c43852e73d027d249953cce532d2a681d722bd25ac960b537b2b69d1139852392
+  metadata.gz: bddf9817bcb9f4512397e2da5ee97269555e3eece6d260abd5df791436012841d33a9b9c836ac369b4dc16c411e20bd646a0fe250467a7ae0d744b6962a47ce9
+  data.tar.gz: a7f3c332d1d4a701fb6cc9a416d20ec5d68ce8c1b6369602a9420f8fc52432ebd1586c3c5b215799d4f0badabaa514cb91d93df11b8b2f2b99c5fbc6a11efb1f

data/.circleci/config.yml

@@ -0,0 +1,132 @@
+---
+version: 2.1
+
+commands:
+  run_with_languages:
+    description: "Run the given command in an environment that includes relevant langauges in the PATH"
+    parameters:
+      command:
+        type: string
+        description: "What command to execute"
+      label:
+        type: string
+        description: "What to label the run"
+        default: <<parameters.command>>
+    steps:
+      - run:
+          name: <<parameters.label>>
+          command: |
+            export PATH="${HOME}/.pyenv/bin:${PATH}"
+            export PATH="${HOME}/.rbenv/bin:${HOME}/.rbenv/shims:${PATH}"
+            export PATH="${HOME}/project/node_modules/.bin:${PATH}"
+            eval "$(pyenv init --path)"
+            eval "$(pyenv virtualenv-init -)"
+            eval "$(rbenv init -)"
+            export BUNDLE_PATH=vendor/bundle
+
+            <<parameters.command>>
+          environment:
+            # https://app.circleci.com/pipelines/github/apiology/cookiecutter-pypackage/4/workflows/29074dc8-944c-4600-8aaa-5116575fed90/jobs/4
+            "LC_ALL": "C.UTF-8"
+            "LANG": "C.UTF-8"
+  set_up_environment:
+    description: "Install source environment"
+    steps:
+      - checkout
+      - run: |
+          sed -E -e 's/punchlist \([[:digit:]]+.[[:digit:]]+.[[:digit:]]+\)/punchlist (0.1.0)/g' \
+          Gemfile.lock > Gemfile.lock.deversioned
+      - restore_cache:
+          key: gems-v2-{{ checksum "Gemfile.lock.deversioned" }}
+      - restore_cache:
+          key: wheels-v1-3.12.1-{{ checksum "requirements_dev.txt" }}
+      - run:
+          name: Initialize packages
+          command: |
+            export BUNDLE_PATH=vendor/bundle
+            './fix.sh'
+      - run:
+          name: Verify Gemfile.lock
+          command: |
+            if ! git diff --exit-code Gemfile.lock
+            then
+              >&2 echo "Please resolve changes to Gemfile.lock after bundle install to avoid caching difficulties"
+              exit 1
+            fi
+      - save_cache:
+          key: gems-v2-{{ checksum "Gemfile.lock.deversioned" }}
+          paths:
+            - "vendor/bundle"
+      - save_cache:
+          key: wheels-v1-3.12.1-{{ checksum "requirements_dev.txt" }}
+          paths:
+            - "/home/circleci/.cache/pip/wheels"
+            - "/home/circleci/.pyenv/versions/3.12.1/envs/punchlist-3.12.1"
+            - "/home/circleci/.pyenv/versions/punchlist-3.12.1"
+      - run:
+          name: Download new circleci tool
+          command: |
+            curl -fLSs \
+            https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/master/install.sh | sudo bash
+  overcommit:
+    description: "Run overcommit"
+    steps:
+      - set_up_environment
+      - run_with_languages:
+          label: Run overcommit
+          command: |
+            # Coax overcommit into working
+            git config --global user.email "test@test.test"
+            git config --global user.name "Test Test"
+            bundle exec overcommit --sign
+            bundle exec overcommit --sign pre-commit
+
+            bundle exec overcommit --run
+
+jobs:
+  overcommit:
+    working_directory: ~/punchlist
+    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"
+  build:
+    working_directory: ~/punchlist
+    docker:
+      - image: apiology/circleci-ruby:latest
+    steps:
+      - set_up_environment
+      - run_with_languages:
+          label: test
+          command: make citest cicoverage
+    # This seemed to shave 5ish% of the build time off when added
+    resource_class: large
+
+workflows:
+  version: 2
+  weekly:
+    triggers:
+      - schedule:
+          cron: "0 0 * * 6"
+          filters:
+            branches:
+              only:
+                - main
+    jobs:
+      - build
+      - overcommit
+  overcommit:
+    jobs:
+      - overcommit
+  build:
+    jobs:
+      - build

data/.envrc

@@ -0,0 +1,4 @@
+# shellcheck shell=bash
+PATH_add bin
+
+direnv_load op run --cache --env-file=config/env.1p -- direnv dump

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'overcommit'
+require 'overcommit/hook/pre_commit/base'
+
+module Overcommit
+  module Hook
+    module PreCommit
+      # CircleCI plugin for Overcommit to validate config file (.circleci/config.yml)
+      class CircleCi < Base
+        # @return [Symbol, Array<[Symbol, String]>]
+        def run
+          result = execute(command)
+          return :pass if result.success?
+
+          if result.success?
+            :pass
+          else
+            [:fail, result.stderr]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'overcommit'
+require 'overcommit/hook/pre_commit/base'
+
+# Overcommit configuration
+module Overcommit
+  module Hook
+    module PreCommit
+      # Runs `punchlist` against any modified Ruby files.
+      class Punchlist < Base
+        # @param stdout [String]
+        # @return [Array<Overcommit::Hook::Message>]
+        def parse_output(stdout)
+          stdout.split("\n").map do |line|
+            # @sg-ignore
+            file, line_no, _message = line.split(':', 3)
+            Overcommit::Hook::Message.new(:error, file, line_no.to_i, line)
+          end
+        end
+
+        # @return [String]
+        def files_glob
+          "{" \
+            "#{applicable_files.join(',')}" \
+            "}"
+        end
+
+        # @return [Symbol, Array<Overcommit::Hook::Message>]
+        def run
+          # @sg-ignore
+          # @type [Overcommit::Subprocess::Result]
+          result = execute([*command, '-g', files_glob])
+
+          warn result.stderr
+
+          # If the command exited with a non-zero status or produced any output, treat it as a failure
+          if result.status.nonzero? || !result.stdout.empty? || !result.stderr.empty?
+            # Parse the output to create Message objects
+            stdout = result.stdout
+            messages = parse_output(stdout)
+
+            return messages
+          end
+
+          :pass
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'overcommit'
+require 'overcommit/hook/pre_commit/base'
+
+# @!override Overcommit::Hook::Base#execute
+#   @return [Overcommit::Subprocess::Result]
+
+module Overcommit
+  module Hook
+    module PreCommit
+      # Runs `solargraph typecheck` against any modified Ruby files.
+      class SolargraphTypecheck < Base
+        # @return [Array<String>]
+        def run
+          errors = []
+
+          applicable_files.each do |file|
+            generate_errors_for_file(file, errors)
+          end
+
+          # output message to stderr
+          errors
+        end
+
+        private
+
+        # @param file [String]
+        # @param errors [Array<String>]
+        # @return [void]
+        def generate_errors_for_file(file, errors)
+          result = execute(['bundle', 'exec', 'solargraph', 'typecheck', '--level', 'strong', file])
+          return if result.success?
+
+          # @type [String]
+          stdout = result.stdout
+
+          stdout.split("\n").each do |error|
+            error = parse_error(file, 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]
+          match = error.match(/^(.+?):(\d+)/)
+          return nil unless match
+
+          # @!override MatchData.captures
+          #   @return [Array]
+          # @sg-ignore
+          file_path, lineno = match.captures
+          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)
+        end
+      end
+    end
+  end
+end

data/.gitattributes

@@ -0,0 +1,6 @@
+# there's a lot of .sh in the build machinery; this can overwhelm
+# smaller projects and confuse GitHub's detection of majority project
+# type (GitHub uses the linguist library)
+#
+# https://dev.to/katkelly/changing-your-repo-s-language-in-github-5gjo
+*.sh linguist-detectable=false

data/.gitignore

@@ -0,0 +1,60 @@
+# OSX useful to ignore
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# IntelliJ Idea family of suites
+.idea
+*.iml
+## File-based project format:
+*.ipr
+*.iws
+## mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# IDE settings
+.vscode/
+
+# Editor temp files
+*~
+\#*\#
+
+# Used by Makefile to track what we have and haven't installed
+Gemfile.lock.installed
+requirements_dev.txt.installed
+
+# Used by CircleCI as a place to store installed gems
+/vendor
+
+# Installed by fix.sh based on what latest versions are
+/.python-version
+/.ruby-version
+
+# Ruby-related
+/.bundle/
+/.yardoc
+/_yardoc/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/coverage/

data/.markdownlint_style.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+rule 'MD029', style: 'ordered'

data/.mdlrc

@@ -0,0 +1 @@
+style ".markdownlint_style.rb"

data/.overcommit.yml

@@ -0,0 +1,87 @@
+---
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+  # Extend default config at
+  # https://github.com/sds/overcommit/blob/master/config/default.yml
+  BrokenSymlinks:
+    enabled: true
+    description: 'Check for broken symlinks'
+    quiet: true
+  RuboCop:
+    enabled: true
+    command: ['bundle', 'exec', 'rubocop']
+    include:
+      - '**/*.gemspec'
+      - '**/*.rake'
+      - '**/*.rb'
+      - '**/*.ru'
+      - '**/Gemfile'
+      - '**/Rakefile'
+      - 'bin/*'
+      - 'exe/*'
+    problem_on_unmodified_line: warn
+    exclude:
+      - db/migrate/*.rb
+      - db/schema.rb
+  PythonFlake8:
+    enabled: true
+    on_warn: fail
+  ShellCheck:
+    enabled: true
+    on_warn: fail
+    include:
+      - '.envrc'
+      - '**/*.sh'
+  YamlLint:
+    enabled: true
+    flags: ['-c', '.yamllint.yml', '--format=parsable', '--strict']
+    on_warn: fail
+  CircleCi:
+    required_executable: 'circleci'
+    flags: ['config', 'validate']
+    include:
+      - '.circleci/config.yml'
+    enabled: true
+  SolargraphTypecheck:
+    enabled: true
+    problem_on_unmodified_line: warn
+    include:
+      - '**/*.rb'
+  Punchlist:
+    command: ['bundle', 'exec', 'punchlist']
+    enabled: true
+    problem_on_unmodified_line: warn
+
+PrePush:
+  RakeTarget:
+    enabled: true
+    command: ['bundle', 'exec', 'rake']
+    include:
+      - 'Rakefile'
+    targets:
+      - 'clear_metrics'
+      - 'spec'
+      - 'undercover'
+
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#    quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.pronto.yml

@@ -0,0 +1,2 @@
+text:
+  format: "%{color_location}: [%{runner}] %{msg}"

data/.rubocop.yml

@@ -0,0 +1,148 @@
+---
+Layout/LineLength:
+  Max: 120
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+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:
+  Enabled: false
+
+# https://stackoverflow.com/questions/40934345/rubocop-25-line-block-size-and-rspec-tests
+Metrics/BlockLength:
+  # Exclude DSLs
+  Exclude:
+    - 'Rakefile'
+    - '*.gemspec'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - 'feature/**/*.rb'
+
+# I use keyword arguments for a poor man's dependency injection to cut
+# down on the magic in my tests.
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: true
+  AllowedNames:
+    # I don't think things on this list are a terribly hard convention
+    # for folks to learn.  bbatsov also doesn't care much for this
+    # check:
+    #
+    # https://github.com/rubocop-hq/rubocop/issues/3666
+    - e # exception
+    - x # cartesian coordinates
+    - y # cartesian coordinates
+
+# by default (EnforcedStyle=NormalCase) this rule doesn't like
+# things like check_1, check_2, etc and wants check1, check2, etc. I
+# like the former.
+#
+# https://docs.rubocop.org/rubocop/cops_naming.html#namingvariablenumber
+Naming/VariableNumber:
+  Enabled: true
+  EnforcedStyle: snake_case
+
+# http://www.betterspecs.org/#single
+#
+# > in tests that are not isolated (e.g. ones that integrate with a
+# > DB, an external webservice, or end-to-end-tests), you take a
+# > massive performance hit to do the same setup over and over again,
+# > just to set a different expectation in each test. In these sorts
+# > of slower tests, I think it's fine to specify more than one
+# > isolated behavior.
+RSpec/MultipleExpectations:
+  Exclude:
+    - 'feature/**/*.rb'
+
+# Bump this up a bit for now.  I find useful, readable specs at level
+# 4, for now at least.
+#
+# The logic here makes sense to me:
+# https://github.com/datarockets/ruby-style/issues/36
+RSpec/NestedGroups:
+  Max: 4
+
+# Likewise
+RSpec/MultipleMemoizedHelpers:
+  Max: 8
+
+# Ensure we reference constants on classes in instance_double() so
+# that a renamed class is caught and doubles are always actually
+# verified.
+RSpec/VerifiedDoubleReference:
+  Enabled: true
+  EnforcedStyle: constant
+
+#
+# Add 'XX X' to the standard list
+#
+Style/CommentAnnotation:
+  Keywords:
+    - "TOD\
+       O"
+    - "FIXM\
+       E"
+    - "OPTIMIZ\
+       E"
+    - "HAC\
+       K"
+    - "REVIE\
+       W"
+    - "XX\
+       X"
+
+Style/DocumentationMethod:
+  Enabled: true
+  Include:
+    - 'lib/punchlist/*.rb'
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
+  ConsistentQuotesInMultiline: true
+
+# Solargraph needs to see a class inherited from Struct to recognize
+# what's going on
+Style/StructInheritance:
+  Enabled: false
+
+# I like trailing commas in arrays and hashes.  They let me insert new
+# elements and see them as one line in a diff, not two.
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+# If I'm using one function name and returning the contents of an
+# attribute, that's OK.  The alternative would be this, which I find
+# confusing and often not really what I mean:
+#
+# attr_reader :something_else
+# alias_method :something, :something_else
+Style/TrivialAccessors:
+  ExactNameMatch: true
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+  Exclude:
+    - 'bin/*'
+    - 'vendor/**/*'
+
+require:
+  - rubocop-rake
+  - rubocop-rspec

data/.solargraph.yml

@@ -0,0 +1,26 @@
+---
+include:
+  - "**/*.rb"
+  - ".git-hooks/**/*.rb"
+exclude:
+  - spec/**/*
+  - feature/**/*
+  - test/**/*
+  - vendor/**/*
+  - ".bundle/**/*"
+require: []
+domains: []
+reporters:
+  - rubocop
+  - require_not_found
+  - typecheck:strong
+  - update_errors
+formatter:
+  rubocop:
+    cops: safe
+    except: []
+    only: []
+    extra_args: []
+require_paths: []
+plugins: []
+max_files: 5000

data/.yamllint.yml

@@ -0,0 +1,8 @@
+---
+# https://yamllint.readthedocs.io/en/stable/configuration.html
+extends: default
+
+rules:
+  comments: disable
+  line-length:
+    max: 120