plansheet 0.17.1 → 0.23.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c094d7236b6603dcab810d785eab766754e0cd9f161a2cb2daf280962b41026
-  data.tar.gz: 2686468ff7aa21915ff73ff27c49990cd05c2dc4e75c139837a69c1580a49dd5
+  metadata.gz: e479f020bfa87192523fd231ec0704d07a2e0e92805eaf76720bf3ee62469c4a
+  data.tar.gz: c197a3c2730522f7f70aa4793ff50670e91e04f57f15874bef174c0f94b44f83
 SHA512:
-  metadata.gz: 646ede4ae64522cfc33912eaefae96083de293800647700ec04b2569fe305d40bf7855a0780c63262db5fdaa5adf8472dba4790bd5f0b60228acc7a921b84417
-  data.tar.gz: 0c56e57fa79c225d9c3edf055e5c033e9bb9c5b63a49d2d1e7ae1bc17e3c1298e086af4c06d88d270fe9a6e83f3d6f67bba6c4f65f09afbcaf80ed46570f4a3f
+  metadata.gz: 77d8895595f834e4bf6f844aabd20178b3f50172071a2713e81f50e9e0e21f4c9cc29df0550cfba085419f7508eeb188417610ce8364b18fdcdd8a6012290eed
+  data.tar.gz: 1da8aab0fe36a1775584afbdd140c3b0e0b6a6ed43202b2987311aa258bc3a2d59ce6109cb88c11c6a8a9335bd5770c9c2e66c1ff3f74c3f26cd4c0c07120733

data/Gemfile

@@ -7,7 +7,7 @@ gemspec
 
 group :development, optional: true do
   gem "guard", "~> 2.18"
-  gem "guard-minitest", "~> 2.4"
+  gem "guard-rake", "~> 1.0"
   gem "minitest", "~> 5.0"
   gem "rake", "~> 13.0"
   gem "rdoc"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plansheet (0.17.1)
+    plansheet (0.23.2)
       dc-kwalify (~> 1.0)
       rgl (= 0.5.8)
 
@@ -23,10 +23,9 @@ GEM
       pry (>= 0.13.0)
       shellany (~> 0.0)
       thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-minitest (2.4.6)
-      guard-compat (~> 1.2)
-      minitest (>= 3.0)
+    guard-rake (1.0.0)
+      guard
+      rake
     lazy_priority_queue (0.1.1)
     listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
@@ -87,7 +86,7 @@ PLATFORMS
 
 DEPENDENCIES
   guard (~> 2.18)
-  guard-minitest (~> 2.4)
+  guard-rake (~> 1.0)
   minitest (~> 5.0)
   plansheet!
   rake (~> 13.0)

data/Guardfile

@@ -1,9 +1,16 @@
 # frozen_string_literal: true
 
-directories(%w[lib test].select { |d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist") })
+directories(%w[. exe bin lib test].select { |d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist") })
 
-guard :minitest do
-  watch(%r{^test/test_(.*)\.rb$}) { "test" }
-  watch(%r{^lib/plansheet/(.*)\.rb$}) { "test" }
-  watch(%r{^lib/plansheet\.rb$}) { "test" }
+guard :rake, task: "default" do
+  watch("Gemfile")
+  watch("Rakefile")
+  watch("Guardfile")
+  watch(%r{^test/test_(.*)\.rb$})
+  watch("exe/plansheet")
+  watch("bin/console")
+  watch(%r{^test/test_(.*)\.rb$})
+  watch(%r{^lib/plansheet/(.*)\.rb$})
+  watch(%r{^lib/plansheet/project/(.*)\.rb$})
+  watch(%r{^lib/plansheet\.rb$})
 end

data/exe/plansheet

@@ -13,10 +13,22 @@ parser.on(
   "--sort",
   "Sort project files"
 )
+parser.on(
+  "--irb",
+  "Open IRB console after loading projects"
+)
 parser.on(
   "--cli",
   "CLI dump of projects (WIP)"
 )
+parser.on(
+  "--stats",
+  "Various stats (WIP)"
+)
+parser.on(
+  "--time-roi",
+  "Show projects with a time return-on-investment"
+)
 parser.on(
   "--calendar",
   "List of projects ordered by due date"
@@ -36,9 +48,23 @@ if options[:sheet] || options.empty?
   require "plansheet/sheet"
   Dir.mkdir config["output_dir"] unless Dir.exist? config["output_dir"]
   Plansheet::Sheet.new("#{config["output_dir"]}/projects.md", pool.projects)
+elsif options[:irb]
+  binding.irb # rubocop:disable Lint/Debugger
+elsif options[:stats]
+  puts "# of projects: #{pool.projects.count}"
+  puts "# of tasks: #{pool.projects.sum { |x| x&.tasks&.count || 0 }}"
+  puts "# of locations: #{pool.projects.collect(&:location).flatten.delete_if(&:nil?).uniq.count}"
+  puts "combined time estimate: #{pool.projects.sum { |x| x.time_estimate_minutes || 0 }} minutes"
 elsif options[:sort]
   # Pool sorts projects, this now just matches old behaviour
   pool.write_projects
+elsif options[:"time-roi"]
+  project_arr = pool.projects.select {|x| x.time_roi_payoff != 0 && !x.dropped_or_done?}.sort
+  project_arr.each do |proj|
+    puts proj
+    puts "time ROI payoff: #{proj.time_roi_payoff}"
+    puts "\n"
+  end
 elsif options[:calendar]
   # TODO: add a project filter method
   project_arr = pool.projects

data/lib/plansheet/pool.rb

@@ -14,10 +14,11 @@ module Plansheet
       priority
       defer
       due
+      time_roi
       status
     ].freeze
 
-    def initialize(config)
+    def initialize(config, debug: false)
       @projects_dir = config[:projects_dir]
       @sort_order = config[:sort_order]
       # @completed_projects_dir = config(:completed_projects_dir)
@@ -26,17 +27,19 @@ module Plansheet
       # until runtime. I'm sure this design decision definitely won't bite me
       # in the future ;-) Fortunately, it's also not a problem that can't be
       # walked back from.
-      if config[:sort_order]
-        self.class.const_set("POOL_COMPARISON_ORDER", config[:sort_order])
-      else
-        self.class.const_set("POOL_COMPARISON_ORDER", Plansheet::Pool::DEFAULT_COMPARISON_ORDER)
-      end
+      # rubocop:disable Lint/OrAssignmentToConstant
+      Plansheet::Pool::POOL_COMPARISON_ORDER ||= config[:sort_order] if config[:sort_order]
+      puts "using config sort order" if config[:sort_order]
+      Plansheet::Pool::POOL_COMPARISON_ORDER ||= Plansheet::Pool::DEFAULT_COMPARISON_ORDER
+      # rubocop:enable Lint/OrAssignmentToConstant
       require_relative "project"
-      load_projects_dir(@projects_dir)
-      sort_projects
+
+      load_projects_dir(@projects_dir) unless debug
+      sort_projects if @projects
     end
 
     def sort_projects
+      @projects ||= []
       @projects.sort!
       # lookup_hash returns the index of a project
       lookup_hash = Hash.new nil

data/lib/plansheet/project/yaml.rb

@@ -9,6 +9,8 @@ require "kwalify"
 module Plansheet
   # Once there's some stability in plansheet and dc-kwalify, will pre-load this
   # to save the later YAML.load
+  YAML_TIME_REGEX = "/\\d+[mh] ?\d*m?/" # TODO: regex is bad, adjust for better handling of pretty time
+  YAML_DATE_REGEX = "/\\d+[dw]/"
   PROJECT_YAML_SCHEMA = <<~YAML
     desc: dc-tasks project schema
     type: seq
@@ -18,6 +20,7 @@ module Plansheet
           "project":
             desc: Project name
             type: str
+            unique: true
           "namespace":
             desc: Project name
             type: str
@@ -51,14 +54,42 @@ module Plansheet
           "time_estimate":
             desc: The estimated amount of time before a project is completed
             type: str
+            pattern: #{YAML_TIME_REGEX}
+          "daily_time_roi":
+            desc: The estimated amount of time saved daily by completing this project
+            type: str
+            pattern: #{YAML_TIME_REGEX}
+          "weekly_time_roi":
+            desc: The estimated amount of time saved daily by completing this project
+            type: str
+            pattern: #{YAML_TIME_REGEX}
+          "yearly_time_roi":
+            desc: The estimated amount of time saved daily by completing this project
+            type: str
+            pattern: #{YAML_TIME_REGEX}
+          "day_of_week":
+            desc: recurring day of week project
+            type: str
+            enum:
+              - Sunday
+              - Monday
+              - Tuesday
+              - Wednesday
+              - Thursday
+              - Friday
+              - Saturday
           "frequency":
-            desc: The amount of time before a recurring project moves to ready status again from when it was last done (WIP)
+            desc: The amount of time before a recurring project moves to ready status again from when it was last done, with a set due date (eg. a bill becomes due)
+            type: str
+            pattern: #{YAML_DATE_REGEX}
+          "last_for":
+            desc: "The amount of time before a recurring project moves to ready status again from when it was last done, with a set defer date (eg. inflating a bike tire). If your project 'can't wait' a day or two, you should use frequency."
             type: str
-            pattern: /\\d+[dwDW]/
+            pattern: #{YAML_DATE_REGEX}
           "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]/
+            pattern: #{YAML_DATE_REGEX}
           "due":
             desc: Due date of the task
             type: date

data/lib/plansheet/project.rb

@@ -5,6 +5,13 @@ require "date"
 require_relative "project/yaml"
 require_relative "project/stringify"
 
+# Needed for Project#time_estimate, would be much happier *not* patching Array
+class Array
+  def nil_if_empty
+    count.zero? ? nil : self
+  end
+end
+
 module Plansheet
   PROJECT_STATUS_PRIORITY = {
     "wip" => 1,
@@ -17,6 +24,12 @@ module Plansheet
     "done" => 8
   }.freeze
 
+  # Pre-compute the next days-of-week
+  NEXT_DOW = 0.upto(6).to_h do |x|
+    d = Date.today + x
+    [d.strftime("%A"), d]
+  end.freeze
+
   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]/)
@@ -24,6 +37,29 @@ module Plansheet
     raise "Can't parse time duration string #{str}"
   end
 
+  def self.parse_time_duration(str)
+    if str.match(/(\d+h) (\d+m)/)
+      return (parse_time_duration(Regexp.last_match(1)) + parse_time_duration(Regexp.last_match(2)))
+    end
+
+    return Regexp.last_match(1).to_i if str.strip.match(/(\d+)m/)
+    return (Regexp.last_match(1).to_f * 60).to_i if str.strip.match(/(\d+\.?\d*)h/)
+
+    raise "Can't parse time duration string #{str}"
+  end
+
+  def self.build_time_duration(minutes)
+    if minutes > 59
+      if (minutes % 60).zero?
+        "#{minutes / 60}h"
+      else
+        "#{minutes / 60}h #{minutes % 60}m"
+      end
+    else
+      "#{minutes}m"
+    end
+  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
@@ -33,6 +69,9 @@ module Plansheet
   class Project
     include Comparable
 
+    TIME_EST_REGEX = /\((\d+\.?\d*[mMhH])\)$/.freeze
+    TIME_EST_REGEX_NO_CAPTURE = /\(\d+\.?\d*[mMhH]\)$/.freeze
+
     PROJECT_PRIORITY = {
       "high" => 1,
       "medium" => 2,
@@ -42,13 +81,14 @@ module Plansheet
     COMPARISON_ORDER_SYMS = Plansheet::Pool::POOL_COMPARISON_ORDER.map { |x| "compare_#{x}".to_sym }.freeze
     # NOTE: The order of these affects presentation!
     # namespace is derived from file name
-    STRING_PROPERTIES = %w[priority status location notes time_estimate frequency lead_time].freeze
+    STRING_PROPERTIES = %w[priority status location notes time_estimate daily_time_roi weekly_time_roi yearly_time_roi
+                           day_of_week frequency last_for lead_time].freeze
     DATE_PROPERTIES = %w[due defer completed_on 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
 
-    attr_reader :name, :priority_val, *ALL_PROPERTIES
+    attr_reader :name, :priority_val, :time_estimate_minutes, *ALL_PROPERTIES
     attr_accessor :namespace
 
     def initialize(options)
@@ -74,6 +114,47 @@ module Plansheet
                       else
                         PROJECT_PRIORITY["low"]
                       end
+
+      # Remove stale defer dates
+      remove_instance_variable("@defer") if @defer && (@defer < Date.today)
+
+      # Add a created_on field if it doesn't exist
+      instance_variable_set("@created_on", Date.today) unless @created_on
+
+      # Handle nil-value tasks
+      if @tasks
+        @tasks.compact!
+        remove_instance_variable("@tasks") if @tasks.empty?
+      end
+
+      # Generate time estimate from tasks if specified
+      # Stomps time_estimate field
+      if @tasks
+        @time_estimate_minutes = @tasks&.select do |t|
+                                   t.match? TIME_EST_REGEX_NO_CAPTURE
+                                 end&.nil_if_empty&.map { |t| Plansheet::Project.task_time_estimate(t) }&.sum
+      elsif @time_estimate
+        # No tasks with estimates, but there's an explicit time_estimate
+        # Convert the field to minutes
+        @time_estimate_minutes = Plansheet.parse_time_duration(@time_estimate)
+      end
+      if @time_estimate_minutes # rubocop:disable Style/GuardClause
+        # Rewrite time_estimate field
+        @time_estimate = Plansheet.build_time_duration(@time_estimate_minutes)
+
+        yms = yearly_minutes_saved
+        @time_roi_payoff = yms.to_f / @time_estimate_minutes if yms
+      end
+    end
+
+    def yearly_minutes_saved
+      if @daily_time_roi
+        Plansheet.parse_time_duration(@daily_time_roi) * 365
+      elsif @weekly_time_roi
+        Plansheet.parse_time_duration(@weekly_time_roi) * 52
+      elsif @yearly_time_roi
+        Plansheet.parse_time_duration(@yearly_time_roi)
+      end
     end
 
     def <=>(other)
@@ -89,6 +170,14 @@ module Plansheet
       priority_val <=> other.priority_val
     end
 
+    def time_roi_payoff
+      @time_roi_payoff || 0
+    end
+
+    def compare_time_roi(other)
+      other.time_roi_payoff <=> time_roi_payoff
+    end
+
     def compare_status(other)
       PROJECT_STATUS_PRIORITY[status] <=> PROJECT_STATUS_PRIORITY[other.status]
     end
@@ -178,7 +267,8 @@ module Plansheet
 
     def subsequent_recurring_status
       return "done" if @lead_time && defer > Date.today
-      return "done" if due > Date.today
+      return "done" if @last_for && defer > Date.today
+      return "done" if due && due > Date.today
 
       task_based_status
     end
@@ -191,39 +281,60 @@ module Plansheet
     # Due date either explicit or recurring
     def due
       return @due if @due
-      return recurring_due_date if recurring?
+      return recurring_due_date if recurring_due?
 
       nil
     end
 
     def recurring_due_date
       if @last_done
-        @last_done + Plansheet.parse_date_duration(@frequency)
-      else
-        Date.today
+        return @last_done + Plansheet.parse_date_duration(@frequency) if @frequency
+
+        if @day_of_week
+          return Date.today + 7 if @last_done == Date.today
+          return @last_done + 7 if @last_done < Date.today - 7
+
+          return NEXT_DOW[@day_of_week]
+        end
       end
+
+      # Going to assume this is the first time, so due today
+      Date.today
     end
 
     def defer
       return @defer if @defer
       return lead_time_deferral if @lead_time && due
+      return last_for_deferral if @last_for
 
       nil
     end
 
+    def last_for_deferral
+      return @last_done + Plansheet.parse_date_duration(@last_for) if @last_done
+    end
+
     def lead_time_deferral
       [(due - Plansheet.parse_date_duration(@lead_time)),
        Date.today].max
     end
 
+    def recurring_due?
+      !@frequency.nil? || !@day_of_week.nil?
+    end
+
     def recurring?
-      !@frequency.nil?
+      !@frequency.nil? || !@day_of_week.nil? || !@last_done.nil?
     end
 
     def dropped_or_done?
       status == "dropped" || status == "done"
     end
 
+    def self.task_time_estimate(str)
+      Plansheet.parse_time_duration(Regexp.last_match(1)) if str.match(TIME_EST_REGEX)
+    end
+
     def to_h
       h = { "project" => @name, "namespace" => @namespace }
       ALL_PROPERTIES.each do |prop|

data/lib/plansheet/sheet.rb

@@ -28,20 +28,26 @@ module Plansheet
 
     def project_minipage(proj)
       str = String.new
-      str << "\\begin{minipage}{4.5cm}\n"
+      str << "\\begin{minipage}{6cm}\n"
       str << project_header(proj)
       proj&.tasks&.each do |t|
-        str << "$\\square$ #{t} \\\\\n"
+        str << "$\\square$ #{sanitize_string(t)} \\\\\n"
       end
       str << "\\end{minipage}\n"
       str
     end
 
+    def sanitize_string(str)
+      str.gsub("_", '\_')
+    end
+
     def project_header(proj)
       str = String.new
-      str << "#{proj.namespace}: #{proj.name} - #{proj.status}"
-      str << " - #{proj.location}" if proj.location
-      str << " - due #{proj.due}" if proj.due
+      str << "#{sanitize_string(proj.namespace)}: #{sanitize_string(proj.name)}\\\\\n"
+      str << proj.status.to_s
+      str << " - #{sanitize_string(proj.location)}" if proj.location
+      str << " due: #{proj.due}" if proj.due
+      str << " time: #{proj.time_estimate}" if proj.time_estimate
       str << " \\\\\n"
       str
     end

data/lib/plansheet/version.rb

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

metadata

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