checkoff 0.99.0 → 0.101.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0aa9c88e96e1094d284c59a9c7146ff72f393f2e16442c8e320b3253ab0221d
-  data.tar.gz: 7f6021289d7fb0e331cb6b993b10307287c365d9a00d5fbe789e5b6c13972dad
+  metadata.gz: 6242a956ad83d3a1818be59711f4ba42040d7051dac2dd0ba2c8a2e5ed29f244
+  data.tar.gz: 515a08a90d20a58956256f76248f01d7a5fd52c6ac14e1fbd8215a6eb33dcc6d
 SHA512:
-  metadata.gz: ab4476c149bf918e5d138f71a5d1c5df78192f3fa3fa13e8ef0e8a2d7c7198b34268a78ab14e6009237d3cf0113316f3ff91222d22893606c5ecc1ab31830d55
-  data.tar.gz: 4f804bcfc9548b7106fcd80c5764da4250bf024e9dc7f1c2b95460078b89de3a238ba2b28f6d44188cd3fee074a0d348925ef780b751534a0f801f08b74fab24
+  metadata.gz: 8575f32ba5e2130117784cdf0b6e3f9bd40a11c918ffd99208457cd8dde84f7333da5ffc09096f520bccb28f6451da0605f3a3073002de89e8b9d75800371dfa
+  data.tar.gz: 037b01300963f231ba1401eb55beb47aff94deb9baab62c3d952876de3d3afc6d5a2c427bb717f5bdc0b8faa8cf3029bdd844de8d955ae3d600ebf9b2ee20835

data/Gemfile.lock

@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    checkoff (0.99.0)
+    checkoff (0.101.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

@@ -114,7 +114,7 @@ module Checkoff
         end
       end
 
-      # :ready_between_n_days function
+      # :ready_between_relative function
       class ReadyBetweenRelativePFunctionEvaluator < FunctionEvaluator
         FUNCTION_NAME = :ready_between_relative
 
@@ -134,24 +134,34 @@ module Checkoff
         #
         # @return [Boolean]
         def evaluate(task, beginning_num_days_from_now, end_num_days_from_now, ignore_dependencies: false)
+          ready_between_relative?(task,
+                                  beginning_num_days_from_now, end_num_days_from_now,
+                                  ignore_dependencies: ignore_dependencies)
+        end
+
+        private
+
+        # @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]
-          task_date_or_time = @task_timing.date_or_time_field_by_name(task, :start) ||
-                              @task_timing.date_or_time_field_by_name(task, :due)
+          ready_date_or_time = @task_timing.date_or_time_field_by_name(task, :ready)
 
-          return false if task_date_or_time.nil?
+          return false if ready_date_or_time.nil?
 
-          # if time
-          in_range = if task_date_or_time.is_a?(Time)
-                       task_date_or_time > beginning_n_days_from_now_time &&
-                         task_date_or_time <= end_n_days_from_now_time
-                     else
-                       # if date
-                       task_date_or_time > beginning_n_days_from_now_time.to_date &&
-                         task_date_or_time <= end_n_days_from_now_time.to_date
-                     end
+          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
 
@@ -159,6 +169,17 @@ module Checkoff
 
           true
         end
+
+        # @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
 
       # :field_less_than_n_days_ago
@@ -373,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/internal/task_timing.rb

@@ -59,6 +59,8 @@ module Checkoff
 
         return start_date_or_time(task) if field_name == :start
 
+        return start_date_or_time(task) || due_date_or_time(task) if field_name == :ready
+
         raise "Teach me how to handle field #{field_name}"
       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
 
@@ -166,6 +171,21 @@ module Checkoff
       task_hashes.task_to_h(task)
     end
 
+    # @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.99.0'
+  VERSION = '0.101.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.99.0
+  version: 0.101.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