shellopts 2.0.0.pre.8 → 2.0.0.pre.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b967bc79076cae64e2c68c3ef559568a4324d94f7d87800937b746e09755fcfe
-  data.tar.gz: 14c6a5866c6b33da7f7a27f050de46d03b7936842c366fb7b32121324f17d7b0
+  metadata.gz: abf197d1a00cb875a6ac80ba5dd672bfdf035778f2e281baa151b61b4ffb4644
+  data.tar.gz: 2e4f6a91002acbdd0ad2f528305e559606accb5f9b6f2b6610f88851a0cbd981
 SHA512:
-  metadata.gz: de339ab12a1ef41f75cbb386a6778adc0dca989f64e9180780c1e00276303824dacca681ccba287f746e0bf7b436b717384be48feb02b4b9faf4be3852c533a5
-  data.tar.gz: a4b286f8297d56afc672a8e9f21119580496c820a8377a419a1aca1905a08e67a5763ed1aa14678137a9c739f120d673a1227d7a18233b43a482e8c43c603d92
+  metadata.gz: 6297e1adbf0a1a6f9a6c3b1057ae2a9c904cc34f4dfad26ee9ae25f48400476ea128b3c834e23cbe0ed746a1c11a69001c74dcd422ec06eec04b3138b855cbf3
+  data.tar.gz: bc9b0549d18774cdfac16150693e30b707bae6eb718ee36f8964405a78794335aea39386cb67e5457b7652e276fd244e9f6ec88d73577756e87d7f9490fd80b4

data/lib/shellopts.rb

@@ -135,6 +135,7 @@ module ShellOpts
   def self.process(spec, argv, name: ::ShellOpts.default_name, usage: ::ShellOpts.default_usage) 
     @shellopts.nil? or reset
     @shellopts = ShellOpts.new(spec, argv, name: name, usage: usage)
+    @shellopts.process
   end
 
   # Process command line, set current shellopts object, and return a

data/lib/shellopts/args.rb

@@ -2,21 +2,23 @@
 module ShellOpts
   # Specialization of Array for arguments lists. Args extends Array with a
   # #extract and an #expect method to extract elements from the array. The
-  # methods call #error() in response to errors
+  # methods raise a ShellOpts::UserError exception in case of errors
   class Args < Array
     def initialize(shellopts, *args)
       @shellopts = shellopts
       super(*args)
     end
 
-    # Remove and return elements from beginning of the array. If
-    # +count_or_range+ is a number, that number of elements will be returned.
-    # If the count is one, a simple value is returned instead of an array.  If
-    # the count is negative, the elements will be removed from the end of the
-    # array. If +count_or_range+ is a range, the number of elements returned
-    # will be in that range. The range can't contain negative numbers #expect
-    # calls #error() if there's is not enough elements in the array to satisfy
-    # the request
+    # Remove and return elements from beginning of the array
+    #
+    # If +count_or_range+ is a number, that number of elements will be
+    # returned.  If the count is one, a simple value is returned instead of an
+    # array.  If the count is negative, the elements will be removed from the
+    # end of the array. If +count_or_range+ is a range, the number of elements
+    # returned will be in that range. The range can't contain negative numbers 
+    #
+    # #extract raise a ShellOpts::UserError exception if there's is not enough
+    # elements in the array to satisfy the request
     def extract(count_or_range, message = nil) 
       if count_or_range.is_a?(Range)
         range = count_or_range
@@ -33,8 +35,11 @@ module ShellOpts
       end
     end
 
-    # As extract except it doesn't allow negative counts and that the array is
+    # As #extract except it doesn't allow negative counts and that the array is
     # expect to be emptied by the operation
+    #
+    # #expect raise a ShellOpts::UserError exception if the array is not emptied 
+    # by the operation
     def expect(count_or_range, message = nil)
       count_or_range === self.size or inoa(message)
       extract(count_or_range) # Can't fail

data/lib/shellopts/shellopts.rb

@@ -39,17 +39,16 @@ module ShellOpts
     # The IDR generated from the Ast
     attr_reader :idr
 
-    # Compile a spec string into a grammar and use that to parse command line
-    # arguments
+    # Compile a spec string into a grammar
     #
     # +spec+ is the spec string, and +argv+ the command line (typically the
     # global ARGV array). +name+ is the name of the program and defaults to the
     # basename of the program
     #
-    # Syntax errors in the spec string are caused by the developer and raise a
-    # +ShellOpts::CompilerError+ exception. Errors in the +argv+ arguments are
-    # caused by the user and terminates the program with an error message and a
-    # short description of its spec
+    # Syntax errors in the spec string are caused by the developer and cause
+    # #initialize to raise a +ShellOpts::CompilerError+ exception. Errors in
+    # the +argv+ arguments are caused by the user and cause #process to raise
+    # ShellOpts::UserError exception
     #
     # TODO: Change to (name, spec, argv, usage: nil) because
     # ShellOpts::ShellOpts isn't a magician like the ShellOpts module
@@ -60,13 +59,21 @@ module ShellOpts
       @argv = argv
       begin
         @grammar = Grammar.compile(@name, @spec)
-        @ast = Ast.parse(@grammar, @argv)
-        @idr = Idr.generate(self)
       rescue Grammar::Compiler::Error => ex
         raise CompilerError.new(5, ex.message)
+      end
+    end
+
+    # Process command line arguments and return self. Raises a
+    # ShellOpts::UserError in case of an error
+    def process
+      begin
+        @ast = Ast.parse(@grammar, @argv)
+        @idr = Idr.generate(self)
       rescue Ast::Parser::Error => ex
         raise UserError.new(ex.message)
       end
+      self
     end
 
     # Return an array representation of options and commands in the same order

data/lib/shellopts/version.rb

@@ -1,3 +1,3 @@
 module Shellopts
-  VERSION = "2.0.0.pre.8"
+  VERSION = "2.0.0.pre.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shellopts
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.8
+  version: 2.0.0.pre.9
 platform: ruby
 authors:
 - Claus Rasmussen