checkoff 0.194.0 → 0.195.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebec494187b376d4803fa45da76cfdb6ca3b958290ec0308caacb4ac895fa092
-  data.tar.gz: 7d2fd1701ecbae61048495a6eb91587a3cc384f3aa067f01b7b580e9807d02a0
+  metadata.gz: c777dc82cc51fd0ec445c1413fc6f33ed37e98b8a41026446cec61f800ec0417
+  data.tar.gz: bb7edb3ed4eb31a171cd4204a338ea56b6097a4cee8bf299e451ee7ecf342e59
 SHA512:
-  metadata.gz: 9ce29418e9649e852ce60b1a3ac8c166e7da1d06bb52d496356bb01022be067b26846b82b631842ae80a8703824ba84731fd585c621df4b982effebdb3b50452
-  data.tar.gz: 29997815ab3aa694eb4d67758fb6cdd8f2e06a2467006b54b13f82c00ad3e385773e8ad69da448e7ef563d2b4c938b6e8719e923ddc95abe06d6f79403151444
+  metadata.gz: 794bf6eba0270a4cb002421f2e0857b20268d348bec359dc5d1363f345a60f385d1dea1cf26f0530cabd015e1f06b4b037ca54b342174ac5415c1f93eed3afa7
+  data.tar.gz: c9263dd810014f080b6d52c6954dd86aca9f837b88e10c711be154c49f7652cdba92303d462bee08a1c25a2f34b3ef3b85a14557410892c052916ea82a7eb098

data/Gemfile.lock

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

data/lib/checkoff/internal/asana_event_enrichment.rb

@@ -18,6 +18,7 @@ module Checkoff
       # @param tasks [Checkoff::Tasks]
       # @param sections [Checkoff::Sections]
       # @param projects [Checkoff::Projects]
+      # @param resources [Checkoff::Resources]
       # @param clients [Checkoff::Clients]
       # @param client [Asana::Client]
       # @param asana_event_enrichment [Checkoff::Internal::AsanaEventEnrichment]
@@ -26,12 +27,14 @@ module Checkoff
                      tasks: Checkoff::Tasks.new(config: config),
                      sections: Checkoff::Sections.new(config: config),
                      projects: Checkoff::Projects.new(config: config),
+                     resources: Checkoff::Resources.new(config: config),
                      clients: Checkoff::Clients.new(config: config),
                      client: clients.client)
         @workspaces = workspaces
         @tasks = tasks
         @sections = sections
         @projects = projects
+        @resources = resources
         @client = client
       end
 
@@ -86,13 +89,9 @@ module Checkoff
       #
       # @return [Array<([String, nil], [String,nil])>]
       def enrich_gid(gid, resource_type: nil)
-        %w[task section project].each do |resource_type_to_try|
-          next unless [resource_type_to_try, nil].include?(resource_type)
-
-          name = method(:"enrich_#{resource_type_to_try}_gid").call(gid)
-          return [name, resource_type_to_try] if name
-        end
-        [nil, nil]
+        # @sg-ignore
+        resource, resource_type = resources.resource_by_gid(gid, resource_type: resource_type)
+        [resource&.name, resource_type]
       end
 
       # @param filter [Hash{String => String}]
@@ -108,30 +107,6 @@ module Checkoff
         filter['checkoff:enriched:parent.resource_type'] = resource_type if resource_type
       end
 
-      # @param gid [String]
-      #
-      # @return [String, nil]
-      def enrich_task_gid(gid)
-        task = tasks.task_by_gid(gid, only_uncompleted: false)
-        task&.name
-      end
-
-      # @param section_gid [String]
-      #
-      # @return [String, nil]
-      def enrich_section_gid(section_gid)
-        section = sections.section_by_gid(section_gid)
-        section&.name
-      end
-
-      # @param project_gid [String]
-      #
-      # @return [String, nil]
-      def enrich_project_gid(project_gid)
-        project = projects.project_by_gid(project_gid)
-        project&.name
-      end
-
       # @param filter [Hash{String => String}]
       #
       # @return [void]
@@ -151,7 +126,8 @@ module Checkoff
         section_gid = filter['checkoff:fetched.section.gid']
         return unless section_gid
 
-        name = enrich_section_gid(section_gid)
+        section = sections.section_by_gid(section_gid)
+        name = section&.name
         filter['checkoff:enriched:fetched.section.name'] = name if name
       end
 
@@ -208,6 +184,9 @@ module Checkoff
       # @return [Checkoff::Workspaces]
       attr_reader :workspaces
 
+      # @return [Checkoff::Resources]
+      attr_reader :resources
+
       # @return [Asana::Client]
       attr_reader :client
     end

data/lib/checkoff/resources.rb

@@ -0,0 +1,131 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'cache_method'
+require_relative 'internal/config_loader'
+require_relative 'workspaces'
+require_relative 'clients'
+
+# https://developers.asana.com/reference/resources
+
+module Checkoff
+  # Deal with Asana resources across different resource types
+  class Resources
+    # @!parse
+    #   extend CacheMethod::ClassMethods
+
+    MINUTE = 60
+    private_constant :MINUTE
+    HOUR = MINUTE * 60
+    private_constant :HOUR
+    DAY = 24 * HOUR
+    private_constant :DAY
+    REALLY_LONG_CACHE_TIME = HOUR * 1
+    private_constant :REALLY_LONG_CACHE_TIME
+    LONG_CACHE_TIME = MINUTE * 15
+    private_constant :LONG_CACHE_TIME
+    SHORT_CACHE_TIME = MINUTE
+    private_constant :SHORT_CACHE_TIME
+
+    # @param config [Hash]
+    # @param workspaces [Checkoff::Workspaces]
+    # @param tasks [Checkoff::Tasks]
+    # @param sections [Checkoff::Sections]
+    # @param projects [Checkoff::Projects]
+    # @param clients [Checkoff::Clients]
+    # @param client [Asana::Client]
+    def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
+                   workspaces: Checkoff::Workspaces.new(config: config),
+                   tasks: Checkoff::Tasks.new(config: config),
+                   sections: Checkoff::Sections.new(config: config),
+                   projects: Checkoff::Projects.new(config: config),
+                   clients: Checkoff::Clients.new(config: config),
+                   client: clients.client)
+      @workspaces = workspaces
+      @tasks = tasks
+      @sections = sections
+      @projects = projects
+      @client = client
+    end
+
+    # Attempt to look up a GID, even in situations where we don't
+    # have a resource type provided.
+    #
+    # @param gid [String]
+    # @param resource_type [String,nil]
+    #
+    # @return [Array<([Asana::Resource, nil], [String,nil])>]
+    def resource_by_gid(gid, resource_type: nil)
+      %w[task section project].each do |resource_type_to_try|
+        next unless [resource_type_to_try, nil].include?(resource_type)
+
+        resource = method(:"fetch_#{resource_type_to_try}_gid").call(gid)
+        return [resource, resource_type_to_try] if resource
+      end
+      [nil, nil]
+    end
+
+    private
+
+    # @param gid [String]
+    #
+    # @return [Asana::Resources::Task, nil]
+    def fetch_task_gid(gid)
+      tasks.task_by_gid(gid, only_uncompleted: false)
+    end
+
+    # @param section_gid [String]
+    #
+    # @return [Asana::Resources::Section, nil]
+    def fetch_section_gid(section_gid)
+      sections.section_by_gid(section_gid)
+    end
+
+    # @param project_gid [String]
+    #
+    # @return [Asana::Resources::Project, nil]
+    def fetch_project_gid(project_gid)
+      projects.project_by_gid(project_gid)
+    end
+
+    # @return [Checkoff::Workspaces]
+    attr_reader :workspaces
+
+    # @return [Checkoff::Projects]
+    attr_reader :projects
+
+    # @return [Checkoff::Sections]
+    attr_reader :sections
+
+    # @return [Checkoff::Tasks]
+    attr_reader :tasks
+
+    # @return [Asana::Client]
+    attr_reader :client
+
+    # bundle exec ./resources.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]
+        # resource_name = ARGV[1] || raise('Please pass resource name as second argument')
+        # resources = Checkoff::Resources.new
+        # resource = resources.resource_or_raise(workspace_name, resource_name)
+        # puts "Results: #{resource}"
+      end
+    end
+    # :nocov:
+  end
+end
+
+# :nocov:
+abs_program_name = File.expand_path($PROGRAM_NAME)
+Checkoff::Resources.run if abs_program_name == File.expand_path(__FILE__)
+# :nocov:

data/lib/checkoff/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.194.0
+  version: 0.195.0
 platform: ruby
 authors:
 - Vince Broz
@@ -170,6 +170,7 @@ files:
 - lib/checkoff/portfolios.rb
 - lib/checkoff/project_selectors.rb
 - lib/checkoff/projects.rb
+- lib/checkoff/resources.rb
 - lib/checkoff/section_selectors.rb
 - lib/checkoff/sections.rb
 - lib/checkoff/subtasks.rb