checkoff 0.243.0 → 0.244.0

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

@@ -14,8 +14,8 @@ module Checkoff
           @date_url_params = date_url_params
         end
 
-        # @sg-ignore
         # @return [Array(Hash{String => String}, Array<Symbol, Array>)]
+        # @sg-ignore
         def convert
           return [{}, []] if date_url_params.empty?
 
@@ -78,7 +78,6 @@ module Checkoff
 
           validate_unit_is_day!(prefix)
 
-          # @sg-ignore
           # @type [Date]
           before = Date.today + value
 
@@ -99,7 +98,6 @@ module Checkoff
           # Example value: 1702857600000
           # +1 is because API seems to operate on inclusive ranges
           # @type [Date]
-          # @sg-ignore
           after = Time.at(after.to_i / 1000).to_date + 1
           [{ "#{API_PREFIX.fetch(prefix)}.after" => after.to_s }, []]
         end
@@ -111,7 +109,6 @@ module Checkoff
 
           validate_unit_is_day!(prefix)
 
-          # @sg-ignore
           # @type [Date]
           after = Date.today - value
 
@@ -125,7 +122,6 @@ module Checkoff
 
           validate_unit_is_day!(prefix)
 
-          # @sg-ignore
           # @type [Date]
           before = Date.today + value + 1
 
@@ -133,6 +129,7 @@ module Checkoff
         end
 
         # @param param_key [String]
+        # @sg-ignore
         # @return [String]
         def get_single_param(param_key)
           raise "Expected #{param_key} to have at least one value" unless date_url_params.key? param_key

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

@@ -24,7 +24,9 @@ module Checkoff
         # @param url [String]
         # @return [Array(Hash{String => String}, Array)]
         def convert_params(url)
+          # @sg-ignore
           url_params = CGI.parse(URI.parse(url).query)
+          # @sg-ignore
           custom_field_params, date_url_params, simple_url_params = partition_url_params(url_params)
           custom_field_args, custom_field_task_selector = convert_custom_field_params(custom_field_params)
           date_url_args, date_task_selector = convert_date_params(date_url_params)
@@ -58,8 +60,10 @@ module Checkoff
         # @return [Array(Hash{String => Array<String>}, Hash{String => Array<String>}, Hash{String => Array<String>})]
         def partition_url_params(url_params)
           groups = T.let(url_params.to_a.group_by do |key, _values|
+                           # @sg-ignore
                            if key.start_with? 'custom_field_'
                              :custom_field
+                           # @sg-ignore
                            elsif key.include? '_date'
                              :date
                            else

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

@@ -18,6 +18,7 @@ module Checkoff
 
         # @param task_selectors [Array<Symbol, Array>]
         # @return [Array(Symbol, Array, Array)]
+        # @sg-ignore
         def self.merge_task_selectors(*task_selectors)
           return [] if task_selectors.empty?
 

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

@@ -21,7 +21,6 @@ module Checkoff
 
           private
 
-          # @sg-ignore
           # @return [String] the single value of the search url param
           def single_value
             @single_value ||= begin
@@ -48,7 +47,6 @@ module Checkoff
           # @return [void]
           def parse_projects_and_sections(projects, sections)
             single_value.split('~').each do |project_section_pair|
-              # @sg-ignore
               project, section = project_section_pair.split('_column_')
               raise "Invalid query string: #{project_section_pair}" if project.nil?
 
@@ -228,6 +226,7 @@ module Checkoff
         # @return [Hash{String => String}] the converted params
         def convert
           # @type [Array<Array(String, String)>]
+          # @sg-ignore
           arr_of_tuples = simple_url_params.to_a.flat_map do |key, values|
             # @type
             entry = convert_arg(key, values).each_slice(2).to_a
@@ -264,14 +263,13 @@ module Checkoff
         private_constant :ARGS
 
         # https://developers.asana.com/docs/search-tasks-in-a-workspace
-        # @sg-ignore
         # @param key [String] the name of the search url param
         # @param values [Array<String>] the values of the search url param
+        # @sg-ignore
         # @return [Hash{String => String}] the converted params
         def convert_arg(key, values)
           # @type [Class<SimpleParam::SimpleParam>]
           clazz = ARGS.fetch(key)
-          # @sg-ignore
           # @type [SimpleParam::SimpleParam]
           obj = clazz.new(key:, values:)
           # @sg-ignore

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

@@ -105,9 +105,12 @@ 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
           return nil if custom_field.nil?
 
+          # @sg-ignore
           custom_field['display_value']
         end
       end
@@ -124,10 +127,14 @@ module Checkoff
 
         # @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']
         end
       end
@@ -145,13 +152,17 @@ 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)
 
+          # @sg-ignore
           actual_custom_field_values_gids.any? do |custom_field_value|
             custom_field_values_gids.include?(custom_field_value)
           end
@@ -172,13 +183,17 @@ 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)
 
+          # @sg-ignore
           actual_custom_field_values_names.any? do |custom_field_value|
             custom_field_value_names.include?(custom_field_value)
           end
@@ -203,10 +218,12 @@ 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_field_values_gids.all? do |custom_field_value|
+            # @sg-ignore
             actual_custom_field_values_gids.include?(custom_field_value)
           end
         end
@@ -225,6 +242,7 @@ module Checkoff
         end
 
         # @param resource [Asana::Resources::Task, Asana::Resources::Project]
+        # @sg-ignore
         # @param prefix [String]
         # @return [boolish]
         def evaluate(resource, prefix)
@@ -238,9 +256,9 @@ module Checkoff
           selector.is_a?(String)
         end
 
-        # @sg-ignore
         # @param _resource [Asana::Resources::Task,Asana::Resources::Project]
         # @return [String]
+        # @sg-ignore
         def evaluate(_resource)
           T.cast(selector, String)
         end

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

@@ -14,8 +14,8 @@ module Checkoff
         true
       end
 
-      # @sg-ignore
       # @return [Boolean]
+      # @sg-ignore
       def matches?
         raise 'Override me!'
       end

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

@@ -17,6 +17,7 @@ module Checkoff
 
         # @param resource [Asana::Resources::Project]
         # @return [String, nil]
+        # @sg-ignore
         def evaluate(resource)
           resource.due_date
         end
@@ -32,8 +33,10 @@ 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:)
         end
       end
@@ -50,13 +53,18 @@ 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 }
         end
       end

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

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

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

@@ -25,6 +25,15 @@ module Checkoff
           super()
         end
 
+        # @return [Checkoff::Tasks]
+        attr_reader :tasks
+
+        # @return [Checkoff::Timelines]
+        attr_reader :timelines
+
+        # @return [Checkoff::CustomFields]
+        attr_reader :custom_fields
+
         private
 
         # @return [Array(Symbol, Array)]

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

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require_relative 'task/function_evaluator'
@@ -18,12 +18,11 @@ module Checkoff
           false
         end
 
-        # @sg-ignore
         # @param task [Asana::Resources::Task]
         # @return [Boolean]
         def evaluate(task)
           # @type [Hash{'unwrapped' => Hash}]
-          task_data = @tasks.task_to_h(task)
+          task_data = tasks.task_to_h(task)
           # @type [Hash{'membership_by_project_name' => Hash}]
           unwrapped = task_data.fetch('unwrapped')
           # @type [Array]
@@ -43,14 +42,14 @@ module Checkoff
           false
         end
 
-        # @sg-ignore
         # @param task [Asana::Resources::Task]
         # @param section_name_prefix [String]
         # @return [Boolean]
+        # @sg-ignore
         def evaluate(task, section_name_prefix)
-          task_data = @tasks.task_to_h(task)
+          task_data = tasks.task_to_h(task)
           task_data.fetch('unwrapped').fetch('membership_by_section_name').keys.any? do |section_name|
-            section_name.start_with? section_name_prefix
+            String(section_name).start_with?(section_name_prefix)
           end
         end
       end
@@ -71,7 +70,7 @@ module Checkoff
         # @param section_name [String]
         # @return [Boolean]
         def evaluate(task, section_name)
-          task_data = @tasks.task_to_h(task)
+          task_data = tasks.task_to_h(task)
           task_data.fetch('unwrapped').fetch('membership_by_section_name').keys.any?(section_name)
         end
       end
@@ -87,15 +86,16 @@ module Checkoff
           false
         end
 
-        # @sg-ignore
         # @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|
-            membership.fetch('project').fetch('name')
+            m = T.cast(membership, T::Hash[String, T.untyped])
+            T.cast(m.fetch('project'), T::Hash[String, T.untyped]).fetch('name')
           end
-          project_names.include? project_name
+          T.cast(project_names.include?(project_name), T::Boolean)
         end
       end
 
@@ -110,12 +110,11 @@ module Checkoff
           false
         end
 
-        # @sg-ignore
         # @param task [Asana::Resources::Task]
         # @param portfolio_name [String]
         # @return [Boolean]
         def evaluate(task, portfolio_name)
-          @tasks.in_portfolio_more_than_once?(task, portfolio_name)
+          tasks.in_portfolio_more_than_once?(task, portfolio_name)
         end
       end
 
@@ -130,10 +129,10 @@ module Checkoff
           false
         end
 
-        # @sg-ignore
         # @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
         end
@@ -158,7 +157,7 @@ module Checkoff
         # @return [Boolean]
         # rubocop:disable Style/OptionalBooleanParameter
         def evaluate(task, period = :now_or_before, ignore_dependencies = false)
-          @tasks.task_ready?(task, period:, ignore_dependencies:)
+          tasks.task_ready?(task, period:, ignore_dependencies:)
         end
         # rubocop:enable Style/OptionalBooleanParameter
       end
@@ -179,7 +178,7 @@ module Checkoff
         # @param period [Symbol,Array<Symbol>] See Checkoff::Timing#in_period?
         # @return [Boolean]
         def evaluate(task, field_name, period)
-          @tasks.in_period?(task, field_name, period)
+          tasks.in_period?(task, field_name, period)
         end
       end
 
@@ -191,6 +190,7 @@ module Checkoff
 
         # @param task [Asana::Resources::Task]
         # @return [Boolean]
+        # @sg-ignore
         def evaluate(task)
           task.assignee.nil?
         end
@@ -204,9 +204,9 @@ module Checkoff
           fn?(selector, FUNCTION_NAME)
         end
 
-        # @sg-ignore
         # @param task [Asana::Resources::Task]
         # @return [Boolean]
+        # @sg-ignore
         def evaluate(task)
           !task.due_at.nil? || !task.due_on.nil?
         end
@@ -233,13 +233,15 @@ 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_created_at = Time.parse(last_story.created_at)
-          n_days_ago = Time.now - (num_days * 24 * 60 * 60)
+          n_days_ago = Time.at(Time.now.to_i - (num_days * 86_400))
           last_story_created_at < n_days_ago
         end
       end
@@ -260,7 +262,6 @@ module Checkoff
           start_on = Date.parse(task.start_on) unless task.start_on.nil?
           due_on = Date.parse(task.due_on) unless task.due_on.nil?
           allocated_hours = 8.0
-          # @sg-ignore
           allocated_hours = (due_on - start_on + 1).to_i * 8.0 if start_on && due_on
           allocated_hours
         end
@@ -268,11 +269,10 @@ module Checkoff
         # @param task [Asana::Resources::Task]
         # @return [Boolean]
         def evaluate(task)
-          custom_field = @custom_fields.resource_custom_field_by_name(task, 'Estimated time')
+          custom_field = custom_fields.resource_custom_field_by_name(task, 'Estimated time')
 
           return false if custom_field.nil?
 
-          # @sg-ignore
           # @type [Integer, nil]
           estimate_minutes = custom_field.fetch('number_value')
 
@@ -301,8 +301,8 @@ module Checkoff
         #
         # @return [Boolean]
         def evaluate(task, limit_to_portfolio_gid: nil)
-          @timelines.task_dependent_on_previous_section_last_milestone?(task,
-                                                                        limit_to_portfolio_gid:)
+          timelines.task_dependent_on_previous_section_last_milestone?(task,
+                                                                       limit_to_portfolio_gid:)
         end
       end
 
@@ -319,7 +319,7 @@ module Checkoff
         #
         # @return [Boolean]
         def evaluate(task, portfolio_name)
-          @tasks.in_portfolio_named?(task, portfolio_name)
+          tasks.in_portfolio_named?(task, portfolio_name)
         end
       end
 
@@ -340,8 +340,8 @@ module Checkoff
         #
         # @return [Boolean]
         def evaluate(task, limit_to_portfolio_name = nil)
-          !@timelines.last_task_milestone_depends_on_this_task?(task,
-                                                                limit_to_portfolio_name:)
+          !timelines.last_task_milestone_depends_on_this_task?(task,
+                                                               limit_to_portfolio_name:)
         end
       end
 
@@ -360,6 +360,7 @@ module Checkoff
         # @param task [Asana::Resources::Task]
         #
         # @return [Boolean]
+        # @sg-ignore
         def evaluate(task)
           raise 'Please add resource_subtype to extra_fields' if task.resource_subtype.nil?
 
@@ -384,8 +385,8 @@ module Checkoff
         #
         # @return [Boolean]
         def evaluate(task, limit_to_portfolio_name = nil)
-          !@timelines.any_milestone_depends_on_this_task?(task,
-                                                          limit_to_portfolio_name:)
+          !timelines.any_milestone_depends_on_this_task?(task,
+                                                         limit_to_portfolio_name:)
         end
       end
     end

data/lib/checkoff/internal/selector_evaluator.rb

@@ -17,6 +17,7 @@ module Checkoff
 
         next unless evaluator.matches?
 
+        # @sg-ignore
         return try_this_evaluator(selector, evaluator)
       end
 
@@ -42,6 +43,7 @@ module Checkoff
     def evaluate_args(selector, evaluator)
       return [] unless selector.is_a?(Array)
 
+      # @sg-ignore
       selector[1..].map.with_index do |item, index|
         if evaluator.evaluate_arg?(index)
           evaluate(item)

data/lib/checkoff/internal/task_hashes.rb

@@ -34,7 +34,6 @@ module Checkoff
       # @param task_hash [Hash]
       # @return [void]
       def unwrap_custom_fields(task_hash)
-        # @sg-ignore
         # @type [Array<Hash>,nil]
         custom_fields = task_hash.fetch('custom_fields', nil)
 
@@ -72,7 +71,6 @@ module Checkoff
       #
       # @return [void]
       def unwrap_memberships(task_hash, memberships, resource, key)
-        # @sg-ignore
         # @type [Hash]
         unwrapped = task_hash.fetch('unwrapped')
         unwrapped["membership_by_#{resource}_#{key}"] = memberships.group_by do |membership|
@@ -83,7 +81,6 @@ module Checkoff
       # @param task_hash [Hash]
       # @return [void]
       def unwrap_all_memberships(task_hash)
-        # @sg-ignore
         # @type [Array<Hash>]
         memberships = task_hash.fetch('memberships', []).dup
         add_user_task_list(task_hash, memberships)

data/lib/checkoff/internal/task_timing.rb

@@ -19,11 +19,13 @@ module Checkoff
 
       # @param task [Asana::Resources::Task]
       # @return [Time, nil]
+      # @sg-ignore
       def start_time(task)
         date_or_time_field_by_name(task, :start)&.to_time
       end
 
       # @param task [Asana::Resources::Task]
+      # @sg-ignore
       # @return [Time, nil]
       def due_time(task)
         date_or_time_field_by_name(task, :due)&.to_time
@@ -31,9 +33,9 @@ module Checkoff
 
       # @param task [Asana::Resources::Task]
       #
-      # @sg-ignore
       # @return [Date, Time, nil]
       def start_date_or_time(task)
+        # @sg-ignore
         return @time_class.parse(task.start_at).localtime unless task.start_at.nil?
 
         return @date_class.parse(task.start_on) unless task.start_on.nil?
@@ -43,10 +45,9 @@ module Checkoff
 
       # @param task [Asana::Resources::Task]
       #
-      # @sg-ignore
       # @return [Date, Time, nil]
       def due_date_or_time(task)
-        return @time_class.parse(task.due_at).localtime unless task.due_at.nil?
+        return @time_class.parse(T.must(task.due_at)).localtime unless task.due_at.nil?
 
         return @date_class.parse(task.due_on) unless task.due_on.nil?
 
@@ -66,7 +67,6 @@ module Checkoff
       # @return [Time, Date, nil]
       def custom_field(task, custom_field_name)
         custom_field = @custom_fields.resource_custom_field_by_name_or_raise(task, custom_field_name)
-        # @sg-ignore
         # @type [String, nil]
         time_str = custom_field.fetch('display_value')
         return nil if time_str.nil?
@@ -77,7 +77,6 @@ module Checkoff
       # @param task [Asana::Resources::Task]
       # @param field_name [Symbol,Array]
       #
-      # @sg-ignore
       # @return [Date, Time, nil]
       def date_or_time_field_by_name(task, field_name)
         return due_date_or_time(task) if field_name == :due
@@ -89,7 +88,6 @@ module Checkoff
         return start_date_or_time(task) || due_date_or_time(task) if field_name == :ready
 
         if field_name.is_a?(Array)
-          # @sg-ignore
           # @type [Symbol]
           actual_field_name = field_name.first
           args = field_name[1..]

data/lib/checkoff/internal/thread_local.rb

@@ -9,8 +9,8 @@ module Checkoff
       # @param name [Symbol]
       # @param value [Object,Boolean]
       # @yieldreturn [generic<T>]
-      # @sg-ignore
       # @return [generic<T>]
+      # @sg-ignore
       def with_thread_local_variable(name, value, &block)
         old_value = Thread.current[name]
         Thread.current[name] = value

data/lib/checkoff/monkeypatches/resource_marshalling.rb

@@ -30,10 +30,8 @@ module Asana
       #
       # @return [void]
       def marshal_load(data)
-        # @sg-ignore
         # @type [Asana::Client]
         @_client = data.fetch('client')
-        # @sg-ignore
         # @type [Hash]
         @_data = data.fetch('data')
         @_data.each do |k, v|

data/lib/checkoff/my_tasks.rb

@@ -46,7 +46,7 @@ module Checkoff
       by_my_tasks_section(active_tasks, project.gid)
     end
 
-    # @param name [String]
+    # @param name [String, nil]
     # @return [String, nil]
     def section_key(name)
       return nil if name == 'Recently assigned'
@@ -67,6 +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
         current_section = section_key(assignee_section.name)
         by_section[current_section] ||= []
         by_section[current_section] << task

data/lib/checkoff/portfolios.rb

@@ -47,6 +47,7 @@ module Checkoff
     # @param portfolio_name [String]
     #
     # @return [Asana::Resources::Portfolio]
+    # @sg-ignore
     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?