plansheet 0.31.0 → 0.34.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1b05c9c4733d200c8baee9815468f5645bff5e4c91290d36be60cb292d3cc19
-  data.tar.gz: bafca3ddbcd281d8fb98098dd77af9771fdf9e896d7edb67bb03c16377e40600
+  metadata.gz: 0127f89bb4b286c6bda0d5ff1d1c8e02d4ceb26f0898f78f2031ad7d69913bf1
+  data.tar.gz: 0ce4e76d7693d51bfdd96cd6390124955858c15b5fe109f03d11d4aa707bdf98
 SHA512:
-  metadata.gz: a392b05530451746c15420d8bd5a96be18666f709974c604ab03ecafadec3464e876fb51203c5824e6203f370e2f71bab62b2eb9c7a5d496b9de70099f021f87
-  data.tar.gz: 24320acdc706151578b4a3e8ba278aaae5630317ed4d069b3b609c983597c7b668fbdce51002fedaa066ae359d5a05f47825f2e3eb4cf0927efebd6bfb4a1931
+  metadata.gz: 7d694e749bff3c2a4b7f6983f75ecc6861eb8a793752658439bc0e2a3381c0037aa09edad3ab4f33fc8365992ee21ab12bdc450eb6283a4e1fa8b2f7250078a3
+  data.tar.gz: 81e8c85c1914e225b2bca1fe8655e367b1d36a830ea0905d0bf449fa4c3ced79b023c92ecd9d655cf09a5843ec9be78de67a63e5efdaa341e843999dec736eb6

data/Gemfile

@@ -5,6 +5,6 @@ source "https://rubygems.org"
 gemspec
 
 group :development, optional: true do
-  gem "dc-devtools", "~> 0.1"
+  gem "dc-devtools", "~> 0.5"
   gem "rdoc"
 end

data/Rakefile

@@ -9,8 +9,6 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/test_*.rb"]
 end
 
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
+require "dc_rake"
 
 task default: %i[test rubocop]

data/exe/plansheet

@@ -4,11 +4,14 @@
 require "plansheet"
 require "optparse"
 
+options = {}
 parser = OptionParser.new
 parser.on(
-  "--sheet",
+  "--sheet [TYPE]",
   "Generates MD/LaTeX project PDF"
-)
+) do |sheet_type|
+  options[:sheet] = sheet_type || "projects"
+end
 parser.on(
   "--sort",
   "Sort project files"
@@ -41,7 +44,6 @@ parser.on(
   "--location_filter LOCATION",
   "location filter for CLI dump (WIP)"
 )
-options = {}
 parser.parse!(into: options)
 
 config = Plansheet.load_config
@@ -49,11 +51,21 @@ pool = Plansheet::Pool.new({ projects_dir: config["projects_dir"],
                              sort_order: config["sort_order"] })
 
 if options[:sheet] || options.empty?
+  # TODO: Add pdflatex command (customizable path)
   require "plansheet/sheet"
   FileUtils.mkdir_p config["output_dir"]
-  project_arr = pool.projects
-  project_arr.delete_if { |x| %w[dropped done paused].include? x.status }
-  Plansheet::LaTeXSheet.new("#{config["output_dir"]}/projects.tex", project_arr)
+  case options[:sheet]
+  when "daily"
+    Plansheet::DailyLaTeXSheet.new("#{config["output_dir"]}/daily.tex", config["daily"])
+  when "weekly"
+    Plansheet::WeeklyLaTeXSheet.new("#{config["output_dir"]}/weekly.tex", pool.projects, config["weekly"])
+  when "monthly"
+    Plansheet::MonthlyLaTeXSheet.new("#{config["output_dir"]}/monthly.tex", config["monthly"])
+  else
+    project_arr = pool.projects
+    project_arr.delete_if { |x| %w[dropped done paused].include? x.status }
+    Plansheet::LaTeXSheet.new("#{config["output_dir"]}/projects.tex", project_arr)
+  end
 elsif options[:irb]
   binding.irb # rubocop:disable Lint/Debugger
 elsif options[:stats]

data/lib/plansheet/project.rb

@@ -6,14 +6,17 @@ 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
-  def nil_if_empty
-    count.zero? ? nil : self
+module Plansheet
+  module PlansheetArray
+    # Needed for Project#time_estimate
+    refine Array do
+      def nil_if_empty
+        count.zero? ? nil : self
+      end
+    end
   end
-end
+  using PlansheetArray
 
-module Plansheet
   PROJECT_STATUS_PRIORITY = {
     "wip" => 1,
     "ready" => 2,
@@ -121,11 +124,13 @@ module Plansheet
       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
+        unless recurring?
+          @completed_on ||= Date.today
+          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
       elsif paused?
         @paused_on ||= Date.today
         remove_instance_variable("@status") if @status
@@ -332,16 +337,10 @@ module Plansheet
       !@frequency.nil? || !@day_of_week.nil? || !@last_done.nil? || !@last_for.nil?
     end
 
-    def paused?
-      status == "paused"
-    end
-
-    def dropped?
-      status == "dropped"
-    end
-
-    def done?
-      status == "done"
+    PROJECT_STATUS_PRIORITY.each_key do |stat|
+      define_method("#{stat}?".to_sym) do
+        status == stat
+      end
     end
 
     def dropped_or_done?

data/lib/plansheet/sheet/daily.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: false
+
+require "date"
+module Plansheet
+  class DailyLaTeXSheet
+    include Plansheet::LaTeXMixins
+    def initialize(output_file, config)
+      @config = config
+      projects_str = sheet_header
+      projects_str << document do
+        sheet_body
+      end
+
+      puts "Writing to #{output_file}"
+      File.write(output_file, projects_str)
+    end
+
+    def dateline
+      <<~DATELINE
+        \\thispagestyle{empty}
+
+        Date \\(\\underline{\\hspace{4cm}}\\)
+
+      DATELINE
+    end
+
+    INCOLUMN_SPACING = "7mm".freeze
+    def sheet_body
+      [
+        dateline,
+        vspace("1cm"),
+        vbox do
+          @config["top"].map do |section|
+            minipage("8cm") do
+              section_output(section)
+            end
+          end.join
+        end,
+
+        %w[left_bar right_bar].map do |col|
+          minipage("8cm") do
+            @config[col].map do |section|
+              minipage("\\textwidth") do
+                section_output(section)
+              end
+            end.join(vspace(INCOLUMN_SPACING))
+          end
+        end
+      ].flatten.join
+    end
+
+    def section_output(section)
+      case section["type"]
+      when "checkboxes"
+        checkboxes(section["items"])
+      when "checkbox_and_lines"
+        checkbox_and_lines(section["items"])
+      when "multiline_checkbox_and_lines"
+        multiline_checkbox_and_lines(section["items"])
+      end
+    end
+
+    def checkboxes(items)
+      items.map do |l|
+        l.map do |i|
+          checkbox_item i
+        end.join(" ")
+      end.join(HARD_NL)
+    end
+
+    def checkbox_and_lines(items)
+      items.map do |i|
+        checkbox_item(i, line: "4cm")
+      end.join(HARD_NL)
+    end
+
+    def multiline_checkbox_and_lines(items)
+      items.map do |q|
+        "#{checkbox_item q} #{HARD_NL}#{writein_line("\\textwidth")}"
+      end.join(HARD_NL)
+    end
+  end
+end

data/lib/plansheet/sheet/latex.rb

@@ -2,97 +2,39 @@
 
 require "date"
 module Plansheet
-  # The Sheet class constructs a Markdown/LaTeX file for use with pandoc
+  # The Sheet class constructs a Markdown/LaTeX file for use with pdflatex
   class LaTeXSheet
+    include LaTeXMixins
     def initialize(output_file, project_arr)
-      projects_str = String.new
-      projects_str << sheet_header
-
-      project_arr.each do |p|
-        projects_str << project_minipage(p)
+      projects_str = sheet_header
+      projects_str << document do
+        "\\thispagestyle{empty}\n\n\\section{Date: #{Date.today}}\n".concat(
+          project_arr.map do |p|
+            project_minipage(p)
+          end.join
+        )
       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
-        \\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}
-
-        \\section{Date: #{Date.today}}
-      FRONTMATTER
-    end
-
-    def sheet_footer
-      '\end{document}'
-    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"
+      minipage("6cm") do
+        project_header(proj)&.concat(
+          proj&.tasks&.map do |t|
+            "#{checkbox_item sanitize_string(t)}#{HARD_NL}"
+          end&.join("") || "" # empty string to catch nil
+        )
       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 = "#{sanitize_string(proj.namespace)}: #{sanitize_string(proj.name)}#{HARD_NL}"
       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 << HARD_NL
       str
     end
   end

data/lib/plansheet/sheet/latex_utils.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require "date"
+module Plansheet
+  module LaTeXMixins
+    HARD_NL = " \\\\\n"
+    SQUARE = "$\\square$"
+
+    def vspace(space)
+      "\\vspace{#{space}}\n"
+    end
+
+    def writein_line(space)
+      "$\\underline{\\hspace{#{space}}}$"
+    end
+
+    def checkbox_item(str, line: nil)
+      "#{SQUARE} #{str}#{" #{writein_line(line)}" if line}"
+    end
+
+    def vbox
+      "\\vbox{\n#{yield}\n}\n"
+    end
+
+    %w[center document enumerate tabbing].each do |env|
+      define_method(env.to_sym) do |&e|
+        <<~ENV
+          \\begin{#{env}}
+          #{e.call}
+          \\end{#{env}}
+        ENV
+      end
+    end
+
+    def itemize_tightlist
+      <<~DOCUMENT
+        \\begin{itemize}
+        \\tightlist
+        #{yield}
+        \\end{itemize}
+      DOCUMENT
+    end
+
+    def itemline(item, opt: nil)
+      "\\item#{opt ? "[#{opt}]" : ""} #{item}\n"
+    end
+
+    def minipage(size)
+      <<~MINIPAGE
+        \\begin{minipage}{#{size}}
+        #{yield}
+        \\end{minipage}
+      MINIPAGE
+    end
+
+    def sanitize_string(str)
+      str.gsub("_", '\_')
+    end
+
+    def sheet_header
+      # LaTeX used to be generated by pandoc
+      <<~FRONTMATTER
+        \\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}
+      FRONTMATTER
+    end
+
+    def config_file_sanity_check(options = {})
+      options.each do |opt, type|
+        unless @config[opt].is_a?(type) && !@config[opt]&.empty?
+          abort "Need to specify #{opt} #{type.to_s.downcase} in your ~/.plansheet.yml config"
+        end
+      end
+    end
+  end
+end

data/lib/plansheet/sheet/monthly.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: false
+
+require "date"
+module Plansheet
+  class MonthlyLaTeXSheet
+    include LaTeXMixins
+    def initialize(output_file, config)
+      @config = config || {}
+      config_file_sanity_check({
+                                 "highlevel_items" => Array,
+                                 "tags" => Hash
+                               })
+
+      str = sheet_header
+      str << document do
+        [
+          month_line,
+          highlevel_items,
+          center do
+            [
+              events_minipage,
+              tags_minipages
+            ].join
+          end,
+          monthly_calendar_grid
+        ].join
+      end
+      puts "Writing to #{output_file}"
+      File.write(output_file, str)
+    end
+
+    def highlevel_items
+      itemize_tightlist do
+        @config["highlevel_items"].map do |i|
+          itemline("#{i} #{writein_line("5cm")}", opt: SQUARE)
+        end.join.concat("\n")
+      end
+    end
+
+    def tags_minipages
+      minipage("6.5cm") do
+        @config["tags"].map { |k, v| tag_minipage k, v }.join
+      end.concat("\n")
+    end
+
+    def events_minipage
+      minipage("8cm") do
+        "Events:\n#{
+          itemize_tightlist do
+            30.times.map do |n|
+              itemline(
+                writein_line("6cm"),
+                opt: (Date.today + n).strftime("%a %m-%d")
+              )
+            end.join.concat("\n")
+          end
+        }"
+      end
+    end
+
+    def pretty_tag_name(tag)
+      tag.capitalize.gsub("_", " ")
+    end
+
+    def tag_minipage(tag, items = 10)
+      "#{pretty_tag_name tag}:\n".concat(
+        itemize_tightlist do
+          items.times.map do
+            itemline(writein_line("6cm"), opt: SQUARE)
+          end.join
+        end
+      )
+    end
+
+    def month_line
+      "For the next month: #{Date.today} - #{Date.today + 30}\n\n"
+    end
+
+    def monthly_calendar_grid
+      <<~GRID
+        \\begin{tabular}{|#{7.times.map { "p{2cm}" }.join("|")}|}
+        \\hline
+      GRID
+        .concat(
+          %w[Sunday Monday Tuesday Wednesday Thursday Friday Saturday].join(" & ").concat(HARD_NL)
+        ).concat(
+          5.times.map do |n|
+            calendar_grid_line n
+          end.join(HARD_NL).concat(HARD_NL)
+        ).concat(
+          <<~GRID
+            \\hline
+            \\end{tabular}
+          GRID
+        )
+    end
+
+    private
+
+    def calendar_grid_line(week_multiplier = 0)
+      "\\hline\n#{
+        7.times.map do |n|
+          (Date.today - Date.today.wday + (n + (week_multiplier * 7))).strftime("%d")
+        end.join(" & ")
+      } #{
+        vspace("5mm")
+      }"
+    end
+  end
+end

data/lib/plansheet/sheet/weekly.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: false
+
+require "date"
+module Plansheet
+  class WeeklyLaTeXSheet
+    include LaTeXMixins
+    include TimeUtils
+    MINIPAGE_SIZE = "6cm".freeze
+    def initialize(output_file, projects, config)
+      @config = config || {}
+      config_file_sanity_check({
+                                 "namespaces" => Hash,
+                                 "tags" => Hash
+                               })
+
+      @external_commits = projects.select(&:externals) || []
+      @projects = projects # TODO: remove finished?
+      str = sheet_header
+      str << document do
+        [
+          week_line,
+          [
+            event_writeins,
+            past_due,
+            upcoming_due
+          ].compact.join,
+          # Since the following are a lot more volatile in minipage length,
+          # sort by newline so more fits on the page
+          [
+            external_commits,
+            works_in_progress,
+            tag_minipages,
+            namespace_minipages,
+            recurring_defer
+          ].flatten.compact.sort_by { |x| x.count("\n") }.join
+        ].flatten.join
+      end
+      puts "Writing to #{output_file}"
+      File.write(output_file, str)
+    end
+
+    def namespace_minipages
+      @config["namespaces"].map do |namespace, limit|
+        projects = @projects.select { |x| x.namespace == namespace }
+        project_minipage namespace, projects_in_time(projects, limit)
+      end&.join
+    end
+
+    def tag_minipages
+      @config["tags"].map do |tag, limit|
+        projects = @projects.select { |x| x&.tags&.any?(tag) }
+        project_minipage pretty_tag_name(tag), projects_in_time(projects, limit)
+      end&.join
+    end
+
+    def works_in_progress
+      projects = @projects.select(&:wip?)
+      project_minipage "Works in progress", projects if projects
+    end
+
+    def past_due
+      projects = @projects.select { |x| x.due ? x.due < Date.today : false }
+      project_minipage "Past due", projects if projects
+    end
+
+    def recurring_defer
+      projects = @projects.select { |x| x.last_for ? x.last_for_deferral < Date.today + 8 : false }
+      project_minipage "Recurring defer", projects if projects
+    end
+
+    def upcoming_due
+      projects = @projects.select { |x| x.due ? (x.due >= Date.today && x.due < Date.today + 8) : false }
+      project_minipage "Upcoming due", projects if projects
+    end
+
+    def external_commits
+      project_minipage("Externals", @external_commits) unless @external_commits&.empty?
+    end
+
+    def event_writeins
+      minipage(MINIPAGE_SIZE) do
+        "Events:\n#{
+          itemize_tightlist do
+            7.times.map do |n|
+              itemline(
+                writein_line("4cm"),
+                opt: (Date.today + n).strftime("%a %m-%d")
+              )
+            end.join.concat("\n")
+          end
+        }"
+      end
+    end
+
+    def pretty_tag_name(tag)
+      tag.capitalize.gsub("_", " ")
+    end
+
+    def project_minipage(thing, projects = [])
+      unless projects&.empty?
+        minipage(MINIPAGE_SIZE) do
+          "#{thing}:
+        #{itemize_tightlist do
+            projects&.map do |x|
+              itemline("#{x.name} #{x&.time_estimate}", opt: SQUARE)
+            end&.join("\n")
+          end
+        }"
+        end
+      end
+    end
+
+    DEFAULT_PROJECT_TIME_ESTIMATE_MIN = 120
+    def projects_in_time(projects, time)
+      projects ||= []
+      t = parse_time_duration(time)
+      p = []
+      projects.each do |proj|
+        e = proj&.time_estimate ? parse_time_duration(proj.time_estimate) : DEFAULT_PROJECT_TIME_ESTIMATE_MIN
+        if e <= t
+          p.append proj
+          t -= e
+        end
+      end
+      p
+    end
+
+    def week_line
+      "For the next week: #{Date.today} - #{Date.today + 7}\n\n"
+    end
+  end
+end

data/lib/plansheet/sheet.rb

@@ -1,3 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "sheet/latex_utils"
 require_relative "sheet/latex"
+require_relative "sheet/daily"
+require_relative "sheet/weekly"
+require_relative "sheet/monthly"

data/lib/plansheet/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plansheet
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.34.1
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-15 00:00:00.000000000 Z
+date: 2022-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dc-kwalify
@@ -75,7 +75,11 @@ files:
 - lib/plansheet/project/stringify.rb
 - lib/plansheet/project/yaml.rb
 - lib/plansheet/sheet.rb
+- lib/plansheet/sheet/daily.rb
 - lib/plansheet/sheet/latex.rb
+- lib/plansheet/sheet/latex_utils.rb
+- lib/plansheet/sheet/monthly.rb
+- lib/plansheet/sheet/weekly.rb
 - lib/plansheet/time.rb
 - lib/plansheet/version.rb
 homepage: https://dafyddcrosby.com