ChangeLog

2023-07-28  Michael Herstine  <sp1ff@pobox.com>

	Fix issue #32 Parent dirs in elfeed-score-rule-stats-file are not
	Setting `elfeed-score-rule-stats-file` to a path with intermediate
	directories that don't exist will error-out. This fix will at
	least attempt to create them.

	Also, update the CI workflow & generally prep for the merge
	(new versions in docs &c)

	As an aside, the regression test was originally written using
	`file-name-concat' which was only introduced in Emacs 28.1
	(we support 26.1). It now uses a purpose-build Emacs Lisp
	replacement.

2023-07-27  Michael Herstine  <sp1ff@pobox.com>

	Fix the Continuous Integration job.
	I neglected to do `sudo apt-get update` before doing an `apt-get
	install`. This commit remedies that.

2023-07-12  Michael Herstine  <sp1ff@pobox.com>

	Fix the Continuous Integration job.
	I neglected to do `sudo apt-get update` before doing an `apt-get
	install`. This commit remedies that.

2023-06-17  Michael Herstine  <sp1ff@pobox.com>

	Allow the melpazoid check to run on-demand as well as nightly

2023-06-14  Michael Herstine  <sp1ff@pobox.com>

	Fix make distcheck

2023-06-13  Michael Herstine  <sp1ff@pobox.com>

	Fix CI

2023-05-06  Michael Herstine  <sp1ff@pobox.com>

	Updating project workflows.

	Make release 1.2.6.

	Merge branch 'elfeed-enable-configurably'

	    - Updated the elfeed-score manual to reflect this     - Fixed a unit test that was broken by the previous merge     - Added swflint to AUTHORS

2023-05-02  Samuel W. Flint  <swflint@flintfam.org>

	Add configurability to elfeed-score-scoring-score-entry depth

2023-04-19  Michael  <sp1ff@pobox.com>

	Merge pull request #29 from sp1ff/pr-process
	Maintenance commit. This commit:

2023-04-19  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

2023-04-18  Michael Herstine  <sp1ff@pobox.com>

	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

2022-07-02  Michael  <sp1ff@pobox.com>

	Merge pull request #26 from danielfleischer/patch-1
	Update README

2022-07-02  Daniel Fleischer  <danflscr@gmail.com>

	Update README
	Having a working example with property lists, similar to #24.
	I missed the README, sorry.

2022-07-02  Michael Herstine  <sp1ff@pobox.com>

	Housekeeping commit.
	This commit does a few things:

	    1. addresses issue #25 ("Typo(?) in the readme")
	    2. commits a unit test for issue #22 that was carelessly left
	       laying around after fixing it
	    3. bumps the version after merging pr #24

2022-07-02  Michael  <sp1ff@pobox.com>

	Merge pull request #24 from danielf-amobee/patch-1
	Update elfeed-score.texi

2022-06-15  Daniel Fleischer  <93716777+danielf-amobee@users.noreply.github.com>

	Update elfeed-score.texi
	Having a working example with property lists.

2022-05-28  Michael  <sp1ff@pobox.com>

	Merge pull request #23 from PaulPorfiroff/patch-1
	Fix misleading `elfeed-score-serde-score-mark` docstring

2022-05-12  Paul Porfiroff  <PaulPorfiroff@gmail.com>

	Fix misleading `elfeed-score-serde-score-mark` docstring
	`<=` -> `<`
	
	https://github.com/sp1ff/elfeed-score/blob/419de17d681d75789271b8457509fa3f942eab54/elfeed-score-scoring.el#L659-L661
	
	https://github.com/sp1ff/elfeed-score/blob/419de17d681d75789271b8457509fa3f942eab54/doc/elfeed-score.texi#L991-L994

2022-04-27  Michael Herstine  <michael@lithic>

	Resolve issue #22.

2022-02-01  Michael Herstine  <sp1ff@pobox.com>

	Merge branch 'master' of github.com:sp1ff/elfeed-score

2022-02-01  Michael Herstine  <sp1ff@pobox.com>

	Fix issue #21.
	Qingshui Zheng <https://github.com/qingshuizheng> both noted a
	duplicate keybinding ("aa" :=> 'elfeed-score-maint-add-authors-rule
	and 'elfeed-score-maint-add-tag-rule) *and* suggested a better
	scheme (via private e-mail). This commits incorporates both.

	Since I'm changing an old keybinding, this is a breaking change.
	That said, I can't justify a major version bump (or even a patch
	number bump) for this-- just a new build number.

	This commit *also* fixes a few lints and updates the copyright
	years throughout.

2021-12-30  Michael  <sp1ff@pobox.com>

	Merge pull request #20 from fclaude/patch-1
	Fix example for setting debug mode

2021-12-29  Francisco Claude  <fclaude@recoded.cl>

	Fix example for setting debug mode
	The example in the documentation contains a duplicated `-log` in the variable name.

2021-11-23  Michael Herstine  <sp1ff@pobox.com>

	Updating the version post-merge because I accidentally tagged the alpha release.

2021-11-22  Michael Herstine  <sp1ff@pobox.com>

	Fix doc typo

	Trying to get release GHA to work

	Trying to get release GHA to work

	Address issue #19.
	This commit adds a new rule type `elfeed-score-udf-rule`. `udf'
	for User-Defined function.

2021-11-17  Michael Herstine  <sp1ff@pobox.com>

	adding workflow for creating alphas on the issue-19 branch

2021-10-14  Michael Herstine  <sp1ff@pobox.com>

	Added a reference to John Kitchin's video to the README

2021-10-08  Michael Herstine  <sp1ff@pobox.com>

	Address Issue-18.
	This commit adds a new field to each rule type: :comment. Since
	Lisp source comments are discarded on read, this provides a way
	for rule authors to attach a note, or docstring, to each rule.

2021-09-24  Michael Herstine  <sp1ff@pobox.com>

	elfeed-score 1.0.
	The last obsolete symbols have been removed, with the exception of
	`elfeed-score-score-file`, which I suspect would break a lot of
	configurations.

2021-09-15  Michael Herstine  <sp1ff@pobox.com>

	Fixing release workflow

	Remove all symbols made obsolete as of release 0.2.0.

	Revising test suite.
	    1. Added a few tests to the test suite
	    2. Added a set of tests I had been running manually to the
	       distcheck-hook, since they depend on the elfeed-score
	       Emacs package being present, which only happens during
	       `make dist`

2021-09-09  Michael Herstine  <sp1ff@pobox.com>

	First steps towards a 1.0 release.
	    1. first 0.9 release
	    2. produce an error message when attempting to deserialize
	       rules form a property list missing mandatory fields.

2021-08-31  Michael Herstine  <sp1ff@pobox.com>

	Post-merge commit; bumping to 0.8.6 for release purposes

2021-08-30  Michael Herstine  <sp1ff@pobox.com>

	Repairing the release workflow

	Add full suite of interactive scoring rules.
	This commit adds commands for adding all scoring rule types based
	on the current Elfeed entry.

2021-08-30  Michael Herstine  <sp1ff@pobox.com>

	Add interactive scoring.
	This commit adds a new command `elfeed-score-serde-add-title-rule`
	which will add a new "title" scoring rule based on the current
	Elfeed entry.

	This is the first commit in support of this feature; later commits
	will add additional commands as well as docs.

2021-08-30  Michael Herstine  <sp1ff@pobox.com>

	adding a workflow for making alpha releases on the 0.8 branch

	Spiff-up the explanations buffer.
	    1. introduce elfeed-score-scoring-explain-text-face
	    2. make the list of rules clickable; clicking-on or hitting
	       enter when in a rule match will open the score file and
	       move point to that rule

	Added `elfeed-score-serde-add-rule`

	Introduce `elfeed-score-rule-stats--sexp-to-file` for writing LISP S-expressions to file more safely.
	Changed `elfeed-score-rule-stats-write` and
	`elfeed-score-serde-write-score-file` to use it.

	Removed redudant writes of the stats file

2021-08-18  Michael Herstine  <sp1ff@pobox.com>

	adding a workflow for making alpha releases on the 0.8 branch

2021-08-05  Michael Herstine  <sp1ff@pobox.com>

	Fix issue #13-- split stats out into their own structure.
	The scoring & reporting mechanics all use the new structure and new
	unit tests have been written. The `hits` & `date` fields have been
	removed from the rule structs & the score file version has been
	bumped.

	All docs have been updated.

2021-06-05  Michael Herstine  <sp1ff@pobox.com>

	Edits preperatory to the 0.7.9 release

	Touch-up to the new feature:
	    - Corrected a bug in `elfeed-score-set-score` wherein the prefix
	      argument was marked optional instead of mandatory
	    - Score explanations now note sticky scores
	    - The scoring log messages reflect sticky scores

2021-06-05  Michael Herstine  <sp1ff@pobox.com>

	Fix issue #10.
	This commit adds an optional parameter to
	`elfeed-score-scoring-set-score-on-entry`: `sticky`. If the caller
	sets this to true an additional bit of metadata will be set on the
	entry indicating that this score should not be changed by
	subsequent invocations unless the `sticky` parameter is also set.

	`elfeed-score-set-score` is the only function to specify the
	`sticky` flag. In this way, scores that are set manually will
	"stick": while scores set through the new entry hook or as part of
	scoring an entire search will not overwrite them.

	Since this is a new feature, I've put it behind a configuration
	option `elfeed-score-scoring-manual-is-sticky` which defaults
	to true, but if the user dislikes this they can set it to nil to
	disable the feature.

2021-04-29  Michael Herstine  <sp1ff@pobox.com>

	Fix issue #14.
	Embarrasingly, I forgot to update 'elfeed-score-serde-link-rules'
	in 'elfeed-score-serde-load-score-file'-- fixed. Thanks to
	@jpowellrussell for pointing it out.

2021-03-02  Michael Herstine  <sp1ff@pobox.com>

	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  <sp1ff@pobox.com>

	Re-factor 'elfeed-score-scoring.el' to define the logic for title, content, authors & link rules via macro rather than individually.

2021-03-01  Michael Herstine  <sp1ff@pobox.com>

	Address issue #11.
	This commit introduces a new rule type: link. Link scoring rules
	will operate against the entry link (thanks for the suggestion
	TheLugal).

	Additionally, this commit raises the format version to 7.

2021-02-28  Michael Herstine  <sp1ff@pobox.com>

	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  <sp1ff@pobox.com>

	Fixed a few typos in the release workflow.

2021-02-25  Michael Herstine  <sp1ff@pobox.com>

	Initial 0.7 release.
	This commit brings in a few major changes to elfeed-score:

	    1. Re-factors 'elfeed-score.el' into multiple, smaller files
	    2. Updates the score file format to serialize rules as property
	       lists
	    3. When elfeed-score reads a score file in an archaic format,
	       it will write a backup before updating it.

2021-02-25  Michael Herstine  <sp1ff@pobox.com>

	texinfo version updated by sanity check

	Write a backup copy of the score file on version upgrade.
	This commit adds a minor new feature: if elfeed-score detects,
	on loading the score file, that the format version has changed,
	it will write a backup copy of the score file.

2021-02-25  Michael Herstine  <sp1ff@pobox.com>

	Introduce score file format version 6.
	With this commit, elfeed-score will serialize scoring rules as
	property lists, rather than flat lists. It will, of course,
	continue to read all prior versions of the score file format.

	Moving to property lists for the rule format, while more prolix,
	will reduce errors on the part of rule authors & enable better
	validation & error messages on the part of the package.

2021-02-25  Michael Herstine  <sp1ff@pobox.com>

	Stop packages from referring to private symbols in other packages.
	Post-re-factor, there were a few cases of one package referring
	to a prinvate symbol defined in another package. This commit
	eliminates that, albeit by simply renaming the referenced
	private symbosl to be public.

2021-02-25  Michael Herstine  <sp1ff@pobox.com>

	Update my Github workflows.
	This commit:

	  - updates the release workflow to add the stock Emacs package
	    file (elfeed-score-x.y.z.tar) to the release
	  - adds a workflow just for the 0.7 branch that will create
	    alpha releases

2021-02-25  Michael Herstine  <sp1ff@pobox.com>

	Major re-work of the elfeed-score documentation.
	This commit breaks-up the bloated README:

	  - introductory information & installation instructions remain
	    in the README
	  - user documentation has been moved to a Texinfo manual
	  - developer documentation has been moved to the project Wiki

2021-02-25  Michael Herstine  <sp1ff@pobox.com>

	Re-factor 'elfeed-score.el'.
	'elfeed-score.el' has grown to over 2K lines. Consequently, it
	has become difficult to read, maintain & reason about. This commit:

	    - breaks 'elfeed-score.el' up into several smaller files
	    - changes the variable & function names in these new files to
	      begin with their new prefix:
	      - public symbols have aliases defined
	      - private symols were just renamed-- if you were accessing
	        these symbols in your code, it will break(!)

	All lints now pass, as well as all unit tests. Still, this is a
	major, breaking change & is not ready for release, yet.

2021-02-25  Michael Herstine  <sp1ff@pobox.com>

	Updated README.org with latest 0.7 alpha release

2021-02-20  Michael Herstine  <sp1ff@pobox.com>

	Updated the 0.7 pre-releases ann

2021-02-08  Michael Herstine  <sp1ff@pobox.com>

	Added an announcment about 0.7 pre-releases to the README.

2021-01-29  Michael Herstine  <sp1ff@pobox.com>

	Squashing commits fixing assorted issues raised by firmart:
	  - Fix issue #6.

	    Correct the bad "authors" clause in the sample 'elfeed.score' in
	    the README. Thank Firmin for noting this.

	  - Fix issue #9.

	    Correct the 'elfeed-score-explain' docstring.

	  - Address issue #7.

	    This comes down to better validation on loading of score file.
	    I updated the constructor to use (arguably abuse) the '&aux'
	    CL keyword to validate the parmeters.

2020-12-19  Michael Herstine  <sp1ff@pobox.com>

	Address a final nit in issue #2: make 'elfeed-score-explain-entry' non-interactive.

	Getting the release workflow working.

	Docs-only commit: updated the README with new installation instructions & a mention of 'elfeed-score-explain-entry'.

2020-12-13  Michael Herstine  <sp1ff@pobox.com>

	Re-implemented the "explain" feature & added unit tests.

2020-12-05  Michael Herstine  <sp1ff@pobox.com>

	BUGFIX: 'elfeed-score--pp-rule-match-to-string' wasn't handling tag rules correctly.
	Also took the opportunity to fix typos in both my GitHub Actions
	workflows.

2020-12-04  Michael Herstine  <sp1ff@pobox.com>

	'elfeed-score-explain'
	This commit addresses #5 -- "Feature Request: `elfeed-score-explain`
	function" by re-factoring the scoring routines to apply an arbitrary
	lambda on all matches. The scoring functions have been re-worked to
	use this framework: on match, they just add the relevant value to
	the entry score. I then introduced a new function corresponding
	to each scoring function-- an "explain" variant. It walks the relevant
	scoring rules, but records matches instead of totalling up a score.

	Finally, I implemented 'elfeed-score-explain'-- an interactive function
	that will print out the matches in a dedicated buffer.

	Finally, I added two GitHub actions:

	    1. one that runs Chris Raynor's (@riscy) "melpazoid" linter against
	       all commits & PRs

	     2. a release workflow that will create a GitHub release whenever
	        a release is tagged (copied shamlessly from Burnt Sushi)

2020-11-01  Michael Herstine  <sp1ff@pobox.com>

	Documentation updates prior to releasing 0.5.5.

2020-10-31  Michael Herstine  <sp1ff@pobox.com>

	Add reporting on rules by number of match hits.

	Add the ability to report rules by last match date.

2020-10-30  Michael Herstine  <sp1ff@pobox.com>

	Scoping rules by feed.
	This commit implements a new feature: scoping rules by feed.

	It also adds a "hit count" to all rules.

2020-10-25  Michael Herstine  <sp1ff@pobox.com>

	BUGFIX: issue #4
	let-bind 'print-le{vel,ngth}' to nil before calling 'pp-to-string'.

2020-08-10  Michael Herstine  <sp1ff@pobox.com>

	Merge branch 'C-J-Cundy-master'

	Preparing to merge C-J-Cundy's PR https://github.com/sp1ff/elfeed-score/pull/3:
	  - Minor touch-ups to the PR
	  - Added unit tests; updated maintainer's files

2020-08-04  Chris Cundy  <chris.j.cundy@gmail.com>

	Added description of `authors` matching to README

2020-07-30  Chris Cundy  <chris.j.cundy@gmail.com>

	Adds in scoring by author
	This adds in a new field to score entries against: author.
	Uses the entry :author metadata to concatenate all the authors'
	names together. This string is then matched on in the same way as
	e.g. the contents string is matched on.

2020-03-28  Michael Herstine  <sp1ff@pobox.com>

	Fix Issue #2: "(elfeed-score-enable) must have an argument now, unlike README suggests"
	I foolishly forgot the `&optional' keyword; fixed & I'm working on
	some non-ERT tests to catch this going forward (those tests aren't
	committed yet).

2020-03-22  Michael Herstine  <sp1ff@pobox.com>

	Final pre-release fixes.
	    1. format scores properly before displaying

	    2. give `elfeed-score-enable' a prefix arg; if present, do
	       *not* install the sort function. This is to accomodate
	       people who have already customized the sort function.

	    3. BUGFIX: `elfeed-score-unload' had been pulled into the
	       definition of `elfeed-score-enable' (?)

	    4. update README.org

2020-03-21  Michael Herstine  <sp1ff@pobox.com>

	Added a maximum size to the log buffer, along with `elfeed-score--{set-score-on,get-score-from}-entry.
	This commit:

	    1. adds variable `elfeed-score-max-log-buffer-size', an upper
	       bound on the number of lines in the elfeed log buffer

	    2. adds two internal convenience functions for setting &
	       getting the score of an entry, resp.

	       - elfeed-score--set-score-on-entry
	       - elfeed-score--get-score-from-entry

2020-03-15  Michael Herstine  <sp1ff@pobox.com>

	Two new scoring rules: tag, and adjust-tags.
	This commit adds two new scoring rules (and bumps the score file
	version to 3):

	    1. tag: adjust an entry's score up or down based on the presence
	       or absence of one or more tags
	    2. adjust-tags: after the scoring process is complete, add
	       or remove tags based on the score being above or below
	       given thresholds.

2020-03-14  Michael Herstine  <sp1ff@pobox.com>

	Much-improved logging.
	This commit introduces the *elfeed-score* log buffer, modeled on
	`elfeed-log', to which much more detailed messages are sent. The
	verbosity can be controlled by `elfeed-score-log-level'.

2020-02-21  Michael Herstine  <sp1ff@pobox.com>

	Change `assoc-delete-all' to `cl-delete' to avoid having to depend on a later version of Emacs.
	Move the struct definitions ahead of their use, to ease re-loading.

2020-02-21  Michael Herstine  <sp1ff@pobox.com>

	This commit squashes a few bugs:
	    1. if `version' isn't mentioned in a score file, just assume it's
	       in the latest format

	    2. feed rules without tag scoping were being serializsed with a
	       needless trailing `nil'

	    3. all rules other than titles were failing to read tag-scoping
	       rules on creation

	    4. fixed a typo in the unit test names

	    5. log more detailed information when `elfeed-score-debug' is t
	       and a rule matches

2020-02-15  Michael Herstine  <sp1ff@pobox.com>

	This commit some additional, new scoring features for score file version 2:
	    1. tag-specific rules: any rule can now be made to apply only when

	       - any of one or more tags are present in the entry being scored

	       - none of one or more tags are present in the entry being scored

	    2. whole-word matching: in addition to string & regex matching, rules
	       can be matched using whole-word regex matching

2020-02-12  Michael Herstine  <sp1ff@pobox.com>

	Score file version 2.
	This commit does the following:

	    1. re-implements the scoring rules in terms of structs (instead)
	       of property lists

	    2. re-wrote the score file parsing logic to separate the file
	       I/O from the parsing of the score sexp.

	    3. bumps the score file format version to 2

	       - adds a new rule type "title-or-content"

	       - permits the version element of the sexp to be keyed either
	         string or symbol

	NB. Whenever the score file is written out, it will be in version
	2 format.

2020-01-19  Michael Herstine  <mherstin@linkedin.com>

	Add the option to display entry scores in *elfeed-search*.
	This commit:

	    1. provides a new function, `elfeed-score-print-entry', which
	       can be used as the value of `elfeed-search-print-entry-function`;
	       when this is done, the entry score will be printed in the
	       first column of the search buffer

	    2. the format of the score is determined by a new customization
	       variable `elfeed-score-score-format'

	Note that the print function will not be substituted when
	`elfeed-score-enable` is invoked; you must do this explicitly in
	your configuration if you want this feature. However,
	`elfeed-score-unload` will remove it, if found.

2020-01-15  Michael  <sp1ff@pobox.com>

	Merge pull request #1 from Miciah/fix-package-URL-in-commentary
	Fix package URL in commentary

2020-01-14  Miciah Masters  <miciah.masters@gmail.com>

	Fix package URL in commentary
	Replace "emacs-score" with "elfeed-score" in the package URL.

	* elfeed-score.el: Fix package URL in commentary.

2020-01-04  Michael Herstine  <sp1ff@pobox.com>

	Minor textual changes:
	    1. Updated README to reflect the fact that this package has been accepted into MELPA

	    2. Updated copyright statements in source

2019-12-23  Michael Herstine  <sp1ff@pobox.com>

	Preparation for submission to MELPA.
	This commit prepares `elfeed-score' for submission to MELPA:

	    1. The naming scheme for public symbols changed from "elfeed-score/"
	       to "elfeed-score-" (in accordance with the Emacs Lisp Coding
	       Conventions. Aliases are defined for all 0.1 symbols.

	    2. Docstrings are now `checkdoc'-compliant.

	    3. Loading the package no longer affects Elfeed; the package
	       must be enabled via a call to `elfeed-score-enable', and may
	       be unloaded via `elfeed-score-unload' (again in accordance
	       with the Emacs Lisp Coding Conventions).

	    4. Miscellaneous other udpates (addition of a Package-Requires
	       header & and autoload, e.g.)

2019-12-20  Michael Herstine  <sp1ff@pobox.com>

	Initial commit of elfeed-score