plansheet 0.23.2 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e479f020bfa87192523fd231ec0704d07a2e0e92805eaf76720bf3ee62469c4a
-  data.tar.gz: c197a3c2730522f7f70aa4793ff50670e91e04f57f15874bef174c0f94b44f83
+  metadata.gz: e4064aa7163d4ad0b941b17a4b3f10541fde5188d2b84e1c5b8fe43fd82eadbb
+  data.tar.gz: a67509fae6401fd25e42ab35ef810a0bba0f82f73173ab2a5061206b2e4d9f62
 SHA512:
-  metadata.gz: 77d8895595f834e4bf6f844aabd20178b3f50172071a2713e81f50e9e0e21f4c9cc29df0550cfba085419f7508eeb188417610ce8364b18fdcdd8a6012290eed
-  data.tar.gz: 1da8aab0fe36a1775584afbdd140c3b0e0b6a6ed43202b2987311aa258bc3a2d59ce6109cb88c11c6a8a9335bd5770c9c2e66c1ff3f74c3f26cd4c0c07120733
+  metadata.gz: b4d07c885342474b0205fceec3e625fc000dd92b164987eaab1603ce453d1e7473c3281a30047470d8c15f7e4dce9e587f1c19365a0d7a56a12b93478f038024
+  data.tar.gz: 7ab35b12fcdc63e00d0dd6e2b2b54e4d27634d1b950c2298c55886b3f8c461cc272bbb507404edfad156ff646148802f099d3c1a054bd000284622f1f1e9ce72

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,8 +1,9 @@
 PATH
   remote: .
   specs:
-    plansheet (0.23.2)
+    plansheet (0.26.0)
       dc-kwalify (~> 1.0)
+      diffy (= 3.4.2)
       rgl (= 0.5.8)
 
 GEM
@@ -11,6 +12,7 @@ GEM
     ast (2.4.2)
     coderay (1.1.3)
     dc-kwalify (1.0.0)
+    diffy (3.4.2)
     ffi (1.15.5)
     formatador (1.1.0)
     generator (0.0.1)

data/exe/plansheet

@@ -59,7 +59,7 @@ elsif options[:sort]
   # Pool sorts projects, this now just matches old behaviour
   pool.write_projects
 elsif options[:"time-roi"]
-  project_arr = pool.projects.select {|x| x.time_roi_payoff != 0 && !x.dropped_or_done?}.sort
+  project_arr = pool.projects.select { |x| x.time_roi_payoff != 0 && !x.dropped_or_done? }.sort
   project_arr.each do |proj|
     puts proj
     puts "time ROI payoff: #{proj.time_roi_payoff}"

data/lib/plansheet/pool.rb

@@ -10,12 +10,14 @@ module Plansheet
 
     DEFAULT_COMPARISON_ORDER = %w[
       completeness
+      completed_on
       dependency
       priority
       defer
       due
       time_roi
       status
+      name
     ].freeze
 
     def initialize(config, debug: false)
@@ -89,8 +91,7 @@ module Plansheet
       # 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
+        pyf.compare_and_write projects_in_namespace(ns)
       end
     end
 

data/lib/plansheet/project/yaml.rb

@@ -189,12 +189,29 @@ module Plansheet
       @projects.sort!
     end
 
-    def write
-      File.write @path, yaml_dump
+    def compare_and_write(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)
+
+      puts "#{@path} has changed, writing"
+      require "diffy"
+      puts Diffy::Diff.new(yaml_dump(load_file), updated_projects_string).to_s(:color)
+      File.write @path, updated_projects_string
     end
 
-    def yaml_dump
-      YAML.dump(@projects.map { |x| x.to_h.delete_if { |k, _| k == "namespace" } })
+    def yaml_dump(projects)
+      # binding.irb if projects.nil?
+      YAML.dump(projects.map do |x|
+        x.to_h.delete_if do |k, v|
+          # Remove low-value default noise from projects
+          k == "namespace" ||
+           (k == "priority" && v == "low") ||
+           (k == "status" && v == "idea")
+        end
+      end)
     end
   end
 end

data/lib/plansheet/project.rb

@@ -138,13 +138,21 @@ 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 yearly_minutes_saved
@@ -182,6 +190,20 @@ module Plansheet
       PROJECT_STATUS_PRIORITY[status] <=> PROJECT_STATUS_PRIORITY[other.status]
     end
 
+    # This seems silly at first glance, but it's to keep projects from flipping
+    # around on each sort when they are equal in all other respects
+    def compare_name(other)
+      @name <=> other.name
+    end
+
+    def compare_completed_on(other)
+      retval = 0
+      retval += 1 if @completed_on
+      retval -= 1 if other.completed_on
+      retval = (other.completed_on <=> @completed_on) if retval.zero?
+      retval
+    end
+
     def compare_due(other)
       # -1 is receiving object being older
 
@@ -273,11 +295,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
@@ -312,6 +329,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
@@ -324,13 +343,17 @@ 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 self.task_time_estimate(str)
       Plansheet.parse_time_duration(Regexp.last_match(1)) if str.match(TIME_EST_REGEX)
     end
@@ -340,8 +363,6 @@ module Plansheet
       ALL_PROPERTIES.each do |prop|
         h[prop] = instance_variable_get("@#{prop}") if instance_variable_defined?("@#{prop}")
       end
-      h.delete "priority" if h.key?("priority") && h["priority"] == "low"
-      h.delete "status" if h.key?("status") && h["status"] == "idea"
       h
     end
   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.23.2"
+  VERSION = "0.26.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plansheet
 version: !ruby/object:Gem::Version
-  version: 0.23.2
+  version: 0.26.0
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-08 00:00:00.000000000 Z
+date: 2022-07-13 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: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.2
 - !ruby/object:Gem::Dependency
   name: rgl
   requirement: !ruby/object:Gem::Requirement
@@ -62,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: