Upgrade the score file on initial load.

This commit causes elfeed-score to immediately re-write the
score file in the current format version when it is asked to
load a score file in an archaic version.

Author: sp1ff

ChangeLog

@@ -1,15 +1,15 @@
-2021-02-28  Michael Herstine  <[email protected]>
+2021-03-02  Michael Herstine  <[email protected]>
 
-	Fix issue #12.
-	Announce the fact when making a backup copy of the score file.
-	If there is an error on copy, say so & continue (i.e. don't
-	error out).
+	Upgrade the score file on initial load.
+	This commit causes elfeed-score to immediately re-write the
+	score file in the current format version when it is asked to
+	load a score file in an archaic version.
 
 2021-03-01  Michael Herstine  <[email protected]>
 
 	Re-factor 'elfeed-score-scoring.el' to define the logic for title, content, authors & link rules via macro rather than individually.
 
-2021-02-27  Michael Herstine  <[email protected]>
+2021-03-01  Michael Herstine  <[email protected]>
 
 	Address issue #11.
 	This commit introduces a new rule type: link. Link scoring rules
@@ -18,6 +18,13 @@
 
 	Additionally, this commit raises the format version to 7.
 
+2021-02-28  Michael Herstine  <[email protected]>
+
+	Fix issue #12.
+	Announce the fact when making a backup copy of the score file.
+	If there is an error on copy, say so & continue (i.e. don't
+	error out).
+
 2021-02-26  Michael Herstine  <[email protected]>
 
 	Fixed a few typos in the release workflow.

NEWS

@@ -1,5 +1,10 @@
 elfeed-score News -- history of user-visible changes -*- outline -*-
 
+* Changes in elfeed-score 0.7.7
+
+** New Features
+
+*** When reading an older score file, immediately re-write in the most recent format
 * Changes in elfeed-score 0.7.6
 
 No user-visible changes in this build; strictly re-factoring.

README.org

@@ -2,7 +2,7 @@
 #+DESCRIPTION: Gnus-style scoring for Elfeed
 #+AUTHOR: Michael Herstine
 #+EMAIL: [email protected]
-#+DATE: <2021-03-01 Mon 19:28>
+#+DATE: <2021-03-02 Tue 08:24>
 #+AUTODATE: t
 #+OPTIONS: toc:nil org-md-headline-style:setext *:t ^:nil
 
@@ -71,7 +71,7 @@ The easiest way to install elfeed-score is [[https://github.com/melpa/melpa][MEL
 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-0.7.6.tar")
+(package-install-file "elfeed-score-0.7.7.tar")
 #+END_SRC
 
 ** Autotools Source Distributions
@@ -80,8 +80,8 @@ You can also download Autotools source tarballs (again available either on the G
 
 #+BEGIN_SRC bash
 cd /tmp
-curl -L --output elfeed-score-0.7.6.tar.gz https://github.com/sp1ff/elfeed-score/releases/download/0.7.6/elfeed-score-0.7.6.tar.gz
-tar xvf elfeed-score-0.7.6.tar.gz && cd elfeed-score-0.7.6
+curl -L --output elfeed-score-0.7.7.tar.gz https://github.com/sp1ff/elfeed-score/releases/download/0.7.7/elfeed-score-0.7.7.tar.gz
+tar xvf elfeed-score-0.7.7.tar.gz && cd elfeed-score-0.7.7
 export EMACSLOADPATH=$HOME/.emacs.d/elpa/elfeed-20200209.1942:$EMACSLOADPATH
 ./configure
 make
@@ -96,20 +96,32 @@ 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-0.7.6.tar.gz https://github.com/sp1ff/elfeed-score/releases/download/0.7.6/elfeed-score-0.7.6.tar.gz
-tar xvf elfeed-score-0.7.6.tar.gz && cd elfeed-score-0.7.6
-export EMACSLOADPATH=/tmp/elfeed-score-0.7.6:/tmp/elfeed:/tmp/elfeed/tests:$EMACSLOADPATH
+curl -L --output=elfeed-score-0.7.7.tar.gz https://github.com/sp1ff/elfeed-score/releases/download/0.7.7/elfeed-score-0.7.7.tar.gz
+tar xvf elfeed-score-0.7.7.tar.gz && cd elfeed-score-0.7.7
+export EMACSLOADPATH=/tmp/elfeed-score-0.7.7:/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-0.7.6:/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-0.7.7:/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.
+* Upgrading Your Score File
+
+The format of the score file is updated fairly regularly to accomodate new features, new rule types, and so forth. elfeed-score maintains backward compatibility in that score files in older format versions are still recognized. The most recent format version will always be used when the score file is written to disk, however. Note than an older elfeed-score will reject a more recent score file (since it will not know how to parse it).
+
+When elfeed-score loads a score file that uses an archaic format (i.e. a format verseion less than =elfeed-scor-serde-current-format=) it will:
+
+  - announce the fact that your score file will be updated
+  - make a backup of your current score file in a file by the same name with a suffix of =~%d~= appended, where "%d" is the current format version
+  - on successful parse, immediately re-write the score file in the most recent version
+
+This should all be transparent to the user.
+
 * Status and Roadmap
 
 I've been using [[https://github.com/sp1ff/elfeed-score][elfeed-score]] day in & day out for my RSS reading for over a year now. I wrote a post on how [[https://github.com/sp1ff/elfeed-score][elfeed-score]] works, along with the process of submitting code to MELPA, [[https://www.unwoundstack.com/blog/scoring-elfeed-entries.html][here]]. [[https://github.com/C-J-Cundy][Chris]] wrote a post on how he uses it to [[https://cundy.me/post/elfeed/][manage ArXiv RSS Feeds]]. 

configure.ac

@@ -1,4 +1,4 @@
-AC_INIT([elfeed-score], [0.7.6], [[email protected]], [elfeed-score], [https://github.com/sp1ff/elfeed-score])
+AC_INIT([elfeed-score], [0.7.7], [[email protected]], [elfeed-score], [https://github.com/sp1ff/elfeed-score])
 AC_CONFIG_AUX_DIR([build-aux])
 AC_CONFIG_SRCDIR([./elfeed-score.el])
 

doc/elfeed-score.texi

@@ -325,19 +325,21 @@ recent score file.
 
 @cindex score file version
 
-When elfeed-score loads a score file that uses an archaic
-version (i.e. a version less than
-@code{elfeed-score-serde-current-format}) it will announce the fact
-that your score file will be updated and make a backup of your current
-score file in @code{%s.~%d~} where @code{%s} is replaced by
-@code{elfeed-score-serde-score-file} and @code{%d} is replaced by your
-score file's current version (so that you will end up with a copy of
-the last score file in each format over time).
+When elfeed-score loads a score file that uses an archaic version
+(i.e. a version less than @code{elfeed-score-serde-current-format}) it
+will announce the fact that your score file will be updated and make a
+backup of your current score file in @code{%s.~%d~} where @code{%s} is
+replaced by @code{elfeed-score-serde-score-file} and @code{%d} is
+replaced by your score file's current version (so that you will end up
+with a copy of the last score file in each format over time).
 
 @defvar elfeed-score-serde-current-format
 The version of the score file format employed by elfeed-score.
 @end defvar
 
+It will also immediately re-write the score file in the current
+format.
+
 @item
 ``title''
 The sublist named by the string ``title'' contains rules that

doc/version.texi

@@ -1,4 +1,4 @@
 @set UPDATED 2 March 2021
 @set UPDATED-MONTH March 2021
-@set EDITION 0.7.6
-@set VERSION 0.7.6
+@set EDITION 0.7.7
+@set VERSION 0.7.7

elfeed-score-pkg.el

@@ -1,5 +1,5 @@
 (define-package
   "elfeed-score"
-  "0.7.6"
+  "0.7.7"
   "Gnus-style scoring for Elfeed"
   '((emacs "26.1") (elfeed "3.3.0")))

elfeed-score-serde.el

@@ -757,7 +757,8 @@ into a property list with the following properties:
     - :adjust-tags
     - :title-or-content
     - :tags
-    - :links"
+    - :links
+    - :version"
 
   (let* ((sexp
           (car
@@ -769,15 +770,15 @@ into a property list with the following properties:
     (unless (eq version elfeed-score-serde-current-format)
       (let ((backup-name (format "%s.~%d~" score-file version)))
         (message "elfeed-score will upgrade your score file to version %d; \
-a backup file will be in %s."
+a backup file will be left in %s."
                  elfeed-score-serde-current-format backup-name)
         (condition-case
          data
          (copy-file score-file backup-name)
          (error
-          (message "Tried to backup your score file to %s: %s."
+          (message "Tried to backup your score file to %s but failed: %s."
                    backup-name (cadr data))))))
-    (elfeed-score-serde--parse-scoring-sexp sexp)))
+    (plist-put (elfeed-score-serde--parse-scoring-sexp sexp) :version version)))
 
 (define-obsolete-function-alias 'elfeed-score/write-score-file
   #'elfeed-score-serde-write-score-file "0.2.0" "Move to standard-compliant naming.")
@@ -859,7 +860,11 @@ Read SCORE-FILE, store scoring rules into
           elfeed-score-serde-tag-rules               (plist-get score-entries :tag)
           elfeed-score-serde-authors-rules           (plist-get score-entries :authors)
           elfeed-score-serde-score-mark              (plist-get score-entries :mark)
-          elfeed-score-serde-adjust-tags-rules       (plist-get score-entries :adjust-tags))))
+          elfeed-score-serde-adjust-tags-rules       (plist-get score-entries :adjust-tags))
+    ;; If this is an upgrade in file format; re-write the score file in the new
+    ;; format right away (https://github.com/sp1ff/elfeed-score/issues/12)
+    (unless (eq elfeed-score-serde-current-format (plist-get score-entries :version))
+      (elfeed-score-serde-write-score-file score-file))))
 
 (provide 'elfeed-score-serde)
 ;;; elfeed-score-serde.el ends here

elfeed-score.el

@@ -3,7 +3,7 @@
 ;; Copyright (C) 2019-2021 Michael Herstine <[email protected]>
 
 ;; Author: Michael Herstine <[email protected]>
-;; Version: 0.7.6
+;; Version: 0.7.7
 ;; Package-Requires: ((emacs "26.1") (elfeed "3.3.0"))
 ;; Keywords: news
 ;; URL: https://github.com/sp1ff/elfeed-score
@@ -43,7 +43,7 @@
 (require 'elfeed-score-scoring)
 (require 'elfeed-score-maint)
 
-(defconst elfeed-score-version "0.7.6")
+(defconst elfeed-score-version "0.7.7")
 
 (defgroup elfeed-score nil
   "Gnus-style scoring for Elfeed entries."

test/test-serde.el

@@ -58,7 +58,7 @@ Test reading a trival score file (format version 1)."
                                        (elfeed-score-title-rule--create
                                         :text "long way( home)?" :value 100
                                         :type 'r))
-                         :content nil)))))
+                         :content nil :version 1)))))
 
 (ert-deftest test-score-files-1 ()
   "Smoke test reading/writing score files.
@@ -91,7 +91,7 @@ Test reading a trival score file (format version 2)."
                                         :text "long way( home)?" :value 100
                                         :type 'r))
                          :content nil
-                         :title-or-content nil)))))
+                         :title-or-content nil :version 2)))))
 
 (ert-deftest test-score-files-2 ()
   "Smoke test reading/writing score files.
@@ -135,7 +135,8 @@ tag-scoping rules)."
                             :title-or-content
                             (list (elfeed-score-title-or-content-rule--create
                                    :text "now is the time..." :title-value 150
-                                   :content-value 100 :type 's :tags '(t . (foo bar)))))))))
+                                   :content-value 100 :type 's :tags '(t . (foo bar))))
+                            :version 2)))))
 
 (ert-deftest test-score-files-3 ()
   "Smoke test reading/writing score files.
@@ -171,7 +172,8 @@ Format version defaulted; tag-scoping rules."
                             :title-or-content nil
                             :authors nil
                             :tag nil
-                            :link nil)))))
+                            :link nil
+                            :version elfeed-score-serde-current-format)))))
 
 (ert-deftest test-score-files-4 ()
   "Smoke test reading/writing score files.
@@ -225,7 +227,8 @@ Format version defaulted, includes adjust-tags rules."
                                     (elfeed-score-tag-rule--create
                                      :tags '(nil . z)
                                      :value -1))
-                         :link nil)))))
+                         :link nil
+                         :version elfeed-score-serde-current-format)))))
 
 (ert-deftest test-score-files-5 ()
   "Smoke test reading/writing score files.
@@ -282,7 +285,8 @@ Format version 4."
                                      :value 10)
                                     (elfeed-score-tag-rule--create
                                      :tags '(nil . z)
-                                     :value -1)))))))
+                                     :value -1))
+                          :version 4)))))
 
 (ert-deftest test-score-files-6 ()
   "Smoke test reading/writing score files.
@@ -344,7 +348,8 @@ Format version 6; tag- and feed-scorping rules; authors rule."
                                 :value 10)
                                (elfeed-score-tag-rule--create
                                 :tags '(nil . z)
-                                :value -1)))))))
+                                :value -1))
+                    :version 5)))))
 
 (ert-deftest test-issue-7 ()
   "Check that the error in issue #7 is caught."
@@ -372,7 +377,7 @@ Format version 6; tag- and feed-scorping rules; authors rule."
                           (elfeed-score-title-rule--create
                            :text "hoping" :value -1000 :type 's))
                          :content nil :title-or-content nil
-                         :authors nil :tag nil)))))
+                         :authors nil :tag nil :version 6)))))
 
 (ert-deftest test-format-version-7 ()
   "Smoke tests for format version 7."
@@ -396,7 +401,8 @@ Format version 6; tag- and feed-scorping rules; authors rule."
                          :link
                          (list
                           (elfeed-score-link-rule--create
-                           :text "foo" :value 100 :type 'r)))))))
+                           :text "foo" :value 100 :type 'r))
+                         :version 7)))))
 
 (ert-deftest test-writes-latest-version ()
   "Be sure that the score file is written in the lastest format version."
@@ -434,14 +440,51 @@ Format version 6; tag- and feed-scorping rules; authors rule."
             (mark -2500)))
          (score-text (pp-to-string score-entries))
          (score-file (make-temp-file "elfeed-score-test-" nil nil score-text))
-         ;; Pre-create the backup-file
          (backup-name (format "%s.~5~" score-file)))
+    ;; Pre-create the backup-file
     (with-temp-buffer
       (insert score-text)
       (write-file backup-name nil))
     ;; This will attempt to make a backup, but stumble across the one
     ;; we just made; should *not* error out
     (elfeed-score-serde--parse-score-file score-file)))
 
+(ert-deftest test-issue-12-a ()
+  "Test a secondary aspect to my fix to issue #12.
+
+When elfeed-score reads a score file in an archaic format, it
+should immediately re-write the file in the new format (as well
+as make a backup copy of the file in the old format--
+cf. `test-issue-12'."
+  (let* ((score-entries
+          '((version 5)
+            ("title"
+             ("hoping" -1000 s nil (t . (foo bar)) 0 (t . ((t . "foo"))))
+             ("long way( home)?" +100 r))
+            ("feed"
+             ("foo.com" +100 s u nil nil 0)
+             ("title" -100 s t))
+            ("authors"
+             ("esr" +100 s nil nil 100 (t . ((t . "foo")
+                                             (u . "http://bar.com/feed")))))
+            ("tag"
+             ((t . (a b c)) +10)
+             ((nil . z) -1))
+            ("adjust-tags"
+             ((t . 100) (t . important))
+             ((nil . -100) (nil . important)))
+            (mark -2500)))
+         (score-text (pp-to-string score-entries))
+         (score-file (make-temp-file "elfeed-score-test-" nil nil score-text))
+         (backup-name (format "%s.~5~" score-file)))
+    (elfeed-score-serde-load-score-file score-file)
+    ;; This should leave us with:
+    ;; 1. a copy of the score file in `backup-name'
+    (should (file-exists-p backup-name))
+    ;; 2. `score-file' updated to `elfeed-score-serde-current-format'
+    (should
+     (eq elfeed-score-serde-current-format
+         (plist-get (elfeed-score-serde--parse-score-file score-file) :version)))))
+
 (provide 'test-serde)
 ;;; test-serde.el ends here