plansheet 0.13.2 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76e5120430c540166b342a58cf0a0c07dfaf773d0a46b1dcd05614be677fe1a6
-  data.tar.gz: 83eb24c7811f8e1e49d8f7f79a059c1451673907460203d95a5c28e98fbc74c2
+  metadata.gz: f121593269dc11059fe547d8b72d58c2ad1a6685ae4826ac39daaff8b33f7c9a
+  data.tar.gz: 4020dab046e837f02b64cfc975408240d472b04a26bc6f40e7e552d915d77336
 SHA512:
-  metadata.gz: 71d3b9dad2c16601ef4472805c282cbfced288e0fc1cee42b0b2e6cb508c5aa255a688c3301fbdee38ae5188f36a2d65cbee2ebc9aa3290771a8f2a2f84854ac
-  data.tar.gz: bc7d994b5d320c0c9f7ed53ca625afb6f586f228a48f16e2e9f1b2f392cae4cb1e1cef45ddc305069fb06a59a8e1fa9cf2324c1dc4a322e411f801d5802c41fe
+  metadata.gz: ae82c5c2df93d55e520262754cc1c6e8b1b80a9a2fe230c09d00bd7ed4a38790c71b0dfcde5ac178e38112a26284219f21a8d99e48212601bbbcfae98607c0d1
+  data.tar.gz: 6ca757244abd515dcd86bbedb5a31590a53fbc8720e35167549bfe326c1f96673acef49b0dd1044a0e92f43253ef1442d126872859cebfa0f1185bb06612da59

data/Gemfile.lock

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

data/exe/plansheet

@@ -25,18 +25,17 @@ options = {}
 parser.parse!(into: options)
 
 config = Plansheet.load_config
+pool = Plansheet::Pool.new({ projects_dir: config["projects_dir"] })
 
 if options[:sheet] || options.empty?
-  project_arr = Plansheet.load_projects_dir config["projects_dir"]
-
   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[: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,53 @@
+# frozen_string_literal: true
+
+module Plansheet
+  # The "pool" is the aggregated collection of projects, calendar events, etc.
+  class Pool
+    attr_accessor :projects
+
+    def initialize(config)
+      @projects_dir = config[:projects_dir]
+      # @completed_projects_dir = config(:completed_projects_dir)
+
+      load_projects_dir(@projects_dir)
+      # TODO: Slurp all files
+      sort_projects
+    end
+
+    def sort_projects
+      @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|
+        # TODO: move this to ProjectYAMLFile
+        #
+        f = "#{@projects_dir}/#{ns}.yml"
+        pyf = ProjectYAMLFile.new f
+        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

@@ -16,11 +16,9 @@ module Plansheet
           "project":
             desc: Project name
             type: str
-            required: yes
           "namespace":
-            desc: Namespace of a group of projects (for organizing)
+            desc: Project name
             type: str
-            required: yes
           "priority":
             desc: Project priority
             type: str
@@ -114,17 +112,19 @@ 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
@@ -133,6 +133,7 @@ module Plansheet
         proj["namespace"] = namespace
         Project.new proj
       end
+      @projects
     end
 
     def namespace
@@ -155,8 +156,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.except("namespace") })
     end
   end
 end

data/lib/plansheet/project.rb

@@ -49,16 +49,18 @@ module Plansheet
     ].map { |x| "compare_#{x}".to_sym }.freeze
     # NOTE: The order of these affects presentation!
     # namespace is derived from file name
-    STRING_PROPERTIES = %w[namespace priority status location notes time_estimate frequency lead_time].freeze
+    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_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]
@@ -220,7 +222,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/version.rb

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

data/lib/plansheet.rb

@@ -2,6 +2,7 @@
 
 require_relative "plansheet/version"
 require_relative "plansheet/project"
+require_relative "plansheet/pool"
 require_relative "plansheet/sheet"
 require "yaml"
 require "kwalify"
@@ -9,28 +10,10 @@ 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.13.2
+  version: 0.15.0
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dc-kwalify
@@ -43,6 +43,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