curses_menu 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2226bebb142878eb4467c0471c3978f683746634acc51e6852f3b9298fbd3cf
-  data.tar.gz: 23f6626cf28f160149106907a307cdc49ce64741f62ffb6053e16ad276267223
+  metadata.gz: d07858a5e2aad9b9633584a1e0b2c06b9a13ad5b69752ef7b4808ed614e7a889
+  data.tar.gz: 65f6f0b04deea7b529d136fe6fa3fea72fcfc98cfc0fc8d651863814a4bde162
 SHA512:
-  metadata.gz: 31d298f6320962b6061936eff73ba7a517f10c0ec0b8b681455ae71df372b8ef5e0ee674d598fe094c76de18531a1d4a3a07b58ae2d405a6112a03b00bfd5275
-  data.tar.gz: 6f49adde82fac8dfd6e7f513184735b3f9e9f0024857b00604b9180bd926659a1a9ddece7ef112ad671f1921d60c236204359c8d6fe361a491c9fe393a31cd4f
+  metadata.gz: f322978d91a509bf1696d1da056f65a7dc097bf65e61ebf46194c1bc555dad59caadadd8cca9f2c5b8bf4aea87a0d086a22555b8084e06c6a15c56c5a9ccd3f3
+  data.tar.gz: 744ed073c7e764068f3b97a528255371b70dedd99c1d164e4cc2f8981069dfd8e1ec5c606df74f3b4df00c232d3995cd31037c53401fc7bc092b1e6313da596a

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# [v0.0.5](https://github.com/Muriel-Salvan/curses_menu/compare/v0.0.4...v0.0.5) (2021-08-18 11:48:24)
+
+### Patches
+
+* [[Hotfix] Add Windows support](https://github.com/Muriel-Salvan/curses_menu/commit/b47b51a79988363c0e292987fe4a97dd6f05c6d8)
+
+# [v0.0.4](https://github.com/Muriel-Salvan/curses_menu/compare/v0.0.3...v0.0.4) (2021-08-18 10:25:59)
+
+### Patches
+
+* [Test UTF-8 support](https://github.com/Muriel-Salvan/curses_menu/commit/f94129db540d41f17f0ed46563461601f140029f)
+
+# [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/examples/actions.rb

@@ -1,25 +1,25 @@
-require 'curses_menu'
-
-nbr = 0
-CursesMenu.new 'Items can have several actions. Look at the footer!' do |menu|
-  menu.item "Current number is #{nbr} - Use a or d", actions: {
-    'd' => {
-      name: 'Increase',
-      execute: proc do
-        nbr += 1
-        :menu_refresh
-      end
-    },
-    'a' => {
-      name: 'Decrease',
-      execute: proc do
-        nbr -= 1
-        :menu_refresh
-      end
-    }
-  }
-  menu.item 'Quit' do
-    puts 'Quitting...'
-    :menu_exit
-  end
-end
+require 'curses_menu'
+
+nbr = 0
+CursesMenu.new 'Items can have several actions. Look at the footer!' do |menu|
+  menu.item "Current number is #{nbr} - Use a or d", actions: {
+    'd' => {
+      name: 'Increase',
+      execute: proc do
+        nbr += 1
+        :menu_refresh
+      end
+    },
+    'a' => {
+      name: 'Decrease',
+      execute: proc do
+        nbr -= 1
+        :menu_refresh
+      end
+    }
+  }
+  menu.item 'Quit' do
+    puts 'Quitting...'
+    :menu_exit
+  end
+end

data/examples/automatic_key_presses.rb

@@ -1,49 +1,49 @@
-require 'curses_menu'
-
-keys = [
-  # Select first
-  CursesMenu::KEY_ENTER,
-  # Select second
-  Curses::KEY_DOWN,
-  'a',
-  'b',
-  # Select third (sub-menu)
-  Curses::KEY_DOWN,
-  CursesMenu::KEY_ENTER,
-  # Select sub-menu first
-  CursesMenu::KEY_ENTER,
-  # Exit sub-menu
-  CursesMenu::KEY_ESCAPE,
-  # Navigate a bit
-  Curses::KEY_NPAGE,
-  Curses::KEY_HOME,
-  # Select last
-  Curses::KEY_END,
-  CursesMenu::KEY_ENTER
-]
-CursesMenu.new('Menu being used automatically', key_presses: keys) do |menu|
-  menu.item 'Simple item' do
-    puts 'Selected a simple item'
-  end
-  menu.item 'Several actions on this item', actions: {
-    'a' => {
-      name: 'Action A',
-      execute: proc { puts 'Selected action A' }
-    },
-    'b' => {
-      name: 'Action B',
-      execute: proc { puts 'Selected action B' }
-    }
-  }
-  menu.item 'Sub-menu' do
-    CursesMenu.new('Sub-menu!', key_presses: keys) do |sub_menu|
-      sub_menu.item 'Simple sub-menu item' do
-        puts 'Selected item from sub-menu'
-      end
-    end
-  end
-  menu.item 'Quit' do
-    puts 'Quitting...'
-    :menu_exit
-  end
-end
+require 'curses_menu'
+
+keys = [
+  # Select first
+  CursesMenu::KEY_ENTER,
+  # Select second
+  Curses::KEY_DOWN,
+  'a',
+  'b',
+  # Select third (sub-menu)
+  Curses::KEY_DOWN,
+  CursesMenu::KEY_ENTER,
+  # Select sub-menu first
+  CursesMenu::KEY_ENTER,
+  # Exit sub-menu
+  CursesMenu::KEY_ESCAPE,
+  # Navigate a bit
+  Curses::KEY_NPAGE,
+  Curses::KEY_HOME,
+  # Select last
+  Curses::KEY_END,
+  CursesMenu::KEY_ENTER
+]
+CursesMenu.new('Menu being used automatically', key_presses: keys) do |menu|
+  menu.item 'Simple item' do
+    puts 'Selected a simple item'
+  end
+  menu.item 'Several actions on this item', actions: {
+    'a' => {
+      name: 'Action A',
+      execute: proc { puts 'Selected action A' }
+    },
+    'b' => {
+      name: 'Action B',
+      execute: proc { puts 'Selected action B' }
+    }
+  }
+  menu.item 'Sub-menu' do
+    CursesMenu.new('Sub-menu!', key_presses: keys) do |sub_menu|
+      sub_menu.item 'Simple sub-menu item' do
+        puts 'Selected item from sub-menu'
+      end
+    end
+  end
+  menu.item 'Quit' do
+    puts 'Quitting...'
+    :menu_exit
+  end
+end

data/examples/formatting.rb

@@ -1,130 +1,148 @@
-require 'curses_menu'
-
-dynamic_row_1 = CursesMenu::CursesRow.new(
-  first_cell: { text: 'Select to' },
-  second_cell: {
-    text: 'change the',
-    color_pair: CursesMenu::COLORS_GREEN
-  },
-  third_cell: {
-    text: 'cells order',
-    color_pair: CursesMenu::COLORS_RED
-  }
-)
-dynamic_row_2 = CursesMenu::CursesRow.new(
-  first_cell: { text: 'Select to change' },
-  second_cell: {
-    text: 'the cells properties',
-    color_pair: CursesMenu::COLORS_GREEN,
-    fixed_size: 40
-  }
-)
-CursesMenu.new 'Extended formatting available too!' do |menu|
-  menu.item CursesMenu::CursesRow.new(
-    default_cell: {
-      text: 'Simple color change - GREEN!',
-      color_pair: CursesMenu::COLORS_GREEN
-    }
-  )
-  menu.item CursesMenu::CursesRow.new(
-    green_cell: {
-      text: 'Several cells ',
-      color_pair: CursesMenu::COLORS_GREEN
-    },
-    red_cell: {
-      text: 'with different ',
-      color_pair: CursesMenu::COLORS_RED
-    },
-    blue_cell: {
-      text: 'formatting',
-      color_pair: CursesMenu::COLORS_BLUE
-    }
-  )
-  menu.item CursesMenu::CursesRow.new(
-    default_cell: {
-      text: 'Use prefixes and suffixes',
-      begin_with: '[ ',
-      end_with: ' ]'
-    }
-  )
-  menu.item CursesMenu::CursesRow.new(
-    first_cell: {
-      text: 'This will have a fixed size!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!',
-      begin_with: '[ ',
-      end_with: ' ]',
-      fixed_size: 40
-    },
-    second_cell: {
-      text: 'And other cells will be aligned',
-      color_pair: CursesMenu::COLORS_GREEN
-    }
-  )
-  menu.item CursesMenu::CursesRow.new(
-    first_cell: {
-      text: 'Pretty nice',
-      fixed_size: 40
-    },
-    second_cell: {
-      text: 'for alignment',
-      color_pair: CursesMenu::COLORS_GREEN
-    }
-  )
-  menu.item CursesMenu::CursesRow.new(
-    first_cell: {
-      text: 'And you can justify',
-      justify: :right,
-      fixed_size: 40
-    },
-    second_cell: {
-      text: 'your text when size is fixed!',
-      justify: :left,
-      color_pair: CursesMenu::COLORS_GREEN
-    }
-  )
-  menu.item CursesMenu::CursesRow.new(
-    first_cell: {
-      text: 'You can even',
-      justify: :right,
-      fixed_size: 40,
-      pad: '_-'
-    },
-    second_cell: {
-      text: 'pad it!',
-      justify: :left,
-      color_pair: CursesMenu::COLORS_GREEN,
-      fixed_size: 40,
-      pad: '*'
-    }
-  )
-  menu.item CursesMenu::CursesRow.new(
-    {
-      first_cell: { text: 'Use a' },
-      second_cell: {
-        text: 'different separator',
-        color_pair: CursesMenu::COLORS_GREEN
-      },
-      third_cell: { text: 'between cells' }
-    },
-    separator: '|'
-  )
-  menu.item dynamic_row_1 do
-    dynamic_row_1.cells_order([:first_cell, :second_cell, :third_cell].sort_by { rand })
-    :menu_refresh
-  end
-  menu.item dynamic_row_2 do
-    dynamic_row_2.change_cells(
-      first_cell: {
-        color_pair: [CursesMenu::COLORS_GREEN, CursesMenu::COLORS_RED, CursesMenu::COLORS_BLUE].sample
-      },
-      second_cell: {
-        color_pair: [CursesMenu::COLORS_GREEN, CursesMenu::COLORS_RED, CursesMenu::COLORS_BLUE].sample,
-        pad: ['*', ' ', '|', '='].sample
-      }
-    )
-    :menu_refresh
-  end
-  menu.item 'Quit' do
-    puts 'Quitting...'
-    :menu_exit
-  end
-end
+require 'curses_menu'
+
+dynamic_row_1 = CursesMenu::CursesRow.new(
+  {
+    first_cell: { text: 'Select to' },
+    second_cell: {
+      text: 'change the',
+      color_pair: CursesMenu::COLORS_GREEN
+    },
+    third_cell: {
+      text: 'cells order',
+      color_pair: CursesMenu::COLORS_RED
+    }
+  }
+)
+dynamic_row_2 = CursesMenu::CursesRow.new(
+  {
+    first_cell: { text: 'Select to change' },
+    second_cell: {
+      text: 'the cells properties',
+      color_pair: CursesMenu::COLORS_GREEN,
+      fixed_size: 40
+    }
+  }
+)
+CursesMenu.new 'Extended formatting available too!' do |menu|
+  menu.item CursesMenu::CursesRow.new(
+    {
+      default_cell: {
+        text: 'Simple color change - GREEN!',
+        color_pair: CursesMenu::COLORS_GREEN
+      }
+    }
+  )
+  menu.item CursesMenu::CursesRow.new(
+    {
+      green_cell: {
+        text: 'Several cells ',
+        color_pair: CursesMenu::COLORS_GREEN
+      },
+      red_cell: {
+        text: 'with different ',
+        color_pair: CursesMenu::COLORS_RED
+      },
+      blue_cell: {
+        text: 'formatting',
+        color_pair: CursesMenu::COLORS_BLUE
+      }
+    }
+  )
+  menu.item CursesMenu::CursesRow.new(
+    {
+      default_cell: {
+        text: 'Use prefixes and suffixes',
+        begin_with: '[ ',
+        end_with: ' ]'
+      }
+    }
+  )
+  menu.item CursesMenu::CursesRow.new(
+    {
+      first_cell: {
+        text: 'This will have a fixed size!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!',
+        begin_with: '[ ',
+        end_with: ' ]',
+        fixed_size: 40
+      },
+      second_cell: {
+        text: 'And other cells will be aligned',
+        color_pair: CursesMenu::COLORS_GREEN
+      }
+    }
+  )
+  menu.item CursesMenu::CursesRow.new(
+    {
+      first_cell: {
+        text: 'Pretty nice',
+        fixed_size: 40
+      },
+      second_cell: {
+        text: 'for alignment',
+        color_pair: CursesMenu::COLORS_GREEN
+      }
+    }
+  )
+  menu.item CursesMenu::CursesRow.new(
+    {
+      first_cell: {
+        text: 'And you can justify',
+        justify: :right,
+        fixed_size: 40
+      },
+      second_cell: {
+        text: 'your text when size is fixed!',
+        justify: :left,
+        color_pair: CursesMenu::COLORS_GREEN
+      }
+    }
+  )
+  menu.item CursesMenu::CursesRow.new(
+    {
+      first_cell: {
+        text: 'You can even',
+        justify: :right,
+        fixed_size: 40,
+        pad: '_-'
+      },
+      second_cell: {
+        text: 'pad it!',
+        justify: :left,
+        color_pair: CursesMenu::COLORS_GREEN,
+        fixed_size: 40,
+        pad: '*'
+      }
+    }
+  )
+  menu.item CursesMenu::CursesRow.new(
+    {
+      first_cell: { text: 'Use a' },
+      second_cell: {
+        text: 'different separator',
+        color_pair: CursesMenu::COLORS_GREEN
+      },
+      third_cell: { text: 'between cells' }
+    },
+    separator: '|'
+  )
+  menu.item dynamic_row_1 do
+    dynamic_row_1.cells_order(%i[first_cell second_cell third_cell].sort_by { rand })
+    :menu_refresh
+  end
+  menu.item dynamic_row_2 do
+    dynamic_row_2.change_cells(
+      first_cell: {
+        color_pair: [CursesMenu::COLORS_GREEN, CursesMenu::COLORS_RED, CursesMenu::COLORS_BLUE].sample
+      },
+      second_cell: {
+        color_pair: [CursesMenu::COLORS_GREEN, CursesMenu::COLORS_RED, CursesMenu::COLORS_BLUE].sample,
+        pad: ['*', ' ', '|', '='].sample
+      }
+    )
+    :menu_refresh
+  end
+  menu.item 'Quit' do
+    puts 'Quitting...'
+    :menu_exit
+  end
+end