plansheet 0.27.0 → 0.30.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e590a914b9d074b7ce833d04aac6e5320684c15a398c1c88d5774ae884cad297
-  data.tar.gz: 7e7d5004b022e6286e0e7792b9392b95c1536c398c7915a2534ead4dbf364080
+  metadata.gz: a918dce2e7ab41c30070205e2dcb75679696047b231e0a0999ed0a940fa3aea8
+  data.tar.gz: 5cec12572afb320929ff5efd951bf9f31e69aeff53d35e4886ea17d6891ad30c
 SHA512:
-  metadata.gz: 4f03c2eaa802dd20a82180ab4a3ad2b23b2a3b69d6e7536f81a42305a3aab486175e18c767a9cb5b919a7c8d5d7e5a22032253e19b95d47d19c64a4583fd150f
-  data.tar.gz: 6a1923c54d08ba01d33dbfb8d0c76b813fb57b65edba8d79fd002db43b9c63299a301c763acb5084ab5d1e9a773af24be12b15d5f5c2d4fad3b009f820939cfa
+  metadata.gz: 30fdf0a0f98d5dd99de508849c9380210d4b8515d8549ccc4cfb60a8da2263fecd9d6b72fcbaf76fd539aeb826a1c69342930a403d6289942c637e1e5f70e54d
+  data.tar.gz: e0cf9b8ec2daa63f29b396ca58e1321d4303fc3ce2cbbccaf3a7bc282d33e2756ed55bce9747ff74223ee026130c1c8b69746ff97a38f189bc540e95f73dd49d

data/.rubocop.yml

@@ -1,24 +1,5 @@
+inherit_gem:
+  dc-rubocop: default.yml
+
 AllCops:
   TargetRubyVersion: 2.6
-  NewCops: enable
-  SuggestExtensions: false
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/GuardClause:
-  Enabled: false
-
-Layout/LineLength:
-  Max: 120
-
-Metrics:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false

data/Gemfile

@@ -6,13 +6,6 @@ source "https://rubygems.org"
 gemspec
 
 group :development, optional: true do
-  gem "guard", "~> 2.18"
-  gem "guard-rake", "~> 1.0"
-  gem "minitest", "~> 5.0"
-  gem "rake", "~> 13.0"
+  gem "dc-devtools"
   gem "rdoc"
-
-  gem "rubocop", "~> 1.21"
-  gem "rubocop-minitest"
-  gem "rubocop-rake"
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plansheet (0.27.0)
+    plansheet (0.30.2)
       dc-kwalify (~> 1.0)
       diffy (= 3.4.2)
       rgl (= 0.5.8)
@@ -11,7 +11,18 @@ GEM
   specs:
     ast (2.4.2)
     coderay (1.1.3)
+    dc-devtools (0.0.202207232239)
+      dc-rubocop (>= 0.0.3)
+      guard (~> 2.18)
+      guard-rake (~> 1.0)
+      minitest
+      rake (~> 13.0)
+      rubocop (~> 1.30)
+      rubocop-minitest
+      rubocop-rake (~> 0.6)
     dc-kwalify (1.0.0)
+    dc-rubocop (0.0.3)
+      rubocop
     diffy (3.4.2)
     ffi (1.15.5)
     formatador (1.1.0)
@@ -28,13 +39,14 @@ GEM
     guard-rake (1.0.0)
       guard
       rake
+    json (2.6.2)
     lazy_priority_queue (0.1.1)
     listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
     method_source (1.0.0)
-    minitest (5.15.0)
+    minitest (5.16.2)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
@@ -54,24 +66,25 @@ GEM
       ffi (~> 1.0)
     rdoc (6.4.0)
       psych (>= 4.0.0)
-    regexp_parser (2.4.0)
+    regexp_parser (2.5.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)
+    rubocop (1.32.0)
+      json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rubocop-ast (>= 1.19.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
+    rubocop-ast (1.19.1)
       parser (>= 3.1.1.0)
-    rubocop-minitest (0.20.0)
+    rubocop-minitest (0.20.1)
       rubocop (>= 0.90, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
@@ -81,21 +94,15 @@ GEM
       generator
     stringio (3.0.2)
     thor (1.2.1)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.2.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  guard (~> 2.18)
-  guard-rake (~> 1.0)
-  minitest (~> 5.0)
+  dc-devtools
   plansheet!
-  rake (~> 13.0)
   rdoc
-  rubocop (~> 1.21)
-  rubocop-minitest
-  rubocop-rake
 
 BUNDLED WITH
    2.3.6

data/README.md

@@ -1,8 +1,10 @@
 # Plansheet
 
-Plansheet is a simple to-do list generator program that creates a
-structured printout (a la [pandoc](https://pandoc.org)) from a
-pile of formatted [YAML](https://yaml.org) files. Still very much a work-in-progress
+Plansheet is a simple to-do list generator program that creates a LaTeX
+printout (that can be turned into a PDF by pdflatex) from a pile of formatted
+[YAML](https://yaml.org) files.
+
+Plansheet is still a work-in-progress, and while effort is made not to break over minor/patch versions, it's best effort. If you aren't comfortable with fixing Ruby using a lot of metaprogramming, check back in a year or two
 
 ## Installation
 

data/exe/plansheet

@@ -29,6 +29,10 @@ parser.on(
   "--time-roi",
   "Show projects with a time return-on-investment"
 )
+parser.on(
+  "--needs-thinking",
+  "Show projects that need tasks, time estimates, etc (WIP)"
+)
 parser.on(
   "--calendar",
   "List of projects ordered by due date"
@@ -46,15 +50,18 @@ pool = Plansheet::Pool.new({ projects_dir: config["projects_dir"],
 
 if options[:sheet] || options.empty?
   require "plansheet/sheet"
-  Dir.mkdir config["output_dir"] unless Dir.exist? config["output_dir"]
-  Plansheet::Sheet.new("#{config["output_dir"]}/projects.md", pool.projects)
+  FileUtils.mkdir_p config["output_dir"]
+  Plansheet::LaTeXSheet.new("#{config["output_dir"]}/projects.tex", pool.projects)
 elsif options[:irb]
   binding.irb # rubocop:disable Lint/Debugger
 elsif options[:stats]
+  require "plansheet/time"
+  include Plansheet::TimeUtils # rubocop:disable Style/MixinUsage
   puts "# of projects: #{pool.projects.count}"
   puts "# of tasks: #{pool.projects.sum { |x| x&.tasks&.count || 0 }}"
   puts "# of locations: #{pool.projects.collect(&:location).flatten.delete_if(&:nil?).uniq.count}"
-  puts "combined time estimate: #{pool.projects.sum { |x| x.time_estimate_minutes || 0 }} minutes"
+  time = Plansheet::TimeUtils.build_time_duration(pool.projects.sum { |x| x.time_estimate_minutes || 0 })
+  puts "combined time estimate: #{time}"
 elsif options[:sort]
   # Pool sorts projects, this now just matches old behaviour
   pool.write_projects
@@ -65,6 +72,15 @@ elsif options[:"time-roi"]
     puts "time ROI payoff: #{proj.time_roi_payoff}"
     puts "\n"
   end
+elsif options[:"needs-thinking"]
+  puts "Projects with no tasks"
+  project_arr = pool.projects.sort
+  project_arr.delete_if(&:dropped_or_done?)
+  project_arr.delete_if(&:tasks)
+  project_arr.each do |proj|
+    puts proj
+    puts "\n"
+  end
 elsif options[:calendar]
   # TODO: add a project filter method
   project_arr = pool.projects

data/lib/plansheet/pool.rb

@@ -79,14 +79,14 @@ module Plansheet
 
     def archive_projects
       archive_dir = "#{@projects_dir}/archive/"
-      Dir.mkdir archive_dir unless Dir.exist? archive_dir
+      FileUtils.mkdir_p 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"
+        path = Pathname.new "#{archive_dir}/#{project.archive_month}/#{project.namespace}.yml"
         Dir.mkdir path.dirname unless path.dirname.exist?
         pyf = ProjectYAMLFile.new path
         pyf.append_project project

data/lib/plansheet/project/yaml.rb

@@ -42,6 +42,8 @@ module Plansheet
               - blocked # project is blocked by another project, but otherwise ready/wip
               - planning # project in planning phase (set manually)
               - idea # project is little more than an idea
+              - paused # project shouldn't be archived, but should be excluded from
+                       # generated output unless paused projects are requested
               - dropped # project has been explicitly dropped, but
                         # want to keep around for reference, etc
               - done # project is finished, but want to keep around
@@ -100,6 +102,12 @@ module Plansheet
           "completed_on":
             desc: When the (non-recurring) project was completed
             type: date
+          "dropped_on":
+            desc: When the project was dropped
+            type: date
+          "paused_on":
+            desc: When the project was paused
+            type: date
           "created_on":
             desc: When the project was created
             type: date

data/lib/plansheet/project.rb

@@ -4,6 +4,7 @@ require "yaml"
 require "date"
 require_relative "project/yaml"
 require_relative "project/stringify"
+require_relative "./time"
 
 # Needed for Project#time_estimate, would be much happier *not* patching Array
 class Array
@@ -20,8 +21,9 @@ module Plansheet
     "waiting" => 4,
     "planning" => 5,
     "idea" => 6,
-    "dropped" => 7,
-    "done" => 8
+    "paused" => 7,
+    "dropped" => 8,
+    "done" => 9
   }.freeze
 
   # Pre-compute the next days-of-week
@@ -30,36 +32,6 @@ module Plansheet
     [d.strftime("%A"), d]
   end.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]/)
-
-    raise "Can't parse time duration string #{str}"
-  end
-
-  def self.parse_time_duration(str)
-    if str.match(/(\d+h) (\d+m)/)
-      return (parse_time_duration(Regexp.last_match(1)) + parse_time_duration(Regexp.last_match(2)))
-    end
-
-    return Regexp.last_match(1).to_i if str.strip.match(/(\d+)m/)
-    return (Regexp.last_match(1).to_f * 60).to_i if str.strip.match(/(\d+\.?\d*)h/)
-
-    raise "Can't parse time duration string #{str}"
-  end
-
-  def self.build_time_duration(minutes)
-    if minutes > 59
-      if (minutes % 60).zero?
-        "#{minutes / 60}h"
-      else
-        "#{minutes / 60}h #{minutes % 60}m"
-      end
-    else
-      "#{minutes}m"
-    end
-  end
-
   # The use of instance_variable_set/get probably seems a bit weird, but the
   # intent is to avoid object allocation on non-existent project properties, as
   # well as avoiding a bunch of copy-paste boilerplate when adding a new
@@ -68,6 +40,7 @@ module Plansheet
   # unwrap the loops if it's not needed.
   class Project
     include Comparable
+    include Plansheet::TimeUtils
 
     TIME_EST_REGEX = /\((\d+\.?\d*[mMhH])\)$/.freeze
     TIME_EST_REGEX_NO_CAPTURE = /\(\d+\.?\d*[mMhH]\)$/.freeze
@@ -83,7 +56,8 @@ module Plansheet
     # namespace is derived from file name
     STRING_PROPERTIES = %w[priority status location notes time_estimate daily_time_roi weekly_time_roi yearly_time_roi
                            day_of_week frequency last_for lead_time].freeze
-    DATE_PROPERTIES = %w[due defer completed_on created_on starts_on last_done last_reviewed].freeze
+    DATE_PROPERTIES = %w[due defer paused_on dropped_on 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
@@ -132,15 +106,15 @@ module Plansheet
       if @tasks
         @time_estimate_minutes = @tasks&.select do |t|
                                    t.match? TIME_EST_REGEX_NO_CAPTURE
-                                 end&.nil_if_empty&.map { |t| Plansheet::Project.task_time_estimate(t) }&.sum
+                                 end&.nil_if_empty&.map { |t| task_time_estimate(t) }&.sum
       elsif @time_estimate
         # No tasks with estimates, but there's an explicit time_estimate
         # Convert the field to minutes
-        @time_estimate_minutes = Plansheet.parse_time_duration(@time_estimate)
+        @time_estimate_minutes = parse_time_duration(@time_estimate)
       end
       if @time_estimate_minutes
         # Rewrite time_estimate field
-        @time_estimate = Plansheet.build_time_duration(@time_estimate_minutes)
+        @time_estimate = build_time_duration(@time_estimate_minutes)
 
         yms = yearly_minutes_saved
         @time_roi_payoff = yms.to_f / @time_estimate_minutes if yms
@@ -152,20 +126,26 @@ module Plansheet
         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
+      elsif paused?
+        @paused_on ||= Date.today
+        remove_instance_variable("@status") if @status
+      elsif dropped?
+        @dropped_on ||= Date.today
+        remove_instance_variable("@status") if @status
       end
     end
 
-    def completed_on_month
-      @completed_on&.strftime("%Y-%m")
+    def archive_month
+      @completed_on&.strftime("%Y-%m") || Date.today.strftime("%Y-%m")
     end
 
     def yearly_minutes_saved
       if @daily_time_roi
-        Plansheet.parse_time_duration(@daily_time_roi) * 365
+        parse_time_duration(@daily_time_roi) * 365
       elsif @weekly_time_roi
-        Plansheet.parse_time_duration(@weekly_time_roi) * 52
+        parse_time_duration(@weekly_time_roi) * 52
       elsif @yearly_time_roi
-        Plansheet.parse_time_duration(@yearly_time_roi)
+        parse_time_duration(@yearly_time_roi)
       end
     end
 
@@ -253,14 +233,16 @@ module Plansheet
     # Projects that are dropped or done are considered "complete", insofar as
     # they are only kept around for later reference.
     def compare_completeness(other)
-      return 0 if dropped_or_done? && other.dropped_or_done?
-      return 0 if !dropped_or_done? && !other.dropped_or_done?
-
-      dropped_or_done? ? 1 : -1
+      retval = 0
+      retval += 1 if dropped_or_done?
+      retval -= 1 if other.dropped_or_done?
+      retval
     end
 
     def status
       return @status if @status
+      return "dropped" if @dropped_on
+      return "paused" if @paused_on
       return recurring_status if recurring?
       return task_based_status if @tasks || @done
       return "done" if @completed_on && @tasks.nil?
@@ -309,7 +291,7 @@ module Plansheet
 
     def recurring_due_date
       if @last_done
-        return @last_done + Plansheet.parse_date_duration(@frequency) if @frequency
+        return @last_done + parse_date_duration(@frequency) if @frequency
 
         if @day_of_week
           return Date.today + 7 if @last_done == Date.today
@@ -332,13 +314,13 @@ module Plansheet
     end
 
     def last_for_deferral
-      return @last_done + Plansheet.parse_date_duration(@last_for) if @last_done
+      return @last_done + parse_date_duration(@last_for) if @last_done
 
       Date.today
     end
 
     def lead_time_deferral
-      [(due - Plansheet.parse_date_duration(@lead_time)),
+      [(due - parse_date_duration(@lead_time)),
        Date.today].max
     end
 
@@ -350,20 +332,28 @@ module Plansheet
       !@frequency.nil? || !@day_of_week.nil? || !@last_done.nil? || !@last_for.nil?
     end
 
-    def dropped_or_done?
-      status == "dropped" || status == "done"
+    def paused?
+      status == "paused"
+    end
+
+    def dropped?
+      status == "dropped"
     end
 
     def done?
       status == "done"
     end
 
+    def dropped_or_done?
+      dropped? || done?
+    end
+
     def archivable?
-      !recurring? && @completed_on
+      (!recurring? && @completed_on) || dropped?
     end
 
-    def self.task_time_estimate(str)
-      Plansheet.parse_time_duration(Regexp.last_match(1)) if str.match(TIME_EST_REGEX)
+    def task_time_estimate(str)
+      parse_time_duration(Regexp.last_match(1)) if str.match(TIME_EST_REGEX)
     end
 
     def to_h

data/lib/plansheet/sheet/latex.rb

@@ -3,7 +3,7 @@
 require "date"
 module Plansheet
   # The Sheet class constructs a Markdown/LaTeX file for use with pandoc
-  class Sheet
+  class LaTeXSheet
     def initialize(output_file, project_arr)
       projects_str = String.new
       projects_str << sheet_header
@@ -12,20 +12,64 @@ module Plansheet
         projects_str << project_minipage(p)
       end
       puts "Writing to #{output_file}"
+      projects_str << sheet_footer
       File.write(output_file, projects_str)
     end
 
     def sheet_header
+      # LaTeX used to be generated by pandoc
       <<~FRONTMATTER
-        ---
-        geometry: margin=1.5cm
-        ---
+        \\PassOptionsToPackage{unicode}{hyperref}
+        \\PassOptionsToPackage{hyphens}{url}
+        \\documentclass[]{article}
+        \\author{}
+        \\date{#{Date.today}}
+        \\usepackage{amsmath,amssymb}
+        \\usepackage{lmodern}
+        \\usepackage{iftex}
+          \\usepackage[T1]{fontenc}
+          \\usepackage[utf8]{inputenc}
+          \\usepackage{textcomp}
+        \\IfFileExists{upquote.sty}{\\usepackage{upquote}}{}
+        \\IfFileExists{microtype.sty}{
+          \\usepackage[]{microtype}
+          \\UseMicrotypeSet[protrusion]{basicmath}
+        }{}
+        \\makeatletter
+        \\@ifundefined{KOMAClassName}{
+          \\IfFileExists{parskip.sty}{
+            \\usepackage{parskip}
+          }{
+            \\setlength{\\parindent}{0pt}
+            \\setlength{\\parskip}{6pt plus 2pt minus 1pt}}
+        }{
+          \\KOMAoptions{parskip=half}}
+        \\makeatother
+        \\usepackage{xcolor}
+        \\IfFileExists{xurl.sty}{\\usepackage{xurl}}{}
+        \\IfFileExists{bookmark.sty}{\\usepackage{bookmark}}{\\usepackage{hyperref}}
+        \\hypersetup{
+          hidelinks,
+          pdfcreator={LaTeX via plansheet}}
+        \\urlstyle{same}
+        \\usepackage[margin=1.5cm]{geometry}
+        \\setlength{\\emergencystretch}{3em}
+        \\providecommand{\\tightlist}{
+          \\setlength{\\itemsep}{0pt}\\setlength{\\parskip}{0pt}}
+        \\setcounter{secnumdepth}{-\\maxdimen}
+
+        \\begin{document}
+
         \\thispagestyle{empty}
 
-        # Date: #{Date.today}
+        \\section{Date: #{Date.today}}
       FRONTMATTER
     end
 
+    def sheet_footer
+      '\end{document}'
+    end
+
     def project_minipage(proj)
       str = String.new
       str << "\\begin{minipage}{6cm}\n"

data/lib/plansheet/time.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Plansheet
+  module TimeUtils
+    def 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]/)
+
+      raise "Can't parse time duration string #{str}"
+    end
+
+    def parse_time_duration(str)
+      if str.match(/(\d+h) (\d+m)/)
+        return (parse_time_duration(Regexp.last_match(1)) + parse_time_duration(Regexp.last_match(2)))
+      end
+
+      return Regexp.last_match(1).to_i if str.strip.match(/(\d+)m/)
+      return (Regexp.last_match(1).to_f * 60).to_i if str.strip.match(/(\d+\.?\d*)h/)
+
+      raise "Can't parse time duration string #{str}"
+    end
+
+    def build_time_duration(minutes)
+      if minutes > 59
+        if (minutes % 60).zero?
+          "#{minutes / 60}h"
+        else
+          "#{minutes / 60}h #{minutes % 60}m"
+        end
+      else
+        "#{minutes}m"
+      end
+    end
+  end
+end

data/lib/plansheet/version.rb

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

metadata

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