checkoff 0.35.1 → 0.36.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c79edf8ed438b9acb826f0ea58bf1e64bd08b336597c19a717a7be021dcdf51
-  data.tar.gz: c5d70772832ea533e37a5413f8682aff31dd6d78420492129313979e0d70e138
+  metadata.gz: 1695c4a845c22ee1bbdb6ffb62eb1c78b119867b06c1a004e713eab663f315f6
+  data.tar.gz: f55d3aeaf99ff74dba23349ff6b8bd388c92236236fcbc51f34416812b1c5a83
 SHA512:
-  metadata.gz: 8606bf6119854a6e69d079374692a27b9a0b5e3fdaaf1fdecbdea9b2c8f77155dcd94c62d925c38e4a745f205129d59af05d690feb06814746cb10f78454bb4e
-  data.tar.gz: '07873de0c336f8f15ddfa68e4c809f4f9b1bb4d7511b8769415ef5a9b74dd25aeaadbb7660265539bab18d945a2106d0db692fbb8da33b73151d84bf03a9937c'
+  metadata.gz: 6b24d4ebc9fb9d6f82eaf53ea5fa7cbc949dcf9d0df84e93e547c09d364bfe291c90e86222cd092eea0b68a3acae3943cde8225980ce9c4ae5eafd4719685605
+  data.tar.gz: b49d2c7e82b74159b0eec2105d27f91be60e58ecabc4c5074ca14d09f52381baec100d96a88f02eacaefb26447fab43e5df108c848d28c4598aab5f9b23320d3

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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'overcommit'
+require 'overcommit/hook/pre_commit/base'
+
 module Overcommit
   module Hook
     module PreCommit

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

@@ -0,0 +1,49 @@
+# 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(:warning, file, line_no.to_i, line)
+          end
+        end
+
+        def files_glob
+          "{" \
+            "#{applicable_files.join(',')}" \
+            "}"
+        end
+
+        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,57 @@
+# 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
+        def run
+          errors = []
+
+          applicable_files.each do |file|
+            generate_errors_for_file(file, errors)
+          end
+
+          # output message to stderr
+          errors
+        end
+
+        private
+
+        def generate_errors_for_file(file, errors)
+          result = execute(['bundle', 'exec', 'solargraph', 'typecheck', '--level', 'strict', 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
+
+        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, message)
+        end
+      end
+    end
+  end
+end

data/.overcommit.yml

@@ -17,15 +17,12 @@
 # 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
+  # Extend default config at
+  # https://github.com/sds/overcommit/blob/master/config/default.yml
   BrokenSymlinks:
     enabled: true
     description: 'Check for broken symlinks'
     quiet: true
-    exclude:
-      # This is a symlink to sibling checkout of vincelifedaily, used
-      # only in local development
-      - config/env.1p
   RuboCop:
     enabled: true
     on_warn: fail # Treat all warnings as failures
@@ -38,7 +35,7 @@ PreCommit:
       - '**/Gemfile'
       - '**/Rakefile'
       - 'bin/*'
-      - 'script/*'
+      - 'exe/*'
     exclude:
       - db/migrate/*.rb
       - db/schema.rb
@@ -53,6 +50,7 @@ PreCommit:
       - '**/*.sh'
   YamlLint:
     enabled: true
+    flags: ['-c', '.yamllint.yml']
     on_warn: fail
   CircleCi:
     required_executable: 'circleci'
@@ -60,12 +58,19 @@ PreCommit:
     include:
       - '.circleci/config.yml'
     enabled: true
+  SolargraphTypecheck:
+    enabled: true
+    on_warn: fail
+    include:
+      - '**/*.rb'
+  Punchlist:
+    on_warn: fail
+    command: ['bundle', 'exec', 'punchlist']
+    enabled: true
 
 PrePush:
   Minitest:
     command: ['ruby', '-Ilib:test/unit:lib/checkoff', '-rbundler/setup', '-rminitest', "-e 'exit! Minitest.run'"]
-    include:
-      - 'test/unit/**/test*.rb'
     enabled: true
 
 #PostCheckout:

data/.solargraph.yml

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

data/Gemfile.lock

@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    checkoff (0.35.1)
+    checkoff (0.36.1)
       activesupport
       asana (> 0.10.0)
       cache_method
@@ -134,10 +134,13 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (5.0.0)
+    punchlist (1.3.0)
+      source_finder (>= 2)
     racc (1.6.2)
     rack (3.0.6.1)
     rainbow (3.1.1)
     rake (13.0.3)
+    rbs (3.1.0)
     regexp_parser (2.6.0)
     reverse_markdown (2.1.1)
       nokogiri
@@ -196,6 +199,7 @@ GEM
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
+    source_finder (3.2.1)
     thor (1.2.1)
     tilt (2.1.0)
     tomlrb (2.0.3)
@@ -232,7 +236,9 @@ DEPENDENCIES
   mocha (~> 2.0.0.alpha.1)
   overcommit (>= 0.60.0, < 0.61.0)
   pry
+  punchlist
   rake (~> 13.0)
+  rbs (> 3.0.3)
   rspec (>= 3.4)
   rubocop (~> 1.36, < 1.44)
   rubocop-minitest

data/Makefile

@@ -78,6 +78,7 @@ cicoverage: coverage ## check code coverage
 
 update_from_cookiecutter: ## Bring in changes from template project used to create this repo
 	bundle exec overcommit --uninstall
+	cookiecutter_project_upgrader --help >/dev/null
 	IN_COOKIECUTTER_PROJECT_UPGRADER=1 cookiecutter_project_upgrader || true
 	git checkout cookiecutter-template && git push && git checkout main
 	git checkout main && git pull && git checkout -b update-from-cookiecutter-$$(date +%Y-%m-%d-%H%M)

data/bin/solargraph

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'solargraph' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("solargraph", "solargraph")

data/bin/yard

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("yard", "yard")

data/checkoff.gemspec

@@ -42,7 +42,10 @@ Gem::Specification.new do |spec|
   # so let's favor the more recent version...
   spec.add_development_dependency 'overcommit', ['>=0.60.0', '<0.61.0']
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'punchlist'
   spec.add_development_dependency 'rake', '~> 13.0'
+  # ensure recent definitions
+  spec.add_development_dependency 'rbs', ['>3.0.3']
   spec.add_development_dependency 'rspec', '>=3.4'
   # I haven't adapted things to Gemspec/DevelopmentDependencies yet,
   # which arrives in 1.44

data/fix.sh

@@ -124,18 +124,8 @@ ensure_ruby_versions() {
 
   for ver in $ruby_versions
   do
-    # These CFLAGS can be retired once 2.6.7 is no longer needed :
-    #
-    # https://github.com/rbenv/ruby-build/issues/1747
-    # https://github.com/rbenv/ruby-build/issues/1489
-    # https://bugs.ruby-lang.org/issues/17777
-    if [ "${ver}" == 2.6.7 ]
-    then
-      CFLAGS="-Wno-error=implicit-function-declaration" rbenv install -s "${ver}"
-    else
-      rbenv install -s "${ver}"
-      hash -r  # ensure we are seeing latest bundler etc
-    fi
+    rbenv install -s "${ver}"
+    hash -r  # ensure we are seeing latest bundler etc
   done
 }
 

data/lib/checkoff/clients.rb

@@ -24,6 +24,7 @@ module Checkoff
       @asana_client_class = asana_client_class
     end
 
+    # @return [Asana::Client]
     def client
       @client ||= @asana_client_class.new do |c|
         c.authentication :access_token, @config.fetch(:personal_access_token)

data/lib/checkoff/projects.rb

@@ -33,6 +33,7 @@ module Checkoff
     end
 
     # Default options used in Asana API to pull taskso
+    # @return [Hash]
     def task_options
       {
         per_page: 100,
@@ -56,6 +57,7 @@ module Checkoff
     end
     cache_method :project, LONG_CACHE_TIME
 
+    # @return [Asana::Project]
     def project_or_raise(workspace_name, project_name)
       project = project(workspace_name, project_name)
       raise "Could not find project #{project_name} under workspace #{workspace_name}." if project.nil?

data/lib/checkoff/tags.rb

@@ -30,6 +30,7 @@ module Checkoff
       @client = client
     end
 
+    # @return [Array<Asana::Resources::Task>]
     def tasks(workspace_name, tag_name,
               only_uncompleted: true,
               extra_fields: [])

data/lib/checkoff/task_searches.rb

@@ -14,7 +14,7 @@ require 'asana/resource_includes/response_helper'
 
 require 'checkoff/internal/search_url'
 
-# https://developers.asana.com/docs/task-searches
+# https://developers.asana.com/reference/searchtasksforworkspace
 module Checkoff
   # Run task searches against the Asana API
   class TaskSearches
@@ -43,6 +43,10 @@ module Checkoff
       @asana_resources_collection_class = asana_resources_collection_class
     end
 
+    # @param [String] workspace_name
+    # @param [String] url
+    # @param [Array<String>] extra_fields
+    # @return [Array<Asana::Resources::Task>]
     def task_search(workspace_name, url, extra_fields: [])
       workspace = workspaces.workspace_or_raise(workspace_name)
       api_params, task_selector = @search_url_parser.convert_params(url)

data/lib/checkoff/task_selectors.rb

@@ -7,12 +7,14 @@ require 'cache_method'
 require 'json'
 require_relative 'internal/config_loader'
 require_relative 'internal/task_selector_evaluator'
+require_relative 'tasks'
 
 # https://developers.asana.com/docs/task-selectors
 
 module Checkoff
   # Filter lists of tasks using declarative selectors.
   class TaskSelectors
+    # @type [Integer]
     MINUTE = 60
     HOUR = MINUTE * 60
     DAY = 24 * HOUR
@@ -42,14 +44,17 @@ module Checkoff
     # bundle exec ./task_selectors.rb
     # :nocov:
     class << self
+      # @return [String]
       def project_name
         ARGV[1] || raise('Please pass project name to pull tasks from as first argument')
       end
 
+      # @return [String]
       def workspace_name
         ARGV[0] || raise('Please pass workspace name as first argument')
       end
 
+      # @return [Array]
       def task_selector
         task_selector_json = ARGV[2] || raise('Please pass task_selector in JSON form as third argument')
         JSON.parse(task_selector_json)

data/lib/checkoff/tasks.rb

@@ -3,6 +3,7 @@
 # frozen_string_literal: true
 
 require_relative 'sections'
+require 'asana'
 
 module Checkoff
   # Pull tasks from Asana
@@ -14,6 +15,7 @@ module Checkoff
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE * 5
 
+    # @param sections [Checkoff::Sections]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
                    client: Checkoff::Clients.new(config: config).client,
                    sections: Checkoff::Sections.new(config: config,
@@ -38,6 +40,7 @@ module Checkoff
     end
 
     # Pull a specific task by name
+    # @return [Asana::Resources::Task, nil]
     def task(workspace_name, project_name, task_name,
              section_name: :unspecified,
              only_uncompleted: true,
@@ -50,6 +53,7 @@ module Checkoff
       tasks.find { |task| task.name == task_name }
     end
 
+    # @return [Asana::Resources::Task]
     def add_task(name,
                  workspace_gid: default_workspace_gid,
                  assignee_gid: default_assignee_gid)
@@ -65,12 +69,13 @@ module Checkoff
 
     private
 
+    # @return [Array<Asana::Resources::Task>]
     def tasks_from_section(workspace_name, project_name,
                            section_name:,
                            only_uncompleted:,
                            extra_fields:)
       if section_name == :unspecified
-        project = projects.project(workspace_name, project_name)
+        project = projects.project_or_raise(workspace_name, project_name)
         projects.tasks_from_project(project,
                                     only_uncompleted: only_uncompleted,
                                     extra_fields: extra_fields)
@@ -83,10 +88,12 @@ module Checkoff
 
     attr_reader :client
 
+    # @return [Checkoff::Projects]
     def projects
       @projects ||= @sections.projects
     end
 
+    # @return [String]
     def default_assignee_gid
       @config.fetch(:default_assignee_gid)
     end
@@ -99,13 +106,16 @@ module Checkoff
     end
 
     def incomplete_dependencies?(task)
-      # Avoid a reundant fetch.  Unfortunately, Ruby SDK allows
+      # Avoid a redundant fetch.  Unfortunately, Ruby SDK allows
       # dependencies to be fetched along with other attributes--but
       # then doesn't use it and does another HTTP GET!  At least this
       # way we can skip the extra HTTP GET in the common case when
       # there are no dependencies.
       #
       # https://github.com/Asana/ruby-asana/issues/125
+
+      # @sg-ignore
+      # @type [Array<Asana::Resources::Task>, nil]
       already_fetched_dependencies = task.instance_variable_get(:@dependencies)
       return false unless already_fetched_dependencies.nil? || already_fetched_dependencies.size.positive?
 

data/lib/checkoff/version.rb

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

data/lib/checkoff.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'checkoff/version'
+require 'checkoff/clients'
 require 'checkoff/workspaces'
 require 'checkoff/projects'
 require 'checkoff/sections'

data/package.json

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.35.1
+  version: 0.36.1
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-03 00:00:00.000000000 Z
+date: 2023-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -212,6 +212,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: punchlist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -226,6 +240,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -368,12 +396,15 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".git-hooks/pre_commit/circle_ci.rb"
+- ".git-hooks/pre_commit/punchlist.rb"
+- ".git-hooks/pre_commit/solargraph_typecheck.rb"
 - ".gitattributes"
 - ".gitignore"
 - ".markdownlint_style.rb"
 - ".mdlrc"
 - ".overcommit.yml"
 - ".rubocop.yml"
+- ".solargraph.yml"
 - ".yamllint.yml"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.rst
@@ -391,6 +422,8 @@ files:
 - bin/rake
 - bin/rubocop
 - bin/setup
+- bin/solargraph
+- bin/yard
 - checkoff.gemspec
 - docs/cookiecutter_input.json
 - docs/example_project.png
@@ -436,6 +469,7 @@ files:
 - metrics/rubocop_high_water_mark
 - metrics/scalastyle_high_water_mark
 - metrics/shellcheck_high_water_mark
+- package.json
 - rakelib/citest.rake
 - rakelib/clear_metrics.rake
 - rakelib/console.rake