checkoff 0.100.0 → 0.102.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1944705f29ddc4dab95bb2c056b55c3aa6417cab26ca036a5493612663a4614
-  data.tar.gz: 299262b20e9331ee86755c8fced359e62889e34f1fb714c694535167356c2793
+  metadata.gz: 4d8549d02934007d479b28d83262a32e060e6ada2033f5d5c9743210bf599e68
+  data.tar.gz: 86f5d4ba266d1d60af237d428c50b0065e80ce233d8ed964e7af9cc2396e6ae3
 SHA512:
-  metadata.gz: f84b26f7790beb97d9f2467b00bead09cd59f60c57e448442892304bbbf7acd6c72c299ee2c890762d9682df76efcf203d5ff3b4442d88d8871b117006a18a83
-  data.tar.gz: b1478b9ac625f873fa32ab444facf710ac7246b118927fd3347ed0867ca182cb757ec8b12cbb83a29e4d00882647b6df45a93c2758fb2e4c1ebad5983b13b724
+  metadata.gz: 6e7d47b7d64ee0008783db1a0a460bc0a1865f361920ff136c85e95df6f1d4cf36f88fda44ce50cb0f7f81e5117800feef82874320d6453e4b525f734721fc2d
+  data.tar.gz: 9c376fe5b386897f379f0b575423078fa0d4495ae953f05a5aeab6d794e3be6eac36a235f4d44d7e80313824de8110e246e7069abf3399f88c0a931eb709b60f

data/Gemfile.lock

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

data/config/definitions.rb

@@ -63,6 +63,10 @@
 #         # @return [String,nil]
 #         def due_date; end
 #       end
+#       class Portfolio
+#         # @return [Enumerable<Asana::Resources::Project>]
+#         def get_items(options = {}); end
+#       end
 #     end
 #     module Resources
 #       class Workspace

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

@@ -394,6 +394,23 @@ module Checkoff
                                                                         limit_to_portfolio_gid: limit_to_portfolio_gid)
         end
       end
+
+      # :in_portfolio_named? function
+      class InPortfolioNamedFunctionEvaluator < FunctionEvaluator
+        FUNCTION_NAME = :in_portfolio_named?
+
+        def matches?
+          fn?(selector, FUNCTION_NAME)
+        end
+
+        # @param task [Asana::Resources::Task]
+        # @param portfolio_name [String]
+        #
+        # @return [Boolean]
+        def evaluate(task, portfolio_name)
+          @tasks.in_portfolio_named?(task, portfolio_name)
+        end
+      end
     end
   end
 end

data/lib/checkoff/portfolios.rb

@@ -78,6 +78,16 @@ module Checkoff
     end
     cache_method :portfolio_by_gid, SHORT_CACHE_TIME
 
+    # @param workspace_name [String]
+    # @param portfolio_name [String]
+    #
+    # @return [Enumerable<Asana::Resources::Project>]
+    def projects_in_portfolio(workspace_name, portfolio_name)
+      portfolio = portfolio_or_raise(workspace_name, portfolio_name)
+      portfolio.get_items
+    end
+    cache_method :projects_in_portfolio, LONG_CACHE_TIME
+
     private
 
     # @return [Checkoff::Workspaces]

data/lib/checkoff/tasks.rb

@@ -3,6 +3,7 @@
 # frozen_string_literal: true
 
 require_relative 'sections'
+require_relative 'portfolios'
 require_relative 'workspaces'
 require_relative 'internal/config_loader'
 require_relative 'internal/task_timing'
@@ -26,6 +27,7 @@ module Checkoff
     # @param client [Asana::Client]
     # @param workspaces [Checkoff::Workspaces]
     # @param sections [Checkoff::Sections]
+    # @param portfolios [Checkoff::Portfolios]
     # @param time_class [Class<Time>]
     # @param date_class [Class<Date>]
     # @param asana_task [Class<Asana::Resources::Task>]
@@ -35,6 +37,8 @@ module Checkoff
                                                         client: client),
                    sections: Checkoff::Sections.new(config: config,
                                                     client: client),
+                   portfolios: Checkoff::Portfolios.new(config: config,
+                                                        client: client),
                    time_class: Time,
                    date_class: Date,
                    asana_task: Asana::Resources::Task)
@@ -44,6 +48,7 @@ module Checkoff
       @date_class = date_class
       @asana_task = asana_task
       @client = client
+      @portfolios = portfolios
       @workspaces = workspaces
     end
 
@@ -71,6 +76,7 @@ module Checkoff
     end
 
     # Pull a specific task by name
+    #
     # @param workspace_name [String]
     # @param project_name [String, Symbol]
     # @param section_name [String, nil, Symbol]
@@ -93,7 +99,8 @@ module Checkoff
     end
     cache_method :task, SHORT_CACHE_TIME
 
-    # Pull a specific task by name
+    # Pull a specific task by GID
+    #
     # @param task_gid [String]
     # @param extra_fields [Array<String>]
     # @return [Asana::Resources::Task, nil]
@@ -105,9 +112,12 @@ module Checkoff
     end
     cache_method :task_by_gid, SHORT_CACHE_TIME
 
+    # Add a task
+    #
     # @param name [String]
     # @param workspace_gid [String]
     # @param assignee_gid [String]
+    #
     # @return [Asana::Resources::Task]
     def add_task(name,
                  workspace_gid: @workspaces.default_workspace_gid,
@@ -117,12 +127,17 @@ module Checkoff
                          workspace: workspace_gid, name: name)
     end
 
+    # Return user-accessible URL for a task
+    #
     # @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
 
+    # True if any of the task's dependencies are marked incomplete
+    #
     # @param task [Asana::Resources::Task]
     def incomplete_dependencies?(task)
       # Avoid a redundant fetch.  Unfortunately, Ruby SDK allows
@@ -161,11 +176,29 @@ module Checkoff
     # task: String (name)
     #
     # @param task [Asana::Resources::Task]
+    #
     # @return [Hash]
     def task_to_h(task)
       task_hashes.task_to_h(task)
     end
 
+    # True if the task is in a project which is in the given portfolio
+    #
+    # @param task [Asana::Resources::Task]
+    # @param portfolio_name [String]
+    # @param workspace_name [String]
+    def in_portfolio_named?(task,
+                            portfolio_name,
+                            workspace_name: @workspaces.default_workspace.name)
+      portfolio_projects = @portfolios.projects_in_portfolio(workspace_name, portfolio_name)
+      task.memberships.any? do |membership|
+        project_gid = membership.fetch('project').fetch('gid')
+        portfolio_projects.any? do |portfolio_project|
+          portfolio_project.gid == project_gid
+        end
+      end
+    end
+
     private
 
     # @return [Checkoff::Internal::TaskTiming]

data/lib/checkoff/version.rb

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

metadata

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