checkoff 0.5.5 → 0.10.0

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,7 +113,11 @@ module Checkoff
     end
 
     def view(workspace_name, project_name, section_name)
-      project_name = project_name[1..-1].to_sym if project_name.start_with? ':'
+      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
@@ -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
 
@@ -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,15 +96,35 @@ 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
+
     def tasks_by_section(workspace_name, project_name)
       project = project_or_raise(workspace_name, project_name)
       case project_name
-      when :my_tasks_new
-        tasks_by_section_for_project_and_assignee_status(project, 'inbox')
-      when :my_tasks_today
-        tasks_by_section_for_project_and_assignee_status(project, 'today')
-      when :my_tasks_upcoming
-        tasks_by_section_for_project_and_assignee_status(project, 'upcoming')
+      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
@@ -104,7 +133,7 @@ module Checkoff
 
     # XXX: Rename to section_tasks
     def tasks(workspace_name, project_name, section_name)
-      tasks_by_section(workspace_name, project_name)[section_name]
+      tasks_by_section(workspace_name, project_name).fetch(section_name, [])
     end
     cache_method :tasks, SHORT_CACHE_TIME
 
@@ -120,6 +149,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 +179,5 @@ module Checkoff
     end
     cache_method :project_task_names, SHORT_CACHE_TIME
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/checkoff/tasks.rb

@@ -50,7 +50,7 @@ module Checkoff
     end
 
     def default_assignee_gid
-      @config[:default_assignee_gid]
+      @config.fetch(:default_assignee_gid)
     end
   end
 end

data/lib/checkoff/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Checkoff
-  VERSION = '0.5.5'
+  VERSION = '0.10.0'
 end

data/lib/checkoff/workspaces.rb

@@ -11,19 +11,20 @@ module Checkoff
 
     def client
       @client ||= @asana_client.new do |c|
-        c.authentication :access_token, @config[:personal_access_token]
+        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'
       end
     end
 
     def default_workspace_gid
-      @config[:default_workspace_gid]
+      @config.fetch(:default_workspace_gid)
     end
 
     def workspace_by_name(workspace_name)
       client.workspaces.find_all.find do |workspace|
         workspace.name == workspace_name
-      end || raise("Could not find workspace #{workspace_name}")
+      end || raise("Could not find workspace named [#{workspace_name}]")
     end
   end
 end

data/metrics/bigfiles_high_water_mark

@@ -1 +1 @@
-414
+488

data/metrics/rubocop_high_water_mark

@@ -1 +1 @@
-4
+6

data/{lib/tasks → rakelib}/clear_metrics.rake

@@ -3,6 +3,6 @@
 desc 'Rebaseline quality thresholds to last commit'
 task :clear_metrics do |_t|
   ret =
-    system('git checkout coverage/.last_run.json metrics/*_high_water_mark')
+    system('git checkout coverage/.last_run.json')
   raise unless ret
 end

data/rakelib/gem_tasks.rake

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/{lib/tasks → rakelib}/localtest.rake

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
 desc 'Standard build when running on a workstation'
-task localtest: %i[clear_metrics test quality]
+task localtest: %i[clear_metrics test undercover quality]

data/rakelib/overcommit.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+desc 'Run overcommit on current code'
+task :overcommit do
+  sh 'overcommit --run'
+end

data/rakelib/quality.rake

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+desc 'Run quality checks'
+task quality: :overcommit

data/rakelib/undercover.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+desc 'Ensure PR changes are fully covered by tests'
+task :undercover do |_t|
+  ret =
+    system('undercover --compare origin/main')
+  raise unless ret
+end

data/requirements_dev.txt

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.10.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2021-05-11 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: bump
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -109,19 +123,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: quality
+  name: overcommit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '38'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '38'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -137,19 +151,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
+  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: rubocop-minitest
+  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: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: undercover
+  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'
 description:
 email:
 - vince@broz.cc
@@ -173,22 +229,32 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".envrc"
+- ".git-hooks/pre_commit/circle_ci.rb"
 - ".gitignore"
+- ".overcommit.yml"
 - ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
+- ".yamllint.yml"
 - CODE_OF_CONDUCT.md
+- DEVELOPMENT.md
 - Gemfile
-- LICENSE.txt
+- Gemfile.lock
+- LICENSE
 - Makefile
 - README.md
 - Rakefile
+- bin/bump
+- bin/checkoff
 - bin/console
+- bin/overcommit
+- bin/rake
 - bin/setup
 - checkoff.gemspec
 - coverage/.last_run.json
+- docs/cookiecutter_input.json
 - docs/example_project.png
 - exe/checkoff
+- fix.sh
 - lib/checkoff.rb
 - lib/checkoff/cli.rb
 - lib/checkoff/config_loader.rb
@@ -198,14 +264,6 @@ files:
 - lib/checkoff/tasks.rb
 - lib/checkoff/version.rb
 - lib/checkoff/workspaces.rb
-- lib/tasks/ci.rake
-- lib/tasks/clear_metrics.rake
-- lib/tasks/default.rake
-- lib/tasks/feature.rake
-- lib/tasks/localtest.rake
-- lib/tasks/quality.rake
-- lib/tasks/spec.rake
-- lib/tasks/test.rake
 - metrics/bigfiles_high_water_mark
 - metrics/brakeman_high_water_mark
 - metrics/bundle-audit_high_water_mark
@@ -223,9 +281,19 @@ files:
 - metrics/rubocop_high_water_mark
 - metrics/scalastyle_high_water_mark
 - metrics/shellcheck_high_water_mark
-homepage: http://github.com/apiology/checkoff
+- rakelib/ci.rake
+- rakelib/clear_metrics.rake
+- rakelib/default.rake
+- rakelib/gem_tasks.rake
+- rakelib/localtest.rake
+- rakelib/overcommit.rake
+- rakelib/quality.rake
+- rakelib/test.rake
+- rakelib/undercover.rake
+- requirements_dev.txt
+homepage: https://github.com/apiology/checkoff
 licenses:
-- MIT
+- MIT license
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -235,14 +303,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Command-line and gem client for Asana (unofficial)