ruby: add keyword arguments to db.query

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

Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
This commit is contained in:
Felipe Contreras 2021-05-23 21:19:09 -05:00 committed by David Bremner
parent 6e7365fb20
commit 814abafc3e
4 changed files with 64 additions and 5 deletions

View file

@ -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 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; const char *qstr;
notmuch_query_t *query; notmuch_query_t *query;
notmuch_database_t *db; notmuch_database_t *db;
rb_scan_args (argc, argv, "1:", &qstrv, &opts);
Data_Get_Notmuch_Database (self, db); Data_Get_Notmuch_Database (self, db);
SafeStringValue (qstrv); SafeStringValue (qstrv);
@ -415,5 +422,39 @@ notmuch_rb_database_query_create (VALUE self, VALUE qstrv)
if (!query) if (!query)
rb_raise (notmuch_rb_eMemoryError, "Out of memory"); 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); return Data_Wrap_Notmuch_Object (notmuch_rb_cQuery, &notmuch_rb_query_type, query);
} }

View file

@ -174,7 +174,7 @@ VALUE
notmuch_rb_database_get_all_tags (VALUE self); notmuch_rb_database_get_all_tags (VALUE self);
VALUE VALUE
notmuch_rb_database_query_create (VALUE self, VALUE qstrv); notmuch_rb_database_query_create (int argc, VALUE *argv, VALUE self);
/* directory.c */ /* directory.c */
VALUE VALUE

View file

@ -275,7 +275,7 @@ Init_notmuch (void)
rb_define_method (notmuch_rb_cDatabase, "find_message_by_filename", rb_define_method (notmuch_rb_cDatabase, "find_message_by_filename",
notmuch_rb_database_find_message_by_filename, 1); /* in database.c */ 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, "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 * Document-class: Notmuch::Directory

View file

@ -82,4 +82,22 @@ q.search_threads.each do |t|
end end
EOF 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 test_done