checkoff 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 121d92b56f0936e25ff98efd5f601e9fea6cf6a71191f0ba7a2803785bcc1feb
-  data.tar.gz: e3b871d18fa8263e0d61df92e22b59a369b5f78e527a8da57ac0fb472db5c34d
+  metadata.gz: 0f9082aa251f94c438c29019a88db01de1732564c237bb3dff8d4aef6ce8eea6
+  data.tar.gz: 90cc397c4381839ddc1ba55c0096e84e7baf735653d2aa46267a1e52dd684603
 SHA512:
-  metadata.gz: '0862ee2cd9aababfb015020a1c55e6f7a5027bc001b2ec6317b661b7407fcb095bb981f7d44ad251a50166edf674bc798f3629b986cece29eb30286f7be09fd0'
-  data.tar.gz: ebaed1748125699b93f3804ee79d2c33fdf560aa232e904a69fb1e55ad3520802096b35ea9a921e5b70c67f37a6c78ce3444606333e6ed81ca6f7e4912ae61b6
+  metadata.gz: 21438c7ac67f3e782a1fee1c7adae43baa13df126904668dc6784cfab27b57d4abea67380af34560ff834e6b6a00a1fcd50ce12f171781991c273cc8bd9ce10e
+  data.tar.gz: 863441bc08bd83be385bb8b5806ad37a720a421cdfab44efcb9c31e528b649ee11a6e0d392401e4fb2931ff4c6f4a7934d2b652df4fb200c8286bc758c9ad7ba

data/.circleci/config.yml

@@ -19,7 +19,7 @@ commands:
             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 -)"
+            eval "$(pyenv init --path)"
             eval "$(pyenv virtualenv-init -)"
             eval "$(rbenv init -)"
             export BUNDLE_PATH=vendor/bundle
@@ -97,11 +97,12 @@ jobs:
     steps:
       - set_up_environment
       - run_with_languages:
-          label: Run tests
+          label: Test
           command: |
-            make test
+            bundle exec rake citest
             # https://github.com/bluelabsio/records-mover/blob/master/Makefile#L25
             git status --porcelain coverage/.last_run.json
+            git diff coverage/.last_run.json
             test -z "$(git status --porcelain coverage/.last_run.json)"
 
 workflows:

data/.envrc

@@ -1,2 +1,2 @@
 PATH_add bin
-eval $(with-op op-env sh -e ASANA__PERSONAL_ACCESS_TOKEN)
+eval $(with-op op-env sh -e ASANA__PERSONAL_ACCESS_TOKEN -e ASANA__DEFAULT_ASSIGNEE_GID)

data/.gitignore

@@ -58,4 +58,5 @@ requirements_dev.txt.installed
 /coverage/.resultset.json.lock
 /coverage/assets/
 /coverage/index.html
+/coverage/lcov/
 /pkg

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    checkoff (0.10.0)
+    checkoff (0.11.0)
       activesupport
       asana (> 0.10.0)
       cache_method
       dalli
+      gli
 
 GEM
   remote: https://rubygems.org/
@@ -27,15 +28,19 @@ GEM
     cache_method (0.2.7)
       cache (>= 0.2.1)
     childprocess (4.0.0)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     dalli (2.7.11)
-    docile (1.3.4)
-    faraday (1.4.1)
+    docile (1.4.0)
+    faraday (1.4.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
       faraday-net_http (~> 1.0)
       faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.1.0)
@@ -44,6 +49,7 @@ GEM
     faraday_middleware-multi_json (0.0.6)
       faraday_middleware
       multi_json
+    gli (2.20.0)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     imagen (0.1.8)
@@ -62,9 +68,10 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
-    overcommit (0.57.0)
+    overcommit (0.58.0)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
+      rexml (~> 3.2)
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
@@ -73,7 +80,7 @@ GEM
     rake (13.0.3)
     regexp_parser (2.1.1)
     rexml (3.2.5)
-    rubocop (1.14.0)
+    rubocop (1.15.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -96,6 +103,7 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
+    simplecov-lcov (0.8.0)
     simplecov_json_formatter (0.1.3)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
@@ -118,13 +126,14 @@ DEPENDENCIES
   checkoff!
   minitest-profile
   mocha
-  overcommit
+  overcommit (>= 0.58.0)
   rake (~> 13.0)
   rubocop
   rubocop-minitest
   rubocop-rake
   simplecov
+  simplecov-lcov
   undercover
 
 BUNDLED WITH
-   2.2.11
+   2.2.19

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
@@ -32,7 +32,10 @@ Gemfile.lock.installed: Gemfile.lock
 
 bundle_install: Gemfile.lock.installed ## Install Ruby dependencies
 
-clean: ## remove all built artifacts
+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
@@ -40,7 +43,8 @@ quality: ## run precommit quality checks
 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

data/checkoff.gemspec

@@ -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 '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,6 +1,6 @@
 {
   "result": {
-    "line": 93.15,
-    "branch": 61.66
+    "line": 94.61,
+    "branch": 71.42
   }
 }

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,7 +123,17 @@ 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 --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
   #
@@ -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

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..].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

data/lib/checkoff/config_loader.rb

@@ -13,10 +13,6 @@ module Checkoff
       @yaml_filename = yaml_filename
     end
 
-    def envvar_name(key)
-      "#{@envvar_prefix}__#{key.upcase}"
-    end
-
     def [](key)
       config_value = @config[key]
       return config_value unless config_value.nil?
@@ -31,25 +27,35 @@ module Checkoff
       raise KeyError,
             "Please configure either the #{key} key in #{@yaml_filename} or set #{envvar_name(key)}"
     end
+
+    private
+
+    def envvar_name(key)
+      "#{@envvar_prefix}__#{key.upcase}"
+    end
   end
 
   # Load configuration file
   class ConfigLoader
-    def self.yaml_filename(sym)
-      file = "#{sym}.yml"
-      File.expand_path("~/.#{file}")
-    end
+    class << self
+      def load(sym)
+        yaml_result = load_yaml_file(sym)
+        EnvFallbackConfigLoader.new(yaml_result, sym, yaml_filename(sym))
+      end
 
-    def self.load_yaml_file(sym)
-      filename = yaml_filename(sym)
-      return {} unless File.exist?(filename)
+      private
 
-      YAML.load_file(filename).with_indifferent_access
-    end
+      def load_yaml_file(sym)
+        filename = yaml_filename(sym)
+        return {} unless File.exist?(filename)
+
+        YAML.load_file(filename).with_indifferent_access
+      end
 
-    def self.load(sym)
-      yaml_result = load_yaml_file(sym)
-      EnvFallbackConfigLoader.new(yaml_result, sym, yaml_filename(sym))
+      def yaml_filename(sym)
+        file = "#{sym}.yml"
+        File.expand_path("~/.#{file}")
+      end
     end
   end
 end

data/lib/checkoff/projects.rb

@@ -22,8 +22,6 @@ module Checkoff
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE * 5
 
-    # XXX: Move low-level functions private
-
     def initialize(config: Checkoff::ConfigLoader.load(:asana),
                    asana_client: Asana::Client,
                    workspaces: Checkoff::Workspaces.new(config: config))
@@ -32,10 +30,41 @@ module Checkoff
       @workspaces = workspaces
     end
 
+    # Returns Asana Ruby API Client object
     def client
       @workspaces.client
     end
 
+    # pulls an Asana API project class given a name
+    def project(workspace_name, project_name)
+      if project_name.is_a?(Symbol) && project_name.to_s.start_with?('my_tasks')
+        my_tasks(workspace_name)
+      else
+        projects = projects_by_workspace_name(workspace_name)
+        projects.find do |project|
+          project.name == project_name
+        end
+      end
+    end
+    cache_method :project, LONG_CACHE_TIME
+
+    # find uncompleted tasks in a list
+    def active_tasks(tasks)
+      tasks.select { |task| task.completed_at.nil? }
+    end
+
+    # pull task objects from a named project
+    def tasks_from_project(project, only_uncompleted: true, extra_fields: [])
+      options = task_options
+      options[:completed_since] = '9999-12-01' if only_uncompleted
+      options[:project] = project.gid
+      options[:options][:fields] += extra_fields
+      client.tasks.find_all(**options).to_a
+    end
+    cache_method :tasks_from_project, SHORT_CACHE_TIME
+
+    private
+
     def projects
       client.projects
     end
@@ -56,22 +85,6 @@ module Checkoff
       projects.find_by_id(gid)
     end
 
-    def project(workspace_name, project_name)
-      if project_name.is_a?(Symbol) && project_name.to_s.start_with?('my_tasks')
-        my_tasks(workspace_name)
-      else
-        projects = projects_by_workspace_name(workspace_name)
-        projects.find do |project|
-          project.name == project_name
-        end
-      end
-    end
-    cache_method :project, LONG_CACHE_TIME
-
-    def active_tasks(tasks)
-      tasks.select { |task| task.completed_at.nil? }
-    end
-
     def task_options
       {
         per_page: 100,
@@ -81,14 +94,5 @@ module Checkoff
         },
       }
     end
-
-    def tasks_from_project(project, only_uncompleted: true, extra_fields: [])
-      options = task_options
-      options[:completed_since] = '9999-12-01' if only_uncompleted
-      options[:project] = project.gid
-      options[:options][:fields] += extra_fields
-      client.tasks.find_all(**options).to_a
-    end
-    cache_method :tasks_from_project, SHORT_CACHE_TIME
   end
 end

data/lib/checkoff/sections.rb

@@ -23,6 +23,71 @@ module Checkoff
       @time = time
     end
 
+    # Given a list of tasks, pull a Hash of tasks with section name -> task list
+    def by_section(tasks, project_gid)
+      by_section = {}
+      tasks.each do |task|
+        file_task_by_section(by_section, task, project_gid)
+      end
+      by_section
+    end
+    cache_method :by_section, LONG_CACHE_TIME
+
+    # Given a project object, pull all tasks, then provide a Hash of
+    # tasks with section name -> task list of the uncompleted tasks
+    def tasks_by_section_for_project(project)
+      raw_tasks = projects.tasks_from_project(project)
+      active_tasks = projects.active_tasks(raw_tasks)
+      by_section(active_tasks, project.gid)
+    end
+
+    # Given a workspace name and project name, then provide a Hash of
+    # tasks with section name -> task list of the uncompleted tasks
+    def tasks_by_section(workspace_name, project_name)
+      project = project_or_raise(workspace_name, project_name)
+      case project_name
+      when :my_tasks, :my_tasks_new, :my_tasks_today, :my_tasks_upcoming
+        user_task_list_by_section(workspace_name, project_name)
+      else
+        tasks_by_section_for_project(project)
+      end
+    end
+    cache_method :tasks_by_section, SHORT_CACHE_TIME
+
+    # XXX: Rename to section_tasks
+    #
+    # Pulls task objects from a specified section
+    def tasks(workspace_name, project_name, section_name)
+      tasks_by_section(workspace_name, project_name).fetch(section_name, [])
+    end
+    cache_method :tasks, SHORT_CACHE_TIME
+
+    # Pulls just names of tasks from a given section.
+    def section_task_names(workspace_name, project_name, section_name)
+      tasks = tasks(workspace_name, project_name, section_name)
+      if tasks.nil?
+        by_section = tasks_by_section(workspace_name, project_name)
+        desc = "#{workspace_name} | #{project_name} | #{section_name}"
+        raise "Could not find task names for #{desc}.  " \
+              "Valid sections: #{by_section.keys}"
+      end
+      tasks.map(&:name)
+    end
+    cache_method :section_task_names, SHORT_CACHE_TIME
+
+    # returns if a task's due field is at or before the current date/time
+    def task_due?(task)
+      if task.due_at
+        Time.parse(task.due_at) <= time.now
+      elsif task.due_on
+        Date.parse(task.due_on) <= time.today
+      else
+        true # set a due date if you don't want to do this now
+      end
+    end
+
+    private
+
     def_delegators :@projects, :client
 
     def file_task_by_section(by_section, task, project_gid)
@@ -35,27 +100,12 @@ module Checkoff
       by_section[current_section] << task
     end
 
-    def by_section(tasks, project_gid)
-      by_section = {}
-      tasks.each do |task|
-        file_task_by_section(by_section, task, project_gid)
-      end
-      by_section
-    end
-    cache_method :by_section, LONG_CACHE_TIME
-
     def legacy_tasks_by_section_for_project(project)
       raw_tasks = projects.tasks_from_project(project)
       active_tasks = projects.active_tasks(raw_tasks)
       legacy_by_section(active_tasks)
     end
 
-    def tasks_by_section_for_project(project)
-      raw_tasks = projects.tasks_from_project(project)
-      active_tasks = projects.active_tasks(raw_tasks)
-      by_section(active_tasks, project.gid)
-    end
-
     def legacy_file_task_by_section(current_section, by_section, task)
       if task.name =~ /:$/
         current_section = task.name
@@ -120,35 +170,6 @@ module Checkoff
       end
     end
 
-    def tasks_by_section(workspace_name, project_name)
-      project = project_or_raise(workspace_name, project_name)
-      case project_name
-      when :my_tasks, :my_tasks_new, :my_tasks_today, :my_tasks_upcoming
-        user_task_list_by_section(workspace_name, project_name)
-      else
-        tasks_by_section_for_project(project)
-      end
-    end
-    cache_method :tasks_by_section, SHORT_CACHE_TIME
-
-    # XXX: Rename to section_tasks
-    def tasks(workspace_name, project_name, section_name)
-      tasks_by_section(workspace_name, project_name).fetch(section_name, [])
-    end
-    cache_method :tasks, SHORT_CACHE_TIME
-
-    def section_task_names(workspace_name, project_name, section_name)
-      tasks = tasks(workspace_name, project_name, section_name)
-      if tasks.nil?
-        by_section = tasks_by_section(workspace_name, project_name)
-        desc = "#{workspace_name} | #{project_name} | #{section_name}"
-        raise "Could not find task names for #{desc}.  " \
-              "Valid sections: #{by_section.keys}"
-      end
-      tasks.map(&:name)
-    end
-    cache_method :section_task_names, SHORT_CACHE_TIME
-
     def user_task_list_migrated_to_real_sections?(workspace_name)
       workspace = workspaces.workspace_by_name(workspace_name)
       result = client.user_task_lists.get_user_task_list_for_user(user_gid: 'me',
@@ -156,16 +177,6 @@ module Checkoff
       result.migration_status != 'not_migrated'
     end
 
-    def task_due?(task)
-      if task.due_at
-        Time.parse(task.due_at) <= time.now
-      elsif task.due_on
-        Date.parse(task.due_on) <= time.today
-      else
-        true # set a due date if you don't want to do this now
-      end
-    end
-
     def project_task_names(workspace_name, project_name)
       by_section = tasks_by_section(workspace_name, project_name)
       by_section.flat_map do |section_name, tasks|

data/lib/checkoff/subtasks.rb

@@ -11,17 +11,7 @@ module Checkoff
 
     extend Forwardable
 
-    def file_task_by_section(current_section, by_section, task)
-      if task.name =~ /:$/
-        current_section = task.name
-        by_section[current_section] = []
-      else
-        by_section[current_section] ||= []
-        by_section[current_section] << task
-      end
-      [current_section, by_section]
-    end
-
+    # pulls a Hash of subtasks broken out by section
     def by_section(tasks)
       current_section = nil
       by_section = {}
@@ -37,5 +27,18 @@ module Checkoff
       task.subtasks(projects.task_options)
     end
     cache_method :raw_subtasks, LONG_CACHE_TIME
+
+    private
+
+    def file_task_by_section(current_section, by_section, task)
+      if task.name =~ /:$/
+        current_section = task.name
+        by_section[current_section] = []
+      else
+        by_section[current_section] ||= []
+        by_section[current_section] << task
+      end
+      [current_section, by_section]
+    end
   end
 end

data/lib/checkoff/tasks.rb

@@ -5,7 +5,7 @@
 require_relative 'sections'
 
 module Checkoff
-  # Pull things from 'my tasks' in Asana
+  # Pull tasks from Asana
   class Tasks
     MINUTE = 60
     HOUR = MINUTE * 60
@@ -22,6 +22,22 @@ module Checkoff
       @asana_task = asana_task
     end
 
+    # Pull a specific task by name
+    def task(workspace_name, project_name, task_name,
+             section_name: :unspecified,
+             only_uncompleted: true)
+      project = projects.project(workspace_name, project_name)
+      tasks = if section_name == :unspecified
+                projects.tasks_from_project(project,
+                                            only_uncompleted: only_uncompleted)
+              else
+                @sections.tasks(workspace_name, project_name, section_name)
+              end
+      tasks.find { |task| task.name == task_name }
+    end
+
+    private
+
     def client
       @sections.client
     end
@@ -30,13 +46,6 @@ module Checkoff
       @projects ||= @sections.projects
     end
 
-    def task(workspace_name, project_name, task_name, only_uncompleted: true)
-      project = projects.project(workspace_name, project_name)
-      tasks = projects.tasks_from_project(project,
-                                          only_uncompleted: only_uncompleted)
-      tasks.find { |task| task.name == task_name }
-    end
-
     def tasks_minus_sections(tasks)
       @sections.by_section(tasks).values.flatten
     end

data/lib/checkoff/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Checkoff
-  VERSION = '0.10.0'
+  # Version of library
+  VERSION = '0.11.0'
 end

data/lib/checkoff/workspaces.rb

@@ -9,6 +9,7 @@ module Checkoff
       @asana_client = asana_client
     end
 
+    # Returns Asana Ruby API Client object
     def client
       @client ||= @asana_client.new do |c|
         c.authentication :access_token, @config.fetch(:personal_access_token)
@@ -17,14 +18,17 @@ module Checkoff
       end
     end
 
-    def default_workspace_gid
-      @config.fetch(:default_workspace_gid)
-    end
-
+    # Pulls an Asana workspace object
     def workspace_by_name(workspace_name)
       client.workspaces.find_all.find do |workspace|
         workspace.name == workspace_name
       end || raise("Could not find workspace named [#{workspace_name}]")
     end
+
+    private
+
+    def default_workspace_gid
+      @config.fetch(:default_workspace_gid)
+    end
   end
 end

data/rakelib/{ci.rake → citest.rake}

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
 desc 'Run tasks to be done during a continuous integration (CI) build'
-task ci: :localtest
+task citest: %i[clear_metrics test undercover]

data/rakelib/clear_metrics.rake

@@ -1,8 +1,17 @@
 # frozen_string_literal: true
 
-desc 'Rebaseline quality thresholds to last commit'
+desc 'Ensure that any locally ratcheted coverage metrics are cleared back ' \
+     'to git baseline'
 task :clear_metrics do |_t|
   ret =
     system('git checkout coverage/.last_run.json')
   raise unless ret
+
+  # Without this old lines which are removed are still counted,
+  # leading to inconsistent coverage percentages between runs.
+  #
+  # need to save coverage/.last_run.json
+  ret =
+    system('rm -fr coverage/assets coverage/.*.json.lock coverage/lcov/* coverage/index.html coverage/.resultset.json')
+  raise unless ret
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-11 00:00:00.000000000 Z
+date: 2021-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bump
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +142,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.58.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.58.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +220,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  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: undercover
   requirement: !ruby/object:Gem::Requirement
@@ -281,7 +309,7 @@ files:
 - metrics/rubocop_high_water_mark
 - metrics/scalastyle_high_water_mark
 - metrics/shellcheck_high_water_mark
-- rakelib/ci.rake
+- rakelib/citest.rake
 - rakelib/clear_metrics.rake
 - rakelib/default.rake
 - rakelib/gem_tasks.rake
@@ -310,7 +338,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3.1
 signing_key:
 specification_version: 4
 summary: Command-line and gem client for Asana (unofficial)