checkoff 0.257.0 → 0.258.0

data/lib/checkoff/internal/selector_evaluator.rb

@@ -11,13 +11,11 @@ module Checkoff
 
       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,18 +30,18 @@ module Checkoff
     end
 
     # @return [Array<Class<Checkoff::SelectorClasses::FunctionEvaluator>>]
-    # @sg-ignore
+    # @sg-ignore abstract method always raises; declared type documents the override contract, not this body
     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
+      # @sg-ignore Array#[] with an open-ended range is inferred as nilable even though it never is here
       selector[1..].map.with_index do |item, index|
         if evaluator.evaluate_arg?(index)
           evaluate(item)
@@ -53,7 +51,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/sections.rb

@@ -142,11 +142,10 @@ module Checkoff
     # @param section_name [String, nil]
     #
     # @return [Array<String>]
-    # @sg-ignore
+    # @sg-ignore Task#name is nilable; task names are assumed present here
     def section_task_names(workspace_name, project_name, section_name)
       task_array = tasks(workspace_name, project_name, section_name)
-      # @type [Array<String>]
-      T.cast(task_array.map(&:name), T::Array[String])
+      T.cast(task_array.map(&:name), Array)
     end
     cache_method :section_task_names, SHORT_CACHE_TIME
 
@@ -184,17 +183,15 @@ module Checkoff
     #
     # @return [Asana::Resources::Section, nil]
     def previous_section(section)
-      sections = sections_by_project_gid(section.project.fetch('gid'))
+      project_sections = sections_by_project_gid(section.project.fetch('gid'))
 
       # @type [Array<Asana::Resources::Section>]
-      # @sg-ignore
-      sections = sections.to_a
+      project_sections_arr = project_sections.to_a
 
-      index = sections.find_index { |s| s.gid == section.gid }
+      index = project_sections_arr.find_index { |s| s.gid == section.gid }
       return nil if index.nil? || index.zero?
 
-      # @sg-ignore
-      sections[index - 1]
+      project_sections_arr[index - 1]
     end
     cache_method :previous_section, SHORT_CACHE_TIME
 
@@ -295,9 +292,6 @@ module Checkoff
       # @type [String, nil]
       current_section = section_key(section_name)
 
-      # @sg-ignore Hash#fetch arg0 expected String,NilClass received String,nil — Solargraph
-      #   treats the nil literal in a Hash{K,nil=>V} declaration and an inferred `nil` union
-      #   member as distinct types; no comment-only fix found
       by_section.fetch(current_section) << task
     end
 

data/lib/checkoff/task_selectors.rb

@@ -64,19 +64,19 @@ module Checkoff
     # :nocov:
     class << self
       # @return [String]
-      # @sg-ignore
+      # @sg-ignore `x || raise(...)` isn't inferred as narrowing away the nil branch
       def project_name
         ARGV[1] || raise('Please pass project name to pull tasks from as first argument')
       end
 
-      # @sg-ignore
       # @return [String]
+      # @sg-ignore `x || raise(...)` isn't inferred as narrowing away the nil branch
       def workspace_name
         ARGV[0] || raise('Please pass workspace name as first argument')
       end
 
       # @return [Array(Symbol, Array)]
-      # @sg-ignore
+      # @sg-ignore `x || raise(...)` isn't inferred as narrowing away the nil branch
       def task_selector
         task_selector_json = ARGV[2] || raise('Please pass task_selector in JSON form as third argument')
 

data/lib/checkoff/tasks.rb

@@ -298,7 +298,7 @@ module Checkoff
     # @sg-ignore Checkoff::Tasks#in_portfolio_named? return type could not be inferred
     def in_portfolio_named?(task,
                             portfolio_name,
-                            workspace_name: @workspaces.default_workspace.name)
+                            workspace_name: T.must(@workspaces.default_workspace.name))
       portfolio_projects = @portfolios.projects_in_portfolio(workspace_name, portfolio_name)
       T.cast(task.memberships.any? do |membership|
         m = T.cast(membership, T::Hash[String, T.untyped])
@@ -315,7 +315,7 @@ module Checkoff
     # @return [Boolean]
     def in_portfolio_more_than_once?(task,
                                      portfolio_name,
-                                     workspace_name: @workspaces.default_workspace.name)
+                                     workspace_name: T.must(@workspaces.default_workspace.name))
       portfolio_projects = @portfolios.projects_in_portfolio(workspace_name, portfolio_name)
       portfolio_project_gids = portfolio_projects.map(&:gid)
       seen = T.let(false, T::Boolean)

data/lib/checkoff/timelines.rb

@@ -54,8 +54,12 @@ module Checkoff
       memberships_data = task_data.fetch('memberships')
       memberships_data.all? do |membership_data|
         # @type [Hash{String => String}]
+        # @sg-ignore Hash#fetch generic<X> leak on rbs >= 4.1.0, fix in progress upstream
+        # https://github.com/castwide/solargraph/pull/1228
         section_data = membership_data.fetch('section')
         section_gid = section_data.fetch('gid')
+        # @sg-ignore Hash#fetch generic<X> leak on rbs >= 4.1.0, fix in progress upstream
+        # https://github.com/castwide/solargraph/pull/1228
         section = @sections.section_by_gid(section_gid)
         # @sg-ignore section_by_gid can return nil on a gid lookup miss, and
         #   task_data_dependent_on_previous_section_last_milestone? dereferences it immediately
@@ -69,7 +73,7 @@ module Checkoff
     # @return [Boolean]
     def last_task_milestone_depends_on_this_task?(task, limit_to_portfolio_name: nil)
       unless limit_to_portfolio_name.nil?
-        limit_to_projects = @portfolios.projects_in_portfolio(@workspaces.default_workspace.name,
+        limit_to_projects = @portfolios.projects_in_portfolio(T.must(@workspaces.default_workspace.name),
                                                               limit_to_portfolio_name)
       end
 
@@ -81,14 +85,20 @@ module Checkoff
         md = membership_data
         unless limit_to_portfolio_name.nil?
           # @type [Hash{String => Object}]
+          # @sg-ignore Hash#fetch generic<X> leak on rbs >= 4.1.0, fix in progress upstream
+          # https://github.com/castwide/solargraph/pull/1228
           project_data = md.fetch('project')
           project_gid = project_data.fetch('gid')
           next true unless limit_to_projects.map(&:gid).include? project_gid
         end
         # @type [Hash{String => Object}]
+        # @sg-ignore Hash#fetch generic<X> leak on rbs >= 4.1.0, fix in progress upstream
+        # https://github.com/castwide/solargraph/pull/1228
         section_data = md.fetch('section')
         section_gid = section_data.fetch('gid')
 
+        # @sg-ignore Hash#fetch generic<X> leak on rbs >= 4.1.0, fix in progress upstream
+        # https://github.com/castwide/solargraph/pull/1228
         last_milestone = last_milestone_in_section(section_gid)
 
         next false if last_milestone.nil?
@@ -108,7 +118,7 @@ module Checkoff
     # @return [Boolean]
     def any_milestone_depends_on_this_task?(task, limit_to_portfolio_name: nil)
       unless limit_to_portfolio_name.nil?
-        limit_to_projects = @portfolios.projects_in_portfolio(@workspaces.default_workspace.name,
+        limit_to_projects = @portfolios.projects_in_portfolio(T.must(@workspaces.default_workspace.name),
                                                               limit_to_portfolio_name)
       end
 
@@ -120,6 +130,8 @@ module Checkoff
         md = membership_data
         unless limit_to_portfolio_name.nil?
           # @type [Hash{String => Object}]
+          # @sg-ignore Hash#fetch generic<X> leak on rbs >= 4.1.0, fix in progress upstream
+          # https://github.com/castwide/solargraph/pull/1228
           project_data = md.fetch('project')
           project_gid = project_data.fetch('gid')
           next true unless limit_to_projects.map(&:gid).include? project_gid

data/lib/checkoff/version.rb

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

data/rbi/checkoff.rbi

@@ -82,7 +82,7 @@ module Overcommit
 end
 
 module Checkoff
-  VERSION = '0.257.0'
+  VERSION = '0.258.0'
 
   class Attachments
     include Logging
@@ -1289,10 +1289,10 @@ module Checkoff
     def h_to_task(task_data); end
 
     sig { params(task: T.untyped, portfolio_name: T.untyped, workspace_name: T.untyped).returns(T.untyped) }
-    def in_portfolio_named?(task, portfolio_name, workspace_name: @workspaces.default_workspace.name); end
+    def in_portfolio_named?(task, portfolio_name, workspace_name: T.must(@workspaces.default_workspace.name)); end
 
     sig { params(task: T.untyped, portfolio_name: T.untyped, workspace_name: T.untyped).returns(T.untyped) }
-    def in_portfolio_more_than_once?(task, portfolio_name, workspace_name: @workspaces.default_workspace.name); end
+    def in_portfolio_more_than_once?(task, portfolio_name, workspace_name: T.must(@workspaces.default_workspace.name)); end
 
     sig { returns(T.untyped) }
     def as_cache_key; end
@@ -1862,6 +1862,9 @@ module Checkoff
           sig { returns(T.untyped) }
           def single_value; end
 
+          sig { returns(T.untyped) }
+          def convert; end
+
           sig { returns(T.untyped) }
           attr_reader :key
 
@@ -1977,6 +1980,9 @@ module Checkoff
     class FunctionEvaluator
       include Logging
 
+      sig { params(selector: T.untyped, _kwargs: T.untyped).void }
+      def initialize(selector: nil, **_kwargs); end
+
       sig { params(_index: T.untyped).returns(T.untyped) }
       def evaluate_arg?(_index); end
 
@@ -2127,6 +2133,9 @@ module Checkoff
         sig { params(selector: T.untyped, custom_fields: T.untyped, _kwargs: T.untyped).void }
         def initialize(selector:, custom_fields:, **_kwargs); end
 
+        sig { returns(T.untyped) }
+        attr_reader :custom_fields
+
         sig { returns(T.untyped) }
         attr_reader :selector
       end
@@ -2182,6 +2191,15 @@ module Checkoff
         end
         def initialize(selector:, projects:, portfolios:, workspaces:, **_kwargs); end
 
+        sig { returns(T.untyped) }
+        attr_reader :projects
+
+        sig { returns(T.untyped) }
+        attr_reader :portfolios
+
+        sig { returns(T.untyped) }
+        attr_reader :workspaces
+
         sig { returns(T.untyped) }
         attr_reader :selector
       end
@@ -2220,10 +2238,13 @@ module Checkoff
         def initialize(selector:, sections:, client:, **kwargs); end
 
         sig { returns(T.untyped) }
-        attr_reader :selector
+        attr_reader :sections
 
         sig { returns(T.untyped) }
         attr_reader :client
+
+        sig { returns(T.untyped) }
+        attr_reader :selector
       end
     end
 
@@ -2449,7 +2470,7 @@ end
 # typed: ignore
 # Command-line and gem client for Asana (unofficial)
 module Checkoff
-  VERSION = T.let('0.257.0', T.untyped)
+  VERSION = T.let('0.258.0', T.untyped)
 
   # Move tasks from one place to another
   class MvSubcommand
@@ -3042,7 +3063,7 @@ module Checkoff
     # 
     # _@param_ `workspace_name`
     sig { params(task: Asana::Resources::Task, portfolio_name: String, workspace_name: String).returns(T::Boolean) }
-    def in_portfolio_named?(task, portfolio_name, workspace_name: @workspaces.default_workspace.name); end
+    def in_portfolio_named?(task, portfolio_name, workspace_name: T.must(@workspaces.default_workspace.name)); end
 
     # sord warn - Asana::Resources::Task wasn't able to be resolved to a constant in this project
     # True if the task is in a project which is in the given portfolio
@@ -3053,7 +3074,7 @@ module Checkoff
     # 
     # _@param_ `workspace_name`
     sig { params(task: Asana::Resources::Task, portfolio_name: String, workspace_name: String).returns(T::Boolean) }
-    def in_portfolio_more_than_once?(task, portfolio_name, workspace_name: @workspaces.default_workspace.name); end
+    def in_portfolio_more_than_once?(task, portfolio_name, workspace_name: T.must(@workspaces.default_workspace.name)); end
 
     sig { returns(T::Hash[T.untyped, T.untyped]) }
     def as_cache_key; end
@@ -3773,7 +3794,7 @@ module Checkoff
     def tasks(workspace_name, project_name, section_name, only_uncompleted: true, extra_fields: []); end
 
     # Pulls just names of tasks from a given section.
-    # @sg-ignore
+    # @sg-ignore Task#name is nilable; task names are assumed present here
     # 
     # _@param_ `workspace_name`
     # 
@@ -4791,15 +4812,15 @@ module Checkoff
     sig { params(task: Asana::Resources::Task, task_selector: T.any(Symbol, T::Array[T.any(Symbol, Integer, T::Array[T.untyped])])).returns(T::Boolean) }
     def filter_via_task_selector(task, task_selector); end
 
-    # @sg-ignore
+    # @sg-ignore `x || raise(...)` isn't inferred as narrowing away the nil branch
     sig { returns(String) }
     def self.project_name; end
 
-    # @sg-ignore
+    # @sg-ignore `x || raise(...)` isn't inferred as narrowing away the nil branch
     sig { returns(String) }
     def self.workspace_name; end
 
-    # @sg-ignore
+    # @sg-ignore `x || raise(...)` isn't inferred as narrowing away the nil branch
     sig { returns([Symbol, T::Array[T.untyped]]) }
     def self.task_selector; end
 
@@ -5318,7 +5339,7 @@ module Checkoff
         sig { params(date_url_params: T::Hash[String, T::Array[String]]).void }
         def initialize(date_url_params:); end
 
-        # @sg-ignore
+        # @sg-ignore out can genuinely be nil if none of the 3 known prefixes matched; relies on the raise above it
         sig { returns([T::Hash[String, String], T::Array[T.any(Symbol, T::Array[T.untyped])]]) }
         def convert; end
 
@@ -5350,7 +5371,7 @@ module Checkoff
         sig { params(prefix: String).returns([T::Hash[String, String], T::Array[T.any(Symbol, T::Array[T.untyped])]]) }
         def handle_within_next(prefix); end
 
-        # @sg-ignore
+        # @sg-ignore value.length == 1 guard above isn't inferred as narrowing value[0] to non-nil
         # 
         # _@param_ `param_key`
         sig { params(param_key: String).returns(String) }
@@ -5517,14 +5538,13 @@ module Checkoff
         def convert; end
 
         # https://developers.asana.com/docs/search-tasks-in-a-workspace
-        # @sg-ignore
         # 
         # _@param_ `key` — the name of the search url param
         # 
         # _@param_ `values` — the values of the search url param
         # 
-        # _@return_ — the converted params
-        sig { params(key: String, values: T::Array[String]).returns(T::Hash[String, String]) }
+        # _@return_ — the converted params, as an alternating key/value flat array
+        sig { params(key: String, values: T::Array[String]).returns(T::Array[String]) }
         def convert_arg(key, values); end
 
         sig { returns(T::Hash[String, T::Array[String]]) }
@@ -5557,7 +5577,7 @@ module Checkoff
         sig { returns(T::Hash[String, T::Hash[T.untyped, T.untyped]]) }
         def by_custom_field; end
 
-        # @sg-ignore
+        # @sg-ignore `unless variant_class.nil?` return value isn't inferred as the declared tuple type
         # 
         # _@param_ `gid`
         # 
@@ -5565,7 +5585,7 @@ module Checkoff
         sig { params(gid: String, single_custom_field_params: T::Hash[String, T::Array[String]]).returns([T::Hash[String, String], T::Array[T.any(Symbol, T::Array[T.untyped])]]) }
         def convert_single_custom_field_params(gid, single_custom_field_params); end
 
-        # @sg-ignore
+        # @sg-ignore split(...)[n]'s nilable Array indexing isn't inferred as the declared String return
         # 
         # _@param_ `key`
         sig { params(key: String).returns(String) }
@@ -5803,20 +5823,20 @@ module Checkoff
     sig { returns(T::Hash[T.untyped, T.untyped]) }
     def initializer_kwargs; end
 
-    # @sg-ignore
+    # @sg-ignore abstract method always raises; declared type documents the override contract, not this body
     sig { returns(T::Array[T.class_of(Checkoff::SelectorClasses::FunctionEvaluator)]) }
     def function_evaluators; end
 
     # _@param_ `selector`
     # 
     # _@param_ `evaluator`
-    sig { params(selector: T::Array[T.untyped], evaluator: Checkoff::SelectorClasses::FunctionEvaluator).returns(T::Array[T.untyped]) }
+    sig { params(selector: T.any(Symbol, T::Array[T.untyped]), evaluator: Checkoff::SelectorClasses::FunctionEvaluator).returns(T::Array[T.untyped]) }
     def evaluate_args(selector, evaluator); end
 
     # _@param_ `selector`
     # 
     # _@param_ `evaluator`
-    sig { params(selector: T::Array[T.untyped], evaluator: Checkoff::SelectorClasses::FunctionEvaluator).returns(T.nilable(T.any(T::Boolean, Object))) }
+    sig { params(selector: T.any(Symbol, T::Array[T.untyped]), evaluator: Checkoff::SelectorClasses::FunctionEvaluator).returns(T.nilable(T.any(T::Boolean, Object))) }
     def try_this_evaluator(selector, evaluator); end
 
     sig { returns(Asana::Resources::Resource) }
@@ -5850,8 +5870,6 @@ module Checkoff
         def evaluate_arg?(_index); end
 
         # sord warn - Asana::Resources::Task wasn't able to be resolved to a constant in this project
-        # @sg-ignore
-        # 
         # _@param_ `task`
         # 
         # _@param_ `section_name_prefix`
@@ -5869,8 +5887,6 @@ module Checkoff
         def evaluate_arg?(_index); end
 
         # sord warn - Asana::Resources::Task wasn't able to be resolved to a constant in this project
-        # @sg-ignore
-        # 
         # _@param_ `task`
         # 
         # _@param_ `section_name`
@@ -5888,7 +5904,8 @@ module Checkoff
         def evaluate_arg?(_index); end
 
         # sord warn - Asana::Resources::Task wasn't able to be resolved to a constant in this project
-        # @sg-ignore
+        # @sg-ignore Hash#fetch generic<X> leak on rbs >= 4.1.0, fix in progress upstream
+        # https://github.com/castwide/solargraph/pull/1228
         # 
         # _@param_ `task`
         # 
@@ -5924,8 +5941,6 @@ module Checkoff
         def evaluate_arg?(_index); end
 
         # sord warn - Asana::Resources::Task wasn't able to be resolved to a constant in this project
-        # @sg-ignore
-        # 
         # _@param_ `task`
         # 
         # _@param_ `tag_name`
@@ -6278,10 +6293,6 @@ module Checkoff
 
         # sord warn - Asana::Resources::Task wasn't able to be resolved to a constant in this project
         # sord warn - Asana::Resources::Project wasn't able to be resolved to a constant in this project
-        # @sg-ignore
-        # @sg-ignore
-        # @sg-ignore
-        # 
         # _@param_ `resource`
         # 
         # _@param_ `custom_field_gid`
@@ -6301,9 +6312,6 @@ module Checkoff
 
         # sord warn - Asana::Resources::Task wasn't able to be resolved to a constant in this project
         # sord warn - Asana::Resources::Project wasn't able to be resolved to a constant in this project
-        # @sg-ignore
-        # @sg-ignore
-        # 
         # _@param_ `resource`
         # 
         # _@param_ `custom_field_gid`
@@ -6325,9 +6333,6 @@ module Checkoff
 
         # sord warn - Asana::Resources::Task wasn't able to be resolved to a constant in this project
         # sord warn - Asana::Resources::Project wasn't able to be resolved to a constant in this project
-        # @sg-ignore
-        # @sg-ignore
-        # 
         # _@param_ `resource`
         # 
         # _@param_ `custom_field_name`
@@ -6389,7 +6394,7 @@ module Checkoff
 
         # sord warn - Asana::Resources::Task wasn't able to be resolved to a constant in this project
         # sord warn - Asana::Resources::Project wasn't able to be resolved to a constant in this project
-        # @sg-ignore
+        # @sg-ignore selector is only String here per matches?'s is_a?(String) check, in another method
         # 
         # _@param_ `_resource`
         sig { params(_resource: T.any(Asana::Resources::Task, Asana::Resources::Project)).returns(String) }
@@ -6424,7 +6429,7 @@ module Checkoff
         def matches?; end
 
         # sord warn - Asana::Resources::Project wasn't able to be resolved to a constant in this project
-        # @sg-ignore
+        # @sg-ignore nilable return from an @!parse-declared method isn't inferred
         # 
         # _@param_ `resource`
         sig { params(resource: Asana::Resources::Project).returns(T.nilable(String)) }
@@ -6439,8 +6444,6 @@ module Checkoff
         def matches?; end
 
         # sord warn - Asana::Resources::Project wasn't able to be resolved to a constant in this project
-        # @sg-ignore
-        # 
         # _@param_ `project`
         # 
         # _@param_ `period` — - :now_or_before or :this_week
@@ -6456,10 +6459,6 @@ module Checkoff
         def matches?; end
 
         # sord warn - Asana::Resources::Project wasn't able to be resolved to a constant in this project
-        # @sg-ignore
-        # 
-        # @sg-ignore
-        # 
         # _@param_ `project`
         # 
         # _@param_ `portfolio_name`
@@ -6524,7 +6523,7 @@ module Checkoff
         def matches?; end
 
         # sord warn - Asana::Resources::Section wasn't able to be resolved to a constant in this project
-        # @sg-ignore
+        # @sg-ignore String, nil safe-nav chain isn't inferred as returning Boolean
         # 
         # _@param_ `section`
         sig { params(section: Asana::Resources::Section).returns(T::Boolean) }
@@ -6539,8 +6538,6 @@ module Checkoff
         def matches?; end
 
         # sord warn - Asana::Resources::Section wasn't able to be resolved to a constant in this project
-        # @sg-ignore
-        # 
         # _@param_ `section`
         sig { params(section: Asana::Resources::Section).returns(T::Boolean) }
         def evaluate(section); end