teek-ui 0.1.0

data/test/test_toast.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require_relative '../../test/tk_test_helper'
+
+# ui.toast: a brief, auto-dismissing notification (e.g. "Saved" after a
+# save action). Genericized from an SDL2-rendered original that drew its
+# own background/text directly to a renderer - this is a real ttk::label,
+# floated over the bottom of the window via place, reused across calls
+# rather than rebuilt each time (there's only ever one toast on screen).
+class TestToast < Minitest::Test
+  include TeekTestHelper
+
+  def test_toast_raises_before_realize
+    assert_tk_app("session.toast should raise before realize, matching every other realize-only action") do
+      require 'teek/ui'
+
+      session = Teek::UI.app(title: 'Toast Test')
+
+      assert_raises(Teek::UI::NotRealizedError) { session.toast('Saved') }
+    end
+  end
+
+  def test_toast_shows_the_message
+    assert_tk_app("toast should create a visible widget carrying the given text") do
+      require 'teek/ui'
+
+      session = Teek::UI.app(title: 'Toast Test')
+      session.run_async
+
+      session.toast('Saved')
+      session.app.update
+
+      assert_equal 'Saved', session.app.command('.toast', :cget, '-text')
+      assert session.app.winfo.ismapped?('.toast')
+
+      session.app.destroy
+    end
+  end
+
+  def test_toast_auto_dismisses_after_a_custom_duration
+    assert_tk_app("toast should auto-dismiss after the given duration, not stay forever") do
+      require 'teek/ui'
+
+      session = Teek::UI.app(title: 'Toast Test')
+      session.run_async
+
+      session.toast('Saved', duration: 30)
+      session.app.update
+      assert session.app.winfo.ismapped?('.toast'), "should be visible immediately after showing"
+
+      deadline = Time.now + 2
+      session.app.update while session.app.winfo.ismapped?('.toast') && Time.now < deadline
+
+      refute session.app.winfo.ismapped?('.toast'), "should have auto-dismissed by now"
+
+      session.app.destroy
+    end
+  end
+
+  def test_toast_auto_dismisses_after_the_default_duration
+    assert_tk_app("toast with no duration: override should still auto-dismiss, using the built-in default") do
+      require 'teek/ui'
+
+      session = Teek::UI.app(title: 'Toast Test')
+      session.run_async
+
+      session.toast('Saved')
+      session.app.update
+      assert session.app.winfo.ismapped?('.toast')
+
+      deadline = Time.now + 3
+      session.app.update while session.app.winfo.ismapped?('.toast') && Time.now < deadline
+
+      refute session.app.winfo.ismapped?('.toast'), "the default duration should have elapsed by now"
+
+      session.app.destroy
+    end
+  end
+
+  def test_toast_called_again_replaces_rather_than_stacks
+    assert_tk_app("a second toast while one is showing should replace it, not create a second widget") do
+      require 'teek/ui'
+
+      session = Teek::UI.app(title: 'Toast Test')
+      session.run_async
+
+      before = session.app.split_list(session.app.tcl_eval('winfo children .')).length
+
+      session.toast('Saved')
+      session.app.update
+      session.toast('Settings')
+      session.app.update
+
+      after = session.app.split_list(session.app.tcl_eval('winfo children .')).length
+
+      assert_equal before + 1, after, "calling toast twice should not leave two separate widgets behind"
+      assert_equal 'Settings', session.app.command('.toast', :cget, '-text')
+
+      session.app.destroy
+    end
+  end
+
+  def test_toast_called_again_cancels_the_earlier_dismiss_timer
+    assert_tk_app("replacing a toast should cancel the earlier one's auto-dismiss - it must not hide the NEW toast early") do
+      require 'teek/ui'
+
+      session = Teek::UI.app(title: 'Toast Test')
+      session.run_async
+
+      session.toast('Saved', duration: 30)
+      session.app.update
+      session.toast('Settings', duration: 1000)
+      session.app.update
+
+      sleep 0.08
+      session.app.update
+
+      assert session.app.winfo.ismapped?('.toast'),
+        "the first toast's short timer should have been cancelled, not fired and hidden the replacement"
+      assert_equal 'Settings', session.app.command('.toast', :cget, '-text')
+
+      session.app.destroy
+    end
+  end
+end

data/test/test_tree_inspector.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+require_relative 'test_helper'
+require 'teek/ui/tree_inspector'
+require 'teek/ui/document'
+require 'teek/ui/session'
+
+# TreeInspector only ever calls #root and #subscribe on whatever it's
+# given - these two minimal doubles exist to prove that's genuinely true
+# (it works against ANY object shaped like this, not just an instance of
+# Teek::UI::Document/Node), not merely that it's convenient to unit test
+# through the real classes.
+FakeInspectorNode = Struct.new(:type, :name, :opts, :children) do
+  def display_name
+    name ? "#{type}(:#{name})" : type.to_s
+  end
+end
+
+FakeInspectorDocument = Struct.new(:root) do
+  def initialize(root)
+    super
+    @listeners = Hash.new { |h, k| h[k] = [] }
+  end
+
+  def subscribe(event, &block)
+    @listeners[event] << block
+  end
+
+  def notify(event, *args)
+    @listeners[event].each { |listener| listener.call(*args) }
+  end
+end
+
+class TestTreeInspector < Minitest::Test
+  def test_to_s_and_log_work_against_a_fake_document_not_the_real_teek_ui_one
+    button = FakeInspectorNode.new(:button, nil, { text: 'Go' }, [])
+    root = FakeInspectorNode.new(:root, nil, {}, [button])
+    document = FakeInspectorDocument.new(root)
+
+    inspector = Teek::UI::TreeInspector.new(document, trace: true)
+    document.notify(:append, root, button)
+
+    assert_equal "root\n└─ button \"Go\"", inspector.to_s
+    assert_equal 1, inspector.log.length
+    assert_equal :append, inspector.log.first.action
+    assert_same button, inspector.log.first.node
+  end
+
+  def test_to_s_renders_the_example_shape
+    document = Teek::UI::Document.new
+    column = document.root.add_child(document.create(type: :column))
+    column.add_child(document.create(type: :label, opts: { text: 'Title' }))
+    row = column.add_child(document.create(type: :row))
+    row.add_child(document.create(type: :button, opts: { text: 'OK' }))
+    row.add_child(document.create(type: :button, opts: { text: 'Cancel' }))
+    column.add_child(document.create(type: :label, opts: { text: 'Footer' }))
+
+    expected = <<~TREE.chomp
+      root
+      └─ column
+         ├─ label "Title"
+         ├─ row
+         │  ├─ button "OK"
+         │  └─ button "Cancel"
+         └─ label "Footer"
+    TREE
+
+    assert_equal expected, Teek::UI::TreeInspector.new(document).to_s
+  end
+
+  def test_to_s_on_an_empty_document_is_just_root
+    document = Teek::UI::Document.new
+
+    assert_equal 'root', Teek::UI::TreeInspector.new(document).to_s
+  end
+
+  def test_to_s_shows_a_name_alongside_the_type
+    document = Teek::UI::Document.new
+    document.root.add_child(document.create(type: :column, name: :ctrl))
+
+    assert_equal "root\n└─ column(:ctrl)", Teek::UI::TreeInspector.new(document).to_s
+  end
+
+  def test_to_s_prefers_text_over_label_when_a_node_somehow_has_both
+    document = Teek::UI::Document.new
+    document.root.add_child(document.create(type: :button, opts: { text: 'OK', label: 'ignored' }))
+
+    assert_equal "root\n└─ button \"OK\"", Teek::UI::TreeInspector.new(document).to_s
+  end
+
+  def test_to_s_falls_back_to_label_for_a_menu_item_shaped_node
+    document = Teek::UI::Document.new
+    document.root.add_child(document.create(type: :menu_item, opts: { label: 'Open' }))
+
+    assert_equal "root\n└─ menu_item \"Open\"", Teek::UI::TreeInspector.new(document).to_s
+  end
+
+  def test_to_s_reflects_the_trees_current_shape_when_called_again_later
+    document = Teek::UI::Document.new
+    inspector = Teek::UI::TreeInspector.new(document)
+
+    assert_equal 'root', inspector.to_s
+
+    document.root.add_child(document.create(type: :button, opts: { text: 'Go' }))
+
+    assert_equal "root\n└─ button \"Go\"", inspector.to_s
+  end
+
+  def test_print_tree_writes_to_s_to_stdout
+    document = Teek::UI::Document.new
+    document.root.add_child(document.create(type: :button, opts: { text: 'Go' }))
+    inspector = Teek::UI::TreeInspector.new(document)
+
+    out, = capture_io { inspector.print_tree }
+
+    assert_equal "#{inspector}\n", out
+  end
+
+  def test_log_is_empty_without_trace_true
+    document = Teek::UI::Document.new
+    inspector = Teek::UI::TreeInspector.new(document)
+
+    document.root.add_child(document.create(type: :button))
+
+    assert_equal [], inspector.log
+  end
+
+  def test_log_records_append_events_once_tracing
+    document = Teek::UI::Document.new
+    inspector = Teek::UI::TreeInspector.new(document, trace: true)
+    parent = document.create(type: :column, name: :ctrl)
+    child = document.create(type: :button, opts: { text: 'Go' })
+
+    parent.add_child(child)
+
+    assert_equal 1, inspector.log.length
+    event = inspector.log.first
+    assert_equal :append, event.action
+    assert_same child, event.node
+    assert_equal 'column(:ctrl)', event.path
+  end
+
+  def test_log_records_push_and_pop_events_once_tracing_through_the_real_builder
+    session = Teek::UI::Session.new(title: 'Tree Inspector Test')
+    inspector = Teek::UI::TreeInspector.new(session.document, trace: true)
+
+    session.column(:ctrl) { |c| c.row(:speed_row) { } }
+
+    actions = inspector.log.map(&:action)
+    assert_equal %i[append push append push pop pop], actions
+    assert_equal 'root', inspector.log[0].path, "column appended under the (unnamed) root"
+    assert_equal 'column(:ctrl)', inspector.log[1].path, "pushing column - path now includes it"
+    assert_equal 'column(:ctrl)', inspector.log[2].path, "row appended under column"
+    assert_equal 'column(:ctrl) > row(:speed_row)', inspector.log[3].path, "pushing row - path now includes it too"
+  end
+
+  def test_two_inspectors_on_the_same_document_are_independent
+    document = Teek::UI::Document.new
+    tracing = Teek::UI::TreeInspector.new(document, trace: true)
+    not_tracing = Teek::UI::TreeInspector.new(document)
+
+    document.root.add_child(document.create(type: :button))
+
+    refute_empty tracing.log
+    assert_empty not_tracing.log
+  end
+
+  def test_event_to_s_is_readable_for_each_action
+    document = Teek::UI::Document.new
+    inspector = Teek::UI::TreeInspector.new(document, trace: true)
+    parent = document.create(type: :column)
+    child = document.create(type: :button)
+
+    document.notify(:push, parent, 'column')
+    parent.add_child(child)
+    document.notify(:pop, parent, 'column')
+
+    push_s, append_s, pop_s = inspector.log.map(&:to_s)
+    assert_match(/column/, push_s)
+    assert_match(/button/, append_s)
+    assert_match(/column/, pop_s)
+  end
+end