ppcurses 0.0.8 → 0.0.9

data/README.rdoc

@@ -0,0 +1,23 @@
+= PPCurses 
+
+Some convenience code to initialize curses and some rudimentary GUI classes.  See the **test** directory for example usage programs.
+
+== Install
+  [sudo] gem install 'ppcurses'
+
+== Usage
+  require 'rubygems'
+  require 'ppcurses'
+
+  def displayMenu()
+    mainMenu = PPCurses::Menu.new( [ "Press", "<ESCAPE>", "to Quit" ], nil )
+    mainMenu.show()
+    mainMenu.getMenuSelection() 
+    mainMenu.close()
+  end
+  
+  screen = PPCurses::Screen.new()
+  screen.run { displayMenu() }
+
+== References
+http://www.ruby-doc.org/stdlib-1.9.3/libdoc/curses/rdoc/Curses.html

data/lib/ppcurses/Screen.rb

@@ -2,8 +2,16 @@ require "curses"
 include Curses
 
 module PPCurses
+
+  # Screen initializes the Curses screen 
+  # Pass a code block to the run method to start things
 	class Screen 
 
+    # Creates a curses session
+    #
+    # Example:
+    #   >> myScreen.run { displayMenu() }
+    #
     def run( )
       begin
         init_screen

data/lib/ppcurses/menu/CompositeMenu.rb

@@ -1,22 +1,31 @@
 
-class CompositeMenu
+module PPCurses
 
-  def initialize(menu1, menu2)
-    @menu1 = menu1
-    @menu2 = menu2
+  class CompositeMenu
 
-    @menu1.setSubMenu(menu2)
+    def initialize(menu1, menu2)
+      @menu1 = menu1
+      @menu2 = menu2
 
-  end
+      @menu1.setSubMenu(menu2)
+
+    end
+
+    def show()
+      @menu1.show()
+      @menu2.show()
+    end
 
-  def show()
-    @menu1.show()
-    @menu2.show()
-  end
 
+    def getMenuSelection()
+     @menu1.getMenuSelection() 
+    end
+ 
+	  def close()
+      @menu1.close()
+      @menu2.close()
+ 	  end
 
-  def getMenuSelection()
-   @menu1.getMenuSelection() 
   end
 
 end

data/lib/ppcurses/menu/Menu.rb

@@ -111,8 +111,8 @@ module PPCurses
 
 
 	  def close()
-		@win.close()
-	  end
+      @win.close()
+ 	 end
 
 	end
 

data/lib/ppcurses/menu/RadioMenu.rb

@@ -1,102 +1,99 @@
-# Curses reference:
-# http://www.ruby-doc.org/stdlib-1.9.3/libdoc/curses/rdoc/Curses.html
 
-require "curses"
-require './ppcurses/BaseMenu.rb'
-include Curses
+require 'ppcurses/menu/BaseMenu.rb'
 
-class RadioMenu  < BaseMenu
+module PPCurses
+  class RadioMenu  < BaseMenu
 
-  def initialize( menuItems, actionItems )
-    @items = Array.new
+    def initialize( menuItems, actionItems )
+      @items = Array.new
 
-    @menuLength = 0
+      @menuLength = 0
 
-     menuItems.each do |item|
-       @items.push item
-        @menuLength += item.length + 5
-     end
+       menuItems.each do |item|
+         @items.push item
+          @menuLength += item.length + 5
+       end
 
-    @selection = 0
+      @selection = 0
 
-    unless actionItems.nil? 
-      @actions = Array.new
-      actionItems.each do |item|
-        @actions.push item      
-      end
-    end 
-   
-    winWidth = @menuLength + 4
-
-    @win = Window.new(3, winWidth ,0, (cols - winWidth) / 2)
-
-    @win.timeout=-1
-    # Enables reading arrow keys in getch 
-    @win.keypad(true)
-  end
-
-  def show()
-    @win.box("|", "-")
-    y = 1
-    x = 2
+      unless actionItems.nil? 
+        @actions = Array.new
+        actionItems.each do |item|
+          @actions.push item      
+        end
+      end 
+     
+      winWidth = @menuLength + 4
 
-    @win.setpos(y, x)
+      @win = Window.new(3, winWidth ,0, (cols - winWidth) / 2)
 
-    for i in 0...@items.length
-      @win.addstr( @items[i] )
-      if @selection == i then @win.addstr(" [*] ") else @win.addstr(" [ ] " ) end
+      @win.timeout=-1
+      # Enables reading arrow keys in getch 
+      @win.keypad(true)
     end
 
-   @win.refresh
+    def show()
+      @win.box("|", "-")
+      y = 1
+      x = 2
 
-  end
+      @win.setpos(y, x)
 
+      for i in 0...@items.length
+        @win.addstr( @items[i] )
+        if @selection == i then @win.addstr(" [*] ") else @win.addstr(" [ ] " ) end
+      end
 
-  def getMenuSelection()
+     @win.refresh
 
-    while(1)
-      c = @win.getch
+    end
 
-      processed = self.handleMenuSelection(c)
 
-      if c == 27 then # ESCAPE
-        @win.clear
-        @win.refresh
-        break
-      end
+    def getMenuSelection()
 
-    end 
+      while(1)
+        c = @win.getch
 
-  end
+        processed = self.handleMenuSelection(c)
 
+        if c == 27 then # ESCAPE
+          @win.clear
+          @win.refresh
+          break
+        end
 
-  def handleMenuSelection(c)
-    n_choices = @items.length
+      end 
 
-    if c == KEY_RIGHT then
-      if @selection < n_choices - 1 then @selection += 1 else @selection = 0 end
-      self.show()
     end
 
-    if c == KEY_LEFT then
-      if @selection > 0 then @selection -= 1 else @selection = n_choices-1 end
-      self.show()
-    end
 
-    if c == 10 then # ENTER
-      unless @actions.nil?
-        @actions[@selection].execute()
+    def handleMenuSelection(c)
+      n_choices = @items.length
+
+      if c == KEY_RIGHT then
+        if @selection < n_choices - 1 then @selection += 1 else @selection = 0 end
+        self.show()
+      end
+
+      if c == KEY_LEFT then
+        if @selection > 0 then @selection -= 1 else @selection = n_choices-1 end
         self.show()
       end
+
+      if c == 10 then # ENTER
+        unless @actions.nil?
+          @actions[@selection].execute()
+          self.show()
+        end
+      end
     end
-  end
- 
+   
+
 
+    def close()
+      @win.close()
+    end
 
-  def close()
-    @win.close()
   end
 
 end
-
-

data/lib/ppcurses.rb

@@ -1,7 +1,11 @@
 
 module PPCurses
  require  'ppcurses/Screen.rb'
+ # Menus
  require  'ppcurses/menu/Menu.rb'
+ require  'ppcurses/menu/CompositeMenu.rb'
+ require  'ppcurses/menu/RadioMenu.rb'
+ # Actions
  require  'ppcurses/actions/ShowMenuAction.rb'
 end
 

data/test/compositeMenu.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'ppcurses'
+
+def displayMenu()
+  centerMenu = PPCurses::Menu.new( [ "Press", "<ESCAPE>", "to Quit" ], nil )
+  radioMenu = PPCurses::RadioMenu.new( [ "Wow", "another", "menu" ], nil )
+
+  mainMenu = PPCurses::CompositeMenu.new(centerMenu, radioMenu)  
+
+
+  mainMenu.show()
+  mainMenu.getMenuSelection() 
+  mainMenu.close()
+end
+
+screen = PPCurses::Screen.new()
+screen.run { displayMenu() }
+

data/test/menuInMenu.rb

@@ -7,7 +7,7 @@ def displayMenu()
   mainMenu = PPCurses::Menu.new( [ "Press", "<ESCAPE>", "to Quit" ], nil )
   innerMenu = PPCurses::Menu.new( [ "Wow", "another", "menu" ], nil )
 
-  menuAction = ShowMenuAction.new(innerMenu) 
+  menuAction = PPCurses::ShowMenuAction.new(innerMenu) 
   mainMenu.setGlobalAction(menuAction)
 
   mainMenu.show()

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ppcurses
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 0
-  - 8
-  version: 0.0.8
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
 - Matthieu Cormier
@@ -46,8 +46,9 @@ files:
 - lib/ppcurses/actions/GetEnumeratedStringAction.rb
 - test/menuInMenu.rb
 - test/displayMenu.rb
+- test/compositeMenu.rb
 - LICENCE.txt
-- README.md
+- README.rdoc
 homepage: https://github.com/mcormier/ppcurses
 licenses: []
 

data/README.md

@@ -1,6 +0,0 @@
-# PPCurses #
-
-Some convenience code to initialize curses and some rudimentary GUI classes.  See the **test** directory for example usage programs.
-
-# References #
-http://www.ruby-doc.org/stdlib-1.9.3/libdoc/curses/rdoc/Curses.html