vli 0.0.3 → 0.0.4

data/lib/vli/command/base.rb

@@ -5,6 +5,7 @@
 module Vli
   module Command
     class Base
+      include Util::SafePuts
       
       def initialize(argv, env)
         @argv   = argv
@@ -13,6 +14,37 @@ module Vli
 
       def execute; end
 
+      # Parses the options given an OptionParser instance.
+      #
+      # This is a convenience method that properly handles duping the
+      # originally argv array so that it is not destroyed.
+      #
+      # This method will also automatically detect "-h" and "--help"
+      # and print help. And if any invalid options are detected, the help
+      # will be printed, as well.
+      #
+      # If this method returns `nil`, then you should assume that help
+      # was printed and parsing failed.
+      def parse_options(opts=nil)
+        # Creating a shallow copy of the arguments so the OptionParser
+        # doesn't destroy the originals.
+        argv = @argv.dup
+
+        # Default opts to a blank optionparser if none is given
+        opts ||= OptionParser.new
+
+        # Add the help option, which must be on every command.
+        opts.on_tail("-h", "--help", "Print this help") do
+          safe_puts(opts.help)
+          return nil
+        end
+
+        opts.parse!(argv)
+        return argv
+      rescue OptionParser::InvalidOption
+        raise Error::CLIInvalidOptions, :help => opts.help.chomp
+      end
+
       # This method will split the argv given into three parts: the
       # flags to this command, the subcommand, and the flags to the
       # subcommand. For example:

data/lib/vli/error.rb

@@ -1,7 +1,6 @@
 module Vli
   module Error
-
+    class CLIInvalidOptions < StandardError; end
     class VliInterrupt < StandardError; end
-
   end
 end

data/lib/vli/version.rb

@@ -1,3 +1,3 @@
 module Vli
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vli
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors: