checkoff 0.92.0 → 0.94.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b750814d7176f6d66ffefaf0c99995dc1c2d6f44b0dcc99d68f777b84f44941
-  data.tar.gz: bb0045530c18cf158a8d255818640a6130eb392f2218c49d2da8c2f70e8197de
+  metadata.gz: 3728a0da90fb49dedd232b05722fbb87f03789d3bf9bc15513e4fa4b88f9e6fc
+  data.tar.gz: 16ce81c8b51905620414ff21f9469ce83c100a61985f355b8a27de20b7234b3c
 SHA512:
-  metadata.gz: 10dccc258a5a948f91cee8ff8ee0eef696dfb0a7e5ae92ae07116f26e65364dee2ebf1f89c6fcc0e17fc4ea7c83a89fda89cdab91586c747a54eef1864a7dc74
-  data.tar.gz: 5aead20f2cf559538115b8f37c394245dd10906603d307a4f4c7879696cd8e03ef40f23b3da7b898f14ae06f48b55136834b6a3bb7420486f7c5915e01ba1a22
+  metadata.gz: d73466d69b7b116eb8c58c0053b7cf13cedf288477e7cc8862de091fdd183e5a84355e19841e09df003da9b44d2b87ac90a459845c9186737069002f5312e455
+  data.tar.gz: 207d7d34ecdc3435892afe3b96860df2373e36067f8c75866f7b87d5a6f0aac0ebe89b0889b45d6a31ddec1ac6211f592fce4b657aa70ffad5e5c504deeea773

data/Gemfile.lock

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

data/config/definitions.rb

@@ -33,6 +33,10 @@
 #       def projects; end
 #       # @return [Asana::ProxiedResourceClasses::UserTaskList]
 #       def user_task_lists; end
+#       # @return [Asana::ProxiedResourceClasses::Portfolio]
+#       def portfolios; end
+#       # @return [Asana::ProxiedResourceClasses::User]
+#       def users; end
 #     end
 #     class Collection < Asana::Resources::Collection; end
 #     module Resources
@@ -160,6 +164,35 @@
 #         def get_user_task_list_for_user(client, user_gid:,
 #             workspace: nil, options: {}); end
 #       end
+#       class Portfolio
+#         # Returns a list of the portfolios in compact representation that are owned
+#         # by the current API user.
+#         #
+#         # @param workspace [Gid] The workspace or organization to filter portfolios on.
+#         # @param owner [String] The user who owns the portfolio. Currently, API users can only get a
+#         # list of portfolios that they themselves own.
+#         #
+#         # @param per_page [Integer] the number of records to fetch per page.
+#         # @param options [Hash] the request I/O options.
+#         #
+#         # @return [Enumerable<Asana::Resources::Portfolio>]
+#         def find_all(workspace: required("workspace"), owner: required("owner"), per_page: 20, options: {}); end
+#         # Returns the complete record for a single portfolio.
+#         #
+#         # @param id [Gid] The portfolio to get.
+#         # @param options [Hash] the request I/O options.
+#
+#         # @return [Asana::Resources::Portfolio,nil]
+#         def find_by_id(client, id, options: {}); end
+#       end
+#       class User
+#         # Returns the full user record for the currently authenticated user.
+#         #
+#         # @param options [Hash] the request I/O options.
+#         #
+#         # @return [Asana::Resources::User]
+#         def me(options: {}); end
+#       end
 #     end
 #   end
 # rubocop:enable Layout/LineLength

data/lib/checkoff/create-entity.sh

@@ -8,6 +8,8 @@ underscored_plural_name="${1:?underscored plural name of entities minus .rb}"
 underscored_singular_name=$(sed -e 's/s$//g' <<< "${underscored_plural_name}")
 kabob_case_plural_name=${underscored_plural_name/_/-}
 class_name="${2:?class name without Checkoff:: prefix}"
+# shellcheck disable=SC2001
+asana_resource_class_name=Asana::Resources::$(sed -e 's/s$//g' <<< "${class_name}")
 
 cat > "${underscored_plural_name}.rb" << EOF
 #!/usr/bin/env ruby
@@ -20,10 +22,13 @@ require_relative 'internal/config_loader'
 require_relative 'workspaces'
 require_relative 'clients'
 
-# https://developers.asana.com/docs/${kabob_case_plural_name}
+# https://developers.asana.com/reference/${kabob_case_plural_name}
 
 module Checkoff
   class ${class_name}
+    # @!parse
+    #   extend CacheMethod::ClassMethods
+
     MINUTE = 60
     HOUR = MINUTE * 60
     DAY = 24 * HOUR
@@ -31,6 +36,10 @@ module Checkoff
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE
 
+    # @param config [Hash]
+    # @param workspaces [Checkoff::Workspaces]
+    # @param clients [Checkoff::Clients]
+    # @param client [Asana::Client]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
                    workspaces: Checkoff::Workspaces.new(config: config),
                    clients: Checkoff::Clients.new(config: config),
@@ -39,31 +48,47 @@ module Checkoff
       @client = client
     end
 
+    # @param workspace_name [String]
+    # @param ${underscored_singular_name}_name [String]
+    #
+    # @return [${asana_resource_class_name}]
     def ${underscored_singular_name}_or_raise(workspace_name, ${underscored_singular_name}_name)
-      ${underscored_singular_name} = ${underscored_singular_name}(workspace_name, ${underscored_singular_name}_name)
-      raise "Could not find ${underscored_singular_name} #{${underscored_singular_name}_name} under workspace #{workspace_name}." if ${underscored_singular_name}.nil?
+      ${underscored_singular_name}_obj = ${underscored_singular_name}(workspace_name, ${underscored_singular_name}_name)
+      raise "Could not find ${underscored_singular_name} #{${underscored_singular_name}_name} under workspace #{workspace_name}." if ${underscored_singular_name}_obj.nil?
 
-      ${underscored_singular_name}
+      ${underscored_singular_name}_obj
     end
     cache_method :${underscored_singular_name}_or_raise, LONG_CACHE_TIME
 
+    # @param workspace_name [String]
+    # @param ${underscored_singular_name}_name [String]
+    #
+    # @return [${asana_resource_class_name},nil]
     def ${underscored_singular_name}(workspace_name, ${underscored_singular_name}_name)
       workspace = workspaces.workspace_or_raise(workspace_name)
-      ${underscored_plural_name} = client.${underscored_plural_name}.get_${underscored_plural_name}_for_workspace(workspace_gid: workspace.gid)
-      ${underscored_plural_name}.find { |${underscored_singular_name}| ${underscored_singular_name}.name == ${underscored_singular_name}_name }
+      ${underscored_singular_name}_objs = client.${underscored_plural_name}.get_${underscored_plural_name}_for_workspace(workspace_gid: workspace.gid)
+      ${underscored_singular_name}_objs.find { |${underscored_singular_name}_obj| ${underscored_singular_name}_obj.name == ${underscored_singular_name}_name }
     end
     cache_method :${underscored_singular_name}, LONG_CACHE_TIME
 
     private
 
-    attr_reader :workspaces, :client
+    # @return [Checkoff::Workspaces]
+    attr_reader :workspaces
+
+    # @return [Asana::Client]
+    attr_reader :client
 
     # bundle exec ./${underscored_plural_name}.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]
         ${underscored_singular_name}_name = ARGV[1] || raise('Please pass ${underscored_singular_name} name as second argument')
         ${underscored_plural_name} = Checkoff::${class_name}.new
         ${underscored_singular_name} = ${underscored_plural_name}.${underscored_singular_name}_or_raise(workspace_name, ${underscored_singular_name}_name)

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

@@ -72,7 +72,7 @@ module Checkoff
       end
 
       # :ready function
-      class DuePFunctionEvaluator < FunctionEvaluator
+      class ReadyFunctionEvaluator < FunctionEvaluator
         def matches?
           fn?(selector, :ready)
         end

data/lib/checkoff/internal/task_timing.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Checkoff
+  module Internal
+    # Utility methods for working with task dates and times
+    class TaskTiming
+      # @param time_class [Class<Time>]
+      def initialize(time_class: Time)
+        @time_class = time_class
+      end
+
+      # @param task [Asana::Resources::Task]
+      # @return [Time, nil]
+      def start_time(task)
+        return @time_class.parse(task.start_at) if task.start_at
+        return @time_class.parse(task.start_on) if task.start_on
+
+        nil
+      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
+
+        nil
+      end
+    end
+  end
+end

data/lib/checkoff/portfolios.rb

@@ -0,0 +1,112 @@
+#!/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/portfolios
+
+module Checkoff
+  # Pull portfolios from Asana
+  class Portfolios
+    # @!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
+
+    # @param config [Hash]
+    # @param workspaces [Checkoff::Workspaces]
+    # @param clients [Checkoff::Clients]
+    # @param client [Asana::Client]
+    def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
+                   workspaces: Checkoff::Workspaces.new(config: config),
+                   clients: Checkoff::Clients.new(config: config),
+                   client: clients.client)
+      @workspaces = workspaces
+      @client = client
+    end
+
+    # @param workspace_name [String]
+    # @param portfolio_name [String]
+    #
+    # @return [Asana::Resources::Portfolio]
+    def portfolio_or_raise(workspace_name, portfolio_name)
+      portfolio_obj = portfolio(workspace_name, portfolio_name)
+      raise "Could not find portfolio #{portfolio_name} under workspace #{workspace_name}." if portfolio_obj.nil?
+
+      portfolio_obj
+    end
+    cache_method :portfolio_or_raise, LONG_CACHE_TIME
+
+    # @param workspace_name [String]
+    # @param portfolio_name [String]
+    #
+    # @sg-ignore
+    # @return [Asana::Resources::Portfolio,nil]
+    def portfolio(workspace_name, portfolio_name)
+      workspace = workspaces.workspace_or_raise(workspace_name)
+      me = client.users.me
+      portfolio_objs = client.portfolios.find_all(workspace: workspace.gid,
+                                                  owner: me.gid)
+      # @type [Asana::Resources::Portfolio, nil]
+      portfolio_objs.find { |portfolio_obj| portfolio_obj.name == portfolio_name }
+    end
+    cache_method :portfolio, LONG_CACHE_TIME
+
+    # Pull a specific portfolio by gid
+    #
+    # @param portfolio_gid [String]
+    # @param extra_fields [Array<String>]
+    #
+    # @return [Asana::Resources::Portfolio, nil]
+    def portfolio_by_gid(portfolio_gid,
+                         extra_fields: [])
+      options = {
+        fields: ['name'],
+      }
+      options[:fields] += extra_fields
+      client.portfolios.find_by_id(portfolio_gid, options: options)
+    end
+    cache_method :portfolio_by_gid, SHORT_CACHE_TIME
+
+    private
+
+    # @return [Checkoff::Workspaces]
+    attr_reader :workspaces
+
+    # @return [Asana::Client]
+    attr_reader :client
+
+    # bundle exec ./portfolios.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]
+        portfolio_name = ARGV[1] || raise('Please pass portfolio name as second argument')
+        portfolios = Checkoff::Portfolios.new
+        portfolio = portfolios.portfolio_or_raise(workspace_name, portfolio_name)
+        puts "Results: #{portfolio}"
+      end
+    end
+    # :nocov:
+  end
+end
+
+# :nocov:
+abs_program_name = File.expand_path($PROGRAM_NAME)
+Checkoff::Portfolios.run if abs_program_name == File.expand_path(__FILE__)
+# :nocov:

data/lib/checkoff/tasks.rb

@@ -5,6 +5,7 @@
 require_relative 'sections'
 require_relative 'workspaces'
 require_relative 'internal/config_loader'
+require_relative 'internal/task_timing'
 require 'asana'
 
 module Checkoff
@@ -57,8 +58,8 @@ module Checkoff
     def task_ready?(task, ignore_dependencies: false)
       return false if !ignore_dependencies && incomplete_dependencies?(task)
 
-      start = start_time(task)
-      due = due_time(task)
+      start = task_timing.start_time(task)
+      due = task_timing.due_time(task)
 
       return true if start.nil? && due.nil?
 
@@ -79,12 +80,12 @@ module Checkoff
              only_uncompleted: true,
              extra_fields: [])
       # @sg-ignore
-      tasks = tasks_from_section(workspace_name,
-                                 project_name,
-                                 section_name: section_name,
-                                 only_uncompleted: only_uncompleted,
-                                 extra_fields: extra_fields)
-      tasks.find { |task| task.name == task_name }
+      t = tasks(workspace_name,
+                project_name,
+                section_name: section_name,
+                only_uncompleted: only_uncompleted,
+                extra_fields: extra_fields)
+      t.find { |task| task.name == task_name }
     end
     cache_method :task, SHORT_CACHE_TIME
 
@@ -146,16 +147,20 @@ module Checkoff
 
     private
 
+    # @return [Checkoff::Internal::TaskTiming]
+    def task_timing
+      @task_timing ||= Checkoff::Internal::TaskTiming.new(time_class: @time_class)
+    end
+
     # @param workspace_name [String]
     # @param project_name [String, Symbol]
-    # @param section_name [String, nil, :unspecified]
+    # @param section_name [String, nil, Symbol<:unspecified>]
     # @param only_uncompleted [Boolean]
     # @param extra_fields [Array<String>]
+    #
     # @return [Enumerable<Asana::Resources::Task>]
-    def tasks_from_section(workspace_name, project_name,
-                           section_name:,
-                           only_uncompleted:,
-                           extra_fields:)
+    def tasks(workspace_name, project_name,
+              only_uncompleted:, extra_fields:, section_name: :unspecified)
       if section_name == :unspecified
         project = projects.project_or_raise(workspace_name, project_name)
         projects.tasks_from_project(project,
@@ -182,23 +187,5 @@ module Checkoff
     def default_assignee_gid
       @config.fetch(:default_assignee_gid)
     end
-
-    # @param task [Asana::Resources::Task]
-    # @return [Time, nil]
-    def start_time(task)
-      return @time_class.parse(task.start_at) if task.start_at
-      return @time_class.parse(task.start_on) if task.start_on
-
-      nil
-    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
-
-      nil
-    end
   end
 end

data/lib/checkoff/version.rb

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

data/lib/checkoff.rb

@@ -3,6 +3,7 @@
 require 'checkoff/version'
 require 'checkoff/clients'
 require 'checkoff/workspaces'
+require 'checkoff/portfolios'
 require 'checkoff/projects'
 require 'checkoff/sections'
 require 'checkoff/subtasks'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.92.0
+  version: 0.94.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-22 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -153,7 +153,9 @@ files:
 - lib/checkoff/internal/selector_classes/task/function_evaluator.rb
 - lib/checkoff/internal/selector_evaluator.rb
 - lib/checkoff/internal/task_selector_evaluator.rb
+- lib/checkoff/internal/task_timing.rb
 - lib/checkoff/my_tasks.rb
+- lib/checkoff/portfolios.rb
 - lib/checkoff/project_selectors.rb
 - lib/checkoff/projects.rb
 - lib/checkoff/section_selectors.rb