menutree 0.0.3

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/README

@@ -0,0 +1,49 @@
+# Menutree
+
+Menutree is a framework for presenting a recursive menu 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. 
+
+The menu structure and commands therein are defined by a directory of ruby 
+scripts conforming to a simple interface. Inline help, command completion, and
+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:
+
+<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> ..
+> exit
+</pre>
+
+Commands could also be run from the shell:
+
+<pre>
+$ ticker add "Make a little love"
+Ticket "Make a little love" added as ticket 214
+</pre>
+
+To implement this, ticker would provide Menutree with a directory that looked
+like:
+
+<pre>
+commands/
+	init.rb
+	add/
+		default.rb
+	rm/
+		default.rb
+</pre>
+
+

data/Rakefile

@@ -0,0 +1,45 @@
+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 Trude", "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'
+  t.verbose = false
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new(:yardoc)
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yard, you must: sudo gem install yard"
+  end
+end
+
+
+Rcov::RcovTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+
+task :default => :rcov

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/lib/base.rb

@@ -0,0 +1,86 @@
+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

data/lib/menutree.rb

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

data/menutree.gemspec

@@ -0,0 +1,47 @@
+# 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.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mat Trude", "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.email = %q{mat@geeky.net}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "lib/base.rb",
+     "lib/menutree.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
+end
+

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: menutree
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Mat Trude
+- Grant McInnes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-16 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        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
+email: mat@geeky.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- README
+- Rakefile
+- VERSION
+- lib/base.rb
+- lib/menutree.rb
+- menutree.gemspec
+has_rdoc: true
+homepage: http://github.com/mtrudel/menutree
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: a simple hierachical command line shell
+test_files: []
+