checkoff 0.93.0 → 0.95.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49531006387df986e746c99973d425917777230710978cad819951ca8d696d7b
-  data.tar.gz: ef9ea84d3a708b8a47425c77a63f83241f310d2b9b0fd71e01f15ec00d5eb4d7
+  metadata.gz: 31607f856925472f48fd4ae56a34d190bef6ea7105086b399e1f2755a0f1dfa5
+  data.tar.gz: 8af77b66a6a15caa5e5f3c5b46746f042d30d6ff56742845a6c537b3afe01d11
 SHA512:
-  metadata.gz: 7d5e93cea9b3b00bb6d7622e7aa4aa93229820683118f72414ac60dd7b3fafd36fac60e1a79a16fc6091b4ba051ae3cc818b0e2f8c5a354ae57b4b849b562af0
-  data.tar.gz: e4f24e5b32dfce8459a3c04fc89ba0b831f0d50f61dcc780864f441b1e119f29f774f2b47503ef6653b285b60c58273bb0bca8a80aa7feacea517019ce8139c1
+  metadata.gz: 5da70b5bbbd6538afa7b7953dfff42ec6377afe959f224c548d8886e64b36f1c101425c1ee51e6fced39ed8b06baa5f3c0f1aa96e92078cfebf1e1949ae4c3c9
+  data.tar.gz: 93f0ae0f4b00cf74cad672b3492b927ea72dc9f2dabd9b052e98da20098953848a69c55e79bcceda6ce6ce8c21fa77b0c08aff8f3378d0cb15a516f17e04a23e

data/Gemfile.lock

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

data/config/definitions.rb

@@ -50,6 +50,8 @@
 #         def assignee; end
 #         # @return [String, nil]
 #         def html_notes; end
+#         # @return [Array<Hash{String => Hash{String => String}}>]
+#         def memberships; end
 #         class << self
 #           # @return [Asana::Resources::Task]
 #           def create(client, assignee:, workspace:, name:); end

data/lib/checkoff/internal/task_hashes.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Checkoff
+  module Internal
+    # Builds on the standard API representation of an Asana task with some
+    # convenience keys.
+    class TaskHashes
+      # @param task [Asana::Resources::Task]
+      # @return [Hash]
+      def task_to_h(task)
+        # @type [Hash]
+        task_hash = task.to_h
+        task_hash['unwrapped'] = {}
+        unwrap_custom_fields(task_hash)
+        unwrap_memberships(task_hash)
+        task_hash['task'] = task.name
+        task_hash
+      end
+
+      private
+
+      # @param task_hash [Hash]
+      # @return [void]
+      def unwrap_custom_fields(task_hash)
+        unwrapped_custom_fields = task_hash.fetch('custom_fields', []).group_by do |cf|
+          cf['name']
+        end.transform_values(&:first)
+        task_hash['unwrapped']['custom_fields'] = unwrapped_custom_fields
+      end
+
+      # @param task_hash [Hash]
+      # @param resource [String]
+      # @param key [String]
+      #
+      # @return [void]
+      def unwrap_membership(task_hash, resource, key)
+        # @sg-ignore
+        # @type [Array<Hash>]
+        memberships = task_hash.fetch('memberships', [])
+        # @sg-ignore
+        # @type [Hash]
+        unwrapped = task_hash.fetch('unwrapped')
+        unwrapped["membership_by_#{resource}_#{key}"] = memberships.group_by do |membership|
+          membership[resource][key]
+        end.transform_values(&:first)
+      end
+
+      # @param task_hash [Hash]
+      # @return [void]
+      def unwrap_memberships(task_hash)
+        unwrap_membership(task_hash, 'section', 'gid')
+        unwrap_membership(task_hash, 'project', 'gid')
+        unwrap_membership(task_hash, 'project', 'name')
+      end
+    end
+  end
+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/tasks.rb

@@ -5,6 +5,8 @@
 require_relative 'sections'
 require_relative 'workspaces'
 require_relative 'internal/config_loader'
+require_relative 'internal/task_timing'
+require_relative 'internal/task_hashes'
 require 'asana'
 
 module Checkoff
@@ -57,8 +59,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 +81,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
 
@@ -144,18 +146,44 @@ module Checkoff
       end
     end
 
+    # Builds on the standard API representation of an Asana task with some
+    # convenience keys:
+    #
+    # <regular keys from API response>
+    # +
+    # unwrapped:
+    #  membership_by_section_gid: Hash<String, Hash (membership)>
+    #  membership_by_project_gid: Hash<String, Hash (membership)>
+    #  membership_by_project_name: Hash<String, Hash (membership)>
+    # task: String (name)
+    #
+    # @param task [Asana::Resources::Task]
+    # @return [Hash]
+    def task_to_h(task)
+      task_hashes.task_to_h(task)
+    end
+
     private
 
+    # @return [Checkoff::Internal::TaskTiming]
+    def task_timing
+      @task_timing ||= Checkoff::Internal::TaskTiming.new(time_class: @time_class)
+    end
+
+    # @return [Checkoff::Internal::TaskHashes]
+    def task_hashes
+      @task_hashes ||= Checkoff::Internal::TaskHashes.new
+    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 +210,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.93.0'
+  VERSION = '0.95.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.93.0
+  version: 0.95.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
@@ -152,7 +152,9 @@ files:
 - lib/checkoff/internal/selector_classes/task.rb
 - lib/checkoff/internal/selector_classes/task/function_evaluator.rb
 - lib/checkoff/internal/selector_evaluator.rb
+- lib/checkoff/internal/task_hashes.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