checkoff 0.66.0 → 0.67.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc25937a7534eda70c7729a9844ef9a8d9dd5443f91a90272a0071558255b369
-  data.tar.gz: 380cb06602f7b984f60ad18fa095ccc69e1f3df67273ee09c6a7eff862879d45
+  metadata.gz: 63b887dd83f103cab32923b8326be62de742bc54b4e137a390d005366d57d1c6
+  data.tar.gz: b65f844a89f4bb5821fec1845d417838b61ef317e59b93c1b4825daf97a59ac2
 SHA512:
-  metadata.gz: 5de5eb2dc6849012b9440fb583186a83d7a1123d2d77f254f293be3158c509ea947ae54386510f6b75957f90dd1d664248b8716122c8a8ea744e6216b96d7204
-  data.tar.gz: '088c35ad378b6e2fc57196e58e8071b5814a59c6fe680fdb96212a6571a7de09b497235eeacb048e824a337b5e05f57698417f3864d4670c9a8dd255dace68fa'
+  metadata.gz: 27ecc27a347c29621c95690e93c3614955295b231dec563703f5db8b2a7647c013eacf70b79c6756b6a39dfb5f1b7bcdbfe2fe56a70ab668e40c2ff66d339f22
+  data.tar.gz: 8633ada2cb84d24b32ab6fa1585a648902718d4cf318f5c15ebb6fc1d36bcce076aff818e4406a7931c3450136cd04f4f3d47a4e3e13f2cfb9c60b9b827028a3

data/GLOSSARY.md

@@ -0,0 +1,11 @@
+# Glossary
+
+* ready/due: See tasks.rb#task_ready?.  Indicates a task is ready for
+  a person to work on it.  This is subtly different than what is used
+  by Asana to mark a date as red/green!  A task is ready if it is not
+  dependent on an incomplete task and one of these is true:
+
+  * start is null and due on is today
+  * start is null and due at is after now
+  * start on is today
+  * start at is after now

data/Gemfile.lock

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

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/internal/selector_classes/task.rb

@@ -335,7 +335,9 @@ module Checkoff
         # @param task [Asana::Resources::Task]
         # @return [Boolean]
         def evaluate(task)
-          custom_field = pull_custom_field_by_name_or_raise(task, 'Estimated time')
+          custom_field = pull_custom_field_by_name(task, 'Estimated time')
+
+          return false if custom_field.nil?
 
           # @sg-ignore
           # @type [Integer, nil]

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/tasks.rb

@@ -42,6 +42,16 @@ module Checkoff
       @workspaces = workspaces
     end
 
+    # Indicates a task is ready for a person to work on it.  This is
+    # subtly different than what is used by Asana to mark a date as
+    # red/green!  A task is ready if it is not dependent on an
+    # incomplete task and one of these is true:
+    #
+    # * start is null and due on is today
+    # * start is null and due at is after now
+    # * start on is today
+    # * start at is after now
+    #
     # @param task [Asana::Resources::Task]
     # @param ignore_dependencies [Boolean]
     def task_ready?(task, ignore_dependencies: false)

data/lib/checkoff/version.rb

@@ -3,5 +3,5 @@
 # Command-line and gem client for Asana (unofficial)
 module Checkoff
   # Version of library
-  VERSION = '0.66.0'
+  VERSION = '0.67.1'
 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.66.0
+  version: 0.67.1
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-18 00:00:00.000000000 Z
+date: 2023-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -103,6 +103,7 @@ files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.rst
 - DEVELOPMENT.md
+- GLOSSARY.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -140,11 +141,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 +156,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