checkoff 0.5.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c4947b2573662cc82bf0fd8652c9efc13169326fb70952e3794aecd3a071a1c
-  data.tar.gz: 97d4f7ec0a0781a62750462fc0a7428980f06a6d084c029b832897f854fd3d32
+  metadata.gz: 834d9600b69c5f79ba30cbf22a79c66d0a277d517cafe6c2aee32de1c63bb533
+  data.tar.gz: 5cb97edadfd9aca288f6f1e5d95400c0e291306ffd2f3a76ad003560539b88cb
 SHA512:
-  metadata.gz: 02e3a309b680887411309fa3f33d8f14a325889f1bfbf5c18790cec9ab20aa80a0e71ab38fdcfa7eefe523474dd2a56bf0443b3523fc0cb0bd90719dd380fcf9
-  data.tar.gz: 22f2339cda88ee9ee63d6009e945d29bf2a7d9b552b0eae3d2a39892bc1f85e3ce373afd341fde97d24719ad89fbf804250fd4450761a4920ab00bc0e17b465d
+  metadata.gz: 83050b84c4cc44b0c5992174cfe8f837f985dd361627ed60e81466f9cb14713b87d14508c9d46d997e9887c8944557252a64bd79f3354c04285c852758fd5021
+  data.tar.gz: '083875c0f26f4309170d036ccec8dc3bb970ddf276916f1744ac0bd1285055de662ac7b29054bceba10fe82baba0ef319731ab32de522fb773a3af824ba687c1'

data/.envrc

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

data/.overcommit.yml

@@ -0,0 +1,40 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+  RuboCop:
+    enabled: true
+    on_warn: fail # Treat all warnings as failures
+#
+#  TrailingWhitespace:
+#    enabled: true
+#    exclude:
+#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+#
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#    quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes
+
+PrePush:
+  Minitest:
+    command: ['ruby', '-Ilib:test/unit:lib/checkoff', '-rbundler/setup', '-rminitest', "-e 'exit! Minitest.run'"]
+    include:
+      - 'test/unit/**/test*.rb'
+    enabled: true

data/.rubocop.yml

@@ -194,7 +194,9 @@ RSpec/StubbedMock: # (new in 1.44)
   Enabled: true
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.5
+  Exclude:
+    - 'bin/*'
 
 require:
   - rubocop-rspec

data/.travis.yml

@@ -10,8 +10,13 @@ rvm:
   # checking for main() in -lstdc++... RuntimeError: The compiler failed to generate
   # https://travis-ci.com/apiology/pronto-punchlist/jobs/264907931
   # - jruby-head
-  - ruby-head
+
+  # These are currently pending ruby-asana fixes:
+  #
+  # https://github.com/Asana/ruby-asana/pull/99
+  #
+  # - ruby-head
+  # - ruby-3.0
   - ruby-2.7
   - ruby-2.6
   - ruby-2.5
-  - ruby-2.4

data/README.md

@@ -126,6 +126,8 @@ my_tasks:
 personal_access_token: 'some_big_long_string_from_asana.com_here'
 ```
 
+Alternately you can set environment variables to match - e.g., `ASANA__PERSONAL_ACCESS_TOKEN`
+
 ## Developing
 
 ```bash

data/bin/checkoff

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'checkoff' 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("checkoff", "checkoff")

data/checkoff.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Command-line and gem client for Asana (unofficial)'
   spec.homepage      = 'http://github.com/apiology/checkoff'
   spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 2.6'
+  spec.required_ruby_version = '>= 2.5'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'minitest-profile'
   spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'overcommit'
   spec.add_development_dependency 'quality', '~> 38'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '>=3.4'

data/coverage/.last_run.json

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

data/lib/checkoff/cli.rb

@@ -110,7 +110,11 @@ module Checkoff
     end
 
     def view(workspace_name, project_name, section_name)
-      project_name = project_name[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..-1].to_sym if project_name.start_with? ':'
       if section_name.nil?
         run_on_project(workspace_name, project_name)
       else

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,8 +49,8 @@ module Checkoff
     end
 
     def my_tasks(workspace_name)
-      my_tasks = @config[:my_tasks]
-      gid = @config[:my_tasks][workspace_name] unless my_tasks.nil?
+      my_tasks = @config.fetch(:my_tasks)
+      gid = my_tasks[workspace_name] unless my_tasks.nil?
       raise "Please define [:my_tasks][#{workspace_name}] in config file" if my_tasks.nil? || gid.nil?
 
       projects.find_by_id(gid)
@@ -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

@@ -11,22 +11,24 @@ 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
 
     def_delegators :@projects, :client
 
     def file_task_by_section(by_section, task, project_gid)
-      membership = task.memberships.find { |m| m.project.gid == project_gid }
+      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 +43,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,8 +76,8 @@ 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)
@@ -87,15 +95,40 @@ 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)
+
+      if project_name == :my_tasks
+        legacy_tasks_by_section_for_project(project_name)
+      else
+        legacy_tasks_by_section_for_project_and_assignee_status(project_name,
+                                                                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
+        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
@@ -120,6 +153,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

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.3'
+  VERSION = '0.8.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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.8.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-19 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  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: quality
   requirement: !ruby/object:Gem::Requirement
@@ -173,7 +187,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".envrc"
 - ".gitignore"
+- ".overcommit.yml"
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
@@ -183,6 +199,7 @@ files:
 - Makefile
 - README.md
 - Rakefile
+- bin/checkoff
 - bin/console
 - bin/setup
 - checkoff.gemspec
@@ -235,7 +252,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="