plansheet 0.9.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8132e26b8647ea119299716b5f88674af3e4264614f7b881133eb6cbd32d7db
-  data.tar.gz: c04f8bf586f6866acf03e809ab581b8010b6fb64be486791abb5fdd3274ae6e2
+  metadata.gz: d1c4e7e5e45d00a1218ac7346c60ba9182c7b73ac2761958c24ea8c8dcf15d9d
+  data.tar.gz: 50cc492240c458e5bc13539f03203007b8922dcd2e00e5108d6f929c81419f2e
 SHA512:
-  metadata.gz: 6426deb869f89a6ff87d5f760acbab8687a542dd3942cf829c536ceb49c3a8268b18ab188d0ad0cb91457fa435963eb7193dd9844a283ccdfb4114e4dece54d8
-  data.tar.gz: 4c03feeae9aed94d4e4df6c931c1317039f1100e67d7475cdbf8b67dae14e753899853291ad46f025e198d93def4b9c67c0c12da24d352d8db0880ae5ebb2f99
+  metadata.gz: 2fe3310c09dfe7d4e79172a476f3bcfc0a3ef6261757a4070a6f49d9857673524663ee97622db603acae911201d5f1acc9cdb65d7c30547ea0e3f4610dc5e0bf
+  data.tar.gz: 58aee2a5ab4f95c114461a8ef614823b5c4e22e0961c792623d0720b033a40c1abbdf1d23887b7b5a38b4823138994116d3eb6b42f2675263d0825d567fee173

data/.rubocop_todo.yml

@@ -9,28 +9,27 @@
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 105
+  Enabled: false
 
 # Offense count: 1
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 8
+  Enabled: false
 
 # Offense count: 2
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 12
+  Enabled: false
 
 # Offense count: 1
 # Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 10
+  Enabled: false
 
 # Offense count: 2
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
-    - 'spec/**/*'
     - 'test/**/*'
     - 'lib/plansheet.rb'
     - 'lib/plansheet/project.rb'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plansheet (0.9.0)
+    plansheet (0.12.0)
       dc-kwalify (~> 1.0)
 
 GEM

data/exe/plansheet

@@ -17,6 +17,10 @@ parser.on(
   "--cli",
   "CLI dump of projects (WIP)"
 )
+parser.on(
+  "--location_filter LOCATION",
+  "location filter for CLI dump (WIP)"
+)
 options = {}
 parser.parse!(into: options)
 
@@ -32,7 +36,10 @@ elsif options[:sort]
   Plansheet.resort_projects_in_dir config["projects_dir"]
 elsif options[:cli]
   project_arr = Plansheet.load_projects_dir config["projects_dir"]
-  project_arr.sort.each do |proj|
+  project_arr.sort!
+  project_arr.delete_if { |x| x.status == "dropped" || x.status == "done" }
+  project_arr.select! { |x| x.location == options[:location_filter] } if options[:location_filter]
+  project_arr.each do |proj|
     puts proj
     puts "\n"
   end

data/lib/plansheet/project.rb

@@ -8,10 +8,11 @@ module Plansheet
     "wip" => 1,
     "ready" => 2,
     "blocked" => 3,
-    "planning" => 4,
-    "idea" => 5,
-    "dropped" => 6,
-    "done" => 7
+    "waiting" => 4,
+    "planning" => 5,
+    "idea" => 6,
+    "dropped" => 7,
+    "done" => 8
   }.freeze
 
   PROJECT_PRIORITY = {
@@ -44,9 +45,10 @@ module Plansheet
             type: str
             enum:
               - wip # project is a work-in-progress
-              - ready # project is fully scoped, ready to go
-              - blocked # project is blocked, but otherwise ready/wip
-              - planning # project in planning phase
+              - ready # project has tasks, ready to go
+              - waiting # project in waiting on some external person/event
+              - blocked # project is blocked by another project, but otherwise ready/wip
+              - planning # project in planning phase (set manually)
               - idea # project is little more than an idea
               - dropped # project has been explicitly dropped, but
                         # want to keep around for reference, etc
@@ -58,12 +60,35 @@ module Plansheet
           "notes":
             desc: Free-form notes string
             type: str
+          "time_estimate":
+            desc: The estimated amount of time before a project is completed
+            type: str
+          "frequency":
+            desc: The amount of time before a recurring project moves to ready status again from when it was last done (WIP)
+            type: str
+            pattern: /\\d+[dwDW]/
+          "lead_time":
+            desc: The amount of time before a recurring project is "due" moved to ready where the project (sort of a deferral mechanism) (WIP)
+            type: str
+            pattern: /\\d+[dwDW]/
           "due":
             desc: Due date of the task
             type: date
           "defer":
             desc: Defer task until this day
             type: date
+          "created_on":
+            desc: When the project was created
+            type: date
+          "starts_on":
+            desc: For ICS (WIP)
+            type: date
+          "last_reviewed":
+            desc: When the project was last reviewed (WIP)
+            type: date
+          "last_done":
+            desc: When the recurring project was last completed (WIP)
+            type: date
           "dependencies":
             desc: The names of projects that need to be completed before this project can be started/completed
             type: seq
@@ -89,9 +114,21 @@ module Plansheet
             type: seq
             sequence:
               - type: str
+          "tags":
+            desc: List of tags (WIP)
+            type: seq
+            sequence:
+              - type: str
   YAML
   PROJECT_SCHEMA = YAML.safe_load(PROJECT_YAML_SCHEMA)
 
+  def self.parse_date_duration(str)
+    return Regexp.last_match(1).to_i if str.strip.match(/(\d+)[dD]/)
+    return (Regexp.last_match(1).to_i * 7) if str.strip.match(/(\d+)[wW]/)
+
+    raise "Can't parse time duration string #{str}"
+  end
+
   # The use of instance_variable_set/get probably seems a bit weird, but the
   # intent is to avoid object allocation on non-existent project properties, as
   # well as avoiding a bunch of copy-paste boilerplate when adding a new
@@ -101,10 +138,18 @@ module Plansheet
   class Project
     include Comparable
 
+    DEFAULT_COMPARISON_ORDER = %w[
+      completeness
+      dependency
+      priority
+      defer
+      due
+      status
+    ].map { |x| "compare_#{x}".to_sym }.freeze
     # NOTE: The order of these affects presentation!
-    STRING_PROPERTIES = %w[priority status location notes].freeze
-    DATE_PROPERTIES = %w[due defer].freeze
-    ARRAY_PROPERTIES = %w[dependencies externals urls tasks done].freeze
+    STRING_PROPERTIES = %w[priority status location notes time_estimate frequency lead_time].freeze
+    DATE_PROPERTIES = %w[due defer created_on starts_on last_done last_reviewed].freeze
+    ARRAY_PROPERTIES = %w[dependencies externals urls tasks done tags].freeze
 
     ALL_PROPERTIES = STRING_PROPERTIES + DATE_PROPERTIES + ARRAY_PROPERTIES
 
@@ -132,14 +177,7 @@ module Plansheet
 
     def <=>(other)
       ret_val = 0
-      %i[
-        compare_completeness
-        compare_dependency
-        compare_priority
-        compare_due
-        compare_defer
-        compare_status
-      ].each do |method|
+      DEFAULT_COMPARISON_ORDER.each do |method|
         ret_val = send(method, other)
         break if ret_val != 0
       end
@@ -177,40 +215,101 @@ module Plansheet
 
     def compare_dependency(other)
       return 0 if @dependencies.nil? && other.dependencies.nil?
+
       if @dependencies.nil?
-        return -1 if other.dependencies.any? {|dep|
+        return -1 if other.dependencies.any? do |dep|
           @name.downcase == dep.downcase
-        }
-      else
-        return 1 if @dependencies.any? {|dep|
-          other.name.downcase == dep.downcase
-        }
+        end
+      elsif @dependencies.any? do |dep|
+              other.name.downcase == dep.downcase
+            end
+        return 1
       end
-      return 0
+      0
     end
 
     # Projects that are dropped or done are considered "complete", insofar as
     # they are only kept around for later reference.
     def compare_completeness(other)
-      return 0 if self.dropped_or_done? && other.dropped_or_done?
-      return 0 if !self.dropped_or_done? && !other.dropped_or_done?
-      self.dropped_or_done? ? 1 : -1
+      return 0 if dropped_or_done? && other.dropped_or_done?
+      return 0 if !dropped_or_done? && !other.dropped_or_done?
+
+      dropped_or_done? ? 1 : -1
     end
 
     def status
       return @status if @status
+      return recurring_status if recurring?
+      return task_based_status if (@tasks || @done)
+      # TODO: return done if done count is positive...
 
-      if @tasks&.count&.positive?
-        if @done&.count&.positive?
-          "wip"
-        else
-          "planning"
-        end
+      "idea"
+    end
+
+    def task_based_status
+      if @tasks&.count&.positive? && @done&.count&.positive?
+        "wip"
+      elsif @tasks&.count&.positive?
+        "ready"
+      elsif @done&.count&.positive?
+        "done"
       else
         "idea"
       end
     end
 
+    def recurring_status
+      # add frequency to last_done
+      unless @last_done
+        # This recurring project is being done for the first time
+        task_based_status
+      else
+        # This project has been done once before
+        subsequent_recurring_status
+      end
+    end
+
+    def subsequent_recurring_status
+      return "done" if @lead_time && defer > Date.today
+      return "done" if due > Date.today
+      task_based_status
+    end
+
+    def process_recurring
+      # TODO: Tasks will be moved from done->tasks if recurring project is
+      # starting again
+    end
+
+    # Due date either explicit or recurring
+    def due
+      return @due if @due
+      return recurring_due_date if recurring?
+      nil
+    end
+
+    def recurring_due_date
+      if @last_done
+        @last_done + Plansheet.parse_date_duration(@frequency)
+      else
+        Date.today
+      end
+    end
+
+    def defer
+      return @defer if @defer
+      return lead_time_deferral if @lead_time && due
+      nil
+    end
+
+    def lead_time_deferral
+      [(due - Plansheet.parse_date_duration(@lead_time)),
+       Date.today].max
+    end
+
+    def recurring?
+      !@frequency.nil?
+    end
+
     def dropped_or_done?
       status == "dropped" || status == "done"
     end

data/lib/plansheet/sheet.rb

@@ -10,7 +10,7 @@ module Plansheet
       projects_str = String.new
       projects_str << sheet_header
 
-      sorted_arr.first(60).each do |p|
+      sorted_arr.each do |p|
         projects_str << project_minipage(p)
       end
       puts "Writing to #{output_file}"

data/lib/plansheet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Plansheet
-  VERSION = "0.9.0"
+  VERSION = "0.12.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plansheet
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.12.0
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-04 00:00:00.000000000 Z
+date: 2022-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dc-kwalify