unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: Felipe Contreras <felipe.contreras@gmail.com>
To: notmuch@notmuchmail.org
Cc: David Bremner <david@tethera.net>,
	Felipe Contreras <felipe.contreras@gmail.com>
Subject: [PATCH v2 0/3] ruby: add latest config API
Date: Tue, 29 Jun 2021 14:08:32 -0500	[thread overview]
Message-ID: <20210629190835.19381-1-felipe.contreras@gmail.com> (raw)

Currently the simplest way to open the notmuch database properly a
client must do:

  $config = IO.popen(%w[notmuch config list]) do |io|
    io.each(chomp: true).map { |e| e.split('=') }.to_h
  end
  $db_name = config['database.path']
  $db = Notmuch::Database.new($db_name)

While this works and it's not too overly complicated, the notmuch API
already has much better constucts.

This patch series allows the user to simply do:

  $db = Notmuch::Database.open_with_config
  $config = $db.config.to_h

And much more.

Since v1 this is rebased on top of master to resolve conflicts, and a
minor style update to one test.

Felipe Contreras (3):
  ruby: add new Database.open_with_config
  ruby: add db.config
  ruby: make db.config return an enumerator

 bindings/ruby/database.c | 95 ++++++++++++++++++++++++++++++++++++++++
 bindings/ruby/defs.h     | 10 +++++
 bindings/ruby/init.c     |  2 +
 test/T395-ruby.sh        | 14 ++++++
 4 files changed, 121 insertions(+)

Range-diff against v1:
1:  0d63249e = 1:  beba4602 ruby: add new Database.open_with_config
2:  41bae8f2 ! 2:  92a36061 ruby: add db.config
    @@ Commit message
         Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
     
      ## bindings/ruby/database.c ##
    -@@ bindings/ruby/database.c: notmuch_rb_database_query_create (VALUE self, VALUE qstrv)
    +@@ bindings/ruby/database.c: notmuch_rb_database_query_create (int argc, VALUE *argv, VALUE self)
      
          return Data_Wrap_Notmuch_Object (notmuch_rb_cQuery, &notmuch_rb_query_type, query);
      }
    @@ bindings/ruby/defs.h: extern ID ID_db_mode;
      extern const rb_data_type_t notmuch_rb_database_type;
     @@ bindings/ruby/defs.h: 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);
      
     +VALUE
     +notmuch_rb_database_config (int argc, VALUE *argv, VALUE self);
    @@ bindings/ruby/init.c
     @@ bindings/ruby/init.c: Init_notmuch (void)
      		      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 */
     +    rb_define_method (notmuch_rb_cDatabase, "config", notmuch_rb_database_config, -1); /* in database.c */
      
          /*
    @@ test/T395-ruby.sh: test_ruby <<EOF
     +test_begin_subtest "config"
     +notmuch config list | grep -v '^built_with\.' > EXPECTED
     +test_ruby <<"EOF"
    -+config_db = Notmuch::Database.open_with_config
    -+config_db.config { |e| puts '%s=%s' % e }
    ++Notmuch::Database.open_with_config do |db|
    ++  db.config { |e| puts '%s=%s' % e }
    ++end
     +EOF
     +
      test_done
3:  e6880180 = 3:  4efe195f ruby: make db.config return an enumerator
-- 
2.32.0

             reply	other threads:[~2021-06-29 19:08 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-29 19:08 Felipe Contreras [this message]
2021-06-29 19:08 ` [PATCH v2 1/3] ruby: add new Database.open_with_config Felipe Contreras
2021-08-21 14:20   ` David Bremner
2021-06-29 19:08 ` [PATCH v2 2/3] ruby: add db.config Felipe Contreras
2021-06-29 19:08 ` [PATCH v2 3/3] ruby: make db.config return an enumerator Felipe Contreras

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210629190835.19381-1-felipe.contreras@gmail.com \
    --to=felipe.contreras@gmail.com \
    --cc=david@tethera.net \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).