shellopts 1.0.1 → 2.0.0.pre.1

data/lib/shellopts.rb

@@ -2,231 +2,145 @@ require "shellopts/version"
 
 require 'shellopts/compiler.rb'
 require 'shellopts/parser.rb'
+require 'shellopts/generator.rb'
+require 'shellopts/option_struct.rb'
+require 'shellopts/messenger.rb'
 require 'shellopts/utils.rb'
 
-# ShellOpts is a library for parsing command line options and sub-commands. The
-# library API consists of the methods {ShellOpts.process}, {ShellOpts.error},
-# and {ShellOpts.fail} and the result class {ShellOpts::ShellOpts}
+# Name of program. Defined as the basename of the program file
+PROGRAM = File.basename($PROGRAM_NAME)
+
+# ShellOpts main Module
+#
+# This module contains methods to process command line options and arguments.
+# ShellOpts keeps a reference in ShellOpts.shellopts to the result of the last
+# command that was processed through its interface and use it as the implicit
+# object of many of its methods. This matches the typical use case where only
+# one command line is ever processed and makes it possible to create class
+# methods that knows about the command like #error and #fail
+#
+# For example; the following process and convert a command line into a struct
+# representation and also sets ShellOpts.shellopts object so that the #error
+# method can print a relevant usage string:
+#
+#   USAGE = "a,all f,file=FILE -- ARG1 ARG2"
+#   opts, args = ShellOpts.as_struct(USAGE, ARGV)
+#   File.exist?(opts.file) or error "Can't find #{opts.file}"
+#
+# The command line is processed through one of the methods #process, #as_array,
+# #as_hash, or #as_struct that returns a [data, args] tuple. The data type
+# depends on the method: #process yields a Idr object that internally serves as
+# the base for the #as_array and #as_hash and #as_struct that converts it into
+# an Array, Hash, or ShellOpts::OptionStruct object. For example:
+#
+#   USAGE = "..."
+#   ShellOpts.process(USAGE, ARGV)
+#   program, args = ShellOpts.as_program(USAGE, ARGV)
+#   array, args = ShellOpts.as_array(USAGE, ARGV)
+#   hash, args = ShellOpts.as_hash(USAGE, ARGV)
+#   struct, args = ShellOpts.as_struct(USAGE, ARGV)
 #
-# ShellOpts inject the constant PROGRAM into the global scope. It contains the 
+# ShellOpts can raise the exception CompilerError is there is an error in the
+# USAGE string. If there is an error in the user supplied command line, #error
+# is called instead and the program terminates with exit code 1. ShellOpts
+# raises ConversionError is there is a name collision when converting to the
+# hash or struct representations. Note that CompilerError and ConversionError
+# are caused by misuse of the library and the problem should be corrected by
+# the developer
+#
+# ShellOpts injects the constant PROGRAM into the global scope. It contains the 
 # name of the program
 #
 module ShellOpts
-  # Return the hidden +ShellOpts::ShellOpts+ object (see .process)
-  def self.shellopts()
-    @shellopts
-  end
+  # Base class for ShellOpts exceptions
+  class Error < RuntimeError; end
 
-  # Prettified usage string used by #error and #fail. Default is +usage+ of
-  # the current +ShellOpts::ShellOpts+ object
-  def self.usage() @usage || @shellopts&.usage end
-
-  # Set the usage string
-  def self.usage=(usage) @usage = usage end
-  
-  # Process command line options and arguments.  #process takes a usage string
-  # defining the options and the array of command line arguments to be parsed
-  # as arguments
-  #
-  # If called with a block, the block is called with name and value of each
-  # option or command and #process returns a list of remaining command line
-  # arguments. If called without a block a ShellOpts::ShellOpts object is
-  # returned
-  # 
-  # The value of an option is its argument, the value of a command is an array
-  # of name/value pairs of options and subcommands. Option values are converted
-  # to the target type (String, Integer, Float) if specified
-  #
-  # Example
-  #
-  #   # Define options
-  #   USAGE = 'a,all g,global +v,verbose h,help save! snapshot f,file=FILE h,help'
-  #
-  #   # Define defaults
-  #   all = false
-  #   global = false
-  #   verbose = 0
-  #   save = false
-  #   snapshot = false
-  #   file = nil
-  #
-  #   # Process options
-  #   argv = ShellOpts.process(USAGE, ARGV) do |name, value|
-  #     case name
-  #       when '-a', '--all'; all = true
-  #       when '-g', '--global'; global = value
-  #       when '-v', '--verbose'; verbose += 1
-  #       when '-h', '--help'; print_help(); exit(0)
-  #       when 'save'
-  #         save = true
-  #         value.each do |name, value|
-  #           case name
-  #             when '--snapshot'; snapshot = true
-  #             when '-f', '--file'; file = value
-  #             when '-h', '--help'; print_save_help(); exit(0)
-  #           end
-  #         end
-  #     else
-  #       raise "Not a user error. The developer forgot or misspelled an option"
-  #     end
-  #   end
-  #
-  #   # Process remaining arguments
-  #   argv.each { |arg| ... }
-  #
-  # If an error is encountered while compiling the usage string, a
-  # +ShellOpts::Compiler+ exception is raised. If the error happens while
-  # parsing the command line arguments, the program prints an error message and
-  # exits with status 1. Failed assertions raise a +ShellOpts::InternalError+
-  # exception
-  #
-  # Note that you can't process more than one command line at a time because
-  # #process saves a hidden {ShellOpts::ShellOpts} class variable used by the
-  # class methods #error and #fail. Call #reset to clear the global object if
-  # you really need to parse more than one command line. Alternatively you can
-  # create +ShellOpts::ShellOpts+ objects yourself and also use the object methods
-  # #error and #fail:
-  #
-  #   shellopts = ShellOpts::ShellOpts.new(USAGE, ARGS)
-  #   shellopts.each { |name, value| ... }
-  #   shellopts.args.each { |arg| ... }
-  #   shellopts.error("Something went wrong")
-  #
-  # Use #shellopts to get the hidden +ShellOpts::ShellOpts+ object
-  #
-  def self.process(usage, argv, program_name: PROGRAM, &block)
-    if !block_given?
-      ShellOpts.new(usage, argv, program_name: program_name)
-    else
-      @shellopts.nil? or raise InternalError, "ShellOpts class variable already initialized"
-      @shellopts = ShellOpts.new(usage, argv, program_name: program_name)
-      @shellopts.each(&block)
-      @shellopts.args
+  # Raised when a syntax error is detected in the usage string
+  class CompilerError < Error
+    def initialize(start, message)
+      super(message)
+      set_backtrace(caller(start))
     end
   end
 
-  # Reset the hidden +ShellOpts::ShellOpts+ class variable so that you can process
-  # another command line
-  def self.reset()
-    @shellopts = nil
-    @usage = nil
-  end
+  # Raised when an error is detected during conversion from the Idr to array,
+  # hash, or struct
+  class ConversionError < Error; end
 
-  # Print error message and usage string and exit with status 1. It use the
-  # current ShellOpts object if defined. This method should be called in
-  # response to user-errors (eg. specifying an illegal option)
-  #
-  # If there is no current ShellOpts object +error+ will look for USAGE to make
-  # it possible to use +error+ before the command line is processed and also as
-  # a stand-alone error reporting method
-  def self.error(*msgs)
-    program = @shellopts&.program_name || PROGRAM
-    usage_string = usage || (defined?(USAGE) && USAGE ? Grammar.compile(PROGRAM, USAGE).usage : nil)
-    emit_and_exit(program, @usage.nil?, usage_string, *msgs)
-  end
+  # Raised when an internal error is detected
+  class InternalError < Error; 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)
-  def self.fail(*msgs)
-    program = @shellopts&.program_name || PROGRAM
-    emit_and_exit(program, false, nil, *msgs)
-  end
+  # The current compilation object. It is set by #process
+  def self.shellopts() @shellopts end
 
-  # The compilation object
-  class ShellOpts
-    # Name of program
-    attr_reader :program_name
-
-    # Prettified usage string used by #error and #fail. Shorthand for +grammar.usage+
-    def usage() @grammar.usage end
-
-    # The grammar compiled from the usage string. If #ast is defined, it's
-    # equal to ast.grammar
-    attr_reader :grammar
-
-    # The AST resulting from parsing the command line arguments
-    attr_reader :ast
-
-    # List of remaining non-option command line arguments. Shorthand for ast.arguments
-    def args() @ast.arguments end
-
-    # Compile a usage string into a grammar and use that to parse command line
-    # arguments
-    #
-    # +usage+ is the usage string, and +argv+ the command line (typically the
-    # global ARGV array). +program_name+ is the name of the program and is
-    # used in error messages. It defaults to the basename of the program
-    #
-    # Errors in the usage string raise a CompilerError exception. Errors in the
-    # argv arguments terminates the program with an error message
-    def initialize(usage, argv, program_name: File.basename($0))
-      @program_name = program_name
-      begin
-        @grammar = Grammar.compile(program_name, usage)
-        @ast = Ast.parse(@grammar, argv)
-      rescue Grammar::Compiler::Error => ex
-        raise CompilerError.new(5, ex.message)
-      rescue Ast::Parser::Error => ex
-        error(ex.message)
-      end
-    end
+  # Process command line and set and return the shellopts compile object
+  def self.process(usage, argv, name: self.name, message: nil)
+    @shellopts.nil? or reset
+    messenger = message && Messenger.new(name, message, format: :custom)
+    @shellopts = ShellOpts.new(usage, argv, name: name, messenger: messenger)
+  end
 
-    # Unroll the AST into a nested array
-    def to_a
-      @ast.values
-    end
+  # Return the internal data representation of the command line (Idr::Program).
+  # Note that #as_program that the remaning arguments are accessible through
+  # the returned object
+  def self.as_program(usage, argv, name: self.name, message: nil) 
+    process(usage, argv, name: name, message: message)
+    [shellopts.idr, shellopts.args]
+  end
 
-    # Iterate the result as name/value pairs. See {ShellOpts.process} for a
-    # detailed description
-    def each(&block)
-      if block_given?
-        to_a.each { |*args| yield(*args) }
-      else
-        to_a # FIXME: Iterator
-      end
-    end
+  # Process command line, set current shellopts object, and return a [array, argv]
+  # tuple. Returns the representation of the current object if not given any
+  # arguments
+  def self.as_array(usage, argv, name: self.name, message: nil)
+    process(usage, argv, name: name, message: message)
+    [shellopts.to_a, shellopts.args]
+  end
 
-    # Print error message and usage string and exit with status 1. This method
-    # should be called in response to user-errors (eg. specifying an illegal
-    # option)
-    def error(*msgs)
-      ::ShellOpts.emit_and_exit(program_name, true, usage, msgs)
-    end
+  # Process command line, set current shellopts object, and return a [hash, argv]
+  # tuple. Returns the representation of the current object if not given any
+  # arguments
+  def self.as_hash(usage, argv, name: self.name, message: nil, use: ShellOpts::DEFAULT_USE, aliases: {})
+    process(usage, argv, name: name, message: message)
+    [shellopts.to_hash(use: use, aliases: aliases), shellopts.args]
+  end
 
-    # Print error message and exit with status 1. This method should not be
-    # called in response to user-errors but system errors (like disk full)
-    def fail(*msgs)
-      ::ShellOpts.emit_and_exit(program_name, false, nil, msgs)
-    end
+  # Process command line, set current shellopts object, and return a [struct, argv]
+  # tuple. Returns the representation of the current object if not given any
+  # arguments
+  def self.as_struct(usage, argv, name: self.name, message: nil, use: ShellOpts::DEFAULT_USE, aliases: {})
+    process(usage, argv, name: name, message: message)
+    [shellopts.to_struct(use: use, aliases: aliases), shellopts.args]
   end
 
-  # Base class for ShellOpts exceptions
-  class Error < RuntimeError; end
+  # Process command line, set current shellopts object, and then iterate
+  # options and commands as an array. Returns an enumerator to the array
+  # representation of the current shellopts object if not given a block
+  # argument
+  def self.each(usage = nil, argv = nil, name: self.name, message: nil, &block)
+    process(usage, argv, name: name, message: message)
+    shellopts.each(&block)
+  end
 
-  # Raised when an error is detected in the usage string
-  class CompilerError < Error
-    def initialize(start, message)
-      super(message)
-      set_backtrace(caller(start))
-    end
+  # Print error message and usage string and exit with status 1. This method
+  # should be called in response to user-errors (eg. specifying an illegal
+  # option)
+  def self.error(*msgs)
+    raise "Oops" if shellopts.nil?
+    shellopts.error(*msgs)
   end
 
-  # Raised when an internal error is detected
-  class InternalError < Error; end
+  # Print error message and exit with status 1. This method should not be
+  # called in response to system errors (eg. disk full)
+  def self.fail(*msgs)
+    raise "Oops" if shellopts.nil?
+    shellopts.fail(*msgs)
+  end
 
 private
-  @shellopts = nil
-
-  def self.emit_and_exit(program, use_usage, usage, *msgs)
-    $stderr.puts "#{program}: #{msgs.join}"
-    if use_usage
-      $stderr.puts "Usage: #{program} #{usage}" if usage
-    else
-      $stderr.puts usage if usage
-    end
-    exit 1
+  # Reset state variables
+  def self.reset()
+    @shellopts = nil
   end
-end
 
-PROGRAM = File.basename($PROGRAM_NAME)
+  @shellopts = nil
+end

data/rs

@@ -0,0 +1,40 @@
+#!/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;
+}
+
+
+
+

data/shellopts.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.2.10"
+  spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "indented_io"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shellopts
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0.pre.1
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-18 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.10
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.10
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -111,13 +111,19 @@ files:
 - lib/shellopts/ast/option.rb
 - lib/shellopts/ast/program.rb
 - lib/shellopts/compiler.rb
+- lib/shellopts/generator.rb
 - lib/shellopts/grammar/command.rb
 - lib/shellopts/grammar/node.rb
 - lib/shellopts/grammar/option.rb
 - lib/shellopts/grammar/program.rb
+- lib/shellopts/idr.rb
+- lib/shellopts/messenger.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: []
@@ -134,9 +140,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.8
 signing_key: