[PATCH 2/3] ruby: add keyword arguments to db.query

Subject: [PATCH 2/3] ruby: add keyword arguments to db.query

Date: Sat, 1 May 2021 07:04:47 -0500

To: notmuch@notmuchmail.org

Cc: Ludovic LANGE, Stefano Zacchiroli

From: Felipe Contreras

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 416eb709..313a4338 100644
--- a/bindings/ruby/database.c
+++ b/bindings/ruby/database.c
@@ -399,17 +399,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);
@@ -419,5 +426,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_Struct (notmuch_rb_cQuery, NULL, NULL, query);
 }
diff --git a/bindings/ruby/defs.h b/bindings/ruby/defs.h
index 48544ca2..1ceaadb5 100644
--- a/bindings/ruby/defs.h
+++ b/bindings/ruby/defs.h
@@ -181,7 +181,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 fd73ed8f..f509edbd 100644
--- a/bindings/ruby/init.c
+++ b/bindings/ruby/init.c
@@ -254,7 +254,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.31.0
_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: