checkoff 0.223.0 → 0.225.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 925f4d51063a064573aba674442739e5a5fbd0e1b117c4a8480b53a7ba494104
-  data.tar.gz: 6ed947f526bd44c5ed8f8c0eb417dadd3c8c213d557931e294355fbdf1f858e9
+  metadata.gz: 2e7ecdc301e24da8bcdf4893c5eac31520410584cce13060481563caabf7deba
+  data.tar.gz: ef3ebc23874cc8bfdcac13b8e7ea58ead9c105fac7f9dc7293978488a6a8b432
 SHA512:
-  metadata.gz: d3093484531af641d774b6fd8e18f33f960d3cc21616a362be4d460d188ddfbc72300aa1befe41e92845d4a2a34153a6d18dd25e83e5b54f36718ba1192a4f0a
-  data.tar.gz: e235b3bf48f544514a95a711b4d07e4ded2b529343d507e65bbab01cbcfd6c4e9b46df6b3ee6e39373d523df330b1adebbdd1389386dcd04ae253fce2e5e5e5c
+  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/cli.rb

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

data/lib/checkoff/clients.rb

@@ -19,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

@@ -24,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

@@ -33,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/config_loader.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require 'yaml'
@@ -50,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/selector_classes/section/function_evaluator.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 require_relative '../function_evaluator'
@@ -11,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/my_tasks.rb

@@ -16,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

@@ -9,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]
@@ -35,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/projects.rb

@@ -33,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/sections.rb

@@ -34,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]
@@ -48,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
@@ -112,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/tags.rb

@@ -14,50 +14,81 @@ require_relative 'clients'
 module Checkoff
   # Work with tags in Asana
   class Tags
-    MINUTE = 60
-    HOUR = MINUTE * 60
-    DAY = 24 * HOUR
-    REALLY_LONG_CACHE_TIME = HOUR * 1
-    LONG_CACHE_TIME = MINUTE * 15
-    SHORT_CACHE_TIME = MINUTE
+    # @!parse
+    #   extend CacheMethod::ClassMethods
 
+    MINUTE = 60
+    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 [Checkoff::Internal::EnvFallbackConfigLoader]
+    # @param clients [Checkoff::Clients]
+    # @param client [Asana::Client]
+    # @param projects [Checkoff::Projects]
+    # @param workspaces [Checkoff::Workspaces]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
                    clients: Checkoff::Clients.new(config: config),
                    client: clients.client,
                    projects: Checkoff::Projects.new(config: config, client: client),
                    workspaces: Checkoff::Workspaces.new(config: config, client: client))
-      @workspaces = workspaces
-      @projects = projects
-      @client = client
+      @workspaces = T.let(workspaces, Checkoff::Workspaces)
+      @projects = T.let(projects, Checkoff::Projects)
+      @client = T.let(client, Asana::Client)
     end
 
+    # @param workspace_name [String]
+    # @param tag_name [String]
+    # @param only_uncompleted [Boolean]
+    # @param extra_fields [Array<String>]
+    #
     # @return [Enumerable<Asana::Resources::Task>]
     def tasks(workspace_name, tag_name,
               only_uncompleted: true,
               extra_fields: [])
       tag = tag_or_raise(workspace_name, tag_name)
+      tag_gid = tag.gid
 
+      tasks_by_tag_gid(workspace_name, tag_gid,
+                       only_uncompleted: only_uncompleted, extra_fields: extra_fields)
+    end
+
+    # @param workspace_name [String]
+    # @param tag_gid [String]
+    # @param only_uncompleted [Boolean]
+    # @param extra_fields [Array<String>]
+    #
+    # @return [Enumerable<Asana::Resources::Task>]
+    def tasks_by_tag_gid(workspace_name, tag_gid, only_uncompleted: true, extra_fields: [])
       options = projects.task_options(extra_fields: extra_fields,
                                       only_uncompleted: only_uncompleted)
-
       params = build_params(options)
-
-      Asana::Resources::Collection.new(parse(client.get("/tags/#{tag.gid}/tasks",
+      Asana::Resources::Collection.new(parse(client.get("/tags/#{tag_gid}/tasks",
                                                         params: params, options: options[:options])),
                                        type: Asana::Resources::Task,
                                        client: client)
     end
 
+    # @param workspace_name [String]
+    # @param tag_name [String]
+    #
     # @return [Asana::Resources::Tag]
     def tag_or_raise(workspace_name, tag_name)
-      tag = tag(workspace_name, tag_name)
-      raise "Could not find tag #{tag_name} under workspace #{workspace_name}." if tag.nil?
+      t = tag(workspace_name, tag_name)
 
-      tag
+      raise "Could not find tag #{tag_name} under workspace #{workspace_name}." if t.nil?
+
+      t
     end
     cache_method :tag_or_raise, LONG_CACHE_TIME
 
+    # @param workspace_name [String]
+    # @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)
@@ -67,8 +98,17 @@ module Checkoff
 
     private
 
-    attr_reader :workspaces, :projects, :client
-
+    # @return [Checkoff::Workspaces]
+    attr_reader :workspaces
+    # @return [Checkoff::Projects]
+    attr_reader :projects
+    # @return [Asana::Client]
+    attr_reader :client
+
+    # @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|
         v.nil? || Array(v).empty?
@@ -76,6 +116,10 @@ module Checkoff
     end
 
     # https://github.com/Asana/ruby-asana/blob/master/lib/asana/resource_includes/response_helper.rb#L7
+    #
+    # @param response [Asana::HttpClient::Response]
+    #
+    # @return [Array<Hash, Hash>]
     def parse(response)
       data = response.body.fetch('data')
       extra = response.body.except('data')
@@ -85,8 +129,13 @@ module Checkoff
     # bundle exec ./tags.rb
     # :nocov:
     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
         tag = tags.tag_or_raise(workspace_name, tag_name)

data/lib/checkoff/tasks.rb

@@ -32,7 +32,7 @@ module Checkoff
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE * 5
 
-    # @param config [Hash<Symbol, Object>]
+    # @param config [Checkoff::Internal::EnvFallbackConfigLoader]
     # @param client [Asana::Client]
     # @param workspaces [Checkoff::Workspaces]
     # @param sections [Checkoff::Sections]

data/lib/checkoff/version.rb

@@ -4,5 +4,5 @@
 # Command-line and gem client for Asana (unofficial)
 module Checkoff
   # Version of library
-  VERSION = '0.223.0'
+  VERSION = '0.225.0'
 end

data/lib/checkoff/workspaces.rb

@@ -22,7 +22,7 @@ module Checkoff
     # @!parse
     #   extend CacheMethod::ClassMethods
 
-    # @param config [Hash<Symbol, Object>]
+    # @param config [Checkoff::Internal::EnvFallbackConfigLoader]
     # @param client [Asana::Client]
     # @param asana_workspace [Class<Asana::Resources::Workspace>]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),