curses_menu 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 607c643000199bc2b3ef7cf3b2cd16346bcb8f1c4035eb30c2d033bac0df1626
-  data.tar.gz: e71f143c744eff5b971c2821ee1538990fc9906baf5596fec4622294f4ffc4e4
+  metadata.gz: db0a039d187afe66e4986489a45193a3ca76bb5e748a14f9cf0e22f08a5b7065
+  data.tar.gz: 6e0fc6819a62ff3e1da4060fa9f9891088624c1098d91cf066b701b6fe7e3cda
 SHA512:
-  metadata.gz: 66129319cbf7647404eb77ef0d1f8ef095bbd1e5cf3b61561a23bd5d7e7f675e4d7a62721baa377d228b7bea2b280423603f0a7280cf40ab3389d70174c1154f
-  data.tar.gz: bf877618677e1ca577f6e1899f85800f12b91c40a0c620deb9d07b52fa1b6ec1d28ed2a5c3cdb709c76daee35476644ead429b8e5a7e04573c32c0dc98e06a83
+  metadata.gz: 5786992710dfcd47c11d223884c0b4ecef021d28470386c1427e8666e3a62be675ac885f19e69f41d8529a3b9886a48b28b9096079f3b8182255fcf56a2ff6b8
+  data.tar.gz: 6b210504415fe9c5e1d6956eb7024e03b982a5bcf1de034efc96c4ebae47ff0993dddec75e1cec0b52b6bb8a4dd4f6a48c0cfabd1a82d4d917b297cd2fe86f77

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# [v0.0.3](https://github.com/Muriel-Salvan/curses_menu/compare/v0.0.2...v0.0.3) (2021-08-15 16:16:16)
+
+### Patches
+
+* [Add the spec direcotry in the gem as it contains files that can be useful to users](https://github.com/Muriel-Salvan/curses_menu/commit/aeb73ea4507029be97dba2d8243fa3e33ac151ba)
+
+# [v0.0.2](https://github.com/Muriel-Salvan/curses_menu/compare/v0.0.1...v0.0.2) (2021-08-15 15:24:19)
+
+### Patches
+
+* [Added colors testing + Proper CI/CD + Ruby 3 compatibility](https://github.com/Muriel-Salvan/curses_menu/commit/035b19fc27a61c9d10c6b5517993dd0f54537eec)
+* [Add white colors](https://github.com/Muriel-Salvan/curses_menu/commit/5adf552c01f7a254621e53ecd45e04e9c2358bb8)
+
+# 0.0.1
+
+* Initial version

data/LICENSE.md

@@ -0,0 +1,31 @@
+
+The license stated herein is a copy of the BSD License (modified on July 1999).
+The AUTHOR mentionned below refers to the list of people involved in the
+creation and modification of any file included in the delivered package.
+This list is found in the file named AUTHORS.
+The AUTHORS and LICENSE files have to be included in any release of software
+embedding source code of this package, or using it as a derivative software.
+
+Copyright (c) 2019 - 2019 Muriel Salvan (muriel@x-aeon.com)
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+   2. Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+   3. The name of the author may not be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
+OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,78 @@
+# curses_menu
+
+Ruby API to create terminal-based menus, using [curses][link-curses].
+
+* Easy navigation using arrows, page up/down, home, end, enter and escape keys.
+* Several actions per menu item.
+* Scrolling support.
+* Extensive formatting options with colors, alignments, decorations...
+* Easy support for sub-menus.
+* Automatic key presses for autmating tasks in the menu.
+* Ruby-like API.
+
+## Install
+
+Via gem
+
+``` bash
+$ gem install curses_menu
+```
+
+Via a Gemfile
+
+``` ruby
+$ gem 'curses_menu'
+```
+
+## Usage
+
+``` ruby
+require 'curses_menu'
+
+CursesMenu.new 'My awesome new menu!' do |menu|
+  menu.item 'How\'s life?' do
+    puts 'Couldn\'t be easier'
+    :menu_exit
+  end
+end
+```
+
+Check the [examples][link-examples] folder for more examples.
+
+## Change log
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+## Testing
+
+Automated tests are done using rspec.
+
+Do execute them, first install development dependencies:
+
+```bash
+bundle install
+```
+
+Then execute rspec
+
+```bash
+bundle exec rspec
+```
+
+## Contributing
+
+Any contribution is welcome:
+* Fork the github project and create pull requests.
+* Report bugs by creating tickets.
+* Suggest improvements and new features by creating tickets.
+
+## Credits
+
+- [Muriel Salvan][link-author]
+
+## License
+
+The BSD License. Please see [License File](LICENSE.md) for more information.
+
+[link-curses]: https://rubygems.org/gems/curses/versions/1.2.4
+[link-examples]: ./examples

data/lib/curses_menu/version.rb

@@ -1,5 +1,5 @@
 class CursesMenu
 
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 
 end

data/spec/curses_menu_test.rb

@@ -0,0 +1,121 @@
+require 'curses_menu'
+
+module CursesMenuTest
+
+  # Monkey-patch the curses_menu_finalize method so that it captures the menu screen before finalizing
+  module CursesMenuPatch
+
+    # Last screenshot taken
+    # Array<String>: List of lines
+    attr_reader :screenshot
+
+    # Finalize the curses menu window
+    def curses_menu_finalize
+      @screenshot = capture_screenshot
+      super
+    end
+
+    private
+
+    # Get a screenshot of the menu
+    #
+    # Result::
+    # * Array<String>: List of lines
+    def capture_screenshot
+      # Curses is initialized
+      window = Curses.stdscr
+      old_x = window.curx
+      old_y = window.cury
+      chars = []
+      window.maxy.times do |idx_y|
+        window.maxx.times do |idx_x|
+          window.setpos idx_y, idx_x
+          chars << window.inch
+        end
+      end
+      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_pair = CursesMenu.const_get(const)
+        [
+          # On Windows using Curses.color_pair can result in bugs [BUG] Unnormalized Fixnum value when using/displaying the value.
+          # So for now we depend on the internal algorithm used by color_pair (which is a left shift of the 0 bits of A_COLOR mask)
+          # TODO: Uncomment the following when curses will be fixed on Windows
+          # Curses.color_pair(color_pair),
+          color_pair << colors_left_shift,
+          const
+        ]
+      end.to_h
+      chars.
+        map do |chr|
+          {
+            char: (chr & Curses::A_CHARTEXT).chr,
+            color: color_pairs[chr & Curses::A_COLOR] || chr & Curses::A_COLOR,
+            attributes: chr & Curses::A_ATTRIBUTES
+          }
+        end.
+        each_slice(window.maxx).
+        to_a
+    end
+
+  end
+
+  # Helpers for the tests
+  module Helpers
+
+    # Test a given menu, and prepare a screenshot to be analyzed
+    #
+    # Parameters::
+    # * *title* (String): The title [default: 'Menu title']
+    # * *keys* (Array<Object> or nil): Keys to automatically press [default: []]
+    # * *auto_exit* (Boolean): Do we automatically add the escape key to the key presses? [default: true]
+    # * Proc: The code called with the test menu to be populated
+    #   * Parameters::
+    #     * *menu* (CursesMenu): Curses menu to populate
+    #     * *key_presses* (Array<Object>): Keys to possibly give to sub-menus
+    def test_menu(title: 'Menu title', keys: [], auto_exit: true)
+      # TODO: Find a way to not depend on the current terminal screen, and run the tests silently.
+      key_presses = auto_exit ? keys + [CursesMenu::KEY_ESCAPE] : keys
+      menu = CursesMenu.new(title, key_presses: key_presses) do |m|
+        yield m, key_presses
+      end
+      @screenshot = menu.screenshot
+    end
+
+    # Assert that a line of the screenshot starts with a given content
+    #
+    # Parameters::
+    # * *line_idx* (Integer): The line index of the screenshot
+    # * *expectation* (String): The expected line
+    def assert_line(line_idx, expectation)
+      line = @screenshot[line_idx][0..expectation.size].map { |char_info| char_info[:char] }.join
+      # Add an ending space to make sure the line does not continue after what we test
+      expect(line).to eq("#{expectation} "), "Screenshot line #{line_idx} differs:\n  \"#{line}\" should be\n  \"#{expectation} \""
+    end
+
+    # Assert that a line of the screenshot starts with a given content, using colors information
+    #
+    # Parameters::
+    # * *line_idx* (Integer): The line index of the screenshot
+    # * *expectation* (String): The expected line
+    # * *color* (Symbol): The expected color pair name
+    def assert_colored_line(line_idx, expectation, color)
+      colored_line = @screenshot[line_idx][0..expectation.size - 1].map do |char_info|
+        [char_info[:char], char_info[:color]]
+      end
+      expected_colored_line = expectation.each_char.map do |chr|
+        [chr, color]
+      end
+      expect(colored_line).to eq(expected_colored_line), "Screenshot line #{line_idx} differs:\n  \"#{colored_line}\" should be\n  \"#{expected_colored_line}\""
+    end
+
+  end
+
+end
+
+class CursesMenu
+
+  prepend CursesMenuTest::CursesMenuPatch
+
+end

data/spec/curses_menu_test/actions_spec.rb

@@ -0,0 +1,221 @@
+describe CursesMenu do
+
+  it 'actions the default selection when pressed enter' do
+    actioned = false
+    test_menu(keys: [CursesMenu::KEY_ENTER]) do |menu|
+      menu.item 'Menu item' do
+        actioned = true
+      end
+    end
+    expect(actioned).to eq(true)
+  end
+
+  it 'actions the default selection when pressed enter on the correct item' do
+    action = nil
+    test_menu(keys: [Curses::KEY_DOWN, Curses::KEY_DOWN, CursesMenu::KEY_ENTER]) do |menu|
+      menu.item 'Menu item 1' do
+        action = 1
+      end
+      menu.item 'Menu item 2' do
+        action = 2
+      end
+      menu.item 'Menu item 3' do
+        action = 3
+      end
+      menu.item 'Menu item 4' do
+        action = 4
+      end
+    end
+    expect(action).to eq(3)
+  end
+
+  it 'actions other actions' do
+    action = nil
+    test_menu(keys: ['a']) do |menu|
+      menu.item 'Menu item', actions: {
+        'a' => {
+          name: 'Action A',
+          execute: proc { action = 'a' }
+        },
+        'b' => {
+          name: 'Action B',
+          execute: proc { action = 'b' }
+        }
+      }
+    end
+    expect(action).to eq('a')
+  end
+
+  it 'actions several actions' do
+    actions = []
+    test_menu(keys: %w[a b a]) do |menu|
+      menu.item 'Menu item', actions: {
+        'a' => {
+          name: 'Action A',
+          execute: proc { actions << 'a' }
+        },
+        'b' => {
+          name: 'Action B',
+          execute: proc { actions << 'b' }
+        }
+      }
+    end
+    expect(actions).to eq(%w[a b a])
+  end
+
+  it 'actions several actions including the default one' do
+    actions = []
+    test_menu(keys: ['a', 'b', CursesMenu::KEY_ENTER, 'a']) do |menu|
+      menu.item(
+        'Menu item',
+        actions: {
+          'a' => {
+            name: 'Action A',
+            execute: proc { actions << 'a' }
+          },
+          'b' => {
+            name: 'Action B',
+            execute: proc { actions << 'b' }
+          }
+        }
+      ) do
+        actions << 'ENTER'
+      end
+    end
+    expect(actions).to eq(%w[a b ENTER a])
+  end
+
+  it 'actions nothing if action does not exist' do
+    actions = []
+    test_menu(keys: %w[a b c a]) do |menu|
+      menu.item(
+        'Menu item',
+        actions: {
+          'a' => {
+            name: 'Action A',
+            execute: proc { actions << 'a' }
+          },
+          'b' => {
+            name: 'Action B',
+            execute: proc { actions << 'b' }
+          }
+        }
+      ) do
+        actions << 'ENTER'
+      end
+    end
+    expect(actions).to eq(%w[a b a])
+  end
+
+  it 'exits when action returns :menu_exit' do
+    quit = false
+    test_menu(keys: [CursesMenu::KEY_ENTER], auto_exit: false) do |menu|
+      menu.item 'Menu item quit' do
+        quit = true
+        :menu_exit
+      end
+    end
+    expect(quit).to eq(true)
+  end
+
+  it 'navigates in sub-menus' do
+    actions = []
+    test_menu(
+      keys: [
+        # Enter sub-menu 1
+        CursesMenu::KEY_ENTER,
+        # Action sub-menu second item
+        Curses::KEY_DOWN,
+        CursesMenu::KEY_ENTER,
+        # Back to first menu
+        CursesMenu::KEY_ESCAPE,
+        # Enter sub-menu 2
+        Curses::KEY_DOWN,
+        CursesMenu::KEY_ENTER,
+        # Action sub-menu item
+        CursesMenu::KEY_ENTER,
+        # Exit sub-menu
+        Curses::KEY_DOWN,
+        CursesMenu::KEY_ENTER
+      ]
+    ) do |menu, key_presses|
+      menu.item 'Sub-menu 1' do
+        described_class.new('Sub-menu 1 title', key_presses: key_presses) do |sub_menu|
+          sub_menu.item 'Sub-menu item 1'
+          sub_menu.item 'Sub-menu item 2' do
+            actions << 'a'
+          end
+        end
+      end
+      menu.item 'Sub-menu 2' do
+        described_class.new('Sub-menu 2 title', key_presses: key_presses) do |sub_menu|
+          sub_menu.item 'Sub-menu item 1' do
+            actions << 'b'
+          end
+          sub_menu.item 'Sub-menu item 2' do
+            :menu_exit
+          end
+        end
+      end
+    end
+    expect(actions).to eq(%w[a b])
+  end
+
+  it 'exits only the sub-menu when action returns :menu_exit in a sub-menu' do
+    actions = []
+    test_menu(keys: [CursesMenu::KEY_ENTER, CursesMenu::KEY_ENTER, Curses::KEY_DOWN, CursesMenu::KEY_ENTER]) 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 quit' do
+            actions << 'a'
+            :menu_exit
+          end
+        end
+      end
+      menu.item 'Menu item 2' do
+        actions << 'b'
+      end
+    end
+    expect(actions).to eq(%w[a b])
+  end
+
+  it 'exits only the sub-menu when Escape key is used' do
+    actions = []
+    test_menu(keys: [CursesMenu::KEY_ENTER, CursesMenu::KEY_ESCAPE, Curses::KEY_DOWN, CursesMenu::KEY_ENTER]) 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 quit' do
+            actions << 'a'
+            :menu_exit
+          end
+        end
+      end
+      menu.item 'Menu item 2' do
+        actions << 'b'
+      end
+    end
+    expect(actions).to eq(%w[b])
+  end
+
+  it 'does not refresh menu items normally' do
+    idx = 0
+    test_menu(keys: [CursesMenu::KEY_ENTER, CursesMenu::KEY_ENTER]) do |menu|
+      menu.item "Menu item #{idx}" do
+        idx += 1
+      end
+    end
+    assert_line 3, 'Menu item 0'
+  end
+
+  it 'refreshes menu items when action returns :menu_refresh' do
+    idx = 0
+    test_menu(keys: [CursesMenu::KEY_ENTER, CursesMenu::KEY_ENTER]) do |menu|
+      menu.item "Menu item #{idx}" do
+        idx += 1
+        :menu_refresh
+      end
+    end
+    assert_line 3, 'Menu item 2'
+  end
+
+end

data/spec/curses_menu_test/formatting_spec.rb

@@ -0,0 +1,397 @@
+describe CursesMenu do
+
+  it 'displays a single string' do
+    test_menu do |menu|
+      menu.item 'Simple string'
+    end
+    assert_line 3, 'Simple string'
+  end
+
+  it 'displays a single string in a CursesRow' do
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new({ cell: { text: 'Simple string' } })
+    end
+    assert_line 3, 'Simple string'
+  end
+
+  it 'displays a different color' do
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell: {
+            text: 'Selected colored string',
+            color_pair: CursesMenu::COLORS_GREEN
+          }
+        }
+      )
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell: {
+            text: 'Non-selected colored string',
+            color_pair: CursesMenu::COLORS_GREEN
+          }
+        }
+      )
+    end
+    assert_colored_line 3, 'Selected colored string', :COLORS_MENU_ITEM_SELECTED
+    assert_colored_line 4, 'Non-selected colored string', :COLORS_GREEN
+  end
+
+  it 'adds prefixes' do
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell: {
+            text: 'Simple string',
+            begin_with: 'PRE'
+          }
+        }
+      )
+    end
+    assert_line 3, 'PRESimple string'
+  end
+
+  it 'adds suffixes' do
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell: {
+            text: 'Simple string',
+            end_with: 'POST'
+          }
+        }
+      )
+    end
+    assert_line 3, 'Simple stringPOST'
+  end
+
+  it 'limits fixed-size strings that exceed size' do
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell: {
+            text: 'Simple string',
+            fixed_size: 5
+          }
+        }
+      )
+    end
+    assert_line 3, 'Simpl'
+  end
+
+  it 'pads fixed-size strings that do not exceed size' do
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell: {
+            text: 'Simple string',
+            fixed_size: 15,
+            pad: '*'
+          }
+        }
+      )
+    end
+    assert_line 3, 'Simple string**'
+  end
+
+  it 'pads fixed-size strings that do not exceed size with multi-chars padding' do
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell: {
+            text: 'Simple string',
+            fixed_size: 20,
+            pad: '12345'
+          }
+        }
+      )
+    end
+    assert_line 3, 'Simple string1234512'
+  end
+
+  it 'does not pad fixed-size strings that exceed size' do
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell: {
+            text: 'Simple string',
+            fixed_size: 5,
+            pad: '*'
+          }
+        }
+      )
+    end
+    assert_line 3, 'Simpl'
+  end
+
+  it 'left-justifies fixed-size strings that do not exceed size' do
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell: {
+            text: 'Simple string',
+            fixed_size: 15,
+            pad: '*',
+            justify: :left
+          }
+        }
+      )
+    end
+    assert_line 3, 'Simple string**'
+  end
+
+  it 'right-justifies fixed-size strings that do not exceed size' do
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell: {
+            text: 'Simple string',
+            fixed_size: 15,
+            pad: '*',
+            justify: :right
+          }
+        }
+      )
+    end
+    assert_line 3, '**Simple string'
+  end
+
+  it 'never truncates prefixes when size exceeds fixed size' do
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell: {
+            text: 'Simple string',
+            fixed_size: 15,
+            begin_with: 'PRE'
+          }
+        }
+      )
+    end
+    assert_line 3, 'PRESimple strin'
+  end
+
+  it 'never truncates suffixes when size exceeds fixed size' do
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell: {
+            text: 'Simple string',
+            fixed_size: 15,
+            end_with: 'POST'
+          }
+        }
+      )
+    end
+    assert_line 3, 'Simple striPOST'
+  end
+
+  it 'never truncates prefixes and suffixes when size exceeds fixed size' do
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell: {
+            text: 'Simple string',
+            fixed_size: 15,
+            begin_with: 'PRE',
+            end_with: 'POST'
+          }
+        }
+      )
+    end
+    assert_line 3, 'PRESimple sPOST'
+  end
+
+  it 'displays several cells' do
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell_1: { text: 'Cell 1' },
+          cell_2: { text: 'Cell 2' },
+          cell_3: { text: 'Cell 3' }
+        }
+      )
+    end
+    assert_line 3, 'Cell 1 Cell 2 Cell 3'
+  end
+
+  it 'displays several cells with a different separator' do
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell_1: { text: 'Cell 1' },
+          cell_2: { text: 'Cell 2' },
+          cell_3: { text: 'Cell 3' }
+        },
+        separator: 'SEP'
+      )
+    end
+    assert_line 3, 'Cell 1SEPCell 2SEPCell 3'
+  end
+
+  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
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell_1: { text: '1' * nbr_chars_per_cell },
+          cell_2: { text: '2' * nbr_chars_per_cell },
+          cell_3: { text: '3' * nbr_chars_per_cell },
+          cell_4: { text: '4' * nbr_chars_per_cell }
+        }
+      )
+      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 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
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell_1: { text: '1' * nbr_chars_per_cell },
+          cell_3: { text: '3' * nbr_chars_per_cell }
+        },
+        separator: '2' * nbr_chars_per_cell
+      )
+      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 4, 'Menu item 2'
+  end
+
+  it 'displays several cells with different properties' do
+    test_menu do |menu|
+      menu.item CursesMenu::CursesRow.new(
+        {
+          cell_1: {
+            text: 'Cell 1',
+            begin_with: 'PRE'
+          },
+          cell_2: {
+            text: 'Cell 2',
+            color_pair: CursesMenu::COLORS_GREEN,
+            end_with: 'POST'
+          },
+          cell_3: {
+            text: 'Cell 3',
+            fixed_size: 10,
+            pad: '*',
+            justify: :right
+          },
+          cell_4: {
+            text: 'Cell 4',
+            fixed_size: 2
+          },
+          cell_5: {
+            text: 'Cell 5',
+            fixed_size: 10,
+            pad: '='
+          }
+        }
+      )
+    end
+    # TODO: Find a way to test colors
+    assert_line 3, 'PRECell 1 Cell 2POST ****Cell 3 Ce Cell 5===='
+  end
+
+  it 'can reorder cells' do
+    row = CursesMenu::CursesRow.new(
+      {
+        cell_1: { text: 'Cell 1' },
+        cell_2: { text: 'Cell 2' },
+        cell_3: { text: 'Cell 3' }
+      }
+    )
+    row.cells_order(%i[cell_3 cell_2 cell_1])
+    test_menu { |menu| menu.item row }
+    assert_line 3, 'Cell 3 Cell 2 Cell 1'
+  end
+
+  it 'can reorder cells and ignore unknown ones' do
+    row = CursesMenu::CursesRow.new(
+      {
+        cell_1: { text: 'Cell 1' },
+        cell_2: { text: 'Cell 2' },
+        cell_3: { text: 'Cell 3' }
+      }
+    )
+    row.cells_order(%i[cell_4 cell_3 cell_5 cell_2 cell_1])
+    test_menu { |menu| menu.item row }
+    assert_line 3, 'Cell 3 Cell 2 Cell 1'
+  end
+
+  it 'can reorder cells and create unknown ones' do
+    row = CursesMenu::CursesRow.new(
+      {
+        cell_1: { text: 'Cell 1' },
+        cell_2: { text: 'Cell 2' },
+        cell_3: { text: 'Cell 3' }
+      }
+    )
+    row.cells_order(%i[cell_4 cell_3 cell_5 cell_2 cell_1], unknown_cells: 'Cell X')
+    test_menu { |menu| menu.item row }
+    assert_line 3, 'Cell X Cell 3 Cell X Cell 2 Cell 1'
+  end
+
+  it 'can reorder cells and create unknown ones with properties' do
+    row = CursesMenu::CursesRow.new(
+      {
+        cell_1: { text: 'Cell 1' },
+        cell_2: { text: 'Cell 2' },
+        cell_3: { text: 'Cell 3' }
+      }
+    )
+    row.cells_order(
+      %i[cell_4 cell_3 cell_5 cell_2 cell_1],
+      unknown_cells: {
+        text: 'Cell X',
+        begin_with: '{',
+        end_with: '}'
+      }
+    )
+    test_menu { |menu| menu.item row }
+    assert_line 3, '{Cell X} Cell 3 {Cell X} Cell 2 Cell 1'
+  end
+
+  it 'can change cells properties' do
+    row = CursesMenu::CursesRow.new(
+      {
+        cell_1: {
+          text: 'Cell 1',
+          begin_with: 'PRE',
+          end_with: 'POST'
+        },
+        cell_2: {
+          text: 'Cell 2'
+        },
+        cell_3: {
+          text: 'Cell 3',
+          fixed_size: 10,
+          pad: '*'
+        }
+      }
+    )
+    row.change_cells(
+      {
+        cell_1: {
+          begin_with: 'PRE2'
+        },
+        cell_2: {
+          fixed_size: 2
+        },
+        cell_3: {
+          text: 'Cell X',
+          pad: '-='
+        }
+      }
+    )
+    test_menu { |menu| menu.item row }
+    assert_line 3, 'PRE2Cell 1POST Ce Cell X-=-='
+  end
+
+end

data/spec/curses_menu_test/rubocop_spec.rb

@@ -0,0 +1,31 @@
+require 'json'
+
+describe 'Coding guidelines' do
+
+  it 'makes sure code style follow Rubocop guides' do
+    rubocop_report = JSON.parse(`bundle exec rubocop --format json`)
+    expect(rubocop_report['summary']['offense_count']).to(
+      eq(0),
+      proc do
+        # Format a great error message to help
+        wrong_files = rubocop_report['files'].reject { |file_info| file_info['offenses'].empty? }
+        <<~EO_ERROR
+          #{wrong_files.size} files have Rubocop issues:
+          #{
+            wrong_files.map do |file_info|
+              offenses = file_info['offenses'].map { |offense_info| "L#{offense_info['location']['start_line']}: #{offense_info['cop_name']} - #{offense_info['message']}" }
+              "* #{file_info['path']}:#{
+                if offenses.size == 1
+                  " #{offenses.first}"
+                else
+                  " #{offenses.size} offenses:\n#{offenses.map { |offense| "  - #{offense}" }.join("\n")}"
+                end
+              }"
+            end.join("\n")
+          }
+        EO_ERROR
+      end
+    )
+  end
+
+end

data/spec/curses_menu_test/scrolling_spec.rb

@@ -0,0 +1,95 @@
+describe CursesMenu do
+
+  it 'does not span items on more than 1 line' do
+    nbr_visible_chars = Curses.stdscr.maxx
+    test_menu do |menu|
+      menu.item '1' * nbr_visible_chars * 2
+      menu.item 'Menu item 2'
+    end
+    assert_line 3, '1' * (nbr_visible_chars - 1)
+    assert_line 4, 'Menu item 2'
+  end
+
+  it 'scrolls by using right key' do
+    nbr_visible_chars = Curses.stdscr.maxx
+    test_menu(keys: [Curses::KEY_RIGHT, Curses::KEY_RIGHT, Curses::KEY_RIGHT]) do |menu|
+      menu.item "abcde#{'1' * (nbr_visible_chars - 5)}23456789"
+    end
+    assert_line 3, "de#{'1' * (nbr_visible_chars - 5)}23"
+  end
+
+  it 'scrolls by using left key' do
+    nbr_visible_chars = Curses.stdscr.maxx
+    test_menu(keys: [Curses::KEY_RIGHT, Curses::KEY_RIGHT, Curses::KEY_RIGHT, Curses::KEY_LEFT]) do |menu|
+      menu.item "abcde#{'1' * (nbr_visible_chars - 5)}23456789"
+    end
+    assert_line 3, "cde#{'1' * (nbr_visible_chars - 5)}2"
+  end
+
+  it 'scrolls by using down key' do
+    nbr_visible_items = Curses.stdscr.maxy - 5
+    test_menu(keys: [Curses::KEY_NPAGE, Curses::KEY_DOWN, Curses::KEY_DOWN]) do |menu|
+      (nbr_visible_items * 2).times do |idx|
+        menu.item "Menu item #{idx}"
+      end
+    end
+    assert_line 3, 'Menu item 2'
+    assert_line(-3, "Menu item #{nbr_visible_items + 1}")
+  end
+
+  it 'scrolls by using up key' do
+    nbr_visible_items = Curses.stdscr.maxy - 5
+    test_menu(keys: [Curses::KEY_END, Curses::KEY_PPAGE, Curses::KEY_UP, Curses::KEY_UP]) do |menu|
+      (nbr_visible_items * 2).times do |idx|
+        menu.item "Menu item #{idx}"
+      end
+    end
+    assert_line 3, "Menu item #{nbr_visible_items - 2}"
+    assert_line(-3, "Menu item #{2 * nbr_visible_items - 3}")
+  end
+
+  it 'scrolls by using page down key' do
+    nbr_visible_items = Curses.stdscr.maxy - 5
+    test_menu(keys: [Curses::KEY_NPAGE, Curses::KEY_NPAGE]) do |menu|
+      (nbr_visible_items * 3).times do |idx|
+        menu.item "Menu item #{idx}"
+      end
+    end
+    assert_line 3, "Menu item #{nbr_visible_items - 1}"
+    assert_line(-3, "Menu item #{nbr_visible_items * 2 - 2}")
+  end
+
+  it 'scrolls by using page up key' do
+    nbr_visible_items = Curses.stdscr.maxy - 5
+    test_menu(keys: [Curses::KEY_END, Curses::KEY_PPAGE, Curses::KEY_PPAGE]) do |menu|
+      (nbr_visible_items * 3).times do |idx|
+        menu.item "Menu item #{idx}"
+      end
+    end
+    assert_line 3, "Menu item #{nbr_visible_items + 2 - 1}"
+    assert_line(-3, "Menu item #{nbr_visible_items * 2}")
+  end
+
+  it 'scrolls by using end key' do
+    nbr_visible_items = Curses.stdscr.maxy - 5
+    test_menu(keys: [Curses::KEY_END]) do |menu|
+      (nbr_visible_items * 2).times do |idx|
+        menu.item "Menu item #{idx}"
+      end
+    end
+    assert_line 3, "Menu item #{nbr_visible_items}"
+    assert_line(-3, "Menu item #{nbr_visible_items * 2 - 1}")
+  end
+
+  it 'scrolls by using home key' do
+    nbr_visible_items = Curses.stdscr.maxy - 5
+    test_menu(keys: [Curses::KEY_END, Curses::KEY_HOME]) do |menu|
+      (nbr_visible_items * 3).times do |idx|
+        menu.item "Menu item #{idx}"
+      end
+    end
+    assert_line 3, 'Menu item 0'
+    assert_line(-3, "Menu item #{nbr_visible_items - 1}")
+  end
+
+end

data/spec/curses_menu_test/simple_navigation_spec.rb

@@ -0,0 +1,123 @@
+describe CursesMenu do
+
+  it 'displays a menu with 1 item' do
+    test_menu(title: 'Menu title') do |menu|
+      menu.item 'Menu item'
+    end
+    assert_line 1, '= Menu title'
+    assert_line 3, 'Menu item'
+    assert_line(-1, '= Arrows/Home/End: Navigate | Esc: Exit')
+  end
+
+  it 'displays a menu with several items' do
+    test_menu do |menu|
+      menu.item 'Menu item 1'
+      menu.item 'Menu item 2'
+      menu.item 'Menu item 3'
+    end
+    assert_line 3, 'Menu item 1'
+    assert_line 4, 'Menu item 2'
+    assert_line 5, 'Menu item 3'
+  end
+
+  it 'displays a menu item with more actions' do
+    test_menu do |menu|
+      menu.item 'Menu item', actions: {
+        'a' => {
+          name: 'First action',
+          execute: proc {}
+        },
+        'b' => {
+          name: 'Second action',
+          execute: proc {}
+        }
+      }
+    end
+    assert_line(-1, '= Arrows/Home/End: Navigate | Esc: Exit | a: First action | b: Second action')
+  end
+
+  it 'navigates by using down key' do
+    test_menu(keys: [Curses::KEY_DOWN, Curses::KEY_DOWN]) do |menu|
+      menu.item 'Menu item 1'
+      menu.item 'Menu item 2'
+      menu.item 'Menu item 3', actions: { 'a' => { name: 'Special action', execute: proc {} } }
+      menu.item 'Menu item 4'
+    end
+    assert_line(-1, '= Arrows/Home/End: Navigate | Esc: Exit | a: Special action')
+  end
+
+  it 'navigates by using end key' do
+    test_menu(keys: [Curses::KEY_END]) do |menu|
+      menu.item 'Menu item 1'
+      menu.item 'Menu item 2'
+      menu.item 'Menu item 3'
+      menu.item 'Menu item 4', actions: { 'a' => { name: 'Special action', execute: proc {} } }
+    end
+    assert_line(-1, '= Arrows/Home/End: Navigate | Esc: Exit | a: Special action')
+  end
+
+  it 'navigates by using up key' do
+    test_menu(keys: [Curses::KEY_END, Curses::KEY_UP]) do |menu|
+      menu.item 'Menu item 1'
+      menu.item 'Menu item 2'
+      menu.item 'Menu item 3', actions: { 'a' => { name: 'Special action', execute: proc {} } }
+      menu.item 'Menu item 4'
+    end
+    assert_line(-1, '= Arrows/Home/End: Navigate | Esc: Exit | a: Special action')
+  end
+
+  it 'navigates by using home key' do
+    test_menu(keys: [Curses::KEY_END, Curses::KEY_HOME]) do |menu|
+      menu.item 'Menu item 1', actions: { 'a' => { name: 'Special action', execute: proc {} } }
+      menu.item 'Menu item 2'
+      menu.item 'Menu item 3'
+      menu.item 'Menu item 4'
+    end
+    assert_line(-1, '= Arrows/Home/End: Navigate | Esc: Exit | a: Special action')
+  end
+
+  it 'navigates by using right key' do
+    test_menu(keys: [Curses::KEY_RIGHT, Curses::KEY_RIGHT]) do |menu|
+      menu.item 'Menu item'
+    end
+    assert_line 3, 'nu item'
+    assert_line(-1, 'Arrows/Home/End: Navigate | Esc: Exit')
+  end
+
+  it 'navigates by using left key' do
+    test_menu(keys: [Curses::KEY_RIGHT, Curses::KEY_RIGHT, Curses::KEY_LEFT]) do |menu|
+      menu.item 'Menu item'
+    end
+    assert_line 3, 'enu item'
+    assert_line(-1, ' Arrows/Home/End: Navigate | Esc: Exit')
+  end
+
+  it 'navigates by using page down key' do
+    nbr_visible_items = Curses.stdscr.maxy - 5
+    test_menu(keys: [Curses::KEY_NPAGE]) do |menu|
+      (nbr_visible_items * 2).times do |idx|
+        if idx == nbr_visible_items - 1
+          menu.item "Menu item #{idx}", actions: { 'a' => { name: "Special action #{idx}", execute: proc {} } }
+        else
+          menu.item "Menu item #{idx}"
+        end
+      end
+    end
+    assert_line(-1, "= Arrows/Home/End: Navigate | Esc: Exit | a: Special action #{nbr_visible_items - 1}")
+  end
+
+  it 'navigates by using page up key' do
+    nbr_visible_items = Curses.stdscr.maxy - 5
+    test_menu(keys: [Curses::KEY_END, Curses::KEY_PPAGE]) do |menu|
+      (nbr_visible_items * 2).times do |idx|
+        if idx == nbr_visible_items
+          menu.item "Menu item #{idx}", actions: { 'a' => { name: "Special action #{idx}", execute: proc {} } }
+        else
+          menu.item "Menu item #{idx}"
+        end
+      end
+    end
+    assert_line(-1, "= Arrows/Home/End: Navigate | Esc: Exit | a: Special action #{nbr_visible_items}")
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,105 @@
+require 'curses_menu_test'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # Add our own helpers
+  config.include CursesMenuTest::Helpers
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  # config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  # config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  # config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  # config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  # if config.files_to_run.one?
+  #   # Use the documentation formatter for detailed output,
+  #   # unless a formatter has already been configured
+  #   # (e.g. via a command-line flag).
+  #   config.default_formatter = "doc"
+  # end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  # Kernel.srand config.seed
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: curses_menu
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Muriel Salvan
@@ -85,8 +85,22 @@ email:
 - muriel@x-aeon.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- CHANGELOG.md
+- README.md
+- LICENSE.md
+- examples/hello.rb
+- examples/sub_menus.rb
+- examples/automatic_key_presses.rb
+- examples/refresh.rb
+- examples/formatting.rb
+- examples/several_items.rb
+- examples/actions.rb
+- examples/scrolling.rb
 files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
 - examples/actions.rb
 - examples/automatic_key_presses.rb
 - examples/formatting.rb
@@ -98,6 +112,13 @@ files:
 - lib/curses_menu.rb
 - lib/curses_menu/curses_row.rb
 - lib/curses_menu/version.rb
+- spec/curses_menu_test.rb
+- spec/curses_menu_test/actions_spec.rb
+- spec/curses_menu_test/formatting_spec.rb
+- spec/curses_menu_test/rubocop_spec.rb
+- spec/curses_menu_test/scrolling_spec.rb
+- spec/curses_menu_test/simple_navigation_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/Muriel-Salvan/curses_menu
 licenses:
 - BSD-3-Clause