checkoff 0.257.0 → 0.260.0

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

@@ -105,12 +105,9 @@ module Checkoff
         # @param custom_field_name [String]
         # @return [String, nil]
         def evaluate(resource, custom_field_name)
-          # @sg-ignore
-          custom_field = @custom_fields.resource_custom_field_by_name(resource, custom_field_name)
-          # @sg-ignore
+          custom_field = custom_fields.resource_custom_field_by_name(resource, custom_field_name)
           return nil if custom_field.nil?
 
-          # @sg-ignore
           custom_field['display_value']
         end
       end
@@ -125,17 +122,13 @@ module Checkoff
           false
         end
 
-        # @sg-ignore
         # @param resource [Asana::Resources::Task,Asana::Resources::Project]
-        # @sg-ignore
         # @param custom_field_gid [String]
         # @return [String, nil]
-        # @sg-ignore
         def evaluate(resource, custom_field_gid)
-          # @sg-ignore
-          custom_field = @custom_fields.resource_custom_field_by_gid_or_raise(resource, custom_field_gid)
-          # @sg-ignore
-          custom_field['display_value']
+          custom_field = custom_fields.resource_custom_field_by_gid_or_raise(resource, custom_field_gid)
+          display_value = custom_field['display_value']
+          display_value.nil? ? nil : T.cast(display_value, String)
         end
       end
 
@@ -152,17 +145,13 @@ module Checkoff
         end
 
         # @param resource [Asana::Resources::Task,Asana::Resources::Project]
-        # @sg-ignore
         # @param custom_field_gid [String]
         # @param custom_field_values_gids [Array<String>]
         # @return [Boolean]
-        # @sg-ignore
         def evaluate(resource, custom_field_gid, custom_field_values_gids)
-          # @sg-ignore
-          actual_custom_field_values_gids = @custom_fields.resource_custom_field_values_gids_or_raise(resource,
-                                                                                                      custom_field_gid)
+          actual_custom_field_values_gids = custom_fields.resource_custom_field_values_gids_or_raise(resource,
+                                                                                                     custom_field_gid)
 
-          # @sg-ignore
           actual_custom_field_values_gids.intersect?(custom_field_values_gids)
         end
       end
@@ -181,17 +170,13 @@ module Checkoff
 
         # @param resource [Asana::Resources::Task,Asana::Resources::Project]
         # @param custom_field_name [String]
-        # @sg-ignore
         # @param custom_field_value_names [Array<String>]
-        # @sg-ignore
         # @return [Boolean]
         def evaluate(resource, custom_field_name, custom_field_value_names)
           actual_custom_field_values_names =
-            # @sg-ignore
-            @custom_fields.resource_custom_field_values_names_by_name(resource,
-                                                                      custom_field_name)
+            custom_fields.resource_custom_field_values_names_by_name(resource,
+                                                                     custom_field_name)
 
-          # @sg-ignore
           actual_custom_field_values_names.intersect?(custom_field_value_names)
         end
       end
@@ -214,12 +199,10 @@ module Checkoff
         # @return [Boolean]
         def evaluate(resource, custom_field_gid, custom_field_values_gids)
           actual_custom_field_values_gids =
-            # @sg-ignore
-            @custom_fields.resource_custom_field_values_gids_or_raise(resource,
-                                                                      custom_field_gid)
+            custom_fields.resource_custom_field_values_gids_or_raise(resource,
+                                                                     custom_field_gid)
 
           custom_field_values_gids.all? do |custom_field_value|
-            # @sg-ignore
             actual_custom_field_values_gids.include?(custom_field_value)
           end
         end
@@ -240,8 +223,6 @@ module Checkoff
         # @param resource [Asana::Resources::Task, Asana::Resources::Project]
         # @param prefix [String]
         # @return [boolish]
-        # @sg-ignore Checkoff::SelectorClasses::Common::NameStartsWithPFunctionEvaluator#evaluate
-        #   return type could not be inferred
         def evaluate(resource, prefix)
           resource.name&.start_with?(prefix)
         end
@@ -255,9 +236,10 @@ module Checkoff
 
         # @param _resource [Asana::Resources::Task,Asana::Resources::Project]
         # @return [String]
-        # @sg-ignore
         def evaluate(_resource)
-          T.cast(selector, String)
+          raise "Expected a String selector, got #{selector.inspect}" unless selector.is_a?(String)
+
+          selector
         end
       end
     end

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

@@ -9,13 +9,23 @@ module Checkoff
     class FunctionEvaluator
       include Logging
 
+      # Concrete subclasses each declare their own initialize with their
+      # specific keyword args (and set @selector themselves before calling
+      # super()); this signature exists only so Solargraph can resolve
+      # `evaluator_class.new(selector:, **kwargs)` call sites that hold a
+      # `Class<FunctionEvaluator>` reference rather than a concrete subclass -
+      # deliberately a no-op so a bare `super()` call from those subclasses
+      # can't clobber the @selector they already set.
+      # @param selector [Symbol, Array, String, nil]
+      # @param _kwargs [Hash]
+      def initialize(selector: nil, **_kwargs); end
+
       # @param _index [Integer]
       def evaluate_arg?(_index)
         true
       end
 
       # @return [Boolean]
-      # @sg-ignore return type could not be inferred — abstract method body is only `raise`
       def matches?
         raise 'Override me!'
       end
@@ -23,17 +33,23 @@ module Checkoff
       # @param _task [Asana::Resources::Task]
       # @param _args [Array<Object>]
       # @return [Object]
-      # @sg-ignore return type could not be inferred — abstract method body is only `raise`
       def evaluate(_task, *_args)
         raise 'Implement me!'
       end
 
       private
 
-      # @param object [Object]
+      # @param object [Array<Symbol, Array>, Symbol]
       # @param fn_name [Symbol]
+      # @return [Boolean]
       def fn?(object, fn_name)
-        object.is_a?(Array) && !object.empty? && [fn_name, fn_name.to_s].include?(object[0])
+        if object.is_a?(Array) && !object.empty?
+          # @type [Array<Symbol, Array>]
+          array = object
+          [fn_name, fn_name.to_s].include?(array[0])
+        else
+          false
+        end
       end
     end
   end

data/lib/checkoff/internal/selector_classes/project/function_evaluator.rb

@@ -8,7 +8,7 @@ module Checkoff
     module Project
       # Base class to evaluate a project selector function given fully evaluated arguments
       class FunctionEvaluator < ::Checkoff::SelectorClasses::FunctionEvaluator
-        # @param selector [Array(Symbol, Array), String]
+        # @param selector [Array<Symbol, Array>, Symbol]
         # @param projects [Checkoff::Projects]
         # @param portfolios [Checkoff::Portfolios]
         # @param workspaces [Checkoff::Workspaces]
@@ -25,9 +25,18 @@ module Checkoff
           super()
         end
 
+        # @return [Checkoff::Projects]
+        attr_reader :projects
+
+        # @return [Checkoff::Portfolios]
+        attr_reader :portfolios
+
+        # @return [Checkoff::Workspaces]
+        attr_reader :workspaces
+
         private
 
-        # @return [Array(Symbol, Array)]
+        # @return [Array<Symbol, Array>, Symbol]
         attr_reader :selector
       end
     end

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

@@ -17,7 +17,6 @@ module Checkoff
 
         # @param resource [Asana::Resources::Project]
         # @return [String, nil]
-        # @sg-ignore
         def evaluate(resource)
           resource.due_date
         end
@@ -33,11 +32,9 @@ module Checkoff
 
         # @param project [Asana::Resources::Project]
         # @param period [Symbol] - :now_or_before or :this_week
-        # @sg-ignore
         # @return [Boolean]
         def evaluate(project, period = :now_or_before)
-          # @sg-ignore
-          @projects.project_ready?(project, period:)
+          projects.project_ready?(project, period:)
         end
       end
 
@@ -53,19 +50,14 @@ module Checkoff
         # @param portfolio_name [String]
         # @param workspace_name [String, nil]
         # @param extra_project_fields [Array<String>]
-        # @sg-ignore
         #
-        # @sg-ignore
         # @return [Boolean]
         def evaluate(project, portfolio_name, workspace_name: nil, extra_project_fields: [])
           workspace_name ||= project.workspace&.name
-          # @sg-ignore
-          workspace_name ||= @workspaces.default_workspace.name
-          # @sg-ignore
-          projects = @portfolios.projects_in_portfolio(workspace_name, portfolio_name,
-                                                       extra_project_fields:)
-          # @sg-ignore
-          projects.any? { |p| p.name == project.name }
+          workspace_name ||= workspaces.default_workspace.name
+          matching_projects = portfolios.projects_in_portfolio(T.must(workspace_name), portfolio_name,
+                                                               extra_project_fields:)
+          matching_projects.any? { |p| p.name == project.name }
         end
       end
     end

data/lib/checkoff/internal/selector_classes/section/function_evaluator.rb

@@ -8,7 +8,7 @@ module Checkoff
     module Section
       # Base class to evaluate a project selector function given fully evaluated arguments
       class FunctionEvaluator < ::Checkoff::SelectorClasses::FunctionEvaluator
-        # @param selector [Array(Symbol, Array), String]
+        # @param selector [Array<Symbol, Array>, Symbol]
         # @param client [Asana::Client]
         # @param sections [Checkoff::Sections]
         # @param kwargs [Hash]
@@ -22,13 +22,16 @@ module Checkoff
           super()
         end
 
-        private
-
-        # @return [Array(Symbol, Array)]
-        attr_reader :selector
+        # @return [Checkoff::Sections]
+        attr_reader :sections
 
         # @return [Asana::Client]
         attr_reader :client
+
+        private
+
+        # @return [Array<Symbol, Array>, Symbol]
+        attr_reader :selector
       end
     end
   end

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

@@ -18,12 +18,11 @@ module Checkoff
         # @param section [Asana::Resources::Section]
         #
         # @return [Boolean]
-        # @sg-ignore
         def evaluate(section)
           tasks = client.tasks.get_tasks(section: section.gid,
                                          per_page: 100,
                                          options: { fields: ['resource_subtype'] })
-          T.unsafe(tasks).last&.resource_subtype == 'milestone'
+          tasks.last&.resource_subtype == 'milestone'
         end
       end
 
@@ -37,11 +36,9 @@ module Checkoff
 
         # @param section [Asana::Resources::Section]
         #
-        # @sg-ignore
         # @return [Boolean]
         def evaluate(section)
-          # @sg-ignore
-          @sections.tasks_by_section_gid(section.gid).any?
+          sections.tasks_by_section_gid(section.gid).any?
         end
       end
     end

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

@@ -8,7 +8,7 @@ module Checkoff
     module Task
       # Base class to evaluate a task selector function given fully evaluated arguments
       class FunctionEvaluator < ::Checkoff::SelectorClasses::FunctionEvaluator
-        # @param selector [Array(Symbol, Array), String]
+        # @param selector [Array<Symbol, Array>, Symbol]
         # @param tasks [Checkoff::Tasks]
         # @param timelines [Checkoff::Timelines]
         # @param custom_fields [Checkoff::CustomFields]
@@ -36,7 +36,7 @@ module Checkoff
 
         private
 
-        # @return [Array(Symbol, Array)]
+        # @return [Array<Symbol, Array>, Symbol]
         attr_reader :selector
       end
     end

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

@@ -45,10 +45,14 @@ module Checkoff
         # @param task [Asana::Resources::Task]
         # @param section_name_prefix [String]
         # @return [Boolean]
-        # @sg-ignore
         def evaluate(task, section_name_prefix)
+          # @type [Hash{'unwrapped' => Hash}]
           task_data = tasks.task_to_h(task)
-          task_data.fetch('unwrapped').fetch('membership_by_section_name').keys.any? do |section_name|
+          # @type [Hash{'membership_by_section_name' => Hash}]
+          unwrapped = task_data.fetch('unwrapped')
+          # @type [Array]
+          section_names = unwrapped.fetch('membership_by_section_name').keys
+          section_names.any? do |section_name|
             String(section_name).start_with?(section_name_prefix)
           end
         end
@@ -65,13 +69,17 @@ module Checkoff
           false
         end
 
-        # @sg-ignore
         # @param task [Asana::Resources::Task]
         # @param section_name [String]
         # @return [Boolean]
         def evaluate(task, section_name)
+          # @type [Hash{'unwrapped' => Hash}]
           task_data = tasks.task_to_h(task)
-          task_data.fetch('unwrapped').fetch('membership_by_section_name').keys.any?(section_name)
+          # @type [Hash{'membership_by_section_name' => Hash}]
+          unwrapped = task_data.fetch('unwrapped')
+          # @type [Array]
+          section_names = unwrapped.fetch('membership_by_section_name').keys
+          section_names.any?(section_name)
         end
       end
 
@@ -89,13 +97,11 @@ module Checkoff
         # @param task [Asana::Resources::Task]
         # @param project_name [String]
         # @return [Boolean]
-        # @sg-ignore
         def evaluate(task, project_name)
           project_names = task.memberships.map do |membership|
-            m = T.cast(membership, T::Hash[String, T.untyped])
-            T.cast(m.fetch('project'), T::Hash[String, T.untyped]).fetch('name')
+            membership.fetch('project').fetch('name')
           end
-          T.cast(project_names.include?(project_name), T::Boolean)
+          project_names.include?(project_name)
         end
       end
 
@@ -132,9 +138,11 @@ module Checkoff
         # @param task [Asana::Resources::Task]
         # @param tag_name [String]
         # @return [Boolean]
-        # @sg-ignore
         def evaluate(task, tag_name)
-          task.tags.map(&:name).include? tag_name
+          # @type [Array<Asana::Resources::Tag>]
+          tags = task.tags.to_a
+          tag_names = tags.map(&:name)
+          tag_names.include?(tag_name)
         end
       end
 
@@ -190,10 +198,8 @@ module Checkoff
 
         # @param task [Asana::Resources::Task]
         # @return [Boolean]
-        # @sg-ignore Checkoff::SelectorClasses::Task::UnassignedPFunctionEvaluator#evaluate
-        #   return type could not be inferred
         def evaluate(task)
-          T.cast(task.assignee.nil? == true, T::Boolean)
+          task.assignee.nil?
         end
       end
 
@@ -207,10 +213,8 @@ module Checkoff
 
         # @param task [Asana::Resources::Task]
         # @return [Boolean]
-        # @sg-ignore Checkoff::SelectorClasses::Task::DueDateSetPFunctionEvaluator#evaluate
-        #   return type could not be inferred
         def evaluate(task)
-          T.cast(!(task.due_at.nil? && task.due_on.nil?), T::Boolean)
+          !(task.due_at.nil? && task.due_on.nil?)
         end
       end
 
@@ -235,13 +239,11 @@ module Checkoff
 
           # @type [Array<Asana::Resources::Story>]
           stories = task.stories(per_page: 100).to_a.reject do |story|
-            # @sg-ignore
             excluding_resource_subtypes.include? story.resource_subtype
           end
           return true if stories.empty? # no stories == infinitely old!
 
-          last_story = stories.last
-          # @sg-ignore
+          last_story = T.must(stories.last)
           last_story_created_at = Time.parse(last_story.created_at)
           n_days_ago = Time.at(Time.now.to_i - (num_days * 86_400))
           last_story_created_at < n_days_ago
@@ -362,12 +364,11 @@ module Checkoff
         # @param task [Asana::Resources::Task]
         #
         # @return [Boolean]
-        # @sg-ignore Checkoff::SelectorClasses::Task::MilestonePFunctionEvaluator#evaluate
-        #   return type could not be inferred
         def evaluate(task)
-          raise 'Please add resource_subtype to extra_fields' if task.resource_subtype.nil?
+          resource_subtype = task.resource_subtype
+          raise 'Please add resource_subtype to extra_fields' if resource_subtype.nil?
 
-          task.resource_subtype == 'milestone'
+          resource_subtype == 'milestone'
         end
       end
 

data/lib/checkoff/internal/selector_evaluator.rb

@@ -1,23 +1,21 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 module Checkoff
   # Base class to evaluate Asana resource selectors against an Asana resource
   class SelectorEvaluator
-    # @param selector [Symbol, Array<Symbol, Integer, Array>]
+    # @param selector [Symbol, Array<Symbol, String, Integer, Array>]
     # @return [Boolean, Object, Array, nil]
     def evaluate(selector)
       return true if selector.empty?
 
       function_evaluators.each do |evaluator_class|
         # @type [Checkoff::SelectorClasses::FunctionEvaluator]
-        # @sg-ignore
         evaluator = evaluator_class.new(selector:,
                                         **initializer_kwargs)
 
         next unless evaluator.matches?
 
-        # @sg-ignore
         return try_this_evaluator(selector, evaluator)
       end
 
@@ -32,19 +30,20 @@ module Checkoff
     end
 
     # @return [Array<Class<Checkoff::SelectorClasses::FunctionEvaluator>>]
-    # @sg-ignore
     def function_evaluators
       raise 'Implement me!'
     end
 
-    # @param selector [Array]
+    # @param selector [Symbol, Array]
     # @param evaluator [Checkoff::SelectorClasses::FunctionEvaluator]
     # @return [Array]
     def evaluate_args(selector, evaluator)
       return [] unless selector.is_a?(Array)
 
-      # @sg-ignore
-      selector[1..].map.with_index do |item, index|
+      rest = selector[1..]
+      return [] unless rest
+
+      rest.map.with_index do |item, index|
         if evaluator.evaluate_arg?(index)
           evaluate(item)
         else
@@ -53,7 +52,7 @@ module Checkoff
       end
     end
 
-    # @param selector [Array]
+    # @param selector [Symbol, Array]
     # @param evaluator [Checkoff::SelectorClasses::FunctionEvaluator]
     # @return [Boolean, Object, nil]
     def try_this_evaluator(selector, evaluator)

data/lib/checkoff/internal/task_hashes.rb

@@ -9,7 +9,7 @@ module Checkoff
       # @param task [Asana::Resources::Task]
       # @return [Hash]
       def task_to_h(task)
-        # @type [Hash]
+        # @type [Hash{String => Object}]
         task_hash = task.to_h
         task_hash['unwrapped'] = {}
         unwrap_custom_fields(task_hash)
@@ -18,7 +18,7 @@ module Checkoff
         task_hash
       end
 
-      # @param task_data [Hash]
+      # @param task_data [Hash{String => Object}]
       # @param client [Asana::Client]
       #
       # @return [Asana::Resources::Task]
@@ -34,7 +34,7 @@ module Checkoff
       # @param task_hash [Hash]
       # @return [void]
       def unwrap_custom_fields(task_hash)
-        # @type [Array<Hash>,nil]
+        # @type [Array<Hash{String => Object}>,nil]
         custom_fields = task_hash.fetch('custom_fields', nil)
 
         return if custom_fields.nil?
@@ -53,8 +53,7 @@ module Checkoff
         return unless task_hash.key? 'assignee_section'
 
         assignee_section = task_hash.fetch('assignee_section')
-        # @type [Hash{String => String}]
-        assignee = T.cast(task_hash.fetch('assignee'), T::Hash[String, String])
+        assignee = assignee_hash(task_hash)
         memberships << {
           'section' => assignee_section.dup,
           'project' => {
@@ -64,24 +63,33 @@ module Checkoff
         }
       end
 
-      # @param task_hash [Hash]
+      # @param task_hash [Hash{String => String, Hash, Array}]
+      # @return [Hash{String => Object}]
+      def assignee_hash(task_hash)
+        assignee = task_hash.fetch('assignee')
+        raise "Expected assignee to be a Hash, got #{assignee.class}" unless assignee.is_a?(Hash)
+
+        assignee
+      end
+
+      # @param task_hash [Hash{String => Object}]
       # @param resource [String]
       # @param memberships [Array<Hash>]
       # @param key [String]
       #
       # @return [void]
       def unwrap_memberships(task_hash, memberships, resource, key)
-        # @type [Hash]
+        # @type [Hash{String => Object}]
         unwrapped = task_hash.fetch('unwrapped')
         unwrapped["membership_by_#{resource}_#{key}"] = memberships.group_by do |membership|
           membership[resource][key]
         end.transform_values(&:first)
       end
 
-      # @param task_hash [Hash]
+      # @param task_hash [Hash{String => Object}]
       # @return [void]
       def unwrap_all_memberships(task_hash)
-        # @type [Array<Hash>]
+        # @type [Array<Hash{String => Object}>]
         memberships = task_hash.fetch('memberships', []).dup
         add_user_task_list(task_hash, memberships)
         unwrap_memberships(task_hash, memberships, 'section', 'gid')

data/lib/checkoff/internal/task_timing.rb

@@ -19,16 +19,12 @@ module Checkoff
 
       # @param task [Asana::Resources::Task]
       # @return [Time, nil]
-      # @sg-ignore return type could not be inferred — #to_time called via &. on a Date|Time
-      #   union receiver
       def start_time(task)
         date_or_time_field_by_name(task, :start)&.to_time
       end
 
       # @param task [Asana::Resources::Task]
       # @return [Time, nil]
-      # @sg-ignore return type could not be inferred — #to_time called via &. on a Date|Time
-      #   union receiver
       def due_time(task)
         date_or_time_field_by_name(task, :due)&.to_time
       end

data/lib/checkoff/internal/thread_local.rb

@@ -10,8 +10,6 @@ module Checkoff
       # @param value [Object,Boolean]
       # @yieldreturn [generic<T>]
       # @return [generic<T>]
-      # @sg-ignore return type could not be inferred — Solargraph's generic/yield-return
-      #   inference gap for #with_thread_local_variable
       def with_thread_local_variable(name, value, &block)
         old_value = Thread.current[name]
         Thread.current[name] = value

data/lib/checkoff/monkeypatches/resource_marshalling.rb

@@ -20,19 +20,19 @@ module Asana
     # Public: The base resource class which provides some sugar over common
     # resource functionality.
     class Resource
-      # @return [Hash]
+      # @return [Hash{String => Object}]
       def marshal_dump
         { 'data' => @_data,
           'client' => @_client }
       end
 
-      # @param data [Hash]
+      # @param data [Hash{String => Object}]
       #
       # @return [void]
       def marshal_load(data)
         # @type [Asana::Client]
         @_client = data.fetch('client')
-        # @type [Hash]
+        # @type [Hash{String => Object}]
         @_data = data.fetch('data')
         @_data.each do |k, v|
           if respond_to?(k)

data/lib/checkoff/my_tasks.rb

@@ -67,10 +67,7 @@ module Checkoff
       sections.each_entry { |section| by_section[section_key(section.name)] = [] }
       tasks.each do |task|
         assignee_section = task.assignee_section
-        # @sg-ignore assignee_section can be nil (task has no My Tasks section) but is
-        #   dereferenced without a nil guard — looks like a real gap, flagging for the
-        #   follow-up code PR
-        current_section = section_key(assignee_section.name)
+        current_section = section_key(assignee_section&.name)
         by_section[current_section] ||= []
         by_section[current_section] << task
       end

data/lib/checkoff/portfolios.rb

@@ -47,7 +47,6 @@ module Checkoff
     # @param portfolio_name [String]
     #
     # @return [Asana::Resources::Portfolio]
-    # @sg-ignore nil check above is not flow-sensitive
     def portfolio_or_raise(workspace_name, portfolio_name)
       portfolio_obj = portfolio(workspace_name, portfolio_name)
       raise "Could not find portfolio #{portfolio_name} under workspace #{workspace_name}." if portfolio_obj.nil?

data/lib/checkoff/project_selectors.rb

@@ -42,7 +42,7 @@ module Checkoff
     end
 
     # @param [Asana::Resources::Project] project
-    # @param [Array(Symbol, Array)] project_selector Filter based on
+    # @param [Array<Symbol, String, Array>] project_selector Filter based on
     #        project details.  Examples: [:tag, 'foo'] [:not, [:tag, 'foo']] [:tag, 'foo']
     # @return [Boolean]
     def filter_via_project_selector(project, project_selector)