plansheet 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ccfb13735d8626143db08903deac727870c66e6bd6fec21648fd70bf4050727
-  data.tar.gz: 847f0a0f78cdb0035ee03829f2761e3780fb6296738ac89bcca55635079b9e3a
+  metadata.gz: bddf541a519a646283dbd872816140c667290b05fe81a38a79297e283f48f87b
+  data.tar.gz: 49e9670228ddb622b9cc332f4bd5f8b943bf674b242851212aabfa6384a1162f
 SHA512:
-  metadata.gz: 34835dc03602c977afb76a4b5202f3ccf7322445086550d11d6506a4cce329f437d1f1a650b8500f46f6f81d72879f8a0ed506ed087411c68c1362b50523aeb8
-  data.tar.gz: ff0832cc110fa2f8ab2350867aa9c3642cc4eeb6ad9bea9cb620e69dceb4afe5f8e139d9c23f4d9bfd5270000ebc4f5885d1a6cce5ea5db2270edd3caf277428
+  metadata.gz: 697436e3c7dbc92323a321c75b23ef47a2c4c6f632f93bd4686a95a84b9edd4004691055d2aadfb75f802aaf1b4d88554f3a4f32e8e79942c4e073c65835dd5a
+  data.tar.gz: 285490462d0ff27a9e3a81ae09baaac60754260e6a64fc15c5ad52887d2d1df815e41c84854b98cdbe07d5d6799ddb39f1fc99e52de4b44c41ea85e6b46f2bd0

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.3.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

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require "yaml"
+require "plansheet"
 
 begin
   config = YAML.load_file "#{Dir.home}/.plansheet.yml"
@@ -9,16 +10,6 @@ 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|
@@ -42,7 +33,9 @@ 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
@@ -67,7 +60,7 @@ 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
 

data/exe/plansheet-sorter

@@ -4,16 +4,7 @@
 # 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
-}
+require "plansheet"
 
 def project_priority(project)
   if project["status"]
@@ -27,6 +18,8 @@ end
 
 filename = ARGV.first
 contents = YAML.load_file(filename)
-sorted_hash = contents.sort_by { |project| status_priority[project_priority project] }
+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

@@ -0,0 +1,19 @@
+#!/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

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.2.0"
+  VERSION = "0.3.1"
 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.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-19 00:00:00.000000000 Z
+date: 2022-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dc-kwalify
@@ -30,6 +30,7 @@ email:
 executables:
 - plansheet
 - plansheet-sorter
+- plansheet-validator
 extensions: []
 extra_rdoc_files: []
 files:
@@ -40,16 +41,19 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/backpack.yml
 - exe/plansheet
 - exe/plansheet-sorter
+- exe/plansheet-validator
 - 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