checkoff 0.57.0 → 0.58.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '096eda83e243c4db30bcb92480b82f9be93dd9155b5fdb70058c4e364fe35c22'
-  data.tar.gz: e2886085e543f652cf99c8f0784d2726a470e41f26434171afa3da3e43d84118
+  metadata.gz: a2b8e1f32a572bfcd4797199e3e8bf40a8bacfe3f20eb117a13f52e5f69feab5
+  data.tar.gz: fe61f004dcc81088a23acee2f2fe03c8cec9fc107d1850cc6450d6bde99bdbdc
 SHA512:
-  metadata.gz: 6a119915c86c1124bc61aecb09bad54c3ec274feea2f4f627aadf24a090baae996a200361c4c5bfa52d9b8a65d822ca14b87b36fff4c486a9ee2f3763fc416a3
-  data.tar.gz: 3596da35a48094243a44794df858acb0718141b40555c56889b6adf4ad16c47287633e1e5cbcd293385424e13aafc21ef640c6475933551370c9e6142facaee3
+  metadata.gz: 2e77e9c93328415564d60bc1b3b1ca29bb678ce425477137392acd26d92acd81823a9fa9e6db189ce2a22045ca6dc45df32a8548a9265889e95f86196d238b1e
+  data.tar.gz: 516063b25c108b17ac6039c3890cf375a623078b913a33fecb019ae4c9a4f76e2a1f3995fae4cb3c529d5dddcb2d9076f5ec07e940a464ed13330c5b63ab3fbd

data/Gemfile.lock

@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    checkoff (0.57.0)
+    checkoff (0.58.1)
       activesupport
       asana (> 0.10.0)
       cache_method
@@ -45,7 +45,7 @@ GEM
     concurrent-ruby (1.2.2)
     crack (0.4.5)
       rexml
-    dalli (3.2.5)
+    dalli (3.2.6)
     diff-lcs (1.5.0)
     docile (1.4.0)
     e2mmap (0.1.0)

data/config/definitions.rb

@@ -139,7 +139,7 @@
 #         #
 #         # @param per_page [Integer] the number of records to fetch per page.
 #         # @param options [Hash] the request I/O options.
-#         # @return [Asana::Collection<Asana::Resources::Project>]
+#         # @return [Enumerable<Asana::Resources::Project>]
 #         def find_by_workspace(client, workspace: required("workspace"), is_template: nil, archived: nil, per_page: 20, options: {}); end
 #         # Returns the complete project record for a single project.
 #         #

data/lib/checkoff/project_selectors.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'cache_method'
+require_relative 'internal/config_loader'
+require_relative 'workspaces'
+require_relative 'clients'
+
+# https://developers.asana.com/docs/project-selectors
+
+module Checkoff
+  # Filter lists of projects using declarative selectors.
+  class ProjectSelectors
+    MINUTE = 60
+    HOUR = MINUTE * 60
+    DAY = 24 * HOUR
+    REALLY_LONG_CACHE_TIME = HOUR * 1
+    LONG_CACHE_TIME = MINUTE * 15
+    SHORT_CACHE_TIME = MINUTE
+
+    # @param config [Hash<Symbol, Object>]
+    # @param workspaces [Checkoff::Workspaces]
+    # @param clients [Checkoff::Clients]
+    # @param client [Asana::Client]
+    def initialize(config: Checkoff::Internal::ConfigLoader.load(:asana),
+                   workspaces: Checkoff::Workspaces.new(config: config),
+                   clients: Checkoff::Clients.new(config: config),
+                   client: clients.client)
+      @workspaces = workspaces
+      @client = client
+    end
+
+    # @param [Asana::Resources::Project] project
+    # @param [Array<(Symbol, Array)>] project_selector Filter based on
+    #        project details.  Examples: [:tag, 'foo'] [:not, [:tag, 'foo']] [:tag, 'foo']
+    # @return [Boolean]
+    def filter_via_project_selector(project, project_selector)
+      if project_selector == [:custom_field_values_contain_any_value, 'Project attributes', ['timeline']]
+        custom_field = project.custom_fields.find { |field| field.fetch('name') == 'Project attributes' }
+
+        return false if custom_field.nil?
+
+        # @sg-ignore
+        # @type [Hash, nil]
+        timeline = custom_field.fetch('multi_enum_values').find do |multi_enum_value|
+          multi_enum_value.fetch('name') == 'timeline'
+        end
+
+        return !timeline.nil?
+      end
+
+      raise "Teach me how to evaluate #{project} against #{project_selector}"
+    end
+
+    private
+
+    # @return [Checkoff::Workspaces]
+    attr_reader :workspaces
+
+    # @return [Asana::Client]
+    attr_reader :client
+
+    # bundle exec ./project_selectors.rb
+    # :nocov:
+    class << self
+      # @return [void]
+      def run
+        # workspace_name = ARGV[0] || raise('Please pass workspace name as first argument')
+        # project_selector_name = ARGV[1] || raise('Please pass project_selector name as second argument')
+        # project_selectors = Checkoff::ProjectSelectors.new
+        # project_selector = project_selectors.project_selector_or_raise(workspace_name, project_selector_name)
+        # puts "Results: #{project_selector}"
+      end
+    end
+    # :nocov:
+  end
+end
+
+# :nocov:
+abs_program_name = File.expand_path($PROGRAM_NAME)
+Checkoff::ProjectSelectors.run if abs_program_name == File.expand_path(__FILE__)
+# :nocov:

data/lib/checkoff/projects.rb

@@ -54,13 +54,14 @@ module Checkoff
     # pulls an Asana API project class given a name
     # @param [String] workspace_name
     # @param [String] project_name
+    # @param [Array<String>] extra_fields
     # @return [Asana::Resources::Project, nil]
-    def project(workspace_name, project_name)
+    def project(workspace_name, project_name, extra_fields: [])
       if project_name.is_a?(Symbol) && project_name.to_s.start_with?('my_tasks')
         my_tasks(workspace_name)
       else
-        # @type [Asana::Collection<Asana::Resources::Project>]
-        ps = projects_by_workspace_name(workspace_name)
+        # @type [Enumerable<Asana::Resources::Project>]
+        ps = projects_by_workspace_name(workspace_name, extra_fields: extra_fields)
         ps.find do |project|
           project.name == project_name
         end
@@ -73,7 +74,7 @@ module Checkoff
     # @return [Asana::Resources::Project]
     def project_or_raise(workspace_name, project_name)
       p = project(workspace_name, project_name)
-      raise "Could not find project #{project_name} under workspace #{workspace_name}." if p.nil?
+      raise "Could not find project #{project_name.inspect} under workspace #{workspace_name}." if p.nil?
 
       p
     end
@@ -102,6 +103,17 @@ module Checkoff
     end
     cache_method :tasks_from_project, SHORT_CACHE_TIME
 
+    # @param [String] workspace_name
+    # @param [Array<String>] extra_fields
+    # @return [Enumerable<Asana::Resources::Project>]
+    def projects_by_workspace_name(workspace_name, extra_fields: [])
+      workspace = @workspaces.workspace_or_raise(workspace_name)
+      options = { fields: %w[name] + extra_fields }
+      projects.find_by_workspace(workspace: workspace.gid, per_page: 100, options: options)
+    end
+    # 15 minute cache resulted in 'Your pagination token has expired'
+    cache_method :projects_by_workspace_name, MEDIUM_CACHE_TIME
+
     private
 
     # @return [Asana::Client]
@@ -113,17 +125,6 @@ module Checkoff
     end
     cache_method :projects, LONG_CACHE_TIME
 
-    # @param [String] workspace_name
-    # @return [Asana::Collection<Asana::Resources::Project>]
-    def projects_by_workspace_name(workspace_name)
-      workspace = @workspaces.workspace_or_raise(workspace_name)
-      raise "Could not find workspace named #{workspace_name}" unless workspace
-
-      projects.find_by_workspace(workspace: workspace.gid, per_page: 100)
-    end
-    # 15 minute cache resulted in 'Your pagination token has expired'
-    cache_method :projects_by_workspace_name, MEDIUM_CACHE_TIME
-
     # @param [String] workspace_name
     # @return [Asana::Resources::Project]
     def my_tasks(workspace_name)

data/lib/checkoff/sections.rb

@@ -204,7 +204,7 @@ module Checkoff
 
       project = projects.project(workspace_name, project_name)
       if project.nil?
-        raise "Could not find project #{project_name} " \
+        raise "Could not find project #{project_name.inspect} " \
               "under workspace #{workspace_name}"
       end
       project

data/lib/checkoff/version.rb

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

data/lib/checkoff.rb

@@ -10,4 +10,5 @@ require 'checkoff/tasks'
 require 'checkoff/custom_fields'
 require 'checkoff/tags'
 require 'checkoff/task_selectors'
+require 'checkoff/project_selectors'
 require 'checkoff/task_searches'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.57.0
+  version: 0.58.1
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2023-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -141,6 +141,7 @@ files:
 - lib/checkoff/internal/search_url/simple_param_converter.rb
 - lib/checkoff/internal/task_selector_evaluator.rb
 - lib/checkoff/my_tasks.rb
+- lib/checkoff/project_selectors.rb
 - lib/checkoff/projects.rb
 - lib/checkoff/sections.rb
 - lib/checkoff/subtasks.rb