checkoff 0.192.0 → 0.193.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f18c541bd2d95341686dc5db9637bdfe61cd0f5880f484067c3e20eabebaa717
-  data.tar.gz: d3fc7101c367fab1388d75bf04b08d3e322c9cbeaed614ee2a5da008c2e732cf
+  metadata.gz: 740a4435d472d0e2034b946c694abd1f40e91bcbf874380ca43de89e82bbdb8e
+  data.tar.gz: 7e41942a46e0dc7ad297a1ce4379fab954a2d3831c223c4a99801cd9567ecb70
 SHA512:
-  metadata.gz: 2c72b43aa09c8fe1bf713da082478f52aee59278cdd56a0149012c291cfde621f81979f40fc8267447ed6af5b0abc504ec46e51df18da7d5a295fbaa58be14ca
-  data.tar.gz: 05b8ae1174c3d2352b6ef08525b34774a17276080b8fc14f6afa6c7fb55cd6fa05561a02252435c7803cac41ce6eb0ff28231aea01f0bbcefb0ebb34bfef9a13
+  metadata.gz: c96bb1cc1df2d2874eecb23c8328bb48ea7b5401188dd072dfba815d908965316a9c8062879d61ce6a949b1adfd635db54c6d0a6b436678f0202ad1121072562
+  data.tar.gz: c3b68ef7459b67ccfa436788730b22e01139a12f05d8507b386d3813e0f172e0ff20109ddd2ae2355660c1fe51b9080344e264351a0d79eba1ff6967ece439f7

data/Gemfile.lock

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

data/config/definitions.rb

@@ -54,6 +54,8 @@
 #       class Task
 #         # @return [String]
 #         def resource_subtype; end
+#         # @return [Boolean,nil]
+#         def is_rendered_as_separator; end
 #         # @return [String,nil]
 #         def due_at; end
 #         # @return [String,nil]
@@ -110,6 +112,16 @@
 #         def get_custom_fields_for_workspace(workspace_gid: required("workspace_gid"), options: {}); end
 #       end
 #       class Task
+#         # Get subtasks from a task
+#         #
+#         # @param task_gid [String]  (required) The task to operate on.
+#         # @param options [Hash] the request I/O options
+#         # > offset - [str]  Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
+#         # > limit - [int]  Results per page. The number of objects to return per page. The value must be between 1 and 100.
+#         # > opt_fields - [list[str]]  Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.
+#         # > opt_pretty - [bool]  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
+#         # @return [Enumerable<Asana::Resources::Task>]
+#         def get_subtasks_for_task(task_gid: required("task_gid"), options: {}); end
 #         # Returns the complete task record for a single task.
 #         #
 #         # @param id [String] The task to get.

data/lib/checkoff/subtasks.rb

@@ -7,32 +7,45 @@ require_relative 'projects'
 module Checkoff
   # Query different subtasks of Asana tasks
   class Subtasks
+    # @!parse
+    #   extend CacheMethod::ClassMethods
+
     MINUTE = 60
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE * 5
 
     extend Forwardable
 
+    # @param config [Hash]
+    # @param projects [Checkoff::Projects]
+    # @param clients [Checkoff::Clients]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
-                   projects: Checkoff::Projects.new(config: config))
+                   projects: Checkoff::Projects.new(config: config),
+                   clients: Checkoff::Clients.new(config: config))
       @projects = projects
+      @client = clients.client
     end
 
     # True if all subtasks of the task are completed
+    #
+    # @param task [Asana::Resources::Task]
     def all_subtasks_completed?(task)
-      raw_subtasks = raw_subtasks(task)
-      active_subtasks = @projects.active_tasks(raw_subtasks)
+      rs = raw_subtasks(task)
+      active_subtasks = @projects.active_tasks(rs)
       # anything left should be a section
       active_subtasks.all? { |subtask| subtask_section?(subtask) }
     end
 
     # pulls a Hash of subtasks broken out by section
+    #
     # @param tasks [Enumerable<Asana::Resources::Task>]
+    #
     # @return [Hash<[nil,String], Enumerable<Asana::Resources::Task>>]
     def by_section(tasks)
       current_section = nil
       by_section = { nil => [] }
       tasks.each do |task|
+        # @sg-ignore
         current_section, by_section = file_task_by_section(current_section,
                                                            by_section, task)
       end
@@ -40,26 +53,62 @@ module Checkoff
     end
 
     # Returns all subtasks, including section headers
+    #
+    # @param task [Asana::Resources::Task]
+    #
+    # @return [Enumerable<Asana::Resources::Task>]
     def raw_subtasks(task)
-      task_options = projects.task_options
-      task_options[:options][:fields] << 'is_rendered_as_separator'
-      task.subtasks(**task_options)
+      subtasks_by_gid(task.gid)
+    end
+    cache_method :raw_subtasks, LONG_CACHE_TIME
+
+    # Pull a specific task by GID
+    #
+    # @param task_gid [String]
+    # @param extra_fields [Array<String>]
+    # @param only_uncompleted [Boolean]
+    #
+    # @return [Enumerable<Asana::Resources::Task>]
+    def subtasks_by_gid(task_gid,
+                        extra_fields: [],
+                        only_uncompleted: true)
+      # @type [Hash]
+      options = projects.task_options.fetch(:options, {})
+      options[:fields] += extra_fields
+      options[:fields] += %w[is_rendered_as_separator]
+      options[:fields].uniq!
+
+      options[:completed_since] = '9999-12-01' if only_uncompleted
+      client.tasks.get_subtasks_for_task(task_gid: task_gid,
+                                         # per_page: 100, # stub doesn't have this arg available
+                                         options: options)
     end
-    cache_method :raw_subtasks, SHORT_CACHE_TIME
+    cache_method :subtasks_by_gid, LONG_CACHE_TIME
 
     # True if the subtask passed in represents a section in the subtasks
     #
     # Note: expect this to be removed in a future version, as Asana is
     # expected to move to the new-style way of representing sections
     # as memberships with a separate API within a task.
+    #
+    # @param subtask [Asana::Resources::Task]
     def subtask_section?(subtask)
       subtask.is_rendered_as_separator
     end
 
     private
 
+    # @return [Checkoff::Projects]
     attr_reader :projects
 
+    # @return [Asana::Client]
+    attr_reader :client
+
+    # @param current_section [String,nil]
+    # @param by_section [Hash]
+    # @param task [Asana::Resources::Task]
+    #
+    # @return [Array<(String, Hash)>]
     def file_task_by_section(current_section, by_section, task)
       if subtask_section?(task)
         current_section = task.name

data/lib/checkoff/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.192.0
+  version: 0.193.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-05 00:00:00.000000000 Z
+date: 2024-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport