checkoff 0.39.0 → 0.39.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4aa495392c511216d69ccb2d8ba6fa8efa6fb6a2466fad23dca9f8ee89ff9fa
-  data.tar.gz: 0a48cd6720b49c8b7988ad8469f5b6ca3b89a5a2abeff47855386560a495c007
+  metadata.gz: e76d0cf72eb0426c6c69b27837d486f9cbe6de2f0782b10acc157f1b305941b1
+  data.tar.gz: effbabaaccae53bf8e3e843f509bba7477a24a34be44542906bf33e39a6a1f91
 SHA512:
-  metadata.gz: 7c9535b045a9a35fd7a5df91d01f843d001c1f51761a638d50474c6437aa75781871d9afecb85664eb90a35e06a9b5be4511f8a943ca9928ab042c30fc7881e1
-  data.tar.gz: 03ced5118890e61a65defd98e65cc3cde499861959da931287e6430cb3dc024215157584d45307269dd2fd0428f39bff54958d503520c7b5f823ad2de25c5d38
+  metadata.gz: a0d0e684e7811ab1ba2637117969e114b1c2c01e8e495f5dd2aa42255ff9d8ee1b67cf6368dcb2908ce1e70000b51c537492a5e812632b2c134ff0b632602510
+  data.tar.gz: b24402a8cbf03684397dddea78ba3d778cd96fbb9408a828853e737c65b787b7bb1170f14ff5f28d1efb7b599766e944df8f1e2ce27eff93f03e5b02736ccd86

data/Gemfile.lock

@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    checkoff (0.39.0)
+    checkoff (0.39.2)
       activesupport
       asana (> 0.10.0)
       cache_method
@@ -74,7 +74,7 @@ GEM
       multi_json
     gli (2.21.0)
     hashdiff (1.0.1)
-    i18n (1.13.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     imagen (0.1.8)
       parser (>= 2.5, != 2.5.1.1)

data/config/definitions.rb

@@ -14,6 +14,8 @@
 #       def tasks; end
 #       # @return [Asana::ProxiedResourceClasses::Workspace]
 #       def workspaces; end
+#       # @return [Asana::ProxiedResourceClasses::Section]
+#       def sections; end
 #     end
 #     module Resources
 #       class Task
@@ -43,10 +45,26 @@
 #         # @param options [Hash] the request I/O options.
 #         # @return [Asana::Resources::Task]
 #         def find_by_id(id, options: {}); end
+#         # @param section [Asana::Resources::section]
+#         # @param options [Hash] the request I/O options.
+#         # @return [Array<Asana::Resources::Task>]
+#         def get_tasks(assignee: nil,
+#                       project: nil,
+#                       section: nil,
+#                       workspace: nil,
+#                       completed_since: nil,
+#                       per_page: 20,
+#                       modified_since: nil,
+#                       options: {}); end
 #       end
 #       class Workspace
 #         # @return [Array<Asana::Resources::Workspace>]
 #         def find_all; end
 #       end
+#       class Section
+#         # @param project_gid [String]
+#         # @return [Array<Asana::Resources::Section>]
+#         def get_sections_for_project(client, project_gid:, options: {}); end
+#       end
 #     end
 #   end

data/lib/checkoff/sections.rb

@@ -9,14 +9,23 @@ require_relative 'my_tasks'
 module Checkoff
   # Query different sections of Asana projects
   class Sections
+    # @!parse
+    #   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
 
+    # @param client [Asana::Client]
+    # @param projects [Checkoff::Projects]
+    # @param workspaces [Checkoff::Workspaces]
+    # @param time [Class<Time>]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
                    client: Checkoff::Clients.new(config: config).client,
                    projects: Checkoff::Projects.new(config: config,
@@ -32,13 +41,22 @@ module Checkoff
     end
 
     # Returns a list of Asana API section objects for a given project
+    # @param workspace_name [String]
+    # @param project_name [String, Symbol]
+    #
+    # @return [Array<Asana::Resources::Section>]
     def sections_or_raise(workspace_name, project_name)
       project = project_or_raise(workspace_name, project_name)
+      # @sg-ignore
       client.sections.get_sections_for_project(project_gid: project.gid)
     end
 
     # Given a workspace name and project name, then provide a Hash of
     # tasks with section name -> task list of the uncompleted tasks
+    # @param workspace_name [String]
+    # @param project_name [String, Symbol]
+    # @param extra_fields [Array<String>]
+    # @return [Hash{[String, nil] => Array<Asana::Resources::Task>}]
     def tasks_by_section(workspace_name, project_name, extra_fields: [])
       project = project_or_raise(workspace_name, project_name)
       if project_name == :my_tasks
@@ -51,6 +69,14 @@ module Checkoff
     # XXX: Rename to section_tasks
     #
     # Pulls task objects from a specified section
+    #
+    # @param workspace_name [String]
+    # @param project_name [String, Symbol]
+    # @param section_name [String, nil]
+    # @param only_uncompleted [Boolean]
+    # @param extra_fields [Array<String>]
+    #
+    # @return [Array<Asana::Resources::Task>]
     def tasks(workspace_name, project_name, section_name,
               only_uncompleted: true,
               extra_fields: [])
@@ -64,30 +90,44 @@ module Checkoff
     cache_method :tasks, SHORT_CACHE_TIME
 
     # Pulls just names of tasks from a given section.
+    # @param workspace_name [String]
+    # @param project_name [String, Symbol]
+    # @param section_name [String, nil]
+    #
+    # @return [Array<String>]
     def section_task_names(workspace_name, project_name, section_name)
-      tasks = tasks(workspace_name, project_name, section_name)
-      tasks.map(&:name)
+      task_array = tasks(workspace_name, project_name, section_name)
+      task_array.map(&:name)
     end
     cache_method :section_task_names, SHORT_CACHE_TIME
 
+    # @param workspace_name [String]
+    # @param project_name [String, Symbol]
+    # @param section_name [String, nil]
+    #
+    # @return [Asana::Resources::Section]
     def section_or_raise(workspace_name, project_name, section_name)
-      section = section(workspace_name, project_name, section_name)
-      if section.nil?
+      s = section(workspace_name, project_name, section_name)
+      if s.nil?
         valid_sections = sections_or_raise(workspace_name, project_name).map(&:name)
 
         raise "Could not find section #{section_name} under project #{project_name} " \
               "under workspace #{workspace_name}.  Valid sections: #{valid_sections}"
       end
-      section
+      s
     end
     cache_method :section_or_raise, LONG_CACHE_TIME
 
     private
 
+    # @!attribute [r] 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]
+    # @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)
       active_tasks = projects.active_tasks(raw_tasks)
@@ -102,8 +142,12 @@ module Checkoff
     end
 
     # Given a list of tasks, pull a Hash of tasks with section name -> task list
+    # @param tasks [Array<Asana::Resources::Task>]
+    # @param project_gid [String]
+    # @return [Hash<[String,nil], Array<Asana::Resources::Task>>]
     def by_section(tasks, project_gid)
       by_section = {}
+      # @sg-ignore
       sections = client.sections.get_sections_for_project(project_gid: project_gid)
       sections.each { |section| by_section[section_key(section.name)] = [] }
       tasks.each { |task| file_task_by_section(by_section, task, project_gid) }
@@ -111,15 +155,25 @@ module Checkoff
     end
     cache_method :by_section, LONG_CACHE_TIME
 
+    # @param by_section [Hash{[String, nil] => Array<Asana::Resources::Task>}]
+    # @param task [Asana::Resources::Task]
+    # @param project_gid [String]
+    # @return [void]
     def file_task_by_section(by_section, task, project_gid)
+      # @type [Array<Hash>]
       membership = task.memberships.find { |m| m['project']['gid'] == project_gid }
       raise "Could not find task in project_gid #{project_gid}: #{task}" if membership.nil?
 
+      # @type [String, nil]
       current_section = section_key(membership['section']['name'])
 
+      # @sg-ignore
       by_section.fetch(current_section) << task
     end
 
+    # @param workspace_name [String]
+    # @param project_name [String, Symbol]
+    # @return [Asana::Resources::Project]
     def project_or_raise(workspace_name, project_name)
       project = projects.project(workspace_name, project_name)
       if project.nil?

data/lib/checkoff/subtasks.rb

@@ -27,6 +27,8 @@ module Checkoff
     end
 
     # pulls a Hash of subtasks broken out by section
+    # @param tasks [Array<Asana::Resources::Task>]
+    # @return [Hash<[nil,String], Array<Asana::Resources::Task>>]
     def by_section(tasks)
       current_section = nil
       by_section = { nil => [] }

data/lib/checkoff/task_selectors.rb

@@ -14,7 +14,6 @@ require_relative 'tasks'
 module Checkoff
   # Filter lists of tasks using declarative selectors.
   class TaskSelectors
-    # @type [Integer]
     MINUTE = 60
     HOUR = MINUTE * 60
     DAY = 24 * HOUR
@@ -30,8 +29,10 @@ module Checkoff
       @tasks = tasks
     end
 
+    # @param [Asana::Resources::Task] task
     # @param [Hash<Symbol, Object>] task_selector Filter based on
     #        description.  Examples: {tag: 'foo'} {:not {tag: 'foo'} (:tag 'foo')
+    # @return [Boolean]
     def filter_via_task_selector(task, task_selector)
       evaluator = TaskSelectorEvaluator.new(task: task, tasks: tasks)
       evaluator.evaluate(task_selector)

data/lib/checkoff/tasks.rb

@@ -64,13 +64,13 @@ module Checkoff
     end
 
     # Pull a specific task by name
+    # @param task_gid [String]
+    # @param extra_fields [Array<String>]
     # @return [Asana::Resources::Task, nil]
     def task_by_gid(task_gid,
-                    only_uncompleted: true,
                     extra_fields: [])
-      options = projects.task_options
-      options[:options][:fields] += extra_fields
-      options[:completed_since] = '9999-12-01' if only_uncompleted
+      options = projects.task_options.fetch(:options, {})
+      options[:fields] += extra_fields
       client.tasks.find_by_id(task_gid, options: options)
     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.39.0'
+  VERSION = '0.39.2'
 end

metadata

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