gli 1.2.2 → 1.2.5

data/README.rdoc

@@ -13,7 +13,7 @@ This is a DSL you can use to create a command line interface like git, gem or sv
 
 Install if you need to:
 
-    sudo gem install gli
+    gem install gli
 
 The simplest way to get started is to create a scaffold project
 
@@ -46,5 +46,6 @@ Extensive documentation is {available at the wiki}[https://github.com/davetron50
 * [http://davetron5000.github.com/gli] - RubyDoc
 * [http://www.github.com/davetron5000/gli] - Source on GitHub
 * [http://www.github.com/davetron5000/gli/wiki] - Documentation Wiki
+* [http://www.github.com/davetron5000/gli/wiki/Changelog] - Changelog
 
 :include:gli.rdoc

data/lib/gli.rb

@@ -3,6 +3,7 @@ require 'gli/command.rb'
 require 'gli/switch.rb'
 require 'gli/flag.rb'
 require 'gli/options.rb'
+require 'gli/exceptions.rb'
 require 'gli_version.rb'
 require 'support/help.rb'
 require 'support/rdoc.rb'
@@ -124,7 +125,11 @@ module GLI
     @@use_openstruct = use_openstruct
   end
 
-  # Runs whatever command is needed based on the arguments.
+  # Runs whatever command is needed based on the arguments. 
+  #
+  # args - the command line ARGV array
+  #
+  # Returns a number that would be a reasonable exit code
   def run(args)
     rdoc = RDocCommand.new
     commands[:rdoc] = rdoc if !commands[:rdoc]
@@ -142,6 +147,7 @@ module GLI
         command.execute(global_options,options,arguments)
         @@post_block.call(global_options,command,options,arguments) if @@post_block 
       end
+      0
     rescue Exception => ex
       regular_error_handling = true
       regular_error_handling = @@error_block.call(ex) if @@error_block
@@ -149,9 +155,25 @@ module GLI
       if regular_error_handling
         $stderr.puts "error: #{ex.message}"
       end
+
+      raise ex if ENV['GLI_DEBUG'] == 'true'
+
+      case ex
+      when BadCommandLine then -1
+      when CustomExit then ex.exit_code
+      else 
+        -2
+      end
     end
   end
 
+  # Simpler means of exiting with a custom exit code.  This will 
+  # raise a CustomExit with the given message and exit code, which will ultimatley
+  # cause your application to exit with the given exit_code as its exit status
+  def exit_now!(message,exit_code)
+    raise CustomExit.new(message,exit_code)
+  end
+
   # Possibly returns a copy of the passed-in Hash as an instance of GLI::Option.
   # By default, it will *not*, however by putting <tt>use_openstruct true</tt>
   # in your CLI definition, it will
@@ -278,7 +300,7 @@ module GLI
       if !command
         command_name = args.shift
         command = find_command(command_name)
-        raise "Unknown command '#{command_name}'" if !command
+        raise BadCommandLine.new("Unknown command '#{command_name}'") if !command
         return parse_options_helper(args,
                                     global_options,
                                     command,
@@ -344,16 +366,16 @@ module GLI
             try_me.delete arg
             break 
           end
-          raise "Unknown argument #{arg}" if arg =~ /^\-/ 
+          raise BadCommandLine.new("Unknown argument #{arg}") if arg =~ /^\-/ 
         end
         return [global_options,command,command_options,try_me + rest]
       else
         # Now we have our command name
         command_name = try_me.shift
-        raise "Unknown argument #{command_name}" if command_name =~ /^\-/
+        raise BadCommandLine.new("Unknown argument #{command_name}") if command_name =~ /^\-/
 
         command = find_command(command_name)
-        raise "Unknown command '#{command_name}'" if !command
+        raise BadCommandLine.new("Unknown command '#{command_name}'") if !command
 
         return parse_options_helper(rest,
                                     global_options,

data/lib/gli/exceptions.rb

@@ -0,0 +1,28 @@
+module GLI
+  # Indicates that the command line invocation was bad
+  class BadCommandLine < Exception
+    def initialize(message)
+      super(message)
+    end
+  end
+
+  # Raise this if you want to use an exit status that isn't the default
+  # provided by GLI.
+  #
+  # Example:
+  #
+  #     raise CustomExit.new("Not connected to DB",-5) unless connected?
+  #     raise CustomExit.new("Bad SQL",-6) unless valid_sql?(args[0])
+  #
+  class CustomExit < Exception
+    attr_reader :exit_code
+    # Create a custom exit exception
+    #
+    # message - String containing error message to show the user
+    # exit_code - the exit code to use, overridding GLI's default
+    def initialize(message,exit_code)
+      super(message)
+      @exit_code = exit_code
+    end
+  end
+end

data/lib/gli/flag.rb

@@ -24,7 +24,7 @@ module GLI
               args.delete_at index
               return value
             else
-              raise "#{matched} requires an argument"
+              raise BadCommandLine.new("#{matched} requires an argument")
             end
           else
             return value
@@ -38,7 +38,7 @@ module GLI
       if @names[arg]
         return [true,arg,nil] if arg.length == 2
         # This means we matched the long-form, but there's no argument
-        raise "#{arg} requires an argument via #{arg}=argument"
+        raise BadCommandLine.new("#{arg} requires an argument via #{arg}=argument")
       end
       @names.keys.each() do |name|
         match_string = "^#{name}=(.*)$"

data/lib/gli/terminal.rb

@@ -0,0 +1,72 @@
+module GLI
+  # Class to encapsulate stuff about the terminal.  This is a singleton, mostly to facilitate testing.
+  #
+  # Example:
+  #
+  #     Terminal.instance.size[0] # => columns in the terminal
+  #     Terminal.default_size = [128,24] # => change default when we can't figure it out
+  #     raise "no ls?!?!?" unless Terminal.instance.command_exists?("ls")
+  #
+  class Terminal
+
+    @@default_size = [80,24]
+
+    # Get the default size of the terminal when we can't figure it out
+    # 
+    # Returns an array of int [cols,rows]
+    def self.default_size
+      @@default_size
+    end
+
+    # Set the default size of the terminal to use when we can't figure it out
+    #
+    # size - array of two int [cols,rows]
+    def self.default_size=(size)
+      @@default_size = size
+    end
+
+    # Provide access to the shared instance
+    def self.instance; @@instance ||= Terminal.new; end
+
+    # Call this to cause methods to throw exceptions rather than return a sane default.  You
+    # probably don't want to call this unless you are writing tests
+    def make_unsafe!;
+      @unsafe = true
+    end
+
+    # Returns true if the given command exists on this system
+    #
+    # command - The command to check for
+    def command_exists?(command)
+      ENV['PATH'].split(File::PATH_SEPARATOR).any? {|d| File.exists? File.join(d, command) }
+    end
+
+    # Ripped from hirb https://github.com/cldwalker/hirb/blob/master/lib/hirb/util.rb
+    # Returns an array of size two ints representing the terminal width and height
+    def size
+      if (ENV['COLUMNS'] =~ /^\d+$/) && (ENV['LINES'] =~ /^\d+$/)
+        [ENV['COLUMNS'].to_i, ENV['LINES'].to_i]
+      elsif (jruby? || (!STDIN.tty? && ENV['TERM'])) && command_exists?('tput')
+        [run_command('tput cols').to_i, run_command('tput lines').to_i]
+      elsif STDIN.tty? && command_exists?('stty')
+        run_command('stty size').scan(/\d+/).map { |s| s.to_i }.reverse
+      else
+        Terminal.default_size
+      end
+    rescue Exception => ex
+      raise ex if @unsafe
+      Terminal.default_size
+    end
+
+    private
+
+    # Runs a command using backticks.  Extracted to allow for testing
+    def run_command(command)
+      `#{command}`
+    end
+
+    # True if we are JRuby; exposed to allow for testing
+    def jruby?; RUBY_PLATFORM =~ /java/; end
+
+  end
+end

data/lib/gli_version.rb

@@ -1,3 +1,3 @@
 module GLI
-  VERSION = '1.2.2'
+  VERSION = '1.2.5'
 end

data/lib/support/help.rb

@@ -1,5 +1,6 @@
 require 'gli'
 require 'gli/command'
+require 'gli/terminal'
 
 module GLI
   class DefaultHelpCommand < Command
@@ -119,7 +120,10 @@ module GLI
   # 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=80)
+  def wrap(line,pad_length=0,line_length=nil)
+    if line_length.nil?
+      line_length = Terminal.instance.size[0]
+    end
     line_padding = sprintf("%#{pad_length}s",'')
     words = line.split(/\s+/)
     return line if !words || words.empty?

data/lib/support/scaffold.rb

@@ -236,7 +236,7 @@ on_error do |exception|
   true
 end
 
-GLI.run(ARGV)
+exit GLI.run(ARGV)
 EOS
             puts "Created #{bin_file}"
           end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gli
 version: !ruby/object:Gem::Version 
+  hash: 21
   prerelease: false
   segments: 
   - 1
   - 2
-  - 2
-  version: 1.2.2
+  - 5
+  version: 1.2.5
 platform: ruby
 authors: 
 - David Copeland
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-11 00:00:00 -05:00
+date: 2010-12-12 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -27,13 +28,14 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 - gli.rdoc
-- CHANGELOG.rdoc
 files: 
 - lib/gli/command.rb
 - lib/gli/command_line_token.rb
 - lib/gli/flag.rb
 - lib/gli/switch.rb
 - lib/gli/options.rb
+- lib/gli/exceptions.rb
+- lib/gli/terminal.rb
 - lib/gli.rb
 - lib/gli_version.rb
 - lib/support/help.rb
@@ -43,7 +45,6 @@ files:
 - bin/gli
 - README.rdoc
 - gli.rdoc
-- CHANGELOG.rdoc
 has_rdoc: true
 homepage: http://davetron5000.github.com/gli
 licenses: []
@@ -63,6 +64,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -71,6 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"

data/CHANGELOG.rdoc

@@ -1,25 +0,0 @@
-== Changelog
-=== 1.2.2 - 12/11/2010
-
-* Changed uses of <code>map(&:symbol)</code> to older form, since this doesn't work on 100% of Ruby 1.8.7s.
-
-=== 1.2.1 - 11/26/2010
-
-* Changed default data structure of options *back* to a <tt>Hash</tt>.  If you want to use the <tt>OpenStruct</tt> subclass <tt>Options</tt>, simply put <tt>use_openstruct true</tt> in your command line definition.
-
-=== 1.2.0 - 11/26/2010
-
-* Added ability to use +help+ command to list commands suitable for creating bash completion script
-* <code>options</code> and <code>global_options</code> will now contain values for all aliases of each flag and switch, so if you created a flag with <code>flag [:f,:flag]</code> and the user specifies <code>-f foo</code> on the command line, both <code>options[:f]</code> and <code>options[:flag]</code> will have the value <code>foo</code>.  Same behavior for <code>--flag=foo</code>.
-* You may now no-longer use names that have already been used.  So if you declare a switch <code>switch :foo</code> and then later declare a flag <code>flag [:f,:foo]</code>, you get an <code>ArgumentError</code>. This is only checked within relevant scope, so you can still use the same option names between commands, and you can still have the same option name once in global and once in command scope.  This is really a bugfix as the behavior of GLI was not clear before.
-* <tt>long_desc</tt> now shows up in generated rdoc for flags and switches
-* Scaffoling now generates a usable <code>Gemfile</code> for bundler
-* More direct support for version numbers in GLI-managed apps
-
-=== 1.1.3 - 10/24/2010
-
-* Changed the way we locate <code>__FILE__</code>'s directory; if it's a symlink it would've have worked.  Required adding <code>:realpath</code> method to <code>File</code> for pre 1.9.2 rubies
-
-=== 0.0 - 1.1.2
-
-No changelog tracking was done for these versions :(