plansheet 0.7.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98932ed8f5a5d06da4b2f6135d1321e5376a1af2f837d4a65b9f806c7f06b8d9
-  data.tar.gz: 0ef6f026f7bcbc4712d008ca2843a0b5a9d1715038b2fc91534a8c9951697ec6
+  metadata.gz: d1c4e7e5e45d00a1218ac7346c60ba9182c7b73ac2761958c24ea8c8dcf15d9d
+  data.tar.gz: 50cc492240c458e5bc13539f03203007b8922dcd2e00e5108d6f929c81419f2e
 SHA512:
-  metadata.gz: 95217512c48168c26ef2c5f937dd8b94530bccea1149c2e90df1db039243b9ffb4582efe26ea14ae6393845daa4d8f5a4fec36cff82231d7b6ab6fc6a1255ff6
-  data.tar.gz: '095dcda8264517252297a7aba139f8c51bddfbe04880acb9a16d2eb3f4a479003e1ee453902acf65fde2ad89720b522b6d6bd118e3f1f3202f2aab9f9ec50d04'
+  metadata.gz: 2fe3310c09dfe7d4e79172a476f3bcfc0a3ef6261757a4070a6f49d9857673524663ee97622db603acae911201d5f1acc9cdb65d7c30547ea0e3f4610dc5e0bf
+  data.tar.gz: 58aee2a5ab4f95c114461a8ef614823b5c4e22e0961c792623d0720b033a40c1abbdf1d23887b7b5a38b4823138994116d3eb6b42f2675263d0825d567fee173

data/.rubocop_todo.yml

@@ -1,26 +1,35 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-06-02 13:34:43 UTC using RuboCop version 1.29.1.
+# on 2022-06-04 17:25:54 UTC using RuboCop version 1.29.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  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:
+  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

@@ -6,7 +6,12 @@ source "https://rubygems.org"
 gemspec
 
 group :development, optional: true do
+  gem "guard", "~> 2.18"
+  gem "guard-minitest", "~> 2.4"
   gem "minitest", "~> 5.0"
   gem "rake", "~> 13.0"
+
   gem "rubocop", "~> 1.21"
+  gem "rubocop-minitest"
+  gem "rubocop-rake"
 end

data/Gemfile.lock

@@ -1,20 +1,51 @@
 PATH
   remote: .
   specs:
-    plansheet (0.7.0)
+    plansheet (0.12.0)
       dc-kwalify (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    coderay (1.1.3)
     dc-kwalify (1.0.0)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      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)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
     minitest (5.15.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     regexp_parser (2.4.0)
     rexml (3.2.5)
     rubocop (1.29.1)
@@ -28,17 +59,27 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.18.0)
       parser (>= 3.1.1.0)
+    rubocop-minitest (0.20.0)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
+    shellany (0.0.1)
+    thor (1.2.1)
     unicode-display_width (2.1.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  guard (~> 2.18)
+  guard-minitest (~> 2.4)
   minitest (~> 5.0)
   plansheet!
   rake (~> 13.0)
   rubocop (~> 1.21)
+  rubocop-minitest
+  rubocop-rake
 
 BUNDLED WITH
    2.3.6

data/Guardfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+directories(%w[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" }
+end

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

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
 require "yaml"
+require "date"
 
 module Plansheet
   PROJECT_STATUS_PRIORITY = {
     "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 = {
@@ -43,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
@@ -57,6 +60,40 @@ 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
+            sequence:
+              - type: str
           "externals":
             desc: List of external commitments, ie who else cares about project completion?
             type: seq
@@ -77,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
@@ -89,11 +138,20 @@ 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
-    ARRAY_PROPERTIES = %w[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 + ARRAY_PROPERTIES
+    ALL_PROPERTIES = STRING_PROPERTIES + DATE_PROPERTIES + ARRAY_PROPERTIES
 
     attr_reader :name, *ALL_PROPERTIES
 
@@ -118,34 +176,153 @@ module Plansheet
     end
 
     def <=>(other)
-      if @priority == other.priority
-        # TODO: if planning status, then sort based on tasks? category? alphabetically?
-        PROJECT_STATUS_PRIORITY[status] <=> PROJECT_STATUS_PRIORITY[other.status]
-      else
-        PROJECT_PRIORITY[@priority] <=> PROJECT_PRIORITY[other.priority]
+      ret_val = 0
+      DEFAULT_COMPARISON_ORDER.each do |method|
+        ret_val = send(method, other)
+        break if ret_val != 0
       end
+      ret_val
+    end
+
+    def compare_priority(other)
+      PROJECT_PRIORITY[@priority] <=> PROJECT_PRIORITY[other.priority]
+    end
+
+    def compare_status(other)
+      PROJECT_STATUS_PRIORITY[status] <=> PROJECT_STATUS_PRIORITY[other.status]
+    end
+
+    def compare_due(other)
+      # -1 is receiving object being older
+
+      # Handle nil
+      if @due.nil?
+        return 0 if other.due.nil?
+
+        return 1
+      elsif other.due.nil?
+        return -1
+      end
+
+      @due <=> other.due
+    end
+
+    def compare_defer(other)
+      receiver = @defer.nil? || @defer < Date.today ? Date.today : @defer
+      comparison = other.defer.nil? || other.defer < Date.today ? Date.today : other.defer
+      receiver <=> comparison
+    end
+
+    def compare_dependency(other)
+      return 0 if @dependencies.nil? && other.dependencies.nil?
+
+      if @dependencies.nil?
+        return -1 if other.dependencies.any? do |dep|
+          @name.downcase == dep.downcase
+        end
+      elsif @dependencies.any? do |dep|
+              other.name.downcase == dep.downcase
+            end
+        return 1
+      end
+      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 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
+
     def to_s
       str = String.new
       str << "# #{@name}\n"
       STRING_PROPERTIES.each do |o|
         str << stringify_string_property(o)
       end
+      DATE_PROPERTIES.each do |o|
+        str << stringify_string_property(o)
+      end
       ARRAY_PROPERTIES.each do |o|
         str << stringify_array_property(o)
       end
@@ -160,6 +337,14 @@ module Plansheet
       end
     end
 
+    def stringify_date_property(prop)
+      if instance_variable_defined? "@#{prop}"
+        "#{prop}: #{instance_variable_get("@#{prop}")}\n"
+      else
+        ""
+      end
+    end
+
     def stringify_array_property(prop)
       str = String.new
       if instance_variable_defined? "@#{prop}"
@@ -188,7 +373,14 @@ module Plansheet
     def initialize(path)
       @path = path
       # TODO: this won't GC, inline validation instead?
-      @raw = YAML.load_file(path)
+
+      # Handle pre-Ruby 3.1 psych versions (this is brittle)
+      @raw = if Psych::VERSION.split(".")[0].to_i >= 4
+               YAML.load_file(path, permitted_classes: [Date])
+             else
+               YAML.load_file(path)
+             end
+
       validate_schema
       @projects = @raw.map { |proj| Project.new proj }
     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}"
@@ -32,7 +32,7 @@ module Plansheet
       str = String.new
       str << "\\begin{minipage}{4.5cm}\n"
       str << project_header(proj)
-      proj.tasks.each do |t|
+      proj&.tasks&.each do |t|
         str << "$\\square$ #{t} \\\\\n"
       end
       str << "\\end{minipage}\n"

data/lib/plansheet/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plansheet
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.12.0
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-02 00:00:00.000000000 Z
+date: 2022-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dc-kwalify
@@ -37,6 +37,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile