sup 1.3 → 1.4

data/test/fixtures/rfc2047-header-encoding.eml

@@ -1,4 +1,4 @@
-From: test@example.invalid
+From: =?utf-8?q?YouTube-tj=E4nst?= <service@youtube.com>
 To: test@example.invalid
 Date: Sun, 19 Jul 2020 17:03:56 +1000
 Subject:

data/test/integration/test_draft.rb

@@ -0,0 +1,128 @@
+require "sup"
+require "test_helper"
+
+class TestDraft < Minitest::Test
+  include Redwood
+
+  def setup
+    @path = Dir.mktmpdir
+    start
+    Logger.remove_sink $stderr
+    @draft_dir = File.join @path, "drafts"
+    @test_message_1 = <<EOS
+From: Some Person <someone@example.invalid>
+To:
+Cc:
+Bcc:
+Subject: draft
+Date: Fri, 11 Apr 2025 22:34:05 +1000
+Message-ID: <123@example.invalid>
+
+My incomplete message
+EOS
+    DraftManager.instance.instance_eval "@dir = '#{@draft_dir}'"
+    Index.init @path
+    Index.load
+    SourceManager.instance.instance_eval "@sources = {}"
+    @draft_source = DraftManager.new_source
+    SourceManager.add_source @draft_source
+  end
+
+  def teardown
+    Index.save_index
+    ObjectSpace.each_object(Class).select {|a| a < Redwood::Singleton}.each do |klass|
+      klass.deinstantiate! unless klass == Redwood::Logger
+    end
+    FileUtils.rm_r @path
+  end
+
+  def test_write_draft
+    DraftManager.write_draft { |f| f.write @test_message_1 }
+
+    draft_filename = File.join @draft_dir, "0"
+    assert File.exist? draft_filename
+    assert_equal @test_message_1, (File.read draft_filename)
+
+    ## Check that it is loaded back into the index successfully too.
+    messages_in_index = Index.instance.enum_for(:each_message).to_a
+    assert_equal @test_message_1, messages_in_index.first.raw_message
+    assert_equal [:draft, :inbox].to_set, messages_in_index.first.labels
+  end
+
+  def test_discard_draft
+    DraftManager.write_draft { |f| f.write @test_message_1 }
+    draft_filename = File.join @draft_dir, "0"
+    assert File.exist? draft_filename
+    message_in_index = Index.instance.enum_for(:each_message).to_a.first
+
+    DraftManager.discard message_in_index
+    refute File.exist? draft_filename
+  end
+
+  def test_discard_already_deleted_from_disk
+    DraftManager.write_draft { |f| f.write @test_message_1 }
+    draft_filename = File.join @draft_dir, "0"
+    assert File.exist? draft_filename
+    message_in_index = Index.instance.enum_for(:each_message).to_a.first
+
+    File.delete draft_filename
+
+    DraftManager.discard message_in_index
+    refute File.exist? draft_filename
+  end
+
+  def test_load_malformed_draft
+    ## Sup always writes drafts by serialising a Message, meaning the draft is
+    ## guaranteed to have certain headers like Date. But it's always possible
+    ## for the user to edit the draft directly on the filesystem and leave it
+    ## in some kind of malformed state. Sup should handle it without crashing.
+    draft_filename = File.join @draft_dir, "0"
+    fallback_date = Time.new 2025, 5, 3, 15, 47, 41
+    File.write draft_filename, <<EOS
+Some-Header: Value
+
+body
+EOS
+    File.utime fallback_date, fallback_date, draft_filename
+    PollManager.poll_from @draft_source
+    messages_in_index = Index.instance.enum_for(:each_message).to_a
+    assert_equal "", messages_in_index[0].subj
+    assert_equal fallback_date, messages_in_index[0].date
+
+    File.write (File.join @draft_dir, "1"), <<EOS
+missing a header!
+EOS
+    PollManager.poll_from @draft_source
+    messages_in_index = Index.instance.enum_for(:each_message).to_a
+    assert_equal "", messages_in_index[0].subj
+
+    File.write (File.join @draft_dir, "2"), ""
+    PollManager.poll_from @draft_source
+    messages_in_index = Index.instance.enum_for(:each_message).to_a
+    assert_equal "", messages_in_index[0].subj
+  end
+
+  def test_draft_with_non_ascii_chars
+    message = <<EOS
+From: Some Person <someone@example.invalid>
+To:
+Cc:
+Bcc:
+Subject: UTF-8 draft 🤐
+Date: Fri, 11 Apr 2025 22:34:05 +1000
+Message-ID: <123@example.invalid>
+
+¡Buen día! Доброго ранку! おはよう！
+EOS
+    DraftManager.write_draft { |f| f.write message }
+    draft_filename = File.join @draft_dir, "0"
+    assert_equal message, (File.read draft_filename)
+
+    PollManager.poll_from @draft_source
+    messages_in_index = Index.instance.enum_for(:each_message).to_a
+    assert_equal "UTF-8 draft 🤐", messages_in_index[0].subj
+    assert_equal message, messages_in_index.first.raw_message
+    assert_equal "¡Buen día! Доброго ранку! おはよう！", \
+                 messages_in_index[0].chunks[0].lines[0]
+  end
+end

data/test/integration/test_maildir.rb

@@ -41,11 +41,13 @@ EOS
 
   def start_sup_and_add_source(source)
     start
+    Logger.remove_sink $stderr
     Index.init @path
     Index.load
     SourceManager.instance.instance_eval '@sources = {}'
     SourceManager.instance.add_source source
     PollManager.poll_from source
+    Index.save_index
   end
 
   # and now, let the tests begin!

data/test/integration/test_mbox.rb

@@ -34,11 +34,13 @@ EOS
 
   def start_sup_and_add_source(source)
     start
+    Logger.remove_sink $stderr
     Index.init @path
     Index.load
     SourceManager.instance.instance_eval '@sources = {}'
     SourceManager.instance.add_source source
     PollManager.poll_from source
+    Index.save_index
   end
 
   # and now, let the tests begin!

data/test/integration/test_sup-add.rb

@@ -26,6 +26,8 @@ class TestSupAdd < Minitest::Test
 EOS
   end
 
+  ## https://github.com/sup-heliotrope/sup/issues/577
+  ## https://github.com/sup-heliotrope/sup/issues/516
   def test_fixes_old_tag_uri_syntax
     File.write "#{@path}/sources.yaml", <<EOS
 ---
@@ -36,6 +38,7 @@ EOS
   sync_back: true
   id: 1
   labels: []
+- !supmua.org,2006-10-01/Redwood/SentLoader {}
 EOS
     _out, _err = capture_subprocess_io do
       assert system({"SUP_BASE" => @path}, "bin/sup-add", "maildir:///other/path")
@@ -58,6 +61,7 @@ EOS
   sync_back: true
   id: 2
   labels: []
+- !<tag:supmua.org,2006-10-01/Redwood/SentLoader> {}
 EOS
   end
 

data/test/test_crypto.rb

@@ -38,8 +38,13 @@ class TestCryptoManager < Minitest::Test
         @path = Dir.mktmpdir
         Redwood::HookManager.init File.join(@path, 'hooks')
 
-        am = {:default=> {name: +"test", email: @from_email.dup, alternates: [@from_email_ecc.dup]}}
-        Redwood::AccountManager.init am
+        account = {
+          :name => +"test",
+          :email => @from_email.dup,
+          :alternates => [@from_email_ecc.dup],
+          :sendmail => "/bin/false",
+        }
+        Redwood::AccountManager.init :default => account
 
         Redwood::CryptoManager.init
     end

data/test/test_message.rb

@@ -253,6 +253,7 @@ class TestMessage < Minitest::Test
                  "bad: =?UTF16?q?badcharsetname?==?US-ASCII?b?/w?=" +
                  "=?UTF-7?Q?=41=6D=65=72=69=63=61=E2=80=99=73?=",
                  sup_message.subj)
+    assert_equal "=?utf-8?q?YouTube-tj=E4nst?=", sup_message.from.name
   end
 
   def test_nonascii_header

data/test/unit/test_contact.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'sup'
 require 'sup/contact'
 
 module Redwood
@@ -16,9 +17,20 @@ class TestContact < Minitest::Test
 
   def test_contact_manager
     assert @contact
-    ## 1 contact is imported from the fixture file.
-    assert_equal 1, @contact.contacts.count
-    assert_equal @contact.contact_for("RC").name, "Random Contact"
+
+    ## 2 contacts are imported from the fixture file.
+    assert_equal 2, @contact.contacts.count
+
+    rc = @contact.contact_for "RC"
+    assert_equal "Random Contact", rc.name
+    assert @contact.is_aliased_contact? rc
+    assert_equal "RC", @contact.alias_for(rc)
+
+    uc = @contact.person_for "unaliased@example.invalid"
+    refute @contact.is_aliased_contact? uc
+    assert_nil @contact.alias_for uc
+    assert_equal [rc, uc], @contact.contacts
+    assert_equal [rc], @contact.contacts_with_aliases
 
     assert_nil @contact.contact_for "TN"
     @contact.update_alias @person, "TN"

data/test/unit/test_edit_message_mode.rb

@@ -24,7 +24,12 @@ class TestEditMessageMode < Minitest::Test
     $config = {}
     @path = Dir.mktmpdir
     Redwood::HookManager.init File.join(@path, "hooks")
-    Redwood::AccountManager.init :default => {name: +"test", email: +"sender@example.invalid"}
+    account = {
+      :name => +"test",
+      :email => +"sender@example.invalid",
+      :sendmail => "/bin/false",
+    }
+    Redwood::AccountManager.init :default => account
     Redwood::CryptoManager.instance_variable_set :@instance, DummyCryptoManager.new
   end
 

data/test/unit/test_index.rb

@@ -0,0 +1,65 @@
+require "minitest/mock"
+require "test_helper"
+
+require "sup"
+
+class TestIndex < Minitest::Test
+  def setup
+    @path = Dir.mktmpdir
+    Redwood::start
+    Redwood::Logger.remove_sink $stderr
+    Redwood::Index.init @path
+    Redwood::Index.load
+  end
+
+  def teardown
+    Redwood::Index.save_index
+    ObjectSpace.each_object(Class).select {|a| a < Redwood::Singleton}.each do |klass|
+      klass.deinstantiate! unless klass == Redwood::Logger
+    end
+    FileUtils.rm_r @path
+  end
+
+  def with_fake_time &block
+    Time.stub :now, Time.utc(2000) do
+      ## Also stub Time.local to behave like Time.utc so that Chronic.parse
+      ## doesn't pick up the timezone of the test runner.
+      Time.stub :local, ->(*args) { Time.utc(*args) }, &block
+    end
+  end
+
+  def test_date_query_parsing
+    parsed = with_fake_time do
+      Redwood::Index.parse_query "after:yesterday"
+    end
+    expected_qobj = Xapian::Query.new(
+      Xapian::Query::OP_VALUE_RANGE,
+      Redwood::Index::DATE_VALUENO,
+      Xapian.sortable_serialise(Time.utc(2000, 1, 1).to_i),
+      Xapian.sortable_serialise(2**32),
+    )
+    assert_equal expected_qobj.description, parsed[:qobj].description
+
+    parsed = with_fake_time do
+      Redwood::Index.parse_query "before:yesterday"
+    end
+    expected_qobj = Xapian::Query.new(
+      Xapian::Query::OP_VALUE_RANGE,
+      Redwood::Index::DATE_VALUENO,
+      Xapian.sortable_serialise(0),
+      Xapian.sortable_serialise(Time.utc(2000, 1, 1).to_i),
+    )
+    assert_equal expected_qobj.description, parsed[:qobj].description
+
+    parsed = with_fake_time do
+      Redwood::Index.parse_query "during:yesterday"
+    end
+    expected_qobj = Xapian::Query.new(
+      Xapian::Query::OP_VALUE_RANGE,
+      Redwood::Index::DATE_VALUENO,
+      Xapian.sortable_serialise(Time.utc(1999, 12, 31).to_i),
+      Xapian.sortable_serialise(Time.utc(2000,  1,  1).to_i),
+    )
+    assert_equal expected_qobj.description, parsed[:qobj].description
+  end
+end

data/test/unit/test_line_cursor_mode.rb

@@ -0,0 +1,208 @@
+require "test_helper"
+require "dummy_buffer"
+
+require "sup"
+
+class TestLineCursorMode < Minitest::Test
+  def setup
+    $config = {
+      :load_more_threads_hysteresis => 0,
+      :load_more_threads_when_scrolling => true,
+      :continuous_scroll => false,
+    }
+    Redwood::BufferManager.init
+    @modes_to_cleanup = []
+    @lines = []
+    @load_more = Thread::Queue.new
+    @buffer_height = 41  # 1 for status line, 40 usable lines
+  end
+
+  def teardown
+    @modes_to_cleanup.each { |mode| mode.cleanup }
+    Redwood::BufferManager.deinstantiate!
+    $config = nil
+  end
+
+  def make_mode
+    mode = Redwood::LineCursorMode.new
+    @modes_to_cleanup << mode
+    lines = @lines
+    mode.define_singleton_method(:lines) { lines.length }
+    mode.define_singleton_method(:[]) { |i| lines[i] }
+    mode.send(:to_load_more) { |n| @load_more << n }
+    mode.buffer = Redwood::DummyBuffer.new 100, @buffer_height
+    mode.spawned
+    mode.draw
+    mode
+  end
+
+  def expect_load_more n
+    begin
+      requested = @load_more.pop :timeout => 0.1
+    rescue ThreadError
+      ## Ruby < 3.2 does not obey the timeout for Queue#pop
+      sleep 0.1
+      requested = @load_more.pop true
+    end
+    refute_nil requested, "Expected load_more callbacks to fire"
+    assert_equal n, requested
+    (0...n).map { |i| @lines << "line #{i}" }
+  end
+
+  def test_cursor_down
+    mode = make_mode
+    expect_load_more 41
+    mode.draw  # curpos gets messed up without this call, why?
+
+    21.times do
+      mode.handle_input Ncurses::CharCode.character('j')
+    end
+    assert_equal 21, mode.curpos
+    assert_equal 0, mode.topline
+
+    ## Two past halfway, load_more callbacks are triggered.
+    mode.handle_input Ncurses::CharCode.character('j')
+    assert_equal 22, mode.curpos
+    expect_load_more 40
+
+    17.times do
+      mode.handle_input Ncurses::CharCode.character('j')
+    end
+    assert_equal 39, mode.curpos
+    assert_equal 0, mode.topline
+
+    ## From the bottom line, it wraps back to the top of the next page.
+    mode.handle_input Ncurses::CharCode.character('j')
+    assert_equal 40, mode.curpos
+    assert_equal 40, mode.topline
+  end
+
+  def test_scroll_down
+    mode = make_mode
+    expect_load_more 41
+
+    ## When the cursor is already at the top, it moves with the scroll.
+    assert_equal 0, mode.curpos
+    assert_equal 0, mode.topline
+    mode.handle_input Ncurses::CharCode.character('J')
+    assert_equal 1, mode.curpos
+    assert_equal 1, mode.topline
+
+    3.times do
+      mode.handle_input Ncurses::CharCode.character('j')
+    end
+    assert_equal 4, mode.curpos
+    assert_equal 1, mode.topline
+
+    ## When the cursor is not at the top, it keeps its place and the
+    ## buffer scrolls underneath it.
+    mode.handle_input Ncurses::CharCode.character('J')
+    assert_equal 4, mode.curpos
+    assert_equal 2, mode.topline
+
+    ## It always loads 10 more if we would scroll past the bottom.
+    expect_load_more 10
+  end
+
+  def test_page_down
+    mode = make_mode
+    expect_load_more 41
+
+    mode.handle_input Ncurses::CharCode.keycode(Ncurses::KEY_NPAGE)
+    assert_equal 40, mode.curpos
+    assert_equal 40, mode.topline
+    expect_load_more 40
+
+    mode.handle_input Ncurses::CharCode.keycode(Ncurses::KEY_NPAGE)
+    assert_equal 80, mode.curpos
+    assert_equal 80, mode.topline
+    assert_equal 81, mode.lines
+    expect_load_more 40
+  end
+
+  def test_page_down_when_fully_populated
+    mode = make_mode
+    expect_load_more 41
+    (0...119).map { |i| @lines << "more line #{i}" }  # enough for 4 full pages
+
+    mode.handle_input Ncurses::CharCode.keycode(Ncurses::KEY_NPAGE)
+    assert_equal 40, mode.curpos
+    assert_equal 40, mode.topline
+
+    ## Relative cursor position is preserved when paging down.
+    3.times do
+      mode.handle_input Ncurses::CharCode.character('j')
+    end
+    assert_equal 43, mode.curpos
+    assert_equal 40, mode.topline
+    mode.handle_input Ncurses::CharCode.keycode(Ncurses::KEY_NPAGE)
+    assert_equal 83, mode.curpos
+    assert_equal 80, mode.topline
+  end
+
+  def test_half_page_down
+    mode = make_mode
+    expect_load_more 41
+
+    mode.handle_input Ncurses::CharCode.character("\C-d")
+    assert_equal 20, mode.curpos
+    assert_equal 20, mode.topline
+    expect_load_more 40
+
+    mode.handle_input Ncurses::CharCode.character("\C-d")
+    assert_equal 40, mode.curpos
+    assert_equal 40, mode.topline
+  end
+
+  def test_half_page_down_when_fully_populated
+    mode = make_mode
+    expect_load_more 41
+    (0...119).map { |i| @lines << "more line #{i}" }  # enough for 4 full pages
+
+    mode.handle_input Ncurses::CharCode.character("\C-d")
+    assert_equal 20, mode.curpos
+    assert_equal 20, mode.topline
+
+    25.times do
+      mode.handle_input Ncurses::CharCode.character('j')
+    end
+    assert_equal 45, mode.curpos
+    assert_equal 20, mode.topline
+    mode.handle_input Ncurses::CharCode.character("\C-d")
+    assert_equal 45, mode.curpos
+    assert_equal 40, mode.topline
+  end
+
+  def test_half_page_up
+    mode = make_mode
+    expect_load_more 41
+    (0...119).map { |i| @lines << "more line #{i}" }  # enough for 4 full pages
+
+    mode.handle_input Ncurses::CharCode.keycode(Ncurses::KEY_NPAGE)
+    assert_equal 40, mode.curpos
+    assert_equal 40, mode.topline
+
+    mode.handle_input Ncurses::CharCode.character("\C-u")
+    assert_equal 40, mode.curpos
+    assert_equal 20, mode.topline
+
+    mode.handle_input Ncurses::CharCode.character('j')
+    assert_equal 41, mode.curpos
+    assert_equal 20, mode.topline
+
+    mode.handle_input Ncurses::CharCode.character("\C-u")
+    assert_equal 40, mode.curpos
+    assert_equal 0, mode.topline
+  end
+
+  def test_jump_to_end
+    mode = make_mode
+    expect_load_more 41
+
+    mode.handle_input Ncurses::CharCode.keycode(Ncurses::KEY_END)
+    assert_equal 40, mode.curpos
+    assert_equal 1, mode.topline
+    assert_equal 41, mode.botline
+    expect_load_more 40
+  end
+end

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: sup
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: '1.4'
 platform: ruby
 authors:
 - William Morgan
 - Gaute Hope
 - Hamish Downer
 - Matthieu Rakotojaona
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-21 00:00:00.000000000 Z
+date: 2026-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ncursesw
@@ -370,10 +369,15 @@ files:
 - contrib/nix/ruby3.0-Gemfile.lock
 - contrib/nix/ruby3.0-gemset.nix
 - contrib/nix/ruby3.0-shell.nix
+- contrib/nix/ruby3.1-Gemfile.lock
+- contrib/nix/ruby3.1-gemset.nix
 - contrib/nix/ruby3.1-shell.nix
+- contrib/nix/ruby3.2-Gemfile.lock
+- contrib/nix/ruby3.2-gemset.nix
 - contrib/nix/ruby3.2-shell.nix
 - contrib/nix/ruby3.3-shell.nix
 - contrib/nix/ruby3.4-shell.nix
+- contrib/nix/ruby4.0-shell.nix
 - contrib/nix/test-all-rubies.sh
 - devel/console.sh
 - devel/count-loc.sh
@@ -461,8 +465,8 @@ files:
 - man/sup-sync.1
 - man/sup-tweak-labels.1
 - man/sup.1
-- shell.nix
 - sup.gemspec
+- test/dummy_buffer.rb
 - test/dummy_source.rb
 - test/fixtures/bad-content-transfer-encoding-1.eml
 - test/fixtures/binary-content-transfer-encoding-2.eml
@@ -496,6 +500,7 @@ files:
 - test/gnupg_test_home/regen_keys.sh
 - test/gnupg_test_home/secring.gpg
 - test/gnupg_test_home/sup-test-2@foo.bar.asc
+- test/integration/test_draft.rb
 - test/integration/test_maildir.rb
 - test/integration/test_mbox.rb
 - test/integration/test_sup-add.rb
@@ -510,13 +515,15 @@ files:
 - test/unit/test_contact.rb
 - test/unit/test_edit_message_mode.rb
 - test/unit/test_horizontal_selector.rb
+- test/unit/test_index.rb
+- test/unit/test_line_cursor_mode.rb
 - test/unit/test_locale_fiddler.rb
 - test/unit/test_person.rb
 - test/unit/test_rmail_message.rb
 - test/unit/util/test_query.rb
 - test/unit/util/test_string.rb
 - test/unit/util/test_uri.rb
-homepage: https://sup-heliotrope.github.io/
+homepage: https://supmua.dev/
 licenses:
 - GPL-2.0
 metadata: {}
@@ -543,11 +550,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A console-based email client with the best features of GMail, mutt and Emacs
 test_files:
+- test/dummy_buffer.rb
 - test/dummy_source.rb
 - test/fixtures/bad-content-transfer-encoding-1.eml
 - test/fixtures/binary-content-transfer-encoding-2.eml
@@ -581,6 +588,7 @@ test_files:
 - test/gnupg_test_home/regen_keys.sh
 - test/gnupg_test_home/secring.gpg
 - test/gnupg_test_home/sup-test-2@foo.bar.asc
+- test/integration/test_draft.rb
 - test/integration/test_maildir.rb
 - test/integration/test_mbox.rb
 - test/integration/test_sup-add.rb
@@ -595,6 +603,8 @@ test_files:
 - test/unit/test_contact.rb
 - test/unit/test_edit_message_mode.rb
 - test/unit/test_horizontal_selector.rb
+- test/unit/test_index.rb
+- test/unit/test_line_cursor_mode.rb
 - test/unit/test_locale_fiddler.rb
 - test/unit/test_person.rb
 - test/unit/test_rmail_message.rb

data/shell.nix

@@ -1 +0,0 @@
-contrib/nix/ruby3.3-shell.nix