checkoff 0.256.0 → 0.258.0

data/lib/checkoff/tasks.rb

@@ -122,8 +122,7 @@ module Checkoff
              only_uncompleted: true,
              extra_fields: [])
       thread_local = Checkoff::Internal::ThreadLocal.new
-      # @type [String]
-      # @sg-ignore
+      # @type [String, nil]
       task_gid = thread_local.with_thread_local_variable(:suppress_asana_webhook_watch_creation,
                                                          true) do
         gid_for_task(workspace_name, project_name, section_name, task_name)
@@ -179,9 +178,10 @@ module Checkoff
     # @param name [String]
     # @param workspace_gid [String]
     # @param assignee_gid [String]
-    # @sg-ignore
     #
     # @return [Asana::Resources::Task]
+    # @sg-ignore @asana_task.create return type could not be inferred — calling a class method
+    #   through a Class<T>-typed ivar is a known Solargraph dispatch limitation
     def add_task(name,
                  workspace_gid: @workspaces.default_workspace_gid,
                  assignee_gid: default_assignee_gid)
@@ -201,10 +201,10 @@ module Checkoff
 
     # True if any of the task's dependencies are marked incomplete
     #
-    # @sg-ignore
     # Include 'dependencies.gid' in extra_fields of task passed in.
     #
     # @param task [Asana::Resources::Task]
+    # @return [Boolean]
     def incomplete_dependencies?(task)
       # Avoid a redundant fetch.  Unfortunately, Ruby SDK allows
       # dependencies to be fetched along with other attributes--but
@@ -214,14 +214,13 @@ module Checkoff
       #
       # https://github.com/Asana/ruby-asana/issues/125
 
-      # @type [Enumerable<Asana::Resources::Task>, nil]
+      # @type [Array<Hash>]
       dependencies = task.instance_variable_get(:@dependencies) || []
 
       dependencies.any? do |parent_task_info|
         # the real bummer though is that asana doesn't let you fetch
         # the completion status of dependencies, so we need to do this
         # regardless:
-        # @sg-ignore
         parent_task_gid = parent_task_info.fetch('gid')
 
         parent_task = task_by_gid(parent_task_gid, only_uncompleted: false)
@@ -299,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])
@@ -316,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)
@@ -387,7 +386,9 @@ module Checkoff
     end
 
     # @return [String]
-    # @sg-ignore
+    # @sg-ignore @config.fetch return type could not be inferred — @config is intentionally
+    #   dual-typed [Hash, EnvFallbackConfigLoader] throughout this codebase; Solargraph can't
+    #   unify #fetch across that union
     def default_assignee_gid
       @config.fetch(:default_assignee_gid)
     end

data/lib/checkoff/timelines.rb

@@ -54,10 +54,16 @@ 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
+        # @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
+        #   without a nil guard — looks like a real gap, flagging for the follow-up code PR
         task_data_dependent_on_previous_section_last_milestone?(task_data, section)
       end
     end
@@ -67,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
 
@@ -79,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?
@@ -95,7 +107,8 @@ module Checkoff
 
         all_dependent_task_gids ||= @tasks.all_dependent_tasks(task).map(&:gid)
 
-        # @sg-ignore
+        # @sg-ignore all_dependent_task_gids is nil-initialized then set via ||= above, but
+        #   Solargraph doesn't narrow it back to non-nil after the reassignment
         all_dependent_task_gids.include? last_milestone.gid
       end
     end
@@ -105,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
 
@@ -117,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
@@ -131,7 +146,8 @@ module Checkoff
             dependent_task.resource_subtype == 'milestone'
           end
 
-        # @sg-ignore
+        # @sg-ignore all_dependent_milestones is nil-initialized then set via ||= above, but
+        #   Solargraph doesn't narrow it back to non-nil after the reassignment
         all_dependent_milestones.any? do |milestone|
           milestone.memberships.any? do |milestone_membership_data|
             milestone_membership_data.fetch('project').fetch('gid') == project_gid

data/lib/checkoff/timing.rb

@@ -44,18 +44,15 @@ module Checkoff
 
       return next_week?(date_or_time) if period == :next_week
 
-      # @sg-ignore
-      return day_of_week?(date_or_time, period) if %i[monday tuesday wednesday thursday friday saturday
-                                                      sunday].include?(period)
+      return day_of_week?(date_or_time, T.cast(period, Symbol)) if %i[monday tuesday wednesday thursday friday
+                                                                      saturday sunday].include?(period)
 
       return true if period == :indefinite
 
       return now_or_before?(date_or_time) if period == :now_or_before
 
       if period.is_a?(Array)
-        # @sg-ignore
-        # @type [Symbol]
-        period_name = period.first
+        period_name = T.cast(period.first, Symbol)
         args = period[1..]
 
         return compound_in_period?(date_or_time, period_name, *args)
@@ -209,7 +206,7 @@ module Checkoff
 
     # @param date_or_time [Date,Time,nil]
     # @param period_name [Symbol]
-    # @param args [Object]
+    # @param args [Array<Object>]
     def compound_in_period?(date_or_time, period_name, *args)
       return less_than_n_days_ago?(date_or_time, *args) if period_name == :less_than_n_days_ago
 
@@ -225,7 +222,6 @@ module Checkoff
 
       return between_relative_days?(date_or_time, *args) if period_name == :between_relative_days
 
-      # @sg-ignore
       raise "Teach me how to handle period [#{period_name.inspect}, #{args.map(&:inspect).join(', ')}]"
     end
 

data/lib/checkoff/version.rb

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

data/lib/checkoff/workspaces.rb

@@ -44,7 +44,8 @@ module Checkoff
     cache_method :workspace, LONG_CACHE_TIME
 
     # @return [Asana::Resources::Workspace]
-    # @sg-ignore
+    # @sg-ignore @asana_workspace.find_by_id return type could not be inferred — calling a
+    #   class method through a Class<T>-typed ivar is a known Solargraph dispatch limitation
     def default_workspace
       @asana_workspace.find_by_id(client, default_workspace_gid)
     end
@@ -61,7 +62,9 @@ module Checkoff
     end
 
     # @return [String]
-    # @sg-ignore
+    # @sg-ignore @config.fetch return type could not be inferred — @config is intentionally
+    #   dual-typed [Hash, EnvFallbackConfigLoader] throughout this codebase; Solargraph can't
+    #   unify #fetch across that union
     def default_workspace_gid
       @config.fetch(:default_workspace_gid)
     end