checkoff 0.5.4 → 0.9.0

data/coverage/.last_run.json

@@ -1,5 +1,5 @@
 {
   "result": {
-    "covered_percent": 83.74
+    "covered_percent": 89.61
   }
 }

data/docs/cookiecutter_input.json

@@ -0,0 +1,13 @@
+{
+    "_template": "https://github.com/apiology/cookiecutter-gem",
+    "email": "vince@broz.cc",
+    "full_name": "Vince Broz",
+    "github_username": "apiology",
+    "module_name": "Checkoff",
+    "open_source_license": "MIT license",
+    "project_name": "Checkoff",
+    "project_short_description": "Command-line and gem client for Asana (unofficial)",
+    "project_slug": "checkoff",
+    "type_of_github_repo": "public",
+    "version": "0.8.0"
+}

data/fix.sh

@@ -0,0 +1,274 @@
+#!/bin/bash -eu
+
+set -o pipefail
+
+install_rbenv() {
+  if [ "$(uname)" == "Darwin" ]
+  then
+    HOMEBREW_NO_AUTO_UPDATE=1 brew install rbenv || true
+    if ! type rbenv 2>/dev/null
+    then
+      # https://github.com/pyenv/pyenv-installer/blob/master/bin/pyenv-installer
+      >&2 cat <<EOF
+WARNING: seems you still have not added 'rbenv' to the load path.
+
+# Load rbenv automatically by adding
+# the following to ~/.bashrc:
+
+export PATH="$HOME/.rbenv/bin:$PATH"
+eval "$(rbenv init -)"
+EOF
+    fi
+  else
+    git clone https://github.com/rbenv/rbenv.git ~/.rbenv
+  fi
+}
+
+set_rbenv_env_variables() {
+  export PATH="${HOME}/.rbenv/bin:$PATH"
+  eval "$(rbenv init -)"
+}
+
+install_ruby_build() {
+  if [ "$(uname)" == "Darwin" ]
+  then
+    HOMEBREW_NO_AUTO_UPDATE=1 brew install ruby-build || true
+  else
+    mkdir -p "$(rbenv root)"/plugins
+    git clone https://github.com/rbenv/ruby-build.git "$(rbenv root)"/plugins/ruby-build
+  fi
+}
+
+ensure_ruby_build() {
+  if ! type ruby-build >/dev/null 2>&1 && ! [ -d "${HOME}/.rbenv/plugins/ruby-build" ]
+  then
+    install_ruby_build
+  fi
+}
+
+ensure_rbenv() {
+  if ! type rbenv >/dev/null 2>&1 && ! [ -f "${HOME}/.rbenv/bin/rbenv" ]
+  then
+    install_rbenv
+  fi
+
+  set_rbenv_env_variables
+
+  ensure_ruby_build
+}
+
+latest_ruby_version() {
+  major_minor=${1}
+  rbenv install --list 2>/dev/null | grep "^${major_minor}."
+}
+
+ensure_dev_library() {
+  header_file_name=${1:?header file name}
+  homebrew_package=${2:?homebrew package}
+  apt_package=${3:-${homebrew_package}}
+  if ! [ -f /usr/include/"${header_file_name}" ] && \
+      ! [ -f /usr/include/x86_64-linux-gnu/"${header_file_name}" ] && \
+      ! [ -f /usr/local/include/"${header_file_name}" ] && \
+      ! [ -f  /usr/local/opt/"${homebrew_package}"/include/"${header_file_name}" ]
+  then
+    install_package "${homebrew_package}" "${apt_package}"
+  fi
+}
+
+ensure_ruby_build_requirements() {
+  ensure_dev_library readline/readline.h readline libreadline-dev
+}
+
+# You can find out which feature versions are still supported / have
+# been release here: https://www.ruby-lang.org/en/downloads/
+ensure_ruby_versions() {
+  # You can find out which feature versions are still supported / have
+  # been release here: https://www.python.org/downloads/
+  ruby_versions="$(latest_ruby_version 2.6)"
+
+  echo "Latest Ruby versions: ${ruby_versions}"
+
+  ensure_ruby_build_requirements
+
+  for ver in $ruby_versions
+  do
+    rbenv install -s "${ver}"
+  done
+}
+
+ensure_bundle() {
+  # Not sure why this is needed a second time, but it seems to be?
+  #
+  # 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
+  # https://bundler.io/v2.0/bundle_lock.html#SUPPORTING-OTHER-PLATFORMS
+  #
+  # "If you want your bundle to support platforms other than the one
+  # you're running locally, you can run bundle lock --add-platform
+  # PLATFORM to add PLATFORM to the lockfile, force bundler to
+  # 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
+}
+
+set_ruby_local_version() {
+  latest_ruby_version="$(cut -d' ' -f1 <<< "${ruby_versions}")"
+  echo "${latest_ruby_version}" > .ruby-version
+}
+
+latest_python_version() {
+  major_minor=${1}
+  # https://stackoverflow.com/questions/369758/how-to-trim-whitespace-from-a-bash-variable
+  pyenv install --list | grep "^  ${major_minor}." | grep -v -- -dev | tail -1 | xargs
+}
+
+install_pyenv() {
+  if [ "$(uname)" == "Darwin" ]
+  then
+    HOMEBREW_NO_AUTO_UPDATE=1 brew install pyenv || true
+    if ! type pyenv 2>/dev/null
+    then
+      # https://github.com/pyenv/pyenv-installer/blob/master/bin/pyenv-installer
+      >&2 cat <<EOF
+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 -)"
+eval "$(pyenv virtualenv-init -)"
+EOF
+    fi
+  else
+    curl https://pyenv.run | bash
+  fi
+}
+
+set_pyenv_env_variables() {
+  # looks like pyenv scripts aren't -u clean:
+  #
+  # 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 -)"
+  eval "$(pyenv virtualenv-init -)"
+  set -u
+}
+
+ensure_pyenv() {
+  if ! type pyenv >/dev/null 2>&1 && ! [ -f "${HOME}/.pyenv/bin/pyenv" ]
+  then
+    install_pyenv
+  fi
+
+  if ! type pyenv >/dev/null 2>&1
+  then
+    set_pyenv_env_variables
+  fi
+}
+
+install_package() {
+  homebrew_package=${1:?homebrew package}
+  apt_package=${2:-${homebrew_package}}
+  if [ "$(uname)" == "Darwin" ]
+  then
+    HOMEBREW_NO_AUTO_UPDATE=1 brew install "${homebrew_package}"
+  elif type apt-get >/dev/null 2>&1
+  then
+    sudo apt-get update -y
+    sudo apt-get install -y "${apt_package}"
+  else
+    >&2 echo "Teach me how to install packages on this plaform"
+    exit 1
+  fi
+}
+
+ensure_python_build_requirements() {
+  ensure_dev_library zlib.h zlib zlib1g-dev
+  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
+}
+
+# You can find out which feature versions are still supported / have
+# been release here: https://www.python.org/downloads/
+ensure_python_versions() {
+  # You can find out which feature versions are still supported / have
+  # been release here: https://www.python.org/downloads/
+  python_versions="$(latest_python_version 3.9)"
+
+  echo "Latest Python versions: ${python_versions}"
+
+  ensure_python_build_requirements
+
+  for ver in $python_versions
+  do
+    if [ "$(uname)" == Darwin ]
+    then
+      pyenv_install() {
+        CFLAGS="-I/usr/local/opt/zlib/include -I/usr/local/opt/bzip2/include" LDFLAGS="-L/usr/local/opt/zlib/lib -L/usr/local/opt/bzip2/lib" pyenv install --skip-existing "$@"
+      }
+
+      major_minor="$(cut -d. -f1-2 <<<"${ver}")"
+      if [ "${major_minor}" == 3.6 ]
+      then
+        pyenv_install --patch "${ver}" < <(curl -sSL https://github.com/python/cpython/commit/8ea6353.patch\?full_index=1)
+      else
+        pyenv_install "${ver}"
+      fi
+    else
+      pyenv install -s "${ver}"
+    fi
+  done
+}
+
+ensure_pyenv_virtualenvs() {
+  latest_python_version="$(cut -d' ' -f1 <<< "${python_versions}")"
+  virtualenv_name="checkoff-${latest_python_version}"
+  pyenv virtualenv "${latest_python_version}" "${virtualenv_name}" || true
+  # You can use this for your global stuff!
+  pyenv virtualenv "${latest_python_version}" mylibs || true
+  # shellcheck disable=SC2086
+  pyenv local "${virtualenv_name}" ${python_versions} mylibs
+}
+
+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'
+}
+
+ensure_python_requirements() {
+  pip install -r requirements_dev.txt
+}
+
+ensure_shellcheck() {
+  if ! type shellcheck >/dev/null 2>&1
+  then
+    install_package shellcheck
+  fi
+}
+
+ensure_rbenv
+
+ensure_ruby_versions
+
+set_ruby_local_version
+
+ensure_bundle
+
+ensure_pyenv
+
+ensure_python_versions
+
+ensure_pyenv_virtualenvs
+
+ensure_pip
+
+ensure_python_requirements
+
+ensure_shellcheck

data/lib/checkoff/cli.rb

@@ -12,6 +12,7 @@ require_relative 'sections'
 
 module Checkoff
   # Provide ability for CLI to pull Asana items
+  # rubocop:disable Metrics/ClassLength
   class CLI
     attr_reader :sections, :stderr
 
@@ -86,6 +87,7 @@ module Checkoff
       subargs.task_name = args[2]
     end
 
+    # rubocop:disable Metrics/MethodLength
     def parse_args(args)
       mode = args[0]
       subargs = OpenStruct.new
@@ -99,6 +101,7 @@ module Checkoff
       end
       [mode, subargs]
     end
+    # rubocop:enable Metrics/MethodLength
 
     def output_help
       stderr.puts 'View tasks:'
@@ -110,6 +113,10 @@ module Checkoff
     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)
@@ -131,4 +138,5 @@ module Checkoff
       end
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/checkoff/config_loader.rb

@@ -4,12 +4,52 @@ require 'yaml'
 require 'active_support/core_ext/hash'
 
 module Checkoff
+  # Use the provided config from a YAML file, and fall back to env
+  # variable if it's not populated for a key'
+  class EnvFallbackConfigLoader
+    def initialize(config, sym, yaml_filename)
+      @config = config
+      @envvar_prefix = sym.upcase
+      @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?
+
+      ENV[envvar_name(key)]
+    end
+
+    def fetch(key)
+      out = self[key]
+      return out unless out.nil?
+
+      raise KeyError,
+            "Please configure either the #{key} key in #{@yaml_filename} or set #{envvar_name(key)}"
+    end
+  end
+
   # Load configuration file
   class ConfigLoader
-    def self.load(sym)
+    def self.yaml_filename(sym)
       file = "#{sym}.yml"
-      YAML.load_file(File.expand_path("~/.#{file}"))
-          .with_indifferent_access
+      File.expand_path("~/.#{file}")
+    end
+
+    def self.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))
     end
   end
 end

data/lib/checkoff/projects.rb

@@ -49,10 +49,10 @@ module Checkoff
     end
 
     def my_tasks(workspace_name)
-      my_tasks = @config[:my_tasks]
-      gid = @config[:my_tasks][workspace_name] unless my_tasks.nil?
-      raise "Please define [:my_tasks][#{workspace_name}] in config file" if my_tasks.nil? || gid.nil?
-
+      workspace = @workspaces.workspace_by_name(workspace_name)
+      result = client.user_task_lists.get_user_task_list_for_user(user_gid: 'me',
+                                                                  workspace: workspace.gid)
+      gid = result.gid
       projects.find_by_id(gid)
     end
 
@@ -77,7 +77,7 @@ module Checkoff
         per_page: 100,
         options: {
           fields: %w[name completed_at due_at due_on assignee_status tags
-                     memberships.project.gid memberships.section.name],
+                     memberships.project.gid memberships.section.name dependencies],
         },
       }
     end

data/lib/checkoff/sections.rb

@@ -4,6 +4,7 @@ require 'forwardable'
 
 module Checkoff
   # Query different sections of Asana projects
+  # rubocop:disable Metrics/ClassLength
   class Sections
     MINUTE = 60
     LONG_CACHE_TIME = MINUTE * 15
@@ -11,12 +12,14 @@ module Checkoff
 
     extend Forwardable
 
-    attr_reader :projects, :time
+    attr_reader :projects, :workspaces, :time
 
     def initialize(config: Checkoff::ConfigLoader.load(:asana),
                    projects: Checkoff::Projects.new(config: config),
+                   workspaces: Checkoff::Workspaces.new(config: config),
                    time: Time)
       @projects = projects
+      @workspaces = workspaces
       @time = time
     end
 
@@ -26,7 +29,7 @@ module Checkoff
       membership = task.memberships.find { |m| m['project']['gid'] == project_gid }
       raise "Could not find task in project_gid #{project_gid}: #{task}" if membership.nil?
 
-      current_section = membership.section.name
+      current_section = membership['section']['name']
       current_section = nil if current_section == '(no section)'
       by_section[current_section] ||= []
       by_section[current_section] << task
@@ -41,6 +44,12 @@ module Checkoff
     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)
@@ -68,12 +77,12 @@ module Checkoff
       by_section
     end
 
-    def tasks_by_section_for_project_and_assignee_status(project,
-                                                         assignee_status)
+    def legacy_tasks_by_section_for_project_and_assignee_status(project,
+                                                                assignee_status)
       raw_tasks = projects.tasks_from_project(project)
       by_assignee_status =
         projects.active_tasks(raw_tasks)
-                .group_by(&:assignee_status)
+          .group_by(&:assignee_status)
       active_tasks = by_assignee_status[assignee_status]
       legacy_by_section(active_tasks)
     end
@@ -87,20 +96,48 @@ module Checkoff
       project
     end
 
+    def verify_legacy_user_task_list!(workspace_name)
+      return unless user_task_list_migrated_to_real_sections?(workspace_name)
+
+      raise NotImplementedError, 'Section-based user task lists not yet supported'
+    end
+
+    ASSIGNEE_STATUS_BY_PROJECT_NAME = {
+      my_tasks_new: 'inbox',
+      my_tasks_today: 'today',
+      my_tasks_upcoming: 'upcoming',
+    }.freeze
+
+    def user_task_list_by_section(workspace_name, project_name)
+      verify_legacy_user_task_list!(workspace_name)
+
+      project = projects.project(workspace_name, project_name)
+      if project_name == :my_tasks
+        legacy_tasks_by_section_for_project(project)
+      else
+        legacy_tasks_by_section_for_project_and_assignee_status(project,
+                                                                ASSIGNEE_STATUS_BY_PROJECT_NAME.fetch(project_name))
+      end
+    end
+
+    # rubocop:disable Metrics/MethodLength
     def tasks_by_section(workspace_name, project_name)
       project = project_or_raise(workspace_name, project_name)
       case project_name
+      when :my_tasks
+        user_task_list_by_section(workspace_name, project_name)
       when :my_tasks_new
-        tasks_by_section_for_project_and_assignee_status(project, 'inbox')
+        user_task_list_by_section(workspace_name, project_name)
       when :my_tasks_today
-        tasks_by_section_for_project_and_assignee_status(project, 'today')
+        user_task_list_by_section(workspace_name, project_name)
       when :my_tasks_upcoming
-        tasks_by_section_for_project_and_assignee_status(project, '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
+    # rubocop:enable Metrics/MethodLength
 
     # XXX: Rename to section_tasks
     def tasks(workspace_name, project_name, section_name)
@@ -120,6 +157,13 @@ module Checkoff
     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',
+                                                                  workspace: workspace.gid)
+      result.migration_status != 'not_migrated'
+    end
+
     def task_due?(task)
       if task.due_at
         Time.parse(task.due_at) <= time.now
@@ -143,4 +187,5 @@ module Checkoff
     end
     cache_method :project_task_names, SHORT_CACHE_TIME
   end
+  # rubocop:enable Metrics/ClassLength
 end