checkoff 0.104.0 → 0.106.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6d308b4ca05ee88bf3b380772496d9c621cc7b9f521b4cf19eb1351395ed2b2
-  data.tar.gz: eb14bb0c6f4dabd72e083ce67a5c3c821be931ac268f3202445714da9ae713aa
+  metadata.gz: d1113a5ffbcd7bbe80ffd702559e8be32741468c788b26b976d8bb33ce50c06b
+  data.tar.gz: 91fb42cdc5620a932033d43eab190c46191c11794004b358a92bc6e40f97818d
 SHA512:
-  metadata.gz: 28983082df6a4c00e31fb3f458a6bafc0241920d4f1b5657e6ce3613d86127b0df6561defde8669a9ead845e2ef7d77c10ec1d45603c55d17fe735c5d3d5e716
-  data.tar.gz: dc877bc157ed76157327c2e094ff69ff4074275eaa9df93ec9d3fdf8bc67969c4402503ee9435bcf1305f489f0d7ab22f0b43129e69b0abe9e06064b4683f8e7
+  metadata.gz: 18746c467511ea53db664dd7194ce8b9aeb432ae4fac74911db3d775a921fb7abb9ee8e1ce16e83c2ad1e31b4baf9cf79efb180b827579f040007729f7a6fc20
+  data.tar.gz: 81645f19b209186e1e27d8d07bb5e9792eb9127462fa12af8518f71ee5baf2a8b721a2fe2060fb24ab4dc5291b817b27c8370e6b452e9c49a52b7cae3226567a

data/Gemfile.lock

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

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

@@ -74,17 +74,27 @@ module Checkoff
       end
 
       # :ready function
+      #
+      # See GLOSSARY.md and tasks.rb#task_ready? for more information.
       class ReadyFunctionEvaluator < FunctionEvaluator
         def matches?
           fn?(selector, :ready)
         end
 
+        # @param _index [Integer]
+        def evaluate_arg?(_index)
+          false
+        end
+
         # @param task [Asana::Resources::Task]
+        # @param period [Symbol<:now_or_before,:this_week>]
         # @param ignore_dependencies [Boolean]
         # @return [Boolean]
-        def evaluate(task, ignore_dependencies: false)
-          @tasks.task_ready?(task, ignore_dependencies: ignore_dependencies)
+        # rubocop:disable Style/OptionalBooleanParameter
+        def evaluate(task, period = :now_or_before, ignore_dependencies = false)
+          @tasks.task_ready?(task, period: period, ignore_dependencies: ignore_dependencies)
         end
+        # rubocop:ensable Style/OptionalBooleanParameter
       end
 
       # :unassigned function

data/lib/checkoff/tasks.rb

@@ -50,6 +50,7 @@ module Checkoff
       @client = client
       @portfolios = portfolios
       @workspaces = workspaces
+      @timing = 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
@@ -63,16 +64,16 @@ module Checkoff
     # * start at is before now
     #
     # @param task [Asana::Resources::Task]
+    # @param period [Symbol<:now_or_before,:this_week>]
     # @param ignore_dependencies [Boolean]
-    def task_ready?(task, ignore_dependencies: false)
+    def task_ready?(task, period: :now_or_before, ignore_dependencies: false)
+      field_name = :ready
       return false if !ignore_dependencies && incomplete_dependencies?(task)
 
-      start = task_timing.start_time(task)
-      due = task_timing.due_time(task)
+      # @type [Date,Time,nil]
+      task_date_or_time = task_timing.date_or_time_field_by_name(task, field_name)
 
-      return true if start.nil? && due.nil?
-
-      (start || due) < @time_class.now
+      timing.in_period?(task_date_or_time, period)
     end
 
     # Pull a specific task by name
@@ -236,6 +237,9 @@ module Checkoff
     # @return [Asana::Client]
     attr_reader :client
 
+    # @return [Checkoff::Timing]
+    attr_reader :timing
+
     # @return [Checkoff::Projects]
     def projects
       @projects ||= @sections.projects

data/lib/checkoff/timing.rb

@@ -23,24 +23,38 @@ module Checkoff
     SHORT_CACHE_TIME = MINUTE
 
     # @param today_getter [Class<Date>]
-    def initialize(today_getter: Date)
+    # @param now_getter [Class<Time>]
+    def initialize(today_getter: Date,
+                   now_getter: Time)
       @today_getter = today_getter
+      @now_getter = now_getter
     end
 
-    # @param date [Date]
+    # @param date_or_time [Date,Time,nil]
+    def now_or_before?(date_or_time)
+      return true if date_or_time.nil?
+
+      date_or_time.to_time < @now_getter.now
+    end
+
+    # @param date_or_time [Date,Time,nil]
     # @param period [Symbol<:indefinite>]
-    def in_period?(date, period)
-      return this_week?(date) if period == :this_week
+    def in_period?(date_or_time, period)
+      return this_week?(date_or_time) if period == :this_week
 
       return true if period == :indefinite
 
+      return now_or_before?(date_or_time) if period == :now_or_before
+
       raise "Teach me how to handle period #{period.inspect}"
     end
 
     private
 
-    # @param date [Date]
-    def this_week?(date)
+    # @param date_or_time [Date,Time,nil]
+    def this_week?(date_or_time)
+      return true if date_or_time.nil?
+
       today = @today_getter.today
 
       # Beginning of this week (assuming week starts on Sunday)
@@ -49,6 +63,8 @@ module Checkoff
       # End of this week (assuming week ends on Saturday)
       end_of_week = beginning_of_week + 6
 
+      date = date_or_time.to_date
+
       date >= beginning_of_week && date <= end_of_week
     end
 

data/lib/checkoff/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.104.0
+  version: 0.106.0
 platform: ruby
 authors:
 - Vince Broz