plansheet 0.12.3 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72d3799f5166153c1775c768f0734cf0e390adfd80893ef1ae1aa710b7888b0b
-  data.tar.gz: a18fd6eeb6a787438ddcdff1e6b0f25a17688f05a7bccff82495520517754b19
+  metadata.gz: 4c094d7236b6603dcab810d785eab766754e0cd9f161a2cb2daf280962b41026
+  data.tar.gz: 2686468ff7aa21915ff73ff27c49990cd05c2dc4e75c139837a69c1580a49dd5
 SHA512:
-  metadata.gz: c97c83093f8e70948a96392b5d02329128c5f1031a0645b35b9c42bebeabb82192207c3ff71671081792ef3d61e9277c219984f0f558a7b54c1fac632fa68445
-  data.tar.gz: 6723401a02c2086976e1002e4f8d08855f25726d1610fd9f4e593ae3ceac707c47bb6a1114ec1b40f707295c1c627fd5b72cce5ebe45f84b78b24d8304107bcf
+  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.12.3)
+    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,18 +29,29 @@ options = {}
 parser.parse!(into: options)
 
 config = Plansheet.load_config
+pool = Plansheet::Pool.new({ projects_dir: config["projects_dir"],
+                             sort_order: config["sort_order"] })
 
 if options[:sheet] || options.empty?
-  project_arr = Plansheet.load_projects_dir config["projects_dir"]
-
+  require "plansheet/sheet"
   Dir.mkdir config["output_dir"] unless Dir.exist? config["output_dir"]
-
-  Plansheet::Sheet.new("#{config["output_dir"]}/projects.md", project_arr)
+  Plansheet::Sheet.new("#{config["output_dir"]}/projects.md", pool.projects)
 elsif options[:sort]
-  Plansheet.resort_projects_in_dir config["projects_dir"]
+  # 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]
-  project_arr = Plansheet.load_projects_dir config["projects_dir"]
-  project_arr.sort!
+  # TODO: add a project filter method
+  project_arr = pool.projects
   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|

data/lib/plansheet/pool.rb

@@ -0,0 +1,104 @@
+# 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)
+      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
+      @projects.collect(&:namespace).uniq.sort
+    end
+
+    def projects_in_namespace(namespace)
+      @projects.select { |x| x.namespace == namespace }
+    end
+
+    def write_projects
+      # TODO: This leaves potential for duplicate projects where empty files
+      # 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|
+        pyf = ProjectYAMLFile.new "#{@projects_dir}/#{ns}.yml"
+        pyf.projects = projects_in_namespace(ns)
+        pyf.write
+      end
+    end
+
+    def load_projects_dir(dir)
+      project_arr = []
+      projects = Dir.glob("*yml", base: dir)
+      projects.each do |l|
+        project_arr << ProjectYAMLFile.new(File.join(dir, l)).load_file
+      end
+
+      @projects = project_arr.flatten!
+    end
+  end
+end

data/lib/plansheet/project/stringify.rb

@@ -4,7 +4,9 @@ module Plansheet
   class Project
     def to_s
       str = String.new
-      str << "# #{@name}\n"
+      str << "# "
+      str << "#{@namespace} - " if @namespace
+      str << "#{@name}\n"
       STRING_PROPERTIES.each do |o|
         str << stringify_string_property(o)
       end

data/lib/plansheet/project/yaml.rb

@@ -2,6 +2,9 @@
 
 require "yaml"
 require "date"
+require "pathname"
+
+require "kwalify"
 
 module Plansheet
   # Once there's some stability in plansheet and dc-kwalify, will pre-load this
@@ -15,7 +18,9 @@ module Plansheet
           "project":
             desc: Project name
             type: str
-            required: yes
+          "namespace":
+            desc: Project name
+            type: str
           "priority":
             desc: Project priority
             type: str
@@ -109,21 +114,33 @@ module Plansheet
   PROJECT_SCHEMA = YAML.safe_load(PROJECT_YAML_SCHEMA)
 
   class ProjectYAMLFile
-    attr_reader :projects
+    attr_accessor :projects
 
     def initialize(path)
       @path = path
       # TODO: this won't GC, inline validation instead?
+    end
 
+    def load_file
       # 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])
+               YAML.load_file(@path, permitted_classes: [Date])
              else
-               YAML.load_file(path)
+               YAML.load_file(@path)
              end
 
       validate_schema
-      @projects = @raw.map { |proj| Project.new proj }
+      @raw ||= []
+      @projects = @raw.map do |proj|
+        proj["namespace"] = namespace
+        Project.new proj
+      end
+      @projects
+    end
+
+    def namespace
+      # TODO: yikes
+      ::Pathname.new(@path).basename.to_s.gsub(/\.yml$/, "")
     end
 
     def validate_schema
@@ -141,8 +158,12 @@ module Plansheet
       @projects.sort!
     end
 
+    def write
+      File.write @path, yaml_dump
+    end
+
     def yaml_dump
-      YAML.dump(@projects.map(&:to_h))
+      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,25 +33,27 @@ 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
     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
 
-    attr_reader :name, *ALL_PROPERTIES
+    attr_reader :name, :priority_val, *ALL_PROPERTIES
+    attr_accessor :namespace
 
     def initialize(options)
       @name = options["project"]
+      @namespace = options["namespace"]
 
       ALL_PROPERTIES.each do |o|
         instance_variable_set("@#{o}", options[o]) if options[o]
@@ -73,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
@@ -86,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)
@@ -114,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
@@ -219,7 +225,7 @@ module Plansheet
     end
 
     def to_h
-      h = { "project" => @name }
+      h = { "project" => @name, "namespace" => @namespace }
       ALL_PROPERTIES.each do |prop|
         h[prop] = instance_variable_get("@#{prop}") if instance_variable_defined?("@#{prop}")
       end

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.12.3"
+  VERSION = "0.17.1"
 end

data/lib/plansheet.rb

@@ -1,36 +1,16 @@
 # frozen_string_literal: true
 
 require_relative "plansheet/version"
-require_relative "plansheet/project"
-require_relative "plansheet/sheet"
+require_relative "plansheet/pool"
 require "yaml"
-require "kwalify"
 
 module Plansheet
   class Error < StandardError; end
 
+  # TODO: config schema validation
   def self.load_config
     YAML.load_file "#{Dir.home}/.plansheet.yml"
   rescue StandardError
     abort "unable to load plansheet config file"
   end
-
-  def self.resort_projects_in_dir(dir)
-    project_files = Dir.glob("#{dir}/*yml")
-    project_files.each do |f|
-      pyf = ProjectYAMLFile.new(f)
-      pyf.sort!
-      File.write(f, pyf.yaml_dump)
-    end
-  end
-
-  def self.load_projects_dir(dir)
-    project_arr = []
-    projects = Dir.glob("*yml", base: dir)
-    projects.each do |l|
-      project_arr << ProjectYAMLFile.new(File.join(dir, l)).projects
-    end
-
-    project_arr.flatten!
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plansheet
 version: !ruby/object:Gem::Version
-  version: 0.12.3
+  version: 0.17.1
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-06 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
@@ -43,6 +57,7 @@ files:
 - examples/backpack.yml
 - exe/plansheet
 - lib/plansheet.rb
+- lib/plansheet/pool.rb
 - lib/plansheet/project.rb
 - lib/plansheet/project/stringify.rb
 - lib/plansheet/project/yaml.rb