plansheet 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0df6d0d15bff6b0d639ea6561ad722308c02e00b1bd313649b952a48c7826ad4
-  data.tar.gz: 51faedcd44ccaeec7ee88a3e345bb8d5ae1597a5689324953a188e1725a465e2
+  metadata.gz: d9c1a116df170c31d73c29dce213b757743c0e49bbee8c86a47ce7ce09009730
+  data.tar.gz: 2baeb58d82c15823d9beb3e6504bb452e14cabded159f9931bf2300fdaed5d8f
 SHA512:
-  metadata.gz: 0eb27167a0d754f27df229da3e2e12a07734a1e90f8d1a19374a6d408fd822d67286b31efbaa223eae61ec97931727ed4d3ea70e4211035cb8f2ea68f728f207
-  data.tar.gz: 646ed78dd6f00b145ad61778fc7462b1ee1a3f9c52df3b3e27347c5d30ac199b2b4ef914239dd1a586d2e575e9fe8d44f664d5e152075a8ca5211150b4034838
+  metadata.gz: a87a4f7386a651ca82d385600f7b32ee78ff436406d596b6c2966ed721bdcee16f9bd4ad73b158be03305541dceda0d525e68ea2dc520a028fb603a6b5f0c1c0
+  data.tar.gz: d679906ef154e9b84e9282e1811ac0dff8da8b4dfb17c6e0e24d7f08226933346c4229468ddf51526e7532af7bdfd9a502557b64efc6439c128716a380e86d86

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
   TargetRubyVersion: 2.6
   NewCops: enable

data/.rubocop_todo.yml

@@ -0,0 +1,31 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-06-02 13:59:36 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: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 1
+# 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'

data/Gemfile.lock

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

data/lib/plansheet/project.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "yaml"
+require "date"
 
 module Plansheet
   PROJECT_STATUS_PRIORITY = {
@@ -18,11 +19,6 @@ module Plansheet
     "medium" => 2,
     "low" => 3
   }.freeze
-  PROJECT_PRIORITY_REV = {
-    1 => "high",
-    2 => "medium",
-    3 => "low"
-  }.freeze
 
   # Once there's some stability in plansheet and dc-kwalify, will pre-load this
   # to save the later YAML.load
@@ -36,6 +32,13 @@ module Plansheet
             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
@@ -49,15 +52,28 @@ module Plansheet
                         # want to keep around for reference, etc
               - done # project is finished, but want to keep around
                      # for reference, etc.
-          "priority":
-            desc: Project priority
-            type: str
-            enum:
-              - high
-              - low
           "location":
             desc: Location
             type: str
+          "notes":
+            desc: Free-form notes string
+            type: str
+          "due":
+            desc: Due date of the task (WIP)
+            type: date
+          "defer":
+            desc: Defer task until this day (WIP)
+            type: date
+          "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
@@ -68,25 +84,45 @@ module Plansheet
             type: seq
             sequence:
               - type: str
-          "notes":
-            desc: Free-form notes string
-            type: str
   YAML
   PROJECT_SCHEMA = YAML.safe_load(PROJECT_YAML_SCHEMA)
+
+  # 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
+  # property. I suspect I'm guilty of premature optimization here, but it's
+  # easier to do this at the start than untangle that later (ie easier to
+  # unwrap the loops if it's not needed.
   class Project
     include Comparable
-    attr_reader :name, :tasks, :done, :notes, :location, :priority
+
+    # NOTE: The order of these affects presentation!
+    STRING_PROPERTIES = %w[priority status location notes].freeze
+    DATE_PROPERTIES = %w[due defer].freeze
+    ARRAY_PROPERTIES = %w[externals urls tasks done].freeze
+
+    ALL_PROPERTIES = STRING_PROPERTIES + DATE_PROPERTIES + ARRAY_PROPERTIES
+
+    attr_reader :name, *ALL_PROPERTIES
 
     def initialize(options)
       @name = options["project"]
 
-      @tasks = options["tasks"] || []
-      @done = options["done"] || []
+      ALL_PROPERTIES.each do |o|
+        instance_variable_set("@#{o}", options[o]) if options[o]
+      end
 
-      @notes = options["notes"] if options["notes"]
-      @priority = PROJECT_PRIORITY[options["priority"] || "medium"]
-      @location = options["location"] if options["location"]
-      @status = options["status"] if options["status"]
+      # The "priority" concept feels flawed - it requires *me* to figure out
+      # the priority, as opposed to the program understanding the project in
+      # relation to other tasks. If I truly understood the priority of all the
+      # projects, I wouldn't need a todo list program. The point is to remove
+      # the need for willpower/executive function/coffee. The long-term value
+      # of this field will diminish as I add more project properties that can
+      # automatically hone in on the most important items based on due
+      # date/external commits/penalties for project failure, etc
+      #
+      # Assume all projects are low priority unless stated otherwise.
+      @priority ||= "low"
     end
 
     def <=>(other)
@@ -94,20 +130,15 @@ module Plansheet
         # TODO: if planning status, then sort based on tasks? category? alphabetically?
         PROJECT_STATUS_PRIORITY[status] <=> PROJECT_STATUS_PRIORITY[other.status]
       else
-        @priority <=> other.priority
+        PROJECT_PRIORITY[@priority] <=> PROJECT_PRIORITY[other.priority]
       end
     end
 
-    # TODO: clean up priority handling
-    def priority_string
-      PROJECT_PRIORITY_REV[@priority]
-    end
-
     def status
       return @status if @status
 
-      if @tasks.count.positive?
-        if @done.count.positive?
+      if @tasks&.count&.positive?
+        if @done&.count&.positive?
           "wip"
         else
           "planning"
@@ -120,29 +151,52 @@ module Plansheet
     def to_s
       str = String.new
       str << "# #{@name}\n"
-      str << "priority: #{priority_string}\n"
-      str << "status: #{status}\n"
-      str << "notes: #{notes}\n" unless @notes.nil?
-      str << "location: #{location}\n" unless @location.nil?
-      str << "tasks:\n" unless @tasks.empty?
-      @tasks.each do |t|
-        str << "- #{t}\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
-      str << "done:\n" unless @done.empty?
-      @done.each do |d|
-        str << "- #{d}\n"
+    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
 
     def to_h
       h = { "project" => @name }
-      h["priority"] = priority_string unless priority_string == "medium"
-      h["status"] = status unless status == "idea"
-      h["notes"] = @notes unless @notes.nil?
-      h["location"] = @location unless @location.nil?
-      h["tasks"] = @tasks unless @tasks.empty?
-      h["done"] = @done unless @done.empty?
+      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
@@ -153,7 +207,7 @@ module Plansheet
     def initialize(path)
       @path = path
       # TODO: this won't GC, inline validation instead?
-      @raw = YAML.load_file(path)
+      @raw = YAML.load_file(path, permitted_classes: [Date])
       validate_schema
       @projects = @raw.map { |proj| Project.new proj }
     end
@@ -164,7 +218,7 @@ module Plansheet
       # Check YAML validity
       return unless errors && !errors.empty?
 
-      $stderr.write "Schema errors in #{l}\n"
+      $stderr.write "Schema errors in #{@path}:\n"
       errors.each { |err| puts "- [#{err.path}] #{err.message}" }
       abort
     end

data/lib/plansheet/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plansheet
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-31 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dc-kwalify
@@ -33,6 +33,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock