unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
* [PATCH v2 0/2] ruby: improve db.query
@ 2021-05-24  2:19 Felipe Contreras
  2021-05-24  2:19 ` [PATCH v2 1/2] ruby: add keyword arguments to db.query Felipe Contreras
                   ` (2 more replies)
  0 siblings, 3 replies; 4+ messages in thread
From: Felipe Contreras @ 2021-05-24  2:19 UTC (permalink / raw)
  To: notmuch; +Cc: Ludovic LANGE, Stefano Zacchiroli

I find it a bit annoying to have to modify the query object to add
options when Notmuch::Database.query() can do that just fine.

This series also adds a mapping to the notmuch_exclude_t enum in order
to be able to specify NOTMUCH_EXCLUDE_ALL and others.

Nothing changed from v1 except rebased on master of May 23.

Felipe Contreras (2):
  ruby: add keyword arguments to db.query
  test: ruby: simplify basic tests

 bindings/ruby/database.c | 47 +++++++++++++++++++++++++++++++++++++---
 bindings/ruby/defs.h     |  2 +-
 bindings/ruby/init.c     |  2 +-
 test/T395-ruby.sh        | 30 ++++++++++++++++++-------
 4 files changed, 68 insertions(+), 13 deletions(-)

Range-diff against v1:
1:  8cc8cedd < -:  -------- ruby: use notmuch_exclude_t enum
2:  70938802 ! 1:  ec8b5d1a ruby: add keyword arguments to db.query
    @@ bindings/ruby/database.c: notmuch_rb_database_query_create (VALUE self, VALUE qs
     +	}
     +    }
     +
    -     return Data_Wrap_Struct (notmuch_rb_cQuery, NULL, NULL, query);
    +     return Data_Wrap_Notmuch_Object (notmuch_rb_cQuery, &notmuch_rb_query_type, query);
      }
     
      ## bindings/ruby/defs.h ##
3:  26519f68 = 2:  29c15ec1 test: ruby: simplify basic tests
-- 
2.32.0.rc0

^ permalink raw reply	[flat|nested] 4+ messages in thread

* [PATCH v2 1/2] ruby: add keyword arguments to db.query
  2021-05-24  2:19 [PATCH v2 0/2] ruby: improve db.query Felipe Contreras
@ 2021-05-24  2:19 ` Felipe Contreras
  2021-05-24  2:19 ` [PATCH v2 2/2] test: ruby: simplify basic tests Felipe Contreras
  2021-06-04  6:08 ` [PATCH v2 0/2] ruby: improve db.query Felipe Contreras
  2 siblings, 0 replies; 4+ messages in thread
From: Felipe Contreras @ 2021-05-24  2:19 UTC (permalink / raw)
  To: notmuch; +Cc: Ludovic LANGE, Stefano Zacchiroli

That way we don't need pass them to the query object ourselves.

Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 bindings/ruby/database.c | 47 +++++++++++++++++++++++++++++++++++++---
 bindings/ruby/defs.h     |  2 +-
 bindings/ruby/init.c     |  2 +-
 test/T395-ruby.sh        | 18 +++++++++++++++
 4 files changed, 64 insertions(+), 5 deletions(-)

diff --git a/bindings/ruby/database.c b/bindings/ruby/database.c
index bb993d86..d6c804ac 100644
--- a/bindings/ruby/database.c
+++ b/bindings/ruby/database.c
@@ -395,17 +395,24 @@ notmuch_rb_database_get_all_tags (VALUE self)
 }
 
 /*
- * call-seq: DB.query(query) => QUERY
+ * call-seq:
+ *   DB.query(query) => QUERY
+ *   DB.query(query, sort:, excluded_tags:, omit_excluded:) => QUERY
  *
- * Retrieve a query object for the query string 'query'
+ * Retrieve a query object for the query string 'query'. When using keyword
+ * arguments they are passwed to the query object.
  */
 VALUE
-notmuch_rb_database_query_create (VALUE self, VALUE qstrv)
+notmuch_rb_database_query_create (int argc, VALUE *argv, VALUE self)
 {
+    VALUE qstrv;
+    VALUE opts;
     const char *qstr;
     notmuch_query_t *query;
     notmuch_database_t *db;
 
+    rb_scan_args (argc, argv, "1:", &qstrv, &opts);
+
     Data_Get_Notmuch_Database (self, db);
 
     SafeStringValue (qstrv);
@@ -415,5 +422,39 @@ notmuch_rb_database_query_create (VALUE self, VALUE qstrv)
     if (!query)
         rb_raise (notmuch_rb_eMemoryError, "Out of memory");
 
+    if (!NIL_P (opts)) {
+	VALUE sort, exclude_tags, omit_excluded;
+	VALUE kwargs[3];
+	static ID keyword_ids[3];
+
+	if (!keyword_ids[0]) {
+	    keyword_ids[0] = rb_intern_const ("sort");
+	    keyword_ids[1] = rb_intern_const ("exclude_tags");
+	    keyword_ids[2] = rb_intern_const ("omit_excluded");
+	}
+
+	rb_get_kwargs (opts, keyword_ids, 0, 3, kwargs);
+
+	sort = kwargs[0];
+	exclude_tags = kwargs[1];
+	omit_excluded = kwargs[2];
+
+	if (sort != Qundef)
+	    notmuch_query_set_sort (query, FIX2UINT (sort));
+
+	if (exclude_tags != Qundef) {
+	    for (int i = 0; i < RARRAY_LEN (exclude_tags); i++) {
+		VALUE e = RARRAY_AREF (exclude_tags, i);
+		notmuch_query_add_tag_exclude (query, RSTRING_PTR (e));
+	    }
+	}
+
+	if (omit_excluded != Qundef) {
+	    notmuch_exclude_t omit;
+	    omit = FIXNUM_P (omit_excluded) ? FIX2UINT (omit_excluded) : RTEST(omit_excluded);
+	    notmuch_query_set_omit_excluded (query, omit);
+	}
+    }
+
     return Data_Wrap_Notmuch_Object (notmuch_rb_cQuery, &notmuch_rb_query_type, query);
 }
diff --git a/bindings/ruby/defs.h b/bindings/ruby/defs.h
index 9860ee17..995bcafd 100644
--- a/bindings/ruby/defs.h
+++ b/bindings/ruby/defs.h
@@ -174,7 +174,7 @@ VALUE
 notmuch_rb_database_get_all_tags (VALUE self);
 
 VALUE
-notmuch_rb_database_query_create (VALUE self, VALUE qstrv);
+notmuch_rb_database_query_create (int argc, VALUE *argv, VALUE self);
 
 /* directory.c */
 VALUE
diff --git a/bindings/ruby/init.c b/bindings/ruby/init.c
index bedfbf60..d421c601 100644
--- a/bindings/ruby/init.c
+++ b/bindings/ruby/init.c
@@ -275,7 +275,7 @@ Init_notmuch (void)
     rb_define_method (notmuch_rb_cDatabase, "find_message_by_filename",
 		      notmuch_rb_database_find_message_by_filename, 1); /* in database.c */
     rb_define_method (notmuch_rb_cDatabase, "all_tags", notmuch_rb_database_get_all_tags, 0); /* in database.c */
-    rb_define_method (notmuch_rb_cDatabase, "query", notmuch_rb_database_query_create, 1); /* in database.c */
+    rb_define_method (notmuch_rb_cDatabase, "query", notmuch_rb_database_query_create, -1); /* in database.c */
 
     /*
      * Document-class: Notmuch::Directory
diff --git a/test/T395-ruby.sh b/test/T395-ruby.sh
index d36d4aff..e828efed 100755
--- a/test/T395-ruby.sh
+++ b/test/T395-ruby.sh
@@ -82,4 +82,22 @@ q.search_threads.each do |t|
 end
 EOF
 
+test_begin_subtest "check sort argument"
+notmuch search --sort=oldest-first --output=threads tag:inbox > EXPECTED
+test_ruby <<"EOF"
+q = db.query('tag:inbox', sort: Notmuch::SORT_OLDEST_FIRST)
+q.search_threads.each do |t|
+  puts 'thread:%s' % t.thread_id
+end
+EOF
+
+test_begin_subtest "check exclude_tags argument"
+notmuch search --output=threads --exclude=all tag:inbox > EXPECTED
+test_ruby <<"EOF"
+q = db.query('tag:inbox', exclude_tags: %w[deleted], omit_excluded: Notmuch::EXCLUDE_ALL)
+q.search_threads.each do |t|
+  puts 'thread:%s' % t.thread_id
+end
+EOF
+
 test_done
-- 
2.32.0.rc0

^ permalink raw reply	[flat|nested] 4+ messages in thread

* [PATCH v2 2/2] test: ruby: simplify basic tests
  2021-05-24  2:19 [PATCH v2 0/2] ruby: improve db.query Felipe Contreras
  2021-05-24  2:19 ` [PATCH v2 1/2] ruby: add keyword arguments to db.query Felipe Contreras
@ 2021-05-24  2:19 ` Felipe Contreras
  2021-06-04  6:08 ` [PATCH v2 0/2] ruby: improve db.query Felipe Contreras
  2 siblings, 0 replies; 4+ messages in thread
From: Felipe Contreras @ 2021-05-24  2:19 UTC (permalink / raw)
  To: notmuch; +Cc: Ludovic LANGE, Stefano Zacchiroli

We don't need to check for the order here, that is done in another test.

Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 test/T395-ruby.sh | 12 ++++--------
 1 file changed, 4 insertions(+), 8 deletions(-)

diff --git a/test/T395-ruby.sh b/test/T395-ruby.sh
index e828efed..9298bc9e 100755
--- a/test/T395-ruby.sh
+++ b/test/T395-ruby.sh
@@ -20,21 +20,17 @@ test_ruby() {
 }
 
 test_begin_subtest "compare thread ids"
-notmuch search --sort=oldest-first --output=threads tag:inbox > EXPECTED
+notmuch search --output=threads tag:inbox > EXPECTED
 test_ruby <<"EOF"
-q = db.query('tag:inbox')
-q.sort = Notmuch::SORT_OLDEST_FIRST
-q.search_threads.each do |t|
+db.query('tag:inbox').search_threads.each do |t|
   puts 'thread:%s' % t.thread_id
 end
 EOF
 
 test_begin_subtest "compare message ids"
-notmuch search --sort=oldest-first --output=messages tag:inbox > EXPECTED
+notmuch search --output=messages tag:inbox > EXPECTED
 test_ruby <<"EOF"
-q = db.query('tag:inbox')
-q.sort = Notmuch::SORT_OLDEST_FIRST
-q.search_messages.each do |m|
+db.query('tag:inbox').search_messages.each do |m|
   puts 'id:%s' % m.message_id
 end
 EOF
-- 
2.32.0.rc0

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH v2 0/2] ruby: improve db.query
  2021-05-24  2:19 [PATCH v2 0/2] ruby: improve db.query Felipe Contreras
  2021-05-24  2:19 ` [PATCH v2 1/2] ruby: add keyword arguments to db.query Felipe Contreras
  2021-05-24  2:19 ` [PATCH v2 2/2] test: ruby: simplify basic tests Felipe Contreras
@ 2021-06-04  6:08 ` Felipe Contreras
  2 siblings, 0 replies; 4+ messages in thread
From: Felipe Contreras @ 2021-06-04  6:08 UTC (permalink / raw)
  To: notmuch; +Cc: Ludovic LANGE, Stefano Zacchiroli

On Sun, May 23, 2021 at 9:19 PM Felipe Contreras
<felipe.contreras@gmail.com> wrote:
>
> I find it a bit annoying to have to modify the query object to add
> options when Notmuch::Database.query() can do that just fine.
>
> This series also adds a mapping to the notmuch_exclude_t enum in order
> to be able to specify NOTMUCH_EXCLUDE_ALL and others.
>
> Nothing changed from v1 except rebased on master of May 23.

Any update?

-- 
Felipe Contreras

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2021-06-04  6:08 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-24  2:19 [PATCH v2 0/2] ruby: improve db.query Felipe Contreras
2021-05-24  2:19 ` [PATCH v2 1/2] ruby: add keyword arguments to db.query Felipe Contreras
2021-05-24  2:19 ` [PATCH v2 2/2] test: ruby: simplify basic tests Felipe Contreras
2021-06-04  6:08 ` [PATCH v2 0/2] ruby: improve db.query Felipe Contreras

unofficial mirror of notmuch@notmuchmail.org

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://yhetil.org/notmuch/0 notmuch/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 notmuch notmuch/ https://yhetil.org/notmuch \
		notmuch@notmuchmail.org
	public-inbox-index notmuch

Example config snippet for mirrors.
Newsgroups are available over NNTP:
	nntp://news.yhetil.org/yhetil.mail.notmuch.general
	nntp://news.gmane.io/gmane.mail.notmuch.general


code repositories for project(s) associated with this inbox:

	notmuch.git.git (no URL configured)

AGPL code for this site: git clone http://ou63pmih66umazou.onion/public-inbox.git