checkoff 0.193.0 → 0.194.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 740a4435d472d0e2034b946c694abd1f40e91bcbf874380ca43de89e82bbdb8e
-  data.tar.gz: 7e41942a46e0dc7ad297a1ce4379fab954a2d3831c223c4a99801cd9567ecb70
+  metadata.gz: ebec494187b376d4803fa45da76cfdb6ca3b958290ec0308caacb4ac895fa092
+  data.tar.gz: 7d2fd1701ecbae61048495a6eb91587a3cc384f3aa067f01b7b580e9807d02a0
 SHA512:
-  metadata.gz: c96bb1cc1df2d2874eecb23c8328bb48ea7b5401188dd072dfba815d908965316a9c8062879d61ce6a949b1adfd635db54c6d0a6b436678f0202ad1121072562
-  data.tar.gz: c3b68ef7459b67ccfa436788730b22e01139a12f05d8507b386d3813e0f172e0ff20109ddd2ae2355660c1fe51b9080344e264351a0d79eba1ff6967ece439f7
+  metadata.gz: 9ce29418e9649e852ce60b1a3ac8c166e7da1d06bb52d496356bb01022be067b26846b82b631842ae80a8703824ba84731fd585c621df4b982effebdb3b50452
+  data.tar.gz: 29997815ab3aa694eb4d67758fb6cdd8f2e06a2467006b54b13f82c00ad3e385773e8ad69da448e7ef563d2b4c938b6e8719e923ddc95abe06d6f79403151444

data/Gemfile.lock

@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    checkoff (0.193.0)
+    checkoff (0.194.0)
       activesupport
       asana (> 0.10.0)
       cache_method
@@ -130,11 +130,11 @@ GEM
     multi_xml (0.6.0)
     multipart-post (2.3.0)
     mutex_m (0.2.0)
-    nokogiri (1.15.5-arm64-darwin)
+    nokogiri (1.16.2-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.5-x86_64-darwin)
+    nokogiri (1.16.2-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.5-x86_64-linux)
+    nokogiri (1.16.2-x86_64-linux)
       racc (~> 1.4)
     oauth2 (1.4.11)
       faraday (>= 0.17.3, < 3.0)

data/lib/checkoff/projects.rb

@@ -52,17 +52,46 @@ module Checkoff
       @timing = timing
     end
 
+    # @param extra_fields [Array<String>]
+    #
+    # @return [Array<String>]
+    def task_fields(extra_fields: [])
+      (%w[name completed_at start_at start_on due_at due_on tags
+          memberships.project.gid memberships.project.name
+          memberships.section.name dependencies] + extra_fields).sort.uniq
+    end
+
     # Default options used in Asana API to pull tasks
+    #
+    # @param extra_fields [Array<String>]
+    # @param [Boolean] only_uncompleted
+    #
     # @return [Hash<Symbol, Object>]
-    def task_options
-      {
+    def task_options(extra_fields: [], only_uncompleted: false)
+      options = {
         per_page: 100,
         options: {
-          fields: %w[name completed_at start_at start_on due_at due_on tags
-                     memberships.project.gid memberships.project.name
-                     memberships.section.name dependencies],
+          fields: task_fields(extra_fields: extra_fields),
         },
       }
+      options[:completed_since] = '9999-12-01' if only_uncompleted
+      options
+    end
+
+    # @param extra_project_fields [Array<String>]
+    #
+    # @return [Array<String>]
+    def project_fields(extra_project_fields: [])
+      (%w[name custom_fields] + extra_project_fields).sort.uniq
+    end
+
+    # Default options used in Asana API to pull projects
+    #
+    # @param extra_project_fields [Array<String>]
+    #
+    # @return [Hash<Symbol, Object>]
+    def project_options(extra_project_fields: [])
+      { fields: project_fields(extra_project_fields: extra_project_fields) }
     end
 
     # pulls an Asana API project class given a name
@@ -103,7 +132,7 @@ module Checkoff
     #
     # @return [Asana::Resources::Project,nil]
     def project_by_gid(gid, extra_fields: [])
-      projects.find_by_id(gid, options: { fields: %w[name] + extra_fields })
+      projects.find_by_id(gid, options: project_options(extra_project_fields: extra_fields))
     rescue Asana::Errors::NotFound => e
       debug e
       nil
@@ -142,10 +171,8 @@ module Checkoff
     def tasks_from_project_gid(project_gid,
                                only_uncompleted: true,
                                extra_fields: [])
-      options = task_options
-      options[:completed_since] = '9999-12-01' if only_uncompleted
+      options = task_options(extra_fields: extra_fields, only_uncompleted: only_uncompleted)
       options[:project] = project_gid
-      options[:options][:fields] += extra_fields
       # Note: 30 minute cache time on a raw Enumerable from SDK gives
       # 'Your pagination token has expired' errors.  So we go ahead
       # and eagerly evaluate here so we can enjoy the cache.
@@ -158,11 +185,12 @@ module Checkoff
     # @return [Enumerable<Asana::Resources::Project>]
     def projects_by_workspace_name(workspace_name, extra_fields: [])
       workspace = @workspaces.workspace_or_raise(workspace_name)
-      options = { fields: %w[name] + extra_fields }
       # 15 minute cache resulted in 'Your pagination token has
       # expired', so let's cache this a super long time and force
       # evaluation
-      projects.find_by_workspace(workspace: workspace.gid, per_page: 100, options: options).to_a
+      projects.find_by_workspace(workspace: workspace.gid,
+                                 per_page: 100,
+                                 options: project_options(extra_project_fields: extra_fields)).to_a
     end
     cache_method :projects_by_workspace_name, REALLY_LONG_CACHE_TIME
 

data/lib/checkoff/sections.rb

@@ -106,9 +106,8 @@ module Checkoff
     def tasks_by_section_gid(section_gid,
                              only_uncompleted: true,
                              extra_fields: [])
-      options = projects.task_options
-      options[:options][:fields] += extra_fields
-      options[:completed_since] = '9999-12-01' if only_uncompleted
+      options = projects.task_options(extra_fields: extra_fields,
+                                      only_uncompleted: only_uncompleted)
       client.tasks.get_tasks(section: section_gid, **options)
     end
 
@@ -127,9 +126,8 @@ module Checkoff
               only_uncompleted: true,
               extra_fields: [])
       section = section_or_raise(workspace_name, project_name, section_name)
-      options = projects.task_options
-      options[:options][:fields] += extra_fields
-      options[:completed_since] = '9999-12-01' if only_uncompleted
+      options = projects.task_options(extra_fields: extra_fields,
+                                      only_uncompleted: only_uncompleted)
       # Note: 30 minute cache time on a raw Enumerable from SDK gives
       # 'Your pagination token has expired' errors.  So we go ahead
       # and eagerly evaluate here so we can enjoy the cache.

data/lib/checkoff/subtasks.rb

@@ -73,12 +73,9 @@ module Checkoff
                         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
+      all_options = projects.task_options(extra_fields: extra_fields + %w[is_rendered_as_separator],
+                                          only_uncompleted: only_uncompleted)
+      options = all_options.fetch(:options, {})
       client.tasks.get_subtasks_for_task(task_gid: task_gid,
                                          # per_page: 100, # stub doesn't have this arg available
                                          options: options)

data/lib/checkoff/tags.rb

@@ -36,7 +36,8 @@ module Checkoff
               extra_fields: [])
       tag = tag_or_raise(workspace_name, tag_name)
 
-      options = build_task_options(projects.task_options, extra_fields, only_uncompleted)
+      options = projects.task_options(extra_fields: extra_fields,
+                                      only_uncompleted: only_uncompleted)
 
       params = build_params(options)
 
@@ -65,12 +66,6 @@ module Checkoff
 
     attr_reader :workspaces, :projects, :client
 
-    def build_task_options(task_options, extra_fields, only_uncompleted)
-      task_options[:options][:fields] += extra_fields
-      task_options[:completed_since] = '9999-12-01' if only_uncompleted
-      task_options
-    end
-
     def build_params(options)
       { limit: options[:per_page], completed_since: options[:completed_since] }.reject do |_, v|
         v.nil? || Array(v).empty?

data/lib/checkoff/task_searches.rb

@@ -193,10 +193,8 @@ module Checkoff
     # @return [Hash<Symbol, Object>]
     def calculate_api_options(extra_fields)
       # @type [Hash<Symbol, Object>]
-      options = projects.task_options[:options]
-      options[:fields] += ['custom_fields']
-      options[:fields] += extra_fields
-      options
+      all_options = projects.task_options(extra_fields: ['custom_fields'] + extra_fields)
+      all_options[:options]
     end
 
     # bundle exec ./task_searches.rb

data/lib/checkoff/tasks.rb

@@ -156,10 +156,12 @@ module Checkoff
     def task_by_gid(task_gid,
                     extra_fields: [],
                     only_uncompleted: true)
+      # @type [Hash{Symbol => Object}]
+      all_options = projects.task_options(extra_fields: extra_fields,
+                                          only_uncompleted: only_uncompleted)
       # @type [Hash]
-      options = projects.task_options.fetch(:options, {})
-      options[:fields] += extra_fields
-      options[:completed_since] = '9999-12-01' if only_uncompleted
+      options = all_options.fetch(:options, {})
+      options[:completed_since] = all_options[:completed_since] unless all_options[:completed_since].nil?
       client.tasks.find_by_id(task_gid, options: options)
     rescue Asana::Errors::NotFound => e
       debug e

data/lib/checkoff/version.rb

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

metadata

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