checkoff 0.37.0 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78eb26c757cafb9c92eb8e1127e454a3d05a0ed16548483cf0dceeca53c22114
-  data.tar.gz: 39a81ddbcb197370af6e7328664ada5a26268cc434363f7291c518e3a7ce1621
+  metadata.gz: fb28394467995eb9df10b9fa896614dca20ef97b0759c2945bb3baaf98ba0d56
+  data.tar.gz: 3b565699736d8956d83a94e8c93d910ecfac4f7f65280e27303d0da8dd3fd6ff
 SHA512:
-  metadata.gz: 1455835c137f7ed819cd6d5b774d360ee8d72b841a193955ad0b9df665a3f53568c515910b07d8221d6981a9e6f416a089add42025179c0f260cf8cc612740b5
-  data.tar.gz: 31619893659ffe14a38183190f4d299c4354f5161ee41be0647eea5f4c45bc4f297d5051311d1e16fc1b300fdbf2ef6eefd88c21256e1ac0541e3b86312b446e
+  metadata.gz: 3cfeaa16ebe32cda3959dfce64b72382e743d5dcf40a2d1771c2b2d725594f8d505f094139163bca7e6059908b02d5811260c75b7670126a1bcdf22fb306c9f6
+  data.tar.gz: 9066df52dadb002a5b8bd34a7a1fc852d1e45b4543202e21995dee9e491703357ba305b612c5772d5c9c0153e5c7245c9304988e0f5751b608bfbe03e420d214

data/Gemfile.lock

@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    checkoff (0.37.0)
+    checkoff (0.38.0)
       activesupport
       asana (> 0.10.0)
       cache_method

data/config/definitions.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+#
+# @!parse
+#   class Time
+#     class << self
+#       # @param date [String]
+#       # @return [Time]
+#       def parse(date); end
+#     end
+#   end
+#   module Asana
+#     class Client
+#       # @return [Asana::ProxiedResourceClasses::Task]
+#       def tasks; end
+#       # @return [Asana::ProxiedResourceClasses::Workspace]
+#       def workspaces; end
+#     end
+#     module Resources
+#       class Task
+#         # @return [String, nil]
+#         def html_notes; end
+#         class << self
+#           # @return [Asana::Resources::Task]
+#           def create(client, assignee:, workspace:, name:); end
+#         end
+#       end
+#     end
+#     module Resources
+#       class Workspace
+#         # @return [String, nil]
+#         def html_notes; end
+#         class << self
+#           # @return [Asana::Resources::Workspace]
+#           def find_by_id(client, id, options: {}); end
+#         end
+#       end
+#     end
+#     module ProxiedResourceClasses
+#       class Task
+#         # Returns the complete task record for a single task.
+#         #
+#         # @param id [String] The task to get.
+#         # @param options [Hash] the request I/O options.
+#         # @return [Asana::Resources::Task]
+#         def find_by_id(id, options: {}); end
+#       end
+#       class Workspace
+#         # @return [Array<Asana::Resources::Workspace>]
+#         def find_all; end
+#       end
+#     end
+#   end

data/lib/checkoff/tasks.rb

@@ -3,21 +3,30 @@
 # frozen_string_literal: true
 
 require_relative 'sections'
+require_relative 'workspaces'
 require 'asana'
 
 module Checkoff
   # Pull tasks from Asana
   class Tasks
     MINUTE = 60
+    # @sg-ignore
     HOUR = MINUTE * 60
     DAY = 24 * HOUR
     REALLY_LONG_CACHE_TIME = HOUR
+    # @sg-ignore
     LONG_CACHE_TIME = MINUTE * 15
+    # @sg-ignore
     SHORT_CACHE_TIME = MINUTE * 5
 
+    # @param client [Asana::Client]
+    # @param workspaces [Checkoff::Workspaces]
+    # @param time_class [Class<Time>]
     # @param sections [Checkoff::Sections]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
                    client: Checkoff::Clients.new(config: config).client,
+                   workspaces: Checkoff::Workspaces.new(config: config,
+                                                        client: client),
                    sections: Checkoff::Sections.new(config: config,
                                                     client: client),
                    time_class: Time,
@@ -27,6 +36,7 @@ module Checkoff
       @time_class = time_class
       @asana_task = asana_task
       @client = client
+      @workspaces = workspaces
     end
 
     def task_ready?(task)
@@ -53,9 +63,22 @@ module Checkoff
       tasks.find { |task| task.name == task_name }
     end
 
+    # Pull a specific task by name
+    # @return [Asana::Resources::Task, nil]
+    def task_by_gid(task_gid,
+                    only_uncompleted: true,
+                    extra_fields: [])
+      options = projects.task_options
+      options[:options][:fields] += extra_fields
+      options[:completed_since] = '9999-12-01' if only_uncompleted
+      client.tasks.find_by_id(task_gid, options: options)
+    end
+
+    # @param workspace_gid [String]
+    # @param assignee_gid [String]
     # @return [Asana::Resources::Task]
     def add_task(name,
-                 workspace_gid: default_workspace_gid,
+                 workspace_gid: @workspaces.default_workspace_gid,
                  assignee_gid: default_assignee_gid)
       @asana_task.create(client,
                          assignee: assignee_gid,
@@ -93,11 +116,14 @@ module Checkoff
       @projects ||= @sections.projects
     end
 
+    # @sg-ignore
     # @return [String]
     def default_assignee_gid
       @config.fetch(:default_assignee_gid)
     end
 
+    # @param task [Asana::Resources::Task]
+    # @return [Time, nil]
     def due_time(task)
       return @time_class.parse(task.due_at) if task.due_at
       return @time_class.parse(task.due_on) if task.due_on
@@ -117,6 +143,7 @@ module Checkoff
       # @sg-ignore
       # @type [Array<Asana::Resources::Task>, nil]
       already_fetched_dependencies = task.instance_variable_get(:@dependencies)
+      # @sg-ignore
       return false unless already_fetched_dependencies.nil? || already_fetched_dependencies.size.positive?
 
       task.dependencies.any? do |parent_task_info|

data/lib/checkoff/version.rb

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

data/lib/checkoff/workspaces.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'asana'
 require 'forwardable'
 require 'cache_method'
 require_relative 'internal/config_loader'
@@ -11,12 +12,16 @@ module Checkoff
   # Query different workspaces of Asana projects
   class Workspaces
     MINUTE = 60
+    # @sg-ignore
     HOUR = MINUTE * 60
     DAY = 24 * HOUR
+    # @sg-ignore
     REALLY_LONG_CACHE_TIME = HOUR * 1
+    # @sg-ignore
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE
 
+    # @param client [Asana::Client]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
                    client: Checkoff::Clients.new(config: config).client,
                    asana_workspace: Asana::Resources::Workspace)
@@ -26,12 +31,15 @@ module Checkoff
     end
 
     # Pulls an Asana workspace object
+    # @param [String] workspace_name
+    # @return [Asana::Resources::Workspace, nil]
     def workspace(workspace_name)
       client.workspaces.find_all.find do |workspace|
         workspace.name == workspace_name
       end
     end
 
+    # @return [Asana::Resources::Workspace]
     def default_workspace
       @asana_workspace.find_by_id(client, default_workspace_gid)
     end
@@ -39,18 +47,20 @@ module Checkoff
     # @param [String] workspace_name
     # @return [Asana::Resources::Workspace]
     def workspace_or_raise(workspace_name)
-      workspace = workspace(workspace_name)
-      raise "Could not find workspace #{workspace_name}" if workspace.nil?
+      w = workspace(workspace_name)
+      raise "Could not find workspace #{workspace_name}" if w.nil?
 
-      workspace
+      w
     end
 
-    private
-
-    attr_reader :client
-
+    # @sg-ignore
+    # @return [String]
     def default_workspace_gid
       @config.fetch(:default_workspace_gid)
     end
+
+    private
+
+    attr_reader :client
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.37.0
+  version: 0.38.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-28 00:00:00.000000000 Z
+date: 2023-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -411,6 +411,7 @@ files:
 - bin/solargraph
 - bin/yard
 - checkoff.gemspec
+- config/definitions.rb
 - docs/cookiecutter_input.json
 - docs/example_project.png
 - exe/checkoff