checkoff 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4eeb7148c4b835088d3fedc674bf3195b92c9889bfe935a745b50e0b7228c65
-  data.tar.gz: 2a48471aae38c5ed10bed024968bb51ccd772f1e1efe3acd70b7a4c92bbb59ae
+  metadata.gz: 28bce7b1402a371b87f03a468cb1678cd02f7631a2a8f195a544b2bccc4af26e
+  data.tar.gz: f645e96e4526173f33e7b3140d9fec84b59330a4050819467a4456f0b9e10679
 SHA512:
-  metadata.gz: cf4c95afee408b7937ea09c543c21e50b2855eba0393d9ac542e8d67f4eeb9c02c67b82cb23b7b00a81ca09f9678fafbe294baf947d3fcf1418ecd0208947298
-  data.tar.gz: 3ec3e6ef6b0a6c1583a96326cd0fa545b500f61e21ddc97624aeab31dadcd9125928d2bc78bbb8e7ec2827837d700ab651d5bb26a201ddf2a14acb862c246777
+  metadata.gz: 1503cc4b41f8297a806b57311c2f7f3e0e6d7b93027109125c985b4dba056e2709fdcec43d5ca312f9778ba044d67c28e8a5c055a692b7067ebf442491de912e
+  data.tar.gz: 1b30b11537a9608e84ec1434c67a47579e0d6d2a8a88ee79084de24efc39c18e8b10fc1af5be5ccf7b4aac17509b4b16d540d2f4f2304b61f3100b0006ff2af4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    checkoff (0.11.1)
+    checkoff (0.12.0)
       activesupport
       asana (> 0.10.0)
       cache_method
@@ -11,7 +11,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.2)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -31,25 +31,29 @@ GEM
     concurrent-ruby (1.1.9)
     dalli (2.7.11)
     docile (1.4.0)
-    faraday (1.4.2)
+    faraday (1.5.1)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
       faraday-net_http (~> 1.0)
       faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
       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-httpclient (1.0.1)
     faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.1.0)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
     faraday_middleware-multi_json (0.0.6)
       faraday_middleware
       multi_json
-    gli (2.20.0)
+    gli (2.20.1)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     imagen (0.1.8)
@@ -96,7 +100,7 @@ GEM
     rubocop-rake (0.5.1)
       rubocop
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.4)
+    ruby2_keywords (0.0.5)
     rugged (1.1.0)
     simplecov (0.21.2)
       docile (~> 1.1)
@@ -136,4 +140,4 @@ DEPENDENCIES
   undercover
 
 BUNDLED WITH
-   2.2.19
+   2.2.24

data/README.md

@@ -12,7 +12,7 @@ $ checkoff --help
 View tasks:
   checkoff view workspace project [section]
 
-'project' can be set to a project name, or :my_tasks, :my_tasks_upcoming, :my_tasks_new, or :my_tasks_today
+'project' can be set to a project name, or :my_tasks for your user task list.
 ```
 
 Let's say we have a project like this:

data/coverage/.last_run.json

@@ -1,6 +1,6 @@
 {
   "result": {
-    "line": 94.61,
-    "branch": 71.42
+    "line": 97.0,
+    "branch": 80.95
   }
 }

data/lib/checkoff/projects.rb

@@ -35,6 +35,17 @@ module Checkoff
       @workspaces.client
     end
 
+    # Default options used in Asana API to pull taskso
+    def task_options
+      {
+        per_page: 100,
+        options: {
+          fields: %w[name completed_at due_at due_on tags
+                     memberships.project.gid memberships.section.name dependencies],
+        },
+      }
+    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')
@@ -84,15 +95,5 @@ module Checkoff
       gid = result.gid
       projects.find_by_id(gid)
     end
-
-    def task_options
-      {
-        per_page: 100,
-        options: {
-          fields: %w[name completed_at due_at due_on assignee_status tags
-                     memberships.project.gid memberships.section.name dependencies],
-        },
-      }
-    end
   end
 end

data/lib/checkoff/sections.rb

@@ -4,7 +4,6 @@ require 'forwardable'
 
 module Checkoff
   # Query different sections of Asana projects
-  # rubocop:disable Metrics/ClassLength
   class Sections
     MINUTE = 60
     LONG_CACHE_TIME = MINUTE * 15
@@ -23,118 +22,74 @@ 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)
+    # Returns a list of Asana API section objects for a given project
+    def sections_or_raise(workspace_name, project_name)
+      project = project_or_raise(workspace_name, project_name)
+      client.sections.get_sections_for_project(project_gid: 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
+      tasks_by_section_for_project(project)
     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, [])
+    def tasks(workspace_name, project_name, section_name,
+              only_uncompleted: true,
+              extra_fields: [])
+      section = section_or_raise(workspace_name, project_name, section_name)
+      options = projects.task_options
+      # asana-0.10.3 gem doesn't support per_page - not sure if API
+      # itself does
+      options.delete(:per_page)
+      options[:options][:fields] += extra_fields
+      client.tasks.get_tasks_for_section(section_gid: section.gid,
+                                         **options).to_a
     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)
-      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 = nil if current_section == '(no section)'
-      by_section[current_section] ||= []
-      by_section[current_section] << task
-    end
-
-    def legacy_tasks_by_section_for_project(project)
+    # 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)
-      legacy_by_section(active_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
-        by_section[current_section] = []
-      else
-        by_section[current_section] ||= []
-        by_section[current_section] << task
-      end
-      [current_section, by_section]
-    end
+    def_delegators :@projects, :client
 
-    def legacy_by_section(tasks)
-      current_section = nil
+    # 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|
-        current_section, by_section =
-          legacy_file_task_by_section(current_section, by_section, 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_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)
-      active_tasks = by_assignee_status[assignee_status]
-      legacy_by_section(active_tasks)
+    def file_task_by_section(by_section, task, 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 = nil if current_section == '(no section)'
+      by_section[current_section] ||= []
+      by_section[current_section] << task
     end
 
     def project_or_raise(workspace_name, project_name)
@@ -146,49 +101,20 @@ 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'
+    def section(workspace_name, project_name, section_name)
+      sections = sections_or_raise(workspace_name, project_name)
+      sections.find { |section| section.name.chomp(':') == section_name.chomp(':') }
     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 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 section_or_raise(workspace_name, project_name, section_name)
+      section = section(workspace_name, project_name, section_name)
+      if section.nil?
+        valid_sections = sections_or_raise(workspace_name, project_name).map(&:name)
 
-    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|
-        task_names = tasks.map(&:name)
-        if section_name.nil?
-          task_names
-        else
-          [section_name, task_names]
-        end
+        raise "Could not find section #{section_name} under project #{project_name} " \
+              "under workspace #{workspace_name}.  Valid sections: #{valid_sections}"
       end
+      section
     end
-    cache_method :project_task_names, SHORT_CACHE_TIME
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/checkoff/tasks.rb

@@ -54,10 +54,6 @@ module Checkoff
       @projects ||= @sections.projects
     end
 
-    def tasks_minus_sections(tasks)
-      @sections.by_section(tasks).values.flatten
-    end
-
     def default_assignee_gid
       @config.fetch(:default_assignee_gid)
     end

data/lib/checkoff/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-11 00:00:00.000000000 Z
+date: 2021-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport