checkoff 0.110.0 → 0.112.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a81e333f4fb405aaeadf79c3e41b65b8282ff8cbbcb5ffea959379e48e4209b0
-  data.tar.gz: bcb8cbf57ccc8b906efbfb350aac27b233163a207e0d7ea08afbb9803f35ce00
+  metadata.gz: 393a800af57dad5fa9edde789dbe166b09ad79b374c2f7dcab230ee0050c49e7
+  data.tar.gz: a2e852b005e952bacf694e0684c97db27a0e53e2e68d79b471d7a2a8d66939ce
 SHA512:
-  metadata.gz: d93bcd456a656aaf8dd375345715b9c39c272be02c9bac9345e84827c7aaa6809a8b0414103f38ac4492dd1690a6662b28c14a9ba50604942a81439aba2dd4b7
-  data.tar.gz: 612fb95319d7be645abbebb0a45442ae9549f3a51f757903bcc4f372d65831c1c72e5fbf52b821b8bd970c27543ff96e0a4901cdcc774dc4d0e1eb164c9f00af
+  metadata.gz: 12769031da94bd1a7afc9afeccededab8f19506201f14c29d97cbacba7b3c0574f73d1a2bf52e9d6e511249d8f946d42295a110f0ef59f575e8d26eb6337377f
+  data.tar.gz: 6395b5b368b7b74a0173d4a62b5e55188348b9c8293865cba02163f7d9a85ede6d6a139ab001f74eaf7acd13b431af341bac7eddc5cff87ec780c4e67f6a7207

data/Gemfile.lock

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

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

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'task/function_evaluator'
-require 'checkoff/internal/ready_between_relative'
 require 'checkoff/internal/task_timing'
 
 module Checkoff
@@ -146,93 +145,6 @@ module Checkoff
         end
       end
 
-      # :ready_between_relative function
-      class ReadyBetweenRelativePFunctionEvaluator < FunctionEvaluator
-        FUNCTION_NAME = :ready_between_relative
-
-        def matches?
-          fn?(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)
-          ready_between_relative = Checkoff::Internal::ReadyBetweenRelative.new(tasks: @tasks)
-          ready_between_relative.ready_between_relative?(task,
-                                                         beginning_num_days_from_now, end_num_days_from_now,
-                                                         ignore_dependencies: ignore_dependencies)
-        end
-      end
-
-      # :custom_field_less_than_n_days_from_now function
-      class CustomFieldLessThanNDaysFromNowFunctionEvaluator < FunctionEvaluator
-        FUNCTION_NAME = :custom_field_less_than_n_days_from_now
-
-        def matches?
-          fn?(selector, FUNCTION_NAME)
-        end
-
-        def evaluate_arg?(_index)
-          false
-        end
-
-        # @param task [Asana::Resources::Task]
-        # @param custom_field_name [String]
-        # @param num_days [Integer]
-        # @return [Boolean]
-        def evaluate(task, custom_field_name, num_days)
-          custom_field = @custom_fields.resource_custom_field_by_name_or_raise(task, custom_field_name)
-
-          # @sg-ignore
-          # @type [String, nil]
-          time_str = custom_field.fetch('display_value')
-          return false if time_str.nil?
-
-          time = Time.parse(time_str)
-          n_days_from_now = (Time.now + (num_days * 24 * 60 * 60))
-          time < n_days_from_now
-        end
-      end
-
-      # :custom_field_greater_than_or_equal_to_n_days_from_now function
-      class CustomFieldGreaterThanOrEqualToNDaysFromNowFunctionEvaluator < FunctionEvaluator
-        FUNCTION_NAME = :custom_field_greater_than_or_equal_to_n_days_from_now
-
-        def matches?
-          fn?(selector, FUNCTION_NAME)
-        end
-
-        def evaluate_arg?(_index)
-          false
-        end
-
-        # @param task [Asana::Resources::Task]
-        # @param custom_field_name [String]
-        # @param num_days [Integer]
-        # @return [Boolean]
-        def evaluate(task, custom_field_name, num_days)
-          custom_field = @custom_fields.resource_custom_field_by_name_or_raise(task, custom_field_name)
-
-          # @sg-ignore
-          # @type [String, nil]
-          time_str = custom_field.fetch('display_value')
-          return false if time_str.nil?
-
-          time = Time.parse(time_str)
-          n_days_from_now = (Time.now + (num_days * 24 * 60 * 60))
-          time >= n_days_from_now
-        end
-      end
-
       # :last_story_created_less_than_n_days_ago function
       class LastStoryCreatedLessThanNDaysAgoFunctionEvaluator < FunctionEvaluator
         FUNCTION_NAME = :last_story_created_less_than_n_days_ago

data/lib/checkoff/internal/task_timing.rb

@@ -6,9 +6,14 @@ module Checkoff
     class TaskTiming
       # @param time_class [Class<Time>]
       # @param date_class [Class<Date>]
-      def initialize(time_class: Time, date_class: Date)
+      # @param client [Asana::Client]
+      # @param custom_fields [Checkoff::CustomFields]
+      def initialize(time_class: Time, date_class: Date,
+                     client: Checkoff::Clients.new.client,
+                     custom_fields: Checkoff::CustomFields.new(client: client))
         @time_class = time_class
         @date_class = date_class
+        @custom_fields = custom_fields
       end
 
       # @param task [Asana::Resources::Task]
@@ -56,6 +61,20 @@ module Checkoff
         return @time_class.parse(task.modified_at) unless task.modified_at.nil?
       end
 
+      # @param task [Asana::Resources::Task]
+      # @param custom_field_name [String]
+      #
+      # @return [Time, Date, nil]
+      def custom_field(task, custom_field_name)
+        custom_field = @custom_fields.resource_custom_field_by_name_or_raise(task, custom_field_name)
+        # @sg-ignore
+        # @type [String, nil]
+        time_str = custom_field.fetch('display_value')
+        return nil if time_str.nil?
+
+        Time.parse(time_str)
+      end
+
       # @param task [Asana::Resources::Task]
       # @param field_name [Symbol]
       #
@@ -70,6 +89,15 @@ module Checkoff
 
         return start_date_or_time(task) || due_date_or_time(task) if field_name == :ready
 
+        if field_name.is_a?(Array)
+          # @sg-ignore
+          # @type [Symbol]
+          actual_field_name = field_name.first
+          args = field_name[1..]
+
+          return custom_field(task, *args) if actual_field_name == :custom_field
+        end
+
         raise "Teach me how to handle field #{field_name}"
       end
     end

data/lib/checkoff/tasks.rb

@@ -28,6 +28,7 @@ module Checkoff
     # @param workspaces [Checkoff::Workspaces]
     # @param sections [Checkoff::Sections]
     # @param portfolios [Checkoff::Portfolios]
+    # @param custom_fields [Checkoff::CustomFields]
     # @param time_class [Class<Time>]
     # @param date_class [Class<Date>]
     # @param asana_task [Class<Asana::Resources::Task>]
@@ -39,6 +40,8 @@ module Checkoff
                                                     client: client),
                    portfolios: Checkoff::Portfolios.new(config: config,
                                                         client: client),
+                   custom_fields: Checkoff::CustomFields.new(config: config,
+                                                             client: client),
                    time_class: Time,
                    date_class: Date,
                    asana_task: Asana::Resources::Task)
@@ -49,6 +52,7 @@ module Checkoff
       @asana_task = asana_task
       @client = client
       @portfolios = portfolios
+      @custom_fields = custom_fields
       @workspaces = workspaces
       @timing = Timing.new(today_getter: date_class, now_getter: time_class)
     end
@@ -73,7 +77,7 @@ module Checkoff
     end
 
     # @param task [Asana::Resources::Task]
-    # @param field_name [Symbol]
+    # @param field_name [Symbol,Array]
     # @param period [Symbol<:now_or_before,:this_week>,Array] See Checkoff::Timing#in_period?_
     def in_period?(task, field_name, period)
       # @type [Date,Time,nil]
@@ -210,7 +214,9 @@ module Checkoff
 
     # @return [Checkoff::Internal::TaskTiming]
     def task_timing
-      @task_timing ||= Checkoff::Internal::TaskTiming.new(time_class: @time_class, date_class: @date_class)
+      @task_timing ||= Checkoff::Internal::TaskTiming.new(time_class: @time_class, date_class: @date_class,
+                                                          client: client,
+                                                          custom_fields: custom_fields)
     end
 
     # @return [Checkoff::Internal::TaskHashes]
@@ -246,6 +252,9 @@ module Checkoff
     # @return [Checkoff::Timing]
     attr_reader :timing
 
+    # @return [Checkoff::CustomFields]
+    attr_reader :custom_fields
+
     # @return [Checkoff::Projects]
     def projects
       @projects ||= @sections.projects

data/lib/checkoff/timing.rb

@@ -68,6 +68,14 @@ module Checkoff
       date >= n_days_from_today
     end
 
+    # @param date_or_time [Date,Time,nil]
+    # @param num_days [Integer]
+    def greater_than_or_equal_to_n_days_from_now?(date_or_time, num_days)
+      return false if date_or_time.nil?
+
+      date_or_time >= n_days_from_now(num_days)
+    end
+
     # @param date_or_time [Date,Time,nil]
     # @param num_days [Integer]
     def less_than_n_days_ago?(date_or_time, num_days)
@@ -81,6 +89,14 @@ module Checkoff
       date < n_days_ago
     end
 
+    # @param date_or_time [Date,Time,nil]
+    # @param num_days [Integer]
+    def less_than_n_days_from_now?(date_or_time, num_days)
+      return false if date_or_time.nil?
+
+      date_or_time < n_days_from_now(num_days)
+    end
+
     # @param date_or_time [Date,Time,nil]
     def this_week?(date_or_time)
       return true if date_or_time.nil?
@@ -105,6 +121,29 @@ module Checkoff
       date_or_time.to_time < @now_getter.now
     end
 
+    # @param num_days [Integer]
+    #
+    # @return [Time]
+    def n_days_from_now(num_days)
+      (@now_getter.now + (num_days * 24 * 60 * 60))
+    end
+
+    # @param date_or_time [Date,Time,nil]
+    # @param beginning_num_days_from_now [Integer,nil]
+    # @param end_num_days_from_now [Integer,nil]
+    def between_relative_days?(date_or_time, beginning_num_days_from_now, end_num_days_from_now)
+      start_time = n_days_from_now(beginning_num_days_from_now || -99_999)
+      end_time = n_days_from_now(end_num_days_from_now || 99_999)
+
+      return false if date_or_time.nil?
+
+      if date_or_time.is_a?(Time)
+        date_or_time > start_time && date_or_time <= end_time
+      else
+        date_or_time > start_time.to_date && date_or_time <= end_time.to_date
+      end
+    end
+
     # @param date_or_time [Date,Time,nil]
     # @param period_name [Symbol]
     # @param args [Object]
@@ -112,11 +151,20 @@ module Checkoff
       # @sg-ignore
       return less_than_n_days_ago?(date_or_time, *args) if period_name == :less_than_n_days_ago
 
+      return less_than_n_days_from_now?(date_or_time, *args) if period_name == :less_than_n_days_from_now
+
+      if period_name == :greater_than_or_equal_to_n_days_from_now
+        return greater_than_or_equal_to_n_days_from_now?(date_or_time, *args)
+      end
+
       if period_name == :greater_than_or_equal_to_n_days_from_today
-        return greater_than_or_equal_to_n_days_from_today?(date_or_time,
-                                                           *args)
+        return greater_than_or_equal_to_n_days_from_today?(date_or_time, *args)
       end
-      raise "Teach me how to handle period [#{period_name.inspect}, #{args.join(', ')}]"
+
+      # @sg-ignore
+      return between_relative_days?(date_or_time, *args) if period_name == :between_relative_days
+
+      raise "Teach me how to handle period [#{period_name.inspect}, #{args.map(&:inspect).join(', ')}]"
     end
 
     # bundle exec ./time.rb

data/lib/checkoff/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.110.0
+  version: 0.112.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-28 00:00:00.000000000 Z
+date: 2023-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -134,7 +134,6 @@ files:
 - lib/checkoff/internal/config_loader.rb
 - lib/checkoff/internal/create-class.sh
 - lib/checkoff/internal/project_selector_evaluator.rb
-- lib/checkoff/internal/ready_between_relative.rb
 - 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

data/lib/checkoff/internal/ready_between_relative.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-module Checkoff
-  module Internal
-    # Determine whether a task is due within a relative date range
-    class ReadyBetweenRelative
-      # @param config [Hash<Symbol, Object>]
-      # @param clients [Checkoff::Clients]
-      # @param task_timing [Checkoff::Internal::TaskTiming]
-      # @param tasks [Checkoff::Tasks]
-      def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
-                     clients: Checkoff::Clients.new(config: config),
-                     task_timing: ::Checkoff::Internal::TaskTiming.new,
-                     tasks: ::Checkoff::Tasks.new(config: config,
-                                                  client: clients.client))
-        @task_timing = task_timing
-        @tasks = tasks
-      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 ready_between_relative?(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]
-        ready_date_or_time = @task_timing.date_or_time_field_by_name(task, :ready)
-
-        return false if ready_date_or_time.nil?
-
-        in_range = ready_in_range?(ready_date_or_time,
-                                   beginning_n_days_from_now_time,
-                                   end_n_days_from_now_time)
-
-        return false unless in_range
-
-        return false if !ignore_dependencies && @tasks.incomplete_dependencies?(task)
-
-        true
-      end
-
-      private
-
-      # @param ready_date_or_time [Date, Time]
-      # @param start_time [Time]
-      # @param end_time [Time]
-      def ready_in_range?(ready_date_or_time, start_time, end_time)
-        if ready_date_or_time.is_a?(Time)
-          ready_date_or_time > start_time && ready_date_or_time <= end_time
-        else
-          ready_date_or_time > start_time.to_date && ready_date_or_time <= end_time.to_date
-        end
-      end
-    end
-  end
-end