checkoff 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73dc8e8ee25d08cf3457dac6284c7a7ab5476db7d3e1fadbe66d75a1f0546297
-  data.tar.gz: 623ea9cd3331007bb831d72d14e063d9f92751eda5b1819270e69edb4ff7ca2e
+  metadata.gz: 6077fb7e61bc4ca3d3853df3df9aa8321e1638b413c2913eec541e8ae94defe7
+  data.tar.gz: 809c7d2cb26099cef0816719f9cf3491e179d8a8c44b3b1e72d51af46ae98a85
 SHA512:
-  metadata.gz: dd1155bea5724f05e4b1b6f12c172358ccb49d000bf1c22e77663df3b1239d442730c5879d116b4cca411a3a57f4acbf09fee5fa8b9b33c0537179e31601a8b3
-  data.tar.gz: d5e1f8a9aadaffbaf9cd18d8ba976d368b1eec6edd1e829bfa5b42780ee34cddbf661207c3554a9665eec07bce553db9b7a2c19e1e899f7e34df82efd9d7a64d
+  metadata.gz: e8ed5e0dadd2384438b286d0f53a306d1e9f67b6253531e7f19f7809cdc59849b3562ea45d858c87725a532a2305650c5291d057545432a5e0eeeefc9060e9d0
+  data.tar.gz: b1f75a997bda89f8aaca31e1049f74a08d81da53f0495325503dba3114910daf5b9d8c4ae9fbc1428fece772253fb7dc2510708f61cdf7fa877b8a4df71e34e0

data/.circleci/config.yml

@@ -110,6 +110,8 @@ jobs:
             git status --porcelain coverage/.last_run.json
             git diff coverage/.last_run.json
             test -z "$(git status --porcelain coverage/.last_run.json)"
+    # This seemed to shave 5ish% of the build time off when added
+    resource_class: large
 
 workflows:
   version: 2

data/.envrc

@@ -1,2 +1,3 @@
+# shellcheck shell=bash
 PATH_add bin
-eval $(with-op op-env sh -e ASANA__PERSONAL_ACCESS_TOKEN -e ASANA__DEFAULT_ASSIGNEE_GID)
+eval "$(with-op op-env sh -e ASANA__PERSONAL_ACCESS_TOKEN -e ASANA__DEFAULT_ASSIGNEE_GID)"

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

@@ -42,6 +42,9 @@ Temporary Items
 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

data/.overcommit.yml

@@ -35,6 +35,8 @@ PreCommit:
   ShellCheck:
     enabled: true
     on_warn: fail
+    include:
+      - '.envrc'
   YamlLint:
     enabled: true
     on_warn: fail

data/.rubocop.yml

@@ -101,6 +101,7 @@ AllCops:
   TargetRubyVersion: 2.6
   Exclude:
     - 'bin/*'
+    - 'vendor/**/*'
 
 require:
   - rubocop-rake

data/DEVELOPMENT.md

@@ -16,6 +16,36 @@ quality checks.  `bundle exec overcommit --install` will install it.
 This project uses direnv to manage environment variables used during
 development.  See the `.envrc` file for detail.
 
+## cache_method
+
+Checkoff uses the
+[`cache_method`](https://github.com/seamusabshere/cache_method) gem to
+cache results between invocations.  Configuration details can be found
+[here](https://github.com/seamusabshere/cache_method#configuration-and-supported-cache-clients).
+By default a memcached client on the default port (11211) on the host
+`memcached` will be used.
+
+You can run memcached locally on macOS with Homebrew by running:
+
+```sh
+brew install memcached
+brew services start memcached
+```
+
+You may want to add a `memcached` alias for `127.0.0.1` in `/etc/hosts`.
+
+Please make sure this is only listening on loopback for security, of course.
+
+
+## gli
+
+Checkoff uses [`gli`](https://github.com/davetron5000/gli) on the CLI.
+To get a full stack trace when encountering a problem, run as follows:
+
+```sh
+GLI_DEBUG=true checkoff your-arguments-here
+```
+
 ## Publishing
 
 To publish new version as a maintainer:

data/Gemfile.lock

@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    checkoff (0.15.0)
+    checkoff (0.16.0)
       activesupport
       asana (> 0.10.0)
       cache_method
@@ -22,7 +22,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4)
+    activesupport (6.1.5.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -35,8 +35,8 @@ GEM
       cache (>= 0.2.1)
     childprocess (4.0.0)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
-    dalli (2.7.11)
+    concurrent-ruby (1.1.10)
+    dalli (3.2.1)
     docile (1.4.0)
     faraday (1.5.1)
       faraday-em_http (~> 1.0)
@@ -60,15 +60,15 @@ GEM
     faraday_middleware-multi_json (0.0.6)
       faraday_middleware
       multi_json
-    gli (2.20.1)
-    i18n (1.8.10)
+    gli (2.21.0)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     imagen (0.1.8)
       parser (>= 2.5, != 2.5.1.1)
     iniparse (1.5.0)
     jwt (2.2.3)
     method_source (1.0.0)
-    minitest (5.14.4)
+    minitest (5.15.0)
     minitest-profile (0.0.2)
     mocha (1.12.0)
     multi_json (1.15.0)
@@ -127,7 +127,7 @@ GEM
       rainbow (>= 2.1, < 4.0)
       rugged (>= 0.27, < 1.2)
     unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby
@@ -153,4 +153,4 @@ DEPENDENCIES
   undercover
 
 BUNDLED WITH
-   2.2.24
+   2.2.25

data/Makefile

@@ -15,7 +15,7 @@ export PRINT_HELP_PYSCRIPT
 help:
 	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
 
-default: localtest ## run default typechecking and tests
+default: localtest ## run default tests and quality
 
 requirements_dev.txt.installed: requirements_dev.txt
 	pip install -q --disable-pip-version-check -r requirements_dev.txt
@@ -50,6 +50,9 @@ test: ## Run lower-level tests
 localtest: ## run default local actions
 	@bundle exec rake localtest
 
+repl:  ## Load up checkoff in pry
+	@bundle exec rake repl
+
 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

data/README.md

@@ -98,10 +98,6 @@ $
 Since checkoff looks up things by their name, if you have two things
 with the same name, you're probably going to have a bad time.
 
-If you need to talk about the section of a project which contains
-tasks that don't have a section, use `Untitled section` as the name.
-This is a quirk of the Asana API which seemed as good as any other idea.
-
 ## Caching
 
 Note that I don't know of a way through the Asana API to target

data/coverage/.last_run.json

@@ -1,6 +1,6 @@
 {
   "result": {
     "line": 99.78,
-    "branch": 95.34
+    "branch": 94.31
   }
 }

data/fix.sh

@@ -7,7 +7,7 @@ apt_upgraded=0
 update_apt() {
   if [ "${apt_upgraded}" = 0 ]
   then
-    sudo apt-get update -y
+    sudo DEBIAN_FRONTEND=noninteractive apt-get update -y
     apt_upgraded=1
   fi
 }
@@ -243,7 +243,7 @@ install_package() {
   elif type apt-get >/dev/null 2>&1
   then
     update_apt
-    sudo apt-get install -y "${apt_package}"
+    sudo DEBIAN_FRONTEND=noninteractive apt-get install -y "${apt_package}"
   else
     >&2 echo "Teach me how to install packages on this plaform"
     exit 1
@@ -257,7 +257,7 @@ ensure_python_build_requirements() {
   ensure_dev_library ffi.h libffi libffi-dev
   ensure_dev_library sqlite3.h sqlite3 libsqlite3-dev
   ensure_dev_library lzma.h xz liblzma-dev
-  ensure_dev_library readline.h readline libreadline-dev
+  ensure_dev_library readline/readline.h readline libreadline-dev
 }
 
 # You can find out which feature versions are still supported / have
@@ -275,8 +275,12 @@ ensure_python_versions() {
   do
     if [ "$(uname)" == Darwin ]
     then
+      if [ -z "${HOMEBREW_OPENSSL_PREFIX:-}" ]
+      then
+        HOMEBREW_OPENSSL_PREFIX="$(brew --prefix openssl)"
+      fi
       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 "$@"
+        CFLAGS="-I/usr/local/opt/zlib/include -I/usr/local/opt/bzip2/include -I${HOMEBREW_OPENSSL_PREFIX}/include" LDFLAGS="-L/usr/local/opt/zlib/lib -L/usr/local/opt/bzip2/lib -L${HOMEBREW_OPENSSL_PREFIX}/lib" pyenv install --skip-existing "$@"
       }
 
       major_minor="$(cut -d. -f1-2 <<<"${ver}")"

data/lib/checkoff/cli.rb

@@ -211,7 +211,7 @@ module Checkoff
     end
 
     def run
-      workspace = @workspaces.workspace_by_name(workspace_name)
+      workspace = @workspaces.workspace_or_raise(workspace_name)
       @tasks.add_task(task_name,
                       workspace_gid: workspace.gid)
     end

data/lib/checkoff/clients.rb

@@ -27,8 +27,7 @@ module Checkoff
     def client
       @client ||= @asana_client_class.new do |c|
         c.authentication :access_token, @config.fetch(:personal_access_token)
-        c.default_headers 'asana-enable' => 'string_ids,new_sections'
-        c.default_headers 'asana-disable' => 'new_user_task_lists'
+        c.default_headers 'asana-enable' => 'new_project_templates'
       end
     end
 

data/lib/checkoff/create-entity.sh

@@ -48,7 +48,7 @@ module Checkoff
     cache_method :${underscored_singular_name}_or_raise, LONG_CACHE_TIME
 
     def ${underscored_singular_name}(workspace_name, ${underscored_singular_name}_name)
-      workspace = workspaces.workspace_by_name(workspace_name)
+      workspace = workspaces.workspace_or_raise(workspace_name)
       ${underscored_plural_name} = client.${underscored_plural_name}.get_${underscored_plural_name}_for_workspace(workspace_gid: workspace.gid)
       ${underscored_plural_name}.find { |${underscored_singular_name}| ${underscored_singular_name}.name == ${underscored_singular_name}_name }
     end

data/lib/checkoff/custom_fields.rb

@@ -37,7 +37,7 @@ module Checkoff
     cache_method :custom_field_or_raise, LONG_CACHE_TIME
 
     def custom_field(workspace_name, custom_field_name)
-      workspace = workspaces.workspace_by_name(workspace_name)
+      workspace = workspaces.workspace_or_raise(workspace_name)
       custom_fields = client.custom_fields.get_custom_fields_for_workspace(workspace_gid: workspace.gid)
       custom_fields.find { |custom_field| custom_field.name == custom_field_name }
     end

data/lib/checkoff/my_tasks.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require_relative 'projects'
+require_relative 'workspaces'
+require_relative 'clients'
+
+module Checkoff
+  # Query different sections of Asana 'My Tasks' projects
+  class MyTasks
+    MINUTE = 60
+    LONG_CACHE_TIME = MINUTE * 15
+    SHORT_CACHE_TIME = MINUTE * 5
+
+    attr_reader :projects
+
+    def initialize(config: Checkoff::ConfigLoader.load(:asana),
+                   projects: Checkoff::Projects.new(config: config))
+      @config = config
+      @projects = projects
+    end
+
+    # Given a 'My Tasks' 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_my_tasks(project)
+      raw_tasks = projects.tasks_from_project(project,
+                                              extra_fields: ['assignee_section.name'])
+      active_tasks = projects.active_tasks(raw_tasks)
+      by_my_tasks_section(active_tasks)
+    end
+
+    # Given a list of tasks in 'My Tasks', pull a Hash of tasks with
+    # section name -> task list
+    def by_my_tasks_section(tasks)
+      by_section = {}
+      tasks.each do |task|
+        assignee_section = task.assignee_section
+        current_section = assignee_section.name
+        by_section[current_section] ||= []
+        by_section[current_section] << task
+      end
+      by_section
+    end
+  end
+end

data/lib/checkoff/projects.rb

@@ -89,14 +89,14 @@ module Checkoff
     cache_method :projects, LONG_CACHE_TIME
 
     def projects_by_workspace_name(workspace_name)
-      workspace = @workspaces.workspace_by_name(workspace_name)
+      workspace = @workspaces.workspace_or_raise(workspace_name)
       raise "Could not find workspace named #{workspace_name}" unless workspace
 
       projects.find_by_workspace(workspace: workspace.gid)
     end
 
     def my_tasks(workspace_name)
-      workspace = @workspaces.workspace_by_name(workspace_name)
+      workspace = @workspaces.workspace_or_raise(workspace_name)
       result = client.user_task_lists.get_user_task_list_for_user(user_gid: 'me',
                                                                   workspace: workspace.gid)
       gid = result.gid

data/lib/checkoff/sections.rb

@@ -4,6 +4,7 @@ require 'forwardable'
 require_relative 'projects'
 require_relative 'workspaces'
 require_relative 'clients'
+require_relative 'my_tasks'
 
 module Checkoff
   # Query different sections of Asana projects
@@ -14,7 +15,7 @@ module Checkoff
 
     extend Forwardable
 
-    attr_reader :projects, :workspaces, :time
+    attr_reader :projects, :workspaces, :time, :my_tasks
 
     def initialize(config: Checkoff::ConfigLoader.load(:asana),
                    projects: Checkoff::Projects.new(config: config),
@@ -24,8 +25,9 @@ module Checkoff
                    time: Time)
       @projects = projects
       @workspaces = workspaces
-      @time = time
+      @my_tasks = Checkoff::MyTasks.new(config: config, projects: projects)
       @client = client
+      @time = time
     end
 
     # Returns a list of Asana API section objects for a given project
@@ -38,9 +40,12 @@ module Checkoff
     # 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)
-      tasks_by_section_for_project(project)
+      if project_name == :my_tasks
+        my_tasks.tasks_by_section_for_my_tasks(project)
+      else
+        tasks_by_section_for_project(project)
+      end
     end
-    cache_method :tasks_by_section, SHORT_CACHE_TIME
 
     # XXX: Rename to section_tasks
     #
@@ -83,7 +88,9 @@ module Checkoff
     # 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)
+      # print("project: #{project}")
       raw_tasks = projects.tasks_from_project(project)
+      # print("raw_tasks[0]: #{raw_tasks[0]}")
       active_tasks = projects.active_tasks(raw_tasks)
       by_section(active_tasks, project.gid)
     end
@@ -103,7 +110,7 @@ module Checkoff
       raise "Could not find task in project_gid #{project_gid}: #{task}" if membership.nil?
 
       current_section = membership['section']['name']
-      current_section = nil if current_section == '(no section)'
+      current_section = nil if ['(no section)', 'Untitled section'].include?(current_section)
       by_section[current_section] ||= []
       by_section[current_section] << task
     end

data/lib/checkoff/tags.rb

@@ -37,7 +37,7 @@ module Checkoff
     cache_method :tag_or_raise, LONG_CACHE_TIME
 
     def tag(workspace_name, tag_name)
-      workspace = workspaces.workspace_by_name(workspace_name)
+      workspace = workspaces.workspace_or_raise(workspace_name)
       tags = client.tags.get_tags_for_workspace(workspace_gid: workspace.gid)
       tags.find { |tag| tag.name == tag_name }
     end

data/lib/checkoff/tasks.rb

@@ -16,12 +16,15 @@ module Checkoff
 
     def initialize(config: Checkoff::ConfigLoader.load(:asana),
                    sections: Checkoff::Sections.new(config: config),
+                   clients: Checkoff::Clients.new(config: config),
+                   client: clients.client,
                    time_class: Time,
                    asana_task: Asana::Resources::Task)
       @config = config
       @sections = sections
       @time_class = time_class
       @asana_task = asana_task
+      @client = client
     end
 
     def task_ready?(task)
@@ -64,9 +67,7 @@ module Checkoff
 
     private
 
-    def client
-      @sections.client
-    end
+    attr_reader :client
 
     def projects
       @projects ||= @sections.projects

data/lib/checkoff/version.rb

@@ -2,5 +2,5 @@
 
 module Checkoff
   # Version of library
-  VERSION = '0.15.0'
+  VERSION = '0.16.0'
 end

data/requirements_dev.txt

@@ -1,2 +1,2 @@
-pip==21.0.1
+pip==21.1
 yamllint==1.26.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-17 00:00:00.000000000 Z
+date: 2022-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -273,6 +273,7 @@ files:
 - ".circleci/config.yml"
 - ".envrc"
 - ".git-hooks/pre_commit/circle_ci.rb"
+- ".gitattributes"
 - ".gitignore"
 - ".overcommit.yml"
 - ".rubocop.yml"
@@ -303,6 +304,7 @@ files:
 - lib/checkoff/config_loader.rb
 - lib/checkoff/create-entity.sh
 - lib/checkoff/custom_fields.rb
+- lib/checkoff/my_tasks.rb
 - lib/checkoff/projects.rb
 - lib/checkoff/sections.rb
 - lib/checkoff/subtasks.rb