checkoff 0.56.0 → 0.58.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48f7926e53c17c01d34979e6e179e7de9f9c3f75e4b525ad198c12c774d2187e
-  data.tar.gz: faba1965ff8947718c5118a30d4271a1ca8445ff43722f3fe0cfc77b0eb25e38
+  metadata.gz: e5b1efd75edc932f14b7c620a0c90ae36bb94a3734c1c6f8ee329301e6f50af8
+  data.tar.gz: 0fe857d53e21d4f66598104917c31fa455eeedc74f0e4e6aa6dc2a24f811c65a
 SHA512:
-  metadata.gz: 396211f82f8e9636af8c46ee4049a7a5fae6278df3bd95f41bfb7350ca5cfe12fcc45544dac8800a4a2d7a2a8fd811a787657dad1d9c311c8fa1cdc989ba6d5a
-  data.tar.gz: 81fa41307abbb32f576411fa147cbbf845eb341e086ab8697b2c715e4dd756b40709e84f471881ef0e192f77fce8f80beecc56586d3abad395a979de9078f2b7
+  metadata.gz: 84b7f631a32dd256986d85fb132226075857339552f0b9b4a880cb17a0f0378e307d8a323beac840b7b2a0a62aad92283cc817dcad1622bf329462adbbfc619c
+  data.tar.gz: af485a9d86625ed4f138a2bc466e506686c9660af08178dba3f82750adad7a1d4f8379ba434707ef10f78b5f79134b1202843ab568ba1e1b26be213830f08a89

data/Gemfile.lock

@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    checkoff (0.56.0)
+    checkoff (0.58.0)
       activesupport
       asana (> 0.10.0)
       cache_method
@@ -45,7 +45,7 @@ GEM
     concurrent-ruby (1.2.2)
     crack (0.4.5)
       rexml
-    dalli (3.2.5)
+    dalli (3.2.6)
     diff-lcs (1.5.0)
     docile (1.4.0)
     e2mmap (0.1.0)

data/config/definitions.rb

@@ -139,7 +139,7 @@
 #         #
 #         # @param per_page [Integer] the number of records to fetch per page.
 #         # @param options [Hash] the request I/O options.
-#         # @return [Asana::Collection<Asana::Resources::Project>]
+#         # @return [Enumerable<Asana::Resources::Project>]
 #         def find_by_workspace(client, workspace: required("workspace"), is_template: nil, archived: nil, per_page: 20, options: {}); end
 #         # Returns the complete project record for a single project.
 #         #

data/lib/checkoff/internal/task_selector_evaluator.rb

@@ -37,7 +37,7 @@ module Checkoff
       #
       # @sg-ignore
       # @return [Date, nil]
-      def pull_date_field_by_name_or_raise(task, field_name)
+      def pull_date_field_by_name(task, field_name)
         if field_name == :modified
           return Time.parse(task.modified_at).to_date unless task.modified_at.nil?
 
@@ -55,6 +55,31 @@ module Checkoff
         raise "Teach me how to handle field #{field_name}"
       end
 
+      # @param task [Asana::Resources::Task]
+      # @param field_name [Symbol]
+      #
+      # @sg-ignore
+      # @return [Date, Time, nil]
+      def pull_date_or_time_field_by_name(task, field_name)
+        if field_name == :due
+          return Time.parse(task.due_at) unless task.due_at.nil?
+
+          return Date.parse(task.due_on) unless task.due_on.nil?
+
+          return nil
+        end
+
+        if field_name == :start
+          return Time.parse(task.start_at) unless task.start_at.nil?
+
+          return Date.parse(task.start_on) unless task.start_on.nil?
+
+          return nil
+        end
+
+        raise "Teach me how to handle field #{field_name}"
+      end
+
       # @sg-ignore
       # @param task [Asana::Resources::Task]
       # @param custom_field_gid [String]
@@ -257,9 +282,10 @@ module Checkoff
       end
 
       # @param task [Asana::Resources::Task]
+      # @param ignore_dependencies [Boolean]
       # @return [Boolean]
-      def evaluate(task)
-        @tasks.task_ready?(task)
+      def evaluate(task, ignore_dependencies: false)
+        @tasks.task_ready?(task, ignore_dependencies: ignore_dependencies)
       end
     end
 
@@ -292,6 +318,53 @@ module Checkoff
       end
     end
 
+    # :due_between_n_days function
+    class DueBetweenRelativePFunctionEvaluator < FunctionEvaluator
+      FUNCTION_NAME = :due_between_relative
+
+      def matches?
+        fn?(task_selector, FUNCTION_NAME)
+      end
+
+      # @param _index [Integer]
+      def evaluate_arg?(_index)
+        false
+      end
+
+      # @param task [Asana::Resources::Task]
+      # @param beginning_num_days_from_now [Integer]
+      # @param end_num_days_from_now [Integer]
+      # @param ignore_dependencies [Boolean]
+      #
+      # @return [Boolean]
+      def evaluate(task, beginning_num_days_from_now, end_num_days_from_now, ignore_dependencies: false)
+        beginning_n_days_from_now_time = (Time.now + (beginning_num_days_from_now * 24 * 60 * 60))
+        end_n_days_from_now_time = (Time.now + (end_num_days_from_now * 24 * 60 * 60))
+
+        # @type [Date, Time, nil]
+        task_date_or_time = pull_date_or_time_field_by_name(task, :start) ||
+                            pull_date_or_time_field_by_name(task, :due)
+
+        return false if task_date_or_time.nil?
+
+        # if time
+        in_range = if task_date_or_time.is_a?(Time)
+                     task_date_or_time > beginning_n_days_from_now_time &&
+                       task_date_or_time <= end_n_days_from_now_time
+                   else
+                     # if date
+                     task_date_or_time > beginning_n_days_from_now_time.to_date &&
+                       task_date_or_time <= end_n_days_from_now_time.to_date
+                   end
+
+        return false unless in_range
+
+        return false if !ignore_dependencies && @tasks.incomplete_dependencies?(task)
+
+        true
+      end
+    end
+
     # :custom_field_value function
     class CustomFieldValueFunctionEvaluator < FunctionEvaluator
       FUNCTION_NAME = :custom_field_value
@@ -387,7 +460,7 @@ module Checkoff
     end
 
     # :field_less_than_n_days_ago
-    class FieldLessThanNDaysAgoFunctionEvaluator < FunctionEvaluator
+    class FieldLessThanNDaysAgoPFunctionEvaluator < FunctionEvaluator
       FUNCTION_NAME = :field_less_than_n_days_ago
 
       def matches?
@@ -404,7 +477,7 @@ module Checkoff
       #
       # @return [Boolean]
       def evaluate(task, field_name, num_days)
-        date = pull_date_field_by_name_or_raise(task, field_name)
+        date = pull_date_field_by_name(task, field_name)
 
         return false if date.nil?
 
@@ -416,7 +489,7 @@ module Checkoff
     end
 
     # :field_greater_than_or_equal_to_n_days_from_today
-    class FieldGreaterThanOrEqualToNDaysFromTodayFunctionEvaluator < FunctionEvaluator
+    class FieldGreaterThanOrEqualToNDaysFromTodayPFunctionEvaluator < FunctionEvaluator
       FUNCTION_NAME = :field_greater_than_or_equal_to_n_days_from_today
 
       def matches?
@@ -433,7 +506,7 @@ module Checkoff
       #
       # @return [Boolean]
       def evaluate(task, field_name, num_days)
-        date = pull_date_field_by_name_or_raise(task, field_name)
+        date = pull_date_field_by_name(task, field_name)
 
         return false if date.nil?
 
@@ -614,10 +687,11 @@ module Checkoff
       Checkoff::TaskSelectorClasses::AndFunctionEvaluator,
       Checkoff::TaskSelectorClasses::OrFunctionEvaluator,
       Checkoff::TaskSelectorClasses::DuePFunctionEvaluator,
+      Checkoff::TaskSelectorClasses::DueBetweenRelativePFunctionEvaluator,
       Checkoff::TaskSelectorClasses::UnassignedPFunctionEvaluator,
       Checkoff::TaskSelectorClasses::DueDateSetPFunctionEvaluator,
-      Checkoff::TaskSelectorClasses::FieldLessThanNDaysAgoFunctionEvaluator,
-      Checkoff::TaskSelectorClasses::FieldGreaterThanOrEqualToNDaysFromTodayFunctionEvaluator,
+      Checkoff::TaskSelectorClasses::FieldLessThanNDaysAgoPFunctionEvaluator,
+      Checkoff::TaskSelectorClasses::FieldGreaterThanOrEqualToNDaysFromTodayPFunctionEvaluator,
       Checkoff::TaskSelectorClasses::CustomFieldLessThanNDaysFromNowFunctionEvaluator,
       Checkoff::TaskSelectorClasses::CustomFieldGreaterThanOrEqualToNDaysFromNowFunctionEvaluator,
       Checkoff::TaskSelectorClasses::LastStoryCreatedLessThanNDaysAgoFunctionEvaluator,

data/lib/checkoff/project_selectors.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'cache_method'
+require_relative 'internal/config_loader'
+require_relative 'workspaces'
+require_relative 'clients'
+
+# https://developers.asana.com/docs/project-selectors
+
+module Checkoff
+  # Filter lists of projects using declarative selectors.
+  class ProjectSelectors
+    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 clients [Checkoff::Clients]
+    # @param client [Asana::Client]
+    def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
+                   workspaces: Checkoff::Workspaces.new(config: config),
+                   clients: Checkoff::Clients.new(config: config),
+                   client: clients.client)
+      @workspaces = workspaces
+      @client = client
+    end
+
+    # @param [Asana::Resources::Project] project
+    # @param [Array<(Symbol, Array)>] project_selector Filter based on
+    #        project details.  Examples: [:tag, 'foo'] [:not, [:tag, 'foo']] [:tag, 'foo']
+    # @return [Boolean]
+    def filter_via_project_selector(project, project_selector)
+      if project_selector == [:custom_field_values_contain_any_value, 'Project attributes', ['timeline']]
+        custom_field = project.custom_fields.find { |field| field.fetch('name') == 'Project attributes' }
+
+        return false if custom_field.nil?
+
+        # @sg-ignore
+        # @type [Hash, nil]
+        timeline = custom_field.fetch('multi_enum_values').find do |multi_enum_value|
+          multi_enum_value.fetch('name') == 'timeline'
+        end
+
+        return !timeline.nil?
+      end
+
+      raise "Teach me how to evaluate #{project} against #{project_selector}"
+    end
+
+    private
+
+    # @return [Checkoff::Workspaces]
+    attr_reader :workspaces
+
+    # @return [Asana::Client]
+    attr_reader :client
+
+    # bundle exec ./project_selectors.rb
+    # :nocov:
+    class << self
+      # @return [void]
+      def run
+        # workspace_name = ARGV[0] || raise('Please pass workspace name as first argument')
+        # project_selector_name = ARGV[1] || raise('Please pass project_selector name as second argument')
+        # project_selectors = Checkoff::ProjectSelectors.new
+        # project_selector = project_selectors.project_selector_or_raise(workspace_name, project_selector_name)
+        # puts "Results: #{project_selector}"
+      end
+    end
+    # :nocov:
+  end
+end
+
+# :nocov:
+abs_program_name = File.expand_path($PROGRAM_NAME)
+Checkoff::ProjectSelectors.run if abs_program_name == File.expand_path(__FILE__)
+# :nocov:

data/lib/checkoff/projects.rb

@@ -59,7 +59,7 @@ module Checkoff
       if project_name.is_a?(Symbol) && project_name.to_s.start_with?('my_tasks')
         my_tasks(workspace_name)
       else
-        # @type [Asana::Collection<Asana::Resources::Project>]
+        # @type [Enumerable<Asana::Resources::Project>]
         ps = projects_by_workspace_name(workspace_name)
         ps.find do |project|
           project.name == project_name
@@ -102,6 +102,17 @@ module Checkoff
     end
     cache_method :tasks_from_project, SHORT_CACHE_TIME
 
+    # @param [String] workspace_name
+    # @param [Array<String>] extra_fields
+    # @return [Enumerable<Asana::Resources::Project>]
+    def projects_by_workspace_name(workspace_name, extra_fields: [])
+      workspace = @workspaces.workspace_or_raise(workspace_name)
+      options = { fields: %w[name] + extra_fields }
+      projects.find_by_workspace(workspace: workspace.gid, per_page: 100, options: options)
+    end
+    # 15 minute cache resulted in 'Your pagination token has expired'
+    cache_method :projects_by_workspace_name, MEDIUM_CACHE_TIME
+
     private
 
     # @return [Asana::Client]
@@ -113,17 +124,6 @@ module Checkoff
     end
     cache_method :projects, LONG_CACHE_TIME
 
-    # @param [String] workspace_name
-    # @return [Asana::Collection<Asana::Resources::Project>]
-    def projects_by_workspace_name(workspace_name)
-      workspace = @workspaces.workspace_or_raise(workspace_name)
-      raise "Could not find workspace named #{workspace_name}" unless workspace
-
-      projects.find_by_workspace(workspace: workspace.gid, per_page: 100)
-    end
-    # 15 minute cache resulted in 'Your pagination token has expired'
-    cache_method :projects_by_workspace_name, MEDIUM_CACHE_TIME
-
     # @param [String] workspace_name
     # @return [Asana::Resources::Project]
     def my_tasks(workspace_name)

data/lib/checkoff/sections.rb

@@ -204,7 +204,7 @@ module Checkoff
 
       project = projects.project(workspace_name, project_name)
       if project.nil?
-        raise "Could not find project #{project_name} " \
+        raise "Could not find project #{project_name.inspect} " \
               "under workspace #{workspace_name}"
       end
       project

data/lib/checkoff/tasks.rb

@@ -103,6 +103,29 @@ module Checkoff
       "https://app.asana.com/0/0/#{task.gid}/f"
     end
 
+    # @param task [Asana::Resources::Task]
+    def incomplete_dependencies?(task)
+      # Avoid a redundant fetch.  Unfortunately, Ruby SDK allows
+      # dependencies to be fetched along with other attributes--but
+      # then doesn't use it and does another HTTP GET!  At least this
+      # way we can skip the extra HTTP GET in the common case when
+      # there are no dependencies.
+      #
+      # https://github.com/Asana/ruby-asana/issues/125
+
+      # @sg-ignore
+      # @type [Enumerable<Asana::Resources::Task>, nil]
+      dependencies = task.instance_variable_get(:@dependencies)
+      dependencies = task.dependencies.map { |dependency| { 'gid' => dependency.gid } } if dependencies.nil?
+
+      dependencies.any? do |parent_task_info|
+        parent_task_gid = parent_task_info.fetch('gid')
+        parent_task = @asana_task.find_by_id(client, parent_task_gid,
+                                             options: { fields: ['completed'] })
+        !parent_task.completed
+      end
+    end
+
     private
 
     # @param workspace_name [String]
@@ -158,28 +181,5 @@ module Checkoff
 
       nil
     end
-
-    # @param task [Asana::Resources::Task]
-    def incomplete_dependencies?(task)
-      # Avoid a redundant fetch.  Unfortunately, Ruby SDK allows
-      # dependencies to be fetched along with other attributes--but
-      # then doesn't use it and does another HTTP GET!  At least this
-      # way we can skip the extra HTTP GET in the common case when
-      # there are no dependencies.
-      #
-      # https://github.com/Asana/ruby-asana/issues/125
-
-      # @sg-ignore
-      # @type [Enumerable<Asana::Resources::Task>, nil]
-      dependencies = task.instance_variable_get(:@dependencies)
-      dependencies = task.dependencies.map { |task| { 'gid' => task.gid } } if dependencies.nil?
-
-      dependencies.any? do |parent_task_info|
-        parent_task_gid = parent_task_info.fetch('gid')
-        parent_task = @asana_task.find_by_id(client, parent_task_gid,
-                                             options: { fields: ['completed'] })
-        !parent_task.completed
-      end
-    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.56.0'
+  VERSION = '0.58.0'
 end

data/lib/checkoff.rb

@@ -10,4 +10,5 @@ require 'checkoff/tasks'
 require 'checkoff/custom_fields'
 require 'checkoff/tags'
 require 'checkoff/task_selectors'
+require 'checkoff/project_selectors'
 require 'checkoff/task_searches'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.56.0
+  version: 0.58.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-17 00:00:00.000000000 Z
+date: 2023-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -141,6 +141,7 @@ files:
 - lib/checkoff/internal/search_url/simple_param_converter.rb
 - lib/checkoff/internal/task_selector_evaluator.rb
 - lib/checkoff/my_tasks.rb
+- lib/checkoff/project_selectors.rb
 - lib/checkoff/projects.rb
 - lib/checkoff/sections.rb
 - lib/checkoff/subtasks.rb