checkoff 0.243.0 → 0.244.0

data/lib/checkoff/projects.rb

@@ -97,7 +97,7 @@ module Checkoff
     end
 
     # pulls an Asana API project class given a name
-    # @param [String] workspace_name
+    # @param [String, Symbol] workspace_name
     # @param [String,Symbol] project_name - :my_tasks or a project name
     # @param [Array<String>] extra_fields
     #
@@ -116,10 +116,11 @@ module Checkoff
     end
     cache_method :project, REALLY_LONG_CACHE_TIME
 
-    # @param workspace_name [String]
+    # @param workspace_name [String, Symbol]
     # @param project_name [String,Symbol] - :my_tasks or a project name
     # @param [Array<String>] extra_fields
     #
+    # @sg-ignore
     # @return [Asana::Resources::Project]
     def project_or_raise(workspace_name, project_name, extra_fields: [])
       p = project(workspace_name, project_name, extra_fields:)
@@ -182,7 +183,7 @@ module Checkoff
     end
     cache_method :tasks_from_project_gid, REALLY_LONG_CACHE_TIME
 
-    # @param [String] workspace_name
+    # @param [String, Symbol] workspace_name
     # @param [Array<String>] extra_fields
     # @return [Enumerable<Asana::Resources::Project>]
     def projects_by_workspace_name(workspace_name, extra_fields: [])
@@ -254,12 +255,11 @@ module Checkoff
     end
     cache_method :projects, LONG_CACHE_TIME
 
-    # @param [String] workspace_name
+    # @param [String, Symbol] workspace_name
     #
     # @return [Asana::Resources::Project]
     def my_tasks(workspace_name)
       workspace = @workspaces.workspace_or_raise(workspace_name)
-      # @sg-ignore
       result = client.user_task_lists.get_user_task_list_for_user(user_gid: 'me',
                                                                   workspace: workspace.gid)
       gid = result.gid

data/lib/checkoff/resources.rb

@@ -113,10 +113,8 @@ module Checkoff
     class << self
       # @return [void]
       def run
-        # # @sg-ignore
         # # @type [String]
         # workspace_name = ARGV[0] || raise('Please pass workspace name as first argument')
-        # # @sg-ignore
         # # @type [String]
         # resource_name = ARGV[1] || raise('Please pass resource name as second argument')
         # resources = Checkoff::Resources.new

data/lib/checkoff/section_selectors.rb

@@ -43,7 +43,6 @@ module Checkoff
     #        section details.  Examples: [:tag, 'foo'] [:not, [:tag, 'foo']] [:tag, 'foo']
     # @return [Boolean]
     def filter_via_section_selector(section, section_selector)
-      # @sg-ignore
       evaluator = SectionSelectorEvaluator.new(section:, sections:, custom_fields:,
                                                client:)
       !!evaluator.evaluate(section_selector)

data/lib/checkoff/sections.rb

@@ -55,7 +55,7 @@ module Checkoff
     end
 
     # Returns a list of Asana API section objects for a given project
-    # @param workspace_name [String]
+    # @param workspace_name [String, Symbol]
     # @param project_name [String, Symbol]
     # @param extra_fields [Array<String>]
     #
@@ -115,9 +115,9 @@ module Checkoff
 
     # Pulls task objects from a specified section
     #
-    # @param workspace_name [String]
+    # @param workspace_name [String, Symbol]
     # @param project_name [String, Symbol]
-    # @param section_name [String, nil]
+    # @param section_name [String, nil, Symbol]
     # @param only_uncompleted [Boolean]
     # @param extra_fields [Array<String>]
     #
@@ -141,8 +141,8 @@ module Checkoff
     # @param project_name [String, Symbol]
     # @param section_name [String, nil]
     #
-    # @sg-ignore
     # @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>]
@@ -150,13 +150,13 @@ module Checkoff
     end
     cache_method :section_task_names, SHORT_CACHE_TIME
 
-    # @param workspace_name [String]
+    # @param workspace_name [String, Symbol]
     # @param project_name [String, Symbol]
-    # @param section_name [String, nil]
+    # @param section_name [String, nil, Symbol]
     # @param extra_section_fields [Array<String>]
     #
-    # @sg-ignore
     # @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:)
@@ -171,7 +171,7 @@ module Checkoff
     end
     cache_method :section_or_raise, LONG_CACHE_TIME
 
-    # @param name [String]
+    # @param name [String, nil]
     # @return [String, nil]
     def section_key(name)
       inbox_section_names = ['(no section)', 'Untitled section', 'Inbox', 'Recently assigned']
@@ -187,11 +187,13 @@ module Checkoff
       sections = sections_by_project_gid(section.project.fetch('gid'))
 
       # @type [Array<Asana::Resources::Section>]
+      # @sg-ignore
       sections = sections.to_a
 
       index = sections.find_index { |s| s.gid == section.gid }
       return nil if index.nil? || index.zero?
 
+      # @sg-ignore
       sections[index - 1]
     end
     cache_method :previous_section, SHORT_CACHE_TIME
@@ -214,10 +216,9 @@ module Checkoff
       {}
     end
 
-    # @sg-ignore
-    # @param workspace_name [String]
+    # @param workspace_name [String, Symbol]
     # @param project_name [String, Symbol]
-    # @param section_name [String, nil]
+    # @param section_name [String, nil, Symbol]
     # @param extra_section_fields [Array<String>]
     #
     # @return [Asana::Resources::Section, nil]
@@ -268,7 +269,6 @@ module Checkoff
     # @return [Hash{String, nil => Enumerable<Asana::Resources::Task>}]
     def by_section(tasks, project_gid)
       by_section = {}
-      # @sg-ignore
       sections = client.sections.get_sections_for_project(project_gid:,
                                                           options: { fields: ['name'] })
       sections.each_entry { |section| by_section[section_key(section.name)] = [] }
@@ -282,7 +282,10 @@ module Checkoff
     # @param project_gid [String]
     # @return [void]
     def file_task_by_section(by_section, task, project_gid)
-      membership = task.memberships.find { |m| T.cast(m['project'], T::Hash[String, T.untyped])['gid'] == project_gid }
+      membership = task.memberships.find do |m|
+        # @sg-ignore
+        T.cast(m['project'], T::Hash[String, T.untyped])['gid'] == project_gid
+      end
       raise "Could not find task in project_gid #{project_gid}: #{task}" if membership.nil?
 
       section = T.cast(membership['section'], T::Hash[String, T.untyped])
@@ -295,9 +298,10 @@ module Checkoff
       by_section.fetch(current_section) << task
     end
 
-    # @param workspace_name [String]
+    # @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

@@ -46,7 +46,6 @@ module Checkoff
       current_section = nil
       by_section = { nil => [] }
       tasks.each do |task|
-        # @sg-ignore
         current_section, by_section = file_task_by_section(current_section,
                                                            by_section, task)
       end
@@ -90,6 +89,7 @@ module Checkoff
     # as memberships with a separate API within a task.
     #
     # @param subtask [Asana::Resources::Task]
+    # @sg-ignore
     def subtask_section?(subtask)
       subtask.is_rendered_as_separator
     end

data/lib/checkoff/tags.rb

@@ -79,6 +79,7 @@ module Checkoff
     # @param tag_name [String]
     #
     # @return [Asana::Resources::Tag]
+    # @sg-ignore
     def tag_or_raise(workspace_name, tag_name)
       t = tag(workspace_name, tag_name)
 
@@ -92,7 +93,6 @@ module Checkoff
     # @param tag_name [String]
     #
     # @return [Asana::Resources::Tag,nil]
-    # @sg-ignore
     def tag(workspace_name, tag_name)
       workspace = workspaces.workspace_or_raise(workspace_name)
       tags = client.tags.get_tags_for_workspace(workspace_gid: workspace.gid)
@@ -111,10 +111,10 @@ module Checkoff
 
     # @param options [Hash{Symbol => Object}]
     #
-    # @sg-ignore
     # @return [Hash{Symbol => Object}]
     def build_params(options)
       { limit: options[:per_page], completed_since: options[:completed_since] }.reject do |_, v|
+        # @sg-ignore
         v.nil? || Array(v).empty?
       end
     end
@@ -135,10 +135,8 @@ module Checkoff
     class << self
       # @return [void]
       def run
-        # @sg-ignore
         # @type [String]
         workspace_name = ARGV[0] || raise('Please pass workspace name as first argument')
-        # @sg-ignore
         # @type [String]
         tag_name = ARGV[1] || raise('Please pass tag name as second argument')
         tags = Checkoff::Tags.new

data/lib/checkoff/task_searches.rb

@@ -71,9 +71,9 @@ module Checkoff
     # @return [Enumerable<Asana::Resources::Task>]
     def task_search(workspace_name, url, extra_fields: [])
       workspace = workspaces.workspace_or_raise(workspace_name)
-      # @sg-ignore
       api_params, task_selector = @search_url_parser.convert_params(url)
       debug { "Task search params: api_params=#{api_params}, task_selector=#{task_selector}" }
+      # @sg-ignore
       raw_task_search(api_params, workspace_gid: workspace.gid, task_selector:,
                                   extra_fields:)
     end
@@ -93,13 +93,9 @@ module Checkoff
     def raw_task_search(api_params,
                         workspace_gid:, extra_fields: [], task_selector: [],
                         fetch_all: true)
-      # @sg-ignore
       tasks = api_task_search_request(api_params, workspace_gid:, extra_fields:)
 
-      if fetch_all && tasks.count == 100
-        # @sg-ignore
-        tasks = iterated_raw_task_search(api_params, workspace_gid:, extra_fields:)
-      end
+      tasks = iterated_raw_task_search(api_params, workspace_gid:, extra_fields:) if fetch_all && tasks.count == 100
 
       debug { "#{tasks.count} raw tasks returned" }
 
@@ -203,10 +199,8 @@ module Checkoff
     class << self
       # @return [void]
       def run
-        # @sg-ignore
         # @type [String]
         workspace_name = ARGV[0] || raise('Please pass workspace name as first argument')
-        # @sg-ignore
         # @type [String]
         url = ARGV[1] || raise('Please pass task search URL as second argument')
         task_searches = Checkoff::TaskSearches.new

data/lib/checkoff/task_selectors.rb

@@ -20,7 +20,6 @@ module Checkoff
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE
 
-    # @sg-ignore
     # @param [Hash,Checkoff::Internal::EnvFallbackConfigLoader] config
     # @param [Asana::Client] client
     # @param [Checkoff::Tasks] tasks
@@ -64,8 +63,8 @@ module Checkoff
     # bundle exec ./task_selectors.rb
     # :nocov:
     class << self
-      # @sg-ignore
       # @return [String]
+      # @sg-ignore
       def project_name
         ARGV[1] || raise('Please pass project name to pull tasks from as first argument')
       end
@@ -76,8 +75,8 @@ module Checkoff
         ARGV[0] || raise('Please pass workspace name as first argument')
       end
 
-      # @sg-ignore
       # @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')
 

data/lib/checkoff/tasks.rb

@@ -110,13 +110,12 @@ module Checkoff
 
     # Pull a specific task by name
     #
-    # @param workspace_name [String]
+    # @param workspace_name [String, Symbol]
     # @param project_name [String, Symbol]
     # @param section_name [String, nil, Symbol]
     # @param task_name [String]
     # @param only_uncompleted [Boolean]
     # @param extra_fields [Array<String>]
-    # @sg-ignore
     # @return [Asana::Resources::Task, nil]
     def task(workspace_name, project_name, task_name,
              section_name: :unspecified,
@@ -124,6 +123,7 @@ module Checkoff
              extra_fields: [])
       thread_local = Checkoff::Internal::ThreadLocal.new
       # @type [String]
+      # @sg-ignore
       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)
@@ -134,21 +134,21 @@ module Checkoff
     end
     cache_method :task, LONG_CACHE_TIME
 
-    # @param workspace_name [String]
+    # @param workspace_name [String, Symbol]
     # @param project_name [String, Symbol]
     # @param section_name [String, nil, Symbol]
     # @param task_name [String]
     #
     # @return [String, nil]
-    # @sg-ignore
     def gid_for_task(workspace_name, project_name, section_name, task_name)
-      # @sg-ignore
       t = tasks(workspace_name,
                 project_name,
                 section_name:,
                 only_uncompleted: false)
       task_for_gid = t.find { |task| task.name == task_name }
-      task_for_gid&.gid
+      return nil if task_for_gid.nil?
+
+      task_for_gid.gid
     end
     cache_method :gid_for_task, REALLY_LONG_CACHE_TIME
 
@@ -179,6 +179,7 @@ module Checkoff
     # @param name [String]
     # @param workspace_gid [String]
     # @param assignee_gid [String]
+    # @sg-ignore
     #
     # @return [Asana::Resources::Task]
     def add_task(name,
@@ -200,6 +201,7 @@ 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]
@@ -212,7 +214,6 @@ module Checkoff
       #
       # https://github.com/Asana/ruby-asana/issues/125
 
-      # @sg-ignore
       # @type [Enumerable<Asana::Resources::Task>, nil]
       dependencies = task.instance_variable_get(:@dependencies) || []
 
@@ -220,6 +221,7 @@ module Checkoff
         # 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)
@@ -289,12 +291,15 @@ module Checkoff
     # @param task [Asana::Resources::Task]
     # @param portfolio_name [String]
     # @param workspace_name [String]
+    # @return [Boolean]
+    # @sg-ignore
     def in_portfolio_named?(task,
                             portfolio_name,
                             workspace_name: @workspaces.default_workspace.name)
       portfolio_projects = @portfolios.projects_in_portfolio(workspace_name, portfolio_name)
       task.memberships.any? do |membership|
-        project_gid = membership.fetch('project').fetch('gid')
+        m = T.cast(membership, T::Hash[String, T.untyped])
+        project_gid = T.cast(m.fetch('project'), T::Hash[String, T.untyped]).fetch('gid')
         portfolio_projects.any? do |portfolio_project|
           portfolio_project.gid == project_gid
         end
@@ -306,6 +311,7 @@ module Checkoff
     # @param task [Asana::Resources::Task]
     # @param portfolio_name [String]
     # @param workspace_name [String]
+    # @return [Boolean]
     def in_portfolio_more_than_once?(task,
                                      portfolio_name,
                                      workspace_name: @workspaces.default_workspace.name)
@@ -313,7 +319,8 @@ module Checkoff
       portfolio_project_gids = portfolio_projects.map(&:gid)
       seen = T.let(false, T::Boolean)
       task.memberships.each do |membership|
-        project_gid = membership.fetch('project').fetch('gid')
+        m = T.cast(membership, T::Hash[String, T.untyped])
+        project_gid = T.cast(m.fetch('project'), T::Hash[String, T.untyped]).fetch('gid')
         next unless portfolio_project_gids.include?(project_gid)
         return true if seen
 
@@ -341,7 +348,7 @@ module Checkoff
       @task_hashes ||= Checkoff::Internal::TaskHashes.new
     end
 
-    # @param workspace_name [String]
+    # @param workspace_name [String, Symbol]
     # @param project_name [String, Symbol]
     # @param section_name [String, nil, Symbol] - :unspecified
     # @param only_uncompleted [Boolean]
@@ -377,8 +384,8 @@ module Checkoff
       @projects ||= @sections.projects
     end
 
-    # @sg-ignore
     # @return [String]
+    # @sg-ignore
     def default_assignee_gid
       @config.fetch(:default_assignee_gid)
     end

data/lib/checkoff/timelines.rb

@@ -47,9 +47,9 @@ module Checkoff
 
     # @param task [Asana::Resources::Task]
     # @param limit_to_portfolio_gid [String, nil]
+    # @return [Boolean]
     def task_dependent_on_previous_section_last_milestone?(task, limit_to_portfolio_gid: nil)
       task_data = @tasks.task_to_h(task)
-      # @sg-ignore
       # @type [Array<Hash{String => Hash{String => String}}>]
       memberships_data = task_data.fetch('memberships')
       memberships_data.all? do |membership_data|
@@ -57,12 +57,15 @@ module Checkoff
         section_data = membership_data.fetch('section')
         section_gid = section_data.fetch('gid')
         section = @sections.section_by_gid(section_gid)
+        # @sg-ignore
         task_data_dependent_on_previous_section_last_milestone?(task_data, section)
       end
     end
 
     # @param task [Asana::Resources::Task]
     # @param limit_to_portfolio_name [String, nil]
+    # @return [Boolean]
+    # @sg-ignore
     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,
@@ -72,12 +75,13 @@ module Checkoff
       all_dependent_task_gids = nil
       task.memberships.all? do |membership_data|
         unless limit_to_portfolio_name.nil?
+          # @sg-ignore
           project_gid = membership_data.fetch('project').fetch('gid')
           next true unless limit_to_projects.map(&:gid).include? project_gid
         end
-        # @type [Hash{String => String}]
+        # @sg-ignore
         section_data = membership_data.fetch('section')
-        # @type [String]
+        # @sg-ignore
         section_gid = section_data.fetch('gid')
 
         last_milestone = last_milestone_in_section(section_gid)
@@ -88,12 +92,15 @@ module Checkoff
 
         all_dependent_task_gids ||= @tasks.all_dependent_tasks(task).map(&:gid)
 
+        # @sg-ignore
         all_dependent_task_gids.include? last_milestone.gid
       end
     end
 
     # @param task [Asana::Resources::Task]
     # @param limit_to_portfolio_name [String, nil]
+    # @return [Boolean]
+    # @sg-ignore
     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,
@@ -103,6 +110,7 @@ module Checkoff
       all_dependent_milestones = nil
       task.memberships.all? do |membership_data|
         unless limit_to_portfolio_name.nil?
+          # @sg-ignore
           project_gid = membership_data.fetch('project').fetch('gid')
           next true unless limit_to_projects.map(&:gid).include? project_gid
         end
@@ -116,6 +124,7 @@ module Checkoff
             dependent_task.resource_subtype == 'milestone'
           end
 
+        # @sg-ignore
         all_dependent_milestones.any? do |milestone|
           milestone.memberships.any? do |milestone_membership_data|
             milestone_membership_data.fetch('project').fetch('gid') == project_gid
@@ -148,7 +157,6 @@ module Checkoff
       previous_section_last_milestone = last_milestone_in_section(previous_section.gid)
       return true if previous_section_last_milestone.nil?
 
-      # @sg-ignore
       # @type [Array<Hash{String => String}>]
       dependencies = task_data.fetch('dependencies')
       return false if dependencies.empty?
@@ -167,10 +175,8 @@ module Checkoff
     class << self
       # @return [void]
       def run
-        # @sg-ignore
         # @type [String]
         # workspace_name = ARGV[0] || raise('Please pass workspace name as first argument')
-        # @sg-ignore
         # @type [String]
         # timeline_name = ARGV[1] || raise('Please pass timeline name as second argument')
         # timelines = Checkoff::Timelines.new

data/lib/checkoff/timing.rb

@@ -43,6 +43,7 @@ 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)
 
@@ -71,9 +72,7 @@ module Checkoff
 
       date = date_or_time.to_date
 
-      # @sg-ignore
       n_days_from_today = @today_getter.today + num_days
-      # @sg-ignore
       date >= n_days_from_today
     end
 
@@ -92,9 +91,7 @@ module Checkoff
 
       date = date_or_time.to_date
 
-      # @sg-ignore
       n_days_ago = @today_getter.today - num_days
-      # @sg-ignore
       date < n_days_ago
     end
 
@@ -174,14 +171,15 @@ module Checkoff
     #
     # @return [Time]
     def n_days_from_now(num_days)
-      (@now_getter.now + (num_days * 24 * 60 * 60))
+      Time.at(@now_getter.now.to_i + (num_days * 86_400))
     end
 
     # @param num_days [Integer]
     #
     # @return [Date]
+    # @sg-ignore
     def n_days_from_today(num_days)
-      (@today_getter.today + num_days)
+      @today_getter.today + num_days
     end
 
     # @param date_or_time [Date,Time,nil]
@@ -212,7 +210,6 @@ module Checkoff
     # @param period_name [Symbol]
     # @param args [Object]
     def compound_in_period?(date_or_time, period_name, *args)
-      # @sg-ignore
       return less_than_n_days_ago?(date_or_time, *args) if period_name == :less_than_n_days_ago
 
       return less_than_n_days_from_now?(date_or_time, *args) if period_name == :less_than_n_days_from_now
@@ -225,9 +222,9 @@ module Checkoff
         return greater_than_or_equal_to_n_days_from_today?(date_or_time, *args)
       end
 
-      # @sg-ignore
       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.243.0'
+  VERSION = '0.244.0'
 end

data/lib/checkoff/workspaces.rb

@@ -34,8 +34,7 @@ module Checkoff
     end
 
     # Pulls an Asana workspace object
-    # @param [String] workspace_name
-    # @sg-ignore
+    # @param [String, Symbol] workspace_name
     # @return [Asana::Resources::Workspace, nil]
     def workspace(workspace_name)
       client.workspaces.find_all.find do |workspace|
@@ -45,13 +44,15 @@ module Checkoff
     cache_method :workspace, LONG_CACHE_TIME
 
     # @return [Asana::Resources::Workspace]
+    # @sg-ignore
     def default_workspace
       @asana_workspace.find_by_id(client, default_workspace_gid)
     end
     cache_method :default_workspace, REALLY_LONG_CACHE_TIME
 
-    # @param [String] workspace_name
+    # @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?
@@ -59,8 +60,8 @@ module Checkoff
       w
     end
 
-    # @sg-ignore
     # @return [String]
+    # @sg-ignore
     def default_workspace_gid
       @config.fetch(:default_workspace_gid)
     end