checkoff 0.257.0 → 0.260.0

data/lib/checkoff/projects.rb

@@ -22,12 +22,19 @@ require 'asana'
 module Checkoff
   # Work with projects in Asana
   class Projects
+    # @return [Integer]
     MINUTE = 60
+    # @return [Integer]
     HOUR = MINUTE * 60
+    # @return [Integer]
     DAY = 24 * HOUR
+    # @return [Integer]
     REALLY_LONG_CACHE_TIME = MINUTE * 30
+    # @return [Integer]
     LONG_CACHE_TIME = MINUTE * 15
+    # @return [Integer]
     MEDIUM_CACHE_TIME = MINUTE * 5
+    # @return [Integer]
     SHORT_CACHE_TIME = MINUTE
 
     # @!parse
@@ -65,6 +72,12 @@ module Checkoff
 
     # Default options used in Asana API to pull tasks
     #
+    # Keys are :per_page (Integer), :options (a Hash whose :fields is an
+    # Array<String>) and, when only_uncompleted is set, :completed_since
+    # (String). The value type is genuinely per-key, which a single YARD
+    # Hash value type cannot express.
+    # Callers who want the field list should call #task_fields directly.
+    #
     # @param extra_fields [Array<String>]
     # @param [Boolean] only_uncompleted
     #
@@ -109,9 +122,7 @@ module Checkoff
         # @type [Enumerable<Asana::Resources::Project>]
         ps = projects_by_workspace_name(workspace_name, extra_fields:)
         # @type [Asana::Resources::Project,nil]
-        # @sg-ignore Variable type could not be inferred / Unresolved call to _1 — Solargraph
-        #   doesn't fully support numbered block parameters
-        project = ps.find { _1.name == project_name }
+        project = ps.find { |p| p.name == project_name }
         project_by_gid(project.gid, extra_fields:) unless project.nil?
       end
     end
@@ -122,7 +133,6 @@ module Checkoff
     # @param [Array<String>] extra_fields
     #
     # @return [Asana::Resources::Project]
-    # @sg-ignore nil check above is not flow-sensitive
     def project_or_raise(workspace_name, project_name, extra_fields: [])
       p = project(workspace_name, project_name, extra_fields:)
       raise "Could not find project #{project_name.inspect} under workspace #{workspace_name}." if p.nil?
@@ -199,9 +209,10 @@ module Checkoff
     cache_method :projects_by_workspace_name, REALLY_LONG_CACHE_TIME
 
     # @param project_obj [Asana::Resources::Project]
-    # @param project [String, Symbol] - :not_specified, :my_tasks or a project name
+    # @param project [String, :not_specified, :my_tasks, nil] - a String is a
+    #   project name
     #
-    # @return [Hash]
+    # @return [Hash{String => Object}]
     def project_to_h(project_obj, project: :not_specified)
       project_hashes.project_to_h(project_obj, project:)
     end
@@ -214,14 +225,14 @@ module Checkoff
     # date is today or in the past.
     #
     # @param project [Asana::Resources::Project]
-    # @param period [Symbol, Array(Symbol, Integer)] See Checkoff::Timing#in_period? - :now_or_before,:this_week
+    # @param period [Symbol, Array<Symbol, Integer>] See Checkoff::Timing#in_period? - :now_or_before,:this_week
     def project_ready?(project, period: :now_or_before)
       in_period?(project, :ready, period)
     end
 
     # @param project [Asana::Resources::Project]
     # @param field_name [Symbol,Array]
-    # @param period [Symbol, Array(Symbol,Integer)] See Checkoff::Timing#in_period? - :now_or_before,:this_week
+    # @param period [Symbol, Array<Symbol, Integer>] See Checkoff::Timing#in_period? - :now_or_before,:this_week
     def in_period?(project, field_name, period)
       # @type [Date,Time,nil]
       project_date = project_timing.date_or_time_field_by_name(project, field_name)

data/lib/checkoff/resources.rb

@@ -62,9 +62,7 @@ module Checkoff
       %w[task section project].each do |resource_type_to_try|
         next unless [resource_type_to_try, nil].include?(resource_type)
 
-        # @type [Asana::Resources::Resource, nil]
-        resource = T.cast(method(:"fetch_#{resource_type_to_try}_gid").call(gid),
-                          T.nilable(Asana::Resources::Resource))
+        resource = fetch_gid_by_type(resource_type_to_try, gid)
         return [resource, resource_type_to_try] if resource
       end
       [nil, nil]
@@ -72,6 +70,19 @@ module Checkoff
 
     private
 
+    # @param resource_type [String]
+    # @param gid [String]
+    #
+    # @return [Asana::Resources::Resource, nil]
+    def fetch_gid_by_type(resource_type, gid)
+      case resource_type
+      when 'task' then fetch_task_gid(gid)
+      when 'section' then fetch_section_gid(gid)
+      when 'project' then fetch_project_gid(gid)
+      else raise "Unexpected resource_type: #{resource_type}"
+      end
+    end
+
     # @param gid [String]
     #
     # @return [Asana::Resources::Task, nil]

data/lib/checkoff/sections.rb

@@ -14,10 +14,15 @@ module Checkoff
     # @!parse
     #   extend CacheMethod::ClassMethods
 
+    # @return [Integer]
     MINUTE = 60
+    # @return [Integer]
     HOUR = MINUTE * 60
+    # @return [Integer]
     REALLY_LONG_CACHE_TIME = MINUTE * 30
+    # @return [Integer]
     LONG_CACHE_TIME = MINUTE * 15
+    # @return [Integer]
     SHORT_CACHE_TIME = MINUTE * 5
 
     extend Forwardable
@@ -142,11 +147,9 @@ module Checkoff
     # @param section_name [String, nil]
     #
     # @return [Array<String>]
-    # @sg-ignore
     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])
+      task_array.filter_map(&:name)
     end
     cache_method :section_task_names, SHORT_CACHE_TIME
 
@@ -156,7 +159,6 @@ module Checkoff
     # @param extra_section_fields [Array<String>]
     #
     # @return [Asana::Resources::Section]
-    # @sg-ignore section() is nil-checked below
     def section_or_raise(workspace_name, project_name, section_name, extra_section_fields: [])
       s = section(workspace_name, project_name, section_name,
                   extra_section_fields:)
@@ -184,17 +186,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
 
@@ -283,28 +283,22 @@ module Checkoff
     # @return [void]
     def file_task_by_section(by_section, task, project_gid)
       membership = task.memberships.find do |m|
-        membership_hash = T.unsafe(m)
-        T.cast(membership_hash['project'], T::Hash[String, T.untyped])['gid'] == project_gid
+        m.fetch('project')['gid'] == project_gid
       end
       raise "Could not find task in project_gid #{project_gid}: #{task}" if membership.nil?
 
-      membership_data = T.unsafe(membership)
-      section = T.cast(membership_data['section'], T::Hash[String, T.untyped])
-      section_name = T.cast(section['name'], String)
+      section = membership.fetch('section')
+      section_name = section.fetch('name')
 
       # @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
 
     # @param workspace_name [String, Symbol]
     # @param project_name [String, Symbol]
     # @return [Asana::Resources::Project]
-    # @sg-ignore projects.project may be nil but is raised below
     def project_or_raise(workspace_name, project_name)
       raise ArgumentError, 'Provide nil project_name' if T.unsafe(project_name).nil?
 

data/lib/checkoff/subtasks.rb

@@ -72,7 +72,7 @@ module Checkoff
     def subtasks_by_gid(task_gid,
                         extra_fields: [],
                         only_uncompleted: true)
-      # @type [Hash]
+      # @type [Hash{Symbol => undefined}]
       all_options = projects.task_options(extra_fields: extra_fields + %w[is_rendered_as_separator],
                                           only_uncompleted:)
       options = all_options.fetch(:options, {})
@@ -90,7 +90,6 @@ module Checkoff
     #
     # @param subtask [Asana::Resources::Task]
     # @return [Boolean, nil]
-    # @sg-ignore Checkoff::Subtasks#subtask_section? return type could not be inferred
     def subtask_section?(subtask)
       subtask.is_rendered_as_separator
     end

data/lib/checkoff/tags.rb

@@ -79,7 +79,6 @@ module Checkoff
     # @param tag_name [String]
     #
     # @return [Asana::Resources::Tag]
-    # @sg-ignore nil check above is not flow-sensitive
     def tag_or_raise(workspace_name, tag_name)
       t = tag(workspace_name, tag_name)
 
@@ -113,9 +112,9 @@ module Checkoff
     #
     # @return [Hash{Symbol => Object}]
     def build_params(options)
-      { limit: options[:per_page], completed_since: options[:completed_since] }.reject do |_, v|
-        # @sg-ignore Unresolved call to nil? on Object — Solargraph doesn't treat a Hash's
-        #   declared `Object` value type as full Object here
+      # @type [Hash{Symbol => Object}]
+      params = { limit: options[:per_page], completed_since: options[:completed_since] }
+      params.reject do |_, v|
         v.nil? || Array(v).empty?
       end
     end

data/lib/checkoff/task_searches.rb

@@ -73,9 +73,6 @@ module Checkoff
       workspace = workspaces.workspace_or_raise(workspace_name)
       api_params, task_selector = @search_url_parser.convert_params(url)
       debug { "Task search params: api_params=#{api_params}, task_selector=#{task_selector}" }
-      # @sg-ignore task_selector expected Symbol,Array<Symbol,Integer,Array> received
-      #   Hash{String=>String} — Solargraph mis-assigns tuple-destructured types from
-      #   `api_params, task_selector = @search_url_parser.convert_params(url)` above
       raw_task_search(api_params, workspace_gid: workspace.gid, task_selector:,
                                   extra_fields:)
     end
@@ -189,12 +186,8 @@ module Checkoff
 
     # @param [Array<String>] extra_fields
     # @return [Hash{Symbol => Array<String>}]
-    # @sg-ignore return type could not be inferred — bracket access on a Hash{Symbol=>undefined}
-    #   local doesn't narrow even with a T.cast on the return expression
     def calculate_api_options(extra_fields)
-      # @type [Hash{Symbol => undefined}]
-      all_options = projects.task_options(extra_fields: ['custom_fields'] + extra_fields)
-      all_options[:options]
+      { fields: projects.task_fields(extra_fields: ['custom_fields'] + extra_fields) }
     end
 
     # bundle exec ./task_searches.rb

data/lib/checkoff/task_selectors.rb

@@ -40,7 +40,7 @@ module Checkoff
     end
 
     # @param [Asana::Resources::Task] task
-    # @param [Symbol, Array<Symbol, Integer, Array>] task_selector Filter based on
+    # @param [Symbol, Array<Symbol, String, Integer, Array>] task_selector Filter based on
     #   task details.  Examples: [:tag, 'foo'] [:not, [:tag, 'foo']] [:tag, 'foo']
     # @return [Boolean]
     def filter_via_task_selector(task, task_selector)
@@ -60,30 +60,43 @@ module Checkoff
     # @return [Checkoff::CustomFields]
     attr_reader :custom_fields
 
+    class << self
+      # @return [Array(Symbol, Array)]
+      def task_selector
+        task_selector_json = ARGV[2] || raise('Please pass task_selector in JSON form as third argument')
+        function_name, args = validate_task_selector(JSON.parse(task_selector_json))
+        [function_name.to_sym, args]
+      end
+
+      # @param parsed [Object] result of JSON.parse on a task selector
+      # @return [Array(String, Array)]
+      def validate_task_selector(parsed)
+        raise "Expected a 2-element [function_name, args] array, got #{parsed.inspect}" \
+          unless parsed.is_a?(Array) && parsed.length == 2
+
+        function_name = parsed.fetch(0)
+        args = parsed.fetch(1)
+        raise "Expected function_name to be a String, got #{function_name.inspect}" \
+          unless function_name.is_a?(String)
+        raise "Expected args to be an Array, got #{args.inspect}" unless args.is_a?(Array)
+
+        [function_name, args]
+      end
+    end
+
     # bundle exec ./task_selectors.rb
     # :nocov:
     class << self
       # @return [String]
-      # @sg-ignore
       def project_name
         ARGV[1] || raise('Please pass project name to pull tasks from as first argument')
       end
 
-      # @sg-ignore
       # @return [String]
       def workspace_name
         ARGV[0] || raise('Please pass workspace name as first argument')
       end
 
-      # @return [Array(Symbol, Array)]
-      # @sg-ignore
-      def task_selector
-        task_selector_json = ARGV[2] || raise('Please pass task_selector in JSON form as third argument')
-
-        # @return [Symbol, Array]
-        T.cast(JSON.parse(task_selector_json), [Symbol, Array])
-      end
-
       # @return [void]
       def run
         require 'checkoff/projects'

data/lib/checkoff/tasks.rb

@@ -32,7 +32,7 @@ module Checkoff
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE * 5
 
-    # @param config [Hash, Checkoff::Internal::EnvFallbackConfigLoader]
+    # @param config [Hash{Symbol => Object}, Checkoff::Internal::EnvFallbackConfigLoader]
     # @param client [Asana::Client]
     # @param workspaces [Checkoff::Workspaces]
     # @param sections [Checkoff::Sections]
@@ -180,8 +180,6 @@ module Checkoff
     # @param assignee_gid [String]
     #
     # @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)
@@ -282,7 +280,7 @@ module Checkoff
       task_hashes.task_to_h(task)
     end
 
-    # @param task_data [Hash]
+    # @param task_data [Hash{String => Object}]
     #
     # @return [Asana::Resources::Task]
     def h_to_task(task_data)
@@ -295,16 +293,14 @@ module Checkoff
     # @param portfolio_name [String]
     # @param workspace_name [String]
     # @return [Boolean]
-    # @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])
-        project_gid = T.cast(m.fetch('project'), T::Hash[String, T.untyped]).fetch('gid')
+      task.memberships.any? do |membership|
+        project_gid = membership.fetch('project').fetch('gid')
         portfolio_projects.any? { |portfolio_project| portfolio_project.gid == project_gid }
-      end, T::Boolean)
+      end
     end
 
     # True if the task is in a project which is in the given portfolio
@@ -315,13 +311,12 @@ 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)
       task.memberships.each do |membership|
-        m = T.cast(membership, T::Hash[String, T.untyped])
-        project_gid = T.cast(m.fetch('project'), T::Hash[String, T.untyped]).fetch('gid')
+        project_gid = membership.fetch('project').fetch('gid')
         next unless portfolio_project_gids.include?(project_gid)
         return true if seen
 
@@ -386,9 +381,6 @@ module Checkoff
     end
 
     # @return [String]
-    # @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

@@ -57,9 +57,8 @@ module Checkoff
         section_data = membership_data.fetch('section')
         section_gid = section_data.fetch('gid')
         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
-        #   without a nil guard — looks like a real gap, flagging for the follow-up code PR
+        next false if section.nil?
+
         task_data_dependent_on_previous_section_last_milestone?(task_data, section)
       end
     end
@@ -69,7 +68,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
 
@@ -97,8 +96,6 @@ module Checkoff
 
         all_dependent_task_gids ||= @tasks.all_dependent_tasks(task).map(&:gid)
 
-        # @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
@@ -108,7 +105,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
 
@@ -134,8 +131,6 @@ module Checkoff
             dependent_task.resource_subtype == 'milestone'
           end
 
-        # @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
@@ -157,7 +152,7 @@ module Checkoff
 
     private
 
-    # @param task_data [Hash]
+    # @param task_data [Hash{String => Object}]
     # @param section [Asana::Resources::Section]
     #
     # @return [Boolean]

data/lib/checkoff/timing.rb

@@ -36,7 +36,7 @@ module Checkoff
     end
 
     # @param date_or_time [Date,Time,nil]
-    # @param period [Symbol, Array(Symbol,Integer)]
+    # @param period [Symbol, Array<Symbol, Integer>]
     #
     #        Valid values: :this_week, :now_or_before, :indefinite, [:less_than_n_days_ago, Integer]
     def in_period?(date_or_time, period)
@@ -175,7 +175,6 @@ module Checkoff
     # @param num_days [Integer]
     #
     # @return [Date]
-    # @sg-ignore Checkoff::Timing#n_days_from_today return type could not be inferred
     def n_days_from_today(num_days)
       T.cast(@today_getter.today + num_days, Date)
     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.257.0'
+  VERSION = '0.260.0'
 end

data/lib/checkoff/workspaces.rb

@@ -22,7 +22,7 @@ module Checkoff
     # @!parse
     #   extend CacheMethod::ClassMethods
 
-    # @param config [Hash, Checkoff::Internal::EnvFallbackConfigLoader]
+    # @param config [Hash{Symbol => Object}, Checkoff::Internal::EnvFallbackConfigLoader]
     # @param client [Asana::Client]
     # @param asana_workspace [Class<Asana::Resources::Workspace>]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
@@ -44,8 +44,6 @@ module Checkoff
     cache_method :workspace, LONG_CACHE_TIME
 
     # @return [Asana::Resources::Workspace]
-    # @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
@@ -53,7 +51,6 @@ module Checkoff
 
     # @param [String, Symbol] workspace_name
     # @return [Asana::Resources::Workspace]
-    # @sg-ignore workspace() is nil-checked below
     def workspace_or_raise(workspace_name)
       w = workspace(workspace_name)
       raise "Could not find workspace #{workspace_name}" if w.nil?
@@ -62,9 +59,6 @@ module Checkoff
     end
 
     # @return [String]
-    # @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