checkoff 0.67.0 → 0.68.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 651d344e64e8f9b999d1c8d1f235c6657428e11164844e85ea3f53f31dca581b
-  data.tar.gz: bd94b2f08680af330190beb09c6659787e500d7d561a15a80a363a8c4675d158
+  metadata.gz: 6dd5c704b7e134bdda8158cf7851d59bc1c1288e969251bcf4f301d9f18bafed
+  data.tar.gz: 5f92ddd1ce0079e41d9a3aaf34159a5d17aa2ffafa1dbb86beff713a9ac110a1
 SHA512:
-  metadata.gz: '086458eef1a121b9cf27c79d78d18a65289cb7658d37126647a363d784ecaec3251ca05aba3b4f22512a07a35ee012d7fdf58b585950845be0742560e3d0dd50'
-  data.tar.gz: 05e1b5637f49ffd9c0dea9110705a43e79f875cedc699df023e1cc1d68480a7b9b68eb974faf201bc4e0c9efce1ba5333adbeca8bcf84ff0f7c076d57fb07753
+  metadata.gz: e7b890ec0a915814c77e4bce2137a50cdf740dbe8f22bdaac105e4b1b2f4a94dc2b09dc90768b4a7336d2ccf48b63bc61597e4f37d4a77cb3bc8270cb873c8ab
+  data.tar.gz: 564850bdc350602dd3fe4d7bb66a6457cd5b582d061aa83cf95b5a526da25741cdde8debb87ef8443b5bef94b6d8af6e186f6c369dc10232d35f41d40900fd5d

data/GLOSSARY.md

@@ -0,0 +1,11 @@
+# Glossary
+
+* ready/due: 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:
+
+  * start is null and due on is today
+  * start is null and due at is after now
+  * start on is today
+  * start at is after now

data/Gemfile.lock

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

data/lib/checkoff/create-entity.sh

@@ -61,6 +61,7 @@ module Checkoff
     # bundle exec ./${underscored_plural_name}.rb
     # :nocov:
     class << self
+      # @return [void]
       def run
         workspace_name = ARGV[0] || raise('Please pass workspace name as first argument')
         ${underscored_singular_name}_name = ARGV[1] || raise('Please pass ${underscored_singular_name} name as second argument')

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

@@ -335,7 +335,9 @@ module Checkoff
         # @param task [Asana::Resources::Task]
         # @return [Boolean]
         def evaluate(task)
-          custom_field = pull_custom_field_by_name_or_raise(task, 'Estimated time')
+          custom_field = pull_custom_field_by_name(task, 'Estimated time')
+
+          return false if custom_field.nil?
 
           # @sg-ignore
           # @type [Integer, nil]

data/lib/checkoff/tasks.rb

@@ -42,6 +42,16 @@ module Checkoff
       @workspaces = workspaces
     end
 
+    # 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:
+    #
+    # * start is null and due on is today
+    # * start is null and due at is after now
+    # * start on is today
+    # * start at is after now
+    #
     # @param task [Asana::Resources::Task]
     # @param ignore_dependencies [Boolean]
     def task_ready?(task, ignore_dependencies: false)

data/lib/checkoff/timing.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'date'
+require 'time'
+require 'active_support'
+# require 'active_support/time'
+require 'forwardable'
+require 'cache_method'
+require_relative 'internal/config_loader'
+require_relative 'workspaces'
+require_relative 'clients'
+
+module Checkoff
+  # Common vocabulary for managing time and time periods
+  class Timing
+    MINUTE = 60
+    HOUR = MINUTE * 60
+    DAY = 24 * HOUR
+    REALLY_LONG_CACHE_TIME = HOUR * 1
+    LONG_CACHE_TIME = MINUTE * 15
+    SHORT_CACHE_TIME = MINUTE
+
+    # @param today_getter [Class<Date>]
+    def initialize(today_getter: Date)
+      @today_getter = today_getter
+    end
+
+    # @param date [Date]
+    # @param period [Symbol<:indefinite>]
+    def in_period?(date, period)
+      return this_week?(date) if period == :this_week
+
+      return true if period == :indefinite
+
+      raise "Teach me how to handle period #{period.inspect}"
+    end
+
+    private
+
+    # @param date [Date]
+    def this_week?(date)
+      today = @today_getter.today
+
+      # Beginning of this week (assuming week starts on Sunday)
+      beginning_of_week = today - today.wday
+
+      # End of this week (assuming week ends on Saturday)
+      end_of_week = beginning_of_week + 6
+
+      date >= beginning_of_week && date <= end_of_week
+    end
+
+    # bundle exec ./time.rb
+    # :nocov:
+    class << self
+      # @return [void]
+      def run
+        time = Checkoff::Timing.new
+        # time = time.time_or_raise(workspace_name, time_name)
+        puts "Results: #{time}"
+      end
+    end
+    # :nocov:
+  end
+end
+
+# :nocov:
+abs_program_name = File.expand_path($PROGRAM_NAME)
+Checkoff::Timing.run if abs_program_name == File.expand_path(__FILE__)
+# :nocov:

data/lib/checkoff/version.rb

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

data/lib/checkoff.rb

@@ -6,6 +6,7 @@ require 'checkoff/workspaces'
 require 'checkoff/projects'
 require 'checkoff/sections'
 require 'checkoff/subtasks'
+require 'checkoff/timing'
 require 'checkoff/tasks'
 require 'checkoff/custom_fields'
 require 'checkoff/tags'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.67.0
+  version: 0.68.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-19 00:00:00.000000000 Z
+date: 2023-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -103,6 +103,7 @@ files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.rst
 - DEVELOPMENT.md
+- GLOSSARY.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -162,6 +163,7 @@ files:
 - lib/checkoff/task_searches.rb
 - lib/checkoff/task_selectors.rb
 - lib/checkoff/tasks.rb
+- lib/checkoff/timing.rb
 - lib/checkoff/version.rb
 - lib/checkoff/workspaces.rb
 - metrics/bigfiles_high_water_mark