Update build workflow and tests

Author: tgross35

.clippy.toml

@@ -0,0 +1 @@
+doc-valid-idents = ["MessagePack"]

.github/workflows/release-rust.yaml

@@ -103,10 +103,11 @@ jobs:
           # Remove the "unreleased" section from our changelog
           perl -0777 -i -pe "s/(<\!-- next-header -->.*## \[Unreleased\].*?\n)(?=## |<\!--)//gms" CHANGELOG.md
 
-          ./dist/create_install_makefile.sh
+          # Create Makefile.dist for shipping with the package
+          sh dist/create_install_makefile.sh
           
           cp {README.md,LICENSE} "$staging/"
-          cp Makefile.tmp "$staging/Makefile"
+          cp Makefile.dist "$staging/Makefile"
           cp CHANGELOG.md "$staging/doc/"
           # Copy manpages
           cp "$cargo_outdir"/msgpack.1 "$staging/doc"

.github/workflows/validation-rust.yaml

@@ -66,20 +66,20 @@ jobs:
       - name: Test make
         if: matrix.os != 'windows-latest'
         run: |
-          ./dist/create_install_makefile.sh
-          cargo_outdir="$(find "${{ env.TARGET_DIR }}" -name zspell-stamp -print0 | xargs -0 ls -t | head -n1 | xargs dirname)"
+          sh dist/create_install_makefile.sh
+          cargo_outdir="$(find target -name zspell-stamp -print0 | xargs -0 ls -t | head -n1 | xargs dirname)"
           mkdir testdir
           mv Makefile.tmp testdir/Makefile
           mv target
           cd testdir
           make install
           test -f /usr/local/bin/msgpack
           test -f /usr/local/share/man/msgpack.1
-          test -f /usr/share/bash-completion/completions
+          test -f /usr/share/bash-completion/completions/msgpack.bash
           make uninstall
           test ! -f /usr/local/bin/msgpack
           test ! -f /usr/local/share/man/msgpack.1
-          test ! -f /usr/share/bash-completion/completions
+          test ! -f /usr/share/bash-completion/completions/msgpack.bash
 
   miri:
     name: Miri

Makefile

@@ -1,20 +1,34 @@
 # This makefile will build (via Cargo)
 
+MAKEFLAGS=--warn-undefined-variables
 VERSION=0.1.0
+CARGO := $(shell command -v cargo 2> /dev/null)
+
 
+# Install locations
 DESTDIR=
+MANFILE=msgpack.1
 PREFIX=/usr/local
 AUTOPFX=/usr/share
+MANDEST=${DESTDIR}${PREFIX}/share/man/man1
+BINDEST=${DESTDIR}${PREFIX}/bin
+COMPDEST_BASH=${AUTOPFX}/bash-completion/completions
+COMPDEST_FISH=${AUTOPFX}/fish/vendor_completions.d
+COMPDEST_ZSH=${AUTOPFX}/zsh/vendor-completions
+
+USE_RELEASED_INSTALL=0
+
+ifeq ($(USE_RELEASED_INSTALL),1)
+BINSOURCE= .
+MANSOURCE = doc
+COMPLETESOURCE = completion
+else
+builddir=$(shell find target -name msgpack-stamp -print0 | xargs -0 ls -t | head -n1 | xargs dirname)
+BINSOURCE = target/release
+MANSOURCE = $(builddir)
+COMPLETESOURCE = $(builddir)
+endif
 
-MANDIR=${DESTDIR}/${PREFIX}/share/man
-BINDIR=${DESTDIR}/${PREFIX}/bin
-MANFILE=msgpack.1
-
-BASHACDIR="${AUTOPFX}/bash-completion/completions
-FISHACDIR="${AUTOPFX}/fish/vendor_completions.d
-ZSHACDIR="${AUTOPFX}/zsh/vendor-completions
-
-CARGO := $(shell command -v cargo 2> /dev/null)
 
 all: msgpack
 
@@ -31,42 +45,38 @@ ifeq ($(OS),Windows_NT)
 	$(error install does not yet work on Windows)
 	exit 1
 endif
-	$(info installing binary, manpages, and shell complete)
-
-	BUILDDIR="$(find target -name msgpack-stamp -print0 | xargs -0 ls -t | head -n1 | xargs dirname)"
 
-	# We override these in our release script
-	BUILT_MANDIR=${BUILDDIR}
-	BUILT_COMPLETEDIR=${BUILDDIR}
-
-	install -d ${MANDIR}/man1
-	install target/release/msgpack ${DESTDIR}/msgpack; \
-	install -m 644 ${BUILT_MANDIR}/${MANFILE} ${MANDIR}/man1/${MANFILE}
-
-	INSTALLEDAC=0
-
-	if [ -d "${BASHACDIR}" ]; then \
-		install ${BUILDDIR}/msgpack.bash ${BASHACDIR}/msgpack.bash; \
-		$(info installed bash autocomplete); \
-		INSTALLEDAC=1
-	fi
-
-	if [ -d "${FISHACDIR}" ]; then \
-		install ${BUILDDIR}/msgpack.fish ${FISHACDIR}/msgpack.fish; \
-		$(info installed fish autocomplete); \
-		INSTALLEDAC=1
+	$(info installing binary, manpages, and shell completion scripts)
+	$(info binary source: ${BINSOURCE})
+	$(info manpage source: ${MANSOURCE})
+	$(info completion source: ${COMPLETESOURCE})
+
+	install -d ${BINDEST}
+	install -d ${MANDEST}
+	install ${BINSOURCE}/msgpack ${BINDEST}/msgpack
+	install -m 644 ${MANSOURCE}/${MANFILE} ${MANDEST}/${MANFILE}
+
+	INSTALLEDAC=0; \
+	if [ -d "${COMPDEST_BASH}" ]; then \
+		install "${COMPLETESOURCE}/msgpack.bash" "${COMPDEST_BASH}/msgpack.bash"; \
+		echo installed bash autocomplete; \
+		INSTALLEDAC=1; \
+	fi; \
+	if [ -d "${COMPDEST_FISH}" ]; then \
+		install "${COMPLETESOURCE}/msgpack.fish" "${COMPDEST_FISH}/msgpack.fish"; \
+		echo installed fish autocomplete; \
+		INSTALLEDAC=1; \
+	fi; \
+	if [ -d "${COMPDEST_ZSH}" ]; then \
+		install "${COMPLETESOURCE}/_msgpack" "${COMPDEST_ZSH}/_msgpack"; \
+		echo installed zsh autocomplete; \
+		INSTALLEDAC=1; \
+	fi; \
+	if [ "$${INSTALLEDAC}" = "0" ]; then \
+		echo did not find any directorys to install autocompletion scripts; \
 	fi
 
-	if [ -d "${ZSHACDIR}" ]; then \
-		install ${BUILDDIR}/_msgpack ${ZSHACDIR}/_msgpack; \
-		$(info installed zsh autocomplete); \
-		INSTALLEDAC=1
-	fi
-
-ifeq (${INSTALLEDAC},0)
-	$(info did not find any directorys to install autocompletion scripts)
-endif
-
+	$(info install completed successfully)
 
 clean:
 ifndef CARGO
@@ -78,8 +88,8 @@ endif
 
 uninstall:
 	$(info cleaning install directory)
-	rm -f ${DESTDIR}/msgpack
-	rm -f ${MANDIR}/man1/${MAN}
-	rm -f ${BASHACDIR}/msgpack.bash
-	rm -f ${FISHACDIR}/msgpack.fish
-	rm -f ${ZSHACDIR}/_msgpack
+	rm -f ${BINDEST}/msgpack
+	rm -f ${MANDEST}/man1/${MANFILE}
+	rm -f ${COMPDEST_BASH}/msgpack.bash
+	rm -f ${COMPDEST_FISH}/msgpack.fish
+	rm -f ${COMPDEST_ZSH}/_msgpack

build.rs

@@ -59,7 +59,7 @@ fn main() -> Result<(), std::io::Error> {
     let make_dist = std::env::var("MAKE_DIST").map_or(false, |v| v == "1");
 
     // Don't generate outputs if we're in debug mode
-    if make_dist || profile.as_str() != "debug"  {
+    if make_dist || profile.as_str() != "debug" {
         // Create a dummy file to help find the latest output
         let stamp_path = Path::new(&outdir).join("msgpack-stamp");
         if let Err(err) = File::create(&stamp_path) {

dist/create_install_makefile.sh

@@ -2,12 +2,12 @@
 # Generate a makefile suitable for prebuilt binaries
 
 # Remove all targets except install & uninstall
-perl -0777 -pe 's/^(?!install|uninstall)\w+:.*?(?=^\w+:|\Z)//gms' Makefile > Makefile.tmp
+perl -0777 -pe 's/^(?!install|uninstall)\w+:.*?(?=^\w+:|\Z)//gms' Makefile > Makefile.dist
 
 # Strip target prerequisites
-perl -0777 -i -pe 's/^((?:install|uninstall):)(.+)$/$1/gm' Makefile.tmp
+perl -0777 -i -pe 's/^((?:install|uninstall):)(.+)$/$1/gm' Makefile.dist
 
 # Remove BUILDDIR, update man & complete locations
-perl -0777 -i -pe 's/^\s+BUILDDIR=.*$//gm' Makefile.tmp
-perl -0777 -i -pe 's/^(\s+BUILT_MANDIR=).*$/$1\/doc/gm' Makefile.tmp
-perl -0777 -i -pe 's/^(\s+BUILT_COMPLETEDIR=).*$/$1\/completion/gm' Makefile.tmp
+perl -0777 -i -pe 's/^\s+builddir=.*$//gm' Makefile.dist
+perl -0777 -i -pe 's/^(\s+BUILT_MANDIR=).*$/$1\/doc/gm' Makefile.dist
+perl -0777 -i -pe 's/^(\s+USE_RELEASED_INSTALL=).*$/$1 1/gm' Makefile.dist

src/main.rs

@@ -1,7 +1,7 @@
 //! MessagePack command line interface
 //!
 //! Install with `cargo install msgpack-cli` or get a prebuilt binary on the
-//! releases page: https://github.com/pluots/msgpack-cli/releases
+//! releases page: <https://github.com/pluots/msgpack-cli/releases>
 
 #![warn(clippy::pedantic)]
 #![warn(clippy::cargo)]
@@ -139,7 +139,7 @@ impl fmt::Display for Error {
             ),
             Self::NoDirection => write!(
                 f,
-                "Could not determine conversion direction. Specify '--to-json' or '--to-msgpack'."
+                "Could not determine conversion direction. Specify '--to-json' or '--to-msgpack' ('-j'/'-m')."
             ),
             Self::MessagePak(e) => write!(f, "Unable to parse MessagePack input, {e}"),
             Self::Json(e) => write!(f, "Unable to parse JSON input, {e}"),
@@ -269,16 +269,15 @@ where
     };
 
     let mut deserializer = rmp_serde::Deserializer::new(deser_buf);
-    let out_writer;
-
-    if pretty {
+    // Run serializer, get our output writer back
+    let out_writer = if pretty {
         let mut serializer = serde_json::Serializer::pretty(output);
         serde_transcode::transcode(&mut deserializer, &mut serializer)?;
-        out_writer = serializer.into_inner();
+        serializer.into_inner()
     } else {
         let mut serializer = serde_json::Serializer::new(output);
         serde_transcode::transcode(&mut deserializer, &mut serializer)?;
-        out_writer = serializer.into_inner();
+        serializer.into_inner()
     };
 
     // Return ownership of the output