plansheet 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3546f42fdd342ea128be90bff2e19b7bcb5c0910990e2132b89b87cbf6a1f776
-  data.tar.gz: 2ea5d505262832e19e77a63e7aa7c59c9fff0b98ddc3ee8218c68b010f4768eb
+  metadata.gz: 98932ed8f5a5d06da4b2f6135d1321e5376a1af2f837d4a65b9f806c7f06b8d9
+  data.tar.gz: 0ef6f026f7bcbc4712d008ca2843a0b5a9d1715038b2fc91534a8c9951697ec6
 SHA512:
-  metadata.gz: 335cb1a3e74ab82a1441ec034099427dc0caabaad8a87c1f2620c7143d1fd4772023fe089a7305063fb12a96d169e44dd0b01f8f20437f45bdfa945b03aa2422
-  data.tar.gz: 5d618d61c6a07d8e32e46cfb4dba5df0264370f01d8b4ecef4c68f9fdcf6fcf600ca33bda0a8918e63992434e2a009e4d836f1f838851e0ee94de53128fe1ab2
+  metadata.gz: 95217512c48168c26ef2c5f937dd8b94530bccea1149c2e90df1db039243b9ffb4582efe26ea14ae6393845daa4d8f5a4fec36cff82231d7b6ab6fc6a1255ff6
+  data.tar.gz: '095dcda8264517252297a7aba139f8c51bddfbe04880acb9a16d2eb3f4a479003e1ee453902acf65fde2ad89720b522b6d6bd118e3f1f3202f2aab9f9ec50d04'

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,26 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-06-02 13:34:43 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: 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.5.1)
+    plansheet (0.7.0)
       dc-kwalify (~> 1.0)
 
 GEM

data/exe/plansheet

@@ -32,7 +32,7 @@ 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.each do |proj|
+  project_arr.sort.each do |proj|
     puts proj
     puts "\n"
   end

data/lib/plansheet/project.rb

@@ -13,6 +13,12 @@ module Plansheet
     "done" => 7
   }.freeze
 
+  PROJECT_PRIORITY = {
+    "high" => 1,
+    "medium" => 2,
+    "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
@@ -25,6 +31,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
@@ -38,15 +51,22 @@ 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 (not currently implemented)
-            type: str
-            enum:
-              - high
-              - low
           "location":
-            desc: Location (not currently implemented)
+            desc: Location
             type: str
+          "notes":
+            desc: Free-form notes string
+            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
@@ -57,30 +77,60 @@ 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
-    attr_reader :name, :tasks, :done, :notes, :location
+    include Comparable
+
+    # NOTE: The order of these affects presentation!
+    STRING_PROPERTIES = %w[priority status location notes].freeze
+    ARRAY_PROPERTIES = %w[externals urls tasks done].freeze
+
+    ALL_PROPERTIES = STRING_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
+
+      # 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
 
-      @notes = options["notes"] if options["notes"]
-      @location = options["location"] if options["location"]
-      @status = options["status"] if options["status"]
+    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]
+      end
     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"
@@ -92,27 +142,42 @@ module Plansheet
 
     def to_s
       str = String.new
-      str <<  "# #{@name}\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"
+      str << "# #{@name}\n"
+      STRING_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
-      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["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
@@ -132,17 +197,15 @@ module Plansheet
       validator = Kwalify::Validator.new(Plansheet::PROJECT_SCHEMA)
       errors = validator.validate(@raw)
       # Check YAML validity
-      if errors && !errors.empty?
-        $stderr.write "Schema errors in #{l}\n"
-        errors.each { |err| puts "- [#{err.path}] #{err.message}" }
-        abort
-      end
+      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_by! do |project|
-        Plansheet::PROJECT_STATUS_PRIORITY[project.status]
-      end
+      @projects.sort!
     end
 
     def yaml_dump

data/lib/plansheet/sheet.rb

@@ -5,9 +5,7 @@ module Plansheet
   # The Sheet class constructs a Markdown/LaTeX file for use with pandoc
   class Sheet
     def initialize(output_file, project_arr)
-      sorted_arr = project_arr.sort_by do |p|
-        Plansheet::PROJECT_STATUS_PRIORITY[p.status]
-      end
+      sorted_arr = project_arr.sort!
 
       projects_str = String.new
       projects_str << sheet_header

data/lib/plansheet/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plansheet
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 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