linen 0.2.0 → 0.3.0

data/lib/linen.rb

@@ -18,8 +18,8 @@ require 'string_extensions'
 
 
 module Linen
-  VERSION = "0.2.0"
-  SVNRev  = %q$Rev: 56 $
+  VERSION = "0.3.0"
+  SVNRev  = %q$Rev: 71 $
 
 
   def self::plugins
@@ -36,6 +36,8 @@ end
 ### Plugin Infrastructure
 require 'linen/plugin_registry'
 require 'linen/plugin'
+require 'linen/argument'
+require 'linen/command'
 
 
 ### Other Infrastructure

data/lib/linen/argument.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+##############################################################
+# Copyright 2007, LAIKA, Inc.                                #
+#                                                            #
+# Authors:                                                   #
+#  * Ben Bleything <bbleything@laika.com>                    #
+##############################################################
+
+class Linen::Plugin::Argument
+  attr_reader :prompt
+
+  def initialize( plugin, name, opts )
+    @plugin     = plugin
+    @name       = name
+    @prompt     = opts[:prompt]     || "Please enter the value for #{@name}"
+    @validation = opts[:validation] || /^\w+$/
+    @conversion = opts[:conversion] || nil
+  end
+
+
+  def convert( value )
+    return value unless @conversion
+    return @conversion.call( value )
+  end
+
+
+  def validate( value )
+    if @validation.is_a? Proc
+      result = @validation.call( value )
+    else
+      result = ( value =~ @validation )
+    end
+
+    raise Linen::Plugin::ArgumentError, "Value '#{value}' is invalid for #{@name}." unless result
+    return value
+  end
+end

data/lib/linen/cli.rb

@@ -12,7 +12,7 @@ class Linen::CLI
     attr_accessor :prompt
   end
 
-  @prompt = "linen> "
+  @prompt = "linen > "
 
   def self::parse_command( input )
     ### * nil means ctrl-d, so exit.
@@ -103,42 +103,25 @@ class Linen::CLI
 
 
   def self::execute_command( plugin, command, args )
-    plugin = Linen.plugins[ plugin ]
-    command = plugin.commands[ command ]
-
+    plugin    = Linen.plugins[ plugin ]
+    command   = plugin.commands[ command ]
     workspace = Linen::Workspace.new
+    results   = command.validate_arguments( args )
 
-    command.arguments.each do |arg_name|
-      argument = plugin.arguments[ arg_name ]
-
-      arg_value = args.shift
-
-      begin
-        if arg_value.nil?
-          old_completion_proc = Readline.completion_proc
-          Readline.completion_proc = Proc.new {}
-
-          arg_value = Readline.readline( argument.prompt )
-
-          Readline.completion_proc = old_completion_proc
-        end
+    workspace.add_values( results )
+    command.execute( workspace )
+  end
 
-        argument.validate arg_value
 
-      rescue Linen::Plugin::ArgumentError => e
-        print e
+  def self::reprompt( prompt = "Re-enter: " )
+    old_completion_proc = Readline.completion_proc
+    Readline.completion_proc = proc {}
 
-        # reset arg_value to nil so we get prompted on retry
-        arg_value = nil
+    input = Readline.readline( prompt )
 
-        retry
-      else
-        arg_value = argument.convert( arg_value )
-        workspace.set_value arg_name, arg_value
-      end
-    end
+    Readline.completion_proc = old_completion_proc
 
-    puts command.execute( workspace )
+    return input
   end
 
 
@@ -208,8 +191,11 @@ To get help with a plugin, enter "help <plugin>".  You may also enter
     unless completed_command
       refined_candidates = command_candidates.select {|c| c =~ /^#{command}/}
 
-      raise Linen::CLI::CommandNotFoundError, "Command '#{command}' not found." if refined_candidates.empty?
-      raise Linen::CLI::AmbiguousCommandError.new( refined_candidates, command ), "The command you entered ('#{command}') is ambiguous; please select from the following:"
+      raise Linen::CLI::CommandNotFoundError,
+        "Command '#{command}' not found." if refined_candidates.empty?
+
+      raise Linen::CLI::AmbiguousCommandError.new( refined_candidates, command ),
+        "The command you entered ('#{command}') is ambiguous; please select from the following:"
     end
 
     ### if we've gotten here, we're golden.  Everything is completed.  Rejoice!

data/lib/linen/command.rb

@@ -0,0 +1,167 @@
+#!/usr/bin/env ruby
+
+##############################################################
+# Copyright 2007, LAIKA, Inc.                                #
+#                                                            #
+# Authors:                                                   #
+#  * Ben Bleything <bbleything@laika.com>                    #
+##############################################################
+
+class Linen::Plugin::Command
+  def initialize( plugin, name, &block )
+    @plugin    = plugin
+    @name      = name
+    @arguments = []
+    @help_text = "No help for #{plugin.short_name} #{name}"
+
+    self.instance_eval &block
+  end
+
+
+  def execute( workspace = Linen::Workspace.new )
+    return workspace.instance_eval( &@action_proc )
+  end
+
+
+  def help
+    output = []
+
+    output << @help_text.wrap
+    output << nil # blank line
+
+    # this map turns our list of args into a list like this:
+    # <arg1> <arg2> <arg3> <arg4>...
+    arg_list = arguments.map {|a| "<#{a.to_s}>"}.join( ' ' )
+
+    output << "Usage: #{@plugin.short_name} #{name} #{arg_list}"
+
+    return output.join( "\n" )
+  end
+
+
+  #############################
+  # PLUGIN DEFINITION METHODS #
+  #############################
+
+
+  def one_of( *args )
+    raise Linen::Plugin::ArgumentError,
+      "You may not specify both required and one_of arguments" if @argument_type == :required
+
+    @argument_type = :one_of
+
+    args.each do |arg|
+      raise Linen::Plugin::ArgumentError,
+        "Argument '#{arg}' has not been defined" unless @plugin.arguments.include? arg
+
+      @arguments << arg
+    end
+  end
+
+
+  def required_arguments( *args )
+    raise Linen::Plugin::ArgumentError,
+      "You may not specify both required and one_of arguments" if @argument_type == :one_of
+
+    @argument_type = :required
+
+    args.each do |arg|
+      raise Linen::Plugin::ArgumentError,
+        "Argument '#{arg}' has not been defined" unless @plugin.arguments.include? arg
+
+      @arguments << arg
+    end
+  end
+  alias required_argument required_arguments
+
+
+  def help_message( message )
+    @help_text = message
+  end
+
+
+  def action( &block )
+    @action_proc = block
+  end
+
+
+  ##################
+  # HELPER METHODS #
+  ##################
+
+  def validate_arguments( args )
+    if @argument_type == :one_of
+      return validate_one_of_arguments( args.first )
+    else # @argument_type == :required
+      return validate_required_arguments( args )
+    end
+
+    # this is a Can't Happen(tm) so I'm comfortable with the crappy
+    # exception string.  :P
+    raise "Something has happened!"
+  end
+
+
+  ###########
+    private #
+  ###########
+
+  ### FIXME:bbleything
+  ###
+  ### The reprompting stuff below is going to come back to bite us when we try to
+  ### add batch mode later... that said, in the interest of getting things out the
+  ### door, we're going to leave it be for now.
+
+  def validate_one_of_arguments( arg )
+    results = IndifferentHash.new
+
+    begin
+      @arguments.each do |arg_name|
+        argument = @plugin.arguments[ arg_name ]
+
+        results[ arg_name ] = argument.validate( arg ) rescue nil
+      end
+
+      raise Linen::Plugin::ArgumentError,
+        "The value you entered ('#{arg}') is invalid for all arguments." if
+          results.values.compact.empty?
+
+    rescue Linen::Plugin::ArgumentError => e
+      print "#{e}  "
+
+      arg = Linen::CLI.reprompt.split.first
+
+      retry
+    end
+
+    return results
+  end
+
+
+  def validate_required_arguments( args )
+    results = IndifferentHash.new
+
+    @arguments.each do |arg_name|
+      argument  = @plugin.arguments[ arg_name ]
+      arg_value = args.shift
+
+      begin
+        arg_value = Linen::CLI.reprompt( argument.prompt ) if arg_value.nil?
+
+        argument.validate arg_value
+
+      rescue Linen::Plugin::ArgumentError => e
+        print "#{e}  "
+
+        # reset arg_value to nil so we get prompted on retry
+        arg_value = nil
+
+        retry
+      else
+        results[ arg_name ] = argument.convert( arg_value )
+      end
+    end
+
+    return results
+  end
+end

data/lib/linen/plugin.rb

@@ -59,7 +59,7 @@ class Linen::Plugin
   ### so return the hash.
   def self::arguments( *args )
     @defined_arguments ||= IndifferentHash.new
-    
+
     return @defined_arguments if args.empty?
 
     args.each do |arg|
@@ -98,92 +98,3 @@ class Linen::Plugin
     @description = input
   end
 end
-
-class Linen::Plugin::Argument
-  attr_reader :name, :prompt
-
-  def initialize( plugin, name, opts )
-    @plugin     = plugin
-    @name       = name
-    @prompt     = opts[:prompt]     || "Please enter the value for #{@name}"
-    @validation = opts[:validation] || /^\w+$/
-    @conversion = opts[:conversion] || nil
-  end
-
-
-  def convert( value )
-    return value unless @conversion
-    return @conversion.call( value )
-  end
-
-
-  def validate( value )
-    if @validation.is_a? Proc
-      result = @validation.call( value )
-    else
-      result = ( value =~ @validation )
-    end
-
-    raise Linen::Plugin::ArgumentError, "Value '#{value}' is invalid for #{self.name}.  " unless result
-  end
-end
-
-class Linen::Plugin::Command
-  attr_reader :name, :arguments
-
-  def initialize( plugin, name, &block )
-
-    @plugin    = plugin
-    @name      = name
-    @arguments = []
-    @help_text = "No help for #{plugin.short_name} #{name}"
-
-    self.instance_eval &block
-  end
-  
-  
-  def execute( workspace = Linen::Workspace.new )
-    return workspace.instance_eval( &@action_proc )
-  end
-
-
-  def help
-    output = []
-
-    output << @help_text.wrap
-    output << nil # blank line
-
-    # this map turns our list of args into a list like this:
-    # <arg1> <arg2> <arg3> <arg4>...
-    arg_list = arguments.map {|a| "<#{a.to_s}>"}.join( ' ' )
-
-    output << "Usage: #{@plugin.short_name} #{name} #{arg_list}"
-
-    return output.join( "\n" )
-  end
-
-
-  #######
-  private
-  #######
-
-  def required_arguments( *args )
-    args.each do |arg|
-      raise Linen::Plugin::ArgumentError,
-        "Argument '#{arg}' has not been defined" unless @plugin.arguments.include? arg
-
-      @arguments << arg
-    end
-  end
-  alias required_argument required_arguments
-
-
-  def help_message( message )
-    @help_text = message
-  end
-
-
-  def action( &block )
-    @action_proc = block
-  end
-end

data/lib/linen/workspace.rb

@@ -17,4 +17,13 @@ class Linen::Workspace
     # add ivar
     instance_variable_set "@#{name}", value
   end
+
+  def add_values( hash )
+    raise ArgumentError,
+      "must send a hash" unless hash.is_a? Hash
+
+    hash.each do |k,v|
+      self.set_value k, v
+    end
+  end
 end

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: linen
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 date: 2007-09-10 00:00:00 -07:00
 summary: Linen - A pluggable command-line interface library
 require_paths: 
@@ -34,7 +34,9 @@ files:
 - LICENSE
 - lib/indifferent_hash.rb
 - lib/linen
+- lib/linen/argument.rb
 - lib/linen/cli.rb
+- lib/linen/command.rb
 - lib/linen/exceptions.rb
 - lib/linen/plugin.rb
 - lib/linen/plugin_registry.rb