checkoff 0.265.0 → 0.267.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43afa4bb02fd82f7f199254d12c4f489377a9cd527b2ca5e38a94e5b845e6055
-  data.tar.gz: a796db5e7e98d6f73b051475a4c2f891ca648f8179b973bcd1be935f0fc990f0
+  metadata.gz: cbab55444b46fb8c7b10d95bb86294e10d19f6f28ecf909d9362e2e814bcc24e
+  data.tar.gz: be2e338d41917f0207fd8e0fc363a83ae1f567f11b32a1b1aacb7db60a23f01a
 SHA512:
-  metadata.gz: 0127c901a6b621d61251c5052f694e65913911f2f87b9a96b25cdf8c88b0dcd46d38a5aa20fea4a94c73a54b3f82807dd9ae9e480ccf1fcd1ace550e47051d69
-  data.tar.gz: fc574a52669db73bd063fa97b6e3fd33a1c4b5e379ebcc901328b10f2be0e3a00ae1c9301fa6d409b0e2ce76c044e52f0fe38b16611f935285ca226e6b5050b8
+  metadata.gz: 5eaea449f58a098495c90e20a120a7b04daa06e94520861f842283169f756fab5f4601d4d09341408d64a162705c3119d60ad123c9dd0db78f38dbb44fc17f81
+  data.tar.gz: 54061f77cb640e118d6f613170407e0284d011cddfa8591776de716cf315eb80c1110b1f156314429697ca350d9156d974e70f5ed0be59703a6b2079b23ae909

data/lib/checkoff/attachments.rb

@@ -166,7 +166,7 @@ module Checkoff
     # https://github.com/Asana/ruby-asana/blob/master/lib/asana/resource_includes/response_helper.rb#L7
     # @param response [Asana::HttpClient::Response]
     #
-    # @return [Array<Hash, Hash>]
+    # @return [Array(Hash, Hash)]
     def parse(response)
       data = response.body.fetch('data') do
         raise("Unexpected response body: #{response.body}")

data/lib/checkoff/custom_fields.rb

@@ -91,7 +91,7 @@ module Checkoff
     # @param custom_field_name [String]
     # @return [Hash{String => Object}, nil]
     def resource_custom_field_by_name(resource, custom_field_name)
-      # @type [Array<Hash{String => Object}>]
+      # @type [Array<Hash{String => Object}>, nil]
       custom_fields = resource.custom_fields
       if custom_fields.nil?
         raise "custom fields not found on resource - did you add 'custom_fields' in your extra_fields argument?"
@@ -117,7 +117,7 @@ module Checkoff
     # @param custom_field_gid [String]
     # @return [Hash{String => Object}]
     def resource_custom_field_by_gid_or_raise(resource, custom_field_gid)
-      # @type [Array<Hash{String => Object}>]
+      # @type [Array<Hash{String => Object}>, nil]
       custom_fields = resource.custom_fields
       if custom_fields.nil?
         raise "Could not find custom_fields under project (was 'custom_fields' included in 'extra_fields'?)"

data/lib/checkoff/internal/memberships.rb

@@ -0,0 +1,25 @@
+# typed: true
+# frozen_string_literal: true
+
+module Checkoff
+  module Internal
+    # Reads the project/section memberships of an Asana task
+    class Memberships
+      # Asana returns nil for memberships unless they were requested via
+      # 'fields' / extra_fields; raise a clear error instead.
+      #
+      # @param task [Asana::Resources::Task]
+      #
+      # @return [Array<Hash{String => Hash{String => String}}>]
+      def memberships_or_raise(task)
+        memberships = task.memberships
+        if memberships.nil?
+          raise "memberships not found on task #{task.gid} - " \
+                "did you add 'memberships' in your extra_fields argument?"
+        end
+
+        memberships
+      end
+    end
+  end
+end

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

@@ -190,7 +190,7 @@ module Checkoff
 
             empty_task_selector = []
             if selected_options.length == 1
-              [{ "custom_fields.#{gid}.value" => selected_options[0] },
+              [{ "custom_fields.#{gid}.value" => selected_options.fetch(0) },
                empty_task_selector]
             else
               # As of 2023-01,

data/lib/checkoff/internal/selector_classes/task.rb

@@ -3,6 +3,7 @@
 
 require_relative 'task/function_evaluator'
 require 'checkoff/internal/task_timing'
+require 'checkoff/internal/memberships'
 
 module Checkoff
   module SelectorClasses
@@ -98,7 +99,7 @@ module Checkoff
         # @param project_name [String]
         # @return [Boolean]
         def evaluate(task, project_name)
-          project_names = task.memberships.map do |membership|
+          project_names = Checkoff::Internal::Memberships.new.memberships_or_raise(task).map do |membership|
             membership.fetch('project').fetch('name')
           end
           project_names.include?(project_name)
@@ -242,10 +243,21 @@ module Checkoff
           end
           return true if stories.empty? # no stories == infinitely old!
 
-          last_story = T.must(stories.last)
-          last_story_created_at = Time.parse(last_story.created_at)
+          last_story = stories.last
           n_days_ago = Time.at(Time.now.to_i - (num_days * 86_400))
-          last_story_created_at < n_days_ago
+          # @sg-ignore https://github.com/apiology/solargraph/pull/175
+          created_time(last_story) < n_days_ago
+        end
+
+        private
+
+        # @param story [Asana::Resources::Story]
+        # @return [Time]
+        def created_time(story)
+          created_at = story.created_at
+          raise "Story #{story.gid} has no created_at" if created_at.nil?
+
+          Time.parse(created_at)
         end
       end
 

data/lib/checkoff/portfolios.rb

@@ -78,9 +78,8 @@ module Checkoff
     def portfolio_by_gid(portfolio_gid,
                          extra_fields: [])
       options = {
-        fields: ['name'],
+        fields: ['name'] + extra_fields,
       }
-      options[:fields] += extra_fields
       client.portfolios.find_by_id(portfolio_gid, options:)
     end
     cache_method :portfolio_by_gid, SHORT_CACHE_TIME

data/lib/checkoff/sections.rb

@@ -7,6 +7,7 @@ require_relative 'workspaces'
 require_relative 'clients'
 require_relative 'my_tasks'
 require_relative 'internal/logging'
+require_relative 'internal/memberships'
 
 module Checkoff
   # Query different sections of Asana projects
@@ -186,7 +187,8 @@ module Checkoff
     #
     # @return [Asana::Resources::Section, nil]
     def previous_section(section)
-      project_sections = sections_by_project_gid(section.project.fetch('gid'))
+      project = section_project_or_raise(section)
+      project_sections = sections_by_project_gid(project.fetch('gid'))
 
       # @type [Array<Asana::Resources::Section>]
       project_sections_arr = project_sections.to_a
@@ -232,10 +234,27 @@ module Checkoff
 
     include Logging
 
+    # Asana returns nil for a section's project unless it was requested
+    # via 'fields' / extra_fields; raise a clear error instead.
+    #
+    # @param section [Asana::Resources::Section]
+    #
+    # @return [Hash{String => String}]
+    def section_project_or_raise(section)
+      # @type [Hash{String => String}, nil]
+      project = section.project
+      if project.nil?
+        raise "project not found on section #{section.gid} - " \
+              "did you add 'project' in your extra_fields argument?"
+      end
+
+      project
+    end
+
     # https://github.com/Asana/ruby-asana/blob/master/lib/asana/resource_includes/response_helper.rb#L7
     # @param response [Asana::HttpClient::Response]
     #
-    # @return [Array<Hash, Hash>]
+    # @return [Array(Hash, Hash)]
     def parse(response)
       data = response.body.fetch('data') do
         raise("Unexpected response body: #{response.body}")
@@ -282,7 +301,7 @@ module Checkoff
     # @param project_gid [String]
     # @return [void]
     def file_task_by_section(by_section, task, project_gid)
-      membership = task.memberships.find do |m|
+      membership = memberships.memberships_or_raise(task).find do |m|
         m.fetch('project')['gid'] == project_gid
       end
       raise "Could not find task in project_gid #{project_gid}: #{task}" if membership.nil?
@@ -309,5 +328,10 @@ module Checkoff
       end
       project
     end
+
+    # @return [Checkoff::Internal::Memberships]
+    def memberships
+      @memberships ||= Checkoff::Internal::Memberships.new
+    end
   end
 end

data/lib/checkoff/tags.rb

@@ -123,7 +123,7 @@ module Checkoff
     #
     # @param response [Asana::HttpClient::Response]
     #
-    # @return [Array<Hash, Hash>]
+    # @return [Array(Array<Hash>, Hash)]
     def parse(response)
       data = response.body.fetch('data')
       extra = response.body.except('data')

data/lib/checkoff/task_searches.rb

@@ -171,7 +171,10 @@ module Checkoff
 
         break if oldest.nil?
 
-        new_api_params['created_at.before'] = oldest.created_at
+        oldest_created_at = oldest.created_at
+        raise "Task #{oldest.gid} has no created_at" if oldest_created_at.nil?
+
+        new_api_params['created_at.before'] = oldest_created_at
 
         tasks.concat(task_batch.to_a)
       end

data/lib/checkoff/tasks.rb

@@ -10,6 +10,7 @@ require_relative 'workspaces'
 require_relative 'internal/config_loader'
 require_relative 'internal/task_timing'
 require_relative 'internal/task_hashes'
+require_relative 'internal/memberships'
 require_relative 'internal/logging'
 require_relative 'internal/thread_local'
 require 'asana'
@@ -297,7 +298,7 @@ module Checkoff
                             portfolio_name,
                             workspace_name: T.must(@workspaces.default_workspace.name))
       portfolio_projects = @portfolios.projects_in_portfolio(workspace_name, portfolio_name)
-      task.memberships.any? do |membership|
+      memberships.memberships_or_raise(task).any? do |membership|
         project_gid = membership.fetch('project').fetch('gid')
         portfolio_projects.any? { |portfolio_project| portfolio_project.gid == project_gid }
       end
@@ -315,7 +316,7 @@ module Checkoff
       portfolio_projects = @portfolios.projects_in_portfolio(workspace_name, portfolio_name)
       portfolio_project_gids = portfolio_projects.map(&:gid)
       seen = T.let(false, T::Boolean)
-      task.memberships.each do |membership|
+      memberships.memberships_or_raise(task).each do |membership|
         project_gid = membership.fetch('project').fetch('gid')
         next unless portfolio_project_gids.include?(project_gid)
         return true if seen
@@ -344,6 +345,11 @@ module Checkoff
       @task_hashes ||= Checkoff::Internal::TaskHashes.new
     end
 
+    # @return [Checkoff::Internal::Memberships]
+    def memberships
+      @memberships ||= Checkoff::Internal::Memberships.new
+    end
+
     # @param workspace_name [String, Symbol]
     # @param project_name [String, Symbol]
     # @param section_name [String, nil, Symbol] - :unspecified

data/lib/checkoff/timelines.rb

@@ -6,6 +6,7 @@
 require 'forwardable'
 require 'cache_method'
 require_relative 'internal/config_loader'
+require_relative 'internal/memberships'
 require_relative 'workspaces'
 require_relative 'clients'
 
@@ -73,9 +74,7 @@ module Checkoff
       end
 
       all_dependent_task_gids = nil
-      # @type [Array<Hash{String => Object}>]
-      memberships = task.memberships
-      memberships.all? do |membership_data|
+      memberships.memberships_or_raise(task).all? do |membership_data|
         # @type [Hash{String => Object}]
         md = membership_data
         unless limit_to_portfolio_name.nil?
@@ -110,9 +109,7 @@ module Checkoff
       end
 
       all_dependent_milestones = nil
-      # @type [Array<Hash{String => Object}>]
-      memberships = task.memberships
-      memberships.all? do |membership_data|
+      memberships.memberships_or_raise(task).all? do |membership_data|
         # @type [Hash{String => Object}]
         md = membership_data
         unless limit_to_portfolio_name.nil?
@@ -132,7 +129,7 @@ module Checkoff
           end
 
         all_dependent_milestones.any? do |milestone|
-          milestone.memberships.any? do |milestone_membership_data|
+          memberships.memberships_or_raise(milestone).any? do |milestone_membership_data|
             milestone_membership_data.fetch('project').fetch('gid') == project_gid
           end
         end
@@ -176,6 +173,11 @@ module Checkoff
     # @return [Asana::Client]
     attr_reader :client
 
+    # @return [Checkoff::Internal::Memberships]
+    def memberships
+      @memberships ||= Checkoff::Internal::Memberships.new
+    end
+
     # bundle exec ./timelines.rb
     # :nocov:
     class << self

data/lib/checkoff/version.rb

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