checkoff 0.55.0 → 0.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e441dfbcef11d610f73873858235bd110aa27b730a40eca5c5a38aac3e27ff5c
-  data.tar.gz: 4810a4c39437830b9dd6a909102328d6f413600a30bf2fe92702d1a59fe4ae61
+  metadata.gz: '096eda83e243c4db30bcb92480b82f9be93dd9155b5fdb70058c4e364fe35c22'
+  data.tar.gz: e2886085e543f652cf99c8f0784d2726a470e41f26434171afa3da3e43d84118
 SHA512:
-  metadata.gz: '08ad245068e7a1278a90943eff26e239175aa2874b9db59b682448f3069f8d3e71bddae0f21cefcddf2f315a95cfc0094800759487953fb519be6af9935886d1'
-  data.tar.gz: 02c0f071c4d722f26014d2029e13794a26e15ab1396291177e80b8d4506e301bd33b2e3984296314e8a57bf522c589c1a9f4684810564f8f3b387b1e780bbbe3
+  metadata.gz: 6a119915c86c1124bc61aecb09bad54c3ec274feea2f4f627aadf24a090baae996a200361c4c5bfa52d9b8a65d822ca14b87b36fff4c486a9ee2f3763fc416a3
+  data.tar.gz: 3596da35a48094243a44794df858acb0718141b40555c56889b6adf4ad16c47287633e1e5cbcd293385424e13aafc21ef640c6475933551370c9e6142facaee3

data/Gemfile.lock

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

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]
@@ -163,6 +188,26 @@ module Checkoff
       end
     end
 
+    # :or function
+    #
+    # Does not yet shortcut, but may in future - be careful with side
+    # effects!
+    class OrFunctionEvaluator < FunctionEvaluator
+      FUNCTION_NAME = :or
+
+      def matches?
+        fn?(task_selector, FUNCTION_NAME)
+      end
+
+      # @param _task [Asana::Resources::Task]
+      # @param lhs [Object]
+      # @param rhs [Object]
+      # @return [Object]
+      def evaluate(_task, lhs, rhs)
+        lhs || rhs
+      end
+    end
+
     # :not function
     class NotFunctionEvaluator < FunctionEvaluator
       FUNCTION_NAME = :not
@@ -237,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
 
@@ -272,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
@@ -367,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?
@@ -384,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?
 
@@ -396,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?
@@ -413,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?
 
@@ -504,7 +597,7 @@ module Checkoff
         # for whatever reason, .last on the enumerable does not impose ordering; .to_a does!
 
         # @type [Array<Asana::Resources::Story>]
-        stories = task.stories.to_a.reject do |story|
+        stories = task.stories(per_page: 100).to_a.reject do |story|
           excluding_resource_subtypes.include? story.resource_subtype
         end
         return true if stories.empty? # no stories == infinitely old!
@@ -592,11 +685,13 @@ module Checkoff
       Checkoff::TaskSelectorClasses::CustomFieldGidValueContainsAnyGidFunctionEvaluator,
       Checkoff::TaskSelectorClasses::CustomFieldGidValueContainsAllGidsFunctionEvaluator,
       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/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.55.0'
+  VERSION = '0.57.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.55.0
+  version: 0.57.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-17 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport