Release 0.5.0.0

Author: TravisCardwell

CHANGELOG.md

@@ -24,6 +24,16 @@ following conventions:
 
 [KaC]: <https://keepachangelog.com/en/1.0.0/>
 
+## 0.5.0.0 (2020-11-08)
+
+### Breaking
+
+* Add simplified CSV support for tags and items
+
+### Non-Breaking
+
+* Rename Git default branch to `main`
+
 ## 0.4.0.0 (2020-09-12)
 
 ### Breaking

Makefile

@@ -139,7 +139,7 @@ repl: # enter a REPL *
 source-git: # create source tarball of git TREE
 > $(eval TREE := "HEAD")
 > $(eval BRANCH := $(shell git rev-parse --abbrev-ref $(TREE)))
-> @test "${BRANCH}" = "master" || echo "WARNING: Not in master branch!" >&2
+> @test "${BRANCH}" = "main" || echo "WARNING: Not in main branch!" >&2
 > $(eval VERSION := $(shell \
     grep '^version:' $(CABAL_FILE) | sed 's/^version: *//'))
 > @mkdir -p build

README.md

@@ -1,6 +1,6 @@
 # Queue Sheet
 
-[![Build Status](https://travis-ci.com/ExtremaIS/queue-sheet-haskell.svg?branch=master)](https://travis-ci.com/ExtremaIS/queue-sheet-haskell)
+[![Build Status](https://travis-ci.com/ExtremaIS/queue-sheet-haskell.svg?branch=main)](https://travis-ci.com/ExtremaIS/queue-sheet-haskell)
 
 * [Overview](#overview)
 * [Requirements](#requirements)
@@ -66,7 +66,7 @@ no plans to put the package on Hackage.
 
 ### Releases
 
-All releases are tagged in the `master` branch.  Release tags are signed using
+All releases are tagged in the `main` branch.  Release tags are signed using
 the
 [`[email protected]` GPG key](http://keys.gnupg.net/pks/lookup?op=vindex&fingerprint=on&search=0x1D484E4B4705FADF).
 

default.nix

@@ -1,2 +1,35 @@
-{ nixpkgs ? import <nixpkgs> {}, compiler ? "ghc883" }:
-nixpkgs.pkgs.haskell.packages.${compiler}.callPackage ./queue-sheet.nix { }
+let
+
+  nixpkgsRev = "cd63096d6d88";
+  compilerVersion = "ghc884";
+
+  githubTarball = owner: repo: rev:
+    builtins.fetchTarball { url = "https://github.com/${owner}/${repo}/archive/${rev}.tar.gz"; };
+
+  gitIgnore = pkgs.nix-gitignore.gitignoreSourcePure;
+
+  config = {
+    packageOverrides = super: let self = super.pkgs; in rec {
+      haskell = super.haskell // {
+        packageOverrides = self: super: {
+          haskell-nix = super.callCabal2nix "haskell-nix" (gitIgnore [./.gitignore] ./.) {};
+        };
+      };
+    };
+  };
+
+  pkgs = import (githubTarball "NixOS" "nixpkgs" nixpkgsRev) { inherit config; };
+  compilerSet = pkgs.haskell.packages."${compilerVersion}";
+
+in {
+
+  inherit pkgs;
+
+  shell = compilerSet.shellFor {
+    packages = p: [p.haskell-nix];
+    buildInputs = with pkgs; [
+      compilerSet.cabal-install
+    ];
+  };
+
+}

doc/queue-sheet.1.md

@@ -50,7 +50,7 @@ Queues are specified in YAML format.  They may be specified in a few different
 ways, depending on how you want to organize them.
 
 To create a queue sheet of queues without sections, the YAML file consists of
-a list of queue objects, which have the following properties:
+an array of queue objects, which have the following properties:
 
 *name*
 :   queue name (string, required)
@@ -62,27 +62,34 @@ a list of queue objects, which have the following properties:
 :   date of last update (string, optional)
 
 *tags*
-:   list of tags (list of string, optional)
+:   list of tags (simplified CSV string or array of strings, optional)
 
 *prev*
 :   previous item (item, optional)
 
 *next*
-:   list of next items (list of items, optional)
+:   list of next items (simplified CSV string or array of items, optional)
 
 The only required property is *name*.
 
-The *tags* property is a list of string tags that are associated with the
-queue.  A tag must consist of at least one ASCII letter, number, period,
-underscore, or dash.  For example, tag "complete" can be used to indicate that
-there will be no new episodes of a podcast that is complete.
+The *tags* property associates one or more string tags with the queue.  Tags
+can be specified using a string in simplified CSV format or an array of
+strings.  A simplified CSV string is split on commas, and leading/trailing
+whitespace is stripped from each item.  A tag must consist of at least one
+ASCII letter, number, period, underscore, or dash.  For example, tag
+"complete" can be used to indicate that there will be no new episodes of a
+podcast that is complete.
 
 The *next* property is a list of next items in the queue.  When the list is
 exhausted, the previous item can be specified using the *prev* property.  If
 both *prev* and *next* are specified, *prev* is ignored.
 
-Items can be specified by name only, using a string or a number.  To associate
-a URL or tags with an item, use an object with the following properties:
+Next items can be specified using a string in simplified CSV format or an
+array or items.  A simplified CSV string is split on commas, and
+leading/trailing whitespace is stripped from each item.  When specifying items
+using an array, the item name can be specified using a string or a number, or
+an object with the following properties can be used in order to specify more
+item information:
 
 *name*
 :   name of the item (string, required)
@@ -91,19 +98,19 @@ a URL or tags with an item, use an object with the following properties:
 :   item URL (string, optional)
 
 *tags*
-:   list of tags (list of string, optional)
+:   list of tags (simplified CSV string or array of strings, optional)
 
 To organize queues into sections, the YAML file should be written as an object
 with two properties:
 
 *sections*
-:   list of sections names (optional)
+:   list of sections names (array of strings, optional)
 
 *queues*
-:   list of queue objects (required)
+:   list of queue objects (array of queue objects, required)
 
 Sections names are specified using strings.  The order that the sections are
-listed determines the order that they are displayed on the queue sheet.
+specified determines the order that they are displayed on the queue sheet.
 
 Queue objects are as above, with an additional property to specify the
 section:
@@ -115,8 +122,8 @@ Queues that are not explicitly associated with a section are associated with
 an implicit default section.
 
 To make it easier to share queue files, imports are also supported.  Import
-another queue file using an import object instead of a queue object in a list
-of queues.  An import object has the following properties:
+another queue file using an import object instead of a queue object in an
+array of queues.  An import object has the following properties:
 
 *import*
 :   path to the queue file to import (string, required)

examples/podcasts.pdf

@@ -52,10 +52,7 @@ queues:
     url: https://www.preposterousuniverse.com/podcast/
     date: 2020-08-17
     section: Other
-    next:
-      - 108
-      - 109
-      - 110
+    next: 108,109,110
 
   - name: Quanta
     url: https://www.quantamagazine.org/tag/podcast/

examples/podcasts.yaml

@@ -0,0 +1,18 @@
+# `queue-sheet-haskell` `0.5.0.0` Release Notes
+
+Date
+: 2020-11-08
+
+## Overview
+
+This release of Queue Sheet adds support for specifying lists of tags or items
+as a string in a simplified CSV format.  Use of the CSV format can result in
+fewer changes when updating a file, making the update slightly easier to
+perform and the `git diff` output easier to read.  See the updated man page
+for details.
+
+This release also switches the Git default branch to `main`.
+
+YAML files used with version `0.4.0.0` work with version `0.5.0.0` without
+change, but YAML files that the new CSV format will not work with version
+`0.4.0.0` or before.

project/release/queue-sheet-haskell-0.5.0.0.md

@@ -1,5 +1,5 @@
 name:           queue-sheet
-version:        0.4.0.0
+version:        0.5.0.0
 category:       Utils
 synopsis:       queue sheet utility
 description:
@@ -53,6 +53,7 @@ library
     , text
     , transformers
     , ttc
+    , vector
     , yaml
   default-language: Haskell2010
   ghc-options: -Wall

queue-sheet.cabal

@@ -1,2 +1 @@
-{ nixpkgs ? import <nixpkgs> {}, compiler ? "ghc883" }:
-(import ./default.nix { inherit nixpkgs compiler; }).env
+(import ./default.nix).shell

queue-sheet.nix

@@ -69,6 +69,9 @@ import Data.Text (Text)
 -- https://hackage.haskell.org/package/ttc
 import qualified Data.TTC as TTC
 
+-- https://hackage.haskell.org/package/vector
+import qualified Data.Vector as V
+
 ------------------------------------------------------------------------------
 -- $Name
 
@@ -174,7 +177,7 @@ instance FromJSON Item where
     (A.Object o) -> do
       itemName <- o .:  "name"
       itemUrl  <- o .:? "url"
-      itemTags <- o .:? "tags" .!= []
+      itemTags <- maybe (pure []) parseCSV =<< (o .:? "tags")
       return Item{..}
     value -> do
       itemName <- Name <$> parseToString value
@@ -209,13 +212,13 @@ instance FromJSON Queue where
     queueUrl     <- o .:? "url"
     queueDate    <- o .:? "date"
     queueSection <- o .:? "section" .!= defaultSection
-    queueTags    <- o .:? "tags"    .!= []
+    queueTags    <- maybe (pure []) parseCSV =<< (o .:? "tags")
     mPrevItem    <- o .:? "prev"
-    mNextItems   <- o .:? "next"
-    let queueItems = case (mPrevItem, mNextItems) of
-          (_,         Just items) -> Just $ Right items
-          (Just item, Nothing)    -> Just $ Left item
-          (Nothing,   Nothing)    -> Nothing
+    mNextValue   <- o .:? "next"
+    queueItems   <- case (mPrevItem, mNextValue) of
+      (_,         Just nextValue) -> Just . Right <$> parseCSV nextValue
+      (Just item, Nothing)        -> pure . Just $ Left item
+      (Nothing,   Nothing)        -> pure Nothing
     return Queue{..}
 
 ------------------------------------------------------------------------------
@@ -306,6 +309,17 @@ escapeTeX = T.foldl go ""
       '~'  -> acc <> "\\textasciitilde{}"
       c    -> acc `T.snoc` c
 
+-- | Parse an array or string in simplified CSV format
+--
+-- Strings are split on commas, and leading/trailing whitespace is removed
+-- from each item.
+parseCSV :: A.FromJSON a => A.Value -> AT.Parser [a]
+parseCSV = \case
+    (A.String t) -> mapM (parseJSON . A.String . T.strip) $ T.splitOn "," t
+    (A.Array v)  -> mapM parseJSON $ V.toList v
+    A.Object{}   -> fail "unexpected object"
+    value        -> (: []) <$> parseJSON value
+
 -- | Parse any scalar value as a string
 --
 -- Strings, numbers, booleans, and null are parsed as a string.  Empty

shell.nix

@@ -1,4 +1,4 @@
-resolver: lts-16.13
+resolver: lts-16.20
 
 packages:
 - .