plansheet 0.7.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9c1a116df170c31d73c29dce213b757743c0e49bbee8c86a47ce7ce09009730
-  data.tar.gz: 2baeb58d82c15823d9beb3e6504bb452e14cabded159f9931bf2300fdaed5d8f
+  metadata.gz: a8132e26b8647ea119299716b5f88674af3e4264614f7b881133eb6cbd32d7db
+  data.tar.gz: c04f8bf586f6866acf03e809ab581b8010b6fb64be486791abb5fdd3274ae6e2
 SHA512:
-  metadata.gz: a87a4f7386a651ca82d385600f7b32ee78ff436406d596b6c2966ed721bdcee16f9bd4ad73b158be03305541dceda0d525e68ea2dc520a028fb603a6b5f0c1c0
-  data.tar.gz: d679906ef154e9b84e9282e1811ac0dff8da8b4dfb17c6e0e24d7f08226933346c4229468ddf51526e7532af7bdfd9a502557b64efc6439c128716a380e86d86
+  metadata.gz: 6426deb869f89a6ff87d5f760acbab8687a542dd3942cf829c536ceb49c3a8268b18ab188d0ad0cb91457fa435963eb7193dd9844a283ccdfb4114e4dece54d8
+  data.tar.gz: 4c03feeae9aed94d4e4df6c931c1317039f1100e67d7475cdbf8b67dae14e753899853291ad46f025e198d93def4b9c67c0c12da24d352d8db0880ae5ebb2f99

data/.rubocop_todo.yml

@@ -1,17 +1,22 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-06-02 13:59:36 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:
+  Max: 105
+
 # Offense count: 1
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
   Max: 8
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Max: 12

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.1)
+    plansheet (0.9.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/lib/plansheet/project.rb

@@ -59,11 +59,16 @@ module Plansheet
             desc: Free-form notes string
             type: str
           "due":
-            desc: Due date of the task (WIP)
+            desc: Due date of the task
             type: date
           "defer":
-            desc: Defer task until this day (WIP)
+            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
@@ -99,7 +104,7 @@ module Plansheet
     # 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
+    ARRAY_PROPERTIES = %w[dependencies externals urls tasks done].freeze
 
     ALL_PROPERTIES = STRING_PROPERTIES + DATE_PROPERTIES + ARRAY_PROPERTIES
 
@@ -126,12 +131,70 @@ 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]
+      ret_val = 0
+      %i[
+        compare_completeness
+        compare_dependency
+        compare_priority
+        compare_due
+        compare_defer
+        compare_status
+      ].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? {|dep|
+          @name.downcase == dep.downcase
+        }
       else
-        PROJECT_PRIORITY[@priority] <=> PROJECT_PRIORITY[other.priority]
+        return 1 if @dependencies.any? {|dep|
+          other.name.downcase == dep.downcase
+        }
       end
+      return 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
     end
 
     def status
@@ -148,6 +211,10 @@ module Plansheet
       end
     end
 
+    def dropped_or_done?
+      status == "dropped" || status == "done"
+    end
+
     def to_s
       str = String.new
       str << "# #{@name}\n"
@@ -207,7 +274,14 @@ module Plansheet
     def initialize(path)
       @path = path
       # TODO: this won't GC, inline validation instead?
-      @raw = YAML.load_file(path, permitted_classes: [Date])
+
+      # 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

@@ -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.1"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plansheet
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.9.0
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-02 00:00:00.000000000 Z
+date: 2022-06-04 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