Merge pull request #29 from sp1ff/pr-process

Maintenance commit. This commit:
sp1ff · Apr 19, 2023 · 93c3b46 · 93c3b46
2 parents 4a04c57 + 3b3d2b4
commit 93c3b46
Show file tree

Hide file tree

Showing 36 changed files with 142 additions and 57 deletions.
diff --git a/.github/workflows/melpazoid.yml b/.github/workflows/melpazoid.yml
@@ -1,12 +1,17 @@
 # melpazoid <https://github.com/riscy/melpazoid> build checks.
 name: melpazoid
-on: [push, pull_request]
+
+on:
+  push:
+  pull_request:
+    types: [opened, reopened, edited] # don't say `synchronize`-- that is taken care of by `push`
+
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python 3.6
+    - name: Set up Python 3.10
       uses: actions/setup-python@v1
       with: { python-version: 3.10.11 }
     - name: Install

diff --git a/.github/workflows/pr.yaml b/.github/workflows/pr.yaml
@@ -0,0 +1,48 @@
+name: elfeed-score Pull Request
+# Per
+# <https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request>:
+# "if no activity types are specified, the workflow runs when a pull
+# request is opened or reopened or when the head branch of the pull
+# request is updated." That said, I've had difficulty getting workflows to trigger on PRs.
+on:
+  push:
+  pull_request:
+    types: [opened, edited, reopened] # don't say `synchronize`-- that is taken care of by `push`
+
+jobs:
+  lint_and_test:
+    name: Lint & Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+      - name: Install tooling
+        shell: bash
+        run: |
+          pwd
+          set -x
+          sudo apt-get install -y autoconf automake emacs
+          git clone https://github.com/skeeto/elfeed.git
+      - name: Install a modern version of automake
+        shell: bash
+        run: |
+          pwd
+          set -x
+          cd /tmp
+          curl -L -O https://ftp.gnu.org/gnu/automake/automake-1.16.4.tar.xz
+          tar -xf automake-1.16.4.tar.xz
+          cd automake-1.16.4
+          ./configure && make
+          sudo make install
+      - name: Run unit tests
+        shell: bash
+        run: |
+          pwd
+          ls /usr/share/emacs
+          set -x
+          export EMACSLOADPATH=$(pwd):$(pwd)/elfeed:$(pwd)/elfeed/tests:$(ls -d /usr/share/emacs/2*)/lisp
+          ./bootstrap
+          ./configure
+          make
+          make check
+          make dist
diff --git a/AUTHORS b/AUTHORS
@@ -1,2 +1,4 @@
-Michael Herstine <sp1ff@pobox.com>   Initial versions of all files.
+Samuel W. Flint                      Updated elfeed-score-{,scoring}.el to place the explanation buffer in `help-mode'
+Paul Porfiroff                       Improved docstrings in elfeed-score-scoring.el and the Texinfo manual
 Chris Cundy                          Additions to elfeed-score.el in support of scoring by author(s).
+Michael Herstine <sp1ff@pobox.com>   Initial versions of all files.
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,24 @@
+2023-04-18  Michael Herstine  <sp1ff@pobox.com>
+
+	Maintenance commit. This commit:
+	    - fixes the unit tests
+	    - updates copyrights
+	    - adds a new workflow for PRs
+	    - changes the logic for the "melpazoid" workflow
+
+	Merge branch 'master' of github.com:sp1ff/elfeed-score
+
+	Updating the Python version in the Melpazoid checks.
+
+2023-04-18  Michael  <sp1ff@pobox.com>
+
+	Merge pull request #28 from swflint/master
+	Use with-help-window to make the explanation buffer easily quittable
+
+2023-03-09  Samuel W. Flint  <swflint@flintfam.org>
+
+	Use with-help-window to make the explanation buffer easily quittable
+
 2022-07-02  Michael Herstine  <sp1ff@pobox.com>
 
 	Merge branch 'master' of github.com:sp1ff/elfeed-score

diff --git a/Makefile.am b/Makefile.am
@@ -6,6 +6,7 @@ dist_lisp_LISP = elfeed-score.el elfeed-score-log.el \
 EXTRA_DIST = README.org
 CLEANFILES = .pkg-tmp/ elfeed-score-$(PACKAGE_VERSION).tar
 SUBDIRS = doc test
+AM_ELCFLAGS = --eval '(require (quote bytecomp))'
 
 package: elfeed-score-$(PACKAGE_VERSION).tar $(srcdir)/README.org
 

diff --git a/NEWS b/NEWS
@@ -2,6 +2,10 @@ elfeed-score News -- history of user-visible changes -*- outline -*-
 
 * elfeed-score 1.2
 
+** changes in elfeed-score 1.2.5
+
+*** use `help-mode' for explanation buffers
+*** add a workflow for pull requests
 ** changes in elfeed-score 1.2.4
 
 *** address issue #25 Typo(?) in the readme

diff --git a/README.org b/README.org
@@ -2,7 +2,7 @@
 #+DESCRIPTION: Gnus-style scoring for Elfeed
 #+AUTHOR: Michael Herstine
 #+EMAIL: sp1ff@pobox.com
-#+DATE: <2022-07-02 Sat 08:22>
+#+DATE: <2023-04-18 Tue 17:43>
 #+AUTODATE: t
 #+OPTIONS: toc:nil org-md-headline-style:setext *:t ^:nil
 #+STARTUP: overview
@@ -73,7 +73,7 @@ The easiest way to install elfeed-score is [[https://github.com/melpa/melpa][MEL
 If you would prefer to install the package manually, you can also download the Emacs package file on the GitHub releases [[https://github.com/sp1ff/elfeed-score/releases][page]] or from my personal [[https://www.unwoundstack/distros.html][page]]. Then say:
 
 #+BEGIN_SRC elisp
-(package-install-file "elfeed-score-1.2.4.tar")
+(package-install-file "elfeed-score-1.2.5.tar")
 #+END_SRC
 
 ** Autotools Source Distributions
@@ -82,8 +82,8 @@ You can also download Autotools source tarballs (again available either on the G
 
 #+BEGIN_SRC bash
 cd /tmp
-curl -L --output elfeed-score-1.2.4.tar.gz https://github.com/sp1ff/elfeed-score/releases/download/1.2.4/elfeed-score-1.2.4.tar.gz
-tar xvf elfeed-score-1.2.4.tar.gz && cd elfeed-score-1.2.4
+curl -L --output elfeed-score-1.2.5.tar.gz https://github.com/sp1ff/elfeed-score/releases/download/1.2.5/elfeed-score-1.2.5.tar.gz
+tar xvf elfeed-score-1.2.5.tar.gz && cd elfeed-score-1.2.5
 export EMACSLOADPATH=$HOME/.emacs.d/elpa/elfeed-20200209.1942:$EMACSLOADPATH
 ./configure
 make
@@ -98,16 +98,16 @@ The unit tests require some macros defined by the [[https://github.com/skeeto/el
 #+BEGIN_SRC bash
 cd /tmp
 git clone https://github.com/skeeto/elfeed.git
-curl -L --output=elfeed-score-1.2.4.tar.gz https://github.com/sp1ff/elfeed-score/releases/download/1.2.4/elfeed-score-1.2.4.tar.gz
-tar xvf elfeed-score-1.2.4.tar.gz && cd elfeed-score-1.2.4
-export EMACSLOADPATH=/tmp/elfeed-score-1.2.4:/tmp/elfeed:/tmp/elfeed/tests:$EMACSLOADPATH
+curl -L --output=elfeed-score-1.2.5.tar.gz https://github.com/sp1ff/elfeed-score/releases/download/1.2.5/elfeed-score-1.2.5.tar.gz
+tar xvf elfeed-score-1.2.5.tar.gz && cd elfeed-score-1.2.5
+export EMACSLOADPATH=/tmp/elfeed-score-1.2.5:/tmp/elfeed:/tmp/elfeed/tests:$EMACSLOADPATH
 ./configure
 make
 make check
 sudo make install
 #+END_SRC
 
-Again, unless you already use =EMACSLOADPATH=, you'll need to set =EMACSLOADPATH= appropriately to your system, something like =EMACSLOADPATH=/tmp/elfeed-score-1.2.4:/tmp/elfeed:/tmp/elfeed/tests:/usr/share/emacs/25.2/lisp=.
+Again, unless you already use =EMACSLOADPATH=, you'll need to set =EMACSLOADPATH= appropriately to your system, something like =EMACSLOADPATH=/tmp/elfeed-score-1.2.5:/tmp/elfeed:/tmp/elfeed/tests:/usr/share/emacs/25.2/lisp=.
 ** Building From Source
 
 Finally, you can of course just clone this repo & build there. I've started a [[https://github.com/sp1ff/elfeed-score/wiki][wiki]], whose intended audience are people looking to hack on elfeed-score, that includes build instructions.

diff --git a/THANKS b/THANKS
@@ -4,14 +4,15 @@ Contributors:
   - Chris Cundy <http://cundy.me/>
   - Francisco Claude <fclaude@recoded.ci>
   - Paul Porfiroff
-  - Daniel Fleischer
+  - Daniel Fleischer <https://github.com/danielfleischer>
+  - Samuel W. Flint <https://samuelwflint.com>
 
-Thanks to Qingshui Zheng <https://github.com/qingshuizheng> for his suggestions on cleaning-up the default keybindings for "add rule" commands.
+Thanks to:
 
-Thanks to John Kitchin <https://github.com/jkitchin> for his feature requests & kind words for elfeed-score on his YouTube channel.
-
-Thanks to Firmin Martin <https://github.com/firmart> for noting numerous bugs as well as multiple feature requests.
-
-Thanks to Chris Cundy <http://cundy.me/> for his contributions & suggestions.
-
-Thanks to Christopher Wellons <https://github.com/skeeto> for Elfeed (https://github.com/skeeto/elfeed).
+  - Samuel W. Flint for placing the explanation buffers into help mode
+  - Daniel Fleischer for improving the Texinfo manual & the README
+  - Qingshui Zheng <https://github.com/qingshuizheng> for his suggestions on cleaning-up the default keybindings for "add rule" commands
+  - John Kitchin <https://github.com/jkitchin> for his feature requests & kind words for elfeed-score on his YouTube channel
+  - Firmin Martin <https://github.com/firmart> for noting numerous bugs as well as multiple feature requests
+  - Chris Cundy <http://cundy.me/> for his contributions & suggestions
+  - Christopher Wellons <https://github.com/skeeto> for Elfeed (https://github.com/skeeto/elfeed)
diff --git a/configure.ac b/configure.ac
@@ -1,5 +1,5 @@
 AC_PREREQ([2.69])
-AC_INIT([elfeed-score], [1.2.4], [sp1ff@pobox.com], [elfeed-score], [https://github.com/sp1ff/elfeed-score])
+AC_INIT([elfeed-score], [1.2.5], [sp1ff@pobox.com], [elfeed-score], [https://github.com/sp1ff/elfeed-score])
 AC_CONFIG_AUX_DIR([build-aux])
 AC_CONFIG_SRCDIR([./elfeed-score.el])
 AC_PROG_MAKE_SET

diff --git a/doc/elfeed-score.texi b/doc/elfeed-score.texi
@@ -13,7 +13,7 @@
 @copying
 This manual corresponds to elfeed-score version @value{VERSION}.
 
-Copyright @copyright{} 2021-2022 Michael Herstine <sp1ff@@pobox.com>
+Copyright @copyright{} 2021-2023 Michael Herstine <sp1ff@@pobox.com>
 
 @quotation
 Permission is granted to copy, distribute and/or modify this document

diff --git a/doc/version.texi b/doc/version.texi
@@ -1,4 +1,4 @@
-@set UPDATED 2 July 2022
-@set UPDATED-MONTH July 2022
-@set EDITION 1.2.4
-@set VERSION 1.2.4
+@set UPDATED 19 April 2023
+@set UPDATED-MONTH April 2023
+@set EDITION 1.2.5
+@set VERSION 1.2.5
diff --git a/elfeed-score-log.el b/elfeed-score-log.el
@@ -1,6 +1,6 @@
 ;;; elfeed-score-log.el --- Logging facility for `elfeed-score'  -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2021-2022 Michael Herstine <sp1ff@pobox.com>
+;; Copyright (C) 2021-2023 Michael Herstine <sp1ff@pobox.com>
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by

diff --git a/elfeed-score-maint.el b/elfeed-score-maint.el
@@ -1,6 +1,6 @@
 ;;; elfeed-score-maint.el --- Helpers for maintaining `elfeed-score' rules  -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2021-2022 Michael Herstine <sp1ff@pobox.com>
+;; Copyright (C) 2021-2023 Michael Herstine <sp1ff@pobox.com>
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
@@ -592,6 +592,7 @@ loaded; reload now? "))
                                                      ignore-defaults
                                                      called-interactively)
   "Add title & content rule (TITLE-VALUE, CONTENT-VALUE), poss IGNORE-DEFAULTS.
+CALLED-INTERACTIVELY is as per usual.
 
 Interactively add a new `elfeed-score-title-or-content-rule'
 based on the current Elfeed entry.  This command can be invoked

diff --git a/elfeed-score-pkg.el b/elfeed-score-pkg.el
@@ -1,5 +1,5 @@
 (define-package
   "elfeed-score"
-  "1.2.4"
+  "1.2.5"
   "Gnus-style scoring for Elfeed"
   '((emacs "26.1") (elfeed "3.3.0")))
diff --git a/elfeed-score-rule-stats.el b/elfeed-score-rule-stats.el
@@ -1,6 +1,6 @@
 ;;; elfeed-score-rule-stats.el --- Maintain statistics on `elfeed-score' rules  -*- lexical-binding: t -*-
 
-;; Copyright (C) 2021-2022 Michael Herstine <sp1ff@pobox.com>
+;; Copyright (C) 2021-2023 Michael Herstine <sp1ff@pobox.com>
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by

diff --git a/elfeed-score-rules.el b/elfeed-score-rules.el
@@ -1,6 +1,6 @@
 ;;; elfeed-score-rules.el --- Rules for `elfeed-score'  -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2021-2022 Michael Herstine <sp1ff@pobox.com>
+;; Copyright (C) 2021-2023 Michael Herstine <sp1ff@pobox.com>
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by

diff --git a/elfeed-score-scoring.el b/elfeed-score-scoring.el
@@ -1,6 +1,6 @@
 ;;; elfeed-score-scoring.el --- Logic for scoring (and explaining) `elfeed' entries  -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2021-2022 Michael Herstine <sp1ff@pobox.com>
+;; Copyright (C) 2021-2023 Michael Herstine <sp1ff@pobox.com>
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by

diff --git a/elfeed-score-serde.el b/elfeed-score-serde.el
@@ -1,6 +1,6 @@
 ;;; elfeed-score-serde.el --- SERDE `elfeed-score'  -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2021-2022 Michael Herstine <sp1ff@pobox.com>
+;; Copyright (C) 2021-2023 Michael Herstine <sp1ff@pobox.com>
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by

diff --git a/elfeed-score.el b/elfeed-score.el
@@ -1,9 +1,9 @@
 ;;; elfeed-score.el --- Gnus-style scoring for Elfeed  -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2019-2022 Michael Herstine <sp1ff@pobox.com>
+;; Copyright (C) 2019-2023 Michael Herstine <sp1ff@pobox.com>
 
 ;; Author: Michael Herstine <sp1ff@pobox.com>
-;; Version: 1.2.4
+;; Version: 1.2.5
 ;; Package-Requires: ((emacs "26.1") (elfeed "3.3.0"))
 ;; Keywords: news
 ;; URL: https://github.com/sp1ff/elfeed-score
@@ -44,7 +44,7 @@
 (require 'elfeed-score-scoring)
 (require 'elfeed-score-maint)
 
-(defconst elfeed-score-version "1.2.4")
+(defconst elfeed-score-version "1.2.5")
 
 (defgroup elfeed-score nil
   "Gnus-style scoring for Elfeed entries."

diff --git a/test/Makefile.am b/test/Makefile.am
@@ -1,4 +1,4 @@
-AM_ELCFLAGS = -L ${srcdir}/..
+AM_ELCFLAGS = --eval '(require (quote bytecomp))' -L ${srcdir}/..
 
 TESTS = elfeed-score-tests \
 	test-feed-rules    \

diff --git a/test/elfeed-score-tests.el b/test/elfeed-score-tests.el
@@ -1,6 +1,6 @@
 ;;; elfeed-score-tests.el --- ERT tests for elfeed-score  -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2019-2022 Michael Herstine <sp1ff@pobox.com>
+;; Copyright (C) 2019-2023 Michael Herstine <sp1ff@pobox.com>
 
 ;; Author: Michael Herstine <sp1ff@pobox.com>
 
@@ -191,8 +191,9 @@ URL (which is convenient for testing scoring)."
                                                  tags (authors '((:name "spaceman sp1ff")))
                                                  link)
   "Generate a random entry with feed FEED, title TITLE & content CONTENT.
-Use WITHIN to scope the date.  TAGS specifies tags to be applied in addition
-to 'unread.
+Use WITHIN to scope the date.  TAGS specifies tags to be applied
+in addition to \'unread.  AUTHORS defines entry author(s).  LINK
+specifies the URL for the content.
 
 Warning: run this in `with-elfeed-test'.
 

diff --git a/test/package-test-341.el b/test/package-test-341.el
@@ -1,6 +1,6 @@
 ;;; package-test-341.el --- Test the elfeed-score Emacs package   -*- lexical-binding: t -*-
 
-;; Copyright (C) 2021-2022 Michael Herstine <sp1ff@pobox.com>
+;; Copyright (C) 2021-2023 Michael Herstine <sp1ff@pobox.com>
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by

diff --git a/test/package-test.el b/test/package-test.el
@@ -1,6 +1,6 @@
 ;;; package-test.el --- Test the elfeed-score Emacs package   -*- lexical-binding: t -*-
 
-;; Copyright (C) 2021-2022 Michael Herstine <sp1ff@pobox.com>
+;; Copyright (C) 2021-2023 Michael Herstine <sp1ff@pobox.com>
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by

diff --git a/test/smoke-test-core.el b/test/smoke-test-core.el
@@ -1,6 +1,6 @@
 ;;; smoke-test-core.el --- Core "smoke" test logic  -*- lexical-binding: t -*-
 
-;; Copyright (C) 2021-2022 Michael Herstine <sp1ff@pobox.com>
+;; Copyright (C) 2021-2023 Michael Herstine <sp1ff@pobox.com>
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by

diff --git a/test/smoke-test.el b/test/smoke-test.el
@@ -1,6 +1,6 @@
 ;;; smoke-test.el --- "smoke" tests for `elfeed-score'   -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2019-2022 Michael Herstine <sp1ff@pobox.com>
+;; Copyright (C) 2019-2023 Michael Herstine <sp1ff@pobox.com>
 
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by

diff --git a/test/test-explanations.el b/test/test-explanations.el
@@ -1,6 +1,6 @@
 ;;; test-explanations.el -- ERT tests for the score explanation logic -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2020-2022 Michael Herstine <sp1ff@pobox.com>
+;; Copyright (C) 2020-2023 Michael Herstine <sp1ff@pobox.com>
 
 ;; Author: Michael Herstine <sp1ff@pobox.com>
 
@@ -32,6 +32,7 @@
   (with-elfeed-test
    (let* ((feed (elfeed-score-test-generate-feed "foo"))
           (elfeed-score-scoring-explanation-buffer-name "*explanation-smoke-tests*")
+          (buf (get-buffer-create elfeed-score-scoring-explanation-buffer-name))
           (entry (elfeed-score-test-generate-entry
                   feed "bar" "Lorem ipsum"
                   :authors '((:name "John Hancock"))
@@ -62,9 +63,9 @@
               (list (elfeed-score-tag-rule--create :tags '(b c d) :value 1)))
              (elfeed-score-serde-udf-rules
               (list (elfeed-score-udf-rule--create :function (lambda (_) 1)))))
-        (elfeed-score-scoring-explain-entry entry elfeed-score-scoring-explanation-buffer-name)
+        (elfeed-score-scoring-explain-entry entry buf)
         (let ((text
-               (with-current-buffer "*explanation-smoke-tests*"
+               (with-current-buffer elfeed-score-scoring-explanation-buffer-name
                  (buffer-string))))
           (should
            (string=

diff --git a/test/test-feed-rules.el b/test/test-feed-rules.el
@@ -1,6 +1,6 @@
 ;;; elfeed-score-test-feed-rules -- ERT tests for elfeed-score -*- lexical-binding: t; -*-
 
-;; Copyright (C) 2020-2022 Michael Herstine <sp1ff@pobox.com>
+;; Copyright (C) 2020-2023 Michael Herstine <sp1ff@pobox.com>
 
 ;; Author: Michael Herstine <sp1ff@pobox.com>