menutree 0.0.4 → 0.1.1

data/.gitignore

@@ -1 +1 @@
-pkg/
+*.gem

data/README.md

@@ -1,6 +1,6 @@
 # Menutree
 
-Menutree is a framework for presenting a recursive menu shell on the command 
+Menutree is a framework for presenting a recursive Read-Eval-Print Loop (REPL) shell on the command 
 line, inspired by the CLI found in Cisco IOS and other similar products. 
 Menutree lets users issue commands via an interactive nested shell interface, 
 and also directly from the command line. 
@@ -11,26 +11,24 @@ readline support are all built in.
 
 ## Example:
 
-Given a hypothetical program 'ticker' that uses the Menutree gem to manage a list of 
-tickets, a sample interaction might look like:
+Given a hypothetical program 'ticket' that uses the Menutree gem to manage a list of 
+tickets (such a program is included in `examples/`), a sample interaction might look like:
 
 <pre>
-$ ticker
-> init
-Ticker created an empty ticket database
-> add "Do a little dance"
-Ticket "Do a little dance" added as ticket 213
-> rm
-rm> 213
-Ticket 213 ("Do a little dance") removed
-rm> ..
+$ ruby ticket.rb
+> action_one 
+One
+> submenu_one
+/submenu_one> action_one
+Unknown command 'action_one'
+/submenu_one> ..
 > exit
 </pre>
 
 Commands could also be run from the shell:
 
 <pre>
-$ ticker add "Make a little love"
+$ rubyticke add "Make a little love"
 Ticket "Make a little love" added as ticket 214
 </pre>
 

data/Rakefile

@@ -2,23 +2,6 @@ require 'rake'
 require 'rake/testtask'
 require 'rcov/rcovtask'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name = "menutree"
-    s.summary = "a simple hierachical command line shell"
-    s.description = "Menutree is a framework for presenting a recursive menu shell on the command 
-    line, inspired by the CLI found in Cisco IOS and similar products"
-    s.email = "mat@geeky.net"
-    s.homepage = "http://github.com/mtrudel/menutree"
-    s.authors = ["Mat Trudel", "Grant McInnes"]
-    s.add_dependency 'activesupport'
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: gem install jeweler"
-end
-
 Rake::TestTask.new do |t|
   t.libs << 'lib'
   t.pattern = 'test/**/*_test.rb'

data/examples/commands/leaf.rb

@@ -0,0 +1,11 @@
+leaf do |tree|
+  desc "This is action one's help"
+  def action_one(*args)
+    puts "This is action one, called with: #{args.join ' '}"
+  end
+
+  desc "This is action two's help"
+  def action_two(*args)
+    puts "This is action two, called with: #{args.join ' '}"
+  end
+end

data/examples/commands/submenu_one/leaf.rb

@@ -0,0 +1,11 @@
+leaf do |tree|
+  desc "This is action one's help inside submenu one"
+  def action_one(*args)
+    puts "This is action one in submenu one, called with: #{args.join ' '}"
+  end
+
+  desc "This is action two's help inside submenu one"
+  def action_two(*args)
+    puts "This is action two in submenu one, called with: #{args.join ' '}"
+  end
+end

data/examples/commands/submenu_two/leaf.rb

@@ -0,0 +1,11 @@
+leaf do |tree|
+  desc "This is action one's help inside submenu two"
+  def action_one(*args)
+    puts "This is action one in submenu two, called with: #{args.join ' '}"
+  end
+
+  desc "This is action two's help inside submenu one"
+  def action_two(*args)
+    puts "This is action two in submenu two, called with: #{args.join ' '}"
+  end
+end

data/examples/example.rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'menutree'
+
+MenuTree::Tree.new(File.join(File.dirname(__FILE__), 'commands')).repl(ARGV)

data/lib/menutree.rb

@@ -1,5 +1,5 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+$:.unshift(File.join(File.dirname(__FILE__), 'menutree')) unless
+  $:.include?(File.join(File.dirname(__FILE__), 'menutree')) || $:.include?(File.expand_path(File.join(File.dirname(__FILE__), 'menutree')))
 
-require 'base'
+require 'tree'
 

data/lib/menutree/help.rb

@@ -0,0 +1,26 @@
+module MenuTree
+  INDENT = "\t"
+  COMMAND_WIDTH = -12
+  BUILTINS = {
+    "help" => "Displays this message",
+    "quit" => "Quits this session",
+    ".." => "Goes up a level in the menu (or quits if at the root)",
+  }
+
+  module Help
+    def display_help
+      display_help_section("Built-in commands", BUILTINS)
+      display_help_section("Leaf commands", @leaf.commands)
+      display_help_section("Submenus", submenus)
+    end
+
+    def display_help_section(section, contents, indent = 0)
+      puts INDENT*indent + section
+      contents.each do |command, description|
+        puts INDENT*(indent+1) + sprintf("%#{COMMAND_WIDTH}s %s", command, description)
+      end
+      puts ""
+    end
+  end
+end
+

data/lib/menutree/leaf.rb

@@ -0,0 +1,23 @@
+module MenuTree
+  class Leaf
+    attr_accessor :commands
+
+    def initialize(parent_tree)
+      @parent_tree = parent_tree
+      @commands = {}
+      @curent_description = ""
+    end
+
+    def desc(desc)
+      @current_description = desc
+    end
+
+    def singleton_method_added(symbol)
+      @commands[symbol] = @current_description
+    end
+
+    def leaf(&block)
+      self.instance_exec(@parent_tree, &block) if block_given?
+    end
+  end
+end

data/lib/menutree/tree.rb

@@ -0,0 +1,73 @@
+require 'readline'
+require 'active_support'
+require 'leaf'
+require 'help'
+
+module MenuTree
+  class Tree
+    include Help
+    attr_accessor :directory
+    attr_accessor :prompt  
+    attr_accessor :leaf
+    
+    def initialize(directory, parent = "")
+      @directory = directory
+      if parent.is_a? String
+        @prompt = parent
+      elsif !parent.prompt.empty?
+        @prompt = parent.prompt + "/" + File.basename(@directory)
+      else
+        @prompt = File.basename(@directory)
+      end
+
+      file = File.join(@directory, "leaf.rb")
+      @leaf = MenuTree::Leaf.new(self)
+      @leaf.instance_eval(File.read(file), file) if File.exists? file
+    end
+
+    def repl(cmds)
+      one_shot = true unless cmds.empty?
+      to_run = cmds.shift    
+      while true do
+        Readline.completion_append_character = " "
+        Readline.completion_proc = Proc.new do |str|
+          commands(str)
+        end
+        if (to_run.nil?) 
+          cmds = Readline.readline("#{@prompt}> ", true).split
+          to_run = cmds.shift
+        end
+          
+        # If it's a builtin, run it
+        if (to_run.nil?) 
+          next
+        elsif (to_run == "help" or to_run == "?")
+          display_help
+        elsif (to_run == "quit")
+          exit
+        elsif (to_run == "..")
+          return      
+        elsif File.directory?(File.join(@directory, to_run))
+          menu = MenuTree::Tree.new(File.join(@directory, to_run), self)
+          menu.repl(cmds)
+        else 
+          @leaf.send to_run, cmds rescue puts "Unknown command #{to_run}"
+        end
+        to_run = nil
+        return if one_shot
+      end
+    end
+    
+    def commands(prefix='')
+      (leaf_commands + submenus).select { |command| command =~ /^#{Regexp.escape(prefix)}/ }
+    end
+
+    def leaf_commands
+      @leaf.commands.keys.map { |x| x.to_s }
+    end
+
+    def submenus
+      Dir.new(@directory).select { |entry| entry =~ /^[^\.]/ and File.directory?(File.join(@directory, entry)) }
+    end
+  end
+end

data/menutree.gemspec

@@ -1,17 +1,10 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
 Gem::Specification.new do |s|
   s.name = %q{menutree}
-  s.version = "0.0.4"
+  s.version = "0.1.1"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mat Trudel", "Grant McInnes"]
-  s.date = %q{2010-03-16}
-  s.description = %q{Menutree is a framework for presenting a recursive menu shell on the command 
-    line, inspired by the CLI found in Cisco IOS and similar products}
+  s.date = %q{2011-01-05}
+  s.description = %q{Menutree is a framework for presenting a recursive REPL shell, inspired by the CLI found in Cisco IOS and similar products}
   s.email = %q{mat@geeky.net}
   s.extra_rdoc_files = [
     "README.md"
@@ -20,28 +13,19 @@ Gem::Specification.new do |s|
     ".gitignore",
      "README.md",
      "Rakefile",
-     "VERSION",
-     "lib/base.rb",
      "lib/menutree.rb",
+     "lib/menutree/tree.rb",
+     "lib/menutree/leaf.rb",
+     "lib/menutree/help.rb",
+     "examples/example.rb",
+     "examples/commands/leaf.rb",
+     "examples/commands/submenu_one/leaf.rb",
+     "examples/commands/submenu_two/leaf.rb",
      "menutree.gemspec"
   ]
   s.homepage = %q{http://github.com/mtrudel/menutree}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{a simple hierachical command line shell}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-    else
-      s.add_dependency(%q<activesupport>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<activesupport>, [">= 0"])
-  end
+  s.summary = %q{a simple hierachical REPL shell}
+  s.add_dependency(%q<activesupport>, [">= 0"])
 end
 

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: menutree
 version: !ruby/object:Gem::Version 
+  hash: 25
   prerelease: false
   segments: 
   - 0
-  - 0
-  - 4
-  version: 0.0.4
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Mat Trudel
@@ -15,24 +16,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-16 00:00:00 -04:00
+date: 2011-01-05 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
-description: |-
-  Menutree is a framework for presenting a recursive menu shell on the command 
-      line, inspired by the CLI found in Cisco IOS and similar products
+description: Menutree is a framework for presenting a recursive REPL shell, inspired by the CLI found in Cisco IOS and similar products
 email: mat@geeky.net
 executables: []
 
@@ -44,39 +45,48 @@ files:
 - .gitignore
 - README.md
 - Rakefile
-- VERSION
-- lib/base.rb
 - lib/menutree.rb
+- lib/menutree/tree.rb
+- lib/menutree/leaf.rb
+- lib/menutree/help.rb
+- examples/example.rb
+- examples/commands/leaf.rb
+- examples/commands/submenu_one/leaf.rb
+- examples/commands/submenu_two/leaf.rb
 - menutree.gemspec
 has_rdoc: true
 homepage: http://github.com/mtrudel/menutree
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: a simple hierachical command line shell
+summary: a simple hierachical REPL shell
 test_files: []
 

data/VERSION

@@ -1 +0,0 @@
-0.0.4

data/lib/base.rb

@@ -1,86 +0,0 @@
-require 'readline'
-require 'active_support'
-
-class MenuTree
-  attr_accessor :directory
-  attr_accessor :parent
-  attr_accessor :prompt  
-  
-  def initialize(directory, parent = "")
-    @directory = directory
-    @parent = parent
-    if @parent.is_a? self.class
-      @prompt = @parent.prompt + "/" + File.basename(@directory)
-    else
-      @prompt = @parent
-    end
-  end
-  
-  def run_command(cmds)
-    Readline.completion_append_character = " "
-    Readline.completion_proc = Proc.new do |str|
-      commands(str)
-    end
-
-    one_shot = true unless cmds.empty?
-    to_run = cmds.shift    
-    while true do
-      if (to_run.nil?) 
-        cmds = Readline.readline("#{@prompt}> ", true).split
-        to_run = cmds.shift
-      end
-        
-      # If it's a builtin, run it
-      if (to_run.nil?) 
-        next
-      elsif (to_run == "help" or to_run == "?")
-        display_help
-      elsif (to_run == "quit")
-        exit
-      elsif (to_run == "..")
-        return      
-      elsif File.exists?(File.join(@directory, "#{to_run}.rb"))
-        # If we have a .rb file, run it with the rest of cmd as arguments
-        # TODO -- use .extend?
-        require File.join(@directory, "#{to_run}")
-        eval(to_run.camelize).new.run(cmds)
-      elsif File.directory?(File.join(@directory, to_run))
-        menu = MenuTree.new(File.join(@directory, to_run), self)
-        menu.run_command(cmds)
-      elsif File.exists?(File.join(@directory, "default.rb"))
-        # TODO let default handle it, allowing us to have proxy menus
-      else 
-        puts "Unknown command #{to_run}"
-      end
-      to_run = nil
-      return if one_shot
-    end
-  end
-  
-  def commands(prefix='')
-    completions = []
-    Dir.new(@directory).each do |command|
-      if command =~ /^[^\.]/ and command =~ /^#{Regexp.escape(prefix)}/ and File.file?(File.join(@directory, command))
-        completions << File.basename(command, '.rb') 
-      end
-    end
-    completions
-  end
-
-  def display_help
-    puts <<EOF
-Builtin commands:
-  help:\t\t\t\tDisplays this message
-  quit:\t\t\t\tQuits this session
-  ..:  \t\t\t\tGoes up a level in the menu (or quits if at the root)
-  
-#{@parent} commands:
-EOF
-    
-    # TODO display some help for each submenu
-    commands.each do |cmd| 
-      require File.join(@directory, "#{cmd}")
-      puts "  #{cmd}:\t\t\t\t#{eval(cmd.camelize).new.description}"
-    end
-  end
-end