shellopts 2.0.0.pre.3 → 2.0.0.pre.11

data/lib/shellopts/parser.rb

@@ -16,7 +16,7 @@ module ShellOpts
     end
 
   private
-    # Parse a command line
+    # Parse a subcommand line
     class Parser
       class Error < RuntimeError; end
 
@@ -27,24 +27,24 @@ module ShellOpts
 
       def call
         program = Ast::Program.new(@grammar)
-        parse_command(program)
+        parse_subcommand(program)
         program.arguments = @argv
         program
       end
 
     private
-      def parse_command(command)
-        @seen_options = {} # Every new command resets the seen options
+      def parse_subcommand(subcommand)
+        @seen_options = {} # Every new subcommand resets the seen options
         while arg = @argv.first
           if arg == "--"
             @argv.shift
             break
           elsif arg.start_with?("-")
-            parse_option(command)
-          elsif cmd = command.grammar.commands[arg]
+            parse_option(subcommand)
+          elsif cmd = subcommand.grammar.subcommands[arg]
             @argv.shift
-            command.command = Ast::Command.new(cmd, arg)
-            parse_command(command.command)
+            subcommand.subcommand = Ast::Command.new(cmd, arg)
+            parse_subcommand(subcommand.subcommand)
             break
           else
             break
@@ -52,7 +52,7 @@ module ShellOpts
         end
       end
 
-      def parse_option(command)
+      def parse_option(subcommand)
         # Split into name and argument
         case @argv.first
           when /^(--.+?)(?:=(.*))?$/
@@ -62,7 +62,7 @@ module ShellOpts
         end
         @argv.shift
 
-        option = command.grammar.options[name] or raise Error, "Unknown option '#{name}'"
+        option = subcommand.grammar.options[name] or raise Error, "Unknown option '#{name}'"
         !@seen_options.key?(option.key) || option.repeated? or raise Error, "Duplicate option '#{name}'"
         @seen_options[option.key] = true
 
@@ -83,7 +83,7 @@ module ShellOpts
           raise Error, "No argument allowed for option '#{name}'"
         end
 
-        command.options << Ast::Option.new(option, name, arg)
+        subcommand.options << Ast::Option.new(option, name, arg)
       end
 
       def parse_arg(option, name, arg)

data/lib/shellopts/shellopts.rb

@@ -6,7 +6,7 @@ require "shellopts/args.rb"
 # TODO
 #
 # PROCESSING
-#   1. Compile usage string and yield a grammar
+#   1. Compile spec string and yield a grammar
 #   2. Parse the options using the grammar and yield an AST
 #   3. Construct the Program model from the AST
 #   4. Apply defaults to the model
@@ -17,19 +17,20 @@ require "shellopts/args.rb"
 module ShellOpts
   # The command line processing object
   class ShellOpts
-    # One of :key, :name, :option
-    #
-    #         Option   Command
-    # :key    key      #command! (no collision)
-    # :name   name     #command (possible collision)
-    # :option --option #command (multihash, no collision) (TODO)
-    #
-    DEFAULT_USE = :key
-
     # Name of program
-    attr_reader :name
+    attr_accessor :name
+
+    # Usage string. If #usage is nil, the auto-generated default is used
+    def usage() @usage || @grammar.usage end
+    def usage=(usage) @usage = usage end
+
+    # Specification of the command
+    attr_reader :spec
 
-    # The grammar compiled from the usage string
+    # Original argv argument
+    attr_reader :argv
+
+    # The grammar compiled from the spec string
     attr_reader :grammar
 
     # The AST parsed from the command line arguments
@@ -38,33 +39,41 @@ module ShellOpts
     # The IDR generated from the Ast
     attr_reader :idr
 
-    # Object for error & fail messages. Default is to write a message on
-    # standard error and exit with status 1
-    attr_accessor :messenger
-
-    # Compile a usage string into a grammar and use that to parse command line
-    # arguments
+    # Compile a spec string into a grammar
     #
-    # +usage+ is the usage string, and +argv+ the command line (typically the
+    # +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 usage 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 usage
-    def initialize(usage, argv, name: PROGRAM, messenger: nil)
+    # 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
+    def initialize(spec, argv, name: ::ShellOpts.default_name, usage: ::ShellOpts.default_usage)
       @name = name
+      @spec = spec
+      @usage = usage
+      @argv = argv
       begin
-        @grammar = Grammar.compile(name, usage)
-        @messenger = messenger || Messenger.new(name, @grammar.usage)
-        @ast = Ast.parse(@grammar, argv)
-        @idr = Idr.generate(@ast, @messenger)
+        @grammar = Grammar.compile(@name, @spec)
       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
-        error(ex.message)
+        raise UserError.new(ex.message)
       end
+      self
     end
 
     # Return an array representation of options and commands in the same order
@@ -75,10 +84,18 @@ module ShellOpts
     def to_a() idr.to_a end
 
     # Return a hash representation of the options. See {ShellOpts::OptionsHash}
-    def to_h(use: :key, aliases: {}) @idr.to_h(use: use, aliases: aliases) end
+    def to_h(key_type: ::ShellOpts.default_key_type, aliases: {})
+      @idr.to_h(key_type: :key_type, aliases: aliases) 
+    end
+
+    # TODO
+    # Return OptionHash object
+    # def to_hash(...)
 
     # Return a struct representation of the options. See {ShellOpts::OptionStruct}
-    def to_struct(use: :key, aliases: {}) @idr.to_struct(use: use, aliases: aliases) end
+    def to_struct(key_type: ::ShellOpts.default_key_type, aliases: {}) 
+      @idr.to_struct(key_type: key_type, aliases: aliases) 
+    end
 
     # List of remaining non-option command line arguments. Returns a Argv object
     def args() Args.new(self, ast&.arguments) end
@@ -86,15 +103,21 @@ module ShellOpts
     # Iterate options and commands as name/value pairs. Same as +to_a.each+
     def each(&block) to_a.each(&block) end
 
-    # Print error messages and usage string and exit with status 1. This method
+    # Print error messages and spec string and exit with status 1. This method
     # should be called in response to user-errors (eg. specifying an illegal
     # option)
-    def error(*msgs) @messenger.error(*msgs) end
+    def error(*msgs, exit: true)
+      msg = "#{name}: #{msgs.join}\n" + (@usage ? usage : "Usage: #{name} #{usage}")
+      $stderr.puts msg.rstrip
+      exit(1) if exit
+    end
 
     # Print error message and exit with status 1. This method should called in
     # response to system errors (like disk full)
-    def fail(*msgs) @messenger.fail(*msgs) end
+    def fail(*msgs, exit: true)
+      $stderr.puts "#{name}: #{msgs.join}"
+      exit(1) if exit
+    end
   end
 end
 
-

data/lib/shellopts/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shellopts
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.3
+  version: 2.0.0.pre.11
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2020-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -105,6 +105,7 @@ files:
 - bin/setup
 - doc/stylesheet.css
 - lib/ext/array.rb
+- lib/main.rb
 - lib/shellopts.rb
 - lib/shellopts/args.rb
 - lib/shellopts/ast/command.rb
@@ -118,13 +119,11 @@ files:
 - lib/shellopts/grammar/option.rb
 - lib/shellopts/grammar/program.rb
 - lib/shellopts/idr.rb
-- lib/shellopts/messenger.rb
+- lib/shellopts/main.rb
 - lib/shellopts/option_struct.rb
 - lib/shellopts/parser.rb
 - lib/shellopts/shellopts.rb
-- lib/shellopts/utils.rb
 - lib/shellopts/version.rb
-- rs
 - shellopts.gemspec
 homepage: http://github.com/clrgit/shellopts
 licenses: []

data/lib/shellopts/messenger.rb

@@ -1,71 +0,0 @@
-
-module ShellOpts
-  # Service object for output of messages
-  #
-  # Messages are using the common command line formats
-  #
-  class Messenger
-    # Name of the program. When assigning to +name+ prefixed and suffixed
-    # whitespaces are removed
-    attr_accessor :name
-
-    # :nodoc:
-    def name=(name) @name = name.strip end
-    # :nodoc:
-
-    # Usage string. If not nil the usage string is printed by #error. When
-    # assigning to +usage+ suffixed whitespaces are removed and the format
-    # automatically set to +:custom+
-    attr_accessor :usage
-
-    # :nodoc:
-    def usage=(usage) 
-      @format = :custom
-      @usage = usage&.rstrip
-    end
-    # :nodoc:
-
-    # Format of the usage string: +:default+ prefixes the +usage+ with 'Usage:
-    # #{name} ' before printing. +:custom+ prints +usage+ as is
-    attr_accessor :format
-
-    # Initialize a Messenger object. +name+ is the name of the name and +usage+
-    # is a short description of the options (eg. '-a -b') or a longer multiline
-    # explanation. The +:format+ option selects bewtween the two: +short+ (the
-    # default) or :long. Note that 
-    #
-    def initialize(name, usage, format: :default)
-      @name = name
-      @usage = usage
-      @format = format
-    end
-
-    # Print error message and usage string and exit with status 1. Output is
-    # using the following format
-    #
-    #   <name name>: <message>
-    #   Usage: <name name> <options and arguments>
-    #
-    def error(*msgs)
-      $stderr.print "#{name}: #{msgs.join}\n"
-      if usage
-        $stderr.print "Usage: #{name} " if format == :default
-        $stderr.print "#{usage}\n"
-      end
-      exit 1
-    end
-
-    # Print error message and exit with status 1. It use the current ShellOpts
-    # object if defined. This method should not be called in response to
-    # user-errors but system errors (like disk full). Output is using the
-    # following format:
-    #
-    #   <name name>: <message>
-    #
-    def fail(*msgs)
-      $stderr.puts "#{name}: #{msgs.join}"
-      exit 1
-    end
-  end
-end
-

data/lib/shellopts/utils.rb

@@ -1,16 +0,0 @@
-
-module ShellOpts
-  # Use `include ShellOpts::Utils` to include ShellOpts utility methods in the
-  # global namespace
-  module Utils
-    # Forwards to `ShellOpts.error`
-    def error(*msgs)
-      ::ShellOpts.error(*msgs)
-    end
-
-    # Forwards to `ShellOpts.fail`
-    def fail(*msgs)
-      ::ShellOpts.fail(*msgs)
-    end
-  end
-end

data/rs

@@ -1,40 +0,0 @@
-#!/usr/bin/bash
-
-PROGRAM=$(basename $0)
-USAGE="SOURCE-FILE"
-
-function error() {
-    echo "$PROGRAM: $@"
-    echo "Usage: $PROGRAM $USAGE"
-    exit 1
-} >&2
-
-[ $# = 1 ] || error "Illegal number of arguments"
-SOURCE_NAME=${1%.rb}.rb
-
-GEM_FILE=$(ls *.gemspec 2>/dev/null)
-[ -n "$GEM_FILE" ] || error "Can't find gemspec file"
-GEM_NAME=${GEM_FILE%.gemspec}
-
-if [ -f lib/$SOURCE_NAME ]; then
-    SOURCE_FILE=lib/$SOURCE_NAME
-elif [ -f lib/$GEM_NAME/$SOURCE_NAME ]; then
-    SOURCE_FILE=lib/$GEM_NAME/$SOURCE_NAME
-else    
-    SOURCE_FILE=$(find lib/$GEM_NAME -type f -path $SOURCE_NAME | head -1)
-    if [ -z "$SOURCE_FILE" ]; then
-        SOURCE_FILE=lib/$GEM_NAME/$SOURCE_NAME
-    fi
-fi
-
-SPEC_FILE=spec/${SOURCE_NAME%.rb}_spec.rb
-[ -f $SPEC_FILE ] || error "Can't find spec file '$SPEC_FILE'"
-
-rspec --fail-fast $SPEC_FILE || { 
-    # rcov forgets a newline when rspec fails
-    status=$?; echo; exit $status;
-}
-
-
-
-