checkoff 0.128.0 → 0.130.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdeff27a19c7a24911c5864a8f376979b78e19b17d56992cb1e9ef1c33c815f5
-  data.tar.gz: 0e7ad84caa524a58699903a35b08b0865c6c32b5d494ab654b9df5c68506c97c
+  metadata.gz: 671e124a1d07f8449c10381cdaf97619ae58cd56dda7adcf2672396c8cae1c07
+  data.tar.gz: fd7c3e0b5f1dd48e7a6281a807c92a7f6d7614d8d71e27bdf45895e1f98246d7
 SHA512:
-  metadata.gz: 34d9d43590df498315a1ee700c812de55e014e2b9f67a41b725baa8da89e907f93c6af5486275743e9bfb52e4a80f95089026dd5feb82f13e470f58f477cf037
-  data.tar.gz: f6c41733167ddc1966d12fba1b6a00ab634eba365748531e4e9dde5096becb6e8dc43cc0fa07ffb330e5cfd18b00dbe2c81ee10d6c1c6f22837bb0273025908c
+  metadata.gz: ee30df69be122ddcc9cfe7cfe5a72bab8ab53df71ddc0abbd81cab05767f25cea01047f2da2c6652831c4b5558ca23e126f02a0343c6f9963166c8047b93a634
+  data.tar.gz: 85e37bfc18623f783b70ab4724d1b19e3bfdf27c67c130e9c3a23d8b85faf938bdac54f15210d9b073641ec2d7fdcdca0b0a41630e4b660edb3b973c7c2a75ea

data/GLOSSARY.md

@@ -2,10 +2,15 @@
 
 * ready: See tasks.rb#task_ready?.  Indicates a task is ready for
   a person to work on it.  This is subtly different than what is used
-  by Asana to mark a date as red/green!  A task is ready if it is not
-  dependent on an incomplete task and one of these is true:
+  by Asana to mark a date as red/green!
+
+  A task is ready if it is not dependent on an incomplete task and one
+  of these is true:
 
   * start is null and due on is today
   * start is null and due at is before now
   * start on is today
   * start at is before now
+
+  A project is ready if there is no start date, or if the start date
+  is today or in the past.

data/Gemfile.lock

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

data/config/definitions.rb

@@ -209,6 +209,13 @@
 #
 #         # @return [Asana::Resources::Portfolio,nil]
 #         def find_by_id(client, id, options: {}); end
+#         # Get portfolio items
+#         #
+#         # @param portfolio_gid [String]  (required) Globally unique identifier for the portfolio.
+#         # @param options [Hash] the request I/O options
+#         #
+#         # @return [Enumerable<Asana::Resources::Project>]
+#         def get_items_for_portfolio(portfolio_gid: required("portfolio_gid"), options: {}); end
 #       end
 #       class User
 #         # Returns the full user record for the currently authenticated user.

data/lib/checkoff/internal/project_timing.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Checkoff
+  module Internal
+    # Utility methods for working with project dates and times
+    class ProjectTiming
+      # @param time_class [Class<Time>]
+      # @param date_class [Class<Date>]
+      # @param client [Asana::Client]
+      # @param custom_fields [Checkoff::CustomFields]
+      def initialize(time_class: Time, date_class: Date,
+                     client: Checkoff::Clients.new.client,
+                     custom_fields: Checkoff::CustomFields.new(client: client))
+        @time_class = time_class
+        @date_class = date_class
+        @custom_fields = custom_fields
+      end
+
+      # @param project [Asana::Resources::Project]
+      # @param field_name [Symbol]
+      #
+      # @sg-ignore
+      # @return [Date, nil]
+      def start_date(project)
+        return @date_class.parse(project.start_on) unless project.start_on.nil?
+
+        nil
+      end
+
+      # @param project [Asana::Resources::Project]
+      # @param field_name [Symbol]
+      #
+      # @sg-ignore
+      # @return [Date, nil]
+      def due_date(project)
+        return @date_class.parse(project.due_on) unless project.due_on.nil?
+
+        nil
+      end
+
+      # @param project [Asana::Resources::Project]
+      # @param custom_field_name [String]
+      #
+      # @return [Time, Date, nil]
+      def custom_field(project, custom_field_name)
+        custom_field = @custom_fields.resource_custom_field_by_name_or_raise(project, custom_field_name)
+        # @sg-ignore
+        # @type [String, nil]
+        time_str = custom_field.fetch('display_value')
+        return nil if time_str.nil?
+
+        Time.parse(time_str)
+      end
+
+      # @param project [Asana::Resources::Project]
+      # @param field_name [Symbol,Array]
+      #
+      # @sg-ignore
+      # @return [Date, Time, nil]
+      def date_or_time_field_by_name(project, field_name)
+        return due_date(project) if field_name == :due
+
+        return start_date(project) if field_name == :start
+
+        return start_date(project) if field_name == :ready
+
+        if field_name.is_a?(Array)
+          # @sg-ignore
+          # @type [Symbol]
+          actual_field_name = field_name.first
+          args = field_name[1..]
+
+          return custom_field(project, *args) if actual_field_name == :custom_field
+        end
+
+        raise "Teach me how to handle field #{field_name}"
+      end
+    end
+  end
+end

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

@@ -20,6 +20,22 @@ module Checkoff
           resource.due_date
         end
       end
+
+      # :ready? function
+      class ReadyPFunctionEvaluator < FunctionEvaluator
+        FUNCTION_NAME = :ready?
+
+        def matches?
+          fn?(selector, FUNCTION_NAME)
+        end
+
+        # @param project [Asana::Resources::Project]
+        # @param period [Symbol<:now_or_before,:this_week>]
+        # @return [Boolean]
+        def evaluate(project, period = :now_or_before)
+          @projects.project_ready?(project, period: period)
+        end
+      end
     end
   end
 end

data/lib/checkoff/monkeypatches/resource_marshalling.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'asana'
+
+# Monkeypatches Asana::Resources::Resource so that Ruby marshalling and
+# unmarshalling works on Asana resource classes.  Currently, it will
+# work unless you call an accessor method, which triggers Asana's
+# client library Resource class' method_missing() to "cache" the
+# result by creating a singleton method.  Unfortunately, singleton
+# methods break marshalling, which is not smart enough to know that it
+# is not necessary to marshall them as they will simply be recreated
+# when needed.
+
+module Asana
+  # Monkeypatches:
+  #
+  # https://github.com/Asana/ruby-asana/blob/master/lib/asana
+  module Resources
+    # Public: The base resource class which provides some sugar over common
+    # resource functionality.
+    class Resource
+      # @return [Hash]
+      def marshal_dump
+        { 'data' => @_data }
+      end
+
+      # @param data [Hash]
+      #
+      # @return [void]
+      def marshal_load(data)
+        # @sg-ignore
+        # @type [Hash]
+        @_data = data.fetch('data')
+        @_data.each do |k, v|
+          if respond_to?(k)
+            variable = :"@#{k}"
+            instance_variable_set(variable, v)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/checkoff/portfolios.rb

@@ -99,7 +99,7 @@ module Checkoff
         fields: ['name'],
       }
       options[:fields] += extra_project_fields
-      portfolio.get_items(options: options)
+      client.portfolios.get_items_for_portfolio(portfolio_gid: portfolio.gid, options: options)
     end
 
     private

data/lib/checkoff/projects.rb

@@ -2,6 +2,7 @@
 
 require_relative 'internal/config_loader'
 require_relative 'internal/project_hashes'
+require_relative 'internal/project_timing'
 require_relative 'workspaces'
 require_relative 'clients'
 require 'cache_method'
@@ -32,15 +33,21 @@ module Checkoff
     # @param client [Asana::Client]
     # @param workspaces [Checkoff::Workspaces]
     # @param project_hashes [Checkoff::Internal::ProjectHashes]
+    # @param project_timing [Checkoff::Internal::ProjectTiming]
+    # @param timing [Checkoff::Timing]
     def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
                    client: Checkoff::Clients.new(config: config).client,
                    workspaces: Checkoff::Workspaces.new(config: config,
                                                         client: client),
-                   project_hashes: Checkoff::Internal::ProjectHashes.new)
+                   project_hashes: Checkoff::Internal::ProjectHashes.new,
+                   project_timing: Checkoff::Internal::ProjectTiming.new(client: client),
+                   timing: Checkoff::Timing.new)
       @config = config
       @workspaces = workspaces
       @client = client
       @project_hashes = project_hashes
+      @project_timing = project_timing
+      @timing = timing
     end
 
     # Default options used in Asana API to pull tasks
@@ -139,8 +146,37 @@ module Checkoff
       project_hashes.project_to_h(project_obj, project: project)
     end
 
+    # Indicates a project is ready for a person to work on it.  This
+    # is subtly different than what is used by Asana to mark a date as
+    # red/green!
+    #
+    # A project is ready if there is no start date, or if the start
+    # date is today or in the past.
+    #
+    # @param project [Asana::Resources::Project]
+    # @param period [Symbol<:now_or_before,:this_week>]
+    def project_ready?(project, period: :now_or_before)
+      in_period?(project, :ready, period)
+    end
+
+    # @param project [Asana::Resources::Project]
+    # @param field_name [Symbol,Array]
+    # @param period [Symbol<:now_or_before,:this_week>,Array] See Checkoff::Timing#in_period?
+    def in_period?(project, field_name, period)
+      # @type [Date,Time,nil]
+      project_date = project_timing.date_or_time_field_by_name(project, field_name)
+
+      timing.in_period?(project_date, period)
+    end
+
     private
 
+    # @return [Checkoff::Timing]
+    attr_reader :timing
+
+    # @return [Checkoff::Internal::ProjectTiming]
+    attr_reader :project_timing
+
     # @return [Checkoff::Internal::ProjectHashes]
     attr_reader :project_hashes
 

data/lib/checkoff/tasks.rb

@@ -54,7 +54,7 @@ module Checkoff
       @portfolios = portfolios
       @custom_fields = custom_fields
       @workspaces = workspaces
-      @timing = Timing.new(today_getter: date_class, now_getter: time_class)
+      @timing = Checkoff::Timing.new(today_getter: date_class, now_getter: time_class)
     end
 
     # Indicates a task is ready for a person to work on it.  This is

data/lib/checkoff/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.128.0
+  version: 0.130.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-04 00:00:00.000000000 Z
+date: 2023-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -135,6 +135,7 @@ files:
 - lib/checkoff/internal/create-class.sh
 - lib/checkoff/internal/project_hashes.rb
 - lib/checkoff/internal/project_selector_evaluator.rb
+- lib/checkoff/internal/project_timing.rb
 - lib/checkoff/internal/search_url.rb
 - lib/checkoff/internal/search_url/custom_field_param_converter.rb
 - lib/checkoff/internal/search_url/custom_field_variant.rb
@@ -156,6 +157,7 @@ files:
 - lib/checkoff/internal/task_hashes.rb
 - lib/checkoff/internal/task_selector_evaluator.rb
 - lib/checkoff/internal/task_timing.rb
+- lib/checkoff/monkeypatches/resource_marshalling.rb
 - lib/checkoff/my_tasks.rb
 - lib/checkoff/portfolios.rb
 - lib/checkoff/project_selectors.rb