checkoff 0.42.0 → 0.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83cd30ff493ada586596020db325eed63c9e4c24919e34c7e9926c0f9bedf51f
-  data.tar.gz: fee54feaa76dafc06dba69267f4ea6a7b2877e68df6af43738468e65cca552b6
+  metadata.gz: 413eeaac4e3e2a4784e5fca4930fed96beedd594b87f1c8d80460aabe4ee1dd3
+  data.tar.gz: 4127604e8d5c3605d49c2fda86fe0c0e1bed95aaeadfc493d8a2b02c19bed94d
 SHA512:
-  metadata.gz: 7d4cb677d35d91830b2aa6145d40a74ebb1e34ddd9a1e17203ef62ac66afb30a3a864924462de263ff663d33cc561272143fd1b0ab45e9499c4f42e2dad97840
-  data.tar.gz: b074ac5d6a2675e801b52e96d8453847607bf0e523a5988a50456258f1a668319846c8c1f965eadb09409f83b82d23b1262935c2606bab175de0664c7af2077a
+  metadata.gz: 001c49dab8df9d273f2c395dd422509afa82c856712b7dfef9b7c65bf7f23c7d3ada832d32e888b188d38751716ee7e54c8d144b4575cd2de384946002ae6fc5
+  data.tar.gz: a10f6ee8a33870277503458dc19809e642d837899c31c1698ba04942356386fe09c713643db3f3694eca7d5495c43fe13c93d2ae7785e3ad383aeed88651e2f0

data/Gemfile.lock

@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    checkoff (0.42.0)
+    checkoff (0.44.0)
       activesupport
       asana (> 0.10.0)
       cache_method
@@ -22,7 +22,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.5)
+    activesupport (7.0.5.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)

data/lib/checkoff/internal/config_loader.rb

@@ -8,19 +8,27 @@ module Checkoff
     # Use the provided config from a YAML file, and fall back to env
     # variable if it's not populated for a key'
     class EnvFallbackConfigLoader
+      # @param config [Hash<Symbol, Object>]
+      # @param sym [Symbol]
+      # @param yaml_filename [String]
       def initialize(config, sym, yaml_filename)
         @config = config
         @envvar_prefix = sym.upcase
         @yaml_filename = yaml_filename
       end
 
+      # @param key [Symbol]
+      # @return [Object]
       def [](key)
         config_value = @config[key]
         return config_value unless config_value.nil?
 
+        # @sg-ignore
         ENV.fetch(envvar_name(key), nil)
       end
 
+      # @param key [Symbol]
+      # @return [Object]
       def fetch(key)
         out = self[key]
         return out unless out.nil?
@@ -31,6 +39,8 @@ module Checkoff
 
       private
 
+      # @param key [Symbol]
+      # @return [String]
       def envvar_name(key)
         "#{@envvar_prefix}__#{key.upcase}"
       end
@@ -39,7 +49,8 @@ module Checkoff
     # Load configuration file
     class ConfigLoader
       class << self
-        # @return EnvFallbackConfigLoader
+        # @sg-ignore
+        # @return [Hash<Symbol, Object>]
         def load(sym)
           yaml_result = load_yaml_file(sym)
           EnvFallbackConfigLoader.new(yaml_result, sym, yaml_filename(sym))
@@ -47,13 +58,18 @@ module Checkoff
 
         private
 
+        # @param sym [Symbol]
+        # @return [Hash<[String, Symbol], Object>]
         def load_yaml_file(sym)
           filename = yaml_filename(sym)
           return {} unless File.exist?(filename)
 
+          # @sg-ignore
           YAML.load_file(filename).with_indifferent_access
         end
 
+        # @param sym [Symbol]
+        # @return [String]
         def yaml_filename(sym)
           file = "#{sym}.yml"
           File.expand_path("~/.#{file}")

data/lib/checkoff/internal/task_selector_evaluator.rb

@@ -101,7 +101,7 @@ module Checkoff
     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_field' in your extra_fields argument?"
+        raise "custom fields not found on task - did you add 'custom_fields' in your extra_fields argument?"
       end
 
       # @sg-ignore
@@ -339,6 +339,30 @@ module Checkoff
     end
   end
 
+  # :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 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
+    end
+  end
+
   # String literals
   class StringLiteralEvaluator < FunctionEvaluator
     def matches?
@@ -376,6 +400,7 @@ module Checkoff
       DuePFunctionEvaluator,
       DueDateSetPFunctionEvaluator,
       CustomFieldLessThanNDaysFromNowFunctionEvaluator,
+      CustomFieldGreaterThanOrEqualToNDaysFromNowFunctionEvaluator,
       StringLiteralEvaluator,
     ].freeze
 

data/lib/checkoff/task_searches.rb

@@ -27,6 +27,17 @@ module Checkoff
 
     include Asana::Resources::ResponseHelper
 
+    # @!parse
+    #   extend CacheMethod::ClassMethods
+
+    # @param config [Hash<Symbol, Object>]
+    # @param workspaces [Checkoff::Workspaces]
+    # @param task_selectors [Checkoff::TaskSelectors]
+    # @param projects [Checkoff::Projects]
+    # @param clients [Checkoff::Clients]
+    # @param client [Asana::Client]
+    # @param search_url_parser [Checkoff::Internal::SearchUrl::Parser]
+    # @param asana_resources_collection_class [Class<Asana::Resources::Collection>]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
                    workspaces: Checkoff::Workspaces.new(config: config),
                    task_selectors: Checkoff::TaskSelectors.new(config: config),
@@ -49,6 +60,7 @@ module Checkoff
     # @return [Array<Asana::Resources::Task>]
     def task_search(workspace_name, url, extra_fields: [])
       workspace = workspaces.workspace_or_raise(workspace_name)
+      # @sg-ignore
       api_params, task_selector = @search_url_parser.convert_params(url)
       path = "/workspaces/#{workspace.gid}/tasks/search"
       options = calculate_api_options(extra_fields)
@@ -76,8 +88,13 @@ module Checkoff
     # bundle exec ./task_searches.rb
     # :nocov:
     class << self
+      # @return [void]
       def run
+        # @sg-ignore
+        # @type [String]
         workspace_name = ARGV[0] || raise('Please pass workspace name as first argument')
+        # @sg-ignore
+        # @type [String]
         url = ARGV[1] || raise('Please pass task search URL as second argument')
         task_searches = Checkoff::TaskSearches.new
         task_search = task_searches.task_search(workspace_name, url)
@@ -86,7 +103,14 @@ module Checkoff
     end
     # :nocov:
 
-    attr_reader :task_selectors, :projects, :workspaces, :client
+    # @return [Checkoff::TaskSelectors]
+    attr_reader :task_selectors
+    # @return [Checkoff::Projects]
+    attr_reader :projects
+    # @return [Checkoff::Workspaces]
+    attr_reader :workspaces
+    # @return [Asana::Client]
+    attr_reader :client
   end
 end
 

data/lib/checkoff/tasks.rb

@@ -4,25 +4,25 @@
 
 require_relative 'sections'
 require_relative 'workspaces'
+require_relative 'internal/config_loader'
 require 'asana'
 
 module Checkoff
   # Pull tasks from Asana
   class Tasks
     MINUTE = 60
-    # @sg-ignore
     HOUR = MINUTE * 60
     DAY = 24 * HOUR
     REALLY_LONG_CACHE_TIME = HOUR
-    # @sg-ignore
     LONG_CACHE_TIME = MINUTE * 15
-    # @sg-ignore
     SHORT_CACHE_TIME = MINUTE * 5
 
+    # @param config [Hash<Symbol, Object>]
     # @param client [Asana::Client]
     # @param workspaces [Checkoff::Workspaces]
-    # @param time_class [Class<Time>]
     # @param sections [Checkoff::Sections]
+    # @param time_class [Class<Time>]
+    # @param asana_task [Class<Asana::Resources::Task>]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
                    client: Checkoff::Clients.new(config: config).client,
                    workspaces: Checkoff::Workspaces.new(config: config,
@@ -39,8 +39,10 @@ module Checkoff
       @workspaces = workspaces
     end
 
-    def task_ready?(task)
-      return false if incomplete_dependencies?(task)
+    # @param task [Asana::Resources::Task]
+    # @param ignore_dependencies [Boolean]
+    def task_ready?(task, ignore_dependencies: false)
+      return false if !ignore_dependencies && incomplete_dependencies?(task)
 
       due = due_time(task)
 
@@ -50,11 +52,19 @@ module Checkoff
     end
 
     # Pull a specific task by name
+    # @param workspace_name [String]
+    # @param project_name [String, Symbol]
+    # @param section_name [String, nil, Symbol]
+    # @param task_name [String]
+    # @param only_uncompleted [Boolean]
+    # @param extra_fields [Array<String>]
+    # @sg-ignore
     # @return [Asana::Resources::Task, nil]
     def task(workspace_name, project_name, task_name,
              section_name: :unspecified,
              only_uncompleted: true,
              extra_fields: [])
+      # @sg-ignore
       tasks = tasks_from_section(workspace_name,
                                  project_name,
                                  section_name: section_name,
@@ -74,6 +84,7 @@ module Checkoff
       client.tasks.find_by_id(task_gid, options: options)
     end
 
+    # @param name [String]
     # @param workspace_gid [String]
     # @param assignee_gid [String]
     # @return [Asana::Resources::Task]
@@ -85,13 +96,19 @@ module Checkoff
                          workspace: workspace_gid, name: name)
     end
 
-    # Return an end-user URL to the task in question
+    # @param task [Asana::Resources::Task]
+    # @return [String] end-user URL to the task in question
     def url_of_task(task)
       "https://app.asana.com/0/0/#{task.gid}/f"
     end
 
     private
 
+    # @param workspace_name [String]
+    # @param project_name [String, Symbol]
+    # @param section_name [String, nil, :unspecified]
+    # @param only_uncompleted [Boolean]
+    # @param extra_fields [Array<String>]
     # @return [Array<Asana::Resources::Task>]
     def tasks_from_section(workspace_name, project_name,
                            section_name:,
@@ -109,6 +126,7 @@ module Checkoff
       end
     end
 
+    # @return [Asana::Client]
     attr_reader :client
 
     # @return [Checkoff::Projects]
@@ -131,6 +149,7 @@ 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

data/lib/checkoff/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.42.0
+  version: 0.44.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-23 00:00:00.000000000 Z
+date: 2023-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport