[PATCH] ruby: add bindings for `notmuch_database_get_all_tags`
authorDavid Bremner <david@tethera.net>
Sun, 6 Mar 2016 11:56:28 +0000 (07:56 +2000)
committerW. Trevor King <wking@tremily.us>
Sat, 20 Aug 2016 23:21:14 +0000 (16:21 -0700)
6d/00ccdc88b6846a0254f6a765b4c7eac160dbda [new file with mode: 0644]

diff --git a/6d/00ccdc88b6846a0254f6a765b4c7eac160dbda b/6d/00ccdc88b6846a0254f6a765b4c7eac160dbda
new file mode 100644 (file)
index 0000000..e05856b
--- /dev/null
@@ -0,0 +1,182 @@
+Return-Path: <bremner@tethera.net>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by arlo.cworth.org (Postfix) with ESMTP id 3BBD76DE1348\r
+ for <notmuch@notmuchmail.org>; Sun,  6 Mar 2016 03:56:43 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at cworth.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.034\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.034 tagged_above=-999 required=5\r
+ tests=[AWL=-0.023, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01]\r
+ autolearn=disabled\r
+Received: from arlo.cworth.org ([127.0.0.1])\r
+ by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id zT9V4IXtKhI3 for <notmuch@notmuchmail.org>;\r
+ Sun,  6 Mar 2016 03:56:40 -0800 (PST)\r
+Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197])\r
+ by arlo.cworth.org (Postfix) with ESMTPS id AE3156DE021D\r
+ for <notmuch@notmuchmail.org>; Sun,  6 Mar 2016 03:56:40 -0800 (PST)\r
+Received: from remotemail by fethera.tethera.net with local (Exim 4.84)\r
+ (envelope-from <bremner@tethera.net>)\r
+ id 1acXJD-0000tn-BY; Sun, 06 Mar 2016 06:57:15 -0500\r
+Received: (nullmailer pid 3486 invoked by uid 1000);\r
+ Sun, 06 Mar 2016 11:56:35 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: Ludovic LANGE <ll-notmuchmail@lange.nom.fr>, notmuch@notmuchmail.org\r
+Subject: [PATCH] ruby: add bindings for `notmuch_database_get_all_tags`\r
+Date: Sun,  6 Mar 2016 07:56:28 -0400\r
+Message-Id: <1457265388-3434-1-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 2.7.0\r
+In-Reply-To: <1416167892-15686-1-git-send-email-ll-notmuchmail@lange.nom.fr>\r
+References: <1416167892-15686-1-git-send-email-ll-notmuchmail@lange.nom.fr>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.20\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <https://notmuchmail.org/mailman/options/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch/>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <https://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sun, 06 Mar 2016 11:56:43 -0000\r
+\r
+From: Ludovic LANGE <ll-notmuchmail@lange.nom.fr>\r
+\r
+The Ruby bindings were missing a way to get all the tags of the\r
+database. Now you should be able to access this with the public\r
+instance method `all_tags` of your database object.\r
+\r
+Example of use:\r
+    notmuchdb = Notmuch::Database.new path, { :create => false,\r
+       :mode => Notmuch::MODE_READ_ONLY }\r
+\r
+    my_tags = notmuchdb.all_tags\r
+\r
+    my_tags.each { |tag|\r
+      print tag\r
+    }\r
+\r
+    my_tags.destroy!\r
+\r
+Amended by db: improve error reporting, add test\r
+---\r
+\r
+I'm not super happy with the "%s", but apparently the compiler is not smart enough to accept just "msg" there.\r
+\r
+ NEWS                     |  5 +++++\r
+ bindings/ruby/database.c | 24 ++++++++++++++++++++++++\r
+ bindings/ruby/defs.h     |  3 +++\r
+ bindings/ruby/init.c     |  1 +\r
+ test/T395-ruby.sh        | 16 ++++++++++++++++\r
+ 5 files changed, 49 insertions(+)\r
+\r
+diff --git a/NEWS b/NEWS\r
+index 613fdfe..43dc5e0 100644\r
+--- a/NEWS\r
++++ b/NEWS\r
+@@ -1,6 +1,11 @@\r
+ Notmuch 0.22 (UNRELEASED)\r
+ =========================\r
\r
++Ruby Bindings\r
++-------------\r
++\r
++Add support for `notmuch_database_get_all_tags`\r
++\r
+ Emacs Interface\r
+ ---------------\r
\r
+diff --git a/bindings/ruby/database.c b/bindings/ruby/database.c\r
+index c03d701..6deda57 100644\r
+--- a/bindings/ruby/database.c\r
++++ b/bindings/ruby/database.c\r
+@@ -375,6 +375,30 @@ notmuch_rb_database_find_message_by_filename (VALUE self, VALUE pathv)\r
+ }\r
\r
+ /*\r
++ * call-seq: DB.get_all_tags() => TAGS\r
++ *\r
++ * Returns a list of all tags found in the database.\r
++ */\r
++VALUE\r
++notmuch_rb_database_get_all_tags (VALUE self)\r
++{\r
++    notmuch_database_t *db;\r
++    notmuch_tags_t *tags;\r
++\r
++    Data_Get_Notmuch_Database (self, db);\r
++\r
++    tags = notmuch_database_get_all_tags (db);\r
++    if (!tags) {\r
++      const char *msg = notmuch_database_status_string (db);\r
++      if (!msg)\r
++          msg = "Unknown notmuch error";\r
++\r
++      rb_raise (notmuch_rb_eBaseError, "%s", msg);\r
++    }\r
++    return Data_Wrap_Struct (notmuch_rb_cTags, NULL, NULL, tags);\r
++}\r
++\r
++/*\r
+  * call-seq: DB.query(query) => QUERY\r
+  *\r
+  * Retrieve a query object for the query string 'query'\r
+diff --git a/bindings/ruby/defs.h b/bindings/ruby/defs.h\r
+index f4901a0..167250e 100644\r
+--- a/bindings/ruby/defs.h\r
++++ b/bindings/ruby/defs.h\r
+@@ -178,6 +178,9 @@ VALUE\r
+ notmuch_rb_database_find_message_by_filename (VALUE self, VALUE pathv);\r
\r
+ VALUE\r
++notmuch_rb_database_get_all_tags (VALUE self);\r
++\r
++VALUE\r
+ notmuch_rb_database_query_create (VALUE self, VALUE qstrv);\r
\r
+ /* directory.c */\r
+diff --git a/bindings/ruby/init.c b/bindings/ruby/init.c\r
+index ab3f22d..865d6bf 100644\r
+--- a/bindings/ruby/init.c\r
++++ b/bindings/ruby/init.c\r
+@@ -229,6 +229,7 @@ Init_notmuch (void)\r
+                     notmuch_rb_database_find_message, 1); /* in database.c */\r
+     rb_define_method (notmuch_rb_cDatabase, "find_message_by_filename",\r
+                     notmuch_rb_database_find_message_by_filename, 1); /* in database.c */\r
++    rb_define_method (notmuch_rb_cDatabase, "all_tags", notmuch_rb_database_get_all_tags, 0); /* in database.c */\r
+     rb_define_method (notmuch_rb_cDatabase, "query", notmuch_rb_database_query_create, 1); /* in database.c */\r
\r
+     /*\r
+diff --git a/test/T395-ruby.sh b/test/T395-ruby.sh\r
+index d5cade8..20e0691 100755\r
+--- a/test/T395-ruby.sh\r
++++ b/test/T395-ruby.sh\r
+@@ -83,4 +83,20 @@ EOF\r
+ notmuch count --output=threads tag:inbox > EXPECTED\r
+ test_expect_equal_file OUTPUT EXPECTED\r
\r
++test_begin_subtest "get all tags"\r
++test_ruby <<"EOF"\r
++require 'notmuch'\r
++$maildir = ENV['MAIL_DIR']\r
++if not $maildir then\r
++  abort('environment variable MAIL_DIR must be set')\r
++end\r
++@db = Notmuch::Database.new($maildir)\r
++@t = @db.all_tags()\r
++for tag in @t do\r
++   print tag,"\n"\r
++end\r
++EOF\r
++notmuch search --output=tags '*' > EXPECTED\r
++test_expect_equal_file OUTPUT EXPECTED\r
++\r
+ test_done\r
+-- \r
+2.7.0\r
+\r