checkoff 0.44.0 → 0.44.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 413eeaac4e3e2a4784e5fca4930fed96beedd594b87f1c8d80460aabe4ee1dd3
-  data.tar.gz: 4127604e8d5c3605d49c2fda86fe0c0e1bed95aaeadfc493d8a2b02c19bed94d
+  metadata.gz: d924c906eed129ad1c57bdbfdd8cdcc61b572e296a09721195b7c1a10d78dbe5
+  data.tar.gz: 79e71aac6289b18a448288a601c62a02cee6583bcbbc966e64a71003c8e73e89
 SHA512:
-  metadata.gz: 001c49dab8df9d273f2c395dd422509afa82c856712b7dfef9b7c65bf7f23c7d3ada832d32e888b188d38751716ee7e54c8d144b4575cd2de384946002ae6fc5
-  data.tar.gz: a10f6ee8a33870277503458dc19809e642d837899c31c1698ba04942356386fe09c713643db3f3694eca7d5495c43fe13c93d2ae7785e3ad383aeed88651e2f0
+  metadata.gz: 8bc265211c02ebf11e7c7f35ce79aae7517c6b86cf023c8d0b41713a24df2365954f9757bfe9b44a85573187af7fb355f84e7d6b1bad9e8b32fc9b8b9ed6891d
+  data.tar.gz: 5de92894cb1f12d633667b87f426f4460d63a54d84cb1a9f2e8e38c529c45d41efdd9097cb9a2dd6f73691669a4a070ba87aedc55a5d8ec7780fa9cec5e2d13a

data/Gemfile

@@ -29,6 +29,7 @@ gem 'simplecov-lcov'
 gem 'solargraph', ['>=0.49.0']
 gem 'undercover'
 gem 'webmock'
+gem 'yard'
 
 # ruby-asana gem is pending key bugfixes for checkoff as of
 # 2021-07-29:

data/Gemfile.lock

@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    checkoff (0.44.0)
+    checkoff (0.44.2)
       activesupport
       asana (> 0.10.0)
       cache_method
@@ -22,7 +22,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.5.1)
+    activesupport (7.0.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -235,6 +235,7 @@ DEPENDENCIES
   solargraph (>= 0.49.0)
   undercover
   webmock
+  yard
 
 BUNDLED WITH
    2.3.26

data/README.md

@@ -2,7 +2,11 @@
 
 Command-line and gem client for Asana (unofficial)
 
-## Using
+## Using library
+
+See [docs](https://www.rubydoc.info/github/apiology/checkoff)
+
+## Using CLI
 
 ```sh
 $ checkoff --help

data/docs/.gitignore

@@ -0,0 +1,3 @@
+*.html
+/css
+/js

data/lib/checkoff/internal/task_selector_evaluator.rb

@@ -1,379 +1,399 @@
 # frozen_string_literal: true
 
 module Checkoff
-  # Base class to evaluate a task selector function given fully evaluated arguments
-  class FunctionEvaluator
-    # @param task_selector [Array<(Symbol, Array)>,String]
-    # @param tasks [Checkoff::Tasks]
-    def initialize(task_selector:,
-                   tasks:)
-      @task_selector = task_selector
-      @tasks = tasks
-    end
+  module TaskSelectorClasses
+    # Base class to evaluate a task selector function given fully evaluated arguments
+    class FunctionEvaluator
+      # @param task_selector [Array<(Symbol, Array)>,String]
+      # @param tasks [Checkoff::Tasks]
+      def initialize(task_selector:,
+                     tasks:)
+        @task_selector = task_selector
+        @tasks = tasks
+      end
 
-    # @sg-ignore
-    # @param _index [Integer]
-    def evaluate_arg?(_index)
-      true
-    end
+      # @sg-ignore
+      # @param _index [Integer]
+      def evaluate_arg?(_index)
+        true
+      end
 
-    # @sg-ignore
-    # @return [Boolean]
-    def matches?
-      raise 'Override me!'
-    end
+      # @sg-ignore
+      # @return [Boolean]
+      def matches?
+        raise 'Override me!'
+      end
 
-    private
+      private
 
-    # @param object [Object]
-    # @param fn_name [Symbol]
-    def fn?(object, fn_name)
-      object.is_a?(Array) && !object.empty? && [fn_name, fn_name.to_s].include?(object[0])
-    end
+      # @param object [Object]
+      # @param fn_name [Symbol]
+      def fn?(object, fn_name)
+        object.is_a?(Array) && !object.empty? && [fn_name, fn_name.to_s].include?(object[0])
+      end
 
-    # @sg-ignore
-    # @param task [Asana::Resources::Task]
-    # @param custom_field_gid [String]
-    # @return [Hash]
-    def pull_custom_field_or_raise(task, custom_field_gid)
-      # @type [Array<Hash>]
-      custom_fields = task.custom_fields
-      if custom_fields.nil?
-        raise "Could not find custom_fields under task (was 'custom_fields' included in 'extra_fields'?)"
+      # @sg-ignore
+      # @param task [Asana::Resources::Task]
+      # @param custom_field_gid [String]
+      # @return [Hash]
+      def pull_custom_field_or_raise(task, custom_field_gid)
+        # @type [Array<Hash>]
+        custom_fields = task.custom_fields
+        if custom_fields.nil?
+          raise "Could not find custom_fields under task (was 'custom_fields' included in 'extra_fields'?)"
+        end
+
+        # @sg-ignore
+        # @type [Hash, nil]
+        matched_custom_field = custom_fields.find { |data| data.fetch('gid') == custom_field_gid }
+        if matched_custom_field.nil?
+          raise "Could not find custom field with gid #{custom_field_gid} " \
+                "in task #{task.gid} with custom fields #{custom_fields}"
+        end
+
+        matched_custom_field
       end
 
+      # @return [Array<(Symbol, Array)>]
+      attr_reader :task_selector
+
       # @sg-ignore
-      # @type [Hash, nil]
-      matched_custom_field = custom_fields.find { |data| data.fetch('gid') == custom_field_gid }
-      if matched_custom_field.nil?
-        raise "Could not find custom field with gid #{custom_field_gid} " \
-              "in task #{task.gid} with custom fields #{custom_fields}"
+      # @param custom_field [Hash]
+      # @return [Array<String>]
+      def pull_enum_values(custom_field)
+        resource_subtype = custom_field.fetch('resource_subtype')
+        case resource_subtype
+        when 'enum'
+          [custom_field.fetch('enum_value')]
+        when 'multi_enum'
+          custom_field.fetch('multi_enum_values')
+        else
+          raise "Teach me how to handle resource_subtype #{resource_subtype}"
+        end
       end
 
-      matched_custom_field
-    end
+      # @param custom_field [Hash]
+      # @param enum_value [Object, nil]
+      # @return [Array<String>]
+      def find_gids(custom_field, enum_value)
+        if enum_value.nil?
+          []
+        else
+          raise "Unexpected enabled value on custom field: #{custom_field}" if enum_value.fetch('enabled') == false
+
+          [enum_value.fetch('gid')]
+        end
+      end
 
-    # @return [Array<(Symbol, Array)>]
-    attr_reader :task_selector
+      # @param task [Asana::Resources::Task]
+      # @param custom_field_gid [String]
+      # @return [Array<String>]
+      def pull_custom_field_values_gids(task, custom_field_gid)
+        custom_field = pull_custom_field_or_raise(task, custom_field_gid)
+        pull_enum_values(custom_field).flat_map do |enum_value|
+          find_gids(custom_field, enum_value)
+        end
+      end
 
-    # @sg-ignore
-    # @param custom_field [Hash]
-    # @return [Array<String>]
-    def pull_enum_values(custom_field)
-      resource_subtype = custom_field.fetch('resource_subtype')
-      case resource_subtype
-      when 'enum'
-        [custom_field.fetch('enum_value')]
-      when 'multi_enum'
-        custom_field.fetch('multi_enum_values')
-      else
-        raise "Teach me how to handle resource_subtype #{resource_subtype}"
+      # @sg-ignore
+      # @param task [Asana::Resources::Task]
+      # @param custom_field_name [String]
+      # @return [Hash, nil]
+      def pull_custom_field_by_name(task, custom_field_name)
+        custom_fields = task.custom_fields
+        if custom_fields.nil?
+          raise "custom fields not found on task - did you add 'custom_fields' in your extra_fields argument?"
+        end
+
+        # @sg-ignore
+        # @type [Hash, nil]
+        custom_fields.find { |field| field.fetch('name') == custom_field_name }
+      end
+
+      # @param task [Asana::Resources::Task]
+      # @param custom_field_name [String]
+      # @return [Hash]
+      def pull_custom_field_by_name_or_raise(task, custom_field_name)
+        custom_field = pull_custom_field_by_name(task, custom_field_name)
+        if custom_field.nil?
+          raise "Could not find custom field with name #{custom_field_name} " \
+                "in task #{task.gid} with custom fields #{task.custom_fields}"
+        end
+        custom_field
       end
     end
 
-    # @param custom_field [Hash]
-    # @param enum_value [Object, nil]
-    # @return [Array<String>]
-    def find_gids(custom_field, enum_value)
-      if enum_value.nil?
-        []
-      else
-        raise "Unexpected enabled value on custom field: #{custom_field}" if enum_value.fetch('enabled') == false
+    # :and function
+    class AndFunctionEvaluator < FunctionEvaluator
+      FUNCTION_NAME = :and
 
-        [enum_value.fetch('gid')]
+      def matches?
+        fn?(task_selector, FUNCTION_NAME)
       end
-    end
 
-    # @param task [Asana::Resources::Task]
-    # @param custom_field_gid [String]
-    # @return [Array<String>]
-    def pull_custom_field_values_gids(task, custom_field_gid)
-      custom_field = pull_custom_field_or_raise(task, custom_field_gid)
-      pull_enum_values(custom_field).flat_map do |enum_value|
-        find_gids(custom_field, enum_value)
+      # @param _task [Asana::Resources::Task]
+      # @param lhs [Object]
+      # @param rhs [Object]
+      # @return [Object]
+      def evaluate(_task, lhs, rhs)
+        lhs && rhs
       end
     end
 
-    # @sg-ignore
-    # @param task [Asana::Resources::Task]
-    # @param custom_field_name [String]
-    # @return [Hash, nil]
-    def pull_custom_field_by_name(task, custom_field_name)
-      custom_fields = task.custom_fields
-      if custom_fields.nil?
-        raise "custom fields not found on task - did you add 'custom_fields' in your extra_fields argument?"
+    # :not function
+    class NotFunctionEvaluator < FunctionEvaluator
+      FUNCTION_NAME = :not
+
+      def matches?
+        fn?(task_selector, FUNCTION_NAME)
       end
 
-      # @sg-ignore
-      # @type [Hash, nil]
-      custom_fields.find { |field| field.fetch('name') == custom_field_name }
+      # @param _task [Asana::Resources::Task]
+      # @param subvalue [Object]
+      # @return [Boolean]
+      def evaluate(_task, subvalue)
+        !subvalue
+      end
     end
 
-    # @param task [Asana::Resources::Task]
-    # @param custom_field_name [String]
-    # @return [Hash]
-    def pull_custom_field_by_name_or_raise(task, custom_field_name)
-      custom_field = pull_custom_field_by_name(task, custom_field_name)
-      if custom_field.nil?
-        raise "Could not find custom field with name #{custom_field_name} " \
-              "in task #{task.gid} with custom fields #{task.custom_fields}"
-      end
-      custom_field
-    end
-  end
+    # :nil? function
+    class NilPFunctionEvaluator < FunctionEvaluator
+      def matches?
+        fn?(task_selector, :nil?)
+      end
 
-  # :and function
-  class AndFunctionEvaluator < FunctionEvaluator
-    def matches?
-      fn?(task_selector, :and)
+      # @param _task [Asana::Resources::Task]
+      # @param subvalue [Object]
+      # @return [Boolean]
+      def evaluate(_task, subvalue)
+        subvalue.nil?
+      end
     end
 
-    # @param _task [Asana::Resources::Task]
-    # @param lhs [Object]
-    # @param rhs [Object]
-    # @return [Object]
-    def evaluate(_task, lhs, rhs)
-      lhs && rhs
-    end
-  end
+    # :equals? function
+    class EqualsPFunctionEvaluator < FunctionEvaluator
+      FUNCTION_NAME = :equals?
 
-  # :not function
-  class NotFunctionEvaluator < FunctionEvaluator
-    def matches?
-      fn?(task_selector, :not)
-    end
+      def matches?
+        fn?(task_selector, FUNCTION_NAME)
+      end
 
-    # @param _task [Asana::Resources::Task]
-    # @param subvalue [Object]
-    # @return [Boolean]
-    def evaluate(_task, subvalue)
-      !subvalue
+      # @param _task [Asana::Resources::Task]
+      # @param lhs [Object]
+      # @param rhs [Object]
+      # @return [Boolean]
+      def evaluate(_task, lhs, rhs)
+        lhs == rhs
+      end
     end
-  end
 
-  # :nil? function
-  class NilPFunctionEvaluator < FunctionEvaluator
-    def matches?
-      fn?(task_selector, :nil?)
-    end
+    # :tag function
+    class TagPFunctionEvaluator < FunctionEvaluator
+      def matches?
+        fn?(task_selector, :tag)
+      end
 
-    # @param _task [Asana::Resources::Task]
-    # @param subvalue [Object]
-    # @return [Boolean]
-    def evaluate(_task, subvalue)
-      subvalue.nil?
-    end
-  end
+      # @param _index [Integer]
+      def evaluate_arg?(_index)
+        false
+      end
 
-  # :equals? function
-  class EqualsPFunctionEvaluator < FunctionEvaluator
-    def matches?
-      fn?(task_selector, :equals?)
+      # @sg-ignore
+      # @param task [Asana::Resources::Task]
+      # @param tag_name [String]
+      # @return [Boolean]
+      def evaluate(task, tag_name)
+        task.tags.map(&:name).include? tag_name
+      end
     end
 
-    # @param _task [Asana::Resources::Task]
-    # @param lhs [Object]
-    # @param rhs [Object]
-    # @return [Boolean]
-    def evaluate(_task, lhs, rhs)
-      lhs == rhs
-    end
-  end
+    # :due function
+    class DuePFunctionEvaluator < FunctionEvaluator
+      def matches?
+        fn?(task_selector, :due)
+      end
 
-  # :tag function
-  class TagPFunctionEvaluator < FunctionEvaluator
-    def matches?
-      fn?(task_selector, :tag)
+      # @param task [Asana::Resources::Task]
+      # @return [Boolean]
+      def evaluate(task)
+        @tasks.task_ready?(task)
+      end
     end
 
-    # @param _index [Integer]
-    def evaluate_arg?(_index)
-      false
-    end
+    # :due_date_set function
+    class DueDateSetPFunctionEvaluator < FunctionEvaluator
+      FUNCTION_NAME = :due_date_set
 
-    # @sg-ignore
-    # @param task [Asana::Resources::Task]
-    # @param tag_name [String]
-    # @return [Boolean]
-    def evaluate(task, tag_name)
-      task.tags.map(&:name).include? tag_name
-    end
-  end
+      def matches?
+        fn?(task_selector, FUNCTION_NAME)
+      end
 
-  # :due function
-  class DuePFunctionEvaluator < FunctionEvaluator
-    def matches?
-      fn?(task_selector, :due)
+      # @sg-ignore
+      # @param task [Asana::Resources::Task]
+      # @return [Boolean]
+      def evaluate(task)
+        !task.due_at.nil? || !task.due_on.nil?
+      end
     end
 
-    # @param task [Asana::Resources::Task]
-    # @return [Boolean]
-    def evaluate(task)
-      @tasks.task_ready?(task)
-    end
-  end
+    # :custom_field_value function
+    class CustomFieldValueFunctionEvaluator < FunctionEvaluator
+      FUNCTION_NAME = :custom_field_value
 
-  # :due_date_set function
-  class DueDateSetPFunctionEvaluator < FunctionEvaluator
-    def matches?
-      fn?(task_selector, :due_date_set)
-    end
+      def matches?
+        fn?(task_selector, FUNCTION_NAME)
+      end
 
-    # @sg-ignore
-    # @param task [Asana::Resources::Task]
-    # @return [Boolean]
-    def evaluate(task)
-      !task.due_at.nil? || !task.due_on.nil?
-    end
-  end
+      # @param _index [Integer]
+      def evaluate_arg?(_index)
+        false
+      end
 
-  # :custom_field_value function
-  class CustomFieldValueFunctionEvaluator < FunctionEvaluator
-    def matches?
-      fn?(task_selector, :custom_field_value)
-    end
+      # @param task [Asana::Resources::Task]
+      # @param custom_field_name [String]
+      # @return [String, nil]
+      def evaluate(task, custom_field_name)
+        custom_field = pull_custom_field_by_name(task, custom_field_name)
+        return nil if custom_field.nil?
 
-    # @param _index [Integer]
-    def evaluate_arg?(_index)
-      false
+        custom_field['display_value']
+      end
     end
 
-    # @param task [Asana::Resources::Task]
-    # @param custom_field_name [String]
-    # @return [String, nil]
-    def evaluate(task, custom_field_name)
-      custom_field = pull_custom_field_by_name(task, custom_field_name)
-      return nil if custom_field.nil?
+    # :custom_field_gid_value function
+    class CustomFieldGidValueFunctionEvaluator < FunctionEvaluator
+      def matches?
+        fn?(task_selector, :custom_field_gid_value)
+      end
 
-      custom_field['display_value']
-    end
-  end
+      def evaluate_arg?(_index)
+        false
+      end
 
-  # :custom_field_gid_value function
-  class CustomFieldGidValueFunctionEvaluator < FunctionEvaluator
-    def matches?
-      fn?(task_selector, :custom_field_gid_value)
+      # @sg-ignore
+      # @param task [Asana::Resources::Task]
+      # @param custom_field_gid [String]
+      # @return [String, nil]
+      def evaluate(task, custom_field_gid)
+        custom_field = pull_custom_field_or_raise(task, custom_field_gid)
+        custom_field['display_value']
+      end
     end
 
-    def evaluate_arg?(_index)
-      false
-    end
+    # :custom_field_gid_value_contains_any_gid function
+    class CustomFieldGidValueContainsAnyGidFunctionEvaluator < FunctionEvaluator
+      FUNCTION_NAME = :custom_field_gid_value_contains_any_gid
 
-    # @sg-ignore
-    # @param task [Asana::Resources::Task]
-    # @param custom_field_gid [String]
-    # @return [String, nil]
-    def evaluate(task, custom_field_gid)
-      custom_field = pull_custom_field_or_raise(task, custom_field_gid)
-      custom_field['display_value']
-    end
-  end
+      def matches?
+        fn?(task_selector, FUNCTION_NAME)
+      end
 
-  # :custom_field_gid_value_contains_any_gid function
-  class CustomFieldGidValueContainsAnyGidFunctionEvaluator < FunctionEvaluator
-    def matches?
-      fn?(task_selector, :custom_field_gid_value_contains_any_gid)
-    end
+      def evaluate_arg?(_index)
+        false
+      end
+
+      # @param task [Asana::Resources::Task]
+      # @param custom_field_gid [String]
+      # @param custom_field_values_gids [Array<String>]
+      # @return [Boolean]
+      def evaluate(task, custom_field_gid, custom_field_values_gids)
+        actual_custom_field_values_gids = pull_custom_field_values_gids(task, custom_field_gid)
 
-    def evaluate_arg?(_index)
-      false
+        actual_custom_field_values_gids.any? do |custom_field_value|
+          custom_field_values_gids.include?(custom_field_value)
+        end
+      end
     end
 
-    # @param task [Asana::Resources::Task]
-    # @param custom_field_gid [String]
-    # @param custom_field_values_gids [Array<String>]
-    # @return [Boolean]
-    def evaluate(task, custom_field_gid, custom_field_values_gids)
-      actual_custom_field_values_gids = pull_custom_field_values_gids(task, custom_field_gid)
+    # :custom_field_gid_value_contains_all_gids function
+    class CustomFieldGidValueContainsAllGidsFunctionEvaluator < FunctionEvaluator
+      FUNCTION_NAME = :custom_field_gid_value_contains_all_gids
 
-      actual_custom_field_values_gids.any? do |custom_field_value|
-        custom_field_values_gids.include?(custom_field_value)
+      def matches?
+        fn?(task_selector, FUNCTION_NAME)
       end
-    end
-  end
 
-  # :custom_field_gid_value_contains_all_gids function
-  class CustomFieldGidValueContainsAllGidsFunctionEvaluator < FunctionEvaluator
-    def matches?
-      fn?(task_selector, :custom_field_gid_value_contains_all_gids)
-    end
+      def evaluate_arg?(_index)
+        false
+      end
 
-    def evaluate_arg?(_index)
-      false
+      # @param task [Asana::Resources::Task]
+      # @param custom_field_gid [String]
+      # @param custom_field_values_gids [Array<String>]
+      # @return [Boolean]
+      def evaluate(task, custom_field_gid, custom_field_values_gids)
+        actual_custom_field_values_gids = pull_custom_field_values_gids(task, custom_field_gid)
+
+        custom_field_values_gids.all? do |custom_field_value|
+          actual_custom_field_values_gids.include?(custom_field_value)
+        end
+      end
     end
 
-    # @param task [Asana::Resources::Task]
-    # @param custom_field_gid [String]
-    # @param custom_field_values_gids [Array<String>]
-    # @return [Boolean]
-    def evaluate(task, custom_field_gid, custom_field_values_gids)
-      actual_custom_field_values_gids = pull_custom_field_values_gids(task, custom_field_gid)
+    # :custom_field_less_than_n_days_from_now function
+    class CustomFieldLessThanNDaysFromNowFunctionEvaluator < FunctionEvaluator
+      FUNCTION_NAME = :custom_field_less_than_n_days_from_now
 
-      custom_field_values_gids.all? do |custom_field_value|
-        actual_custom_field_values_gids.include?(custom_field_value)
+      def matches?
+        fn?(task_selector, FUNCTION_NAME)
       end
-    end
-  end
 
-  # :custom_field_less_than_n_days_from_now function
-  class CustomFieldLessThanNDaysFromNowFunctionEvaluator < FunctionEvaluator
-    def matches?
-      fn?(task_selector, :custom_field_less_than_n_days_from_now)
-    end
+      def evaluate_arg?(_index)
+        false
+      end
 
-    def evaluate_arg?(_index)
-      false
+      # @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 = pull_custom_field_by_name_or_raise(task, custom_field_name)
+
+        time_str = custom_field.fetch('display_value')
+        time = Time.parse(time_str)
+        n_days_from_now = (Time.now + (num_days * 24 * 60 * 60))
+        time < n_days_from_now
+      end
     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 = pull_custom_field_by_name_or_raise(task, custom_field_name)
-
-      time_str = custom_field.fetch('display_value')
-      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
 
-  # :custom_field_greater_than_or_equal_to_n_days_from_now function
-  class CustomFieldGreaterThanOrEqualToNDaysFromNowFunctionEvaluator < FunctionEvaluator
-    def matches?
-      fn?(task_selector, :custom_field_greater_than_or_equal_to_n_days_from_now)
-    end
+      def matches?
+        fn?(task_selector, FUNCTION_NAME)
+      end
 
-    def evaluate_arg?(_index)
-      false
-    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 = pull_custom_field_by_name_or_raise(task, custom_field_name)
-
-      time_str = custom_field.fetch('display_value')
-      time = Time.parse(time_str)
-      n_days_from_now = (Time.now + (num_days * 24 * 60 * 60))
-      time >= n_days_from_now
+      # @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 = pull_custom_field_by_name_or_raise(task, custom_field_name)
+
+        time_str = custom_field.fetch('display_value')
+        time = Time.parse(time_str)
+        n_days_from_now = (Time.now + (num_days * 24 * 60 * 60))
+        time >= n_days_from_now
+      end
     end
-  end
 
-  # String literals
-  class StringLiteralEvaluator < FunctionEvaluator
-    def matches?
-      task_selector.is_a?(String)
-    end
+    # String literals
+    class StringLiteralEvaluator < FunctionEvaluator
+      def matches?
+        task_selector.is_a?(String)
+      end
 
-    # @sg-ignore
-    # @param _task [Asana::Resources::Task]
-    # @return [String]
-    def evaluate(_task)
-      task_selector
+      # @sg-ignore
+      # @param _task [Asana::Resources::Task]
+      # @return [String]
+      def evaluate(_task)
+        task_selector
+      end
     end
   end
 
@@ -388,20 +408,20 @@ module Checkoff
     end
 
     FUNCTION_EVALUTORS = [
-      NotFunctionEvaluator,
-      NilPFunctionEvaluator,
-      EqualsPFunctionEvaluator,
-      TagPFunctionEvaluator,
-      CustomFieldValueFunctionEvaluator,
-      CustomFieldGidValueFunctionEvaluator,
-      CustomFieldGidValueContainsAnyGidFunctionEvaluator,
-      CustomFieldGidValueContainsAllGidsFunctionEvaluator,
-      AndFunctionEvaluator,
-      DuePFunctionEvaluator,
-      DueDateSetPFunctionEvaluator,
-      CustomFieldLessThanNDaysFromNowFunctionEvaluator,
-      CustomFieldGreaterThanOrEqualToNDaysFromNowFunctionEvaluator,
-      StringLiteralEvaluator,
+      Checkoff::TaskSelectorClasses::NotFunctionEvaluator,
+      Checkoff::TaskSelectorClasses::NilPFunctionEvaluator,
+      Checkoff::TaskSelectorClasses::EqualsPFunctionEvaluator,
+      Checkoff::TaskSelectorClasses::TagPFunctionEvaluator,
+      Checkoff::TaskSelectorClasses::CustomFieldValueFunctionEvaluator,
+      Checkoff::TaskSelectorClasses::CustomFieldGidValueFunctionEvaluator,
+      Checkoff::TaskSelectorClasses::CustomFieldGidValueContainsAnyGidFunctionEvaluator,
+      Checkoff::TaskSelectorClasses::CustomFieldGidValueContainsAllGidsFunctionEvaluator,
+      Checkoff::TaskSelectorClasses::AndFunctionEvaluator,
+      Checkoff::TaskSelectorClasses::DuePFunctionEvaluator,
+      Checkoff::TaskSelectorClasses::DueDateSetPFunctionEvaluator,
+      Checkoff::TaskSelectorClasses::CustomFieldLessThanNDaysFromNowFunctionEvaluator,
+      Checkoff::TaskSelectorClasses::CustomFieldGreaterThanOrEqualToNDaysFromNowFunctionEvaluator,
+      Checkoff::TaskSelectorClasses::StringLiteralEvaluator,
     ].freeze
 
     # @param task_selector [Array]

data/lib/checkoff/sections.rb

@@ -13,15 +13,24 @@ module Checkoff
     #   extend CacheMethod::ClassMethods
 
     MINUTE = 60
-    # @sg-ignore
     LONG_CACHE_TIME = MINUTE * 15
-    # @sg-ignore
     SHORT_CACHE_TIME = MINUTE * 5
 
     extend Forwardable
 
-    attr_reader :projects, :workspaces, :time, :my_tasks
+    # @return [Checkoff::Projects]
+    attr_reader :projects
+
+    # @return [Checkoff::Workspaces]
+    attr_reader :workspaces
 
+    # @return [Class<Time>]
+    attr_reader :time
+
+    # @return [Checkoff::MyTasks]
+    attr_reader :my_tasks
+
+    # @param config [Hash<Symbol, Object>]
     # @param client [Asana::Client]
     # @param projects [Checkoff::Projects]
     # @param workspaces [Checkoff::Workspaces]
@@ -108,6 +117,7 @@ module Checkoff
     # @param project_name [String, Symbol]
     # @param section_name [String, nil]
     #
+    # @sg-ignore
     # @return [Asana::Resources::Section]
     def section_or_raise(workspace_name, project_name, section_name)
       s = section(workspace_name, project_name, section_name)
@@ -123,13 +133,13 @@ module Checkoff
 
     private
 
-    # @!attribute [r] client
-    #   @return [Asana::Client]
+    # @return [Asana::Client]
     attr_reader :client
 
     # Given a project object, pull all tasks, then provide a Hash of
     # tasks with section name -> task list of the uncompleted tasks
     # @param project [Asana::Resources::Project]
+    # @param extra_fields [Array<String>]
     # @return [Hash<[String,nil], Array<Asana::Resources::Task>>]
     def tasks_by_section_for_project(project, extra_fields: [])
       raw_tasks = projects.tasks_from_project(project, extra_fields: extra_fields)
@@ -137,6 +147,8 @@ module Checkoff
       by_section(active_tasks, project.gid)
     end
 
+    # @param name [String]
+    # @return [String, nil]
     def section_key(name)
       inbox_section_names = ['(no section)', 'Untitled section', 'Inbox']
       return nil if inbox_section_names.include?(name)
@@ -188,6 +200,11 @@ module Checkoff
       project
     end
 
+    # @sg-ignore
+    # @param workspace_name [String]
+    # @param project_name [String, Symbol]
+    # @param section_name [String, nil]
+    # @return [Asana::Resources::Section, nil]
     def section(workspace_name, project_name, section_name)
       sections = sections_or_raise(workspace_name, project_name)
       sections.find { |section| section_key(section.name)&.chomp(':') == section_name&.chomp(':') }

data/lib/checkoff/tasks.rb

@@ -161,12 +161,11 @@ module Checkoff
 
       # @sg-ignore
       # @type [Array<Asana::Resources::Task>, nil]
-      already_fetched_dependencies = task.instance_variable_get(:@dependencies)
-      # @sg-ignore
-      return false unless already_fetched_dependencies.nil? || already_fetched_dependencies.size.positive?
+      dependencies = task.instance_variable_get(:@dependencies)
+      dependencies = task.dependencies.map { |task| { 'gid' => task.gid } } if dependencies.nil?
 
-      task.dependencies.any? do |parent_task_info|
-        parent_task_gid = parent_task_info.gid
+      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

data/lib/checkoff/version.rb

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

data/lib/checkoff/workspaces.rb

@@ -12,16 +12,18 @@ module Checkoff
   # Query different workspaces of Asana projects
   class Workspaces
     MINUTE = 60
-    # @sg-ignore
     HOUR = MINUTE * 60
     DAY = 24 * HOUR
-    # @sg-ignore
     REALLY_LONG_CACHE_TIME = HOUR * 1
-    # @sg-ignore
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE
 
+    # @!parse
+    #   extend CacheMethod::ClassMethods
+
+    # @param config [Hash<Symbol, Object>]
     # @param client [Asana::Client]
+    # @param asana_workspace [Class<Asana::Resources::Workspace>]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
                    client: Checkoff::Clients.new(config: config).client,
                    asana_workspace: Asana::Resources::Workspace)
@@ -32,6 +34,7 @@ module Checkoff
 
     # Pulls an Asana workspace object
     # @param [String] workspace_name
+    # @sg-ignore
     # @return [Asana::Resources::Workspace, nil]
     def workspace(workspace_name)
       client.workspaces.find_all.find do |workspace|
@@ -43,6 +46,7 @@ module Checkoff
     def default_workspace
       @asana_workspace.find_by_id(client, default_workspace_gid)
     end
+    cache_method :default_workspace, REALLY_LONG_CACHE_TIME
 
     # @param [String] workspace_name
     # @return [Asana::Resources::Workspace]
@@ -61,6 +65,7 @@ module Checkoff
 
     private
 
+    # @return [Asana::Client]
     attr_reader :client
   end
 end

data/rakelib/doc.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+desc 'Push documentation updates to Dropbox'
+task :doc do
+  sh 'yard -p yard_templates -o docs/ --no-private'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.44.0
+  version: 0.44.2
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-28 00:00:00.000000000 Z
+date: 2023-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -120,6 +120,7 @@ files:
 - bin/yard
 - checkoff.gemspec
 - config/definitions.rb
+- docs/.gitignore
 - docs/cookiecutter_input.json
 - docs/example_project.png
 - exe/checkoff
@@ -169,6 +170,7 @@ files:
 - rakelib/clear_metrics.rake
 - rakelib/console.rake
 - rakelib/default.rake
+- rakelib/doc.rake
 - rakelib/gem_tasks.rake
 - rakelib/localtest.rake
 - rakelib/overcommit.rake