plansheet 0.26.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4064aa7163d4ad0b941b17a4b3f10541fde5188d2b84e1c5b8fe43fd82eadbb
-  data.tar.gz: a67509fae6401fd25e42ab35ef810a0bba0f82f73173ab2a5061206b2e4d9f62
+  metadata.gz: e590a914b9d074b7ce833d04aac6e5320684c15a398c1c88d5774ae884cad297
+  data.tar.gz: 7e7d5004b022e6286e0e7792b9392b95c1536c398c7915a2534ead4dbf364080
 SHA512:
-  metadata.gz: b4d07c885342474b0205fceec3e625fc000dd92b164987eaab1603ce453d1e7473c3281a30047470d8c15f7e4dce9e587f1c19365a0d7a56a12b93478f038024
-  data.tar.gz: 7ab35b12fcdc63e00d0dd6e2b2b54e4d27634d1b950c2298c55886b3f8c461cc272bbb507404edfad156ff646148802f099d3c1a054bd000284622f1f1e9ce72
+  metadata.gz: 4f03c2eaa802dd20a82180ab4a3ad2b23b2a3b69d6e7536f81a42305a3aab486175e18c767a9cb5b919a7c8d5d7e5a22032253e19b95d47d19c64a4583fd150f
+  data.tar.gz: 6a1923c54d08ba01d33dbfb8d0c76b813fb57b65edba8d79fd002db43b9c63299a301c763acb5084ab5d1e9a773af24be12b15d5f5c2d4fad3b009f820939cfa

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plansheet (0.26.0)
+    plansheet (0.27.0)
       dc-kwalify (~> 1.0)
       diffy (= 3.4.2)
       rgl (= 0.5.8)

data/lib/plansheet/pool.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "pathname"
 require "rgl/adjacency"
 require "rgl/topsort"
 
@@ -23,7 +24,6 @@ module Plansheet
     def initialize(config, debug: false)
       @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
@@ -77,6 +77,25 @@ module Plansheet
       @projects.sort!
     end
 
+    def archive_projects
+      archive_dir = "#{@projects_dir}/archive/"
+      Dir.mkdir archive_dir unless Dir.exist? archive_dir
+
+      # NOTE: It would save writes if we sorted and did all month/namespaces
+      # writes only once, but as the normal case only sees a few projects
+      # archived at a time, I'll leave that for someone else to implement ;-)
+      projects_to_archive = @projects.select(&:archivable?)
+      projects_to_archive.each do |project|
+        path = Pathname.new "#{archive_dir}/#{project.completed_on_month}/#{project.namespace}.yml"
+        Dir.mkdir path.dirname unless path.dirname.exist?
+        pyf = ProjectYAMLFile.new path
+        pyf.append_project project
+      end
+
+      # Now that the projects have been archived, remove them from the pool
+      @projects.reject!(&:archivable?)
+    end
+
     def project_namespaces
       @projects.collect(&:namespace).uniq.sort
     end
@@ -86,12 +105,16 @@ module Plansheet
     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|
+      # Collect the namespaces *before* archiving is done, for the case where
+      # all active projects in a namespace have been completed and archived
+      namespaces_before_archiving = project_namespaces
+
+      archive_projects
+
+      namespaces_before_archiving.each do |ns|
+        projects = projects_in_namespace(ns)
         pyf = ProjectYAMLFile.new "#{@projects_dir}/#{ns}.yml"
-        pyf.compare_and_write projects_in_namespace(ns)
+        pyf.compare_and_write projects
       end
     end
 

data/lib/plansheet/project/yaml.rb

@@ -4,6 +4,7 @@ require "yaml"
 require "date"
 require "pathname"
 
+require "diffy"
 require "kwalify"
 
 module Plansheet
@@ -152,7 +153,13 @@ module Plansheet
       # TODO: this won't GC, inline validation instead?
     end
 
+    def stub_file
+      File.write @path, YAML.dump([])
+    end
+
     def load_file
+      stub_file unless File.exist? @path
+
       # 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])
@@ -189,16 +196,22 @@ module Plansheet
       @projects.sort!
     end
 
+    def append_project(project)
+      load_file
+      compare_and_write(@projects.append(project))
+    end
+
     def compare_and_write(projects)
+      load_file
+      orig_string = yaml_dump(@projects)
       updated_projects_string = yaml_dump(projects)
 
       # Compare the existing file to the newly generated one - we only want a
       # write if something has changed
-      return if updated_projects_string == yaml_dump(load_file)
+      return if updated_projects_string == orig_string
 
       puts "#{@path} has changed, writing"
-      require "diffy"
-      puts Diffy::Diff.new(yaml_dump(load_file), updated_projects_string).to_s(:color)
+      puts Diffy::Diff.new(orig_string, updated_projects_string).to_s(:color)
       File.write @path, updated_projects_string
     end
 

data/lib/plansheet/project.rb

@@ -155,6 +155,10 @@ module Plansheet
       end
     end
 
+    def completed_on_month
+      @completed_on&.strftime("%Y-%m")
+    end
+
     def yearly_minutes_saved
       if @daily_time_roi
         Plansheet.parse_time_duration(@daily_time_roi) * 365
@@ -354,6 +358,10 @@ module Plansheet
       status == "done"
     end
 
+    def archivable?
+      !recurring? && @completed_on
+    end
+
     def self.task_time_estimate(str)
       Plansheet.parse_time_duration(Regexp.last_match(1)) if str.match(TIME_EST_REGEX)
     end

data/lib/plansheet/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plansheet
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.27.0
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-13 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dc-kwalify