plansheet 0.9.0 → 0.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8132e26b8647ea119299716b5f88674af3e4264614f7b881133eb6cbd32d7db
-  data.tar.gz: c04f8bf586f6866acf03e809ab581b8010b6fb64be486791abb5fdd3274ae6e2
+  metadata.gz: 76e5120430c540166b342a58cf0a0c07dfaf773d0a46b1dcd05614be677fe1a6
+  data.tar.gz: 83eb24c7811f8e1e49d8f7f79a059c1451673907460203d95a5c28e98fbc74c2
 SHA512:
-  metadata.gz: 6426deb869f89a6ff87d5f760acbab8687a542dd3942cf829c536ceb49c3a8268b18ab188d0ad0cb91457fa435963eb7193dd9844a283ccdfb4114e4dece54d8
-  data.tar.gz: 4c03feeae9aed94d4e4df6c931c1317039f1100e67d7475cdbf8b67dae14e753899853291ad46f025e198d93def4b9c67c0c12da24d352d8db0880ae5ebb2f99
+  metadata.gz: 71d3b9dad2c16601ef4472805c282cbfced288e0fc1cee42b0b2e6cb508c5aa255a688c3301fbdee38ae5188f36a2d65cbee2ebc9aa3290771a8f2a2f84854ac
+  data.tar.gz: bc7d994b5d320c0c9f7ed53ca625afb6f586f228a48f16e2e9f1b2f392cae4cb1e1cef45ddc305069fb06a59a8e1fa9cf2324c1dc4a322e411f801d5802c41fe

data/.rubocop.yml

@@ -1,5 +1,3 @@
-inherit_from: .rubocop_todo.yml
-
 AllCops:
   TargetRubyVersion: 2.6
   NewCops: enable
@@ -15,3 +13,9 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Metrics:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plansheet (0.9.0)
+    plansheet (0.13.2)
       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/stringify.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Plansheet
+  class Project
+    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
+      str
+    end
+
+    def stringify_string_property(prop)
+      if instance_variable_defined? "@#{prop}"
+        "#{prop}: #{instance_variable_get("@#{prop}")}\n"
+      else
+        ""
+      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}"
+        str << "#{prop}:\n"
+        instance_variable_get("@#{prop}").each do |t|
+          str << "- #{t}\n"
+        end
+      end
+      str
+    end
+  end
+end

data/lib/plansheet/project/yaml.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "date"
+require "pathname"
+
+module Plansheet
+  # Once there's some stability in plansheet and dc-kwalify, will pre-load this
+  # to save the later YAML.load
+  PROJECT_YAML_SCHEMA = <<~YAML
+    desc: dc-tasks project schema
+    type: seq
+    sequence:
+      - type: map
+        mapping:
+          "project":
+            desc: Project name
+            type: str
+            required: yes
+          "namespace":
+            desc: Namespace of a group of projects (for organizing)
+            type: str
+            required: yes
+          "priority":
+            desc: Project priority
+            type: str
+            enum:
+              - high
+              - medium
+              - low
+          "status":
+            desc: The current status of the project
+            type: str
+            enum:
+              - wip # project is a work-in-progress
+              - 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
+              - done # project is finished, but want to keep around
+                     # for reference, etc.
+          "location":
+            desc: Location
+            type: str
+          "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
+          "completed_on":
+            desc: When the (non-recurring) project was completed
+            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
+            sequence:
+              - type: str
+          "urls":
+            desc: List of URLs that may be pertinent
+            type: seq
+            sequence:
+              - type: str
+          "tasks":
+            desc: List of tasks to do
+            type: seq
+            sequence:
+              - type: str
+          "done":
+            desc: List of tasks which have been completed
+            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)
+
+  class ProjectYAMLFile
+    attr_reader :projects
+
+    def initialize(path)
+      @path = path
+      # TODO: this won't GC, inline validation instead?
+
+      # 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
+      @raw ||= []
+      @projects = @raw.map do |proj|
+        proj["namespace"] = namespace
+        Project.new proj
+      end
+    end
+
+    def namespace
+      # TODO: yikes
+      ::Pathname.new(@path).basename.to_s.gsub(/\.yml$/, "")
+    end
+
+    def validate_schema
+      validator = Kwalify::Validator.new(Plansheet::PROJECT_SCHEMA)
+      errors = validator.validate(@raw)
+      # Check YAML validity
+      return unless errors && !errors.empty?
+
+      $stderr.write "Schema errors in #{@path}:\n"
+      errors.each { |err| puts "- [#{err.path}] #{err.message}" }
+      abort
+    end
+
+    def sort!
+      @projects.sort!
+    end
+
+    def yaml_dump
+      YAML.dump(@projects.map(&:to_h))
+    end
+  end
+end

data/lib/plansheet/project.rb

@@ -2,16 +2,19 @@
 
 require "yaml"
 require "date"
+require_relative "project/yaml"
+require_relative "project/stringify"
 
 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 = {
@@ -20,77 +23,12 @@ module Plansheet
     "low" => 3
   }.freeze
 
-  # Once there's some stability in plansheet and dc-kwalify, will pre-load this
-  # to save the later YAML.load
-  PROJECT_YAML_SCHEMA = <<~YAML
-    desc: dc-tasks project schema
-    type: seq
-    sequence:
-      - type: map
-        mapping:
-          "project":
-            desc: Project name
-            type: str
-            required: yes
-          "priority":
-            desc: Project priority
-            type: str
-            enum:
-              - high
-              - medium
-              - low
-          "status":
-            desc: The current status of the project
-            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
-              - idea # project is little more than an idea
-              - dropped # project has been explicitly dropped, but
-                        # want to keep around for reference, etc
-              - done # project is finished, but want to keep around
-                     # for reference, etc.
-          "location":
-            desc: Location
-            type: str
-          "notes":
-            desc: Free-form notes string
-            type: str
-          "due":
-            desc: Due date of the task
-            type: date
-          "defer":
-            desc: Defer task until this day
-            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
-            sequence:
-              - type: str
-          "urls":
-            desc: List of URLs that may be pertinent
-            type: seq
-            sequence:
-              - type: str
-          "tasks":
-            desc: List of tasks to do
-            type: seq
-            sequence:
-              - type: str
-          "done":
-            desc: List of tasks which have been completed
-            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
@@ -101,10 +39,19 @@ 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
+    # namespace is derived from file name
+    STRING_PROPERTIES = %w[namespace priority status location notes time_estimate frequency 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
 
@@ -132,14 +79,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,132 +117,116 @@ 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
+      return "done" if @completed_on && @tasks.nil?
 
-      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 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)
+    def recurring_status
+      # add frequency to last_done
+      if @last_done
+        # This project has been done once before
+        subsequent_recurring_status
+      else
+        # This recurring project is being done for the first time
+        task_based_status
       end
-      str
     end
 
-    def stringify_string_property(prop)
-      if instance_variable_defined? "@#{prop}"
-        "#{prop}: #{instance_variable_get("@#{prop}")}\n"
-      else
-        ""
-      end
+    def subsequent_recurring_status
+      return "done" if @lead_time && defer > Date.today
+      return "done" if due > Date.today
+
+      task_based_status
     end
 
-    def stringify_date_property(prop)
-      if instance_variable_defined? "@#{prop}"
-        "#{prop}: #{instance_variable_get("@#{prop}")}\n"
-      else
-        ""
-      end
+    def process_recurring
+      # TODO: Tasks will be moved from done->tasks if recurring project is
+      # starting again
     end
 
-    def stringify_array_property(prop)
-      str = String.new
-      if instance_variable_defined? "@#{prop}"
-        str << "#{prop}:\n"
-        instance_variable_get("@#{prop}").each do |t|
-          str << "- #{t}\n"
-        end
-      end
-      str
+    # Due date either explicit or recurring
+    def due
+      return @due if @due
+      return recurring_due_date if recurring?
+
+      nil
     end
 
-    def to_h
-      h = { "project" => @name }
-      ALL_PROPERTIES.each do |prop|
-        h[prop] = instance_variable_get("@#{prop}") if instance_variable_defined?("@#{prop}")
+    def recurring_due_date
+      if @last_done
+        @last_done + Plansheet.parse_date_duration(@frequency)
+      else
+        Date.today
       end
-      h.delete "priority" if h.key?("priority") && h["priority"] == "low"
-      h.delete "status" if h.key?("status") && h["status"] == "idea"
-      h
     end
-  end
-
-  class ProjectYAMLFile
-    attr_reader :projects
-
-    def initialize(path)
-      @path = path
-      # TODO: this won't GC, inline validation instead?
 
-      # 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
+    def defer
+      return @defer if @defer
+      return lead_time_deferral if @lead_time && due
 
-      validate_schema
-      @projects = @raw.map { |proj| Project.new proj }
+      nil
     end
 
-    def validate_schema
-      validator = Kwalify::Validator.new(Plansheet::PROJECT_SCHEMA)
-      errors = validator.validate(@raw)
-      # Check YAML validity
-      return unless errors && !errors.empty?
+    def lead_time_deferral
+      [(due - Plansheet.parse_date_duration(@lead_time)),
+       Date.today].max
+    end
 
-      $stderr.write "Schema errors in #{@path}:\n"
-      errors.each { |err| puts "- [#{err.path}] #{err.message}" }
-      abort
+    def recurring?
+      !@frequency.nil?
     end
 
-    def sort!
-      @projects.sort!
+    def dropped_or_done?
+      status == "dropped" || status == "done"
     end
 
-    def yaml_dump
-      YAML.dump(@projects.map(&:to_h))
+    def to_h
+      h = { "project" => @name }
+      ALL_PROPERTIES.each do |prop|
+        h[prop] = instance_variable_get("@#{prop}") if instance_variable_defined?("@#{prop}")
+      end
+      h.delete "priority" if h.key?("priority") && h["priority"] == "low"
+      h.delete "status" if h.key?("status") && h["status"] == "idea"
+      h
     end
   end
 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.13.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plansheet
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.13.2
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-04 00:00:00.000000000 Z
+date: 2022-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dc-kwalify
@@ -33,7 +33,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -45,6 +44,8 @@ files:
 - exe/plansheet
 - lib/plansheet.rb
 - lib/plansheet/project.rb
+- lib/plansheet/project/stringify.rb
+- lib/plansheet/project/yaml.rb
 - lib/plansheet/sheet.rb
 - lib/plansheet/version.rb
 homepage: https://dafyddcrosby.com

data/.rubocop_todo.yml

@@ -1,36 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# 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:
-  Max: 105
-
-# Offense count: 1
-# Configuration parameters: IgnoredMethods.
-Metrics/CyclomaticComplexity:
-  Max: 8
-
-# Offense count: 2
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
-Metrics/MethodLength:
-  Max: 12
-
-# Offense count: 1
-# Configuration parameters: IgnoredMethods.
-Metrics/PerceivedComplexity:
-  Max: 10
-
-# Offense count: 2
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/plansheet.rb'
-    - 'lib/plansheet/project.rb'