plansheet 0.15.0 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f121593269dc11059fe547d8b72d58c2ad1a6685ae4826ac39daaff8b33f7c9a
-  data.tar.gz: 4020dab046e837f02b64cfc975408240d472b04a26bc6f40e7e552d915d77336
+  metadata.gz: 4c094d7236b6603dcab810d785eab766754e0cd9f161a2cb2daf280962b41026
+  data.tar.gz: 2686468ff7aa21915ff73ff27c49990cd05c2dc4e75c139837a69c1580a49dd5
 SHA512:
-  metadata.gz: ae82c5c2df93d55e520262754cc1c6e8b1b80a9a2fe230c09d00bd7ed4a38790c71b0dfcde5ac178e38112a26284219f21a8d99e48212601bbbcfae98607c0d1
-  data.tar.gz: 6ca757244abd515dcd86bbedb5a31590a53fbc8720e35167549bfe326c1f96673acef49b0dd1044a0e92f43253ef1442d126872859cebfa0f1185bb06612da59
+  metadata.gz: 646ede4ae64522cfc33912eaefae96083de293800647700ec04b2569fe305d40bf7855a0780c63262db5fdaa5adf8472dba4790bd5f0b60228acc7a921b84417
+  data.tar.gz: 0c56e57fa79c225d9c3edf055e5c033e9bb9c5b63a49d2d1e7ae1bc17e3c1298e086af4c06d88d270fe9a6e83f3d6f67bba6c4f65f09afbcaf80ed46570f4a3f

data/Gemfile

@@ -10,6 +10,7 @@ group :development, optional: true do
   gem "guard-minitest", "~> 2.4"
   gem "minitest", "~> 5.0"
   gem "rake", "~> 13.0"
+  gem "rdoc"
 
   gem "rubocop", "~> 1.21"
   gem "rubocop-minitest"

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    plansheet (0.15.0)
+    plansheet (0.17.1)
       dc-kwalify (~> 1.0)
+      rgl (= 0.5.8)
 
 GEM
   remote: https://rubygems.org/
@@ -12,6 +13,7 @@ GEM
     dc-kwalify (1.0.0)
     ffi (1.15.5)
     formatador (1.1.0)
+    generator (0.0.1)
     guard (2.18.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -25,6 +27,7 @@ GEM
     guard-minitest (2.4.6)
       guard-compat (~> 1.2)
       minitest (>= 3.0)
+    lazy_priority_queue (0.1.1)
     listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
@@ -41,13 +44,21 @@ GEM
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    psych (4.0.4)
+      stringio
     rainbow (3.1.1)
     rake (13.0.6)
     rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
+    rdoc (6.4.0)
+      psych (>= 4.0.0)
     regexp_parser (2.4.0)
     rexml (3.2.5)
+    rgl (0.5.8)
+      lazy_priority_queue (~> 0.1.0)
+      rexml (~> 3.2, >= 3.2.4)
+      stream (~> 0.5.3)
     rubocop (1.29.1)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
@@ -65,6 +76,9 @@ GEM
       rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
     shellany (0.0.1)
+    stream (0.5.4)
+      generator
+    stringio (3.0.2)
     thor (1.2.1)
     unicode-display_width (2.1.0)
 
@@ -77,6 +91,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   plansheet!
   rake (~> 13.0)
+  rdoc
   rubocop (~> 1.21)
   rubocop-minitest
   rubocop-rake

data/exe/plansheet

@@ -17,6 +17,10 @@ parser.on(
   "--cli",
   "CLI dump of projects (WIP)"
 )
+parser.on(
+  "--calendar",
+  "List of projects ordered by due date"
+)
 parser.on(
   "--location_filter LOCATION",
   "location filter for CLI dump (WIP)"
@@ -25,14 +29,26 @@ options = {}
 parser.parse!(into: options)
 
 config = Plansheet.load_config
-pool = Plansheet::Pool.new({ projects_dir: config["projects_dir"] })
+pool = Plansheet::Pool.new({ projects_dir: config["projects_dir"],
+                             sort_order: config["sort_order"] })
 
 if options[:sheet] || options.empty?
+  require "plansheet/sheet"
   Dir.mkdir config["output_dir"] unless Dir.exist? config["output_dir"]
   Plansheet::Sheet.new("#{config["output_dir"]}/projects.md", pool.projects)
 elsif options[:sort]
   # Pool sorts projects, this now just matches old behaviour
   pool.write_projects
+elsif options[:calendar]
+  # TODO: add a project filter method
+  project_arr = pool.projects
+  project_arr.delete_if { |x| x.status == "dropped" || x.status == "done" }
+  project_arr.delete_if { |x| x.due.nil? }
+  project_arr.sort_by!(&:due)
+  project_arr.each do |proj|
+    puts proj
+    puts "\n"
+  end
 elsif options[:cli]
   # TODO: add a project filter method
   project_arr = pool.projects

data/lib/plansheet/pool.rb

@@ -1,21 +1,75 @@
 # frozen_string_literal: true
 
+require "rgl/adjacency"
+require "rgl/topsort"
+
 module Plansheet
   # The "pool" is the aggregated collection of projects, calendar events, etc.
   class Pool
     attr_accessor :projects
 
+    DEFAULT_COMPARISON_ORDER = %w[
+      completeness
+      dependency
+      priority
+      defer
+      due
+      status
+    ].freeze
+
     def initialize(config)
       @projects_dir = config[:projects_dir]
+      @sort_order = config[:sort_order]
       # @completed_projects_dir = config(:completed_projects_dir)
 
+      # This bit of trickiness is because we don't know what the sort order is
+      # until runtime. I'm sure this design decision definitely won't bite me
+      # in the future ;-) Fortunately, it's also not a problem that can't be
+      # walked back from.
+      if config[:sort_order]
+        self.class.const_set("POOL_COMPARISON_ORDER", config[:sort_order])
+      else
+        self.class.const_set("POOL_COMPARISON_ORDER", Plansheet::Pool::DEFAULT_COMPARISON_ORDER)
+      end
+      require_relative "project"
       load_projects_dir(@projects_dir)
-      # TODO: Slurp all files
       sort_projects
     end
 
     def sort_projects
       @projects.sort!
+      # lookup_hash returns the index of a project
+      lookup_hash = Hash.new nil
+
+      # initialize the lookups
+      @projects.each_index do |i|
+        lookup_hash[@projects[i].name] = i
+      end
+
+      pg = RGL::DirectedAdjacencyGraph.new
+      pg.add_vertices @projects
+      @projects.each_index do |proj_index|
+        next if @projects[proj_index].dropped_or_done?
+
+        @projects[proj_index]&.dependencies&.each do |dep|
+          di = lookup_hash[dep]
+          if di
+            # Don't add edges for dropped/done projects, they'll be sorted out
+            # later
+            next if @projects[di].dropped_or_done?
+
+            pg.add_edge(@projects[di], @projects[proj_index])
+          end
+        end
+      end
+
+      # The topological sort of pg is the correct dependency order of the
+      # projects
+      @projects = pg.topsort_iterator.to_a.flatten.uniq
+
+      # TODO: second sort doesn't deal with problems where deferred task gets
+      # pushed below.
+      @projects.sort!
     end
 
     def project_namespaces
@@ -31,10 +85,7 @@ module Plansheet
       # are involved once completed project directories are a thing - will need
       # to keep a list of project files to delete
       project_namespaces.each do |ns|
-        # TODO: move this to ProjectYAMLFile
-        #
-        f = "#{@projects_dir}/#{ns}.yml"
-        pyf = ProjectYAMLFile.new f
+        pyf = ProjectYAMLFile.new "#{@projects_dir}/#{ns}.yml"
         pyf.projects = projects_in_namespace(ns)
         pyf.write
       end

data/lib/plansheet/project/yaml.rb

@@ -4,6 +4,8 @@ require "yaml"
 require "date"
 require "pathname"
 
+require "kwalify"
+
 module Plansheet
   # Once there's some stability in plansheet and dc-kwalify, will pre-load this
   # to save the later YAML.load
@@ -161,7 +163,7 @@ module Plansheet
     end
 
     def yaml_dump
-      YAML.dump(@projects.map { |x| x.to_h.except("namespace") })
+      YAML.dump(@projects.map { |x| x.to_h.delete_if { |k, _| k == "namespace" } })
     end
   end
 end

data/lib/plansheet/project.rb

@@ -17,12 +17,6 @@ module Plansheet
     "done" => 8
   }.freeze
 
-  PROJECT_PRIORITY = {
-    "high" => 1,
-    "medium" => 2,
-    "low" => 3
-  }.freeze
-
   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]/)
@@ -39,14 +33,13 @@ module Plansheet
   class Project
     include Comparable
 
-    DEFAULT_COMPARISON_ORDER = %w[
-      completeness
-      dependency
-      priority
-      defer
-      due
-      status
-    ].map { |x| "compare_#{x}".to_sym }.freeze
+    PROJECT_PRIORITY = {
+      "high" => 1,
+      "medium" => 2,
+      "low" => 3
+    }.freeze
+
+    COMPARISON_ORDER_SYMS = Plansheet::Pool::POOL_COMPARISON_ORDER.map { |x| "compare_#{x}".to_sym }.freeze
     # NOTE: The order of these affects presentation!
     # namespace is derived from file name
     STRING_PROPERTIES = %w[priority status location notes time_estimate frequency lead_time].freeze
@@ -55,7 +48,7 @@ module Plansheet
 
     ALL_PROPERTIES = STRING_PROPERTIES + DATE_PROPERTIES + ARRAY_PROPERTIES
 
-    attr_reader :name, *ALL_PROPERTIES
+    attr_reader :name, :priority_val, *ALL_PROPERTIES
     attr_accessor :namespace
 
     def initialize(options)
@@ -76,12 +69,16 @@ module Plansheet
       # date/external commits/penalties for project failure, etc
       #
       # Assume all projects are low priority unless stated otherwise.
-      @priority ||= "low"
+      @priority_val = if @priority
+                        PROJECT_PRIORITY[@priority]
+                      else
+                        PROJECT_PRIORITY["low"]
+                      end
     end
 
     def <=>(other)
       ret_val = 0
-      DEFAULT_COMPARISON_ORDER.each do |method|
+      COMPARISON_ORDER_SYMS.each do |method|
         ret_val = send(method, other)
         break if ret_val != 0
       end
@@ -89,7 +86,7 @@ module Plansheet
     end
 
     def compare_priority(other)
-      PROJECT_PRIORITY[@priority] <=> PROJECT_PRIORITY[other.priority]
+      priority_val <=> other.priority_val
     end
 
     def compare_status(other)
@@ -117,19 +114,25 @@ module Plansheet
       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
+    def dependency_of?(other)
+      other&.dependencies&.any? do |dep|
+        @name&.downcase == dep.downcase
       end
-      0
+    end
+
+    def dependent_on?(other)
+      @dependencies&.any? do |dep|
+        other&.name&.downcase == dep.downcase
+      end
+    end
+
+    def compare_dependency(other)
+      # This approach might seem odd,
+      # but it's to handle circular dependencies
+      retval = 0
+      retval -= 1 if dependency_of?(other)
+      retval += 1 if dependent_on?(other)
+      retval
     end
 
     # Projects that are dropped or done are considered "complete", insofar as

data/lib/plansheet/sheet.rb

@@ -5,12 +5,10 @@ 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!
-
       projects_str = String.new
       projects_str << sheet_header
 
-      sorted_arr.each do |p|
+      project_arr.each do |p|
         projects_str << project_minipage(p)
       end
       puts "Writing to #{output_file}"
@@ -41,8 +39,9 @@ module Plansheet
 
     def project_header(proj)
       str = String.new
-      str << "#{proj.name} - #{proj.status}"
+      str << "#{proj.namespace}: #{proj.name} - #{proj.status}"
       str << " - #{proj.location}" if proj.location
+      str << " - due #{proj.due}" if proj.due
       str << " \\\\\n"
       str
     end

data/lib/plansheet/version.rb

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

data/lib/plansheet.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "plansheet/version"
-require_relative "plansheet/project"
 require_relative "plansheet/pool"
-require_relative "plansheet/sheet"
 require "yaml"
-require "kwalify"
 
 module Plansheet
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plansheet
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.17.1
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-09 00:00:00.000000000 Z
+date: 2022-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dc-kwalify
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rgl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.8
 description: Convert YAML project files into a nice PDF
 email:
 - dave@dafyddcrosby.com