rigel 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a51ebc53ff6ebba1121a65701886f410b87af1d8
+  data.tar.gz: 6ed01de3dfffdecb5b569fdf9d1a6408603b4162
+SHA512:
+  metadata.gz: abf87334becd9461edc9e17df9d2f34db8659cf4949e9d06cf4fe2ced96135a6989d9598a986f7f33bea9b5e9f7b37d717784c0319bf82883ec2ddfc33423913
+  data.tar.gz: 76b39374517db0247a1f805b305e95e62e17e1438f5be858e506f46858f01bc48c9cb92c69a8705f14cc50a3a92b1a71091f5bf1eea15e43ee4090fcafeef9eb

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+*.log
+*.old

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rigel.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 kepler
+
+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,65 @@
+# Rigel
+
+ri browser using ncurses
+(based on `ribhu` which uses rbcurse gem)
+
+Hopes to make your ruby documentation experience faster. This is a two pane application, with
+Classes on the left list, and details on the right.
+You may press Enter on a class to see its documention. Pressing ENTER over a method in the right will
+fetch its details.
+
+M-x gives a Ctrl-P like list displaying classes, and one can filter from them and select just as one does
+with Ctrl-P. Pressing "/" in the classes list, also lets you type in a string to search from.
+
+You may mark classes with an upper case alphabet (vim style by pressing 'm' in the left list) and access them directly using single-quote.
+Several classes have been bookmarked such as Array, String, Hash, File. You may place more in a file named "~/.rigel.conf" in the form:
+
+    $bookmarks[:Z] = "Zlib"
+
+A list of visited classes is also maintained and can be accessed and selected from. You may prepopulate it
+from the conf file as:
+
+    $visited.concat %w{Abbrev GC ARGF}
+
+Pressing Alt-c ('ask-class') and type in any class or method or portion. If `ri` does not return data or returns
+choices, a popup will allows selection of choices. If you have used the Alt-c already, pressing Alt-h inside the ask-class popup will show history of previous searches.
+
+In the right window, pressing Alt-m will allow selection of methods from a popup. Space and ENTER select, use j/k/gg/G for navigation, or 'f' following by a char to go to the first or next method starting with that char. e.g. pressing 'fm' jumps to 'match' for String.
+
+Search through the current window using "/". You may use "Alt-h" to access history (previous searches).
+
+Browser style, one may backspace through earlier results, or use Alt-n and Alt-p  to go back and forth
+between previous and next pages viewed.
+
+Please get back to me if there are cases where it's unhelpful in finding the ridocs.
+
+
+## Installation
+
+    gem install rigel
+
+## Usage
+
+Ensure you have ri documentation working. On the command line you may do, "ri String". You should get documentation for the String class. If not proceed as follows:
+
+To get ri documentation, you would do 
+
+     rvm docs generate-ri
+
+If you use any gems for development, e.g. highline or rbcurse-core, use the `--ri` flag while installing the gem (this assumes you've switched off ri and rdocs in your .gemrc).
+
+This gem depends on rbcurse-core
+
+## Gem name
+
+   The first two letters are for "ri", the name is that of a star.
+
+   https://rubygems.org/gems/rigel
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/rigel

@@ -0,0 +1,493 @@
+#!/usr/bin/env ruby
+
+# NOTE: If the listbox is empty, that could mean that you have not generated
+#  ri documentation for this version of ruby. You can do so by doing:
+#    rvm docs generate-ri 
+#    or 
+#    rvm docs generate
+#  (This assumes you are using rvm)
+#
+# WARNING : IF THIS PROGRAM HANGS check the ri command 
+# Maybe your version of ri has different options and is going interactive.
+# ruby 1.9.3's ri requires a -l option or else if becomes interactive.
+# this program tests out a listbox
+# This is written in the old style where we start and end ncurses and initiate a 
+# getch loop. It gives more control.
+# The new style is to use App which does the ncurses setup and teardown, as well
+# as manages keys. It also takes care of logger and includes major stuff.
+#
+#
+#  TODO: 
+# when pressing enter on left list move focus to right
+require 'logger'
+require 'canis'
+require 'canis/core/widgets/listbox'
+#require 'canis/core/widgets/rtextview'
+#require 'canis/core/include/vieditable'
+require 'shellwords'
+require 'canis/core/widgets/textpad'
+require 'canis/core/util/widgetshortcuts'
+require 'canis/core/util/rcommandwindow'
+require 'rigel'
+
+
+def my_help_text
+    <<-eos
+
+    =========================================================================
+    Basic Usage
+
+    Press <ENTER> on a class name on the first list, to view ri information
+    for it on the right.
+    
+    Tab to right area, and press <ENTER> on a method name, to see its details
+    Press / <slash> in any box to search. e.g /String will take you to the
+    first occurrence of String. <n> will take you to next.
+    
+    To go quickly to first class starting with 'S', type <f> followed by <S>.
+    Then press <n> to go to next match.
+
+    On the right window, you may press BACKSPACE to go back to earlier pages.
+    You may also press Alt-n and Alt-p to cycle through next and previously
+    viewed pages.
+
+    Press Alt-c to enter class or method name and see details. If there is 
+    no data returned, or options returned you may have to select from a list.
+    e.g. entering 'flatten' may return a list of choices to select from.
+    Entering 'Str' returns nothing from ri, so you have to select from classes
+    starting with 'Str'.
+
+    Press Alt-d to get a popup of visited classes, from which you may select.
+
+    Press Alt-b to get a popup of bookmarks, from which you may select.
+
+    Press Alt-m to get a popup of methods for current class, from which you may select.
+
+    '?' displays all key binding for current object. 'Q' and 'C-q' quit.
+    In any popups, try 'C-q' to quit.
+
+    =========================================================================
+    Bookmarks
+
+    Access bookmarks using single-quote as in vim followed by a single character. 
+    Some have been set such as Array, String, Hash, File. To create a bookmark,
+    position cursor over a class in the left list, and press "m". You will be 
+    prompted for the character to use as the mark.
+    
+    =========================================================================
+    Buffers
+
+    Ordinary a textview contains only one buffer. However, the one on the right
+    is extended for multiple buffers. Pressing ENTER on the left on several 
+    rows opens multiple buffers on the right. Use M-n (Alt-N) and M-p to navigate.
+    ALternatively, : maps to a menu, so :n and :p may also be used.
+    <BACKSPACE> will also go to previous buffer, like a browser.
+
+    =========================================================================
+           Press <M-n> for next help screen, or try :n 
+
+    eos
+end
+
+# seems unused now, but may be useful elsewhere
+def convert_man_to_ansi file
+  lines = file.split "\n"
+  l = nil
+  lines.each_with_index do |line, ix|
+    # convert underlined words to yellow or one color, these are usually params
+    line.gsub!(/((_[^ ])+)/,'\1')
+    line.gsub!(/_/,'')
+    # convert bold words to red or one color, these are usually headers and other words
+    l= line.gsub(/(([^ ][^ ])+)/,'\1').gsub(/[^ ]/,'').gsub(//,'')
+    lines[ix] = l
+  end
+  lines
+end
+##
+#  display the ridoc for given word (class or method or part)
+def display_text word
+  raise "word should be string" unless word.is_a? String
+  w = @form.by_name["tv"]; 
+  lines = get_data word
+  #file = `ri -f bs #{word}`
+  #lines = convert_man_to_ansi file
+  return if lines.nil? || lines.size == 0
+  # ansi can have overflow
+  w.add_content(lines, :content_type => :ansi, :title => word)
+
+  # Since i am trying without border, so need to put class on top right
+  header = @form.by_name["header"]; 
+  header.text_right(word)
+
+  $visited << word unless $visited.index(word)
+  #w.add_content(lines, :title => word)
+  w.buffer_last
+end
+## retrieve data in ansi format.
+#  NOTE that ri returns <t>CLEAR</tt> without the 0. So canis-core does not catch that
+#  it expects a zero there. So i've replaced [[m with [[0m.
+#  @param String class or method name to fetch ri info for
+#  @ returns Array of lines, containing ansi format data
+def get_data str
+  lines = `ri -f ansi #{str} 2>&1`.gsub('','').split("\n")
+end
+
+## 
+# prompt user for a class name and show ri doc for same, can be method too
+#
+def ask_classes
+  format="rdoc"
+  str = get_string_with_history("Enter a class name: ")
+  if str && str != ""
+    #lines = `ri -f #{format} #{str}`.split("\n")
+    lines = get_data str
+    if lines.size == 0
+      alert "Nothing came through for #{str}"
+      ## Nothing returned, lets see if we can match something from the class list
+      li = @form.by_name["mylist"]; 
+      values = li.list
+      values = values.grep(/^#{str}/i)
+      if values.size > 0
+        ix = popuplist(values)
+        if ix
+          str = values[ix]
+          #lines = `ri -f #{format} #{str}`.split("\n")
+          lines = get_data str
+        end
+      else
+        alert "Nothing came through for #{str}"
+        $message.value = "Nothing came through for #{str}"
+      end
+    elsif lines.first.index(".#{str} not found")
+      ## we are returned something with some choices, lets prompt user with choices
+      lines.shift
+      lines.shift
+        ix = popuplist(lines)
+        if ix
+          str = lines[ix]
+          #lines = `ri -f #{format} #{str}`.split("\n")
+          lines = get_data str
+        end
+    end
+    return if lines.size == 0
+    w = @form.by_name["tv"]; 
+    w.add_content(lines, :content_type => :ansi, :title => str)
+    #w.add_content(lines, :title => str)
+    w.buffer_last
+    set_focus_on str
+  end
+end
+
+# set focus in list on given string
+def set_focus_on str
+  listb = @form.by_name["mylist"]; 
+  ix = listb.list.index(str)
+  if ix
+    #listb.set_focus_on ix
+    listb.goto_line ix
+  end
+end
+
+## user has pressed bokmark char, now get the mark A-Z
+def ask_bookmark ch=nil
+  unless ch
+    ch = @window.getchar
+    ch = ch.chr.upcase
+  end
+  str = $bookmarks[ch.to_sym]
+  if str
+    display_text str
+    # set focus to that in the left list
+    set_focus_on str
+  else
+    $message.value = "No bookmark for #{ch}. Use m to create."
+    ## No bookmark, jumping to first char 
+    listb = @form.by_name["mylist"]; 
+    listb.set_selection_for_char ch
+  end
+end
+def add_bookmark ch, word
+  $bookmarks[ch.upcase.to_sym] = word
+  alert "set mark for #{ch.upcase.to_sym} for #{word}"
+end
+
+## try various options till you get something.
+#
+def try_ri arr
+  _text = nil
+  arr.each do |w|
+    #_text = `ri -f rdoc #{w} 2>&1`.split("\n")
+    _text = get_data w
+    if _text.first.index("Nothing known about")
+    else
+      break
+    end
+  end
+  _text
+end
+def popup_history
+  return if $visited.size == 0
+  ix = popuplist($visited, :title => " History ", :bgcolor => :black, :color => :white, :row => 1, :col => 1)
+  if ix
+    display_text $visited[ix]
+  end
+end
+#
+# History is accessible using Alt-h while in field, press enter on any row in the popup
+def get_string_with_history prompt
+  $shell_history ||= []
+  cmd = get_string(prompt, :maxlen => 50) do |f|
+    require 'canis/core/include/rhistory'
+    f.extend(FieldHistory)
+    f.history($shell_history)
+  end
+  if cmd && !cmd.empty?
+    $shell_history.push(cmd) unless $shell_history.include? cmd
+  end
+  return cmd
+end
+# switches location of 2 windows 
+# 
+def switch_windows
+  tv = @form.by_name["tv"]
+  list = @form.by_name["mylist"]
+  if tv.col > 0
+    tv.col = 0
+    tmp = tv.width
+    list.col = tmp + 1
+  else
+    list.col = 0
+    tv.col = list.width + 1
+  end
+end
+
+
+include Canis::WidgetShortcuts
+
+#if $0 == __FILE__
+if true
+  include Canis
+
+  begin
+    # Initialize curses
+    Canis::start_ncurses  # this is initializing colors via ColorMap.setup
+
+    $log = create_logger "rigel.log"
+    $visited = []
+    $bookmarks = {
+      :A => "Array",
+      :C => "Class",
+      :D => "Dir",
+      :F => "File",
+      :H => "Hash",
+      :I => "IO",
+      :K => "Kernel",
+      :M => "Module",
+      :O => "OptionParser",
+      :P => "Proc",
+      :S => "String"
+    }
+    config = File.expand_path("~/.rigel.conf")
+    # read up any bookmarks or visited classes, they get added to the existing data
+    if File.exists? config
+      load config
+    end
+
+
+    @window = Canis::Window.root_window
+    colors = Ncurses.COLORS
+    back = :black
+    lineback = :blue
+    back = 234 if colors >= 256
+    lineback = 236 if colors >= 256
+    $window = @window # i need this for get_char, YUCK
+    $catch_alt_digits = true; # emacs like alt-1..9 numeric arguments
+    #install_help_text my_help_text
+    # Initialize few color pairs 
+    # Create the window to be associated with the form 
+    # Un post form and free the memory
+
+    catch(:close) do
+      @form = Form.new @window
+      @form.help_manager.help_text = my_help_text
+      #@form.bind_key(KEY_F1, 'help'){ display_app_help }
+      @form.bind_key(?\M-c, 'select class') do
+        ask_classes
+      end
+      @form.bind_key(FFI::NCurses::KEY_F5, 'switch_windows'){ switch_windows }
+      @form.bind_key(?', 'select bookmark') do
+        ask_bookmark
+      end
+      # Alt-h is taken by scrolling in list and textareas
+      @form.bind_key(?\M-d, 'View history') do
+        popup_history
+      end
+      @form.bind_key(?\M-b, 'View bookmarks') do
+        # Display bookmarks and allow user to select one
+        list = []
+        $bookmarks.each_pair { |k, v| list << "   #[fg=yellow, bold] #{k} #[/end]    #[fg=cyan] #{v} #[/end]" }
+        ch = padpopup list, :title => "View Bookmarks", :row => 1, :col => 1
+        ask_bookmark ch.upcase
+      end
+
+      widget_shortcuts_init
+      header = app_header "0.0.1", :text_center => "ri Documentation Browser", :text_right =>"rigel" , :name => "header" , :color => :white, :bgcolor => lineback , :attr => :bold 
+
+
+
+        #"#[bg=236, fg=black]#[fg=yellow, bold]F1#[/end] Help | #[fg=yellow, bold]?#[/end] Keys | #[fg=yellow, bold]M-c#[/end] Ask | #[fg=yellow, bold]M-d#[/end] History | #[fg=yellow, bold]M-m#[/end] Methods | #[fg=yellow, bold]M-b#[/end] Bookmarks | Q Quit | %20s" % [$message.value]
+        _col = "#[fg=yellow]"
+      $message = Variable.new
+      $message.value = ""
+      @status_line = status_line :row => Ncurses.LINES-1 #, :bgcolor => :red, :color => :yellow
+      @status_line.command {
+        "#[bg=236, fg=black]#{_col}F1#[/end] Help | #{_col}?#[/end] Keys | #{_col}M-x#[/end] Classes | #{_col}M-d#[/end] History | #{_col}M-m#[/end] Methods | #{_col}M-b#[/end] Bookmarks | #{_col}M-c#[/end] Ask | Q Quit | %20s" % [$message.value]
+      }
+
+      h = FFI::NCurses.LINES-2
+      mylist = `ri -l `.split("\n")
+      $classnames = mylist
+      w = 25
+      r = 1
+
+      listb = Listbox.new @form, :name   => "mylist" ,
+        :row  => r ,
+        :col  => 0 ,
+        :width => w,
+        :height => h,
+        :list => mylist,
+        :selection_mode => :SINGLE,
+        :show_selector => true,
+        :suppress_borders => true,
+        :bgcolor => back,
+        :color => :white,
+        :title => " Ruby Classes "
+      #title_attrib 'reverse'
+      #listb.vieditable_init_listbox
+      # what for is Io here
+      #include Io
+      #listb.bind_key(32) {|l| l.scroll_forward };
+      listb.bind(:PRESS) { 
+        ## select class and display riinfo for class
+        #display_text listb.text
+        display_text listb.current_value
+      }
+      listb.bind_key(?m) { 
+        #str = listb.text
+        str = listb.current_value
+        ch = get_string("Enter character as shortcut for #{str}")
+        if ch && ch != ""
+          add_bookmark ch[0], str
+        end
+        ## select class and display riinfo for class
+      }
+      # since keys are added at handle_key, really late, therefore unbind is of no use.
+      listb.bind_key(?', 'select bookmark') do
+        ask_bookmark
+      end
+
+      tv = Canis::TextPad.new @form, :row => r, :col => w+0, :height => h, :width => FFI::NCurses.COLS-w-0,
+        :name => "tv", :title => "Press Enter on Class", :suppress_borders => true
+      tv.set_content ["Press Enter on list to view ri information in this area.", 
+        "Press ENTER on method name to see details"]
+      require 'canis/core/include/multibuffer'
+      tv.extend(Canis::MultiBuffers)
+      #tv.unbind_key([?', ?'])
+      #tv.unbind_key(?')
+      tv.bind_key(?', 'select bookmark') do
+        ask_bookmark
+      end
+
+      # pressing ENTER on a method name will popup details for that method
+      tv.bind(:PRESS) { |ev|
+        w = ev.word_under_cursor.strip
+        # check that user did not hit enter on empty area
+        if w != ""
+          str = "#{tv.title}.#{w}"
+          _text = try_ri(["#{str}", w])
+          tt = tv.title
+          if _text.first.index("Nothing known about")
+          
+            if tt.index("::")
+              ix = tt.index("::")
+              tt = tt[0,ix]
+         
+              _text = get_data "#{tt}::#{w}"
+            end
+          end
+          if _text && _text.size != 0
+            view(_text, :content_type => :ansi)
+            #view(_text)
+          end
+        end
+      }
+      @form.bind_key(?\M-m, "Select methods") {
+        tv = @form.by_name["tv"]; 
+        kl = tv.title.strip
+        if kl.index "."
+          kl = kl.split(".")[0]
+        end
+
+        # 2013-03-21 - 19:50 since the display may be of a selected method
+        # so we requery the methods each time. Can we go to old position somehow ?
+        lines = `ri -f rdoc #{kl} 2>&1`.split("\n")
+        # 2013-03-21 - 19:09 Fixed, had stopped working after change to ansi format
+        #ix = lines.grep(/Instance methods:/)
+        ix = lines.index("= Instance methods:")
+        unless ix
+          alert "No instance methods found for #{kl}"
+        end
+        if ix
+          values = lines[ix+2..-1]
+          values = values.collect { |x| x.strip }
+          #ix = popuplist(values)
+          #ix = popuplist(values, :title => " Methods ", :bgcolor => :blue, :color => :white)
+          # the problem is when the list is longer than indexing values
+          # since we are not doing pagin in this small popup.
+          #
+          # maybe whenever we scroll or page, redo the numbering from a, and keep sta
+          #meth = Rigel::indexed_list("Methods", values)
+          meth = Rigel::ri_full_indexed_list(values, :title => "Methods")
+          if meth
+            meth = meth.strip
+            # 2013-03-23 - 00:33 shell escape required for methods like << & [] etc else error
+            # from shell which messes screen.
+            meth = Shellwords.escape(meth)
+            display_text "#{kl}.#{meth}"
+          end
+        end
+      }
+      @form.bind_key(?\M-x, "Select classes"){
+        # TODO : this is case sensitive and uses contiguous, we need fuzzy
+        command = Proc.new {|str| $classnames.select do |line| line =~ /#{str}/i ; end }
+        # fuzzy but can be quite a pain since i am not prioritizing in any way
+        #command = Proc.new {|str| patt = str.split("").join(".*"); $classnames.select do |line| line =~ /#{patt}/i ; end }
+        str = display_list $classnames, :title => "Select a class", :command => command
+        if str
+          display_text str
+          set_focus_on str
+        end
+      }
+
+      @form.repaint
+      @window.wrefresh
+      Ncurses::Panel.update_panels
+      while((ch = @window.getchar()) != KEY_F10 )
+        break if ch == ?Q.ord || ch == ?\C-q.getbyte(0)
+        @form.handle_key(ch)
+        @window.wrefresh
+      end
+    end
+  rescue => ex
+    textdialog ["Error in rigel: #{ex} ", *ex.backtrace], :title => "Exception"
+    $log.debug( ex) if ex
+    $log.debug(ex.backtrace.join("\n")) if ex
+  ensure
+    @window.destroy if !@window.nil?
+    Canis::stop_ncurses
+    p ex if ex
+    p(ex.backtrace.join("\n")) if ex
+  end
+  else
+    puts "Error #{$0}, #{__FILE__}"
+end

data/lib/rigel.rb

@@ -0,0 +1,587 @@
+#require "rigel/version"
+
+module Rigel
+  extend self
+# i had put this inside module but was unable to access it from bin/rigel
+  ## COPIED FROM CYGNUS
+  #
+  # pad version of original popuplist
+  # Not used in cygnus, so will require testing if used from elsewhere
+  # Is meant to replace the original popuplist soon since the original list
+  # and other classes have too much work giong on in repaint.
+  # Single selection, selection is with ENTER key, SPACE scrolls
+  # @param Array values to be displayed
+  # @param Hash configuration settings such as row, col, width, height etc
+  # @return int - index in list if selected, nil if C-q pressed
+  def padpopuplist list, config={}, &block
+    raise ArgumentError, "Nil list received by popuplist" unless list
+
+    max_visible_items = config[:max_visible_items]
+    row = config[:row] || 5
+    col = config[:col] || 5
+    relative_to = config[:relative_to]
+    if relative_to
+      layout = relative_to.form.window.layout
+      row += layout[:top]
+      col += layout[:left]
+    end
+    config.delete :relative_to
+    longest = list.max_by(&:length)
+    width = config[:width] || longest.size()+2 # borders take 2
+    if config[:title]
+      width = config[:title].size + 2 if width < config[:title].size
+    end
+    height = config[:height]
+    height ||= [max_visible_items || 10+2, list.length+2].min 
+    #layout(1+height, width+4, row, col) 
+    layout = { :height => 0+height, :width => 0+width, :top => row, :left => col } 
+    window = Canis::Window.new(layout)
+    form = Canis::Form.new window
+
+    listconfig = config[:listconfig] || {}
+    listconfig[:list] = list
+    listconfig[:width] = width
+    listconfig[:height] = height
+    #listconfig[:selection_mode] ||= :single
+    listconfig.merge!(config)
+    listconfig.delete(:row); 
+    listconfig.delete(:col); 
+    # trying to pass populists block to listbox
+    #lb = Canis::List.new form, listconfig, &block
+    lb = Canis::TextPad.new form, listconfig, &block
+    #lb = Cygnus::TextPad.new form, :height => height, :width => width, :row => 0, :col => 0 , :title => "A title", :name => "popup"
+    lb.text(list)
+    #
+    #window.bkgd(Ncurses.COLOR_PAIR($reversecolor));
+    form.repaint
+    Ncurses::Panel.update_panels
+    begin
+      while((ch = window.getchar()) != 999 )
+        case ch
+        when ?\C-q.getbyte(0)
+          break
+        else
+          lb.handle_key ch
+          form.repaint
+          if ch == 13 || ch == 10
+            return lb.current_index #if lb.selection_mode != :multiple
+          end
+          #yield ch if block_given?
+        end
+      end
+    ensure
+      window.destroy  
+    end
+    return nil
+  end
+
+
+  ## 
+  # Menu creator which displays a menu and executes methods based on keys.
+  # In some cases, we call this and then do a case statement on either key or binding.
+  #   Call this with care if you do not intend values to be executed. Maybe that was a bad
+  #   idea to club execution with display.
+  # @param String title
+  # @param hash of keys and methods to call
+  # @return key pressed, and binding (if found, and responded)
+  #
+  def menu title, hash, config={}, &block
+    raise ArgumentError, "Nil hash received by menu" unless hash
+    list = []
+    hash.each_pair { |k, v| list << "   #[fg=yellow, bold] #{k} #[/end]    #[fg=green] #{v} #[/end]" }
+    #  s="#[fg=green]hello there#[fg=yellow, bg=black, dim]"
+    config[:title] = title
+    ch = padpopup list, config, &block
+    return unless ch
+    if ch.size > 1
+      # could be a string due to pressing enter
+      # but what if we format into multiple columns
+      ch = ch.strip[0]
+    end
+
+    binding = hash[ch]
+    binding = hash[ch.to_sym] unless binding
+    if binding
+      if respond_to?(binding, true)
+        send(binding)
+      end
+    end
+    return ch, binding
+  end
+
+  # pops up a list, taking a single key and returning if it is in range of 33 and 126
+  # Called by menu, print_help, show_marks etc
+  # You may pass valid chars or ints so it only returns on pressing those.
+  #
+  # @param Array of lines to print which may be formatted using :tmux format
+  # @return character pressed (ch.chr)
+  # @return nil if escape or C-q pressed
+  #
+  def padpopup list, config={}, &block
+    max_visible_items = config[:max_visible_items]
+    row = config[:row] || 5
+    col = config[:col] || 5
+    # format options are :ansi :tmux :none
+    fmt = config[:format] || :tmux
+    config.delete :format
+    relative_to = config[:relative_to]
+    if relative_to
+      layout = relative_to.form.window.layout
+      row += layout[:top]
+      col += layout[:left]
+    end
+    config.delete :relative_to
+    # still has the formatting in the string so length is wrong.
+    #longest = list.max_by(&:length)
+    width = config[:width] || 60
+    if config[:title]
+      width = config[:title].size + 2 if width < config[:title].size
+    end
+    height = config[:height]
+    height ||= [max_visible_items || 25, list.length+2].min 
+    #layout(1+height, width+4, row, col) 
+    layout = { :height => 0+height, :width => 0+width, :top => row, :left => col } 
+    window = Canis::Window.new(layout)
+    form = Canis::Form.new window
+
+    ## added 2013-03-13 - 18:07 so caller can be more specific on what is to be returned
+    valid_keys_int = config.delete :valid_keys_int
+    valid_keys_char = config.delete :valid_keys_char
+
+    listconfig = config[:listconfig] || {}
+    #listconfig[:list] = list
+    listconfig[:width] = width
+    listconfig[:height] = height
+    #listconfig[:selection_mode] ||= :single
+    listconfig.merge!(config)
+    listconfig.delete(:row); 
+    listconfig.delete(:col); 
+    # trying to pass populists block to listbox
+    lb = Canis::TextPad.new form, listconfig, &block
+    if fmt == :none
+      lb.text(list)
+    else
+      lb.text(list, fmt)
+    end
+    #
+    #window.bkgd(Ncurses.COLOR_PAIR($reversecolor));
+    form.repaint
+    Ncurses::Panel.update_panels
+    if valid_keys_int.nil? && valid_keys_char.nil?
+      # changed 32 to 33 so space can scroll list
+      valid_keys_int = (33..126)
+    end
+
+    begin
+      while((ch = window.getchar()) != 999 )
+
+        # if a char range or array has been sent, check if the key is in it and send back
+        # else just stay here
+        if valid_keys_char
+          if ch > 32 && ch < 127
+            chr = ch.chr
+            return chr if valid_keys_char.include? chr
+          end
+        end
+
+        # if the user specified an array or range of ints check against that
+        # therwise use the range of 33 .. 126
+        return ch.chr if valid_keys_int.include? ch
+
+        case ch
+        when ?\C-q.getbyte(0)
+          break
+        else
+          if ch == 13 || ch == 10
+            s = lb.current_value.to_s # .strip #if lb.selection_mode != :multiple
+            return s
+          end
+          # close if escape or double escape
+          if ch == 27 || ch == 2727
+            return nil
+          end
+          lb.handle_key ch
+          form.repaint
+        end
+      end
+    ensure
+      window.destroy  
+    end
+    return nil
+  end
+
+  # indexes and returns indexed and colored version of list using alpha as indexes
+  # See $IDX and get_shortcut for index details
+  # @param Array a list of values to index which will then be displayed using a padpopup
+  # @returns Array formatted and indexed list
+  def index_this_list list
+    alist = []
+    list.each_with_index { |v, ix| 
+      k = get_shortcut ix
+      alist << " #[fg=yellow, bold] #{k.ljust(2)} #[end] #[fg=green]#{v}#[end]" 
+      # above gets truncated by columnate and results in errors in colorparsers etc
+      #alist << " #{k} #{v}" 
+    }
+    return alist
+  end
+
+  $IDX=('a'..'y').to_a
+  $IDX.concat ('za'..'zz').to_a
+  $IDX.concat ('Za'..'Zz').to_a
+  $IDX.concat ('ZA'..'ZZ').to_a
+
+  # a general function that creates a popup list after indexing the current list,
+  # takes a key and returns the value from the list that was selected, or nil if the 
+  # value was invalid.
+  # Called by show_list (cygnus gem) which is in turn called by several methods.
+  #
+  def indexed_list title, list, config={}, &block
+    raise ArgumentError, "Nil list received by indexed_list" unless list
+    $stact = 0
+    alist = index_this_list list
+    longest = list.max_by(&:length)
+    #  s="#[fg=green]hello there#[fg=yellow, bg=black, dim]"
+    config[:title] = title
+    # if width is greater than size of screen then padfresh will return -1 and nothing will print
+    config[:width] = [ longest.size() + 10, FFI::NCurses.COLS - 1 ].min
+    config[:row] = config[:col] = 0
+    ch = padpopup alist, config, &block
+    return unless ch
+    if ch.size > 1
+      # could be a string due to pressing enter
+      # but what if we format into multiple columns
+      ch = ch.strip[0]
+    end
+    # we are checking this AFTER the popup has returned, what window will be used ?
+    ch = get_index ch
+    return nil unless ch
+
+    return list[ch]
+  end
+  # print in columns
+  # ary - array of data
+  # sz  - lines in one column
+  # This is the original which did not format or color, but since we cannot truncate unless
+  # we have unformatted data i need to mix the functionality into columnate_with_indexing
+  # Called by print_help, this is generic and can be used as a common func
+
+  def columnate ary, sz
+    buff=Array.new
+    return buff if ary.nil? || ary.size == 0
+
+    # ix refers to the index in the complete file list, wherease we only show 60 at a time
+    ix=0
+    while true
+      ## ctr refers to the index in the column
+      ctr=0
+      while ctr < sz
+
+        f = ary[ix]
+        # deleted truncate and pad part since we expect cols to be sized same
+
+        if buff[ctr]
+          buff[ctr] += f
+        else
+          buff[ctr] = f
+        end
+
+        ctr+=1
+        ix+=1
+        break if ix >= ary.size
+      end
+      break if ix >= ary.size
+    end
+    return buff
+  end
+  def pbold text
+    #puts "#{BOLD}#{text}#{BOLD_OFF}"
+    get_single text, :color_pair => $reversecolor
+  end
+  def perror text
+    ##puts "#{RED}#{text}#{CLEAR}"
+    #get_char
+    #alert text
+    get_single text + "  Press a key...", :color_pair => $errorcolor
+  end
+  def pause text=" Press a key ..."
+    get_single text
+    #get_char
+  end
+  ## return shortcut for an index (offset in file array)
+  # use 2 more arrays to make this faster
+  #  if z or Z take another key if there are those many in view
+  #  Also, display ROWS * COLS so now we are not limited to 60.
+  def get_shortcut ix
+    return "<" if ix < $stact
+    ix -= $stact
+    i = $IDX[ix]
+    return i if i
+    return "->"
+  end
+  ## returns the integer offset in view (file array based on a-y za-zz and Za - Zz
+  # Called when user types a key
+  #  should we even ask for a second key if there are not enough rows
+  #  What if we want to also trap z with numbers for other purposes
+  def get_index key, vsz=999
+    i = $IDX.index(key)
+    return i+$stact if i
+    #sz = $IDX.size
+    zch = nil
+    if vsz > 25
+      if key == "z" || key == "Z"
+        #print key
+        zch = get_char
+        #print zch
+        i = $IDX.index("#{key}#{zch}")
+        return i+$stact if i
+      end
+    end
+    return nil
+  end
+  ## I thin we need to make this like the command line one TODO
+  def get_char
+    w = @window || $window
+    c = w.getchar
+    case c
+    when 13,10
+      return "ENTER"
+    when 32
+      return "SPACE"
+    when 127
+      return "BACKSPACE"
+    when 27
+      return "ESCAPE"
+    end
+    keycode_tos c
+    #  if c > 32 && c < 127
+    #return c.chr
+    #end
+    ## use keycode_tos from Utils.
+  end
+  ##
+  # prints a prompt at bottom of screen, takes a character and returns textual representation
+  # of character (as per get_char) and not the int that window.getchar returns.
+  # It uses a window, so underlying text is not touched.
+  #
+  def get_single text, config={}
+    w = one_line_window
+    x = y = 0
+    color = config[:color_pair] || $datacolor
+    color=Ncurses.COLOR_PAIR(color);
+    w.attron(color);
+    w.mvprintw(x, y, "%s" % text);
+    w.attroff(color);
+    w.wrefresh
+    Ncurses::Panel.update_panels
+    chr = get_char
+    w.destroy
+    w = nil 
+    return chr
+  end
+
+  ##
+  # identical to get_string but does not show as a popup with buttons, just ENTER
+  # This is required if there are multiple inputs required and having several get_strings
+  # one after the other seems really odd due to multiple popups
+  # Unlike, get_string this does not return a nil if C-c pressed. Either returns a string if 
+  # ENTER pressed or a blank if C-c or Double Escape. So only blank to be checked
+  # TODO up arrow can access history
+  def get_line text, config={}
+    begin
+      w = one_line_window
+      form = Canis::Form.new w
+      config[:label] = text
+      config[:row] = 0
+      config[:col] = 1
+
+      #f = Field.new form, :label => text, :row => 0, :col => 1
+      f = Field.new form, config
+      form.repaint
+      w.wrefresh
+      while((ch = w.getchar()) != FFI::NCurses::KEY_F10 )
+        break if ch == 13
+        if ch == 3 || ch == 27 || ch == 2727
+          return ""
+        end
+        begin
+          form.handle_key(ch)
+          w.wrefresh
+        rescue => err
+          $log.debug( err) if err
+          $log.debug(err.backtrace.join("\n")) if err
+          textdialog ["Error in Messagebox: #{err} ", *err.backtrace], :title => "Exception"
+          w.refresh # otherwise the window keeps showing (new FFI-ncurses issue)
+          $error_message.value = ""
+        ensure
+        end
+      end # while loop
+
+    ensure
+      w.destroy
+      w = nil 
+    end
+    return f.text
+  end
+  def ask prompt, dt=nil
+    return get_line prompt
+  end
+  ##
+  # justify or pad list with spaces so we can columnate, uses longest item to determine size
+  # @param list to pad
+  # @return list padded with spaces
+  def padup_list list
+    longest = list.max_by(&:length)
+    llen = longest.size
+    alist = list.collect { |x|
+      x.ljust(llen)
+    }
+    alist
+  end
+
+
+  # pops up a list, taking a single key and returning if it is in range of 33 and 126
+  # This is a specialized method and overrides textpads keys and behavior
+  #
+  def ri_full_indexed_list list, config={}, &block
+    config[:row] ||= 0
+    config[:col] ||= 0
+    config[:width] ||= FFI::NCurses.COLS - config[:col]
+    width = config[:width]
+    if config[:title]
+      width = config[:title].size + 2 if width < config[:title].size
+    end
+    height = config[:height]
+    #height ||= [max_visible_items || 25, list.length+2].min 
+    height ||= FFI::NCurses.LINES - config[:row]
+    config[:height] = height
+    config[:name] = "fil"
+    row = config[:row]
+    col = config[:col]
+    #layout(1+height, width+4, row, col) 
+    layout = { :height => 0+height, :width => 0+width, :top => row, :left => col } 
+    window = Canis::Window.new(layout)
+    form = Canis::Form.new window
+
+
+    #config[:suppress_border] = true
+    lb = Canis::TextPad.new form, config, &block
+    grows = lb.rows
+    gviscols ||= 3
+    pagesize = grows * gviscols
+    files = list
+    patt = nil
+    view = nil
+    sta = cursor = 0
+    $stact = 0 # to prevent crash
+    ignorecase = true
+
+    while true
+      break if $quitting
+      if patt
+        if ignorecase
+          view = files.grep(/#{patt}/i)
+        else
+          view = files.grep(/#{patt}/)
+        end
+      else 
+        view = files
+      end
+      fl=view.size
+      sta = 0 if sta < 0
+      cursor = fl -1 if cursor >= fl
+      cursor = 0 if cursor < 0
+      sta = calc_sta pagesize, cursor
+      $log.debug "XXX:   sta is #{sta}, size is #{fl}"
+      viewport = view[sta, pagesize]
+      fin = sta + viewport.size
+      #alist = columnate_with_indexing viewport, grows
+      viewport = padup_list viewport
+      viewport = index_this_list viewport
+      alist = columnate viewport, grows
+      lb.text(alist, :tmux)
+      # we need to show the next 1 to n of n for long lists
+      #@header.text_right "#{$sta+1} to #{fin} of #{fl}"
+      #
+      form.repaint
+      Ncurses::Panel.update_panels
+
+      begin
+        
+        ch = window.getchar()
+
+        # if a char range or array has been sent, check if the key is in it and send back
+        # else just stay here
+        #if ( ( ch >= ?a.ord && ch <= ?z.ord ) || ( ch >= ?A.ord && ch <= ?Z.ord ) )
+        if ( ( ch >= ?a.ord && ch <= ?z.ord ) || ( ch == ?Z.ord ) )
+         
+          chr = ch.chr
+          
+          chr = get_index chr, viewport.size
+          # viewport has indexed data
+          #viewport = view[sta, pagesize]
+          return view[sta+chr] if chr
+          next
+        end
+
+
+        case ch
+        when 32, "SPACE", ?\M-n.getbyte(0)
+          #next_page
+          sta += pagesize
+          cursor = sta if cursor < sta
+          next
+        when ?\M-p.getbyte(0)
+          # prev page
+          sta -= pagesize
+          cursor = sta
+          next
+        when ?/.getbyte(0)
+          # filter data on regex
+          patt = get_line "Enter pattern: "
+          next
+        when ?\C-q.getbyte(0)
+          return nil
+        else
+          # close if escape or double escape or C-c
+          if ch == 27 || ch == 2727 || ch == 3
+            # this just closes the app ! since my finger remains on Ctrl which is Escape
+            return nil
+          end
+          # lets check our own bindings so textpad doesn't take over
+          # Either that or check form's first
+          # but this way we can just reuse from cetus
+          #retval = c_process_key ch
+          #next if retval
+
+          retval = form.handle_key ch #if retval == :UNHANDLED
+          next if retval != :UNHANDLED
+          $log.debug "XXXX form returned #{retval} for #{ch}"
+          #alert "got key before lb.handle #{ch.chr}"
+          retval = lb.handle_key ch  if retval.nil? || retval == :UNHANDLED
+          #          if retval == :UNHANDLED
+          #alert "got key in unhdnalde lb.handle #{ch}, #{retval}"
+          $log.debug "XXXX textpad returned #{retval} for #{ch}"
+        end
+
+        form.repaint
+        #end # while getchar
+      end
+    end # while true
+    return nil
+  ensure
+    window.destroy 
+  end
+  ##
+  # calculate start of display based on current position
+  # This is the value 'sta' should have (starting index)
+  # @param int pagesize : number of items on one page
+  # @param int cur : current cursor position
+  # @return int : position where 'sta' should be
+  def calc_sta pagesize, cur
+    pages = (cur * 1.001 / pagesize).ceil
+    pages -= 1 if pages > 0
+    return pages * pagesize
+  end
+
+end  # module
+include Rigel

data/lib/rigel/version.rb

@@ -0,0 +1,3 @@
+module Rigel
+  VERSION = "0.0.2"
+end

data/rigel.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rigel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rigel"
+  spec.version       = Rigel::VERSION
+  spec.authors       = ["kepler"]
+  spec.email         = ["githubkepler.50@gishpuppy.com"]
+  spec.summary       = %q{ruby documentation browser in terminal (text/ncurses)}
+  spec.description   = %q{Ruby documentation (ri) browser in text terminals using ncurses}
+  spec.homepage      = "https://github.com/mare-imbrium/rigel"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", ">= 0.9.6"
+  spec.add_runtime_dependency "canis", ">= 0.0.3", ">= 0.0.3"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: rigel
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- kepler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: canis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+description: Ruby documentation (ri) browser in text terminals using ncurses
+email:
+- githubkepler.50@gishpuppy.com
+executables:
+- rigel
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/rigel
+- lib/rigel.rb
+- lib/rigel/version.rb
+- rigel.gemspec
+homepage: https://github.com/mare-imbrium/rigel
+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.2.2
+signing_key: 
+specification_version: 4
+summary: ruby documentation browser in terminal (text/ncurses)
+test_files: []