checkoff 0.9.0 → 0.12.0

data/Makefile

@@ -1,4 +1,4 @@
-.PHONY: clean test help quality localtest spec feature
+.PHONY: clean test help quality localtest
 .DEFAULT_GOAL := default
 
 define PRINT_HELP_PYSCRIPT
@@ -17,23 +17,42 @@ help:
 
 default: localtest ## run default typechecking and tests
 
-clean: ## remove all built artifacts
+requirements_dev.txt.installed: requirements_dev.txt
+	pip install -q --disable-pip-version-check -r requirements_dev.txt
+	touch requirements_dev.txt.installed
 
-test: spec ## run tests quickly
+pip_install: requirements_dev.txt.installed ## Install Python dependencies
 
-quality:  ## run precommit quality checks
-	@bundle exec overcommit --run
+Gemfile.lock:
+	bundle install
+
+Gemfile.lock.installed: Gemfile.lock
+	bundle install
+	touch Gemfile.lock.installed
+
+bundle_install: Gemfile.lock.installed ## Install Ruby dependencies
+
+clear_metrics: ## remove or reset result artifacts created by tests and quality tools
+	bundle exec rake clear_metrics
+
+clean: clear_metrics ## remove all built artifacts
+
+quality: ## run precommit quality checks
+	bundle exec overcommit --run
 
 test: ## Run lower-level tests
 	@bundle exec rake test
 
-localtest: test quality feature ## run default local actions
+localtest: ## run default local actions
+	@bundle exec rake localtest
 
 update_from_cookiecutter: ## Bring in changes from template project used to create this repo
+	bundle exec overcommit --uninstall
 	IN_COOKIECUTTER_PROJECT_UPGRADER=1 cookiecutter_project_upgrader || true
-	git checkout cookiecutter-template && git push && (git checkout main; bundle exec overcommit --sign)
-	git checkout main && bundle exec overcommit --sign && git pull && (git checkout -b update-from-cookiecutter-$$(date +%Y-%m-%d-%H%M); bundle exec overcommit --sign)
+	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)
 	git merge cookiecutter-template || true
+	bundle exec overcommit --install
 	@echo
 	@echo "Please resolve any merge conflicts below and push up a PR with:"
 	@echo

data/README.md

@@ -12,7 +12,7 @@ $ checkoff --help
 View tasks:
   checkoff view workspace project [section]
 
-'project' can be set to a project name, or :my_tasks, :my_tasks_upcoming, :my_tasks_new, or :my_tasks_today
+'project' can be set to a project name, or :my_tasks for your user task list.
 ```
 
 Let's say we have a project like this:

data/Rakefile

@@ -1,11 +1,4 @@
 # frozen_string_literal: true
 
-#
-# bundle exec rake release to release a new gem
-#
-require 'bundler/gem_tasks'
-
-Dir['lib/tasks/**/*.rake'].each { |t| load t }
-
-desc 'Default: Run specs and check quality.'
-task default: [:localtest]
+# Add your own tasks in files placed in rakelib/ ending in .rake,
+# for example rakelib/capistrano.rake, and they will automatically be available to Rake.

data/bin/overcommit

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'overcommit' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+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("overcommit", "overcommit")

data/checkoff.gemspec

@@ -12,8 +12,8 @@ Gem::Specification.new do |spec|
   spec.email         = ['vince@broz.cc']
   spec.summary       = 'Command-line and gem client for Asana (unofficial)'
   spec.homepage      = 'https://github.com/apiology/checkoff'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 2.5'
+  spec.license       = 'MIT license'
+  spec.required_ruby_version = '>= 2.6'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -26,16 +26,21 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'asana', '>0.10.0'
   spec.add_runtime_dependency 'cache_method'
   spec.add_runtime_dependency 'dalli'
+  spec.add_runtime_dependency 'gli'
 
   spec.add_development_dependency 'bump'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'minitest-profile'
   spec.add_development_dependency 'mocha'
-  spec.add_development_dependency 'overcommit'
+  # 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...
+  spec.add_development_dependency 'overcommit', ['>=0.58.0']
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '>=3.4'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-minitest'
   spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-lcov'
+  spec.add_development_dependency 'undercover'
 end

data/coverage/.last_run.json

@@ -1,5 +1,6 @@
 {
   "result": {
-    "covered_percent": 89.61
+    "line": 97.0,
+    "branch": 80.95
   }
 }

data/exe/checkoff

@@ -4,5 +4,4 @@
 require 'checkoff/cli'
 
 CacheMethod.config.storage = Dalli::Client.new('memcached:11211')
-cli = Checkoff::CLI.new
-puts cli.run(ARGV)
+exit(Checkoff::CheckoffGLIApp.run(ARGV))

data/fix.sh

@@ -2,6 +2,16 @@
 
 set -o pipefail
 
+apt_upgraded=0
+
+update_apt() {
+  if [ "${apt_upgraded}" = 0 ]
+  then
+    sudo apt-get update -y
+    apt_upgraded=1
+  fi
+}
+
 install_rbenv() {
   if [ "$(uname)" == "Darwin" ]
   then
@@ -77,6 +87,8 @@ ensure_dev_library() {
 
 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
 }
 
 # You can find out which feature versions are still supported / have
@@ -92,7 +104,17 @@ ensure_ruby_versions() {
 
   for ver in $ruby_versions
   do
-    rbenv install -s "${ver}"
+    # 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}"
+    fi
   done
 }
 
@@ -101,8 +123,18 @@ ensure_bundle() {
   #
   # 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 bundler
-  bundle install
+  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}")
+  # Version 2.1 of bundler seems to have some issues with nokogiri:
+  #
+  # https://app.asana.com/0/1107901397356088/1199504270687298
+  if [ "${bundler_version_major}" == 2 ] && [ "${bundler_version_minor}" -lt 2 ]
+  then
+    gem install --no-document bundler
+  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
@@ -111,7 +143,7 @@ ensure_bundle() {
   # 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.'
-  bundle lock --add-platform x86_64-darwin-20 x86_64-linux
+  grep x86_64-darwin-20 Gemfile.lock >/dev/null 2>&1 || bundle lock --add-platform x86_64-darwin-20 x86_64-linux
 }
 
 set_ruby_local_version() {
@@ -138,8 +170,9 @@ WARNING: seems you still have not added 'pyenv' to the load path.
 # Load pyenv automatically by adding
 # the following to ~/.bashrc:
 
-export PATH="$HOME/.pyenv/bin:$PATH"
-eval "$(pyenv init -)"
+export PYENV_ROOT="${HOME}/.pyenv"
+export PATH="${PYENV_ROOT}/bin:$PATH"
+eval "$(pyenv init --path)"
 eval "$(pyenv virtualenv-init -)"
 EOF
     fi
@@ -153,8 +186,9 @@ set_pyenv_env_variables() {
   #
   # https://app.circleci.com/pipelines/github/apiology/cookiecutter-pypackage/15/workflows/10506069-7662-46bd-b915-2992db3f795b/jobs/15
   set +u
-  export PATH="${HOME}/.pyenv/bin:$PATH"
-  eval "$(pyenv init -)"
+  export PYENV_ROOT="${HOME}/.pyenv"
+  export PATH="${PYENV_ROOT}/bin:$PATH"
+  eval "$(pyenv init --path)"
   eval "$(pyenv virtualenv-init -)"
   set -u
 }
@@ -179,7 +213,7 @@ install_package() {
     HOMEBREW_NO_AUTO_UPDATE=1 brew install "${homebrew_package}"
   elif type apt-get >/dev/null 2>&1
   then
-    sudo apt-get update -y
+    update_apt
     sudo apt-get install -y "${apt_package}"
   else
     >&2 echo "Teach me how to install packages on this plaform"
@@ -192,6 +226,7 @@ ensure_python_build_requirements() {
   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
 }
 
 # You can find out which feature versions are still supported / have
@@ -239,11 +274,15 @@ ensure_pyenv_virtualenvs() {
 ensure_pip() {
   # Make sure we have a pip with the 20.3 resolver, and after the
   # initial bugfix release
-  pip install 'pip>=20.3.1'
+  major_pip_version=$(pip --version | cut -d' ' -f2 | cut -d '.' -f 1)
+  if [[ major_pip_version -lt 21 ]]
+  then
+    pip install 'pip>=20.3.1'
+  fi
 }
 
 ensure_python_requirements() {
-  pip install -r requirements_dev.txt
+  make pip_install
 }
 
 ensure_shellcheck() {
@@ -253,12 +292,31 @@ ensure_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
+  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
@@ -272,3 +330,5 @@ ensure_pip
 ensure_python_requirements
 
 ensure_shellcheck
+
+ensure_overcommit

data/lib/checkoff/cli.rb

@@ -4,6 +4,7 @@
 
 require 'ostruct'
 require 'dalli'
+require 'gli'
 require 'cache_method'
 require_relative 'workspaces'
 require_relative 'projects'
@@ -11,41 +12,44 @@ require_relative 'tasks'
 require_relative 'sections'
 
 module Checkoff
-  # Provide ability for CLI to pull Asana items
-  # rubocop:disable Metrics/ClassLength
-  class CLI
-    attr_reader :sections, :stderr
-
-    def initialize(config: Checkoff::ConfigLoader.load(:asana),
-                   workspaces: Checkoff::Workspaces.new(config: config),
+  # CLI subcommand that shows tasks in JSON form
+  class ViewSubcommand
+    def initialize(workspace_name, project_name, section_name,
+                   task_name,
+                   config: Checkoff::ConfigLoader.load(:asana),
                    projects: Checkoff::Projects.new(config: config),
                    sections: Checkoff::Sections.new(config: config,
                                                     projects: projects),
-                   tasks: Checkoff::Tasks.new(config: config),
-                   stderr: $stderr,
-                   kernel: Kernel)
-      @workspaces = workspaces
-      @projects = projects
+                   tasks: Checkoff::Tasks.new(config: config,
+                                              sections: sections),
+                   stderr: $stderr)
+      @workspace_name = workspace_name
+      @stderr = stderr
+      validate_and_assign_project_name(project_name)
+      @section_name = section_name
+      @task_name = task_name
       @sections = sections
       @tasks = tasks
-      @kernel = kernel
-      @stderr = stderr
     end
 
-    def task_to_hash(task)
-      task_out = {
-        name: task.name,
-      }
-      if task.due_on
-        task_out[:due] = task.due_on
-      elsif task.due_at
-        task_out[:due] = task.due_at
+    def run
+      if section_name.nil?
+        run_on_project(workspace_name, project_name)
+      elsif task_name.nil?
+        run_on_section(workspace_name, project_name, section_name)
+      else
+        run_on_task(workspace_name, project_name, section_name, task_name)
       end
-      task_out
     end
 
-    def tasks_to_hash(tasks)
-      tasks.map { |task| task_to_hash(task) }
+    private
+
+    def validate_and_assign_project_name(project_name)
+      @project_name = if project_name.start_with? ':'
+                        project_name[1..].to_sym
+                      else
+                        project_name
+                      end
     end
 
     def run_on_project(workspace, project)
@@ -63,80 +67,89 @@ module Checkoff
       tasks_to_hash(tasks).to_json
     end
 
-    def quickadd(workspace_name, task_name)
-      workspace = @workspaces.workspace_by_name(workspace_name)
-      @tasks.add_task(task_name,
-                      workspace_gid: workspace.gid)
+    def run_on_task(workspace, project, section, task_name)
+      section = nil if section == ''
+      task = tasks.task(workspace, project, task_name, section_name: section)
+      task_to_hash(task).to_json
     end
 
-    def validate_args!(args)
-      return unless args.length < 2 || !%w[view quickadd].include?(args[0])
-
-      output_help
-      exit(1)
+    def task_to_hash(task)
+      task_out = {
+        name: task.name,
+      }
+      if task.due_on
+        task_out[:due] = task.due_on
+      elsif task.due_at
+        task_out[:due] = task.due_at
+      end
+      task_out
     end
 
-    def parse_view_args(subargs, args)
-      subargs.workspace = args[1]
-      subargs.project = args[2]
-      subargs.section = args[3]
+    def tasks_to_hash(tasks)
+      tasks.map { |task| task_to_hash(task) }
     end
 
-    def parse_quickadd_args(subargs, args)
-      subargs.workspace = args[1]
-      subargs.task_name = args[2]
-    end
+    attr_reader :workspace_name, :project_name, :section_name, :task_name, :sections, :tasks, :stderr
+  end
 
-    # rubocop:disable Metrics/MethodLength
-    def parse_args(args)
-      mode = args[0]
-      subargs = OpenStruct.new
-      case mode
-      when 'view'
-        parse_view_args(subargs, args)
-      when 'quickadd'
-        parse_quickadd_args(subargs, args)
-      else
-        raise
-      end
-      [mode, subargs]
+  # CLI subcommand that creates a task
+  class QuickaddSubcommand
+    def initialize(workspace_name, task_name,
+                   config: Checkoff::ConfigLoader.load(:asana),
+                   workspaces: Checkoff::Workspaces.new(config: config),
+                   tasks: Checkoff::Tasks.new(config: config))
+      @workspace_name = workspace_name
+      @task_name = task_name
+      @workspaces = workspaces
+      @tasks = tasks
     end
-    # rubocop:enable Metrics/MethodLength
-
-    def output_help
-      stderr.puts 'View tasks:'
-      stderr.puts "  #{$PROGRAM_NAME} view workspace project [section]"
-      stderr.puts "  #{$PROGRAM_NAME} quickadd workspace task_name"
-      stderr.puts
-      stderr.puts "'project' can be set to a project name, or :my_tasks, " \
-                  ":my_tasks_upcoming, :my_tasks_new, or :my_tasks_today"
+
+    def run
+      workspace = @workspaces.workspace_by_name(workspace_name)
+      @tasks.add_task(task_name,
+                      workspace_gid: workspace.gid)
     end
 
-    def view(workspace_name, project_name, section_name)
-      if project_name.nil?
-        stderr.puts 'Please specify a project name'
-        exit(1)
-      end
-      project_name = project_name[1..-1].to_sym if project_name.start_with? ':'
-      if section_name.nil?
-        run_on_project(workspace_name, project_name)
-      else
-        run_on_section(workspace_name, project_name, section_name)
+    private
+
+    attr_reader :workspace_name, :task_name
+  end
+
+  # Provide ability for CLI to pull Asana items
+  class CheckoffGLIApp
+    extend GLI::App
+
+    program_desc 'Command-line client for Asana (unofficial)'
+
+    subcommand_option_handling :normal
+    arguments :strict
+
+    desc 'Add a short task to Asana'
+    arg 'workspace'
+    arg 'task_name'
+    command :quickadd do |c|
+      c.action do |_global_options, _options, args|
+        workspace_name = args.fetch(0)
+        task_name = args.fetch(1)
+
+        QuickaddSubcommand.new(workspace_name, task_name).run
       end
     end
 
-    def run(args)
-      validate_args!(args)
-      command, subargs = parse_args(args)
-      case command
-      when 'view'
-        view(subargs.workspace, subargs.project, subargs.section)
-      when 'quickadd'
-        quickadd(subargs.workspace, subargs.task_name)
-      else
-        raise
+    desc 'Output representation of Asana tasks'
+    arg 'workspace'
+    arg 'project'
+    arg 'section', :optional
+    arg 'task_name', :optional
+    command :view do |c|
+      c.action do |_global_options, _options, args|
+        workspace_name = args.fetch(0)
+        project_name = args.fetch(1)
+        section_name = args[2]
+        task_name = args[3]
+
+        puts ViewSubcommand.new(workspace_name, project_name, section_name, task_name).run
       end
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end