plansheet 0.1.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a563b95ceb3605f848e88baabd37ba4c2512d621bbac5b656b53333143ac22b
-  data.tar.gz: b92dd0d8690e7bd164f396d898b0b2bc530092537d05024d4d01ac8211583f59
+  metadata.gz: e78fa7422ef53cce690b2d8500c406ac6bb2136d195725b3d839d67cc234c780
+  data.tar.gz: 65093bd8b89bf39b2a144de85867bcb4635e41f5a8c379b8486c0a8a0135cebb
 SHA512:
-  metadata.gz: 82917bb297389a27eeda311ea87e940b73c84b7b1605f0b6887b2c4b32bd825ce84427446087144da1b1559c5afa0edcf51de0c3dc65562c1a0235f7c358b7c8
-  data.tar.gz: be2d3efa2d984fba4bc23ed71be01788187a63d91166dd9baf51dac84e0ff74a7ec52e45b7fdfac9bfc92d370a71012fdd22d40dc43bd3a63b3a636a40ce6da2
+  metadata.gz: a70d01f6617f79041d95e4a1b596f68c36de68a9be8abd7be684f3d394dd15a5d49bc0a7560435670fab7d5fc59dd505c1f4adee0aba68d7feaed46cc2f61bcb
+  data.tar.gz: f63764aaaca3a1a7efa75c07f2776d279171dc297cee0d34306416690fb2b08f5c85697f7d1ebc1a40a03671727f3162f0293d552231405c0084438a61dfb9b6

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.1.0)
+    plansheet (0.3.3)
       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,7 +1,9 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require "kwalify"
 require "yaml"
+require "plansheet"
 
 begin
   config = YAML.load_file "#{Dir.home}/.plansheet.yml"
@@ -9,20 +11,19 @@ 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))
+  validator = Kwalify::Validator.new(Plansheet::PROJECT_SCHEMA)
+  errors = validator.validate(contents)
+  # Check YAML validity
+  if errors && !errors.empty?
+    $stderr.write "Schema errors in #{l}\n"
+    errors.each { |err| puts "- [#{err.path}] #{err.message}" }
+    abort
+  end
+
   key = l.gsub(".yml", "")
   contents.each do |project|
     key = project["project"]
@@ -42,10 +43,11 @@ projects.each do |l|
   end
 end
 
-sorted_hash = project_hash.sort_by { |_, v| status_priority[v[:status]] }
+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"
@@ -56,7 +58,7 @@ def project_minipage(proj)
   str
 end
 
-require 'date'
+require "date"
 projects_str = String.new
 projects_str << <<~FRONTMATTER
   ---
@@ -67,11 +69,13 @@ projects_str << <<~FRONTMATTER
   # Date: #{Date.today}
 FRONTMATTER
 
-sorted_hash.first(30).each do |_, p|
+sorted_hash.first(60).each do |_, p|
   projects_str << project_minipage(p)
 end
 
+output_file = "#{config["output_dir"]}/projects.md"
+puts "Writing to #{output_file}"
 Dir.mkdir config["output_dir"] unless Dir.exist? config["output_dir"]
-f = File.open("#{config["output_dir"]}/projects.md", "w")
+f = File.open(output_file, "w")
 f.write(projects_str)
 f.close

data/exe/plansheet-sorter

@@ -0,0 +1,25 @@
+#!/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/lib/plansheet/project.rb

@@ -0,0 +1,62 @@
+# 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
+          "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)
+end

data/lib/plansheet/version.rb

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

data/lib/plansheet.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "plansheet/version"
+require_relative "plansheet/project"
 
 module Plansheet
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plansheet
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.3
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-18 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dc-kwalify
@@ -29,6 +29,7 @@ email:
 - dave@dafyddcrosby.com
 executables:
 - plansheet
+- plansheet-sorter
 extensions: []
 extra_rdoc_files: []
 files:
@@ -39,15 +40,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/backpack.yml
 - exe/plansheet
+- exe/plansheet-sorter
 - lib/plansheet.rb
+- lib/plansheet/project.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/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