fstui 0.5.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c70d3bdbca2796d540ec5518bccfcdcb01cea95b4ccb844780affe7aaf38ddf7
+  data.tar.gz: 97c8de10fa9948830b068c801b4fc580610e694f33517c588f121f5e72474897
+SHA512:
+  metadata.gz: 0efb84d357330c920760c40cfd66f9ddafcb893ee20098ffa8e255ac1cb5f98cf47267e59b05bd9aa9c2736e92f441c772ad47e0d7af7e03d63f20faa848246f
+  data.tar.gz: 84c669222f21fc903d2c279824ae3ca1f67131be94ddfdff6b8f39459d573372ed72a0e74fb74e1f8789de23dfc779b074a11980b5dbf53dd2aa54dcca0068b8

data/README.md

@@ -0,0 +1,2 @@
+# ruby-fstui
+Full Screen Text UI library for Ruby

data/lib/fstui/datascreen.rb

@@ -0,0 +1,39 @@
+module FSTui
+  class DataScreen
+    attr_accessor :title, :subtitle, :data
+
+    def initialize(screen, title, subtitle, data)
+      @screen = screen
+      @title = title
+      @subtitle = subtitle
+      @data = data
+    end
+    
+    def get_response(options: nil)
+      loop do
+        @win = Window.new(@data.lines.length+3, stdscr.maxx, 5, 0)
+        @win.addstr @title.center(@win.maxx)
+        @win.addstr @subtitle.center(@win.maxx) + "\n"
+      
+        # figure out which line is the longest and center it
+        longest_line = 0
+        @data.each_line do |line|
+          longest_line = line.length if line.length > longest_line
+        end
+        padding = " " * (@win.maxx / 2 - longest_line / 2)
+      
+        # draw the data block, with the longest line centered and all others left justified with it
+        @data.each_line do |line|
+          @win.addstr "#{padding}#{line.strip}\n"
+        end
+
+        @win.noutrefresh
+        selection = @screen.inputbar.get_selection(options: options)
+        @win.clear
+        @win.noutrefresh
+        @win.close
+        return selection
+      end
+    end
+  end
+end

data/lib/fstui/fieldscreen.rb

@@ -0,0 +1,195 @@
+module FSTui
+  class FieldScreen
+    attr_accessor :title, :subtitle, :fields
+
+    def initialize(screen, title, subtitle, fields)
+      @screen = screen
+      @title = title
+      @subtitle = subtitle
+      @fields = fields
+      @field_rows = []
+    end
+    
+    def clear_fields
+      @fields.each do |field|
+        field.value = nil
+      end
+    end
+
+    def get_response(options: nil)
+      loop do
+        @win = Window.new(stdscr.maxy-4, stdscr.maxx, 2, 0)
+        @win.addstr @title.center(@win.maxx)
+        @win.addstr @subtitle.center(@win.maxx) + "\n"
+      
+        # draw the fields on the form
+        @fields.each_index do |idx|
+          field = @fields[idx]
+          # keep track of which row each field starts on, for later edits
+          @field_rows[idx] = @win.cury
+          @win.addstr "  #{idx+1} - #{field.display_name}: "
+          @win.attron Curses::A_UNDERLINE
+          @win.addstr "#{field.value}"
+          @win.attroff Curses::A_UNDERLINE
+          @win.addstr "\n\n"
+        end
+        
+        @screen.inputbar.instructions = "#=Enter Data  ENTER=Submit Form  A=Abort"
+        @win.noutrefresh
+        selection = @screen.inputbar.get_selection(options: options)
+        case selection
+          when "1", "2", "3", "4", "5", "6", "7", "8", "9"
+            edit_field selection.to_i-1
+          when :enter
+            # check that all required fields have data
+            field_errors = 0
+            @fields.each_index do |idx|
+              field = @fields[idx]
+              next unless field.is_required?
+              next unless field.value == "" or field.value == nil
+              field_row = 3+idx*2
+
+              @win.setpos field_row, 0
+              @win.addstr "  #{idx+1} X #{field.display_name}: "
+              @win.standout
+              @win.addstr "                                 "
+              @win.standend
+              @win.clrtoeol
+              @win.setpos field_row, 8+field.display_name.length
+              field_errors += 1
+            end
+            
+            if(field_errors == 0) then
+              # everything looks good, end here and return the collected data
+              @win.clear
+              @win.noutrefresh
+              @win.close
+              @screen.inputbar.instructions = ""
+              return @fields
+            else
+              # TODO: consider blink or something, this isn't very obvious
+              @screen.inputbar.instructions = "Missing data in required field!"
+              @win.noutrefresh
+              @screen.redraw
+              doupdate
+              sleep 3
+            end
+          when 'A', 'a'
+            @win.clear
+            @win.noutrefresh
+            @win.close
+            @screen.inputbar.instructions = ""
+            return nil
+        end
+      end
+    end
+
+    def edit_field(field_nbr)
+      field = @fields[field_nbr]
+      value = ""
+      value = field.value if field.value
+      insert_pos = value.length
+      @win.setpos @field_rows[field_nbr], 0
+      @win.addstr "  #{field_nbr+1} - #{field.display_name}: "
+      @win.standout
+      # TODO: fix the hardcoded 33-long fields :)
+      @win.addstr value.ljust(33)
+      @win.clrtoeol
+      @win.setpos @field_rows[field_nbr], 8+field.display_name.length + value.length
+      noecho
+      @win.refresh
+      @win.keypad(true)
+      loop do
+        char = @win.getch
+        case char
+          when 10, 13, "\n", "\r"
+            break
+          when 8, KEY_BACKSPACE, "\b", 127
+            next unless insert_pos > 0
+            row = @win.cury
+            col = @win.curx
+            if(insert_pos == 1) then
+              value = ""
+              insert_pos = 0
+            else
+              value = value[0..insert_pos-2] + value[insert_pos..-1]
+              insert_pos -= 1
+            end
+            if(col==0) then
+              @win.setpos(row-1, @win.maxx-1)
+              @win.addstr value[insert_pos..-1] + ' '
+              @win.setpos(row-1, @win.maxx-1)
+            else
+              @win.setpos(row, col-1)
+              @win.addstr value[insert_pos..-1] + ' '
+              @win.setpos(row, col-1)
+            end
+          when KEY_DC # delete
+            next unless insert_pos < value.length
+            value = value[0..insert_pos-1] + value[insert_pos+1..-1]
+            row = @win.cury
+            col = @win.curx
+            @win.addstr value[insert_pos..-1] + ' '
+            @win.setpos(row, col)
+          when KEY_LEFT
+            next unless insert_pos > 0
+            row = @win.cury
+            col = @win.curx
+            if(col == 0) then
+              @win.setpos(row-1, @win.maxx-1)
+            else
+              @win.setpos(row, col-1)
+            end
+            insert_pos -= 1
+          when KEY_RIGHT
+            next unless insert_pos < value.length
+            row = @win.cury
+            col = @win.curx
+            if(col == @win.maxx-1) then
+              @win.setpos(row+1, 0)
+            else
+              @win.setpos(row, col+1)
+            end
+            insert_pos += 1
+          when KEY_DOWN, KEY_UP
+          else
+            value.insert(insert_pos, char)
+            insert_pos += 1
+            if(insert_pos == value.length) then
+              # adding chars at the end, easy
+              @win.addch char
+            else
+              # adding chars in the middle, need to redraw the rest of the field
+              row = @win.cury
+              col = @win.curx
+              @win.addstr value[insert_pos-1..-1]
+              @win.setpos(row, col+1)
+            end
+        end
+      end
+      @win.keypad(false)
+      echo
+      @win.standend
+
+      @fields[field_nbr].value = value
+    end
+  end
+
+  class Field
+    attr_accessor :name, :required, :value
+    def initialize(name:, required: true)
+      @name = name
+      @required = required
+    end
+
+    def display_name
+      disp_name = @name
+      disp_name += " (opt)" unless @required
+      disp_name
+    end
+    
+    def is_required?
+      @required
+    end
+  end
+end

data/lib/fstui/infolist.rb

@@ -0,0 +1,118 @@
+module FSTui
+  class InfoList
+    attr_accessor :infoline, :left_heading, :right_heading
+
+    def initialize(screen, infoline, lines_per_item)
+      @infoline = infoline
+      @lines_per_item = lines_per_item
+      @items = Array.new
+      @screen = screen
+    end
+    
+    def add_item(item)
+      @items.push item
+    end
+
+    def <<(item)
+      @items.push item
+    end
+
+    def clear_items
+      @items = []
+    end
+
+    def get_response(extra_options: [])
+      page = 1
+      loop do
+        @win = Window.new(stdscr.maxy - 5, stdscr.maxx, 2, 0)
+        @win.addstr @infoline
+        @win.setpos 2, 0
+        @win.attron A_REVERSE
+        @win.addstr " "*5 + @left_heading + " " * (stdscr.maxx - 5 - 5 - @left_heading.length - @right_heading.length) + @right_heading + " "*5
+        @win.attroff A_REVERSE
+        
+        items_per_page = (@win.maxy - 6) / (@lines_per_item + 1)
+        total_pages = @items.length / items_per_page
+        start_item = items_per_page * (page-1)
+
+        idx = start_item + 1
+	@items[start_item..start_item + items_per_page].each do |item|
+          # figure out which line has the longest right-hand side so we know how much to trim the left so it doesn't interfere
+          longest_rhs = 0
+          item.rows.each do |row|
+            longest_rhs = row.rhs.length if row.rhs.length > longest_rhs
+          end
+          lhs = truncate(item.rows[0].lhs, stdscr.maxx - 6 - longest_rhs - 3)
+          @win.addstr "  #{idx}. #{lhs}" + " "*(stdscr.maxx - 5 - 1 - idx.to_s.length - lhs.length - item.rows[0].rhs.length) + "#{item.rows[0].rhs}\n"
+          if(item.rows.length > 1)
+            item.rows[1..-1].each do |row|
+              lhs = truncate(row.lhs, stdscr.maxx - 9 - longest_rhs - 3)
+              @win.addstr "       #{lhs}" + " "*(stdscr.maxx - 7 - 2 - lhs.length - row.rhs.length) + "#{row.rhs}\n"
+            end
+          end
+          @win.addstr "\n"
+          idx += 1
+        end
+        morepages = page < total_pages ? "More on Next Screen" : "End of List"
+        @win.addstr "\n** #{@items.length} Items UNSORTED - Page #{page} of #{total_pages} - #{morepages} **"
+
+        @win.noutrefresh
+        old_instructions = @screen.inputbar.instructions
+        instructions = []
+        extra_options.each do |key, desc|
+          instructions << "#{key}=#{desc}"
+        end
+        instructions.push "B=Back" if page > 1
+        instructions.push "<Enter>=Next Screen" if page < total_pages
+        @screen.inputbar.instructions = instructions.join(", ")
+        selection = @screen.inputbar.get_string
+        @screen.inputbar.instructions = old_instructions
+        @win.clear
+        @win.noutrefresh
+        @win.close
+        
+        if(selection == "" and page < total_pages)
+          page += 1
+        elsif(selection == "b" or selection == "B" and page > 1)
+          page -= 1
+        elsif(extra_options.keys.include?(selection.upcase) or extra_options.keys.include?(selection.downcase))
+          return selection
+        else
+	  return @items[selection.to_i - 1].key if selection.to_i > 0 and selection.to_i < @items.length + 1
+        end
+      end
+    end
+
+    private
+
+    def truncate(str, len)
+      return str if str.length <= len
+      "#{str[0..len-3]}..."
+    end
+
+  end
+  class InfoItem
+    attr_accessor :key, :rows
+
+    def initialize(key:, rows:)
+      @key = key
+      @rows = rows
+    end
+  end
+
+  class InfoRow
+    attr_accessor :lhs, :rhs
+
+    def initialize(lhs:, rhs:)
+      @lhs = lhs
+      @rhs = rhs
+    end
+
+    def [](idx)
+      return @lhs if idx == 0
+      return @rhs if idx == 1
+
+      nil
+    end
+  end
+end

data/lib/fstui/inputbox.rb

@@ -0,0 +1,22 @@
+module FSTui
+  class InputBox
+    attr_accessor :title
+    def initialize(screen, title, subtitle)
+      @title = title
+      @subtitle = subtitle
+      @screen = screen
+    end
+    
+    def get_entry
+      @win = Window.new(5, stdscr.maxx, stdscr.maxy / 2 - 3, 0)
+      @win.addstr @title.center(@win.maxx)
+      @win.addstr @subtitle.center(@win.maxx) + "\n"
+      
+      @win.refresh
+      @screen.redraw
+      selection = @screen.inputbar.get_string
+      @win.close
+      selection
+    end
+  end
+end

data/lib/fstui/menu.rb

@@ -0,0 +1,53 @@
+module FSTui
+  class Menu
+    attr_accessor :title
+    def initialize(screen, title, subtitle)
+      @title = title
+      @subtitle = subtitle
+      @items = Array.new
+      @screen = screen
+    end
+    
+    def add_item(key, desc)
+      @items.push MenuItem.new(key, desc)
+    end
+    
+    def get_response
+      loop do
+        @win = Window.new(@items.length + 4, stdscr.maxx, 5, 0)
+        @win.clear
+        @win.addstr @title.center(@win.maxx)
+        @win.addstr @subtitle.center(@win.maxx) + "\n"
+      
+        # figure out which item is the longest and center it
+        longest_item = 0
+        @items.each do |item|
+          longest_item = item.desc.length if item.desc.length > longest_item
+        end
+        padding = " " * (@win.maxx / 2 - longest_item / 2)
+      
+        # draw the menu, with the longest item centered and all others left justified with it
+        @items.each_index do |idx| 
+          menu_text = "#{padding}#{idx + 1}. #{@items[idx].desc}\n"
+          @win.addstr menu_text
+        end
+
+        @win.noutrefresh
+        selection = @screen.inputbar.get_selection
+        @win.clear
+        @win.noutrefresh
+        @win.close
+        return @items[selection.to_i - 1].key if(("0".."9").include?(selection) and selection.to_i <= @items.length)
+      end
+    end
+    
+    class MenuItem
+      attr_accessor :key, :desc
+      
+      def initialize(key, desc)
+        @key = key
+        @desc = desc
+      end
+    end
+  end
+end

data/lib/fstui/messagebox.rb

@@ -0,0 +1,25 @@
+module FSTui
+  class MessageBox
+    attr_accessor :title
+    def initialize(screen, title, subtitle)
+      @title = title
+      @subtitle = subtitle
+      @screen = screen
+    end
+    
+    def show
+      @win = Window.new(5, stdscr.maxx, stdscr.maxy / 2 - 3, 0)
+      @win.addstr @title.center(@win.maxx)
+      @win.addstr @subtitle.center(@win.maxx) + "\n"
+      @win.refresh
+      @screen.inputbar.hide
+    end
+    
+    def hide
+      @win.clear
+      @win.refresh
+      @win.close
+      @screen.redraw
+    end
+  end
+end

data/lib/fstui/screen.rb

@@ -0,0 +1,153 @@
+module FSTui
+  class Screen
+    attr_accessor :titlebar, :inputbar
+    
+    def initialize
+      init_screen
+      start_color
+      crmode
+      
+      @titlebar = TitleBar.new(self)
+      @inputbar = InputBar.new(self)
+    end
+    
+    def destroy
+      close_screen
+    end
+    
+    def redraw
+      @titlebar.redraw
+      @inputbar.redraw
+    end
+
+    def new_menu(title, subtitle = "Please select one of the options below.")
+      Menu.new(self, title, subtitle)
+    end
+
+    def new_inputbox(title, subtitle = "Please enter your selection below.")
+      InputBox.new(self, title, subtitle)
+    end
+
+    def new_messagebox(title, subtitle = "")
+      MessageBox.new(self, title, subtitle)
+    end
+
+    def pop_messagebox(title, subtitle = "", timeout = 3)
+      msg = MessageBox.new(self, title, subtitle)
+      msg.show
+      sleep timeout
+      msg.hide
+    end
+
+    def new_infolist(infoline, lines_per_item)
+      InfoList.new(self, infoline, lines_per_item)
+    end
+
+    def new_datascreen(title, subtitle = "", data)
+      DataScreen.new(self, title, subtitle, data)
+    end
+
+    def new_fieldscreen(title, subtitle = "", fields)
+      FieldScreen.new(self, title, subtitle, fields)
+    end
+  end
+
+  class TitleBar
+    def initialize(screen, pad_chars = 2)
+      @win = Window.new(1, stdscr.maxx, 0, 0)
+      @win.attrset A_REVERSE
+      @win.noutrefresh
+      @left = @center = @right = ""
+      @pad_chars = pad_chars
+      redraw
+    end
+
+    def center=(center)
+      @center = center
+      redraw
+    end
+
+    def left=(left)
+      @left = left
+      redraw
+    end
+
+    def right=(right)
+      @right = right
+      redraw
+    end
+
+    def redraw
+      @win.clear
+      @win.addstr (" " * @pad_chars) + @left + @center.center(@win.maxx - (@left.length + @pad_chars) - (@right.length + @pad_chars)) + @right + (" " * @pad_chars)
+      @win.noutrefresh
+    end
+  end
+  
+  class InputBar
+    attr_accessor :prompt, :instructions
+    
+    def initialize(screen, prompt = " Enter your selection(s) and press <Enter> : ", instructions = "")
+      @prompt = prompt
+      @instructions = instructions
+      window_setup
+    end
+
+    def window_setup
+      # TODO: this could use a lot of simplification
+      @promptwin = Window.new(1, @prompt.length, stdscr.maxy - 2, 0)
+      @promptwin.attrset A_REVERSE
+      @entrywin = Window.new(1, stdscr.maxx - @prompt.length, stdscr.maxy - 2, @prompt.length + 1)
+      @instructionwin = Window.new(1, stdscr.maxx, stdscr.maxy-1, 0)
+    end
+    
+    def prompt=(prompt)
+      @prompt = prompt
+      destroy
+      window_setup
+    end
+
+    def destroy
+      @promptwin.close
+      @entrywin.close
+    end
+    
+    def redraw
+      @promptwin.clear
+      @promptwin.addstr @prompt
+      @promptwin.noutrefresh
+      @instructionwin.clear
+      @instructionwin.addstr @instructions
+      @instructionwin.noutrefresh
+    end
+
+    def hide
+      @promptwin.clear
+      @promptwin.noutrefresh
+    end
+    
+    def get_selection(options: nil)
+      while(true) do
+        @entrywin.setpos 0, 0
+        redraw
+        # getch will doupdate() for us as well
+        entry = @entrywin.getch
+        @entrywin.clear
+        @entrywin.noutrefresh
+        entry = :enter if entry == 10 or entry == 13
+        break if options == nil or options.include? entry
+      end
+      entry
+    end
+    
+    def get_string
+      @entrywin.setpos 0, 0
+      redraw
+      # getstr will doupdate() for us as well
+      entry = @entrywin.getstr
+      @entrywin.clear
+      @entrywin.noutrefresh
+      entry
+    end
+  end
+end 

data/lib/fstui/version.rb

@@ -0,0 +1,3 @@
+module FSTui
+  VERSION = '0.5.5'
+end

data/lib/fstui.rb

@@ -0,0 +1,10 @@
+require "curses";
+include Curses
+
+require 'fstui/screen'
+require 'fstui/menu'
+require 'fstui/inputbox'
+require 'fstui/messagebox'
+require 'fstui/infolist'
+require 'fstui/datascreen'
+require 'fstui/fieldscreen'

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: fstui
+version: !ruby/object:Gem::Version
+  version: 0.5.5
+platform: ruby
+authors:
+- sarahemm
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: Full screen text UI library
+email: github@sen.cx
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/fstui.rb
+- lib/fstui/datascreen.rb
+- lib/fstui/fieldscreen.rb
+- lib/fstui/infolist.rb
+- lib/fstui/inputbox.rb
+- lib/fstui/menu.rb
+- lib/fstui/messagebox.rb
+- lib/fstui/screen.rb
+- lib/fstui/version.rb
+homepage: http://github.com/sarahemm/ruby-fstui
+licenses:
+- MIT
+metadata: {}
+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: []
+rubygems_version: 4.0.21
+specification_version: 4
+summary: Full Screen TUI library
+test_files: []