checkoff 0.228.0 → 0.229.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e45b3232b765bca7bb6fbee30ad5f42c4b468a22a3e8cc23364d38cb4892cbb7
-  data.tar.gz: 94a438965b5a9a2fd471ca051e708539303917b3cdc2adc21c7426acb6da3313
+  metadata.gz: 6f57a81625b3c25ed144505d114057cd46d6282436a8a44e5b597b75b35938fc
+  data.tar.gz: f48a21ca0f749f54111e0e38c6d0b410a322a5a5ab5172f3a8e3a2099cffce89
 SHA512:
-  metadata.gz: 25517dee54899096ed93e72f87b441dd6a86c1970a53d7f86bb78b289d44afd7e7fae7beb6e14982ec062d7876b638df25d414c1a515b428f467026d56831360
-  data.tar.gz: 5ff93cfdd549f16b367069379490dcf2acf868d3509df899c82d5df80dda41aaed35d727a2a20a1ac8f5000b8411828fc40d170678c66dbd2b31ddf41486ced3
+  metadata.gz: f8f4325f1043ea9478fe19fbeaa640aca3b6aa017761a1e97cfedba663a2d4e3c94aa67c562a7f12d0b7d72953bf1e96351486620b3016c810f56a3fdd1f6c4b
+  data.tar.gz: 363ead40190b064f57cd0eee22de909c00960667aa6dfcf23aca938f406375a61983c731fcf6d9929892ee69327aefcbbf2cf70663bedbc8aff67fb297de3ec6

data/checkoff.gemspec

@@ -29,12 +29,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'activesupport'
-  spec.add_runtime_dependency 'asana', '>0.10.0'
-  spec.add_runtime_dependency 'cache_method'
-  spec.add_runtime_dependency 'gli'
-  spec.add_runtime_dependency 'mime-types'
-  spec.add_runtime_dependency 'sorbet-runtime'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'asana', '>0.10.0'
+  spec.add_dependency 'cache_method'
+  spec.add_dependency 'gli'
+  spec.add_dependency 'mime-types'
+  spec.add_dependency 'sorbet-runtime'
 
   spec.metadata = {
     'rubygems_mfa_required' => 'false',

data/lib/checkoff/cli.rb

@@ -14,6 +14,10 @@ require_relative 'sections'
 module Checkoff
   # Move tasks from one place to another
   class MvSubcommand
+    # @param from_workspace_arg [Symbol,String]
+    # @param from_project_arg [Symbol,String]
+    # @param from_section_arg [nil,String]
+    # @return [void]
     def validate_and_assign_from_location(from_workspace_arg, from_project_arg, from_section_arg)
       if from_workspace_arg == :default_workspace
         # Figure out what to do here - we accept a default
@@ -28,6 +32,9 @@ module Checkoff
       @from_section_name = from_section_arg
     end
 
+    # @param to_project_arg [Symbol, String]
+    #
+    # @return [String, Symbol]
     def create_to_project_name(to_project_arg)
       if to_project_arg == :source_project
         from_project_name
@@ -36,6 +43,9 @@ module Checkoff
       end
     end
 
+    # @param to_section_arg [Symbol, String, nil] :source_section
+    #
+    # @return [nil, String, Symbol]
     def create_to_section_name(to_section_arg)
       if to_section_arg == :source_section
         from_section_name
@@ -44,6 +54,10 @@ module Checkoff
       end
     end
 
+    # @param to_workspace_arg [Symbol, String]
+    # @param to_project_arg [Symbol, String]
+    # @param to_section_arg [Symbol, String, nil] :source_section
+    # @return [void]
     def validate_and_assign_to_location(to_workspace_arg, to_project_arg, to_section_arg)
       @to_workspace_name = to_workspace_arg
       @to_workspace_name = from_workspace_name if to_workspace_arg == :source_workspace
@@ -55,6 +69,17 @@ module Checkoff
       raise NotImplementedError, 'Not implemented: Teach me how to move tasks between workspaces'
     end
 
+    # @param from_workspace_arg [Symbol, String]
+    # @param from_project_arg [Symbol, String]
+    # @param from_section_arg [nil, String]
+    # @param to_workspace_arg [Symbol, String]
+    # @param to_project_arg [Symbol, String]
+    # @param to_section_arg [Symbol, String, nil] :source_section
+    # @param config [Checkoff::Internal::EnvFallbackConfigLoader, Hash]
+    # @param projects [Checkoff::Projects]
+    # @param sections [Checkoff::Sections]
+    # @param logger [IO]
+    # @return [void]
     def initialize(from_workspace_arg:,
                    from_project_arg:,
                    from_section_arg:,
@@ -73,15 +98,23 @@ module Checkoff
       @logger = logger
     end
 
+    # @param tasks [Enumerable<Asana::Resources::Task>]
+    # @param to_project [Asana::Resources::Project]
+    # @param to_section [Asana::Resources::Section]
+    # @return [void]
     def move_tasks(tasks, to_project, to_section)
       tasks.each do |task|
-        # a. check if already in correct project and section (TODO)
+        # a. check if already in correct project and section (future)
         # b. if not, put it there
         @logger.puts "Moving #{task.name} to #{to_section.name}..."
         task.add_project(project: to_project.gid, section: to_section.gid)
       end
     end
 
+    # @param from_workspace_name [String]
+    # @param from_project_name [String, Symbol]
+    # @param from_section_name [String, Symbol]
+    # @return [Enumerable<Asana::Resources::Task>]
     def fetch_tasks(from_workspace_name, from_project_name, from_section_name)
       if from_section_name == :all_sections
         raise NotImplementedError, 'Not implemented: Teach me how to move all sections of a project'
@@ -90,6 +123,7 @@ module Checkoff
       sections.tasks(from_workspace_name, from_project_name, from_section_name)
     end
 
+    # @return [void]
     def run
       # 0. Look up project and section gids
       to_project = projects.project_or_raise(to_workspace_name, to_project_name)
@@ -109,6 +143,8 @@ module Checkoff
                 :to_workspace_name, :to_project_name, :to_section_name,
                 :projects, :sections
 
+    # @param project_arg [String]
+    # @return [Symbol, String]
     def project_arg_to_name(project_arg)
       if project_arg.start_with? ':'
         project_arg[1..].to_sym
@@ -120,6 +156,15 @@ module Checkoff
 
   # CLI subcommand that shows tasks in JSON form
   class ViewSubcommand
+    # @param workspace_name [String]
+    # @param project_name [String, Symbol]
+    # @param section_name [String, Symbol, nil]
+    # @param task_name [String, Symbol, nil]
+    # @param config [Checkoff::Internal::EnvFallbackConfigLoader, Hash]
+    # @param projects [Checkoff::Projects]
+    # @param sections [Checkoff::Sections]
+    # @param tasks [Checkoff::Tasks]
+    # @param stderr [IO]
     def initialize(workspace_name, project_name, section_name,
                    task_name,
                    config: Checkoff::Internal::ConfigLoader.load(:asana),
@@ -138,6 +183,7 @@ module Checkoff
       @tasks = tasks
     end
 
+    # @return [void]
     def run
       if section_name.nil?
         run_on_project(workspace_name, project_name)
@@ -150,6 +196,8 @@ module Checkoff
 
     private
 
+    # @param project_name [String]
+    # @return [String, Symbol]
     def validate_and_assign_project_name(project_name)
       @project_name = if project_name.start_with? ':'
                         project_name[1..].to_sym
@@ -158,6 +206,9 @@ module Checkoff
                       end
     end
 
+    # @param workspace [String, Symbol]
+    # @param project [String, Symbol]
+    # @return [String]
     def run_on_project(workspace, project)
       tasks_by_section =
         sections.tasks_by_section(workspace, project)
@@ -167,18 +218,29 @@ module Checkoff
       tasks_by_section.to_json
     end
 
+    # @param workspace [String, Symbol]
+    # @param project [String, Symbol]
+    # @param section [String, Symbol, nil]
+    # @return [String]
     def run_on_section(workspace, project, section)
       section = nil if section == ''
       tasks = sections.tasks(workspace, project, section) || []
       tasks_to_hash(tasks).to_json
     end
 
+    # @param workspace [String, Symbol]
+    # @param project [String, Symbol]
+    # @param section [String, Symbol, nil]
+    # @param task_name [String]
+    # @return [String]
     def run_on_task(workspace, project, section, task_name)
       section = nil if section == ''
       task = tasks.task(workspace, project, task_name, section_name: section)
       task_to_hash(task).to_json
     end
 
+    # @param task [Asana::Resources::Task]
+    # @return [Hash{Symbol => undefined}]
     def task_to_hash(task)
       task_out = {
         name: task.name,
@@ -191,6 +253,8 @@ module Checkoff
       task_out
     end
 
+    # @param tasks [Enumerable<Asana::Resources::Task>]
+    # @return [Array<Hash>]
     def tasks_to_hash(tasks)
       tasks.map { |task| task_to_hash(task) }
     end
@@ -200,6 +264,11 @@ module Checkoff
 
   # CLI subcommand that creates a task
   class QuickaddSubcommand
+    # @param workspace_name [String]
+    # @param task_name [String]
+    # @param config [Internal::EnvFallbackConfigLoader, Hash]
+    # @param workspaces [Checkoff::Workspaces]
+    # @param tasks [Checkoff::Tasks]
     def initialize(workspace_name, task_name,
                    config: Checkoff::Internal::ConfigLoader.load(:asana),
                    workspaces: Checkoff::Workspaces.new(config:),
@@ -210,6 +279,7 @@ module Checkoff
       @tasks = tasks
     end
 
+    # @return [void]
     def run
       workspace = @workspaces.workspace_or_raise(workspace_name)
       @tasks.add_task(task_name,

data/lib/checkoff/clients.rb

@@ -19,7 +19,7 @@ module Checkoff
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE
 
-    # @param config [Checkoff::Internal::EnvFallbackConfigLoader]
+    # @param config [Hash, Checkoff::Internal::EnvFallbackConfigLoader]
     # @param asana_client_class [Class<Asana::Client>]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
                    asana_client_class: Asana::Client)

data/lib/checkoff/custom_fields.rb

@@ -24,7 +24,7 @@ module Checkoff
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE
 
-    # @param config [Checkoff::Internal::EnvFallbackConfigLoader]
+    # @param config [Hash, Checkoff::Internal::EnvFallbackConfigLoader]
     # @param workspaces [Checkoff::Workspaces]
     # @param clients [Checkoff::Clients]
     # @param client [Asana::Client]
@@ -93,7 +93,7 @@ module Checkoff
     end
 
     # @sg-ignore
-    # @param project [Asana::Resources::Task,Asana::Resources::Project]
+    # @param resource [Asana::Resources::Task,Asana::Resources::Project]
     # @param custom_field_name [String]
     # @return [Hash, nil]
     def resource_custom_field_by_name(resource, custom_field_name)
@@ -144,7 +144,7 @@ module Checkoff
 
     private
 
-    # @param custom_field [Hash{String => [Hash,Array<Hash>]}]
+    # @param custom_field [Hash{String => Hash,Array<Hash>}]
     #
     # @sg-ignore
     # @return [Array<Hash>]

data/lib/checkoff/events.rb

@@ -33,7 +33,7 @@ module Checkoff
     SHORT_CACHE_TIME = MINUTE
     private_constant :SHORT_CACHE_TIME
 
-    # @param config [Checkoff::Internal::EnvFallbackConfigLoader]
+    # @param config [Checkoff::Internal::EnvFallbackConfigLoader,Hash]
     # @param workspaces [Checkoff::Workspaces]
     # @param tasks [Checkoff::Tasks]
     # @param sections [Checkoff::Sections]
@@ -79,9 +79,9 @@ module Checkoff
       asana_event_enrichment.enrich_event(asana_event)
     end
 
-    # @param filter [Hash<String,[String,Array<String>]>]
+    # @param filter [Hash{String => String, Array<String>}]
     #
-    # @return [Hash<String,[String,Array<String>]>]
+    # @return [Hash{String => String, Array<String>}]
     def enrich_filter(filter)
       asana_event_enrichment.enrich_filter(filter)
     end

data/lib/checkoff/internal/asana_event_enrichment.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require 'forwardable'
@@ -22,7 +22,6 @@ module Checkoff
       # @param resources [Checkoff::Resources]
       # @param clients [Checkoff::Clients]
       # @param client [Asana::Client]
-      # @param asana_event_enrichment [Checkoff::Internal::AsanaEventEnrichment]
       def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
                      workspaces: Checkoff::Workspaces.new(config:),
                      tasks: Checkoff::Tasks.new(config:),
@@ -53,9 +52,9 @@ module Checkoff
         asana_event
       end
 
-      # @param filter [Hash<String,[String,Array<String>]>]
+      # @param filter [Hash{String => String, Array<String>}]
       #
-      # @return [Hash<String,[String,Array<String>]>]
+      # @return [Hash{String => String, Array<String>}]
       def enrich_filter(filter)
         filter = filter.dup
         enrich_filter_section!(filter)
@@ -64,7 +63,7 @@ module Checkoff
         filter
       end
 
-      # @param webhook_subscription [Hash] Hash of the request made to
+      # @param webhook_subscription [Hash, nil] Hash of the request made to
       #   webhook POST endpoint - https://app.asana.com/api/1.0/webhooks
       #   https://developers.asana.com/reference/createwebhook
       #
@@ -88,27 +87,26 @@ module Checkoff
       # @param gid [String]
       # @param resource_type [String,nil]
       #
-      # @return [Array<([String, nil], [String,nil])>]
+      # @return [Array([String, nil], [String, nil])]
       def enrich_gid(gid, resource_type: nil)
         # @sg-ignore
         resource, resource_type = resources.resource_by_gid(gid, resource_type:)
         [resource&.name, resource_type]
       end
 
-      # @param filter [Hash{String => String}]
+      # @param filter [Hash{String => String, Array<String>}]
       #
       # @return [String, nil]
       def enrich_filter_parent_gid!(filter)
         parent_gid = filter['checkoff:parent.gid']
         return unless parent_gid
 
-        # @sg-ignore
         name, resource_type = enrich_gid(parent_gid)
         filter['checkoff:enriched:parent.name'] = name if name
         filter['checkoff:enriched:parent.resource_type'] = resource_type if resource_type
       end
 
-      # @param filter [Hash{String => String}]
+      # @param filter [Hash{String => String, Array<String>}]
       #
       # @return [void]
       def enrich_filter_resource!(filter)
@@ -117,14 +115,15 @@ module Checkoff
         return unless resource_gid
 
         task = tasks.task_by_gid(resource_gid)
-        filter['checkoff:enriched:resource.name'] = task.name if task
+        task_name = task&.name
+        filter['checkoff:enriched:resource.name'] = task_name if task_name
       end
 
-      # @param filter [Hash{String => [String,Array<String>]}]
+      # @param filter [Hash{String => String, Array<String>}]
       #
       # @return [void]
       def enrich_filter_section!(filter)
-        section_gid = filter['checkoff:fetched.section.gid']
+        section_gid = T.cast(filter['checkoff:fetched.section.gid'], T.nilable(String))
         return unless section_gid
 
         section = sections.section_by_gid(section_gid)
@@ -156,8 +155,8 @@ module Checkoff
       #
       # @return [void]
       def enrich_event_resource!(asana_event)
-        # @type [Hash{String => String }]
-        resource = asana_event['resource']
+        # @type [Hash{String => String}]
+        resource = T.cast(asana_event['resource'], T::Hash[String, String])
         # @type [String]
         resource_type = resource.fetch('resource_type')
 

data/lib/checkoff/internal/config_loader.rb

@@ -9,7 +9,7 @@ module Checkoff
     # Use the provided config from a YAML file, and fall back to env
     # variable if it's not populated for a key'
     class EnvFallbackConfigLoader
-      # @param config [Hash<Symbol, Object>]
+      # @param config [Hash{Symbol => undefined}]
       # @param sym [Symbol]
       # @param yaml_filename [String]
       def initialize(config, sym, yaml_filename)
@@ -50,6 +50,8 @@ module Checkoff
     # Load configuration file
     class ConfigLoader
       class << self
+        # @param sym [Symbol]
+        #
         # @return [EnvFallbackConfigLoader]
         def load(sym)
           yaml_result = load_yaml_file(sym)
@@ -59,7 +61,7 @@ module Checkoff
         private
 
         # @param sym [Symbol]
-        # @return [Hash<[String, Symbol], Object>]
+        # @return [Hash{Symbol => undefined}]
         def load_yaml_file(sym)
           filename = yaml_filename(sym)
           return {} unless File.exist?(filename)

data/lib/checkoff/internal/logging.rb

@@ -5,11 +5,14 @@ require 'logger'
 
 # include this to add ability to log at different levels
 module Logging
+  # @sg-ignore
   # @return [::Logger]
   def logger
+    # @type [::Logger]
     # @sg-ignore
     @logger ||= if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
                   # @sg-ignore
+                  # @type [::Logger]
                   Rails.logger
                 else
                   ::Logger.new($stdout, level: log_level)

data/lib/checkoff/internal/project_selector_evaluator.rb

@@ -26,17 +26,20 @@ module Checkoff
       super()
     end
 
-    private
-
     COMMON_FUNCTION_EVALUATORS = (Checkoff::SelectorClasses::Common.constants.map do |const|
       Checkoff::SelectorClasses::Common.const_get(const)
     end - [Checkoff::SelectorClasses::Common::FunctionEvaluator]).freeze
+    private_constant :COMMON_FUNCTION_EVALUATORS
 
     PROJECT_FUNCTION_EVALUATORS = (Checkoff::SelectorClasses::Project.constants.map do |const|
       Checkoff::SelectorClasses::Project.const_get(const)
     end - [Checkoff::SelectorClasses::Project::FunctionEvaluator]).freeze
+    private_constant :PROJECT_FUNCTION_EVALUATORS
 
     FUNCTION_EVALUTORS = (COMMON_FUNCTION_EVALUATORS + PROJECT_FUNCTION_EVALUATORS).freeze
+    private_constant :FUNCTION_EVALUTORS
+
+    private
 
     # @return [Array<Class<Checkoff::SelectorClasses::Project::FunctionEvaluator>>]
     def function_evaluators

data/lib/checkoff/internal/project_timing.rb

@@ -20,7 +20,6 @@ module Checkoff
       end
 
       # @param project [Asana::Resources::Project]
-      # @param field_name [Symbol]
       #
       # @sg-ignore
       # @return [Date, nil]
@@ -31,7 +30,6 @@ module Checkoff
       end
 
       # @param project [Asana::Resources::Project]
-      # @param field_name [Symbol]
       #
       # @sg-ignore
       # @return [Date, nil]

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

@@ -10,16 +10,16 @@ module Checkoff
       # Convert custom field parameters from an Asana search URL into
       # API search arguments and Checkoff task selectors
       class CustomFieldParamConverter
-        # @param custom_field_params [Hash<String, Array<String>>]
+        # @param custom_field_params [Hash{String => Array<String>}]
         def initialize(custom_field_params:)
           @custom_field_params = custom_field_params
         end
 
-        # @return [Array(Hash<String, String>, Array<[Symbol, Array]>)]
+        # @return [Array(Hash{String => String}, Array<Symbol, Array>)]
         def convert
-          # @type args [Hash<String, String>]
+          # @type args [Hash{String => String}]
           args = {}
-          # @type task_selector [Array<[Symbol, Array]>]
+          # @type task_selector [Array<Symbol, Array>]
           task_selector = []
           by_custom_field.each do |gid, single_custom_field_params|
             # @sg-ignore
@@ -37,14 +37,14 @@ module Checkoff
         private
 
         # @sg-ignore
-        # @return [Hash<String, Hash>]
+        # @return [Hash{String => Hash}]
         def by_custom_field
           custom_field_params.group_by do |key, _value|
             gid_from_custom_field_key(key)
           end.transform_values(&:to_h)
         end
 
-        # @type [Hash<String, Class<CustomFieldVariant>]
+        # @type [Hash{String => Class<CustomFieldVariant>}]
         VARIANTS = {
           'is' => CustomFieldVariant::Is,
           'no_value' => CustomFieldVariant::NoValue,
@@ -57,22 +57,22 @@ module Checkoff
           'contains_any' => CustomFieldVariant::ContainsAny,
           'contains_all' => CustomFieldVariant::ContainsAll,
         }.freeze
+        private_constant :VARIANTS
 
         # @param gid [String]
-        # @param single_custom_field_params [Hash<String, Array<String>>]
+        # @param single_custom_field_params [Hash{String => Array<String>}]
         # @sg-ignore
-        # @return [Array(Hash<String, String>, Array<[Symbol, Array]>)]
+        # @return [Array(Hash{String => String}, Array<Symbol, Array>)]
         def convert_single_custom_field_params(gid, single_custom_field_params)
           variant_key = "custom_field_#{gid}.variant"
           variant = single_custom_field_params.fetch(variant_key)
           remaining_params = single_custom_field_params.reject { |k, _v| k == variant_key }
           raise "Teach me how to handle #{variant_key} = #{variant}" unless variant.length == 1
 
-          # @sg-ignore
-          # @type variant_class [Class<CustomFieldVariant>]
+          # @type [Class<CustomFieldVariant>]
           variant_class = VARIANTS[variant[0]]
-          # @type [Array(Hash<String, String>, Array<[Symbol, Array]>)]
           # @sg-ignore
+          # @type [Array(Hash{String => String}, Array<Symbol, Array>)]
           return variant_class.new(gid, remaining_params).convert unless variant_class.nil?
 
           raise "Teach me how to handle #{variant_key} = #{variant}"
@@ -84,7 +84,7 @@ module Checkoff
           key.split('_')[2].split('.')[0]
         end
 
-        # @return [Hash<String, Array<String>>]
+        # @return [Hash{String => Array<String>}]
         attr_reader :custom_field_params
       end
     end