gli 1.6.0 → 2.0.0.rc3

data/lib/gli_version.rb

@@ -1,3 +0,0 @@
-module GLI
-  VERSION = '1.6.0'
-end

data/lib/support/help.rb

@@ -1,179 +0,0 @@
-require 'gli'
-require 'gli/command'
-require 'gli/terminal'
-
-module GLI
-  class DefaultHelpCommand < Command #:nodoc:
-    @@output = $stdout
-    @@skips_pre = true
-    @@skips_post = true
-
-    # Exposed for testing
-    def self.output_device=(o); @@output = o; end
-
-    # To override the default behavior of the help command, which is
-    # to NOT run the pre block, use this.
-    def self.skips_pre=(skips_pre)
-      @@skips_pre = skips_pre
-    end
-
-    # To override the default behavior of the help command, which is
-    # to NOT run the post block, use this.
-    def self.skips_post=(skips_post)
-      @@skips_post = skips_post
-    end
-
-    def initialize(version,*omit_from_list)
-      @omit_from_list = omit_from_list
-      @version = version
-      super(:help,
-            'Shows list of commands or help for one command',
-            '[command]',
-            'Gets help for the application or its commands.  Can also list the commands in a way helpful to creating a bash-style completion function')
-      self.desc 'List all commands one line at a time, for use with shell completion ([command] argument is partial command to match)'
-      self.switch [:c,:completion]
-    end
-
-    def skips_pre; @@skips_pre; end
-    def skips_post; @@skips_post; end
-
-    def execute(global_options,options,arguments)
-      if options[:c]
-        names = commands_to_show.reduce([]) do |memo,obj|
-          memo << obj[0]
-          memo << obj[1].aliases
-          memo = memo.flatten
-        end
-        names.map! { |name| name.to_s } 
-        if arguments && arguments.size > 0
-          names = names.select { |name| name =~ /^#{arguments[0]}/ }
-        end
-        names.sort.each do |command|
-          next if command.empty?
-          @@output.puts command
-        end
-      else
-        if arguments.empty?
-          list_global_flags
-          list_commands
-        else
-          list_one_command_help(arguments[0])
-        end
-      end
-    end
-
-    private
-
-    def list_global_flags
-      if GLI.program_desc
-        @@output.puts wrap(GLI.program_desc,0)
-        @@output.puts
-      end
-      usage = "usage: #{GLI.program_name} "
-      all_options = GLI.switches.merge(GLI.flags)
-      if !all_options.empty?
-          usage += "[global options] "
-      end
-      usage += "command"
-      usage += ' [command options]'
-      @@output.puts usage
-      @@output.puts
-      if @version
-        @@output.puts "Version: #{@version}"
-        @@output.puts
-      end
-      @@output.puts 'Global Options:' if !all_options.empty?
-      output_command_tokens_for_help(all_options)
-      @@output.puts if !all_options.empty?
-    end
-
-    def list_commands
-      @@output.puts 'Commands:'
-      output_command_tokens_for_help(commands_to_show,:names)
-    end
-
-    def commands_to_show
-      GLI.commands.reject{ |name,c| @omit_from_list.include?(c) }
-    end
-
-    def list_one_command_help(command_name)
-      command = GLI.find_command(command_name)
-      if command
-        @@output.puts command.usage
-        description = wrap(command.description,4)
-        @@output.puts "    #{description}"
-        if command.long_description
-          @@output.puts
-          @@output.puts "    #{wrap(command.long_description,4)}"
-        end
-        all_options = command.switches.merge(command.flags)
-        if !all_options.empty?
-          @@output.puts
-          @@output.puts "Command Options:"
-          output_command_tokens_for_help(all_options)
-        end
-      else
-        @@output.puts "No such command #{command_name}"
-      end
-    end
-
-    def output_command_tokens_for_help(tokens,usage_name=:usage)
-      max = 0
-      tokens.values.each do |token| 
-        len = token.send(usage_name).length
-        if len > max 
-          max = len
-        end
-      end
-      names = tokens.keys.sort { |x,y| x.to_s <=> y.to_s }
-      names.each do |name|
-        token = tokens[name]
-        description = token.description || ''
-        if token.kind_of? Flag 
-          description += " (default: #{token.default_value})" if token.default_value
-        end
-        description = wrap(description,max+7)
-        string = sprintf "    %-#{max}s - %s",token.send(usage_name),description
-        @@output.puts string
-      end
-    end
-  end
-
-  private
-
-  # Wraps the line at the given column length, using the given line padding.
-  # Assumes that the first line doesn't need the padding, as its filled
-  # up with other stuff
-  def wrap(line,pad_length=0,line_length=nil)
-    line ||= ''
-    if line_length.nil?
-      line_length = Terminal.instance.size[0]
-    end
-    line_padding = sprintf("%#{pad_length}s",'')
-    paragraphs = line.split("\n\n").map { |l| l.chomp }.reject { |l| l.empty? }
-    wrapped = paragraphs.map do |para|
-      paragraph_lines(para, line_length - pad_length).join("\n#{line_padding}")
-    end
-    wrapped.join("\n\n#{line_padding}")
-  end
-
-  # Creates lines of the given column length using the words from the
-  # provided paragraph.
-  def paragraph_lines(paragraph,line_length)
-    lines = []
-    this_line = ''
-
-    paragraph.split(/\s+/).each do |word|
-      if this_line.length + word.length + 1 > line_length
-        lines << this_line
-        this_line = word
-      else
-        this_line += ' ' unless this_line.empty?
-        this_line += word
-      end
-    end
-
-    lines << this_line
-  end
-
-end

data/lib/support/initconfig.rb

@@ -1,34 +0,0 @@
-require 'gli'
-require 'gli/command'
-require 'yaml'
-
-module GLI
-  class InitConfig < Command # :nodoc:
-    COMMANDS_KEY = 'commands'
-
-    def initialize(config_file_name)
-      @filename = config_file_name
-      super(:initconfig,"Initialize the config file using current global options",nil,'Initializes a configuration file where you can set default options for command line flags, both globally and on a per-command basis.  These defaults override the built-in defaults and allow you to omit commonly-used command line flags when invoking this program')
-
-      self.desc 'force overwrite of existing config file'
-      self.switch :force
-    end
-
-    def execute(global_options,options,arguments)
-      if options[:force] || !File.exist?(@filename)
-        config = global_options
-        config[COMMANDS_KEY] = {}
-        GLI.commands.each do |name,command|
-          if (command != self) && (name != :rdoc) && (name != :help)
-            config[COMMANDS_KEY][name.to_sym] = {} if command != self
-          end
-        end
-        File.open(@filename,'w', 0600) do |file|
-          YAML.dump(config,file)
-        end
-      else
-        raise "Not overwriting existing config file #{@filename}, use --force to override"
-      end
-    end
-  end
-end

data/lib/support/rdoc.rb

@@ -1,119 +0,0 @@
-require 'gli'
-require 'fileutils'
-
-module GLI
-  class RDocCommand < Command # :nodoc:
-
-    def initialize
-      super(:rdoc,'Generates RDoc (and other types of documentation) for your command line interface')
-      self.desc 'Create a very basic scaffold for a cheat-style cheatsheet, in addition to rdoc'
-      self.switch 'cheatsheet'
-      self.desc 'Include a manapage suitable for gem man, in addition to rdoc'
-      self.switch 'manpage'
-      self.desc 'Do not create rdoc'
-      self.switch 'no-rdoc'
-    end
-
-    def execute(g,options,a)
-      create_rdoc unless options[:'no-rdoc']
-      create_manpage if options[:manpage]
-      create_cheatsheet if options[:cheatsheet]
-    end
-
-    def create_cheatsheet
-      File.open("#{GLI.program_name}.cheat",'w') do |file|
-        file << GLI.program_name
-        file << "\n"
-        file << GLI.program_name.length.times.inject("") { |a,x| a + "=" }
-        file << "\n"
-        file << "\n"
-        file << "Installation:\n"
-        file << "$ gem install #{GLI.program_name}\n\n"
-        GLI.commands.values.sort.each do |command|
-          next if command == self
-          file << command.description
-          file << "\n"
-          [command.name,command.aliases].flatten.each do |name|
-            next unless name
-            file << "$ #{GLI.program_name} #{name} #{command.arguments_description}\n"
-          end
-          file << "\n"
-        end
-      end
-    end
-
-    def create_manpage
-    end
-
-    def create_rdoc
-      File.open("#{GLI.program_name}.rdoc",'w') do |file|
-        file << "= <tt>#{GLI.program_name}</tt>\n\n"
-        if GLI.program_desc
-          file << GLI.program_desc
-          file << "\n\n"
-        end
-        file << "    "
-        file << GLI.program_name
-        file << " "
-        global_options = GLI.switches.merge(GLI.flags)
-        if (global_options && global_options.length > 0)
-          file << "[global options] "
-        end
-        file << "command_name"
-        file << " [command-specific options]"
-        file << " [--] arguments...\n\n"
-        file << "* Use the command +help+ to get a summary of commands\n"
-        file << "* Use the command <tt>help command_name</tt> to get a help for +command_name+\n"
-        file << "* Use <tt>--</tt> to stop command line argument processing; useful if your arguments have dashes in them\n"
-        file << "\n"
-        if (global_options && global_options.length > 0)
-          file << "== Global Options\n"
-          file << "These options are available for any command and are specified before the name of the command\n\n"
-          output_flags(file,global_options)
-        end
-        file << "== Commands\n"
-        GLI.commands.values.sort.each do |command|
-          next if command == self
-          file << "[<tt>#{command.name}</tt>] #{command.description}\n"
-        end
-        file << "\n"
-
-        GLI.commands.values.sort.each do |command|
-          next if command == self
-          file << "=== <tt>#{command.name} #{command.arguments_description}</tt>\n\n"
-          file << "#{command.description}\n\n"
-          if command.aliases
-            file << "*Aliases*\n"
-            command.aliases.each do |al|
-              file << "* <tt><b>#{al}</b></tt>\n"
-            end 
-            file << "\n"
-          end
-          all_options = command.switches.merge(command.flags)
-          file << "#{command.long_description}\n\n" if command.long_description
-          if (all_options && all_options.length > 0)
-            file << "==== Options\n"
-            file << "These options are specified *after* the command.\n\n"
-            output_flags(file,all_options)
-          end
-        end
-      end
-    end
-
-    def output_flags(file,flags)
-      flags.values.sort.each do |flag|
-        file << "[<tt>#{flag.usage}</tt>] #{flag.description}"
-        if flag.kind_of? Flag
-          file << " <i>( default: <tt>#{flag.default_value}</tt>)</i>" if flag.default_value
-        end
-        file << "\n"
-        if flag.long_description
-          file << "\n"
-          # 12 is: 4 for tt, 5 for /tt, 2 for the brackets and 1 for spacing
-          (flag.usage.length + 12).times { file << " " }
-          file << "#{flag.long_description}\n\n"
-        end
-      end
-    end
-  end
-end