plansheet 0.24.1 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fae1a985802ab6da236f5f3d54224b4468ae5cc5e6beba86510293e7a92fe0a8
-  data.tar.gz: b2fe70fc1cb48dd794f561ff5037d2311366bb7e64c901cf4f32d33c0592e45b
+  metadata.gz: e590a914b9d074b7ce833d04aac6e5320684c15a398c1c88d5774ae884cad297
+  data.tar.gz: 7e7d5004b022e6286e0e7792b9392b95c1536c398c7915a2534ead4dbf364080
 SHA512:
-  metadata.gz: f68b48246ce4e8b10c66dd805f783fd822886b168aa57bb7db71012934bd2f21f8a76c8f26dab6c8bf4f8156529b897a5d33c02cba2e67d39224579626ee00a0
-  data.tar.gz: 751a5a7beffa1c35d7723521db61aa0ca26d1fafb6643017bfd2c3a3cb14e63dd5d4f775df34e2a9b644c24a8d582e0cd19d9cfd4a3b009673b9fb6d70faef55
+  metadata.gz: 4f03c2eaa802dd20a82180ab4a3ad2b23b2a3b69d6e7536f81a42305a3aab486175e18c767a9cb5b919a7c8d5d7e5a22032253e19b95d47d19c64a4583fd150f
+  data.tar.gz: 6a1923c54d08ba01d33dbfb8d0c76b813fb57b65edba8d79fd002db43b9c63299a301c763acb5084ab5d1e9a773af24be12b15d5f5c2d4fad3b009f820939cfa

data/.rubocop.yml

@@ -11,6 +11,9 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
+Style/GuardClause:
+  Enabled: false
+
 Layout/LineLength:
   Max: 120
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plansheet (0.24.1)
+    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(updated_projects_string, yaml_dump(load_file)).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

@@ -138,13 +138,25 @@ module Plansheet
         # Convert the field to minutes
         @time_estimate_minutes = Plansheet.parse_time_duration(@time_estimate)
       end
-      if @time_estimate_minutes # rubocop:disable Style/GuardClause
+      if @time_estimate_minutes
         # Rewrite time_estimate field
         @time_estimate = Plansheet.build_time_duration(@time_estimate_minutes)
 
         yms = yearly_minutes_saved
         @time_roi_payoff = yms.to_f / @time_estimate_minutes if yms
       end
+
+      if done?
+        @completed_on ||= Date.today unless recurring?
+        remove_instance_variable("@status") if @status
+        remove_instance_variable("@time_estimate") if @time_estimate
+        remove_instance_variable("@time_estimate_minutes") if @time_estimate
+        remove_instance_variable("@time_roi_payoff") if @time_roi_payoff
+      end
+    end
+
+    def completed_on_month
+      @completed_on&.strftime("%Y-%m")
     end
 
     def yearly_minutes_saved
@@ -287,11 +299,6 @@ module Plansheet
       task_based_status
     end
 
-    def process_recurring
-      # TODO: Tasks will be moved from done->tasks if recurring project is
-      # starting again
-    end
-
     # Due date either explicit or recurring
     def due
       return @due if @due
@@ -326,6 +333,8 @@ module Plansheet
 
     def last_for_deferral
       return @last_done + Plansheet.parse_date_duration(@last_for) if @last_done
+
+      Date.today
     end
 
     def lead_time_deferral
@@ -338,13 +347,21 @@ module Plansheet
     end
 
     def recurring?
-      !@frequency.nil? || !@day_of_week.nil? || !@last_done.nil?
+      !@frequency.nil? || !@day_of_week.nil? || !@last_done.nil? || !@last_for.nil?
     end
 
     def dropped_or_done?
       status == "dropped" || status == "done"
     end
 
+    def done?
+      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/sheet/latex.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "date"
+module Plansheet
+  # The Sheet class constructs a Markdown/LaTeX file for use with pandoc
+  class Sheet
+    def initialize(output_file, project_arr)
+      projects_str = String.new
+      projects_str << sheet_header
+
+      project_arr.each do |p|
+        projects_str << project_minipage(p)
+      end
+      puts "Writing to #{output_file}"
+      File.write(output_file, projects_str)
+    end
+
+    def sheet_header
+      <<~FRONTMATTER
+        ---
+        geometry: margin=1.5cm
+        ---
+        \\thispagestyle{empty}
+
+        # Date: #{Date.today}
+      FRONTMATTER
+    end
+
+    def project_minipage(proj)
+      str = String.new
+      str << "\\begin{minipage}{6cm}\n"
+      str << project_header(proj)
+      proj&.tasks&.each do |t|
+        str << "$\\square$ #{sanitize_string(t)} \\\\\n"
+      end
+      str << "\\end{minipage}\n"
+      str
+    end
+
+    def sanitize_string(str)
+      str.gsub("_", '\_')
+    end
+
+    def project_header(proj)
+      str = String.new
+      str << "#{sanitize_string(proj.namespace)}: #{sanitize_string(proj.name)}\\\\\n"
+      str << proj.status.to_s
+      str << " - #{sanitize_string(proj.location)}" if proj.location
+      str << " due: #{proj.due}" if proj.due
+      str << " time: #{proj.time_estimate}" if proj.time_estimate
+      str << " \\\\\n"
+      str
+    end
+  end
+end

data/lib/plansheet/sheet.rb

@@ -1,55 +1,3 @@
 # frozen_string_literal: true
 
-require "date"
-module Plansheet
-  # The Sheet class constructs a Markdown/LaTeX file for use with pandoc
-  class Sheet
-    def initialize(output_file, project_arr)
-      projects_str = String.new
-      projects_str << sheet_header
-
-      project_arr.each do |p|
-        projects_str << project_minipage(p)
-      end
-      puts "Writing to #{output_file}"
-      File.write(output_file, projects_str)
-    end
-
-    def sheet_header
-      <<~FRONTMATTER
-        ---
-        geometry: margin=1.5cm
-        ---
-        \\thispagestyle{empty}
-
-        # Date: #{Date.today}
-      FRONTMATTER
-    end
-
-    def project_minipage(proj)
-      str = String.new
-      str << "\\begin{minipage}{6cm}\n"
-      str << project_header(proj)
-      proj&.tasks&.each do |t|
-        str << "$\\square$ #{sanitize_string(t)} \\\\\n"
-      end
-      str << "\\end{minipage}\n"
-      str
-    end
-
-    def sanitize_string(str)
-      str.gsub("_", '\_')
-    end
-
-    def project_header(proj)
-      str = String.new
-      str << "#{sanitize_string(proj.namespace)}: #{sanitize_string(proj.name)}\\\\\n"
-      str << proj.status.to_s
-      str << " - #{sanitize_string(proj.location)}" if proj.location
-      str << " due: #{proj.due}" if proj.due
-      str << " time: #{proj.time_estimate}" if proj.time_estimate
-      str << " \\\\\n"
-      str
-    end
-  end
-end
+require_relative "sheet/latex"

data/lib/plansheet/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plansheet
 version: !ruby/object:Gem::Version
-  version: 0.24.1
+  version: 0.27.0
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-11 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dc-kwalify
@@ -76,6 +76,7 @@ files:
 - lib/plansheet/project/stringify.rb
 - lib/plansheet/project/yaml.rb
 - lib/plansheet/sheet.rb
+- lib/plansheet/sheet/latex.rb
 - lib/plansheet/version.rb
 homepage: https://dafyddcrosby.com
 licenses: