terminal-basic-menu 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 61f908608d54e5872d523f2d84d7151b4d1e793dc2b62fba259f7ae817211776
+  data.tar.gz: acfabc6a92621d9ec932f5b82eec106ed3d4426565d2ad48028a269537733ae4
+SHA512:
+  metadata.gz: 25efde4fca9a3c8a8ece2a36a2298f9637ae1f465c3ee5acbae28f9731b28f96fdf311ddb715f7b1306c524e37aa25de74368f614bc69214b03bda6c08f2f9ec
+  data.tar.gz: 0aed9b87dacf05a989d65cc1a6d1588fc199c10c1a164a29d60182f8182da098e08d0d76d71e500dfaff4284006001e1e3eb80cb8ab4197d3c56faf0970cbc79

data/lib/terminal-basic-menu.rb

@@ -0,0 +1,125 @@
+require 'rainbow'
+
+# Basic menu class used to create an instance of a terminal menu
+class Menu
+  attr_accessor :width, :header, :body, :footer, :border_color, :word_wrap, :block_align
+  def initialize(width: 50, header: nil, body: nil, footer: nil, border_color: 0)
+    @width = width - 4 # adjust to allow '| ' and ' |' on each side
+    @header = header
+    @body = body
+    @footer = footer
+    @border_color = border_color
+    @word_wrap = true
+    @block_align = true
+  end
+
+  def display_menu
+    # Return if nothing to display
+    return unless @header || @body || @footer
+    # Change left to ljust etc.
+    align_to_method!
+    print_line_break
+    if @header
+      display_header
+      print_line_break
+    end
+    if @body
+      display_body
+      print_line_break
+    end
+    if @footer
+      display_footer
+      print_line_break
+    end
+  end
+
+  def display_header
+    print_text(@header[:text], @header[:align], @header[:color])
+  end
+
+  def display_body
+    print_text(@body[:text], @body[:align], @body[:color])
+    print_choices(@body[:choices], @body[:choice_align], @body[:color])
+  end
+
+  def display_footer
+    print_text(@footer[:text], @footer[:align], @footer[:color])
+  end
+
+  private
+
+  def print_text(text, align, color, choices: false)
+    color = 0 if color.nil?
+    # Default to center align
+    align = 'center' if align.nil?
+    # Split for normal text not for choices
+    lines = choices ? text.dup : text.split("\n")
+    # Wrap words or text that is too long
+    lines.map! { |line| word_wrap(line) } if @word_wrap
+    lines.flatten!
+    # Check for longest line to allow for grouped alignment if enabled
+    max_length = @block_align ? lines.map(&:length).max : 0
+    # Add extra length for choices '1) '
+    max_length += lines.count.to_s.length + 2 if choices
+    lines.each_with_index do |line, i|
+      line.prepend("#{i + 1}) ") if choices
+      output = Rainbow('| ').fg(border_color)
+      output += Rainbow(line.ljust(max_length).send(align, @width)).fg(color)
+      output += Rainbow(' |').fg(border_color)
+      puts output
+    end
+  end
+
+  def print_choices(choices, align, color)
+    print_text(choices, align, color, choices: true) unless choices.nil?
+  end
+
+  def print_line_break
+    puts Rainbow('+' + '-' * (@width + 2) + '+').color(border_color)
+  end
+
+  def word_wrap(text)
+    lines = text.split("\n")
+    string = ''
+    lines.each do |line|
+      space_left = @width
+      line.split.each do |word|
+        if word.length + 1 > space_left
+          string += "\n"
+          if word.length > @width
+            # Use regex to split word with newline when reaching max width
+            word = word.scan(/.{1,#{@width}}/).join("\n")
+          end
+          string += word
+          space_left = @width - word.length
+        else
+          string += " #{word}"
+          space_left -= word.length + 1
+        end
+      end
+      string += "\n"
+    end
+    string.strip.split("\n")
+  end
+
+  def align_to_method!
+    @header[:align] = method_name(@header[:align]) if @header
+    if @body
+      @body[:align] = method_name(@body[:align])
+      @body[:choice_align] = method_name(@body[:choice_align])
+    end
+    @footer[:align] = method_name(@footer[:align]) if @footer
+  end
+
+  def method_name(input = nil)
+    return if input.nil?
+    case input
+    when 'left', 'ljust'
+      'ljust'
+    when 'right', 'rjust'
+      'rjust'
+    when 'center', 'middle'
+      'center'
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: terminal-basic-menu
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- David Armour
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: A simple gem used to create and display menus for terminal apps.
+email: agrobmonkey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/terminal-basic-menu.rb
+homepage: https://github.com/dav-armour/terminal-basic-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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: A basic menu for terminal apps
+test_files: []