checkoff 0.222.0 → 0.225.0

data/lib/checkoff/tags.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# typed: true
 
 # frozen_string_literal: true
 
@@ -13,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)
@@ -66,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?
@@ -75,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')
@@ -84,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/task_searches.rb

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

data/lib/checkoff/task_selectors.rb

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

data/lib/checkoff/tasks.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-# typed: true
+# typed: false
 
 # frozen_string_literal: true
 
@@ -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/timelines.rb

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

data/lib/checkoff/timing.rb

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

data/lib/checkoff/version.rb

@@ -1,7 +1,8 @@
+# typed: strict
 # frozen_string_literal: true
 
 # Command-line and gem client for Asana (unofficial)
 module Checkoff
   # Version of library
-  VERSION = '0.222.0'
+  VERSION = '0.225.0'
 end

data/lib/checkoff/workspaces.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'asana'
@@ -21,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),

data/lib/checkoff.rb

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