curses_menu 0.0.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74becd64c41df7dc7628e8c2b2c416c56f430c53d9be7e3e68698bb6bc1633aa
-  data.tar.gz: 02bf486f61ae412243d536912202a36eb03d72d6c3c0e4ff034808221193d3f5
+  metadata.gz: '093b7bafe2adec885ebb1cd49607556b54a1925f416597d1ab220519ec6009f8'
+  data.tar.gz: f0a6110f5e1ae34026c3d6982a5f2e8c8f402849bd0a7805ed43f90a8b398cad
 SHA512:
-  metadata.gz: d7014fece6ecf47e9f0dba36ee8b835841b8176809a09f52bf16e87892719075da8847427a62b2558068bb15abd6cb12cab0f49b4456693c417740c0d306f77d
-  data.tar.gz: c407a1d42c57f39fa7c32488191097186c574fca00bd043e664b7cce45f0fba946d227712f9754025b0c9c72fac342cd721e3429cd2d4427b3d2bc4bfdc6dac6
+  metadata.gz: 6b8d1c93130d98de349183ffd888f21de3ea0023e0cd7372817dc7efa0606974c442b0c1bd1d10f946395deb62cac089a332a0fc7f35c13a662c6452147b736e
+  data.tar.gz: 15f764995f0baa99dca4da1e73a67c2079c4956f237f3975c3086f6f9678c212f10e6c40e8ae0d3d90ab4375463114c917708fd44ed1a058fe71239a61390254

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [v0.2.0](https://github.com/Muriel-Salvan/curses_menu/compare/v0.1.0...v0.2.0) (2022-11-01 21:07:07)
+
+### Features
+
+* [[feature] [#6] Add lazy evaluation for actions](https://github.com/Muriel-Salvan/curses_menu/commit/0a5a96ae84fecdf982f763b833e8e863231dde73)
+
+# [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,25 @@
+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 "[Rendered at #{Time.now}] - I am a normal item"
+    menu.item(proc do
+      "[Rendered at #{Time.now}] - I am a lazy item"
+    end)
+    menu.item(
+      "[Rendered at #{Time.now}] - I am a normal item with lazy rendered action",
+      actions: proc do
+        {
+          'a' => {
+            name: "Action rendered at #{Time.now}",
+            execute: proc {}
+          }
+        }
+      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.2.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,
@@ -72,9 +74,11 @@ class CursesMenu
           'Arrows/Home/End' => 'Navigate',
           'Esc' => 'Exit'
         }
-        if current_items[selected_idx][:actions]
+        # Keep a cache of actions as they can be loaded in a lazy way for performance
+        current_items[selected_idx][:actions_cached] = current_items[selected_idx][:actions].is_a?(Proc) ? current_items[selected_idx][:actions].call : current_items[selected_idx][:actions] unless current_items[selected_idx].key?(:actions_cached)
+        if current_items[selected_idx][:actions_cached]
           display_actions.merge!(
-            current_items[selected_idx][:actions].to_h do |action_shortcut, action_info|
+            current_items[selected_idx][:actions_cached].to_h do |action_shortcut, action_info|
               [
                 case action_shortcut
                 when KEY_ENTER
@@ -125,9 +129,11 @@ class CursesMenu
           break
         else
           # Check actions
-          if current_items[selected_idx][:actions]&.key?(user_choice)
+          # Keep a cache of actions as they can be loaded in a lazy way for performance
+          current_items[selected_idx][:actions_cached] = current_items[selected_idx][:actions].is_a?(Proc) ? current_items[selected_idx][:actions].call : current_items[selected_idx][:actions] unless current_items[selected_idx].key?(:actions_cached)
+          if current_items[selected_idx][:actions_cached]&.key?(user_choice)
             curses_menu_finalize
-            result = current_items[selected_idx][:actions][user_choice][:execute].call
+            result = current_items[selected_idx][:actions_cached][user_choice][:execute].call
             if result.is_a?(Symbol)
               case result
               when :menu_exit
@@ -159,10 +165,11 @@ 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
-  # * *actions* (Hash<Object, Hash<Symbol,Object> >): Associated actions to this item, per shortcut [default: {}]
+  # * *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> > or Proc): Associated actions to this item, per shortcut, or Proc returning those actions when needed (lazy loading) [default: {}]
   #   * *name* (String): Name of this action (displayed at the bottom of the menu)
   #   * *execute* (Proc): Code called when this action is selected
+  #   In case of lazy loading (with a Proc), the title Proc will always be called first.
   # * *&action* (Proc): Code called if the item is selected (action for the enter key) [optional].
   #   * Result::
   #     * Symbol or Object: If the code returns a symbol, the menu will behave in a specific way:
@@ -170,8 +177,21 @@ class CursesMenu
   #       * *menu_refresh*: The menu will compute again its items.
   def item(title, actions: {}, &action)
     menu_item_def = { title: title }
-    all_actions = action.nil? ? actions : actions.merge(KEY_ENTER => { name: 'Select', execute: action })
-    menu_item_def[:actions] = all_actions unless all_actions.empty?
+    all_actions =
+      if action.nil?
+        actions
+      else
+        mapped_default_action = { KEY_ENTER => { name: 'Select', execute: action } }
+        if actions.is_a?(Proc)
+          # Make sure we keep the lazyness
+          proc do
+            actions.call.merge(mapped_default_action)
+          end
+        else
+          actions.merge(mapped_default_action)
+        end
+      end
+    menu_item_def[:actions] = all_actions if all_actions.is_a?(Proc) || !all_actions.empty?
     @current_menu_items << menu_item_def
   end
 

data/spec/curses_menu_test/lazy_spec.rb

@@ -0,0 +1,383 @@
+describe CursesMenu do
+
+  it 'displays a menu with 1 item with lazy rendering' do
+    render_called = false
+    test_menu 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 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 'displays menu actions with lazy evaluation' do
+    render_called = false
+    action_executed = false
+    test_menu(keys: ['a']) do |menu|
+      menu.item('Menu item lazy', actions: proc do
+        render_called = true
+        {
+          'a' => {
+            name: 'Lazy action',
+            execute: proc do
+              action_executed = true
+            end
+          }
+        }
+      end)
+    end
+    assert_line 3, 'Menu item lazy'
+    assert_line(-1, '= Arrows/Home/End: Navigate | Esc: Exit | a: Lazy action')
+    expect(render_called).to be true
+    expect(action_executed).to be true
+  end
+
+  it 'displays menu actions with lazy evaluation and a default action' do
+    render_called = false
+    action_executed = false
+    default_executed = false
+    test_menu(keys: ['a', CursesMenu::KEY_ENTER]) do |menu|
+      menu.item(
+        'Menu item lazy',
+        actions: proc do
+          render_called = true
+          {
+            'a' => {
+              name: 'Lazy action',
+              execute: proc do
+                action_executed = true
+              end
+            }
+          }
+        end
+      ) do
+        default_executed = true
+      end
+    end
+    assert_line 3, 'Menu item lazy'
+    assert_line(-1, '= Arrows/Home/End: Navigate | Enter: Select | Esc: Exit | a: Lazy action')
+    expect(render_called).to be true
+    expect(action_executed).to be true
+    expect(default_executed).to be true
+  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 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 'doesn\'t lazy evaluate actions when the item is not displayed' do
+    nbr_visible_items = Curses.stdscr.maxy - 5
+    render_called = false
+    test_menu do |menu|
+      (nbr_visible_items * 2).times do |idx|
+        menu.item "Menu item #{idx}"
+      end
+      menu.item('Menu item lazy', actions: proc do
+        render_called = true
+        {
+          'a' => {
+            name: 'Lazy action',
+            execute: proc {}
+          }
+        }
+      end)
+    end
+    expect(render_called).to be false
+  end
+
+  it 'doesn\'t lazy evaluate actions when the item is not selected' do
+    render_called = false
+    test_menu do |menu|
+      menu.item 'Menu item'
+      menu.item('Menu item lazy', actions: proc do
+        render_called = true
+        {
+          'a' => {
+            name: 'Lazy action',
+            execute: proc {}
+          }
+        }
+      end)
+    end
+    expect(render_called).to be false
+  end
+
+  it 'lazy evaluates actions as soon as the item is selected' do
+    render_called = false
+    test_menu(keys: [Curses::KEY_DOWN]) do |menu|
+      menu.item 'Menu item'
+      menu.item('Menu item lazy', actions: proc do
+        render_called = true
+        {
+          'a' => {
+            name: 'Lazy action',
+            execute: proc {}
+          }
+        }
+      end)
+    end
+    expect(render_called).to be true
+  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 evaluated actions 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('Menu item 2 lazy', actions: proc do
+        nbr_renders += 1
+        {
+          'a' => {
+            name: 'Lazy action',
+            execute: proc {}
+          }
+        }
+      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 'keeps lazy evaluated actions 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('Menu item lazy', actions: proc do
+        nbr_renders += 1
+        {
+          'a' => {
+            name: 'Lazy action',
+            execute: proc {}
+          }
+        }
+      end)
+    end
+    expect(nbr_renders).to eq 1
+    assert_line(-1, '= Arrows/Home/End: Navigate | Esc: Exit | a: Lazy action')
+  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 'refreshes lazy evaluated actions 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('Menu item lazy', actions: proc do
+        nbr_renders += 1
+        {
+          'a' => {
+            name: 'Lazy action',
+            execute: proc {}
+          }
+        }
+      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 evaluated actions 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('Menu item lazy', actions: proc do
+        nbr_renders += 1
+        {
+          'a' => {
+            name: 'Lazy action',
+            execute: proc {}
+          }
+        }
+      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
+
+  it 'does not refresh lazy evaluated actions 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('Menu item lazy', actions: proc do
+        nbr_renders += 1
+        {
+          'a' => {
+            name: 'Lazy action',
+            execute: proc {}
+          }
+        }
+      end)
+    end
+    expect(nbr_renders).to eq 1
+  end
+
+  it 'always lazy renders titles before lazy evaluating actions' do
+    lazy_renders = []
+    nbr_visible_items = Curses.stdscr.maxy - 5
+    test_menu(keys: [Curses::KEY_END, Curses::KEY_HOME, Curses::KEY_DOWN]) do |menu|
+      menu.item(
+        proc do
+          lazy_renders << :item_1_title
+          'Menu item 1 lazy'
+        end,
+        actions: proc do
+          lazy_renders << :item_1_action
+          { 'a' => { name: 'Lazy action 1', execute: proc {} } }
+        end
+      )
+      menu.item(
+        proc do
+          lazy_renders << :item_2_title
+          'Menu item 2 lazy'
+        end,
+        actions: proc do
+          lazy_renders << :item_2_action
+          { 'a' => { name: 'Lazy action 2', execute: proc {} } }
+        end
+      )
+      (nbr_visible_items * 2).times do |idx|
+        menu.item "Menu item #{idx}"
+      end
+      menu.item(
+        proc do
+          lazy_renders << :item_3_title
+          'Menu item 3 lazy'
+        end,
+        actions: proc do
+          lazy_renders << :item_3_action
+          { 'a' => { name: 'Lazy action 3', execute: proc {} } }
+        end
+      )
+    end
+    expect(lazy_renders).to eq %i[item_1_title item_2_title item_1_action item_3_title item_3_action item_2_action]
+  end
+
+end

data/spec/curses_menu_test/simple_navigation_spec.rb

@@ -9,6 +9,16 @@ describe CursesMenu do
     assert_line(-1, '= Arrows/Home/End: Navigate | Esc: Exit')
   end
 
+  it 'displays a menu with 1 item having a default action' do
+    test_menu(title: 'Menu title') do |menu|
+      menu.item 'Menu item' do
+        # Do nothing
+      end
+    end
+    assert_line 3, 'Menu item'
+    assert_line(-1, '= Arrows/Home/End: Navigate | Enter: Select | Esc: Exit')
+  end
+
   it 'displays a menu with several items' do
     test_menu do |menu|
       menu.item 'Menu item 1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: curses_menu
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-12 00:00:00.000000000 Z
+date: 2022-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curses
@@ -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