curses_menu 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74becd64c41df7dc7628e8c2b2c416c56f430c53d9be7e3e68698bb6bc1633aa
-  data.tar.gz: 02bf486f61ae412243d536912202a36eb03d72d6c3c0e4ff034808221193d3f5
+  metadata.gz: 8dc4a9d14a6f315f6e2fba464d40d58d7a17922ee9afe1aabc1c045a4731a561
+  data.tar.gz: fde73b88bf3972e2b4353911dea6278cd606a2a8e673feeab8dff41a87a0f3e8
 SHA512:
-  metadata.gz: d7014fece6ecf47e9f0dba36ee8b835841b8176809a09f52bf16e87892719075da8847427a62b2558068bb15abd6cb12cab0f49b4456693c417740c0d306f77d
-  data.tar.gz: c407a1d42c57f39fa7c32488191097186c574fca00bd043e664b7cce45f0fba946d227712f9754025b0c9c72fac342cd721e3429cd2d4427b3d2bc4bfdc6dac6
+  metadata.gz: 6f9e782b2d1264e4b8b2e3b5f721574ba62abb20935a6d61fe6a70647d73386da9fc6c429689f35de3463f2d6aa6ce5d799fe8d17793b05a5621a27128bb3456
+  data.tar.gz: c39295fce31482e5f3dd91f2a0de36658912c4fd0d6da3d7a18d0ae55671b74dd5d13e6b74037c96b57993716776697f3b5cb01e5da484b660dc459cd2fe9d1a

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [v0.1.0](https://github.com/Muriel-Salvan/curses_menu/compare/v0.0.6...v0.1.0) (2022-10-12 15:58:25)
+
+### Features
+
+* [[#5] [feature] Add possibility to render menu item titles in a lazy way](https://github.com/Muriel-Salvan/curses_menu/commit/6997c846f800d37441ea40bce109345e725ff12c)
+
 # [v0.0.6](https://github.com/Muriel-Salvan/curses_menu/compare/v0.0.5...v0.0.6) (2022-10-12 15:48:18)
 
 ### Patches

data/examples/lazy_menu_items.rb

@@ -0,0 +1,14 @@
+require 'curses_menu'
+
+nbr_visible_items = Curses.stdscr.maxy - 5
+CursesMenu.new 'Menu items using lazy rendering' do |menu|
+  (nbr_visible_items * 2).times do
+    menu.item "I am a normal item, rendered at #{Time.now}"
+    menu.item(proc do
+      "I am a lazy item, rendered at   #{Time.now}"
+    end)
+  end
+  menu.item 'Refresh menu' do
+    :menu_refresh
+  end
+end

data/lib/curses_menu/version.rb

@@ -1,5 +1,5 @@
 class CursesMenu
 
-  VERSION = '0.0.6'
+  VERSION = '0.1.0'
 
 end

data/lib/curses_menu.rb

@@ -55,9 +55,11 @@ class CursesMenu
         # Display the menu
         current_items[display_first_idx..display_first_idx + max_displayed_items - 1].each.with_index do |item_info, idx|
           selected = display_first_idx + idx == selected_idx
+          # Keep a cache of titles as they can be loaded in a lazy way for performance
+          item_info[:title_cached] = item_info[:title].is_a?(Proc) ? item_info[:title].call : item_info[:title] unless item_info.key?(:title_cached)
           print(
             window,
-            item_info[:title],
+            item_info[:title_cached],
             from: display_first_char_idx,
             default_color_pair: item_info.key?(:actions) ? COLORS_MENU_ITEM : COLORS_LINE,
             force_color_pair: selected ? COLORS_MENU_ITEM_SELECTED : nil,
@@ -159,7 +161,7 @@ class CursesMenu
   # This method is meant to be called from a choose_from call.
   #
   # Parameters::
-  # * *title* (String or CursesRow): Text to be displayed for this item
+  # * *title* (String, CursesRow or Proc): Text to be displayed for this item, or Proc returning this text when needed (lazy loading)
   # * *actions* (Hash<Object, Hash<Symbol,Object> >): Associated actions to this item, per shortcut [default: {}]
   #   * *name* (String): Name of this action (displayed at the bottom of the menu)
   #   * *execute* (Proc): Code called when this action is selected

data/spec/curses_menu_test/lazy_spec.rb

@@ -0,0 +1,127 @@
+describe CursesMenu do
+
+  it 'displays a menu with 1 item with lazy rendering' do
+    render_called = false
+    test_menu(title: 'Menu title') do |menu|
+      menu.item(proc do
+        render_called = true
+        'Menu item lazy'
+      end)
+    end
+    expect(render_called).to be true
+    assert_line 3, 'Menu item lazy'
+  end
+
+  it 'displays a menu with 1 item in a CursesRow with lazy rendering' do
+    render_called = false
+    test_menu(title: 'Menu title') do |menu|
+      menu.item(proc do
+        render_called = true
+        CursesMenu::CursesRow.new({ cell: { text: 'Menu item lazy' } })
+      end)
+    end
+    expect(render_called).to be true
+    assert_line 3, 'Menu item lazy'
+  end
+
+  it 'doesn\'t lazy render when the item is not displayed' do
+    nbr_visible_items = Curses.stdscr.maxy - 5
+    render_called = false
+    test_menu(title: 'Menu title') do |menu|
+      (nbr_visible_items * 2).times do |idx|
+        menu.item "Menu item #{idx}"
+      end
+      menu.item(proc do
+        render_called = true
+        'Menu item lazy'
+      end)
+    end
+    expect(render_called).to be false
+  end
+
+  it 'keeps lazy rendered titles in a cache while navigating' do
+    nbr_renders = 0
+    test_menu(keys: [Curses::KEY_DOWN, Curses::KEY_DOWN, Curses::KEY_DOWN]) do |menu|
+      menu.item 'Menu item 1'
+      menu.item(proc do
+        nbr_renders += 1
+        'Menu item 2 Lazy'
+      end)
+      menu.item 'Menu item 3'
+      menu.item 'Menu item 4', actions: { 'a' => { name: 'Special action', execute: proc {} } }
+    end
+    expect(nbr_renders).to eq 1
+    assert_line(-1, '= Arrows/Home/End: Navigate | Esc: Exit | a: Special action')
+  end
+
+  it 'keeps lazy rendered titles in a cache while navigating across pages' do
+    nbr_renders = 0
+    nbr_visible_items = Curses.stdscr.maxy - 5
+    test_menu(keys: [Curses::KEY_DOWN, Curses::KEY_DOWN, Curses::KEY_END, Curses::KEY_HOME, Curses::KEY_END, Curses::KEY_HOME, Curses::KEY_END]) do |menu|
+      (nbr_visible_items * 2).times do |idx|
+        menu.item "Menu item #{idx}"
+      end
+      menu.item(proc do
+        nbr_renders += 1
+        'Menu item Lazy'
+      end)
+    end
+    expect(nbr_renders).to eq 1
+    assert_line(-3, 'Menu item Lazy')
+  end
+
+  it 'refreshes lazy rendered titles between menu refreshes' do
+    nbr_renders = 0
+    test_menu(keys: [Curses::KEY_DOWN, Curses::KEY_UP, CursesMenu::KEY_ENTER, Curses::KEY_DOWN, Curses::KEY_UP]) do |menu|
+      menu.item 'Menu item Refresh' do
+        :menu_refresh
+      end
+      menu.item(proc do
+        nbr_renders += 1
+        'Menu item Lazy'
+      end)
+    end
+    expect(nbr_renders).to eq 2
+  end
+
+  it 'does not refresh lazy rendered titles when executing actions' do
+    nbr_renders = 0
+    test_menu(keys: [Curses::KEY_DOWN, Curses::KEY_UP, CursesMenu::KEY_ENTER, Curses::KEY_DOWN, Curses::KEY_UP]) do |menu|
+      menu.item 'Menu item' do
+        # Do nothing
+      end
+      menu.item(proc do
+        nbr_renders += 1
+        'Menu item Lazy'
+      end)
+    end
+    expect(nbr_renders).to eq 1
+  end
+
+  it 'does not refresh lazy rendered titles when getting into sub-menus' do
+    nbr_renders = 0
+    test_menu(
+      keys: [
+        # Enter sub-menu
+        CursesMenu::KEY_ENTER,
+        Curses::KEY_DOWN,
+        # Back to first menu
+        CursesMenu::KEY_ESCAPE,
+        Curses::KEY_DOWN
+      ]
+    ) do |menu, key_presses|
+      menu.item 'Sub-menu' do
+        described_class.new('Sub-menu title', key_presses: key_presses) do |sub_menu|
+          sub_menu.item 'Sub-menu item 1'
+          sub_menu.item 'Sub-menu item 2'
+        end
+      end
+      menu.item(proc do
+        nbr_renders += 1
+        'Menu item Lazy'
+      end)
+    end
+    expect(nbr_renders).to eq 1
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: curses_menu
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Muriel Salvan
@@ -93,6 +93,7 @@ extra_rdoc_files:
 - examples/automatic_key_presses.rb
 - examples/formatting.rb
 - examples/hello.rb
+- examples/lazy_menu_items.rb
 - examples/refresh.rb
 - examples/scrolling.rb
 - examples/several_items.rb
@@ -106,6 +107,7 @@ files:
 - examples/automatic_key_presses.rb
 - examples/formatting.rb
 - examples/hello.rb
+- examples/lazy_menu_items.rb
 - examples/refresh.rb
 - examples/scrolling.rb
 - examples/several_items.rb
@@ -117,6 +119,7 @@ files:
 - spec/curses_menu_test.rb
 - spec/curses_menu_test/actions_spec.rb
 - spec/curses_menu_test/formatting_spec.rb
+- spec/curses_menu_test/lazy_spec.rb
 - spec/curses_menu_test/rubocop_spec.rb
 - spec/curses_menu_test/scrolling_spec.rb
 - spec/curses_menu_test/simple_navigation_spec.rb