rcommand 0.1.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+== RCommand 0.1.0
+ * Initial release, probably isn't very portable.

data/README

@@ -0,0 +1,42 @@
+RCommand is a generic way for ruby scripts to present a full-featured
+command interface to users, complete with command history and tab completion.
+
+== Example
+  require 'rcommand'
+
+  command_line = RCommand.new(STDIN, STDOUT)
+  command_line.for_prompt do
+    command_line.io_write.print("#{command_line.history.size}:> ")
+  end
+  
+  # Default events shown here in full, for demonstration purposes.  Omitting
+  # them will give the same behavior.
+  command_line.on_single_tab do |partial|
+    matches = RCommand.matches(partial, command_line.history)
+    common_prefix = RCommand.common_prefix(matches)
+    common_prefix.nil? ? partial : common_prefix
+  end
+  command_line.on_double_tab do |partial|
+    matches = RCommand.matches(partial, command_line.history)
+    if matches.size > 1
+      command_line.io_write.puts()
+      for match in matches.uniq
+        command_line.io_write.puts(match)
+      end
+      command_line.prompt()
+      command_line.io_write.print(partial)
+    end
+    partial
+  end
+  command_line.on_key_up do |partial|
+    command_line.prev()
+  end
+  command_line.on_key_down do |partial|
+    command_line.next()
+  end
+
+  loop do
+    command_line.prompt()
+    result = command_line.gets()
+    command_line.io_write.puts("Example command: #{result}")
+  end

data/install.rb

@@ -0,0 +1,30 @@
+require 'rbconfig'
+require 'find'
+require 'ftools'
+
+include Config
+
+# this was adapted from rdoc's install.rb by ways of Log4r
+
+$sitedir = CONFIG["sitelibdir"]
+unless $sitedir
+  version = CONFIG["MAJOR"] + "." + CONFIG["MINOR"]
+  $libdir = File.join(CONFIG["libdir"], "ruby", version)
+  $sitedir = $:.find {|x| x =~ /site_ruby/ }
+  if !$sitedir
+    $sitedir = File.join($libdir, "site_ruby")
+  elsif $sitedir !~ Regexp.quote(version)
+    $sitedir = File.join($sitedir, version)
+  end
+end
+
+# the acual gruntwork
+Dir.chdir("lib")
+
+Find.find("rcommand.rb") { |f|
+  if f[-3..-1] == ".rb"
+    File::install(f, File.join($sitedir, *f.split(/\//)), 0644, true)
+  else
+    File::makedirs(File.join($sitedir, *f.split(/\//)))
+  end
+}

data/lib/rcommand.rb

@@ -0,0 +1,287 @@
+#--
+# Copyright (c) 2005 Robert Aman
+#
+# 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.
+#++
+
+RCOMMAND_VERSION = "0.1.0"
+
+$:.unshift(File.dirname(__FILE__))
+
+# RCommand is a generic way for ruby scripts to present a full-featured
+# command interface to users with command history and tab completion.
+class RCommand
+  
+  # Returns all commands in a command list that match a partial command.
+  def self.matches(partial, command_list)
+    matches = []
+    for command in command_list
+      unless command.kind_of? String
+        raise "Expecting String, got #{command.class.name} instead."
+      end
+      matches << command if command[0...(partial.size)] == partial
+    end
+    return matches
+  end
+  
+  # Returns any prefix shared by all commands in a list, or the empty
+  # string if there was no prefix.
+  def self.common_prefix(command_list)
+    return "" unless command_list.kind_of? Enumerable
+    return "" if command_list.size == 0
+    command_list.each do |command|
+      unless command.kind_of? String
+        raise "Expecting String, got #{command.class.name} instead."
+      end
+    end
+    prefix = ""
+    command_list = command_list.sort do |a, b|
+      a.size <=> b.size
+    end
+    for i in 0..command_list[0].size
+      for command in command_list
+        return prefix if command_list[0][i] != command[i]
+      end
+      prefix = command_list[0][0..i]
+    end
+    return prefix
+  end
+  
+  # Creates a new RCommand interface object.
+  def initialize(io_read, io_write)
+    unless io_read.kind_of? IO
+      raise "Expecting object of type IO, got #{io_read.class.name}."
+    end
+    unless io_write.kind_of? IO
+      raise "Expecting object of type IO, got #{io_write.class.name}."
+    end
+    @io_read = io_read
+    @io_write = io_write
+    @history = []
+    @history_index = nil
+    @tab_count = 0
+    @prompt_proc = nil
+    @single_tab_proc = lambda do |partial|
+      matches = RCommand.matches(partial, self.history)
+      common_prefix = RCommand.common_prefix(matches)
+      common_prefix.nil? ? partial : common_prefix
+    end
+    @double_tab_proc = lambda do |partial|
+      matches = RCommand.matches(partial, self.history)
+      if matches.size > 1
+        self.io_write.puts()
+        for match in matches.uniq
+          self.io_write.puts(match)
+        end
+        self.prompt()
+        self.io_write.print(partial)
+      end
+      partial
+    end
+    @key_up_proc = lambda do |partial|
+      self.prev()
+    end
+    @key_down_proc = lambda do |partial|
+      self.next()
+    end
+    @key_left_proc = nil
+    @key_right_proc = nil
+    @interupt_proc = lambda do
+      self.io_write.print("\n")
+      system("stty sane")
+      exit
+    end
+  end
+  
+  attr_reader :io_read
+  attr_reader :io_write
+  attr_reader :history
+  attr_accessor :history_index
+
+  def for_prompt(&block); @prompt_proc = block; end
+  def on_single_tab(&block); @single_tab_proc = block; end
+  def on_double_tab(&block); @double_tab_proc = block; end
+  def on_key_up(&block); @key_up_proc = block; end
+  def on_key_down(&block); @key_down_proc = block; end
+  def on_key_left(&block); @key_left_proc = block; end
+  def on_key_right(&block); @key_right_proc = block; end
+  def on_interupt(&block); @interupt_proc = block; end
+  
+  # Displays the prompt, if any.
+  def prompt()
+    @prompt_proc.call() unless @prompt_proc.nil?
+  end
+  
+  # Sets the command line to the previous command.
+  def prev()
+    if self.history_index.nil?
+      self.history_index = self.history.size - 1
+    else
+      self.history_index -= 1
+      self.history_index = 0 if self.history_index < 0
+    end
+    self.history[self.history_index]
+  end
+  
+  # Sets the command line to the next command.
+  def next()
+    if self.history_index.nil?
+      nil
+    else
+      self.history_index += 1
+      if self.history_index > self.history.size - 1
+        self.history_index = self.history.size - 1
+        ""
+      else
+        self.history[self.history_index]
+      end
+    end
+  end
+  
+  # Adds a command to the command line.
+  def <<(command)
+    command = command[0..-1] if command[-1] == "\n"
+    command = command[0..-1] if command[-1] == "\r"
+    if @history[-1] == ""
+      @history.pop()
+    end
+    @history << command if command != ""
+    @history_index = nil
+  end
+  
+  # Returns the command string entered by the user.
+  def gets()
+    command = ""
+    char = nil
+    loop do
+      char = getc()
+      next if char.nil?
+      next if char == 0
+      if char != 9
+        @tab_count = 0
+      end
+      if char == 3
+        @interupt_proc.call() unless @interupt_proc.nil?
+      elsif char == 10
+        @io_write.print("\n")
+        self << command
+        break
+      elsif char == 9
+        @tab_count += 1
+        replacement = nil
+        if @tab_count == 1
+          unless @single_tab_proc.nil?
+            replacement =
+              @single_tab_proc.call(command)
+          end
+        elsif @tab_count > 1
+          unless @double_tab_proc.nil?
+            replacement =
+              @double_tab_proc.call(command)
+          end
+        end
+        if replacement != nil && replacement.size > command.size
+          @io_write.print(
+            8.chr * command.size +
+            " " * command.size +
+            8.chr * command.size)
+          @io_write.print(replacement)
+          command = replacement
+        end
+      elsif char == 8 || char == 127
+        if command.size > 0
+          command = command[0..-2]
+          @io_write.print(8.chr + " " + 8.chr)
+        end
+      else
+        command << char.chr
+        replacement = nil
+        if command.index("\e[A") != nil
+          command.gsub!("\e[A", "")
+          unless @key_up_proc.nil?
+            replacement =
+              @key_up_proc.call(command)
+          end
+        elsif command.index("\e[B") != nil
+          command.gsub!("\e[B", "")
+          unless @key_down_proc.nil?
+            replacement =
+              @key_down_proc.call(command)
+          end
+        elsif command.index("\e[C") != nil
+          command.gsub!("\e[C", "")
+          unless @key_right_proc.nil?
+            replacement =
+              @key_right_proc.call(command)
+          end
+        elsif command.index("\e[D") != nil
+          command.gsub!("\e[D", "")
+          unless @key_left_proc.nil?
+            replacement =
+              @key_left_proc.call(command)
+          end
+        else
+          if (char == "["[0] && command[-2] != "\e"[0]) ||
+              (char != "\e"[0] && char != "["[0])
+            @io_write.print(char.chr)
+          end
+        end
+        if replacement != nil
+          @io_write.print(
+            8.chr * command.size +
+            " " * command.size +
+            8.chr * command.size)
+          @io_write.print(replacement)
+          command = replacement
+        end
+      end
+    end
+    return command
+  end
+  
+private
+  # Returns a single character without waiting for the enter key to be
+  # pressed.
+  def getc()
+    char = nil
+    begin
+      if @io_read == STDIN
+        if RUBY_PLATFORM =~ /mswin/
+          require "Win32API"
+          char = Win32API.new("crtdll", "_getch", [], "L").Call
+        else
+          begin
+            system("stty cbreak -echo")
+            char = @io_read.readchar()
+          ensure
+            system("stty -cbreak -echo")
+          end
+        end
+      else
+        char = @io_read.readchar()
+      end
+    rescue Interrupt
+      return 3
+    rescue Exception
+      return nil
+    end
+    return char
+  end
+end

data/rakefile

@@ -0,0 +1,113 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+
+PKG_NAME      = 'rcommand'
+PKG_VERSION   = '0.1.0'
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+RELEASE_NAME  = "REL #{PKG_VERSION}"
+
+RUBY_FORGE_PROJECT = "rcommand"
+RUBY_FORGE_USER    = "sporkmonger"
+
+PKG_FILES = FileList[
+    "lib/**/*", "test/**/*", "examples/**/*", "doc/**/*", "[A-Z]*", "install.rb", "rakefile"
+].exclude(/\bCVS\b|~$/).exclude(/database\.yml/)
+
+desc "Default Task"
+task :default => [ :test_all ]
+
+# Run the unit tests
+
+Rake::TestTask.new("test_all") { |t|
+  t.libs << "test"
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+}
+
+# Generate the RDoc documentation
+
+Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "RCommand -- generic interactive command handler"
+  rdoc.options << '--line-numbers' << '--inline-source' <<
+    '--accessor' << 'cattr_accessor=object'
+  rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+  rdoc.rdoc_files.include('README', 'CHANGELOG')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}
+
+# Create compressed packages
+
+dist_dirs = [ "lib", "test" ]
+
+spec = Gem::Specification.new do |s|
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.summary = "Command handler."
+  s.description = "A generic interactive command handler."
+
+  s.files = [ "rakefile", "install.rb", "README", "CHANGELOG" ]
+  dist_dirs.each do |dir|
+    s.files = s.files + Dir.glob( "#{dir}/**/*" ).delete_if do |item|
+      item.include?( "\.svn" ) || item.include?( "database\.yml" )
+    end
+  end
+  
+  s.require_path = 'lib'
+  s.autorequire = 'rcommand'
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = %w( README )
+  s.rdoc_options.concat ['--main',  'README']
+  
+  s.author = "Bob Aman"
+  s.email = "bob@sporkmonger.com"
+  s.homepage = "http://sporkmonger.com/projects/rcommand"
+  s.rubyforge_project = "rcommand"
+end
+  
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+task :lines do
+  lines, codelines, total_lines, total_codelines = 0, 0, 0, 0
+
+  for file_name in FileList["lib/**/*.rb"]
+    f = File.open(file_name)
+
+    while line = f.gets
+      lines += 1
+      next if line =~ /^\s*$/
+      next if line =~ /^\s*#/
+      codelines += 1
+    end
+    puts "L: #{sprintf("%4d", lines)}, LOC #{sprintf("%4d", codelines)} | #{file_name}"
+    
+    total_lines     += lines
+    total_codelines += codelines
+    
+    lines, codelines = 0, 0
+  end
+
+  puts "Total: Lines #{total_lines}, LOC #{total_codelines}"
+end
+
+
+# Publishing ------------------------------------------------------
+
+desc "Publish the API documentation"
+task :pdoc => [:rdoc] do 
+  Rake::SshDirPublisher.new(
+    "vacindak@sporkmonger.com",
+    "public_html/projects/rcommand/api",
+    "doc").upload
+end

data/test/command_test.rb

@@ -0,0 +1,63 @@
+require 'test/unit'
+require 'rcommand'
+
+class CommandTest < Test::Unit::TestCase
+  def setup
+  end
+  
+  def test_command_history
+    command_line = RCommand.new(STDIN, STDOUT)
+    
+    command_line << "first command"
+    command_line << "second command"
+    command_line << "third command"
+    
+    assert_equal(nil, command_line.next())
+    assert_equal("third command", command_line.prev())
+    assert_equal("second command", command_line.prev())
+    assert_equal("first command", command_line.prev())
+    assert_equal("second command", command_line.next())
+    assert_equal("third command", command_line.next())
+    assert_equal("", command_line.next())
+    assert_equal(3, command_line.history.size)
+    
+    command_line << "fourth command"
+    
+    assert_equal(nil, command_line.next())
+    assert_equal("fourth command", command_line.prev())
+    assert_equal(4, command_line.history.size)
+  end
+  
+  def test_command_matches
+    history = [
+      "good",
+      "better",
+      "best",
+      "bestest"
+    ]
+    
+    assert_equal(3, RCommand.matches("b", history).size)
+    assert_equal(3, RCommand.matches("be", history).size)
+    assert_equal(2, RCommand.matches("bes", history).size)
+    assert_equal(2, RCommand.matches("best", history).size)
+    assert_equal(1, RCommand.matches("beste", history).size)
+    assert_equal(1, RCommand.matches("bestes", history).size)
+    assert_equal(1, RCommand.matches("bestest", history).size)
+
+    assert_equal(1, RCommand.matches("g", history).size)
+    assert_equal(1, RCommand.matches("go", history).size)
+    assert_equal(1, RCommand.matches("goo", history).size)
+    assert_equal(1, RCommand.matches("good", history).size)
+  end
+  
+  def test_command_common_prefix
+    assert_equal("",
+      RCommand.common_prefix(["good", "better", "best", "bestest"]))
+    assert_equal("be",
+      RCommand.common_prefix(["better", "best", "bestest"]))
+    assert_equal("best",
+      RCommand.common_prefix(["best", "bestest"]))
+    assert_equal("bestest",
+      RCommand.common_prefix(["bestest"]))
+  end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: rcommand
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2006-03-27 00:00:00 -05:00
+summary: Command handler.
+require_paths: 
+  - lib
+email: bob@sporkmonger.com
+homepage: http://sporkmonger.com/projects/rcommand
+rubyforge_project: rcommand
+description: A generic interactive command handler.
+autorequire: rcommand
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+  - Bob Aman
+files: 
+  - rakefile
+  - install.rb
+  - README
+  - CHANGELOG
+  - lib/rcommand.rb
+  - test/command_test.rb
+test_files: []
+rdoc_options: 
+  - "--main"
+  - README
+extra_rdoc_files: 
+  - README
+executables: []
+extensions: []
+requirements: []
+dependencies: []