terminal-menu 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42ebb17b36ef8b8d895711f65fc2cf7379fdba96
+  data.tar.gz: cbc7b91df3a8d07e9bc8e88a3dba6671a5c2f885
+SHA512:
+  metadata.gz: f654dca829f81a091b5022dfc8b808121d9df06e32bc88c6224724f83625cc2d0f1a0e58c6ecc0c0f0ef97f4c4a4a0f70695bbfabb074374924ca4b06d176754
+  data.tar.gz: c6ae9b699e8c475abf4ee2f6db5535cdc404653e9c6e80c7061f8c8acad1e1041d08f55edb0d488e5f8686df9670ed08a035075590f67faa4eebae22703442fd

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Two Bucks Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# Terminal Menu
+
+[![Build Status](https://travis-ci.org/twobucks/terminal-menu.svg)](https://travis-ci.org/twobucks/terminal-menu)
+
+Retro ANSI terminal menu.
+
+![example](example.png)
+
+
+## Install
+
+```
+gem install terminal-menu
+```
+
+## Example
+
+
+```ruby
+require 'terminal-menu'
+
+menu = TerminalMenu.new(title: 'Rick Astley - Never Gonna Give You Up',
+                        description: '',
+                        width: 40,
+                        fg: 'white',
+                        bg: 'red') do |selected|
+                          puts "you have selected: #{selected}"
+                          menu.quit
+                        end
+
+menu.add('Never gonna give you up') do |selected|
+  puts "first option selected"
+end
+menu.add('Never gonna let you down') do |selected|
+  puts "second option selected"
+end
+menu.add('Never gonna run around and desert you') do |selected|
+  puts "third option selected"
+end
+menu.show
+```
+
+# API
+
+```ruby
+# Initializes new TerminalMenu instance.
+# 
+# block - Optional block that will get called with label once some option
+#         is selected
+# 
+# Options:
+#
+#   title - The title of this menu (default: '')
+#   description - The description of this menu (default: '')
+#   width - The width of this menu in chars (default: 80)
+#   fg - Foreground color of this menu (default: 'white')
+#   bg - Background color of this menu (default: 'black')
+#   stdin - Input IO instance (default: STDIN)
+#   stdout - Output IO instance (default: STDOUT)
+menu = TerminalMenu.new(title: '', description: '', width: 80,
+                        fg: 'white', bg: 'black',
+                        stdin: STDIN, stdout: STDOUT){|selected| block }
+
+
+# Adds a new item to menu options.
+#
+# label - Label for this menu option.
+# blk - Optional block that will be called once this option is selected.
+menu.add(label, &blk)
+
+# Starts read-eval-print loop.
+menu.show
+
+# Quits this menu.
+menu.quit
+```
+
+## Thanks
+
+To [@substack](https://github.com/substack) for creating [terminal-menu](https://github.com/substack/terminal-menu) for Node.
+
+## License
+
+MIT
+
+## Sponsors
+
+Two Bucks Ltd. © 2016
+
+<a href="https://twobucks.co">
+  ![https://twobucks.co](https://twobucks.co/assets/images/logo-small.png)
+</a>

data/lib/terminal-menu/version.rb

@@ -0,0 +1,3 @@
+module TerminalMenu
+  VERSION = '1.0.0'
+end

data/lib/terminal-menu.rb

@@ -0,0 +1,151 @@
+require 'paint'
+require 'io/console'
+
+class TerminalMenu
+  # Public: Initializes new TerminalMenu instance.
+  #
+  # block - Optional block that will get called with label once some option
+  #         is selected
+  #
+  # Options:
+  #
+  #   title - The title of this menu (default: '')
+  #   description - The description of this menu (default: '')
+  #   width - The width of this menu in chars (default: 80)
+  #   fg - Foreground color of this menu (default: 'white')
+  #   bg - Background color of this menu (default: 'black')
+  #   stdin - Input IO instance (default: STDIN)
+  #   stdout - Output IO instance (default: STDOUT)
+  def initialize(title: '', description: '', width: 80,
+                 fg: 'white', bg: 'black',
+                 stdin: STDIN, stdout: STDOUT, &selected_callback)
+    @title = title
+    @description = description
+    @width = width
+    @selected_callback = selected_callback || -> (arg) {}
+    @fg = fg
+    @bg = bg
+    @stdin = stdin
+    @stdout = stdout
+
+    @selected_index = 0
+
+    @options = [{label: 'exit', callback:  ->{}}]
+    @last_char = []
+  end
+
+  # Public: Adds a new item to menu options.
+  #
+  # label - Label for this menu option.
+  # blk - Optional block that will be called once this option is selected.
+  def add(label, &blk)
+    # preserve exit as the last option
+    last = @options.pop
+    @options << {label: label, callback: blk || -> (arg) {}}
+    @options << last
+  end
+
+  # Public: Starts read-eval-print loop.
+  def show
+    while true do
+      clear_screen
+      print_screen
+      get_input
+    end
+  rescue IOError
+    # do nothing, program has ended
+  end
+
+  # Public: Quits this menu.
+  def quit
+    @stdin.close
+    @stdout.close
+  end
+
+  private
+
+    def go_down
+      if @selected_index == @options.length - 1
+        @selected_index = 0
+      else
+        @selected_index += 1
+      end
+    end
+
+    def go_up
+      if @selected_index == 0
+        @selected_index = @options.length - 1
+      else
+        @selected_index -= 1
+      end
+    end
+
+    def print_header
+      print(@title.upcase)
+      print(@description)
+      print_delimiter
+    end
+
+    def print_options
+      @options.each_with_index do |option, i|
+        if i == @options.length - 1 # last option AKA exit
+          print_delimiter
+          print("#{option[:label].upcase}", inverted: i == @selected_index)
+        else
+          print(">> #{option[:label].upcase}", inverted: i == @selected_index)
+        end
+      end
+    end
+
+    def print_delimiter
+      print('-' * @width)
+    end
+
+    def print_screen
+      print_header
+      print_options
+    end
+
+    def print(text, inverted: false)
+      if inverted
+        @stdout.puts Paint[text.ljust(@width), @bg, @fg]
+      else
+        @stdout.puts Paint[text.ljust(@width), @fg, @bg]
+      end
+    end
+
+    def get_input
+      char = @stdin.getch
+
+      @last_char << char # special characters (like up arrow) get sent
+                         # as mulitple characters, so we have to store past
+                         # few characters somewhere
+
+      case
+      when @last_char.join == "\e[A" || char == 'k' # up arrow or k
+        go_up
+        @last_char = []
+      when @last_char.join == "\e[B" || char == 'j' # down arrow or j
+        go_down
+        @last_char = []
+      when char == "\r" # enter
+        if @selected_index == @options.length - 1
+          quit
+          return
+        end
+
+        @options[@selected_index][:callback].call(@options[@selected_index][:label])
+        @selected_callback.call(@options[@selected_index][:label])
+      when char == "\u0003" || char == "q" # ctrl+c or q
+        quit
+      when !@last_char.include?("\e") # not a special character, clear array
+        @last_char = []
+      end
+    end
+
+    def clear_screen
+      @stdout.puts "\e[0m"
+      @stdout.puts "\e[2J"
+      @stdout.puts "\ec"
+    end
+end

data/terminal-menu.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+require File.dirname(__FILE__) + "/lib/terminal-menu/version"
+
+Gem::Specification.new do |s|
+  s.name         = "terminal-menu"
+  s.version      = TerminalMenu::VERSION
+  s.authors      = ["Hrvoje Simic"]
+  s.email        = "shime@twobucks.co"
+  s.homepage     = "https://github.com/twobucks/terminal-menu"
+  s.summary      = "Terminal menu"
+  s.description  = "Retro ANSI terminal menu"
+  s.license      = 'MIT'
+  s.require_path = 'lib'
+
+  s.files = %w[
+    README.md
+    LICENSE
+    terminal-menu.gemspec
+    lib/terminal-menu.rb
+    lib/terminal-menu/version.rb
+  ]
+
+  s.required_ruby_version = '>= 2.0'
+
+  s.add_runtime_dependency 'paint', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'minitest', '~> 5.9', '>= 5.9.0'
+  s.add_development_dependency 'rake', '~> 11.2', '>= 11.2.2'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: terminal-menu
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Hrvoje Simic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.9.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+description: Retro ANSI terminal menu
+email: shime@twobucks.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/terminal-menu.rb
+- lib/terminal-menu/version.rb
+- terminal-menu.gemspec
+homepage: https://github.com/twobucks/terminal-menu
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Terminal menu
+test_files: []
+has_rdoc: