Subject: [PATCH v3 0/2] [Outreachy] advice: revamp advise API

From: "Heba Waly via GitGitGadget" <[email-masked]>
Date: Wed, 19 Feb 2020 20:33:59 +0000

Changes in V3:

 * Remove the new wrapper advice_push_update_rejected_enabled() (which was
   added in V2 to handle a special case of having a config variable alias),
   and replace it by adding switch cases to advice_enabled() (The reason
   behind this change is that another special case came up while I was
   migrating the rest of the advise calls to the new APIs.)
 * Remove trailing whitespaces.

----------------------------------------------------------------------------

Main changes in V2:

 * Rename advise_ng to advise_if_enabled.
 * Add a new advise_enabled() helper.
 * Add a list of config variables names to replace advice_config[] (used by
   list_config_advices()).
 * Send an enum parameter to the new advise helpers instead of strings.
 * Extract vadvise() from advise() and advise_if enabled().

----------------------------------------------------------------------------

The advice API is currently a little bit confusing to call. quoting from
[1]:

When introducing a new advice message, you would

 * come up with advice.frotz configuration variable

 * define and declare advice_frotz global variable that defaults to
   true

 * sprinkle calls like this:

  if (advice_frotz)
    advise(_("helpful message about frotz"));

A new approach was suggested in [1] which this patch is based upon.

A new advise_if_enabled() is introduced to gradually replace advise()
advice_enabled() helper is also introduced to be used by those callers who:

 * Only need to check the visibility without calling advise() (they call
   die() or error() instead for example)
 * Need to carry out some heavy processing to display an advice, in this
   case they'll do: if(advice_enabled(advice_type))  advise("some advice message");

To introduce a new advice message, the caller needs to:

 * Add a new_advice_type to 'enum advice_type'
 * Come up with a new config variable name and add this name to 
   advice_config_keys[]
 * Call advise_if_enabled(new_advice_type, "advice message to be printed")
 * Or call advice_enabled(new_advice_type) first and then follow is by
   advice("advice message to be printed") as explained earlier.
 * Add the new config variable to Documentation/config/advice.txt

The reason a new list of configuration variables was added to the library is
to be used by the list_config_advices() function instead of advice_config[].
And we should get rid of advice_config[] once we migrate all the callers to
use the new APIs instead of checking the global variables (which we'll get
rid of as well).

In the future, we can investigate generating the documentation from the list
of config variables or vice versa to make introducing a new advice much
easier, but this approach will do it for now.

V2 makes the process of introducing a new advice longer than V1 and almost
as long as the original library, but having the advice library responsible
for checking the message visibility is still an improvement and in my own
opinion the new structure makes better sense and makes the library less
confusing to use.

After this patch the plan is to change the advise() calls to
advise_if_enabled() whenever possible, or at least replace the global
variables checks by advise_enabled() when advise_if_enabled() is not
suitable.

[1] https://public-inbox.org/git/[email-masked]/

Heba Waly (2):
  advice: revamp advise API
  advice: extract vadvise() from advise()

 Makefile               |  1 +
 advice.c               | 93 ++++++++++++++++++++++++++++++++++++++----
 advice.h               | 53 +++++++++++++++++++++++-
 builtin/tag.c          |  4 +-
 t/helper/test-advise.c | 16 ++++++++
 t/helper/test-tool.c   |  1 +
 t/helper/test-tool.h   |  1 +
 t/t0018-advice.sh      | 28 +++++++++++++
 t/t7004-tag.sh         |  1 +
 9 files changed, 187 insertions(+), 11 deletions(-)
 create mode 100644 t/helper/test-advise.c
 create mode 100755 t/t0018-advice.sh

base-commit: c7a62075917b3340f908093f63f1161c44ed1475
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-548%2FHebaWaly%2Fadvice_refactoring-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-548/HebaWaly/advice_refactoring-v3
Pull-Request: https://github.com/gitgitgadget/git/pull/548

Range-diff vs v2:

 1:  080d12b5c69 ! 1:  4ab141426f3 advice: refactor advise API
     @@ -1,6 +1,6 @@
      Author: Heba Waly <[email-masked]>
      
     -    advice: refactor advise API
     +    advice: revamp advise API
      
          Currently it's very easy for the advice library's callers to miss
          checking the visibility step before printing an advice. Also, it makes
     @@ -63,7 +63,7 @@
      +	[PUSH_UPDATE_REJECTED]			 = "pushUpdateRejected",
      +	/* make this an alias for backward compatibility */
      +	[PUSH_UPDATE_REJECTED_ALIAS]		 = "pushNonFastForward",
     -+	
     ++
      +	[PUSH_NON_FF_CURRENT]			 = "pushNonFFCurrent",
      +	[PUSH_NON_FF_MATCHING]			 = "pushNonFFMatching",
      +	[PUSH_ALREADY_EXISTS]			 = "pushAlreadyExists",
     @@ -99,7 +99,7 @@
       	strbuf_release(&buf);
       }
       
     -+int advice_enabled(enum advice_type type)
     ++static int get_config_value(enum advice_type type)
      +{
      +	int value = 1;
      +	char *key = xstrfmt("%s.%s", "advice", advice_config_keys[type]);
     @@ -107,11 +107,15 @@
      +	return value;
      +}
      +
     -+int advice_push_update_rejected_enabled(void)
     ++int advice_enabled(enum advice_type type)
      +{
     -+	return advice_enabled(PUSH_UPDATE_REJECTED) ||
     -+	       advice_enabled(PUSH_UPDATE_REJECTED_ALIAS);
     -+	
     ++	switch(type) {
     ++	case PUSH_UPDATE_REJECTED:
     ++		return get_config_value(PUSH_UPDATE_REJECTED) &&
     ++		       get_config_value(PUSH_UPDATE_REJECTED_ALIAS);
     ++	default:
     ++		return get_config_value(type);
     ++	}
      +}
      +
      +static const char turn_off_instructions[] =
     @@ -223,12 +227,7 @@
      +int advice_enabled(enum advice_type type);
      +
      +/**
     -+ Checks if PUSH_UPDATE_REJECTED advice type is enabled.
     -+ */
     -+int advice_push_update_rejected_enabled(void);
     -+
     -+/**
     -+ Checks the visibility of the advice before priniting.
     ++ Checks the visibility of the advice before printing.
      + */
      +void advise_if_enabled(enum advice_type type, const char *advice, ...);
      +
     @@ -266,7 +265,7 @@
      +	die("usage: %s <advice>", argv[0]);
      +
      +	setup_git_directory();
     -+	
     ++
      +	//use any advice type for testing
      +	advise_if_enabled(NESTED_TAG, argv[1]);
      +
 2:  3e4f52e5526 ! 2:  a2a145c705e advice: extract vadvise() from advise()
     @@ -38,7 +38,7 @@
       	for (cp = buf.buf; *cp; cp = np) {
       		np = strchrnul(cp, '\n');
      @@
     - 	
     + 	}
       }
       
      -static const char turn_off_instructions[] =

-- 
gitgitgadget