ppcurses 0.0.25 → 0.1.0

data/lib/ppcurses/date/meta_month.rb

@@ -0,0 +1,139 @@
+
+def group(xs, n)
+    (0..xs.size / n - 1).collect { |i| xs[i * n, n] }     #  / This comment fixes a Visual Studio Code highlighting bug
+end
+
+# --------------------------------------------------------------------------
+# This algorithm is based on ref/cal.rb by Tadayoshi Funaba
+#
+# Differences:
+# - Only supports a monthly calendar type; no yearly calendar.
+#
+# - Returns a secondary day position array that specifies the row 
+#     and column for each day of the month. Useful for highlighting a
+#     specific day. 
+#
+#     Example day position array for May 2015.  The 1st of February
+#     occurs in the second row and the 16th column of the returned
+#     string calendar array
+#
+#     day_pos = [ nil, [2,16], [2,19], 
+#                  [3,1], [3,4], [3,7], [3,10], [3,13], [3,16], [3,19],
+#                  [4,0], [4,3], [4,6], [4,9],  [4,12], [4,15], [4,18],
+#                  [5,0], [5,3], [5,6], [5,9],  [5,12], [5,15], [5,18],
+#                  [6,0], [6,3], [6,6], [6,9],  [6,12], [6,15], [6,18],
+#                  [7,0] ]
+#
+#
+# - Takes a Date object as initial parameter
+#
+# - K variable eliminated
+#
+# - Does not support the transformation option
+#
+#
+def pict(day)
+
+  year = day.year
+  month = day.month
+
+  dw = 2                    # Day width
+  mw = (dw + 1) * 7 - 1     # Month width
+  day_pos = [ nil ]         # Create an array indexed by 1 by putting nil in slot zero.
+  
+  # First day of the month e.g. 2015-05-01
+  fi = Date.new(year, month, 1, Date::GREGORIAN) 
+  # Go backwards to the earliest closest day divisible by 7 date, e.g. 2015-04-26, 
+  # using the Julian day number and modulus.    
+  fi -= (fi.jd + 1) % 7                              
+    
+  ve  = (fi..fi +  6).collect{ |cu|
+    %w(S M Tu W Th F S)[cu.wday]
+  }
+  
+  row = 1
+  pos = -1  
+  # Creates an array of values ["S", " M", ... "31"]
+  ve += (fi..fi + 41).collect{ |cu|  # of type Date
+     
+    pos += 1 # Needed for meta info
+    if (cu.jd + 1) % 7 == 0 then 
+        row += 1
+        pos = 0 
+    end 
+         
+    if cu.mon == month then
+       
+      # -------- Save meta information in day_pos array    
+      i = pos * 3
+      if cu.mday < 10 then i += 1 end  
+     
+      day_pos.push [row, i]             
+      # ---------  End Meta info ------------------
+       
+      cu.mday  
+    end.to_s
+    
+  }
+  
+  # adds padding based on day width  "1"  --> " 1"
+  ve = ve.collect{|e| e.rjust(dw)}                              
+
+  # Creates an array of arrays.  7 for the days in the week  
+  gr = group(ve, 7)    
+  
+  # Converts inner arrays to strings                                     
+  ta = gr.collect{|xs| xs.join(' ')}                            
+
+  # Adds month/year header to top 
+  ca = %w(January February March April May June July
+	        August September October November December)[month - 1]
+  ca = ca + ' ' + year.to_s 
+  ca = ca.center(mw)    
+  ta.unshift(ca)                                                
+
+  return ta, day_pos                   
+end
+
+
+
+module PPCurses
+
+
+  # A container object that holds:
+  #
+  # - A date object
+  # - The month the day belongs to in string array format
+  # - The row and column position of the date in the string array
+  #
+  # This container is used for displaying dates in the datepicker.
+  # The row and column position are necessary so that the day
+  # selected can be highlighted.
+  #
+  class MetaMonth
+  
+    attr_accessor :day
+    attr_accessor :month_str_array    
+    attr_accessor :day_pos
+ 
+    def initialize(day=Date.today)    
+      self.day = day    
+    end
+  
+    def day=(new_day)
+      @day = new_day 
+      @month_str_array, @day_pos = pict(@day)
+    end
+  
+    def day_row
+      @day_pos[ @day.day ][0]
+    end
+    
+    def day_col
+      @day_pos[ @day.day ][1]
+    end
+  
+  end
+
+
+end

data/lib/ppcurses/form/button.rb

@@ -0,0 +1,120 @@
+module PPCurses
+
+  class Button < View
+
+    attr_accessor :label
+    attr_accessor :selected
+    attr_accessor :pushed
+
+    attr_accessor :action
+
+    def initialize(label)
+      @label = label
+      @selected = false
+      @pushed = false
+    end
+
+    #
+    # Screen should be of type Curses::Window
+    #
+    def show(screen)
+      screen.attron(Curses::A_REVERSE) if @selected
+      screen.addstr("< #{@label} >")
+      screen.attroff(Curses::A_REVERSE) if @selected
+    end
+
+    def width
+      @label.length + 4
+    end
+
+    def height
+      1
+    end
+
+    def set_curs_pos(screen)
+      Curses.curs_set(INVISIBLE)
+    end
+
+    def key_down( key )
+
+      if key == ENTER
+        @action.call unless action.nil?
+      end
+
+    end
+
+  end
+
+
+
+
+  # For grouping two buttons together, i.e. SUBMIT/CANCEL
+  class ButtonPair < View
+
+    attr_accessor :selected
+    attr_accessor :selected_element
+
+    attr_reader :button1
+    attr_reader :button2
+
+    def initialize(button1_label, button2_label)
+      @button1 = Button.new(button1_label)
+      @button2 = Button.new(button2_label)
+
+      @selected_button = @button1
+
+      @selected = false
+    end
+
+    def selected=(val)
+      @selected_button.selected = val
+      @selected=val
+    end
+
+    def height
+      1
+    end
+
+    def set_curs_pos(screen)
+      Curses.curs_set(INVISIBLE)
+    end
+
+    def key_down( key )
+      if key == KEY_RIGHT or key == KEY_LEFT
+        @selected_button.selected=false
+
+        if @selected_button == @button1
+          @selected_button = @button2
+        else
+          @selected_button = @button1
+        end
+
+        @selected_button.selected=true
+        return
+      end
+
+      @selected_button.key_down(key)
+
+    end
+
+    def show(screen)
+
+      p = screen.cur_point
+      p.y+=1
+      screen.set_pos_by_point(p)
+
+
+      @button1.show(screen)
+
+      p.x += @button1.width + 2
+      screen.set_pos_by_point(p)
+
+      @button2.show(screen)
+
+    end
+
+  end
+
+
+
+end

data/lib/ppcurses/form/combo_box.rb

@@ -0,0 +1,93 @@
+# -*- encoding : utf-8 -*-
+
+module PPCurses
+
+  class ComboBox < View
+
+    DOWN_ARROW = '∇'
+
+    # Does the element have focus in the form?
+    attr_accessor :selected
+
+
+    def initialize(label, options)
+      @label = label
+      @options = options
+
+      @display_width = 13
+      @choice_made = false
+
+      @options.each do |option|
+        if option.length > @display_width
+          @display_width = option.length
+        end
+      end
+
+    end
+
+    def show(screen)
+      screen.attron(A_REVERSE) if @selected
+      screen.addstr("#{@label}:")
+
+      @combo_display_point = screen.cur_point
+
+      screen.attroff(A_REVERSE) if @selected
+
+      screen.addstr(display_string)
+    end
+
+    def height
+      1
+    end
+
+    def set_curs_pos(screen)
+      screen.curs_set(INVISIBLE)
+    end
+
+    # Return Value
+    # The object in the receiver's internal item list corresponding to the last item selected
+    # from the pop-up list, or nil if no item is selected.
+    def object_value_of_selected_item
+      if  @options_menu.nil?
+        return nil
+      end
+
+      @options[@options_menu.selection]
+    end
+
+    def key_down(key)
+
+      if key == ENTER
+
+        if  @options_menu.nil?
+          @options_menu = PPCurses::ChoiceMenu.new( @options )
+        end
+
+        @options_menu.set_origin(@combo_display_point)
+
+        @options_menu.show
+        @options_menu.menu_selection
+
+        if @options_menu.pressed_enter
+          @choice_made = true
+        end
+
+      end
+
+    end
+
+    #------------------------------------------------
+    protected
+    def display_string
+      if @choice_made
+        return ' '+ "#{@options[@options_menu.selection].center(@display_width,'-')} #{DOWN_ARROW}"
+      end
+
+      ' ' + ' select '.center(@display_width,'-') + " #{DOWN_ARROW}"
+    end
+
+
+
+  end
+
+end

data/lib/ppcurses/form/date_picker.rb

@@ -0,0 +1,86 @@
+# -*- encoding : utf-8 -*-
+
+module PPCurses
+
+
+  # Ruby date objects are immutable
+  # ---------------------------------
+  # 09-15-1950
+  # 05-04-2015 = May 4th 2015
+  class DatePicker < View
+
+    DOWN_ARROW = '∇'
+
+    # Does the element have focus in the form?
+    attr_accessor :selected
+
+
+    def initialize(label, initial_date = Date.today)
+      @label = label
+      @display_width = 13
+      @date = initial_date      
+    end
+    
+
+    def show(screen)
+      screen.attron(A_REVERSE) if @selected
+      screen.addstr("#{@label}:")
+
+      @combo_display_point = screen.cur_point
+
+      screen.attroff(A_REVERSE) if @selected
+
+      screen.addstr(display_string)
+    end
+
+    def height
+      1
+    end
+
+    def set_curs_pos(screen)
+      screen.curs_set(INVISIBLE)
+    end
+
+    # Return Value
+    # The object in the receiver's internal item list corresponding to the last item selected
+    # from the pop-up list, or nil if no item is selected.
+    def object_value_of_selected_item
+      if  @options_menu.nil?
+        return nil
+      end
+
+      @options[@options_menu.selection]
+    end
+
+    def key_down(key)
+
+      if key == ENTER
+        
+        if  @date_menu.nil?         
+          @date_menu = PPCurses::DateMenu.new(@date)
+        end
+
+        @date_menu.set_origin(@combo_display_point)
+
+        @date_menu.show
+        @date_menu.menu_selection
+
+        if @date_menu.pressed_enter
+          @date = @date_menu.day
+        end
+
+      end
+
+    end
+
+    #------------------------------------------------
+    protected
+    def display_string
+      " #{@date.month}-#{@date.day}-#{@date.year} #{DOWN_ARROW}"
+    end
+
+
+
+  end
+
+end

data/lib/ppcurses/form/form.rb

@@ -0,0 +1,96 @@
+module PPCurses
+
+  class Form < View
+
+    attr_accessor :selected_element
+
+    #
+    # Screen should be of type Curses::Window
+    #
+    def initialize
+      @elements = []
+    end
+
+    # Formal protocol required
+    # Adds an element to the form.  Elements are rendered in the order they are added.
+    #
+    # An element must implement the following protocol:
+    #
+    # - def show(screen)
+    # - def height
+    # - def set_curs_pos(screen)
+    # - def key_down(key)
+    # - def selected=
+    #
+    def add (element)
+      PPCurses.implements_protocol( element, %w(show height set_curs_pos key_down selected=))
+      @elements.push(element)
+
+      if  @selected_element.nil?
+        set_selected_element(@elements[0])
+      end
+
+    end
+
+
+    def submitted?
+      @button_pair.button1.pushed
+    end
+
+
+    def key_down( key )
+
+      if key == KEY_UP or key == KEY_DOWN or key == TAB
+        selected_index = @elements.index(@selected_element)
+        n_choices = @elements.length
+
+        if key == KEY_DOWN or key == TAB
+          (selected_index == n_choices-1) ? next_selection = 0 : next_selection = selected_index + 1
+        else
+          (selected_index == 0) ? next_selection = n_choices - 1 : next_selection =  selected_index - 1
+        end
+
+        set_selected_element(@elements[next_selection])
+        return
+      end
+
+      @selected_element.key_down(key)
+
+    end
+
+
+    # TODO -- call display of subview???
+    def display(screen)
+      y = 1
+      x = 1
+
+      for i in 0..@elements.length - 1
+        element = @elements[i]
+        screen.setpos(y, x)
+        element.show(screen)
+        y += element.height
+      end
+
+
+      @selected_element.set_curs_pos(screen) unless @selected_element.nil?
+    end
+
+    # --------------------------------------------------------------------------------
+    protected
+
+
+
+    def set_selected_element(new_element)
+
+      unless @selected_element.nil?
+        @selected_element.selected=false
+      end
+
+      @selected_element = new_element
+      @selected_element.selected=true
+
+    end
+
+  end
+
+end

data/lib/ppcurses/form/input_element.rb

@@ -0,0 +1,189 @@
+module PPCurses
+
+  class InputElement < View
+
+    attr_accessor :label
+    attr_accessor :value
+    attr_accessor :size
+    attr_accessor :selected
+
+    attr_accessor :filter
+
+    attr_accessor :value_start_point
+
+
+    # Stores the X location of the cursor relative to the
+    # value being displayed.  If the cursor is in
+    # the middle of the string then subsequent keys
+    # will be added from this location, etc.
+    attr_accessor :cursor_location
+
+
+    def initialize(label, size )
+      @label = label
+      @size = size
+      @selected = false
+      @value = ''
+      @cursor_location = 0
+      @filter = nil
+    end
+
+    # Creates an InputElement that only allows integer input
+    #
+    def InputElement.new_integer_only( label, size)
+      i_only = PPCurses::InputElement.new(label, size)
+      i_only.filter =PPCurses::NumberFilter.new
+      i_only
+    end
+
+
+    def show(screen)
+      print_label( screen )
+
+      @value_start_point = screen.cur_point
+
+      print_value( screen )
+    end
+
+
+
+    def key_down( key )
+      if key == DELETE
+        handle_delete
+        return
+      end
+
+      if key == KEY_LEFT
+        @cursor_location -= 1 unless @cursor_location == 0
+        return
+      end
+
+      if key == KEY_RIGHT
+        @cursor_location += 1 unless @cursor_location == @value.length
+        return
+      end
+
+
+      # Ignore control characters
+      if key.is_a?(Fixnum)
+        return
+      end
+
+      # Adding new characters to the string
+
+      # Check size of string before adding another character
+      if @value.length >= @size
+        # Ignore input
+        return
+      end
+
+      unless passes_filter(key)
+        return
+      end
+
+      add_character(key)
+
+    end
+
+
+    def passes_filter( key )
+      if @filter.nil?
+        return true
+      end
+
+      @filter.passes_filter( key )
+    end
+
+
+    def set_curs_pos(screen)
+      Curses.curs_set(VISIBLE)
+      x =  @value_start_point.x  + @cursor_location
+
+      screen.setpos( @value_start_point.y, x )
+    end
+
+
+    def height
+      1
+    end
+
+    # --------------------------------------------------------------------------------
+    protected
+
+
+    def print_label( screen )
+      screen.attron(Curses::A_REVERSE) if @selected
+      screen.addstr("#{@label}:")
+      screen.attroff(Curses::A_REVERSE) if @selected
+      screen.addstr(' ')
+    end
+
+
+    def print_value( screen )
+      screen.attron(Curses::A_UNDERLINE)
+      screen.addstr(@value.ljust(@size))
+      screen.attroff(Curses::A_UNDERLINE)
+    end
+
+
+    def handle_delete
+      # Cursor is at the front of the string, nothing in
+      # front of it to delete, or there is nothing to delete
+      if @cursor_location == 0 or @value.length == 0
+        return
+      end
+
+      if @value.length == 1
+        @value = ''
+        @cursor_location = 0
+        return
+      end
+
+      # Cursor is at the end of the string, remove the last character
+      if @cursor_location == @value.length
+        @value = @value.slice(0..@cursor_location-2)
+      elsif @cursor_location == 1
+        # cursor is right after the first character
+        @value = @value.slice(1..@value.length-1)
+      else
+        # Cursor is in the middle of the string, remove the character at the cursor location
+        # Example:
+        #
+        # abcdefg
+        # 1234567
+        #   ^ -> cursor-location = 3
+        #
+        @value = @value.slice(0..@cursor_location-2) + @value.slice(@cursor_location..@value.length-1)
+      end
+
+      @cursor_location -= 1
+    end
+
+
+    def add_character ( char )
+      if @cursor_location == @value.length
+        @value += char
+      else
+        @value = @value.slice(0..@cursor_location-1) + char + @value.slice(@cursor_location..@value.length-1)
+      end
+
+      @cursor_location += 1
+    end
+
+  end
+
+
+
+  class NumberFilter
+
+    def passes_filter( key )
+      if key =~ /^\d+$/
+        return true
+      end
+
+      false
+    end
+
+  end
+
+end