Re: [PATCH] emacs: add missing paren to fix defun in notmuch-address.el.

[Tomi Ollila <tomi.ollila@iki.fi>]

On Fri, Jul 04 2014, Sebastian Lipp <bacuh@riseup.net> wrote:

> Tomi Ollila <tomi.ollila@iki.fi> writes:
>> On Tue, Apr 09 2013, David Bremner wrote:
>>> There seems to be a few warnings:
>>>
>>> In notmuch-bbdb/snarf-from:
>>> notmuch-address.el:116:26:Warning: reference to free variable
>>>     `bbdb-get-addresses-headers'
>>>
>>> In notmuch-bbdb/snarf-to:
>>> notmuch-address.el:122:29:Warning: reference to free variable
>>>     `bbdb-get-addresses-headers'
>>>
>>> In end of data:
>>> notmuch-address.el:143:1:Warning: the following functions are not known to be
>>>     defined: bbdb-get-addresses, bbdb-update-records, notmuch-show-get-header
>>>
>>> Do we need a few defvars?
>>
>> For the above set, something like:
>>
>> (defvar bbdb-get-addresses-headers)
>>
>> (declare-function notmuch-show-get-header "notmuch-show" (header &optional props))
>>
>> (declare-function bbdb-get-addresses "bbdb-com" 
>>   (only-first-address
>>    uninteresting-senders
>>    get-header-content-function
>>    &rest get-header-content-function-args))
>>
>> (declare-function bbdb-update-records "bbdb-com" (addrs auto-create-p offer-to-create))
>
> As I'd like to see this in notmuch I made the change. The patch is
> attached. As it is my first contribution to notmuch at all: Just tell me
> if I'm supposed to do it in any other way.
>
> LG
> basti

I saved this patch with 'w' in emacs mua -- and have to remove '>' From the
first line so that 'git am' could recognize it. 

There was one whitespace error -- I reapplied with

git am --whitespace=fix ~/0001-emacs-functions-to-import-sender-or-recipient-into-B.patch

more inline (in addition to Karl's good comments)

IMO all of that can be in one patch...

>From 522e4294258e6392a02c923b4b7e78a898986fca Mon Sep 17 00:00:00 2001
> From: Daniel Bergey <bergey@alum.mit.edu>
> Date: Mon, 8 Apr 2013 19:55:04 -0500
> Subject: [PATCH] emacs: functions to import sender or recipient into BBDB [v3]
>
>From a show buffer, notmuch-bbdb/snarf-from imports the sender into

Interestingly the line above was lost when I applied the patch -- 
probably '>From' somehow borke git am... -- should git am be more capable
there (or would the required heuristics pass the tolerance threshold) ?

> bbdb.  notmuch-bbdb/snarf-to imports all recipients.  Newly imported
> contacts are reported in the minibuffer / Messages buffer.
>
> Both functions use the BBDB parser to recognize email address formats.
>
> [v3] Fixes a few warnings as suggested by Tomi Ollila in
>      id:87vc7vgbym.fsf@zancas.localnet
> [v2] Fixes missing close parenthesis in original.
>      Spotted by Karl Fogel <kfogel@red-bean.com>.
> ---
>  emacs/notmuch-address.el | 53 ++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 53 insertions(+)
>
> diff --git a/emacs/notmuch-address.el b/emacs/notmuch-address.el
> index fa65cd5..ee7b169 100644
> --- a/emacs/notmuch-address.el
> +++ b/emacs/notmuch-address.el
> @@ -113,6 +113,59 @@ to know how address selection is made by default."
>  (when (notmuch-address-locate-command notmuch-address-command)
>    (notmuch-address-message-insinuate))
>  
> +;; functions to add sender / recipients to BBDB
> +
> +(defvar bbdb-get-addresses-headers)

It would be nice to have comment where bbdb-get-addresses-headers is defined.

> +
> +(declare-function notmuch-show-get-header "notmuch-show" (header &optional props))
> +
> +(declare-function bbdb-get-addresses "bbdb-com" 
> +  (only-first-address
> +   uninteresting-senders
> +   get-header-content-function
> +   &rest get-header-content-function-args))
> +
> +(declare-function bbdb-update-records "bbdb-com" (addrs auto-create-p offer-to-create))
> +
> +(defun notmuch-bbdb/snarf-headers (headers)
> +  ;; Helper function to avoid code duplication in the two below
> +  ;; headers should have the same format as bbdb-get-addresses-headers
> +
> +  ;; bbdb-get-addresses reads these
> +  ;; Ugh, pass-by-global

Somehow this comment section looks a bit odd -- is it the empty line there,
or just that (at least part of) it is not docstring.

> +  (let ((addrs (bbdb-get-addresses nil nil 'notmuch-bbdb/get-header-content))
> +	(bbdb-get-addresses-headers headers) ; headers to read
> +	(bbdb-gag-messages t)) ; suppress m/n processed message)
> +    (bbdb-update-records addrs t t)))
> +
> +(defun notmuch-bbdb/snarf-from ()
> +  "Import the sender of the current message into BBDB"
> +  (interactive)
> +  (notmuch-bbdb/snarf-headers
> +   (list (assoc 'authors bbdb-get-addresses-headers))))
> +
> +(defun notmuch-bbdb/snarf-to ()
> +  "Import all recipients of the current message into BBDB"
> +  (interactive)
> +  (notmuch-bbdb/snarf-headers
> +   (list (assoc 'recipients bbdb-get-addresses-headers))))
> +
> +(defvar notmuch-bbdb/header-by-name
> +  ;; both are case sensitive
> +  '( ("From" . :From)
> +     ("To" . :To)
> +     ("CC" . :Cc)
> +     ("BCC" . :Bcc)
> +     ("Resent-From" . nil)
> +     ("Reply-To" . nil)
> +     ("Resent-To" . nil)
> +     ("Resent-CC" . nil))
> +  "Alist for dispatching header symbols as used by notmuch-show-get-header
> +from strings as used by bbdb-get-addresses")
> +
> +(defun notmuch-bbdb/get-header-content (name)
> +  (notmuch-show-get-header (cdr (assoc name notmuch-bbdb/header-by-name))))
> +
>  ;;
>  
>  (provide 'notmuch-address)
> -- 
> 2.0.1

Tomi