checkoff 0.65.0 → 0.67.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4505355c1c82cd6052ef5fd0996ecf25a415df8846ce7e21f4d80f5a9b1c788f
-  data.tar.gz: 2837a88035c53d49ef8ee4bef2cbd2b1c2007f1b2d5441d4640a8680785ef438
+  metadata.gz: 651d344e64e8f9b999d1c8d1f235c6657428e11164844e85ea3f53f31dca581b
+  data.tar.gz: bd94b2f08680af330190beb09c6659787e500d7d561a15a80a363a8c4675d158
 SHA512:
-  metadata.gz: 999cc4babf24a98ab16cbed5349e536e4e7d9a9b08b16c50a73df63dac135dde8740e799c2ea7630d0682685775a9eff984830a0bfcca884900ee604a62f443b
-  data.tar.gz: df41ae1e0e59e3efa637c06114a9b4370c2e093c932ff022be61f773af3a617c6eecc65ec5f147987bb229701aeea88fcf60163923309e92a19ba0b8b4e3db3e
+  metadata.gz: '086458eef1a121b9cf27c79d78d18a65289cb7658d37126647a363d784ecaec3251ca05aba3b4f22512a07a35ee012d7fdf58b585950845be0742560e3d0dd50'
+  data.tar.gz: 05e1b5637f49ffd9c0dea9110705a43e79f875cedc699df023e1cc1d68480a7b9b68eb974faf201bc4e0c9efce1ba5333adbeca8bcf84ff0f7c076d57fb07753

data/Gemfile.lock

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

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

@@ -51,6 +51,7 @@ module Checkoff
           'is_not' => CustomFieldVariant::IsNot,
           'less_than' => CustomFieldVariant::LessThan,
           'greater_than' => CustomFieldVariant::GreaterThan,
+          'equals' => CustomFieldVariant::Equals,
           'doesnt_contain_any' => CustomFieldVariant::DoesntContainAny,
           'contains_any' => CustomFieldVariant::ContainsAny,
           'contains_all' => CustomFieldVariant::ContainsAll,

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

@@ -7,6 +7,8 @@ module Checkoff
       module CustomFieldVariant
         # base class for handling different custom_field_#{gid}.variant params
         class CustomFieldVariant
+          # @param [String] gid
+          # @param [Hash] remaining_params
           def initialize(gid, remaining_params)
             @gid = gid
             @remaining_params = remaining_params
@@ -14,17 +16,27 @@ module Checkoff
 
           private
 
-          attr_reader :gid, :remaining_params
+          # @return [String]
+          attr_reader :gid
 
+          # @return [Hash]
+          attr_reader :remaining_params
+
+          # @return [void]
           def ensure_no_remaining_params!
             return if remaining_params.empty?
 
             raise "Teach me how to handle these remaining keys: #{remaining_params}"
           end
 
+          # @param [String] param_name
+          #
+          # @return [String]
           def fetch_solo_param(param_name)
             case remaining_params.keys
             when [param_name]
+              # @sg-ignore
+              # @type [Array<String>]
               param_values = remaining_params.fetch(param_name)
               unless param_values.length == 1
                 raise "Teach me how to handle these remaining keys for #{param_name}: #{remaining_params}"
@@ -39,6 +51,7 @@ module Checkoff
 
         # custom_field_#{gid}.variant = 'less_than'
         class LessThan < CustomFieldVariant
+          # @return [Array<(Hash, Array)>]
           def convert
             max_value = fetch_solo_param("custom_field_#{gid}.max")
             empty_task_selector = []
@@ -48,6 +61,7 @@ module Checkoff
 
         # custom_field_#{gid}.variant = 'greater_than'
         class GreaterThan < CustomFieldVariant
+          # @return [Array<(Hash, Array)>]
           def convert
             max_value = fetch_solo_param("custom_field_#{gid}.min")
             empty_task_selector = []
@@ -55,10 +69,21 @@ module Checkoff
           end
         end
 
+        # custom_field_#{gid}.variant = 'equals'
+        class Equals < CustomFieldVariant
+          # @return [Array<(Hash, Array)>]
+          def convert
+            value = fetch_solo_param("custom_field_#{gid}.value")
+            empty_task_selector = []
+            [{ "custom_fields.#{gid}.value" => value }, empty_task_selector]
+          end
+        end
+
         # This is used in the UI for select fields
         #
         # custom_field_#{gid}.variant = 'is_not'
         class IsNot < CustomFieldVariant
+          # @return [Array<(Hash, Array)>]
           def convert
             selected_options = fetch_solo_param("custom_field_#{gid}.selected_options").split('~')
 
@@ -75,6 +100,7 @@ module Checkoff
         #
         # custom_field_#{gid}.variant = 'doesnt_contain_any'
         class DoesntContainAny < CustomFieldVariant
+          # @return [Array<(Hash, Array)>]
           def convert
             selected_options = fetch_solo_param("custom_field_#{gid}.selected_options").split('~')
 
@@ -90,6 +116,7 @@ module Checkoff
         #
         # custom_field_#{gid}.variant = 'contains_any'
         class ContainsAny < CustomFieldVariant
+          # @return [Array<(Hash, Array)>]
           def convert
             selected_options = fetch_solo_param("custom_field_#{gid}.selected_options").split('~')
 
@@ -104,6 +131,7 @@ module Checkoff
         #
         # custom_field_#{gid}.variant = 'contains_all'
         class ContainsAll < CustomFieldVariant
+          # @return [Array<(Hash, Array)>]
           def convert
             selected_options = fetch_solo_param("custom_field_#{gid}.selected_options").split('~')
 
@@ -116,6 +144,7 @@ module Checkoff
 
         # custom_field_#{gid}.variant = 'no_value'
         class NoValue < CustomFieldVariant
+          # @return [Array<(Hash, Array)>]
           def convert
             ensure_no_remaining_params!
 
@@ -135,6 +164,7 @@ module Checkoff
         #
         # Not used for multi-select fields
         class AnyValue < CustomFieldVariant
+          # @return [Array<(Hash, Array)>]
           def convert
             ensure_no_remaining_params!
 
@@ -146,6 +176,7 @@ module Checkoff
 
         # custom_field_#{gid}.variant = 'is'
         class Is < CustomFieldVariant
+          # @return [Array<(Hash, Array)>]
           def convert
             selected_options = fetch_solo_param("custom_field_#{gid}.selected_options").split('~')
 

data/lib/checkoff/internal/section_selector_evaluator.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'selector_classes/common'
+require_relative 'selector_classes/section'
+require_relative 'selector_evaluator'
+
+module Checkoff
+  # Evaluates section selectors against a section
+  class SectionSelectorEvaluator < SelectorEvaluator
+    # @param section [Asana::Resources::Project]
+    # @param client [Asana::Client]
+    # @param projects [Checkoff::Projects]
+    # @param sections [Checkoff::Sections]
+    def initialize(section:,
+                   client:,
+                   projects: Checkoff::Projects.new(client: client),
+                   sections: Checkoff::Sections.new)
+      @item = section
+      @client = client
+      @projects = projects
+      @sections = sections
+      super()
+    end
+
+    private
+
+    COMMON_FUNCTION_EVALUATORS = (Checkoff::SelectorClasses::Common.constants.map do |const|
+      Checkoff::SelectorClasses::Common.const_get(const)
+    end - [Checkoff::SelectorClasses::Common::FunctionEvaluator]).freeze
+
+    SECTION_FUNCTION_EVALUATORS = (Checkoff::SelectorClasses::Section.constants.map do |const|
+      Checkoff::SelectorClasses::Section.const_get(const)
+    end - [Checkoff::SelectorClasses::Section::FunctionEvaluator]).freeze
+
+    FUNCTION_EVALUTORS = (COMMON_FUNCTION_EVALUATORS + SECTION_FUNCTION_EVALUATORS).freeze
+
+    # @return [Array<Class<ProjectSelectorClasses::FunctionEvaluator>>]
+    def function_evaluators
+      FUNCTION_EVALUTORS
+    end
+
+    # @return [Hash]
+    def initializer_kwargs
+      { sections: sections, projects: projects, client: client }
+    end
+
+    # @return [Asana::Resources::Project]
+    attr_reader :item
+    # @return [Checkoff::Sections]
+    attr_reader :sections
+    # @return [Checkoff::Projects]
+    attr_reader :projects
+    # @return [Asana::Client]
+    attr_reader :client
+  end
+end

data/lib/checkoff/internal/selector_classes/section/function_evaluator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative '../function_evaluator'
+
+module Checkoff
+  module SelectorClasses
+    module Section
+      # Base class to evaluate a project selector function given fully evaluated arguments
+      class FunctionEvaluator < ::Checkoff::SelectorClasses::FunctionEvaluator
+        # @param selector [Array<(Symbol, Array)>,String]
+        # @param client [Asana::Client]
+        # @param sections [Checkoff::Sections]
+        def initialize(selector:,
+                       sections:,
+                       client:,
+                       **)
+          @selector = selector
+          @sections = sections
+          @client = client
+          super()
+        end
+
+        private
+
+        # @return [Array<(Symbol, Array)>]
+        attr_reader :selector
+
+        # @return [Asana::Client]
+        attr_reader :client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'section/function_evaluator'
+
+module Checkoff
+  module SelectorClasses
+    # Section selector classes
+    module Section
+      # :ends_with_milestone function
+      class DueDateFunctionEvaluator < FunctionEvaluator
+        FUNCTION_NAME = :ends_with_milestone
+
+        def matches?
+          fn?(selector, FUNCTION_NAME)
+        end
+
+        # @param section [Asana::Resources::Section]
+        #
+        # @sg-ignore
+        # @return [Boolean]
+        def evaluate(section)
+          tasks = client.tasks.get_tasks(section: section.gid,
+                                         per_page: 100,
+                                         options: { fields: ['resource_subtype'] })
+          # @sg-ignore
+          tasks.last&.resource_subtype == 'milestone'
+        end
+      end
+    end
+  end
+end

data/lib/checkoff/my_tasks.rb

@@ -61,7 +61,8 @@ module Checkoff
     # @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 = client.sections.get_sections_for_project(project_gid: project_gid,
+                                                          options: { fields: ['name'] })
       sections.each_entry { |section| by_section[section_key(section.name)] = [] }
       tasks.each do |task|
         assignee_section = task.assignee_section

data/lib/checkoff/project_selectors.rb

@@ -9,8 +9,6 @@ require_relative 'internal/project_selector_evaluator'
 require_relative 'workspaces'
 require_relative 'clients'
 
-# https://developers.asana.com/docs/project-selectors
-
 module Checkoff
   # Filter lists of projects using declarative selectors.
   class ProjectSelectors

data/lib/checkoff/section_selectors.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'cache_method'
+require_relative 'internal/config_loader'
+require_relative 'internal/section_selector_evaluator'
+require_relative 'workspaces'
+require_relative 'clients'
+
+module Checkoff
+  # Filter lists of sections using declarative selectors.
+  class SectionSelectors
+    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<Symbol, Object>]
+    # @param workspaces [Checkoff::Workspaces]
+    # @param sections [Checkoff::Sections]
+    # @param clients [Checkoff::Clients]
+    # @param client [Asana::Client]
+    def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
+                   workspaces: Checkoff::Workspaces.new(config: config),
+                   sections: Checkoff::Sections.new(config: config),
+                   clients: Checkoff::Clients.new(config: config),
+                   client: clients.client)
+      @workspaces = workspaces
+      @sections = sections
+      @client = client
+    end
+
+    # @param [Asana::Resources::Section] section
+    # @param [Array<(Symbol, Array)>] section_selector Filter based on
+    #        section details.  Examples: [:tag, 'foo'] [:not, [:tag, 'foo']] [:tag, 'foo']
+    # @return [Boolean]
+    def filter_via_section_selector(section, section_selector)
+      # @sg-ignore
+      evaluator = SectionSelectorEvaluator.new(section: section, sections: sections, client: client)
+      evaluator.evaluate(section_selector)
+    end
+
+    private
+
+    # @return [Checkoff::Workspaces]
+    attr_reader :workspaces
+
+    # @return [Checkoff::Sections]
+    attr_reader :sections
+
+    # @return [Asana::Client]
+    attr_reader :client
+
+    # bundle exec ./section_selectors.rb
+    # :nocov:
+    class << self
+      # @return [void]
+      def run
+        # workspace_name = ARGV[0] || raise('Please pass workspace name as first argument')
+        # section_selector_name = ARGV[1] || raise('Please pass section_selector name as second argument')
+        # section_selectors = Checkoff::SectionSelectors.new
+        # section_selector = section_selectors.section_selector_or_raise(workspace_name, section_selector_name)
+        # puts "Results: #{section_selector}"
+      end
+    end
+    # :nocov:
+  end
+end
+
+# :nocov:
+abs_program_name = File.expand_path($PROGRAM_NAME)
+Checkoff::SectionSelectors.run if abs_program_name == File.expand_path(__FILE__)
+# :nocov:

data/lib/checkoff/sections.rb

@@ -52,12 +52,14 @@ module Checkoff
     # Returns a list of Asana API section objects for a given project
     # @param workspace_name [String]
     # @param project_name [String, Symbol]
+    # @param extra_fields [Array<String>]
     #
     # @return [Enumerable<Asana::Resources::Section>]
-    def sections_or_raise(workspace_name, project_name)
+    def sections_or_raise(workspace_name, project_name, extra_fields: [])
+      fields = %w[name] + extra_fields
       project = project_or_raise(workspace_name, project_name)
-      # @sg-ignore
-      client.sections.get_sections_for_project(project_gid: project.gid)
+      client.sections.get_sections_for_project(project_gid: project.gid,
+                                               options: { fields: fields })
     end
     cache_method :sections_or_raise, SHORT_CACHE_TIME
 
@@ -173,7 +175,8 @@ module Checkoff
     def by_section(tasks, project_gid)
       by_section = {}
       # @sg-ignore
-      sections = client.sections.get_sections_for_project(project_gid: project_gid)
+      sections = client.sections.get_sections_for_project(project_gid: project_gid,
+                                                          options: { fields: ['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

data/lib/checkoff/task_selectors.rb

@@ -9,8 +9,6 @@ require_relative 'internal/config_loader'
 require_relative 'internal/task_selector_evaluator'
 require_relative 'tasks'
 
-# https://developers.asana.com/docs/task-selectors
-
 module Checkoff
   # Filter lists of tasks using declarative selectors.
   class TaskSelectors

data/lib/checkoff/version.rb

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

data/lib/checkoff.rb

@@ -11,4 +11,5 @@ require 'checkoff/custom_fields'
 require 'checkoff/tags'
 require 'checkoff/task_selectors'
 require 'checkoff/project_selectors'
+require 'checkoff/section_selectors'
 require 'checkoff/task_searches'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.65.0
+  version: 0.67.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-18 00:00:00.000000000 Z
+date: 2023-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -140,11 +140,14 @@ files:
 - 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/section_selector_evaluator.rb
 - lib/checkoff/internal/selector_classes/common.rb
 - lib/checkoff/internal/selector_classes/common/function_evaluator.rb
 - lib/checkoff/internal/selector_classes/function_evaluator.rb
 - lib/checkoff/internal/selector_classes/project.rb
 - lib/checkoff/internal/selector_classes/project/function_evaluator.rb
+- lib/checkoff/internal/selector_classes/section.rb
+- lib/checkoff/internal/selector_classes/section/function_evaluator.rb
 - lib/checkoff/internal/selector_classes/task.rb
 - lib/checkoff/internal/selector_classes/task/function_evaluator.rb
 - lib/checkoff/internal/selector_evaluator.rb
@@ -152,6 +155,7 @@ files:
 - lib/checkoff/my_tasks.rb
 - lib/checkoff/project_selectors.rb
 - lib/checkoff/projects.rb
+- lib/checkoff/section_selectors.rb
 - lib/checkoff/sections.rb
 - lib/checkoff/subtasks.rb
 - lib/checkoff/tags.rb