plansheet 0.3.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bddf541a519a646283dbd872816140c667290b05fe81a38a79297e283f48f87b
-  data.tar.gz: 49e9670228ddb622b9cc332f4bd5f8b943bf674b242851212aabfa6384a1162f
+  metadata.gz: 0df6d0d15bff6b0d639ea6561ad722308c02e00b1bd313649b952a48c7826ad4
+  data.tar.gz: 51faedcd44ccaeec7ee88a3e345bb8d5ae1597a5689324953a188e1725a465e2
 SHA512:
-  metadata.gz: 697436e3c7dbc92323a321c75b23ef47a2c4c6f632f93bd4686a95a84b9edd4004691055d2aadfb75f802aaf1b4d88554f3a4f32e8e79942c4e073c65835dd5a
-  data.tar.gz: 285490462d0ff27a9e3a81ae09baaac60754260e6a64fc15c5ad52887d2d1df815e41c84854b98cdbe07d5d6799ddb39f1fc99e52de4b44c41ea85e6b46f2bd0
+  metadata.gz: 0eb27167a0d754f27df229da3e2e12a07734a1e90f8d1a19374a6d408fd822d67286b31efbaa223eae61ec97931727ed4d3ea70e4211035cb8f2ea68f728f207
+  data.tar.gz: 646ed78dd6f00b145ad61778fc7462b1ee1a3f9c52df3b3e27347c5d30ac199b2b4ef914239dd1a586d2e575e9fe8d44f664d5e152075a8ca5211150b4034838

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   TargetRubyVersion: 2.6
   NewCops: enable
+  SuggestExtensions: false
 
 Style/StringLiterals:
   Enabled: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plansheet (0.3.1)
+    plansheet (0.6.0)
       dc-kwalify (~> 1.0)
 
 GEM

data/exe/plansheet

@@ -1,70 +1,39 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "yaml"
 require "plansheet"
-
-begin
-  config = YAML.load_file "#{Dir.home}/.plansheet.yml"
-rescue StandardError
-  abort "unable to load plansheet config file"
-end
-
-project_hash = {}
-projects = Dir.glob("*yml", base: config["projects_dir"])
-projects.each do |l|
-  contents = YAML.load_file(File.join(config["projects_dir"], l))
-  key = l.gsub(".yml", "")
-  contents.each do |project|
-    key = project["project"]
-    project_hash[key] = {
-      name: project["project"]
-    }
-    %w[tasks desc done].each do |k|
-      project_hash[key][k.to_sym] = project[k] if project[k]
-    end
-    project_hash[key][:status] = if project["status"]
-                                   project["status"]
-                                 elsif project_hash[key][:tasks]
-                                   "planning"
-                                 else
-                                   "idea"
-                                 end
+require "optparse"
+
+parser = OptionParser.new
+parser.on(
+  "--sheet",
+  "Generates MD/LaTeX project PDF"
+)
+parser.on(
+  "--sort",
+  "Sort project files"
+)
+parser.on(
+  "--cli",
+  "CLI dump of projects (WIP)"
+)
+options = {}
+parser.parse!(into: options)
+
+config = Plansheet.load_config
+
+if options[:sheet] || options.empty?
+  project_arr = Plansheet.load_projects_dir config["projects_dir"]
+
+  Dir.mkdir config["output_dir"] unless Dir.exist? config["output_dir"]
+
+  Plansheet::Sheet.new("#{config["output_dir"]}/projects.md", project_arr)
+elsif options[:sort]
+  Plansheet.resort_projects_in_dir config["projects_dir"]
+elsif options[:cli]
+  project_arr = Plansheet.load_projects_dir config["projects_dir"]
+  project_arr.sort.each do |proj|
+    puts proj
+    puts "\n"
   end
 end
-
-sorted_hash = project_hash.sort_by do |_, v|
-  Plansheet::PROJECT_STATUS_PRIORITY[v[:status]]
-end
-
-def project_minipage(proj)
-  p proj
-  str = String.new
-  str << "\\begin{minipage}{5cm}\n"
-  str << "#{proj[:name]} - #{proj[:status]} \\\\\n"
-  proj[:tasks]&.each do |t|
-    str << "$\\square$ #{t} \\\\\n"
-  end
-  str << "\\end{minipage}\n"
-  str
-end
-
-require "date"
-projects_str = String.new
-projects_str << <<~FRONTMATTER
-  ---
-  geometry: margin=3cm
-  ---
-  \\thispagestyle{empty}
-
-  # Date: #{Date.today}
-FRONTMATTER
-
-sorted_hash.first(60).each do |_, p|
-  projects_str << project_minipage(p)
-end
-
-Dir.mkdir config["output_dir"] unless Dir.exist? config["output_dir"]
-f = File.open("#{config["output_dir"]}/projects.md", "w")
-f.write(projects_str)
-f.close

data/lib/plansheet/project.rb

@@ -13,6 +13,17 @@ module Plansheet
     "done" => 7
   }.freeze
 
+  PROJECT_PRIORITY = {
+    "high" => 1,
+    "medium" => 2,
+    "low" => 3
+  }.freeze
+  PROJECT_PRIORITY_REV = {
+    1 => "high",
+    2 => "medium",
+    3 => "low"
+  }.freeze
+
   # Once there's some stability in plansheet and dc-kwalify, will pre-load this
   # to save the later YAML.load
   PROJECT_YAML_SCHEMA = <<~YAML
@@ -39,11 +50,14 @@ module Plansheet
               - done # project is finished, but want to keep around
                      # for reference, etc.
           "priority":
-            desc: Project priority (not currently implemented)
+            desc: Project priority
             type: str
             enum:
               - high
               - low
+          "location":
+            desc: Location
+            type: str
           "tasks":
             desc: List of tasks to do
             type: seq
@@ -59,4 +73,108 @@ module Plansheet
             type: str
   YAML
   PROJECT_SCHEMA = YAML.safe_load(PROJECT_YAML_SCHEMA)
+  class Project
+    include Comparable
+    attr_reader :name, :tasks, :done, :notes, :location, :priority
+
+    def initialize(options)
+      @name = options["project"]
+
+      @tasks = options["tasks"] || []
+      @done = options["done"] || []
+
+      @notes = options["notes"] if options["notes"]
+      @priority = PROJECT_PRIORITY[options["priority"] || "medium"]
+      @location = options["location"] if options["location"]
+      @status = options["status"] if options["status"]
+    end
+
+    def <=>(other)
+      if @priority == other.priority
+        # TODO: if planning status, then sort based on tasks? category? alphabetically?
+        PROJECT_STATUS_PRIORITY[status] <=> PROJECT_STATUS_PRIORITY[other.status]
+      else
+        @priority <=> other.priority
+      end
+    end
+
+    # TODO: clean up priority handling
+    def priority_string
+      PROJECT_PRIORITY_REV[@priority]
+    end
+
+    def status
+      return @status if @status
+
+      if @tasks.count.positive?
+        if @done.count.positive?
+          "wip"
+        else
+          "planning"
+        end
+      else
+        "idea"
+      end
+    end
+
+    def to_s
+      str = String.new
+      str << "# #{@name}\n"
+      str << "priority: #{priority_string}\n"
+      str << "status: #{status}\n"
+      str << "notes: #{notes}\n" unless @notes.nil?
+      str << "location: #{location}\n" unless @location.nil?
+      str << "tasks:\n" unless @tasks.empty?
+      @tasks.each do |t|
+        str << "- #{t}\n"
+      end
+      str << "done:\n" unless @done.empty?
+      @done.each do |d|
+        str << "- #{d}\n"
+      end
+      str
+    end
+
+    def to_h
+      h = { "project" => @name }
+      h["priority"] = priority_string unless priority_string == "medium"
+      h["status"] = status unless status == "idea"
+      h["notes"] = @notes unless @notes.nil?
+      h["location"] = @location unless @location.nil?
+      h["tasks"] = @tasks unless @tasks.empty?
+      h["done"] = @done unless @done.empty?
+      h
+    end
+  end
+
+  class ProjectYAMLFile
+    attr_reader :projects
+
+    def initialize(path)
+      @path = path
+      # TODO: this won't GC, inline validation instead?
+      @raw = YAML.load_file(path)
+      validate_schema
+      @projects = @raw.map { |proj| Project.new proj }
+    end
+
+    def validate_schema
+      validator = Kwalify::Validator.new(Plansheet::PROJECT_SCHEMA)
+      errors = validator.validate(@raw)
+      # Check YAML validity
+      return unless errors && !errors.empty?
+
+      $stderr.write "Schema errors in #{l}\n"
+      errors.each { |err| puts "- [#{err.path}] #{err.message}" }
+      abort
+    end
+
+    def sort!
+      @projects.sort!
+    end
+
+    def yaml_dump
+      YAML.dump(@projects.map(&:to_h))
+    end
+  end
 end

data/lib/plansheet/sheet.rb

@@ -0,0 +1,50 @@
+# 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)
+      sorted_arr = project_arr.sort!
+
+      projects_str = String.new
+      projects_str << sheet_header
+
+      sorted_arr.first(60).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}{4.5cm}\n"
+      str << project_header(proj)
+      proj.tasks.each do |t|
+        str << "$\\square$ #{t} \\\\\n"
+      end
+      str << "\\end{minipage}\n"
+      str
+    end
+
+    def project_header(proj)
+      str = String.new
+      str << "#{proj.name} - #{proj.status}"
+      str << " - #{proj.location}" if proj.location
+      str << " \\\\\n"
+      str
+    end
+  end
+end

data/lib/plansheet/version.rb

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

data/lib/plansheet.rb

@@ -2,8 +2,35 @@
 
 require_relative "plansheet/version"
 require_relative "plansheet/project"
+require_relative "plansheet/sheet"
+require "yaml"
+require "kwalify"
 
 module Plansheet
   class Error < StandardError; end
-  # Your code goes here...
+
+  def self.load_config
+    YAML.load_file "#{Dir.home}/.plansheet.yml"
+  rescue StandardError
+    abort "unable to load plansheet config file"
+  end
+
+  def self.resort_projects_in_dir(dir)
+    project_files = Dir.glob("#{dir}/*yml")
+    project_files.each do |f|
+      pyf = ProjectYAMLFile.new(f)
+      pyf.sort!
+      File.write(f, pyf.yaml_dump)
+    end
+  end
+
+  def self.load_projects_dir(dir)
+    project_arr = []
+    projects = Dir.glob("*yml", base: dir)
+    projects.each do |l|
+      project_arr << ProjectYAMLFile.new(File.join(dir, l)).projects
+    end
+
+    project_arr.flatten!
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plansheet
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.6.0
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-22 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dc-kwalify
@@ -29,8 +29,6 @@ email:
 - dave@dafyddcrosby.com
 executables:
 - plansheet
-- plansheet-sorter
-- plansheet-validator
 extensions: []
 extra_rdoc_files: []
 files:
@@ -43,10 +41,9 @@ files:
 - Rakefile
 - examples/backpack.yml
 - exe/plansheet
-- exe/plansheet-sorter
-- exe/plansheet-validator
 - lib/plansheet.rb
 - lib/plansheet/project.rb
+- lib/plansheet/sheet.rb
 - lib/plansheet/version.rb
 homepage: https://dafyddcrosby.com
 licenses:

data/exe/plansheet-sorter

@@ -1,25 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# An ugly script to sort projects by status (and eventually priority)
-
-require "yaml"
-require "plansheet"
-
-def project_priority(project)
-  if project["status"]
-    project["status"]
-  elsif project["tasks"]
-    "planning"
-  else
-    "idea"
-  end
-end
-
-filename = ARGV.first
-contents = YAML.load_file(filename)
-sorted_hash = contents.sort_by do |project|
-  Plansheet::PROJECT_STATUS_PRIORITY[project_priority project]
-end
-
-File.write(filename, YAML.dump(sorted_hash))

data/exe/plansheet-validator

@@ -1,19 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "plansheet"
-require "kwalify"
-require "yaml"
-require "pp"
-
-# TODO: yuck!
-filename = ARGV.first
-validator = Kwalify::Validator.new(Plansheet::PROJECT_SCHEMA)
-errors = validator.validate(YAML.load_file(filename))
-# Check YAML validity
-if errors && !errors.empty?
-  errors.each do |err|
-    puts "- [#{err.path}] #{err.message}"
-  end
-  abort "Schema errors in #{filename}"
-end