curses_menu 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d07858a5e2aad9b9633584a1e0b2c06b9a13ad5b69752ef7b4808ed614e7a889
-  data.tar.gz: 65f6f0b04deea7b529d136fe6fa3fea72fcfc98cfc0fc8d651863814a4bde162
+  metadata.gz: 8dc4a9d14a6f315f6e2fba464d40d58d7a17922ee9afe1aabc1c045a4731a561
+  data.tar.gz: fde73b88bf3972e2b4353911dea6278cd606a2a8e673feeab8dff41a87a0f3e8
 SHA512:
-  metadata.gz: f322978d91a509bf1696d1da056f65a7dc097bf65e61ebf46194c1bc555dad59caadadd8cca9f2c5b8bf4aea87a0d086a22555b8084e06c6a15c56c5a9ccd3f3
-  data.tar.gz: 744ed073c7e764068f3b97a528255371b70dedd99c1d164e4cc2f8981069dfd8e1ec5c606df74f3b4df00c232d3995cd31037c53401fc7bc092b1e6313da596a
+  metadata.gz: 6f9e782b2d1264e4b8b2e3b5f721574ba62abb20935a6d61fe6a70647d73386da9fc6c429689f35de3463f2d6aa6ce5d799fe8d17793b05a5621a27128bb3456
+  data.tar.gz: c39295fce31482e5f3dd91f2a0de36658912c4fd0d6da3d7a18d0ae55671b74dd5d13e6b74037c96b57993716776697f3b5cb01e5da484b660dc459cd2fe9d1a

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [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
+
+* [Bump versions](https://github.com/Muriel-Salvan/curses_menu/commit/ec272ce612c45a127f90613f3133e0186eab8e22)
+
 # [v0.0.5](https://github.com/Muriel-Salvan/curses_menu/compare/v0.0.4...v0.0.5) (2021-08-18 11:48:24)
 
 ### 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.5'
+  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,
@@ -74,7 +76,7 @@ class CursesMenu
         }
         if current_items[selected_idx][:actions]
           display_actions.merge!(
-            current_items[selected_idx][:actions].map do |action_shortcut, action_info|
+            current_items[selected_idx][:actions].to_h do |action_shortcut, action_info|
               [
                 case action_shortcut
                 when KEY_ENTER
@@ -84,7 +86,7 @@ class CursesMenu
                 end,
                 action_info[:name]
               ]
-            end.to_h
+            end
           )
         end
         print(
@@ -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/actions_spec.rb

@@ -7,7 +7,7 @@ describe CursesMenu do
         actioned = true
       end
     end
-    expect(actioned).to eq(true)
+    expect(actioned).to be(true)
   end
 
   it 'actions the default selection when pressed enter on the correct item' do
@@ -115,7 +115,7 @@ describe CursesMenu do
         :menu_exit
       end
     end
-    expect(quit).to eq(true)
+    expect(quit).to be(true)
   end
 
   it 'navigates in sub-menus' do

data/spec/curses_menu_test/formatting_spec.rb

@@ -15,9 +15,7 @@ describe CursesMenu do
     # This test is pending a better support for UTF-8.
     # cf https://github.com/ruby/curses/issues/65
     # TODO: Uncomment when Ruby curses will be fixed.
-    # rubocop:disable Style/AsciiComments
     # assert_line 3, 'Simple string - 単純な文字列'
-    # rubocop:enable Style/AsciiComments
     assert_line 3, /^Simple string - .+$/
   end
 
@@ -245,7 +243,7 @@ describe CursesMenu do
 
   it 'does not exceed line when several cells are too long' do
     nbr_visible_chars = Curses.stdscr.maxx
-    nbr_chars_per_cell = nbr_visible_chars / 3 + 1
+    nbr_chars_per_cell = (nbr_visible_chars / 3) + 1
     test_menu do |menu|
       menu.item CursesMenu::CursesRow.new(
         {
@@ -257,13 +255,13 @@ describe CursesMenu do
       )
       menu.item 'Menu item 2'
     end
-    assert_line 3, "#{'1' * nbr_chars_per_cell} #{'2' * nbr_chars_per_cell} #{'3' * (nbr_visible_chars - 2 * nbr_chars_per_cell - 3)}"
+    assert_line 3, "#{'1' * nbr_chars_per_cell} #{'2' * nbr_chars_per_cell} #{'3' * (nbr_visible_chars - (2 * nbr_chars_per_cell) - 3)}"
     assert_line 4, 'Menu item 2'
   end
 
   it 'does not exceed line when several cells are too long due to separators' do
     nbr_visible_chars = Curses.stdscr.maxx
-    nbr_chars_per_cell = nbr_visible_chars / 3 + 1
+    nbr_chars_per_cell = (nbr_visible_chars / 3) + 1
     test_menu do |menu|
       menu.item CursesMenu::CursesRow.new(
         {
@@ -274,7 +272,7 @@ describe CursesMenu do
       )
       menu.item 'Menu item 2'
     end
-    assert_line 3, "#{'1' * nbr_chars_per_cell}#{'2' * nbr_chars_per_cell}#{'3' * (nbr_visible_chars - 2 * nbr_chars_per_cell - 1)}"
+    assert_line 3, "#{'1' * nbr_chars_per_cell}#{'2' * nbr_chars_per_cell}#{'3' * (nbr_visible_chars - (2 * nbr_chars_per_cell) - 1)}"
     assert_line 4, 'Menu item 2'
   end
 

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

data/spec/curses_menu_test/scrolling_spec.rb

@@ -45,7 +45,7 @@ describe CursesMenu do
       end
     end
     assert_line 3, "Menu item #{nbr_visible_items - 2}"
-    assert_line(-3, "Menu item #{2 * nbr_visible_items - 3}")
+    assert_line(-3, "Menu item #{(2 * nbr_visible_items) - 3}")
   end
 
   it 'scrolls by using page down key' do
@@ -56,7 +56,7 @@ describe CursesMenu do
       end
     end
     assert_line 3, "Menu item #{nbr_visible_items - 1}"
-    assert_line(-3, "Menu item #{nbr_visible_items * 2 - 2}")
+    assert_line(-3, "Menu item #{(nbr_visible_items * 2) - 2}")
   end
 
   it 'scrolls by using page up key' do
@@ -78,7 +78,7 @@ describe CursesMenu do
       end
     end
     assert_line 3, "Menu item #{nbr_visible_items}"
-    assert_line(-3, "Menu item #{nbr_visible_items * 2 - 1}")
+    assert_line(-3, "Menu item #{(nbr_visible_items * 2) - 1}")
   end
 
   it 'scrolls by using home key' do

data/spec/curses_menu_test.rb

@@ -36,7 +36,7 @@ module CursesMenuTest
       window.setpos old_y, old_x
       # Build the map of colors per color pair acutally registered
       colors_left_shift = Curses::A_COLOR.to_s(2).match(/^1+(0+)$/)[1].size
-      color_pairs = CursesMenu.constants.select { |const| const.to_s.start_with?('COLORS_') }.map do |const|
+      color_pairs = CursesMenu.constants.select { |const| const.to_s.start_with?('COLORS_') }.to_h do |const|
         color_pair = CursesMenu.const_get(const)
         [
           # On Windows using Curses.color_pair can result in bugs [BUG] Unnormalized Fixnum value when using/displaying the value.
@@ -46,7 +46,7 @@ module CursesMenuTest
           color_pair << colors_left_shift,
           const
         ]
-      end.to_h
+      end
       chars.
         map do |chr|
           {
@@ -57,7 +57,7 @@ module CursesMenuTest
               # In this case we just force an ASCII version of it.
               (chr & 255).chr(Encoding::UTF_8)
             end,
-            color: color_pairs[chr & Curses::A_COLOR] || chr & Curses::A_COLOR,
+            color: color_pairs[chr & Curses::A_COLOR] || (chr & Curses::A_COLOR),
             attributes: chr & Curses::A_ATTRIBUTES
           }
         end.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: curses_menu
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-18 00:00:00.000000000 Z
+date: 2022-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curses
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: sem_ver_components
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '1.36'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '1.36'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.13'
 description: 
 email:
 - muriel@x-aeon.com
@@ -87,17 +87,18 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - CHANGELOG.md
-- README.md
 - LICENSE.md
-- examples/utf_8.rb
-- examples/hello.rb
-- examples/sub_menus.rb
+- README.md
+- examples/actions.rb
 - examples/automatic_key_presses.rb
-- examples/refresh.rb
 - examples/formatting.rb
-- examples/several_items.rb
-- examples/actions.rb
+- examples/hello.rb
+- examples/lazy_menu_items.rb
+- examples/refresh.rb
 - examples/scrolling.rb
+- examples/several_items.rb
+- examples/sub_menus.rb
+- examples/utf_8.rb
 files:
 - CHANGELOG.md
 - LICENSE.md
@@ -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
@@ -126,6 +129,7 @@ licenses:
 - BSD-3-Clause
 metadata:
   homepage_uri: https://github.com/Muriel-Salvan/curses_menu
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -141,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Simple menu offering choices with navigation keys using curses