checkoff 0.46.0 → 0.46.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a65e8d9c8d8e3012cbe1821983bc48e5151f6c666a454ce627c0084edaac8b46
-  data.tar.gz: 35f49e9a77c9409278b3f68a6c84f6afefc68727510b13ac322a1988360163af
+  metadata.gz: 5a4be48acbc5f3ab9954ca8f7ec3ef64f1c629bfbc0015f158cde7a87fcc4049
+  data.tar.gz: 1824e5607d750cc1d9b2161dc897cd4a08fd90c27fea1c4cc7a5f19ee4e2c497
 SHA512:
-  metadata.gz: 70162bcc35ac9bb35d3006e7334a0abd36c5b9853b148e3f9ae720761691bb00af8de7f065969f144c01cc5563f78c6a53e90c92f7811ab5bf269eabb30986bc
-  data.tar.gz: 3b49077f074571a0b09c7a167601ed7bc99f59707505ef10deb187215dcc059cbd1ea04cff64669ae5e7bbf2007a5d0054aeb62658129ff15e93f3a5baf87534
+  metadata.gz: 3ef67e1152d4399b8b507a6b6b6555f300ac83ffda4b998a8ae031ada997deabdd60974228db9cb01101bf319a3092a36fa259391c4fbdc6940266e1d53f923d
+  data.tar.gz: e04b024a9f4def03f62fb7a8b1498e53ed2d08cc53cff3a5b76bc7f16b6a20402a450704a7f782372b5f3438a7ecad063f1e7047b552d50a360fa7c5d1d60dbc

data/Gemfile.lock

@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    checkoff (0.46.0)
+    checkoff (0.46.1)
       activesupport
       asana (> 0.10.0)
       cache_method

data/config/definitions.rb

@@ -83,7 +83,7 @@
 #         # just because another object it is associated with (e.g. a subtask)
 #         # is modified. Actions that count as modifying the task include
 #         # assigning, renaming, completing, and adding stories.
-#         # @return [Asana::Collection<Asana::Resources::Task>]
+#         # @return [Enumerable<Asana::Resources::Task>]
 #         def find_all(assignee: nil, workspace: nil, project: nil, section: nil,
 #                      tag: nil, user_task_list: nil, completed_since: nil,
 #                      modified_since: nil, per_page: 20, options: {}); end
@@ -106,7 +106,7 @@
 #       class Section
 #         # @param project_gid [String]
 #         # @return [Enumerable<Asana::Resources::Section>]
-#         def get_sections_for_project(client, project_gid:, options: {}); end
+#         def get_sections_for_project(project_gid:, options: {}); end
 #       end
 #       class Project
 #         # Returns the compact project records for all projects in the workspace.

data/lib/checkoff/internal/search_url/date_param_converter.rb

@@ -48,9 +48,11 @@ module Checkoff
 
         # @return [void]
         def validate_due_date_through_next!
-          return if date_url_params.fetch('due_date.operator') == ['through_next']
+          due_date_operators = date_url_params.fetch('due_date.operator')
 
-          raise 'Teach me how to handle other date modes'
+          return if due_date_operators == ['through_next']
+
+          raise "Teach me how to handle date mode: #{due_date_operators}."
         end
 
         # @return [Hash<String, Array<String>>]

data/lib/checkoff/my_tasks.rb

@@ -12,8 +12,12 @@ module Checkoff
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE * 5
 
+    # @return [Checkoff::Projects]
     attr_reader :projects
 
+    # @param config [Hash<Symbol, Object>]
+    # @param client [Asana::Client]
+    # @param projects [Checkoff::Projects]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
                    client: Checkoff::Clients.new(config: config).client,
                    projects: Checkoff::Projects.new(config: config,
@@ -26,13 +30,23 @@ module Checkoff
     # 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, extra_fields: [])
+    #
+    # @param project [Asana::Resources::Project]
+    # @param only_uncompleted [Boolean]
+    # @param extra_fields [Array<String>]
+    # @return [Hash<String, Enumerable<Asana::Resources::Task>>]
+    def tasks_by_section_for_my_tasks(project,
+                                      only_uncompleted: true,
+                                      extra_fields: [])
       raw_tasks = projects.tasks_from_project(project,
+                                              only_uncompleted: only_uncompleted,
                                               extra_fields: extra_fields + ['assignee_section.name'])
       active_tasks = projects.active_tasks(raw_tasks)
       by_my_tasks_section(active_tasks, project.gid)
     end
 
+    # @param name [String]
+    # @return [String, nil]
     def section_key(name)
       return nil if name == 'Recently assigned'
 
@@ -41,10 +55,14 @@ module Checkoff
 
     # Given a list of tasks in 'My Tasks', pull a Hash of tasks with
     # section name -> task list
+    #
+    # @param tasks [Enumerable<Asana::Resources::Task>]
+    # @param project_gid [String]
+    # @return [Hash<String, Enumerable<Asana::Resources::Task>>]
     def by_my_tasks_section(tasks, project_gid)
       by_section = {}
       sections = client.sections.get_sections_for_project(project_gid: project_gid)
-      sections.each { |section| by_section[section_key(section.name)] = [] }
+      sections.each_entry { |section| by_section[section_key(section.name)] = [] }
       tasks.each do |task|
         assignee_section = task.assignee_section
         current_section = section_key(assignee_section.name)
@@ -56,6 +74,7 @@ module Checkoff
 
     private
 
+    # @return [Asana::Client]
     attr_reader :client
   end
 end

data/lib/checkoff/projects.rb

@@ -91,12 +91,14 @@ module Checkoff
     # @param [Boolean] only_uncompleted
     # @param [Array<String>] extra_fields
     # @return [Enumerable<Asana::Resources::Task>]
-    def tasks_from_project(project, only_uncompleted: true, extra_fields: [])
+    def tasks_from_project(project,
+                           only_uncompleted: true,
+                           extra_fields: [])
       options = task_options
       options[:completed_since] = '9999-12-01' if only_uncompleted
       options[:project] = project.gid
       options[:options][:fields] += extra_fields
-      client.tasks.find_all(**options).to_a
+      client.tasks.find_all(**options)
     end
     cache_method :tasks_from_project, SHORT_CACHE_TIME
 

data/lib/checkoff/sections.rb

@@ -65,17 +65,21 @@ module Checkoff
     # tasks with section name -> task list of the uncompleted tasks
     # @param workspace_name [String]
     # @param project_name [String, Symbol]
+    # @param only_uncompleted [Boolean]
     # @param extra_fields [Array<String>]
     # @return [Hash{[String, nil] => Enumerable<Asana::Resources::Task>}]
-    def tasks_by_section(workspace_name, project_name, extra_fields: [])
+    def tasks_by_section(workspace_name,
+                         project_name,
+                         only_uncompleted: true,
+                         extra_fields: [])
       raise ArgumentError, 'Provided nil workspace name' if workspace_name.nil?
       raise ArgumentError, 'Provided nil project name' if project_name.nil?
 
       project = project_or_raise(workspace_name, project_name)
       if project_name == :my_tasks
-        my_tasks.tasks_by_section_for_my_tasks(project, extra_fields: extra_fields)
+        my_tasks.tasks_by_section_for_my_tasks(project, only_uncompleted: only_uncompleted, extra_fields: extra_fields)
       else
-        tasks_by_section_for_project(project, extra_fields: extra_fields)
+        tasks_by_section_for_project(project, only_uncompleted: only_uncompleted, extra_fields: extra_fields)
       end
     end
 
@@ -140,10 +144,15 @@ module Checkoff
     # Given a project object, pull all tasks, then provide a Hash of
     # tasks with section name -> task list of the uncompleted tasks
     # @param project [Asana::Resources::Project]
+    # @param only_uncompleted [Boolean]
     # @param extra_fields [Array<String>]
     # @return [Hash<[String,nil], Enumerable<Asana::Resources::Task>>]
-    def tasks_by_section_for_project(project, extra_fields: [])
-      raw_tasks = projects.tasks_from_project(project, extra_fields: extra_fields)
+    def tasks_by_section_for_project(project,
+                                     only_uncompleted: true,
+                                     extra_fields: [])
+      raw_tasks = projects.tasks_from_project(project,
+                                              only_uncompleted: only_uncompleted,
+                                              extra_fields: extra_fields)
       active_tasks = projects.active_tasks(raw_tasks)
       by_section(active_tasks, project.gid)
     end
@@ -165,7 +174,7 @@ module Checkoff
       by_section = {}
       # @sg-ignore
       sections = client.sections.get_sections_for_project(project_gid: project_gid)
-      sections.each { |section| by_section[section_key(section.name)] = [] }
+      sections.each_entry { |section| by_section[section_key(section.name)] = [] }
       tasks.each { |task| file_task_by_section(by_section, task, project_gid) }
       by_section
     end

data/lib/checkoff/version.rb

@@ -3,5 +3,5 @@
 # Command-line and gem client for Asana (unofficial)
 module Checkoff
   # Version of library
-  VERSION = '0.46.0'
+  VERSION = '0.46.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.46.0
+  version: 0.46.1
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-01 00:00:00.000000000 Z
+date: 2023-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport