checkoff 0.112.0 → 0.114.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 393a800af57dad5fa9edde789dbe166b09ad79b374c2f7dcab230ee0050c49e7
-  data.tar.gz: a2e852b005e952bacf694e0684c97db27a0e53e2e68d79b471d7a2a8d66939ce
+  metadata.gz: a87ae5e25697c0daa4fd48bb9eb16d79e2b253ab886b535bd41fc460e3b1d2a9
+  data.tar.gz: 3ae9f56d8e53390c87c0f1560d85f8f9c6ad37d3fb1236ce23bbafe2cdb6125c
 SHA512:
-  metadata.gz: 12769031da94bd1a7afc9afeccededab8f19506201f14c29d97cbacba7b3c0574f73d1a2bf52e9d6e511249d8f946d42295a110f0ef59f575e8d26eb6337377f
-  data.tar.gz: 6395b5b368b7b74a0173d4a62b5e55188348b9c8293865cba02163f7d9a85ede6d6a139ab001f74eaf7acd13b431af341bac7eddc5cff87ec780c4e67f6a7207
+  metadata.gz: b227e5768678060e3ce4c3992937ff0e7bb0c6a9099b828fc577da123b48a6d070d75c3aa6c383509fe78b98777bc8e0ee246a54a254dbd7b1ea0de2abf411cc
+  data.tar.gz: b999dd5ab7a0d58c010c43231664bbe30efe617f4836a572ae146dde1cbe9f8d6bddf46598ec490327e6a8f7f86a6f4ff5c34d909bb06ddcd6a003336607e29c

data/Gemfile.lock

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

data/lib/checkoff/internal/create-class.sh

@@ -6,8 +6,6 @@ underscored_plural_name="${1:?underscored plural name of entities minus .rb}"
 class_name="${2:?class name without Checkoff:: prefix}"
 
 cat > "${underscored_plural_name}.rb" << EOF
-#!/usr/bin/env ruby
-
 # frozen_string_literal: true
 
 module Checkoff

data/lib/checkoff/internal/project_hashes.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Checkoff
+  module Internal
+    # Builds on the standard API representation of an Asana project with some
+    # convenience keys.
+    class ProjectHashes
+      # @param _deps [Hash]
+      def initialize(_deps = {}); end
+
+      # @param project_obj [Asana::Resources::Project]
+      # @param project [String, Symbol<:not_specified, :my_tasks>]
+      #
+      # @return [Hash]
+      def project_to_h(project_obj, project: :not_specified)
+        project = project_obj.name if project == :not_specified
+        project_hash = { **project_obj.to_h, 'project' => project }
+        project_hash['unwrapped'] = {}
+        unwrap_custom_fields(project_hash)
+        project_hash
+      end
+
+      private
+
+      # @param project_hash [Hash]
+      # @return [void]
+      def unwrap_custom_fields(project_hash)
+        unwrapped_custom_fields = project_hash.fetch('custom_fields', []).group_by do |cf|
+          cf['name']
+        end.transform_values(&:first)
+        project_hash['unwrapped']['custom_fields'] = unwrapped_custom_fields
+      end
+    end
+  end
+end

data/lib/checkoff/internal/task_timing.rb

@@ -76,7 +76,7 @@ module Checkoff
       end
 
       # @param task [Asana::Resources::Task]
-      # @param field_name [Symbol]
+      # @param field_name [Symbol,Array]
       #
       # @sg-ignore
       # @return [Date, Time, nil]

data/lib/checkoff/portfolios.rb

@@ -80,14 +80,28 @@ module Checkoff
 
     # @param workspace_name [String]
     # @param portfolio_name [String]
+    # @param extra_project_fields [Array<String>]
     #
     # @return [Enumerable<Asana::Resources::Project>]
-    def projects_in_portfolio(workspace_name, portfolio_name)
+    def projects_in_portfolio(workspace_name, portfolio_name,
+                              extra_project_fields: [])
       portfolio = portfolio_or_raise(workspace_name, portfolio_name)
-      portfolio.get_items
+      projects_in_portfolio_obj(portfolio)
     end
     cache_method :projects_in_portfolio, LONG_CACHE_TIME
 
+    # @param portfolio [Asana::Resources::Portfolio]
+    # @param extra_project_fields [Array<String>]
+    #
+    # @return [Enumerable<Asana::Resources::Project>]
+    def projects_in_portfolio_obj(portfolio, extra_project_fields: [])
+      options = {
+        fields: ['name'],
+      }
+      options[:fields] += extra_project_fields
+      portfolio.get_items(options: options)
+    end
+
     private
 
     # @return [Checkoff::Workspaces]

data/lib/checkoff/projects.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'internal/config_loader'
+require_relative 'internal/project_hashes'
 require_relative 'workspaces'
 require_relative 'clients'
 require 'cache_method'
@@ -30,13 +31,16 @@ module Checkoff
     # @param config [Hash<Symbol, Object>]
     # @param client [Asana::Client]
     # @param workspaces [Checkoff::Workspaces]
+    # @param project_hashes [Checkoff::Internal::ProjectHashes]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
                    client: Checkoff::Clients.new(config: config).client,
                    workspaces: Checkoff::Workspaces.new(config: config,
-                                                        client: client))
+                                                        client: client),
+                   project_hashes: Checkoff::Internal::ProjectHashes.new)
       @config = config
       @workspaces = workspaces
       @client = client
+      @project_hashes = project_hashes
     end
 
     # Default options used in Asana API to pull tasks
@@ -115,8 +119,19 @@ module Checkoff
     # 15 minute cache resulted in 'Your pagination token has expired'
     cache_method :projects_by_workspace_name, MEDIUM_CACHE_TIME
 
+    # @param project_obj [Asana::Resources::Project]
+    # @param project [String, Symbol<:not_specified, :my_tasks>]
+    #
+    # @return [Hash]
+    def project_to_h(project_obj, project: :not_specified)
+      project_hashes.project_to_h(project_obj, project: project)
+    end
+
     private
 
+    # @return [Checkoff::Internal::ProjectHashes]
+    attr_reader :project_hashes
+
     # @return [Asana::Client]
     attr_reader :client
 

data/lib/checkoff/tasks.rb

@@ -86,6 +86,19 @@ module Checkoff
       timing.in_period?(task_date_or_time, period)
     end
 
+    # @param task [Asana::Resources::Task]
+    # @param field_name [Symbol,Array]
+    #         :start - start_at or start_on (first set)
+    #         :due - due_at or due_on (first set)
+    #         :ready - start_at or start_on or due_at or due_on (first set)
+    #         :modified - modified_at
+    #         [:custom_field, "foo"] - 'Date' custom field type named 'foo'
+    #
+    # @return [Date, Time, nil]
+    def date_or_time_field_by_name(task, field_name)
+      task_timing.date_or_time_field_by_name(task, field_name)
+    end
+
     # Pull a specific task by name
     #
     # @param workspace_name [String]
@@ -193,6 +206,13 @@ module Checkoff
       task_hashes.task_to_h(task)
     end
 
+    # @param task_data [Hash]
+    #
+    # @return [Asana::Resources::Task]
+    def h_to_task(task_data)
+      Asana::Resources::Task.new(task_data, client: client)
+    end
+
     # True if the task is in a project which is in the given portfolio
     #
     # @param task [Asana::Resources::Task]

data/lib/checkoff/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.112.0
+  version: 0.114.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-29 00:00:00.000000000 Z
+date: 2023-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -133,6 +133,7 @@ files:
 - lib/checkoff/custom_fields.rb
 - lib/checkoff/internal/config_loader.rb
 - lib/checkoff/internal/create-class.sh
+- lib/checkoff/internal/project_hashes.rb
 - lib/checkoff/internal/project_selector_evaluator.rb
 - lib/checkoff/internal/search_url.rb
 - lib/checkoff/internal/search_url/custom_field_param_converter.rb