Add oauth2 customize group (resolve FIXME)

Add oauth2 customize group (resolve FIXME)

[Naoya Yamashita]

[-- Attachment #1: Type: Text/Plain, Size: 214 bytes --]


Hi, thanks for maintaining such a great project!

I find oauth2 ELPA package and also find a easy FIXME comment.
This patch add a new group and changed all customization
variables to belong to it.

Regards,
Naoya

[-- Attachment #2: 0001-packages-oauth2-oauth2.el-Add-oauth2-group-and-use-i.patch --]
[-- Type: Text/X-Patch, Size: 1469 bytes --]

From b6619724abc1f268eb3b68bc9077f899f9d70bea Mon Sep 17 00:00:00 2001
From: Naoya Yamashita <conao3@gmail.com>
Date: Fri, 19 Feb 2021 09:56:48 +0900
Subject: [PATCH] * packages/oauth2/oauth2.el: Add oauth2 group and use it

(oauth2): New group.
(oauth2-token-file): Belongs to it.
---
 oauth2.el | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/oauth2.el b/oauth2.el
index 43c4e9e4d4..43e48c1dbe 100644
--- a/oauth2.el
+++ b/oauth2.el
@@ -47,6 +47,12 @@
 (defvar url-callback-arguments)
 (defvar url-callback-function)
 
+(defgroup oauth2 nil
+  "OAuth 2.0 Authorization Protocol."
+  :group 'comm
+  :link '(url-link :tag "Savannah" "http://git.savannah.gnu.org/cgit/emacs/elpa.git/tree/?h=externals/oauth2")
+  :link '(url-link :tag "ELPA" "https://elpa.gnu.org/packages/oauth2.html"))
+
 (defun oauth2-request-authorization (auth-url client-id &optional scope state redirect-uri)
   "Request OAuth authorization at AUTH-URL by launching `browse-url'.
 CLIENT-ID is the client id provided by the provider.
@@ -149,8 +155,7 @@ TOKEN should be obtained with `oauth2-request-access'."
 
 (defcustom oauth2-token-file (concat user-emacs-directory "oauth2.plstore")
   "File path where store OAuth tokens."
-  ;; FIXME: This var doesn't belong to any group.  Either add it to some
-  ;; pre-existing group or create an `oauth2' group for it.
+  :group 'oauth2
   :type 'file)
 
 (defun oauth2-compute-id (auth-url token-url scope)
-- 
2.30.0

Re: Add oauth2 customize group (resolve FIXME)

[Julien Danjou]

On Fri, Feb 19 2021, Naoya Yamashita wrote:

Thanks Naoya.

I pushed your change.

> Hi, thanks for maintaining such a great project!
>
> I find oauth2 ELPA package and also find a easy FIXME comment.
> This patch add a new group and changed all customization
> variables to belong to it.
>
> Regards,
> Naoya
>
> From b6619724abc1f268eb3b68bc9077f899f9d70bea Mon Sep 17 00:00:00 2001
> From: Naoya Yamashita <conao3@gmail.com>
> Date: Fri, 19 Feb 2021 09:56:48 +0900
> Subject: [PATCH] * packages/oauth2/oauth2.el: Add oauth2 group and use it
>
> (oauth2): New group.
> (oauth2-token-file): Belongs to it.
> ---
>  oauth2.el | 9 +++++++--
>  1 file changed, 7 insertions(+), 2 deletions(-)
>
> diff --git a/oauth2.el b/oauth2.el
> index 43c4e9e4d4..43e48c1dbe 100644
> --- a/oauth2.el
> +++ b/oauth2.el
> @@ -47,6 +47,12 @@
>  (defvar url-callback-arguments)
>  (defvar url-callback-function)
>  
> +(defgroup oauth2 nil
> +  "OAuth 2.0 Authorization Protocol."
> +  :group 'comm
> +  :link '(url-link :tag "Savannah" "http://git.savannah.gnu.org/cgit/emacs/elpa.git/tree/?h=externals/oauth2")
> +  :link '(url-link :tag "ELPA" "https://elpa.gnu.org/packages/oauth2.html"))
> +
>  (defun oauth2-request-authorization (auth-url client-id &optional scope state redirect-uri)
>    "Request OAuth authorization at AUTH-URL by launching `browse-url'.
>  CLIENT-ID is the client id provided by the provider.
> @@ -149,8 +155,7 @@ TOKEN should be obtained with `oauth2-request-access'."
>  
>  (defcustom oauth2-token-file (concat user-emacs-directory "oauth2.plstore")
>    "File path where store OAuth tokens."
> -  ;; FIXME: This var doesn't belong to any group.  Either add it to some
> -  ;; pre-existing group or create an `oauth2' group for it.
> +  :group 'oauth2
>    :type 'file)
>  
>  (defun oauth2-compute-id (auth-url token-url scope)

-- 
Julien Danjou
/* Free Software hacker
   https://julien.danjou.info */

Re: Add oauth2 customize group (resolve FIXME)

[Naoya Yamashita]

> Thanks Naoya.
> 
> I pushed your change.
> 

Thanks, but I'm bit sad when see the commit.
http://git.savannah.gnu.org/cgit/emacs/elpa.git/commit/?h=externals/oauth2&id=dc069550616fb0a72507489ea796d0e1bd8b48c9

The commit `author` should be `Naoya Yamashita <conao3@gmail.com>`.

You may think it's a small thing, but OSS contributors are
motivated by commits being properly marked as my contribution, so
pushing inappropriate commits may demotivate them.

This time is okay, but please pay attention to the Author field next time!

Re: Add oauth2 customize group (resolve FIXME)

[Stefan Monnier]

Hi,

> The commit `author` should be `Naoya Yamashita <conao3@gmail.com>`.
>
> You may think it's a small thing, but OSS contributors are
> motivated by commits being properly marked as my contribution, so
> pushing inappropriate commits may demotivate them.
>
> This time is okay, but please pay attention to the Author field next time!

Very well said, thank you for reminding us (copyright attribution is
also another reason why we want to be careful with it).


        Stefan

Re: Add oauth2 customize group (resolve FIXME)

[Naoya Yamashita]

> Very well said, thank you for reminding us (copyright attribution is
> also another reason why we want to be careful with it).

Thanks for your comment, Stefan!

Again, thanks to all of you maintainers and committers, I can
continue to use Emacs. Thank you!