checkoff 0.45.1 → 0.46.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 166520f53086eea60a30deae24eacea2bff98b58cc63e1bc14397e016cfce5a3
-  data.tar.gz: 182f61588c6343c7b16100a56357909b5d1c532a2580040fdb50828dedeb4032
+  metadata.gz: 5a4be48acbc5f3ab9954ca8f7ec3ef64f1c629bfbc0015f158cde7a87fcc4049
+  data.tar.gz: 1824e5607d750cc1d9b2161dc897cd4a08fd90c27fea1c4cc7a5f19ee4e2c497
 SHA512:
-  metadata.gz: 00461660f5b2f2927d5c0bd89b34e12a1393ce105dcddf6782054ef655c3ba55654c0d5a818e35907dd46d457beac3a18b637bb2a5379ae78d30913fdd55944d
-  data.tar.gz: 8aa6bdc999894732e1e243cac1617b6b40b905b80562c5d8d57bbf2a988b4f1b66fc7848dbe4937dc01228c503a4e26661bc17a28c75c6effed5b10d9afd10db
+  metadata.gz: 3ef67e1152d4399b8b507a6b6b6555f300ac83ffda4b998a8ae031ada997deabdd60974228db9cb01101bf319a3092a36fa259391c4fbdc6940266e1d53f923d
+  data.tar.gz: e04b024a9f4def03f62fb7a8b1498e53ed2d08cc53cff3a5b76bc7f16b6a20402a450704a7f782372b5f3438a7ecad063f1e7047b552d50a360fa7c5d1d60dbc

data/Gemfile.lock

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

data/config/definitions.rb

@@ -83,7 +83,7 @@
 #         # just because another object it is associated with (e.g. a subtask)
 #         # is modified. Actions that count as modifying the task include
 #         # assigning, renaming, completing, and adding stories.
-#         # @return [Asana::Collection<Asana::Resources::Task>]
+#         # @return [Enumerable<Asana::Resources::Task>]
 #         def find_all(assignee: nil, workspace: nil, project: nil, section: nil,
 #                      tag: nil, user_task_list: nil, completed_since: nil,
 #                      modified_since: nil, per_page: 20, options: {}); end
@@ -106,7 +106,7 @@
 #       class Section
 #         # @param project_gid [String]
 #         # @return [Enumerable<Asana::Resources::Section>]
-#         def get_sections_for_project(client, project_gid:, options: {}); end
+#         def get_sections_for_project(project_gid:, options: {}); end
 #       end
 #       class Project
 #         # Returns the compact project records for all projects in the workspace.

data/lib/checkoff/internal/search_url/custom_field_param_converter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'custom_field_variant'
+require_relative 'results_merger'
 
 module Checkoff
   module Internal
@@ -8,44 +9,41 @@ module Checkoff
       # Convert custom field parameters from an Asana search URL into
       # API search arguments and Checkoff task selectors
       class CustomFieldParamConverter
+        # @param custom_field_params [Hash<String, Array<String>>]
         def initialize(custom_field_params:)
           @custom_field_params = custom_field_params
         end
 
+        # @return [Array(Hash<String, String>, Array<[Symbol, Array]>)]
         def convert
+          # @type args [Hash<String, String>]
           args = {}
+          # @type task_selector [Array<[Symbol, Array]>]
           task_selector = []
           by_custom_field.each do |gid, single_custom_field_params|
+            # @sg-ignore
             new_args, new_task_selector = convert_single_custom_field_params(gid,
                                                                              single_custom_field_params)
-            args, task_selector = merge_args_and_task_selectors(args, new_args,
-                                                                task_selector, new_task_selector)
+
+            args = ResultsMerger.merge_args(args, new_args)
+
+            # @sg-ignore
+            task_selector = ResultsMerger.merge_task_selectors(task_selector, new_task_selector)
           end
           [args, task_selector]
         end
 
         private
 
+        # @sg-ignore
+        # @return [Hash<String, Hash>]
         def by_custom_field
           custom_field_params.group_by do |key, _value|
             gid_from_custom_field_key(key)
           end.transform_values(&:to_h)
         end
 
-        def merge_args_and_task_selectors(args, new_args, task_selector, new_task_selector)
-          final_args = args.merge(new_args)
-
-          final_task_selector = if new_task_selector == []
-                                  task_selector
-                                elsif task_selector == []
-                                  new_task_selector
-                                else
-                                  [:and, task_selector, new_task_selector]
-                                end
-
-          [final_args, final_task_selector]
-        end
-
+        # @type [Hash<String, Class<CustomFieldVariant>]
         VARIANTS = {
           'is' => CustomFieldVariant::Is,
           'no_value' => CustomFieldVariant::NoValue,
@@ -58,22 +56,33 @@ module Checkoff
           'contains_all' => CustomFieldVariant::ContainsAll,
         }.freeze
 
+        # @param gid [String]
+        # @param single_custom_field_params [Hash<String, Array<String>>]
+        # @sg-ignore
+        # @return [Array(Hash<String, String>, Array<[Symbol, Array]>)]
         def convert_single_custom_field_params(gid, single_custom_field_params)
           variant_key = "custom_field_#{gid}.variant"
           variant = single_custom_field_params.fetch(variant_key)
           remaining_params = single_custom_field_params.reject { |k, _v| k == variant_key }
           raise "Teach me how to handle #{variant_key} = #{variant}" unless variant.length == 1
 
+          # @sg-ignore
+          # @type variant_class [Class<CustomFieldVariant>]
           variant_class = VARIANTS[variant[0]]
+          # @type [Array(Hash<String, String>, Array<[Symbol, Array]>)]
+          # @sg-ignore
           return variant_class.new(gid, remaining_params).convert unless variant_class.nil?
 
           raise "Teach me how to handle #{variant_key} = #{variant}"
         end
 
+        # @param key [String]
+        # @return [String]
         def gid_from_custom_field_key(key)
           key.split('_')[2].split('.')[0]
         end
 
+        # @return [Hash<String, Array<String>>]
         attr_reader :custom_field_params
       end
     end

data/lib/checkoff/internal/search_url/date_param_converter.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative 'custom_field_param_converter'
+
+module Checkoff
+  module Internal
+    module SearchUrl
+      # Convert date parameters - ones where the param name itself
+      # doesn't encode any parameters'
+      class DateParamConverter
+        # @param date_url_params [Hash<String, Array<String>>] the simple params
+        def initialize(date_url_params:)
+          @date_url_params = date_url_params
+        end
+
+        # @return [Array(Hash<String, String>, Array<[Symbol, Array]>)] See https://developers.asana.com/docs/search-tasks-in-a-workspace
+        def convert
+          return [{}, []] if date_url_params.empty?
+
+          # example params:
+          #   due_date.operator=through_next
+          #   due_date.value=0
+          #   due_date.unit=day
+          validate_due_date_through_next!
+
+          value = date_url_params.fetch('due_date.value').fetch(0).to_i
+
+          # @sg-ignore
+          # @type [Date]
+          before = Date.today + value
+
+          validate_unit_is_day!
+
+          # 'due_on.before' => '2023-01-01',
+          # 'due_on.after' => '2023-01-01',
+          # [{ 'due_on.before' => '2023-09-01' }, []]
+          [{ 'due_on.before' => before.to_s }, []]
+        end
+
+        private
+
+        # @return [void]
+        def validate_unit_is_day!
+          unit = date_url_params.fetch('due_date.unit').fetch(0)
+
+          raise 'Teach me how to handle other time units' unless unit == 'day'
+        end
+
+        # @return [void]
+        def validate_due_date_through_next!
+          due_date_operators = date_url_params.fetch('due_date.operator')
+
+          return if due_date_operators == ['through_next']
+
+          raise "Teach me how to handle date mode: #{due_date_operators}."
+        end
+
+        # @return [Hash<String, Array<String>>]
+        attr_reader :date_url_params
+      end
+    end
+  end
+end

data/lib/checkoff/internal/search_url/parser.rb

@@ -6,6 +6,8 @@ require 'cgi'
 require 'uri'
 require_relative 'simple_param_converter'
 require_relative 'custom_field_param_converter'
+require_relative 'results_merger'
+require_relative 'date_param_converter'
 
 module Checkoff
   module Internal
@@ -13,36 +15,68 @@ module Checkoff
       # Parse Asana search URLs into parameters suitable to pass into
       # the /workspaces/{workspace_gid}/tasks/search endpoint
       class Parser
+        # @param _deps [Hash]
         def initialize(_deps = {})
           # allow dependencies to be passed in by tests
         end
 
+        # @param url [String]
+        # @return [Array(Hash<String, String>, Hash<String, String>)]
         def convert_params(url)
           url_params = CGI.parse(URI.parse(url).query)
+          # @type custom_field_params [Hash<String, Array<String>>]
+          # @type date_url_params [Hash<String, Array<String>>]
+          # @type simple_url_params [Hash<String, Array<String>>]
+          # @sg-ignore
+          custom_field_params, date_url_params, simple_url_params = partition_url_params(url_params)
+          # @type custom_field_args [Hash<String, String>]
+          # @type custom_field_task_selector [Hash<String, String>]
           # @sg-ignore
-          custom_field_params, simple_url_params = partition_url_params(url_params)
+          custom_field_args, custom_field_task_selector = convert_custom_field_params(custom_field_params)
+          # @type date_args [Hash<String, String>]
+          # @type date_task_selector [Hash<String, String>]
           # @sg-ignore
-          custom_field_args, task_selector = convert_custom_field_params(custom_field_params)
+          date_url_args, date_task_selector = convert_date_params(date_url_params)
           simple_url_args = convert_simple_params(simple_url_params)
-          [custom_field_args.merge(simple_url_args), task_selector]
+          # raise 'merge these things'
+          [ResultsMerger.merge_args(custom_field_args, date_url_args, simple_url_args),
+           ResultsMerger.merge_task_selectors(date_task_selector, custom_field_task_selector)]
         end
 
         private
 
+        # @param date_url_params [Hash<String, Array<String>>]
+        # @return [Array(Hash<String, String>, Array<[Symbol, Array]>)]
+        def convert_date_params(date_url_params)
+          DateParamConverter.new(date_url_params: date_url_params).convert
+        end
+
+        # @param simple_url_params [Hash<String, Array<String>>]
+        # @return [Hash<String, String>]
         def convert_simple_params(simple_url_params)
           SimpleParamConverter.new(simple_url_params: simple_url_params).convert
         end
 
+        # @param custom_field_params [Hash<String, Array<String>>]
+        # @return [Array(Hash<String, String>, Array<[Symbol, Array]>)]
         def convert_custom_field_params(custom_field_params)
           CustomFieldParamConverter.new(custom_field_params: custom_field_params).convert
         end
 
         # @param url_params [Hash<String, String>]
-        # @return [Array(Hash<String, String>, Hash<String, String>)]
+        # @return [Array(Hash<String, String>, Hash<String, String>, Hash<String, String>)]
         def partition_url_params(url_params)
-          url_params.to_a.partition do |key, _values|
-            key.start_with? 'custom_field_'
-          end.map(&:to_h)
+          groups = url_params.to_a.group_by do |key, _values|
+            if key.start_with? 'custom_field_'
+              :custom_field
+            elsif key.include? '_date'
+              :date
+            else
+              :simple
+            end
+          end.transform_values(&:to_h)
+          # @sg-ignore
+          [groups.fetch(:custom_field, {}), groups.fetch(:date, {}), groups.fetch(:simple, {})]
         end
       end
     end

data/lib/checkoff/internal/search_url/results_merger.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Checkoff
+  module Internal
+    module SearchUrl
+      # Merge task selectors and search API arguments
+      class ResultsMerger
+        # @param args [Array<[Hash<String, String>]>]
+        # @return [Hash<String, String>
+        def self.merge_args(*args)
+          # first element of args
+          # @sg-ignore
+          # @type [Hash<String, String>]
+          f = args.fetch(0)
+          # rest of args
+          r = args.drop(0)
+          f.merge(*r)
+        end
+
+        # @param task_selectors [Array<Array<[Symbol, Array]>>]
+        # @return [Array<[Symbol, Array]>]
+        def self.merge_task_selectors(*task_selectors)
+          return [] if task_selectors.empty?
+
+          first_task_selector = task_selectors.fetch(0)
+
+          return merge_task_selectors(*task_selectors.drop(1)) if first_task_selector.empty?
+
+          return first_task_selector if task_selectors.length == 1
+
+          rest_task_selectors = merge_task_selectors(*task_selectors.drop(1))
+
+          return first_task_selector if rest_task_selectors.empty?
+
+          [:and, first_task_selector, rest_task_selectors]
+        end
+      end
+    end
+  end
+end

data/lib/checkoff/my_tasks.rb

@@ -12,8 +12,12 @@ module Checkoff
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE * 5
 
+    # @return [Checkoff::Projects]
     attr_reader :projects
 
+    # @param config [Hash<Symbol, Object>]
+    # @param client [Asana::Client]
+    # @param projects [Checkoff::Projects]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
                    client: Checkoff::Clients.new(config: config).client,
                    projects: Checkoff::Projects.new(config: config,
@@ -26,13 +30,23 @@ module Checkoff
     # Given a 'My Tasks' project object, pull all tasks, then provide
     # a Hash of tasks with section name -> task list of the
     # uncompleted tasks.
-    def tasks_by_section_for_my_tasks(project, extra_fields: [])
+    #
+    # @param project [Asana::Resources::Project]
+    # @param only_uncompleted [Boolean]
+    # @param extra_fields [Array<String>]
+    # @return [Hash<String, Enumerable<Asana::Resources::Task>>]
+    def tasks_by_section_for_my_tasks(project,
+                                      only_uncompleted: true,
+                                      extra_fields: [])
       raw_tasks = projects.tasks_from_project(project,
+                                              only_uncompleted: only_uncompleted,
                                               extra_fields: extra_fields + ['assignee_section.name'])
       active_tasks = projects.active_tasks(raw_tasks)
       by_my_tasks_section(active_tasks, project.gid)
     end
 
+    # @param name [String]
+    # @return [String, nil]
     def section_key(name)
       return nil if name == 'Recently assigned'
 
@@ -41,10 +55,14 @@ module Checkoff
 
     # Given a list of tasks in 'My Tasks', pull a Hash of tasks with
     # section name -> task list
+    #
+    # @param tasks [Enumerable<Asana::Resources::Task>]
+    # @param project_gid [String]
+    # @return [Hash<String, Enumerable<Asana::Resources::Task>>]
     def by_my_tasks_section(tasks, project_gid)
       by_section = {}
       sections = client.sections.get_sections_for_project(project_gid: project_gid)
-      sections.each { |section| by_section[section_key(section.name)] = [] }
+      sections.each_entry { |section| by_section[section_key(section.name)] = [] }
       tasks.each do |task|
         assignee_section = task.assignee_section
         current_section = section_key(assignee_section.name)
@@ -56,6 +74,7 @@ module Checkoff
 
     private
 
+    # @return [Asana::Client]
     attr_reader :client
   end
 end

data/lib/checkoff/projects.rb

@@ -91,12 +91,14 @@ module Checkoff
     # @param [Boolean] only_uncompleted
     # @param [Array<String>] extra_fields
     # @return [Enumerable<Asana::Resources::Task>]
-    def tasks_from_project(project, only_uncompleted: true, extra_fields: [])
+    def tasks_from_project(project,
+                           only_uncompleted: true,
+                           extra_fields: [])
       options = task_options
       options[:completed_since] = '9999-12-01' if only_uncompleted
       options[:project] = project.gid
       options[:options][:fields] += extra_fields
-      client.tasks.find_all(**options).to_a
+      client.tasks.find_all(**options)
     end
     cache_method :tasks_from_project, SHORT_CACHE_TIME
 

data/lib/checkoff/sections.rb

@@ -65,17 +65,21 @@ module Checkoff
     # tasks with section name -> task list of the uncompleted tasks
     # @param workspace_name [String]
     # @param project_name [String, Symbol]
+    # @param only_uncompleted [Boolean]
     # @param extra_fields [Array<String>]
     # @return [Hash{[String, nil] => Enumerable<Asana::Resources::Task>}]
-    def tasks_by_section(workspace_name, project_name, extra_fields: [])
+    def tasks_by_section(workspace_name,
+                         project_name,
+                         only_uncompleted: true,
+                         extra_fields: [])
       raise ArgumentError, 'Provided nil workspace name' if workspace_name.nil?
       raise ArgumentError, 'Provided nil project name' if project_name.nil?
 
       project = project_or_raise(workspace_name, project_name)
       if project_name == :my_tasks
-        my_tasks.tasks_by_section_for_my_tasks(project, extra_fields: extra_fields)
+        my_tasks.tasks_by_section_for_my_tasks(project, only_uncompleted: only_uncompleted, extra_fields: extra_fields)
       else
-        tasks_by_section_for_project(project, extra_fields: extra_fields)
+        tasks_by_section_for_project(project, only_uncompleted: only_uncompleted, extra_fields: extra_fields)
       end
     end
 
@@ -140,10 +144,15 @@ module Checkoff
     # Given a project object, pull all tasks, then provide a Hash of
     # tasks with section name -> task list of the uncompleted tasks
     # @param project [Asana::Resources::Project]
+    # @param only_uncompleted [Boolean]
     # @param extra_fields [Array<String>]
     # @return [Hash<[String,nil], Enumerable<Asana::Resources::Task>>]
-    def tasks_by_section_for_project(project, extra_fields: [])
-      raw_tasks = projects.tasks_from_project(project, extra_fields: extra_fields)
+    def tasks_by_section_for_project(project,
+                                     only_uncompleted: true,
+                                     extra_fields: [])
+      raw_tasks = projects.tasks_from_project(project,
+                                              only_uncompleted: only_uncompleted,
+                                              extra_fields: extra_fields)
       active_tasks = projects.active_tasks(raw_tasks)
       by_section(active_tasks, project.gid)
     end
@@ -165,7 +174,7 @@ module Checkoff
       by_section = {}
       # @sg-ignore
       sections = client.sections.get_sections_for_project(project_gid: project_gid)
-      sections.each { |section| by_section[section_key(section.name)] = [] }
+      sections.each_entry { |section| by_section[section_key(section.name)] = [] }
       tasks.each { |task| file_task_by_section(by_section, task, project_gid) }
       by_section
     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.45.1'
+  VERSION = '0.46.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.45.1
+  version: 0.46.1
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-29 00:00:00.000000000 Z
+date: 2023-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -135,7 +135,9 @@ files:
 - lib/checkoff/internal/search_url.rb
 - lib/checkoff/internal/search_url/custom_field_param_converter.rb
 - lib/checkoff/internal/search_url/custom_field_variant.rb
+- lib/checkoff/internal/search_url/date_param_converter.rb
 - lib/checkoff/internal/search_url/parser.rb
+- lib/checkoff/internal/search_url/results_merger.rb
 - lib/checkoff/internal/search_url/simple_param_converter.rb
 - lib/checkoff/internal/task_selector_evaluator.rb
 - lib/checkoff/my_tasks.rb