plansheet 0.2.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ccfb13735d8626143db08903deac727870c66e6bd6fec21648fd70bf4050727
-  data.tar.gz: 847f0a0f78cdb0035ee03829f2761e3780fb6296738ac89bcca55635079b9e3a
+  metadata.gz: 3546f42fdd342ea128be90bff2e19b7bcb5c0910990e2132b89b87cbf6a1f776
+  data.tar.gz: 2ea5d505262832e19e77a63e7aa7c59c9fff0b98ddc3ee8218c68b010f4768eb
 SHA512:
-  metadata.gz: 34835dc03602c977afb76a4b5202f3ccf7322445086550d11d6506a4cce329f437d1f1a650b8500f46f6f81d72879f8a0ed506ed087411c68c1362b50523aeb8
-  data.tar.gz: ff0832cc110fa2f8ab2350867aa9c3642cc4eeb6ad9bea9cb620e69dceb4afe5f8e139d9c23f4d9bfd5270000ebc4f5885d1a6cce5ea5db2270edd3caf277428
+  metadata.gz: 335cb1a3e74ab82a1441ec034099427dc0caabaad8a87c1f2620c7143d1fd4772023fe089a7305063fb12a96d169e44dd0b01f8f20437f45bdfa945b03aa2422
+  data.tar.gz: 5d618d61c6a07d8e32e46cfb4dba5df0264370f01d8b4ecef4c68f9fdcf6fcf600ca33bda0a8918e63992434e2a009e4d836f1f838851e0ee94de53128fe1ab2

data/.rubocop.yml

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

data/Gemfile

@@ -6,7 +6,7 @@ source "https://rubygems.org"
 gemspec
 
 group :development, optional: true do
-  gem "rake", "~> 13.0"
   gem "minitest", "~> 5.0"
+  gem "rake", "~> 13.0"
   gem "rubocop", "~> 1.21"
 end

data/Gemfile.lock

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

data/examples/backpack.yml

@@ -0,0 +1,10 @@
+- project: Add snazzy patches to backpack
+  status: planning
+  tasks:
+    - gather patches around the house in one spot
+    - determine which patches to put on
+    - find thread that matches patch colors
+    - plug in sewing machine
+    - put thread onto bobbin
+    - sew patches onto backpack
+

data/exe/plansheet

@@ -1,77 +1,39 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "yaml"
-
-begin
-  config = YAML.load_file "#{Dir.home}/.plansheet.yml"
-rescue StandardError
-  abort "unable to load plansheet config file"
-end
-
-status_priority = {
-  "wip" => 1,
-  "ready" => 2,
-  "blocked" => 3,
-  "planning" => 4,
-  "idea" => 5,
-  "dropped" => 6,
-  "done" => 7
-}
-
-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 "plansheet"
+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.each do |proj|
+    puts proj
+    puts "\n"
   end
 end
-
-sorted_hash = project_hash.sort_by { |_, v| status_priority[v[:status]] }
-
-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(30).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

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module Plansheet
+  PROJECT_STATUS_PRIORITY = {
+    "wip" => 1,
+    "ready" => 2,
+    "blocked" => 3,
+    "planning" => 4,
+    "idea" => 5,
+    "dropped" => 6,
+    "done" => 7
+  }.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
+    desc: dc-tasks project schema
+    type: seq
+    sequence:
+      - type: map
+        mapping:
+          "project":
+            desc: Project name
+            type: str
+            required: yes
+          "status":
+            desc: The current status of the project
+            type: str
+            enum:
+              - wip # project is a work-in-progress
+              - ready # project is fully scoped, ready to go
+              - blocked # project is blocked, but otherwise ready/wip
+              - planning # project in planning phase
+              - idea # project is little more than an idea
+              - dropped # project has been explicitly dropped, but
+                        # want to keep around for reference, etc
+              - done # project is finished, but want to keep around
+                     # for reference, etc.
+          "priority":
+            desc: Project priority (not currently implemented)
+            type: str
+            enum:
+              - high
+              - low
+          "location":
+            desc: Location (not currently implemented)
+            type: str
+          "tasks":
+            desc: List of tasks to do
+            type: seq
+            sequence:
+              - type: str
+          "done":
+            desc: List of tasks which have been completed
+            type: seq
+            sequence:
+              - type: str
+          "notes":
+            desc: Free-form notes string
+            type: str
+  YAML
+  PROJECT_SCHEMA = YAML.safe_load(PROJECT_YAML_SCHEMA)
+  class Project
+    attr_reader :name, :tasks, :done, :notes, :location
+
+    def initialize(options)
+      @name = options["project"]
+
+      @tasks = options["tasks"] || []
+      @done = options["done"] || []
+
+      @notes = options["notes"] if options["notes"]
+      @location = options["location"] if options["location"]
+      @status = options["status"] if options["status"]
+    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 << "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["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
+      if errors && !errors.empty?
+        $stderr.write "Schema errors in #{l}\n"
+        errors.each { |err| puts "- [#{err.path}] #{err.message}" }
+        abort
+      end
+    end
+
+    def sort!
+      @projects.sort_by! do |project|
+        Plansheet::PROJECT_STATUS_PRIORITY[project.status]
+      end
+    end
+
+    def yaml_dump
+      YAML.dump(@projects.map(&:to_h))
+    end
+  end
+end

data/lib/plansheet/sheet.rb

@@ -0,0 +1,52 @@
+# 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_by do |p|
+        Plansheet::PROJECT_STATUS_PRIORITY[p.status]
+      end
+
+      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.2.0"
+  VERSION = "0.5.1"
 end

data/lib/plansheet.rb

@@ -1,8 +1,36 @@
 # frozen_string_literal: true
 
 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.2.0
+  version: 0.5.1
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-19 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dc-kwalify
@@ -29,7 +29,6 @@ email:
 - dave@dafyddcrosby.com
 executables:
 - plansheet
-- plansheet-sorter
 extensions: []
 extra_rdoc_files: []
 files:
@@ -40,16 +39,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/backpack.yml
 - exe/plansheet
-- exe/plansheet-sorter
 - lib/plansheet.rb
+- lib/plansheet/project.rb
+- lib/plansheet/sheet.rb
 - lib/plansheet/version.rb
-- project.schema.yaml
 homepage: https://dafyddcrosby.com
 licenses:
 - MIT
 metadata:
   homepage_uri: https://dafyddcrosby.com
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:

data/exe/plansheet-sorter

@@ -1,32 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# An ugly script to sort projects by status (and eventually priority)
-
-require "yaml"
-
-status_priority = {
-  "wip" => 1,
-  "ready" => 2,
-  "blocked" => 3,
-  "planning" => 4,
-  "idea" => 5,
-  "dropped" => 6,
-  "done" => 7
-}
-
-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 { |project| status_priority[project_priority project] }
-
-File.write(filename, YAML.dump(sorted_hash))

data/project.schema.yaml

@@ -1,41 +0,0 @@
-desc: dc-tasks project schema
-type: seq
-sequence:
-  - type: map
-    mapping:
-      "project":
-        desc: Project name
-        type: str
-        required: yes
-      "status":
-        desc: The current status of the project
-        type: str
-        enum:
-          - wip # project is a work-in-progress
-          - ready # project is fully scoped, ready to go
-          - blocked # project is blocked, but otherwise ready/wip
-          - planning # project in planning phase
-          - idea # project is little more than an idea
-          - dropped # project has been explicitly dropped, but
-                    # want to keep around for reference, etc
-          - done # project is finished, but want to keep around
-                 # for reference, etc.
-      "priority":
-        desc: Project priority (not currently implemented)
-        type: str
-        enum:
-          - high
-          - low
-      "tasks":
-        desc: List of tasks to do
-        type: seq
-        sequence:
-          - type: str
-      "done":
-        desc: List of tasks which have been completed
-        type: seq
-        sequence:
-          - type: str
-      "notes":
-        desc: Free-form notes string
-        type: str