checkoff 0.222.0 → 0.225.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cddefb59c6b268a9501c151a8c5482baedc1626ff56090a02bacd09a34e4f530
-  data.tar.gz: 733b5e95bab3a468e4fbe54e8215c70bd4d1094e48464b25e04053d29023653e
+  metadata.gz: 2e7ecdc301e24da8bcdf4893c5eac31520410584cce13060481563caabf7deba
+  data.tar.gz: ef3ebc23874cc8bfdcac13b8e7ea58ead9c105fac7f9dc7293978488a6a8b432
 SHA512:
-  metadata.gz: 21d8c9e39760f92e503efbcd98707a3935dffb077677f92e7165767cd7c305673a27810f75bd8640fe79bd6ffc1cd5f616e4787234d9ac4c84ddf4008be344d9
-  data.tar.gz: 2d6aaadfd50a74cccca45efe6ccf866e4da393f2a70bac001e7afbc912acf071a95e765de2f4ee4fb67dbf515e46db61f01c4ddb2ad507dd34e4cb213885b9fc
+  metadata.gz: 0c66ab40b991cda60fee2d3ca1badd2bee3b363a09cbffa346248ee32886c84c659f49b67badbba61749a003d7a7e5abf9a5263cd09f42fe5a4d9a962a80b252
+  data.tar.gz: 50b8cee8d14a8515222cd285041780eb2bcdab8a8835ca22ce9ab3ef9d608c89c942fb1416df851658f95e8c7dc47242ce637334023c9e2c59f5fd33a18f9bd4

data/checkoff.gemspec

@@ -15,11 +15,16 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT license'
   spec.required_ruby_version = '>= 3.0'
 
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      f.match(%r{^(test|spec|features)/})
-    end
-  end
+  spec.files         = Dir['README.md',
+                           'Rakefile',
+                           'lib/checkoff.rb',
+                           '{lib}/**/*',
+                           'sig/**/*.rbs',
+                           'sig/*.rbs',
+                           'rbi/**/*.rbi',
+                           'rbi/*.rbi',
+                           '{exe}/*',
+                           'checkoff.gemspec']
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']

data/lib/checkoff/attachments.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# typed: false
 
 # frozen_string_literal: true
 

data/lib/checkoff/cli.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# typed: ignore
+# typed: true
 
 # frozen_string_literal: true
 

data/lib/checkoff/clients.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# typed: true
 
 # frozen_string_literal: true
 
@@ -18,7 +19,7 @@ module Checkoff
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE
 
-    # @param config [Hash]
+    # @param config [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

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# typed: true
 
 # frozen_string_literal: true
 
@@ -23,7 +24,7 @@ module Checkoff
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE
 
-    # @param config [Hash]
+    # @param config [Checkoff::Internal::EnvFallbackConfigLoader]
     # @param workspaces [Checkoff::Workspaces]
     # @param clients [Checkoff::Clients]
     # @param client [Asana::Client]

data/lib/checkoff/events.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# typed: true
 
 # frozen_string_literal: true
 
@@ -32,7 +33,7 @@ module Checkoff
     SHORT_CACHE_TIME = MINUTE
     private_constant :SHORT_CACHE_TIME
 
-    # @param config [Hash]
+    # @param config [Checkoff::Internal::EnvFallbackConfigLoader]
     # @param workspaces [Checkoff::Workspaces]
     # @param tasks [Checkoff::Tasks]
     # @param sections [Checkoff::Sections]

data/lib/checkoff/internal/asana_event_enrichment.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'forwardable'

data/lib/checkoff/internal/asana_event_filter.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative 'logging'

data/lib/checkoff/internal/config_loader.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'yaml'
@@ -49,8 +50,7 @@ module Checkoff
     # Load configuration file
     class ConfigLoader
       class << self
-        # @sg-ignore
-        # @return [Hash<Symbol, Object>]
+        # @return [EnvFallbackConfigLoader]
         def load(sym)
           yaml_result = load_yaml_file(sym)
           EnvFallbackConfigLoader.new(yaml_result, sym, yaml_filename(sym))

data/lib/checkoff/internal/logging.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'logger'
@@ -15,35 +16,35 @@ module Logging
                 end
   end
 
-  # @param message [String,nil]
+  # @param message [Object,nil]
   #
   # @return [void]
   def error(message = nil, &block)
     logger.error(message, &block)
   end
 
-  # @param message [String,nil]
+  # @param message [Object,nil]
   #
   # @return [void]
   def warn(message = nil, &block)
     logger.warn(message, &block)
   end
 
-  # @param message [String,nil]
+  # @param message [Object,nil]
   #
   # @return [void]
   def info(message = nil, &block)
     logger.info(message, &block)
   end
 
-  # @param message [String,nil]
+  # @param message [Object,nil]
   #
   # @return [void]
   def debug(message = nil, &block)
     logger.debug(message, &block)
   end
 
-  # @param message [String,nil]
+  # @param message [Object,nil]
   #
   # @return [void]
   def finer(message = nil, &block)

data/lib/checkoff/internal/project_hashes.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Checkoff

data/lib/checkoff/internal/project_selector_evaluator.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative 'selector_classes/common'
@@ -37,7 +38,7 @@ module Checkoff
 
     FUNCTION_EVALUTORS = (COMMON_FUNCTION_EVALUATORS + PROJECT_FUNCTION_EVALUATORS).freeze
 
-    # @return [Array<Class<ProjectSelectorClasses::FunctionEvaluator>>]
+    # @return [Array<Class<Checkoff::SelectorClasses::Project::FunctionEvaluator>>]
     def function_evaluators
       FUNCTION_EVALUTORS
     end

data/lib/checkoff/internal/project_timing.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'checkoff/custom_fields'

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

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require_relative 'custom_field_variant'

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

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 module Checkoff

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

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require_relative 'custom_field_param_converter'

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

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# typed: false
 
 # frozen_string_literal: true
 

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

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 module Checkoff

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

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require_relative 'custom_field_param_converter'

data/lib/checkoff/internal/search_url.rb

@@ -1,3 +1,4 @@
+# typed: strict
 # frozen_string_literal: true
 
 require_relative 'search_url/parser'

data/lib/checkoff/internal/section_selector_evaluator.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative 'selector_classes/common'
@@ -38,7 +39,7 @@ module Checkoff
 
     FUNCTION_EVALUTORS = (COMMON_FUNCTION_EVALUATORS + SECTION_FUNCTION_EVALUATORS).freeze
 
-    # @return [Array<Class<ProjectSelectorClasses::FunctionEvaluator>>]
+    # @return [Array<Class<Checkoff::SelectorClasses::Project::FunctionEvaluator>>]
     def function_evaluators
       FUNCTION_EVALUTORS
     end

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

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative '../function_evaluator'

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

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require_relative 'common/function_evaluator'

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

@@ -1,3 +1,4 @@
+# typed: strict
 # frozen_string_literal: true
 
 require 'checkoff/internal/logging'

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

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative '../function_evaluator'

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

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative 'project/function_evaluator'

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

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative '../function_evaluator'
@@ -10,10 +11,11 @@ module Checkoff
         # @param selector [Array<(Symbol, Array)>,String]
         # @param client [Asana::Client]
         # @param sections [Checkoff::Sections]
+        # @param kwargs [Hash]
         def initialize(selector:,
                        sections:,
                        client:,
-                       **)
+                       **kwargs)
           @selector = selector
           @sections = sections
           @client = client

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

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require_relative 'section/function_evaluator'

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

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative '../function_evaluator'

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

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require_relative 'task/function_evaluator'

data/lib/checkoff/internal/selector_evaluator.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 module Checkoff
@@ -9,7 +10,7 @@ module Checkoff
       return true if selector.empty?
 
       function_evaluators.each do |evaluator_class|
-        # @type [SelectorClasses::FunctionEvaluator]
+        # @type [Checkoff::SelectorClasses::FunctionEvaluator]
         # @sg-ignore
         evaluator = evaluator_class.new(selector: selector,
                                         **initializer_kwargs)
@@ -29,14 +30,14 @@ module Checkoff
       {}
     end
 
-    # @return [Array<Class<FunctionEvaluator>>]
+    # @return [Array<Class<Checkoff::SelectorClasses::FunctionEvaluator>>]
     # @sg-ignore
     def function_evaluators
       raise 'Implement me!'
     end
 
     # @param selector [Array]
-    # @param evaluator [SelectorClasses::FunctionEvaluator]
+    # @param evaluator [Checkoff::SelectorClasses::FunctionEvaluator]
     # @return [Array]
     def evaluate_args(selector, evaluator)
       return [] unless selector.is_a?(Array)
@@ -51,7 +52,7 @@ module Checkoff
     end
 
     # @param selector [Array]
-    # @param evaluator [SelectorClasses::FunctionEvaluator]
+    # @param evaluator [Checkoff::SelectorClasses::FunctionEvaluator]
     # @return [Boolean, Object, nil]
     def try_this_evaluator(selector, evaluator)
       # if selector is an array

data/lib/checkoff/internal/task_hashes.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Checkoff

data/lib/checkoff/internal/task_selector_evaluator.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative 'selector_classes/common'
@@ -34,7 +35,7 @@ module Checkoff
 
     FUNCTION_EVALUTORS = (COMMON_FUNCTION_EVALUATORS + TASK_FUNCTION_EVALUATORS).freeze
 
-    # @return [Array<Class<TaskSelectorClasses::FunctionEvaluator>>]
+    # @return [Array<Class<Checkoff::SelectorClasses::Task::FunctionEvaluator>>]
     def function_evaluators
       FUNCTION_EVALUTORS
     end

data/lib/checkoff/internal/task_timing.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 module Checkoff

data/lib/checkoff/internal/thread_local.rb

@@ -1,3 +1,4 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Checkoff

data/lib/checkoff/monkeypatches/resource_marshalling.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'asana'

data/lib/checkoff/my_tasks.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'forwardable'
@@ -15,7 +16,7 @@ module Checkoff
     # @return [Checkoff::Projects]
     attr_reader :projects
 
-    # @param config [Hash<Symbol, Object>]
+    # @param config [Checkoff::Internal::EnvFallbackConfigLoader]
     # @param client [Asana::Client]
     # @param projects [Checkoff::Projects]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),

data/lib/checkoff/portfolios.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# typed: true
 
 # frozen_string_literal: true
 
@@ -8,23 +9,25 @@ require_relative 'internal/config_loader'
 require_relative 'workspaces'
 require_relative 'clients'
 require_relative 'projects'
+require 'sorbet-runtime'
 
 # https://developers.asana.com/reference/portfolios
 
 module Checkoff
   # Pull portfolios from Asana
   class Portfolios
+    extend T::Sig
     # @!parse
     #   extend CacheMethod::ClassMethods
 
     MINUTE = 60
-    HOUR = MINUTE * 60
-    DAY = 24 * HOUR
-    REALLY_LONG_CACHE_TIME = HOUR * 1
-    LONG_CACHE_TIME = MINUTE * 15
-    SHORT_CACHE_TIME = MINUTE
+    HOUR = T.let(MINUTE * 60, Numeric)
+    DAY = T.let(24 * HOUR, Numeric)
+    REALLY_LONG_CACHE_TIME = T.let(HOUR * 1, Numeric)
+    LONG_CACHE_TIME = T.let(MINUTE * 15, Numeric)
+    SHORT_CACHE_TIME = T.let(MINUTE, Numeric)
 
-    # @param config [Hash]
+    # @param config [Checkoff::Internal::EnvFallbackConfigLoader]
     # @param workspaces [Checkoff::Workspaces]
     # @param clients [Checkoff::Clients]
     # @param client [Asana::Client]
@@ -34,9 +37,9 @@ module Checkoff
                    client: clients.client,
                    projects: Checkoff::Projects.new(config: config, client: client),
                    workspaces: Checkoff::Workspaces.new(config: config, client: client))
-      @workspaces = workspaces
-      @client = client
-      @projects = projects
+      @workspaces = T.let(workspaces, Checkoff::Workspaces)
+      @client = T.let(client, Asana::Client)
+      @projects = T.let(projects, Checkoff::Projects)
     end
 
     # @param workspace_name [String]

data/lib/checkoff/project_selectors.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# typed: false
 
 # frozen_string_literal: true
 

data/lib/checkoff/projects.rb

@@ -1,3 +1,5 @@
+# typed: false
+
 # frozen_string_literal: true
 
 require_relative 'internal/config_loader'
@@ -31,7 +33,7 @@ module Checkoff
     # @!parse
     #   extend CacheMethod::ClassMethods
 
-    # @param config [Hash<Symbol, Object>]
+    # @param config [Checkoff::Internal::EnvFallbackConfigLoader]
     # @param client [Asana::Client]
     # @param workspaces [Checkoff::Workspaces]
     # @param project_hashes [Checkoff::Internal::ProjectHashes]

data/lib/checkoff/resources.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# typed: false
 
 # frozen_string_literal: true
 

data/lib/checkoff/section_selectors.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# typed: false
 
 # frozen_string_literal: true
 

data/lib/checkoff/sections.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'forwardable'
@@ -33,7 +34,7 @@ module Checkoff
     # @return [Checkoff::MyTasks]
     attr_reader :my_tasks
 
-    # @param config [Hash<Symbol, Object>]
+    # @param config [Checkoff::Internal::EnvFallbackConfigLoader]
     # @param client [Asana::Client]
     # @param projects [Checkoff::Projects]
     # @param workspaces [Checkoff::Workspaces]
@@ -47,7 +48,8 @@ module Checkoff
                    time: Time)
       @projects = projects
       @workspaces = workspaces
-      @my_tasks = Checkoff::MyTasks.new(config: config, projects: projects, client: client)
+      @my_tasks = Checkoff::MyTasks
+        .new(config: config, projects: projects, client: client)
       @client = client
       @time = time
     end
@@ -111,8 +113,6 @@ module Checkoff
       client.tasks.get_tasks(section: section_gid, **options)
     end
 
-    # XXX: Rename to section_tasks
-    #
     # Pulls task objects from a specified section
     #
     # @param workspace_name [String]

data/lib/checkoff/subtasks.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require 'forwardable'