Class: Ame::Root

Inherits:
Class show all
Defined in:
lib/ame-1.0/root.rb

Overview

Root of a hierarchy of Classes. This class should be subclassed by the root of your command-line interface.

Examples:

An rm-like Command-line Interface with Ame

class Rm < Ame::Root
  version '1.0.0'

  flag 'f', '', false, 'Do not prompt for confirmation'
  flag 'i', '', nil, 'Prompt for confirmation' do |options|
    options['f'] = false
  end
  flag 'R', '', false, 'Remove file hierarchies'
  flag 'r', '', nil, 'Equivalent to -R' do |options|
    options['r'] = true
  end
  splus 'FILE', String, 'File to remove'
  description 'Remove directory entries'
  def rm(files, options = {})
    require 'fileutils'
    FileUtils.send options['R'] ? :rm_r : :rm,
      [first] + rest, :force => options['f']
  end
end
Rm.process

A Git-like Command-line Interface With Ame

module Git end
class Git::CLI < Ame::Root
  version '1.0.0'
  class Git < Ame::Class
    description 'The stupid content tracker'
    def initialize; end

    description 'Prepare patches for e-mail submission'
    flag   ?n, 'numbered', false, 'Name output in [PATCH n/m] format'
    flag   ?N, 'no-numbered', nil,
      'Name output in [PATCH] format' do |options|
      options['numbered'] = false
    end
    toggle ?s, 'signoff', false,
      'Add Signed-off-by: line to the commit message'
    switch '', 'thread', 'STYLE', nil,
      Ame::Types::Enumeration[:shallow, :deep],
      'Controls addition of In-Reply-To and References headers'
    flag   '', 'no-thread', nil,
      'Disables addition of In-Reply-To and Reference headers' do |options, _|
       options.delete 'thread'
    end
    option '', 'start-number', 'N', 1,
      'Start numbering the patches at N instead of 1'
    multioption '', 'to', 'ADDRESS', String,
      'Add a To: header to the email headers'
    optional 'SINCE', 'N/A', 'Generate patches for commits after SINCE'
    def format_patch(since = '', options = {})
      p since, options
    end

    description 'Annotate file lines with commit information'
    argument 'FILE', String, 'File to annotate'
    def annotate(file)
      p file
    end

    description 'Add file contents to the index'
    splat 'PATHSPEC', String, 'Files to add content from'
    def add(paths)
      p paths
    end

    description 'Display gitattributes information'
    splus 'PATHNAME', String, 'Files to list attributes of'
    def check_attr(paths)
      p paths
    end

    class Remote < Ame::Class
      description 'Manage set of remote repositories'
      def initialize; end

      description 'Shows a list of existing remotes'
      flag 'v', 'verbose', false, 'Show remote URL after name'
      def list(options = {})
        p options
      end

      description 'Adds a remote named NAME for the repository at URL'
      argument 'name', String, 'Name of the remote to add'
      argument 'url', String, 'URL to the repository of the remote to add'
      def add(name, url)
        p name, url
      end
    end
    dispatch Remote, :default => 'list'
  end
  dispatch Git
end
Git::CLI.process

Class Method Summary collapse

Methods inherited from Class

description, fullname, methods

Class Method Details

.basename ⇒ String

Returns An empty string.

Returns:

  • (String) —

    An empty string



148
149
150
 
# File 'lib/ame-1.0/root.rb', line 148

def basename
  ''
end

.call(method, arguments = nil, options = nil) ⇒ self

Call METHOD with ARGUMENTS and OPTIONS on a new instance of the receiver. This method catches AbortAllProcessing.

Parameters:

  • method (#to_sym)
  • arguments (Array) (defaults to: nil)
  • options (Hash<String, Object>) (defaults to: nil)

Returns:

  • (self)

Raises:



139
140
141
142
143
144
 
# File 'lib/ame-1.0/root.rb', line 139

def call(method, arguments = nil, options = nil)
  catch Ame::AbortAllProcessing do
    super
  end
  self
end

.help(help = nil) ⇒ #method, ...

Sets the HELP object to use for displaying usage information, or returns it if HELP is nil. The default is to use a Help::Terminal object.

Parameters:

  • help (#method, #dispatch, #error, #version) (defaults to: nil)

Returns:

  • (#method, #dispatch, #error, #version) 


104
105
106
107
 
# File 'lib/ame-1.0/root.rb', line 104

def help(help = nil)
  super if help
  @help ||= Ame::Help::Terminal.new
end

.process(method = File.basename($0), arguments = ARGV) ⇒ self

Process ARGUMENTS as a list of options and arguments, then call METHOD with the results of this processing on a new instance of the receiver. This method catches AbortAllProcessing. Any errors will be caught and reported using help#error.

Parameters:

  • method (#to_sym) (defaults to: File.basename($0))
  • arguments (Array<String>) (defaults to: ARGV)

Returns:

  • (self) 


125
126
127
128
129
130
131
132
 
# File 'lib/ame-1.0/root.rb', line 125

def process(method = File.basename($0), arguments = ARGV)
  catch Ame::AbortAllProcessing do
    super
  end
  self
rescue => e
  help.error method, e
end

.version(version = nil) ⇒ String

Sets or returns, depending on if VERSION is nil or not, the version of the receiver. The version may be used by help to output version information.

Parameters:

  • version (String, nil) (defaults to: nil)

Returns:

  • (String) 


114
115
116
117
 
# File 'lib/ame-1.0/root.rb', line 114

def version(version = nil)
  return @version = version if version
  @version
end