gli 1.5.1 → 1.6.0

data/lib/gli.rb

@@ -29,6 +29,7 @@ module GLI
   @@program_desc = nil
   @@skips_pre = false
   @@skips_post = false
+  @@default_command = :help
 
   # Override the device of stderr; exposed only for testing
   def error_device=(e) #:nodoc:
@@ -44,12 +45,24 @@ module GLI
     @@config_file = nil
     @@use_openstruct = false
     @@prog_desc = nil
+    @@default_command = :help
     clear_nexts
 
     desc 'Show this message'
     switch :help
   end
 
+  # Sets a default command to run when none is specified on the command line.  Note that
+  # if you use this, you won't be able to pass arguments, flags, or switches
+  # to the command when run in default mode.  All flags and switches are treated
+  # as global, and any argument will be interpretted as the command name and likely
+  # fail.
+  #
+  # +command+:: Command to run as default
+  def default_command(command)
+    @@default_command = command.to_sym
+  end
+
   # Describe the next switch, flag, or command.  This should be a
   # short, one-line description
   #
@@ -60,7 +73,7 @@ module GLI
   # of what your program does that will appear in the help output.
   #
   # +description+:: A String of the short description of your program's purpose
-  def program_desc(description=nil) 
+  def program_desc(description=nil)
     if description
       @@program_desc = description
     end
@@ -140,7 +153,7 @@ module GLI
     clear_nexts
   end
 
-  # Sets that this app uses a config file as well as the name of the config file.  
+  # Sets that this app uses a config file as well as the name of the config file.
   #
   # +filename+:: A String representing the path to the file to use for the config file.  If it's an absolute
   #              path, this is treated as the path to the file.  If it's *not*, it's treated as relative to the user's home
@@ -187,7 +200,7 @@ module GLI
   # Define a block to run if an error occurs.
   # The block will receive any Exception that was caught.
   # It should evaluate to false to avoid the built-in error handling (which basically just
-  # prints out a message). GLI uses a variety of exceptions that you can use to find out what 
+  # prints out a message). GLI uses a variety of exceptions that you can use to find out what
   # errors might've occurred during command-line parsing:
   # * GLI::CustomExit
   # * GLI::UnknownCommandArgument
@@ -200,7 +213,7 @@ module GLI
 
   # Indicate the version of your application
   #
-  # +version+:: String containing the version of your application.  
+  # +version+:: String containing the version of your application.
   def version(version)
     @@version = version
   end
@@ -215,7 +228,7 @@ 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
   #
@@ -233,7 +246,7 @@ module GLI
       global_options = convert_to_openstruct?(global_options)
       options = convert_to_openstruct?(options)
       if proceed?(global_options,command,options,arguments)
-        command = commands[:help] if !command
+        command = commands[@@default_command] if !command
         command.execute(global_options,options,arguments)
         if !command.skips_post && @@post_block
           @@post_block.call(global_options,command,options,arguments)
@@ -258,8 +271,8 @@ module GLI
   def proceed?(global_options,command,options,arguments) #:nodoc:
     if command && command.skips_pre
       true
-    elsif @@pre_block 
-      @@pre_block.call(global_options,command,options,arguments) 
+    elsif @@pre_block
+      @@pre_block.call(global_options,command,options,arguments)
     else
       true
     end
@@ -290,7 +303,7 @@ module GLI
     msg
   end
 
-  # Simpler means of exiting with a custom exit code.  This will 
+  # 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)
@@ -343,7 +356,7 @@ module GLI
 
   # Returns an array of four values:
   #  * global options (as a Hash)
-  #  * Command 
+  #  * Command
   #  * command options (as a Hash)
   #  * arguments (as an Array)
   def parse_options(args) # :nodoc:
@@ -442,7 +455,7 @@ module GLI
     try_me = args[0..non_flag_i]
     rest = args[(non_flag_i+1)..args.length]
     if all_flags
-      try_me = args 
+      try_me = args
       rest = []
     end
 
@@ -468,7 +481,7 @@ module GLI
       # it, we want to override it with the real value.
       # HOWEVER, sometimes this happens in reverse, so we want to err on taking the
       # user-provided, non-default value where possible.
-      if value 
+      if value
         if options[name]
           options[name] = value if options[name] == flag.default_value
         else
@@ -485,13 +498,13 @@ module GLI
     else
       if command
         check = rest
-        check = rest + try_me if all_flags 
-        check.each() do |arg| 
+        check = rest + try_me if all_flags
+        check.each() do |arg|
           if arg =~ /^\-\-$/
             try_me.delete arg
-            break 
+            break
           end
-          raise UnknownCommandArgument.new("Unknown option #{arg}",command) if arg =~ /^\-/ 
+          raise UnknownCommandArgument.new("Unknown option #{arg}",command) if arg =~ /^\-/
         end
         return [global_options,command,command_options,try_me + rest]
       else

data/lib/gli_version.rb

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

data/lib/support/help.rb

@@ -150,32 +150,30 @@ module GLI
       line_length = Terminal.instance.size[0]
     end
     line_padding = sprintf("%#{pad_length}s",'')
-    words = line.split(/\s+/)
-    return line if !words || words.empty?
-    wrapped = ''
-    while wrapped.length + line_padding.length < line_length
-      wrapped += ' ' if wrapped.length > 0
-      word = words.shift
-      if (wrapped.length + line_padding.length + word.length > line_length)
-        words.unshift word
-        break;
-      end
-      wrapped += word
-      return wrapped if words.empty?
+    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 += "\n"
-    this_line = line_padding
-    words.each do |word|
-      if this_line.length + word.length >= line_length
-        wrapped += this_line
-        wrapped += "\n"
-        this_line = line_padding + word
+    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 += ' ' if this_line.length > line_padding.length
+        this_line += ' ' unless this_line.empty?
         this_line += word
       end
     end
-    wrapped.chomp!
-    wrapped + "\n" + this_line
+
+    lines << this_line
   end
+
 end

data/lib/support/scaffold.rb

@@ -51,6 +51,7 @@ spec = Gem::Specification.new do |s|
 # Add your other files here if you make them
   s.files = %w(
 bin/#{project_name}
+lib/#{project_name}_version.rb
   )
   s.require_paths << 'lib'
   s.has_rdoc = true
@@ -60,6 +61,7 @@ bin/#{project_name}
   s.executables << '#{project_name}'
   s.add_development_dependency('rake')
   s.add_development_dependency('rdoc')
+  s.add_runtime_dependency('gli')
 end
 EOS
       end

metadata

@@ -1,188 +1,133 @@
 --- !ruby/object:Gem::Specification
-name: !binary |-
-  Z2xp
+name: gli
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
   prerelease: 
 platform: ruby
 authors:
-- !binary |-
-  RGF2aWQgQ29wZWxhbmQ=
+- David Copeland
 autorequire: 
-bindir: !binary |-
-  Ymlu
+bindir: bin
 cert_chain: []
-date: 2012-02-07 00:00:00.000000000 Z
+date: 2012-04-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: !binary |-
-    cmFrZQ==
-  requirement: &70298245125980 !ruby/object:Gem::Requirement
+  name: rake
+  requirement: &70269061967140 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - !binary |-
-        fj4=
+    - - ~>
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MC45LjIuMg==
+        version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *70298245125980
+  version_requirements: *70269061967140
 - !ruby/object:Gem::Dependency
-  name: !binary |-
-    cmRvYw==
-  requirement: &70298245125280 !ruby/object:Gem::Requirement
+  name: rdoc
+  requirement: &70269061966560 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - !binary |-
-        fj4=
+    - - ~>
       - !ruby/object:Gem::Version
-        version: !binary |-
-          My4xMQ==
+        version: '3.11'
   type: :development
   prerelease: false
-  version_requirements: *70298245125280
+  version_requirements: *70269061966560
 - !ruby/object:Gem::Dependency
-  name: !binary |-
-    cmVlaw==
-  requirement: &70298245124700 !ruby/object:Gem::Requirement
+  name: reek
+  requirement: &70269061965940 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - !binary |-
-        fj4=
+    - - ~>
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MS4yLjA=
+        version: 1.2.0
   type: :development
   prerelease: false
-  version_requirements: *70298245124700
+  version_requirements: *70269061965940
 - !ruby/object:Gem::Dependency
-  name: !binary |-
-    cm9vZGk=
-  requirement: &70298245123940 !ruby/object:Gem::Requirement
+  name: roodi
+  requirement: &70269061965300 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - !binary |-
-        fj4=
+    - - ~>
       - !ruby/object:Gem::Version
-        version: !binary |-
-          Mi4xLjA=
+        version: 2.1.0
   type: :development
   prerelease: false
-  version_requirements: *70298245123940
+  version_requirements: *70269061965300
 - !ruby/object:Gem::Dependency
-  name: !binary |-
-    Z3JhbmNoZXI=
-  requirement: &70298245123160 !ruby/object:Gem::Requirement
+  name: grancher
+  requirement: &70269061964780 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - !binary |-
-        fj4=
+    - - ~>
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MC4xLjU=
+        version: 0.1.5
   type: :development
   prerelease: false
-  version_requirements: *70298245123160
+  version_requirements: *70269061964780
 - !ruby/object:Gem::Dependency
-  name: !binary |-
-    cmFpbmJvdw==
-  requirement: &70298245122480 !ruby/object:Gem::Requirement
+  name: rainbow
+  requirement: &70269061964240 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - !binary |-
-        fj4=
+    - - ~>
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MS4xLjE=
+        version: 1.1.1
   type: :development
   prerelease: false
-  version_requirements: *70298245122480
+  version_requirements: *70269061964240
 - !ruby/object:Gem::Dependency
-  name: !binary |-
-    YXJ1YmE=
-  requirement: &70298245121760 !ruby/object:Gem::Requirement
+  name: aruba
+  requirement: &70269061896020 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - !binary |-
-        fj4=
+    - - ~>
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MC40Ljc=
+        version: 0.4.7
   type: :development
   prerelease: false
-  version_requirements: *70298245121760
-description: !binary |-
-  QW4gYXBwbGljYXRpb24gYW5kIEFQSSBmb3IgZGVzY3JpYmluZyBjb21tYW5k
-  IGxpbmUgaW50ZXJmYWNlcyB0aGF0IGNhbiBiZSB1c2VkIHRvIHF1aWNrbHkg
-  Y3JlYXRlIGEgc2hlbGwgZm9yIGV4ZWN1dGluZyBjb21tYW5kLWxpbmUgdGFz
-  a3MuICBUaGUgY29tbWFuZCBsaW5lIHVzZXIgaW50ZXJmYWNlIGlzIHNpbWls
-  YXIgdG8gR2l0cywgaW4gdGhhdCBpdCB0YWtlcyBnbG9iYWwgb3B0aW9ucywg
-  YSBjb21tYW5kLCBjb21tYW5kLXNwZWNpZmljIG9wdGlvbnMsIGFuZCBhcmd1
-  bWVudHM=
-email: !binary |-
-  ZGF2aWRjb3BlbGFuZEBuYWlsZHJpdmluNS5jb20=
+  version_requirements: *70269061896020
+description: An application and API for describing command line interfaces that can
+  be used to quickly create a shell for executing command-line tasks.  The command
+  line user interface is similar to Gits, in that it takes global options, a command,
+  command-specific options, and arguments
+email: davidcopeland@naildrivin5.com
 executables:
-- !binary |-
-  Z2xp
+- gli
 extensions: []
 extra_rdoc_files:
-- !binary |-
-  UkVBRE1FLnJkb2M=
-- !binary |-
-  Z2xpLnJkb2M=
+- README.rdoc
+- gli.rdoc
 files:
-- !binary |-
-  bGliL2dsaS9jb21tYW5kLnJi
-- !binary |-
-  bGliL2dsaS9jb21tYW5kX2xpbmVfdG9rZW4ucmI=
-- !binary |-
-  bGliL2dsaS9jb3B5X29wdGlvbnNfdG9fYWxpYXNlcy5yYg==
-- !binary |-
-  bGliL2dsaS9mbGFnLnJi
-- !binary |-
-  bGliL2dsaS9zd2l0Y2gucmI=
-- !binary |-
-  bGliL2dsaS9vcHRpb25zLnJi
-- !binary |-
-  bGliL2dsaS9leGNlcHRpb25zLnJi
-- !binary |-
-  bGliL2dsaS90ZXJtaW5hbC5yYg==
-- !binary |-
-  bGliL2dsaS5yYg==
-- !binary |-
-  bGliL2dsaV92ZXJzaW9uLnJi
-- !binary |-
-  bGliL3N1cHBvcnQvaGVscC5yYg==
-- !binary |-
-  bGliL3N1cHBvcnQvcmRvYy5yYg==
-- !binary |-
-  bGliL3N1cHBvcnQvc2NhZmZvbGQucmI=
-- !binary |-
-  bGliL3N1cHBvcnQvaW5pdGNvbmZpZy5yYg==
-- !binary |-
-  YmluL2dsaQ==
-- !binary |-
-  UkVBRE1FLnJkb2M=
-- !binary |-
-  Z2xpLnJkb2M=
-homepage: !binary |-
-  aHR0cDovL2RhdmV0cm9uNTAwMC5naXRodWIuY29tL2dsaQ==
+- lib/gli/command.rb
+- lib/gli/command_line_token.rb
+- lib/gli/copy_options_to_aliases.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
+- lib/support/rdoc.rb
+- lib/support/scaffold.rb
+- lib/support/initconfig.rb
+- bin/gli
+- README.rdoc
+- gli.rdoc
+homepage: http://davetron5000.github.com/gli
 licenses: []
 post_install_message: 
 rdoc_options:
-- !binary |-
-  LS10aXRsZQ==
-- !binary |-
-  R2l0IExpa2UgSW50ZXJmYWNl
-- !binary |-
-  LS1tYWlu
-- !binary |-
-  UkVBRE1FLnJkb2M=
+- --title
+- Git Like Interface
+- --main
+- README.rdoc
 require_paths:
 - lib
-- !binary |-
-  bGli
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -191,7 +136,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2888494682899839059
+      hash: -3214351787275830697
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -200,14 +145,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2888494682899839059
+      hash: -3214351787275830697
 requirements: []
-rubyforge_project: !binary |-
-  Z2xp
+rubyforge_project: gli
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: !binary |-
-  QSBHaXQgTGlrZSBJbnRlcmZhY2UgZm9yIGJ1aWxkaW5nIGNvbW1hbmQgbGlu
-  ZSBhcHBz
+summary: A Git Like Interface for building command line apps
 test_files: []