shellopts 2.0.0.pre.14 → 2.0.0

data/shellopts.gemspec

@@ -11,20 +11,10 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Parse command line options and arguments}
   spec.description   = %q{ShellOpts is a simple command line parsing libray
-                          that covers most modern use cases incl. sub-commands.
-                          Options and commands are specified using a
-                          getopt(1)-like string that is interpreted by the
-                          library to process the command line}
+                          that supports short and long options and subcommands,
+                          and has built-in help and error messages}
   spec.homepage      = "http://github.com/clrgit/shellopts"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0+ is required to protect against public gem pushes"
-  end
-
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -32,9 +22,13 @@ 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", "~> 1.16"
+  spec.add_dependency "forward_to"
+  spec.add_dependency "constrain"
+  spec.add_dependency "ruby-terminfo"
+  spec.add_dependency "indented_io"
+
+  spec.add_development_dependency "bundler", "~> 2.2.10"
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "indented_io"
   spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,71 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: shellopts
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.14
+  version: 2.0.0
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-10 00:00:00.000000000 Z
+date: 2022-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: forward_to
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: constrain
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: ruby-terminfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: indented_io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
-  name: indented_io
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -82,10 +124,8 @@ dependencies:
         version: '0'
 description: |-
   ShellOpts is a simple command line parsing libray
-                            that covers most modern use cases incl. sub-commands.
-                            Options and commands are specified using a
-                            getopt(1)-like string that is interpreted by the
-                            library to process the command line
+                            that supports short and long options and subcommands,
+                            and has built-in help and error messages
 email:
 - claus.l.rasmussen@gmail.com
 executables: []
@@ -103,30 +143,35 @@ files:
 - bin/console
 - bin/mkdoc
 - bin/setup
+- doc/format.rb
+- doc/grammar.txt
 - doc/stylesheet.css
-- lib/ext/algorithm.rb
-- lib/ext/ruby_env.rb
+- doc/syntax.rb
+- doc/syntax.txt
+- lib/ext/array.rb
+- lib/ext/forward_to.rb
+- lib/ext/lcs.rb
 - lib/shellopts.rb
+- lib/shellopts/analyzer.rb
+- lib/shellopts/ansi.rb
 - lib/shellopts/args.rb
-- lib/shellopts/ast/command.rb
-- lib/shellopts/ast/dump.rb
-- lib/shellopts/ast/option.rb
-- lib/shellopts/ast/parser.rb
-- lib/shellopts/constants.rb
-- lib/shellopts/exceptions.rb
+- lib/shellopts/argument_type.rb
+- lib/shellopts/dump.rb
 - lib/shellopts/formatter.rb
-- lib/shellopts/grammar/analyzer.rb
-- lib/shellopts/grammar/command.rb
-- lib/shellopts/grammar/dump.rb
-- lib/shellopts/grammar/lexer.rb
-- lib/shellopts/grammar/option.rb
-- lib/shellopts/grammar/parser.rb
+- lib/shellopts/grammar.rb
+- lib/shellopts/interpreter.rb
+- lib/shellopts/lexer.rb
+- lib/shellopts/parser.rb
+- lib/shellopts/program.rb
+- lib/shellopts/renderer.rb
+- lib/shellopts/stack.rb
+- lib/shellopts/token.rb
 - lib/shellopts/version.rb
+- main
 - shellopts.gemspec
 homepage: http://github.com/clrgit/shellopts
 licenses: []
-metadata:
-  allowed_push_host: https://rubygems.org
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -138,11 +183,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.26
 signing_key: 
 specification_version: 4
 summary: Parse command line options and arguments

data/lib/ext/algorithm.rb

@@ -1,14 +0,0 @@
-
-module Algorithm
-  def follow(object, sym = nil, &block)
-    sym.nil? == block_given? or raise "Can't use both symbol and block"
-    a = []
-    while object
-      a << object
-      object = block_given? ? yield(object) : object.send(sym)
-    end
-    a
-  end
-
-  module_function :follow
-end

data/lib/ext/ruby_env.rb

@@ -1,8 +0,0 @@
-
-if File.directory?(File.join(File.dirname(File.dirname(File.dirname(__FILE__))), "spec"))
-  RUBY_ENV = "development"
-else
-  RUBY_ENV = "production"
-end
-
-

data/lib/shellopts/ast/command.rb

@@ -1,112 +0,0 @@
-module ShellOpts
-  module Ast
-    # Note that Command is derived from BasicObject to minimize the number of
-    # reserved names
-    class Command < BasicObject
-      def initialize(grammar)
-        @grammar = grammar
-        @options_list = []
-        @options_hash = {}
-        @subcommand = nil
-        @subcommands_hash = {} # have at most one element
-
-        @grammar.opts.each { |opt|
-          if opt.argument?
-            self.instance_eval("def #{opt.ident}() @options_hash[:#{opt.ident}] end")
-          end
-          self.instance_eval("def #{opt.ident}?() @options_hash.key?(:#{opt.ident}) end")
-        }
-
-        @grammar.cmds.each { |cmd|
-          self.instance_eval("def #{cmd.ident}!() @subcommands_hash[:#{cmd.ident}] end")
-        }
-      end
-
-      # Return true if the option was used. Defined in #initialize for each option
-      # def <option>?() end
-      
-      # Return the value of the option. Note that repeated options have their
-      # values aggregated into an array. Defined in #initialize for each option
-      # def <option>() end
-
-      # List of Ast::Option objects in the same order as on the command line
-      def options() @options_list end
-      
-      # Hash from option identifier to option value. Note that repeated options
-      # have their values aggregated into an array
-      def [](ident) @options_hash[ident].argument end
-
-      # Return the sub-command Command object or nil if not present. Defined in
-      # #initialize for each sub-command
-      # def <command>!() end
-
-      # The sub-command identifier or nil if not present
-      def subcommand() @subcommand && Command.grammar(@subcommand).ident end
-
-      # The sub-command Command object or nil if not present
-      def subcommand!() @subcommand end
-
-      # Class-level accessor methods
-      def self.program?(command) command.__send__(:__is_program__) end
-      def self.grammar(command) command.__send__(:__get_grammar__) end
-
-      # Class-level mutating methods
-      def self.add_option(command, option) command.__send__(:__add_option__, option) end
-      def self.add_command(command, subcommand) command.__send__(:__add_command__, subcommand) end
-
-    private
-      # True if this is a Program object
-      def __is_program__() false end
-
-      # Get grammar
-      def __get_grammar__()
-        @grammar
-      end
-
-      # Add an option. Only used from the parser
-      def __add_option__(option)
-        @options_list << option
-        if option.grammar.repeatable?        
-          (@options_hash[option.grammar.ident] ||= []) << option.argument
-        else
-          @options_hash[option.grammar.ident] = option.argument
-        end
-      end
-
-      # Set sub-command. Only used from the parser
-      def __add_command__(command)
-        ident = Command.grammar(command).ident
-        @subcommand = command
-        @subcommands_hash[ident] = command
-      end
-    end
-
-    class Program < Command
-      def __is_program__() true end
-    end
-  end
-end
-
-# # TODO: Create class-level methods for access
-# private
-#   # Return class of object. #class is not defined for BasicObjects so this
-#   # method provides an alternative way of getting the class
-#   def self.class_of(object) 
-#     # https://stackoverflow.com/a/18621313/2130986
-#     ::Kernel.instance_method(:class).bind(object).call 
-#   end
-#
-#   # Class method implementation of ObjectStruct#instance_variable_set that is
-#   # not defined in a BasicObject
-#   def self.set_variable(this, var, value)
-#     # https://stackoverflow.com/a/18621313/2130986
-#     ::Kernel.instance_method(:instance_variable_set).bind(this).call(var, value)
-#   end
-#
-#   # Class method implementation of ObjectStruct#instance_variable_get that is
-#   # not defined in a BasicObject
-#   def self.get_variable(this, var)
-#     # https://stackoverflow.com/a/18621313/2130986
-#     ::Kernel.instance_method(:instance_variable_get).bind(this).call(var)
-#   end
-

data/lib/shellopts/ast/dump.rb

@@ -1,28 +0,0 @@
-module ShellOpts
-  module Ast
-    class Command < BasicObject
-      def dump
-        klass = __is_program__ ? "Program" : "Command"
-        ::Kernel.puts "#{@grammar.ident.inspect} (#{klass})"
-        ::Kernel.indent {
-          if !options.empty?
-            options.map(&:dump)
-          end
-          if subcommand
-            subcommand!.dump
-          end
-        }
-      end
-    end
-
-    class Option
-      def dump
-        puts "#{grammar.ident.inspect} (Option)"
-        indent {
-          puts "name: #{name.inspect}"
-          puts "argument: #{argument.inspect}"
-        }
-      end
-    end
-  end
-end

data/lib/shellopts/ast/option.rb

@@ -1,15 +0,0 @@
-module ShellOpts
-  module Ast
-    class Option
-      attr_reader :grammar
-      attr_reader :name # The actual name used on the command line
-      attr_reader :argument
-
-      def initialize(grammar, name, argument)
-        @grammar = grammar
-        @name = name
-        @argument = argument
-      end
-    end
-  end
-end

data/lib/shellopts/ast/parser.rb

@@ -1,106 +0,0 @@
-module ShellOpts
-  module Ast
-    # Parse a subcommand
-    class Parser
-      def initialize(grammar, argv)
-        @grammar, @argv = grammar, argv.dup
-        @seen_options = {} # Used to keep track of repeated options
-        @current = nil # Current command
-      end
-
-      def call
-        @current = program = Program.new(@grammar)
-        parse_command(program)
-        cmd = Command.grammar(@current)
-        !cmd.virtual? or error("'%s' command requires a sub-command")
-        [program, Args.new(cmd, @argv)]
-      end
-
-      def self.parse(grammar, argv)
-        self.new(grammar, argv).call
-      end
-
-    private
-      def error(message)
-        grammar = Command.grammar(@current)
-        raise Error.new(grammar), message % grammar.name
-      end
-
-      def parse_command(command)
-        @seen_options = {} # Every new command resets the seen options
-        while arg = @argv.first
-          if arg == "--"
-            @argv.shift
-            break
-          elsif arg.start_with?("-")
-            parse_option(command)
-          elsif cmd = Command.grammar(command).commands[arg]
-            @argv.shift
-            @current = subcommand = Ast::Command.new(cmd)
-            Command.add_command(command, subcommand)
-            parse_command(subcommand)
-            break
-          else
-            break
-          end
-        end
-      end
-
-      def parse_option(command)
-        # Split into name and argument
-        case @argv.first
-          when /^--(.+?)(?:=(.*))?$/
-            name, arg, short = $1, $2, false
-            opt_name = "--#{name}"
-          when /^-(.)(.+)?$/
-            name, arg, short = $1, $2, true
-            opt_name = "-#{name}"
-        end
-        @argv.shift
-
-        option = Command.grammar(command).options[name] or error "Unknown option '#{opt_name}'"
-        !@seen_options.key?(option.ident) || option.repeatable? or error "Duplicate option '#{opt_name}'"
-        @seen_options[option.ident] = true
-
-        # Parse (optional) argument
-        if option.argument?
-          if arg.nil? && !option.optional?
-            if !@argv.empty?
-              arg = @argv.shift
-            else
-              error "Missing argument for option '#{opt_name}'"
-            end
-          end
-          arg &&= parse_option_arg(option, name, arg)
-        elsif arg && short
-          @argv.unshift("-#{arg}")
-          arg = nil
-        elsif !arg.nil?
-          error "No argument allowed for option '#{opt_name}'"
-        end
-        
-        Command.add_option(command, Option.new(option, name, arg))
-      end
-
-      def parse_option_arg(option, name, arg)
-        if option.string?
-          arg
-        elsif arg == ""
-          nil
-        elsif option.integer?
-          arg =~ /^-?\d+$/ or error "Illegal integer in '#{name}' argument: '#{arg}'"
-          arg.to_i
-        else # option.float?
-          # https://stackoverflow.com/a/21891705/2130986
-          arg =~ /^[+-]?(?:0|[1-9]\d*)(?:\.(?:\d*[1-9]|0))?$/ or
-              error "Illegal float in '#{name}' argument: '#{arg}'"
-          arg.to_f
-        end
-      end
-    end
-  end
-end
-
-
-
-

data/lib/shellopts/constants.rb

@@ -1,88 +0,0 @@
-
-module ShellOpts
-  # FIXME: An option group is -abcd, an option list is a,b,c,d
-  module Constants
-    # Short and long option names
-    SHORT_OPTION_NAME_SUB_RE = /[a-zA-Z0-9]/
-    LONG_OPTION_NAME_SUB_RE = /[a-z](?:[\w-]*\w)/
-    OPTION_NAME_SUB_RE = /#{SHORT_OPTION_NAME_SUB_RE}|#{LONG_OPTION_NAME_SUB_RE}/
-
-    # Initial option in a group
-    INITIAL_SHORT_OPTION_SUB_RE = /[-+]#{SHORT_OPTION_NAME_SUB_RE}/
-    INITIAL_LONG_OPTION_SUB_RE = /(?:--|\+\+)#{LONG_OPTION_NAME_SUB_RE}/
-    INITIAL_OPTION_SUB_RE = /#{INITIAL_SHORT_OPTION_SUB_RE}|#{INITIAL_LONG_OPTION_SUB_RE}/
-
-    # A list of short and long options
-    OPTION_GROUP_SUB_RE = /#{INITIAL_OPTION_SUB_RE}(?:,#{OPTION_NAME_SUB_RE})*/
-
-    # Option argument
-    OPTION_ARG_SUB_RE = /[A-Z](?:[A-Z0-9_-]*[A-Z0-9])?/
-    
-    # Matches option flags and argument. It defines the following captures
-    #
-    #   $1 - Argument flag ('=')
-    #   $2 - Type flag ('#' or '$')
-    #   $3 - Argument name
-    #   $4 - Optional flag ('?')
-    #
-    OPTION_FLAGS_SUB_RE = /(=)(#|\$)?(#{OPTION_ARG_SUB_RE})?(\?)?/
-
-    # Matches a declaration of an option. The RE defines the following captures:
-    #
-    #   $1 - Option group
-    #   $2 - Argument flag ('=')
-    #   $3 - Type flag ('#' or '$')
-    #   $4 - Argument name
-    #   $5 - Optional flag ('?')
-    #
-    OPTION_SUB_RE = /(#{OPTION_GROUP_SUB_RE})#{OPTION_FLAGS_SUB_RE}?/
-    
-    # Command and command paths
-    COMMAND_IDENT_SUB_RE = /[a-z](?:[a-z0-9_-]*[a-z0-9])?/
-    COMMAND_SUB_RE = /#{COMMAND_IDENT_SUB_RE}!/
-    COMMAND_PATH_SUB_RE = /#{COMMAND_IDENT_SUB_RE}(?:\.#{COMMAND_IDENT_SUB_RE})*!/
-
-    # Command argument
-    ARGUMENT_SUB_RE = /[A-Z][A-Z0-9_-]*[A-Z0-9](?:\.\.\.)?/
-    ARGUMENT_EXPR_SUB_RE = /\[?#{ARGUMENT_SUB_RE}(?:#{ARGUMENT_SUB_RE}|[\[\]\|\s])*/
-
-    # Matches a line starting with a command or an option
-    SCAN_RE = /^(?:#{COMMAND_PATH_SUB_RE}|#{OPTION_SUB_RE})(?:\s+.*)?$/
-
-
-    # Create anchored REs for all SUB_REs
-    self.constants.each { |c|
-      next if c.to_s !~ /_SUB_RE$/
-      sub_re = self.const_get(c)
-      next if !sub_re.is_a?(Regexp)
-      re = /^#{sub_re}$/
-      name = c.to_s.sub(/_SUB_RE$/, "_RE")
-      self.const_set(name, re)
-    }
-
-    # Method names reserved by the BasicObject class
-    BASIC_OBJECT_RESERVED_WORDS = %w(
-      ! != == __id__ __send__ equal? instance_eval instance_exec method_missing
-      singleton_method_added singleton_method_removed singleton_method_undefined)
-
-    # Method names reserved by the Ast::Command class
-    AST_COMMAND_RESERVED_WORDS = %w(
-      initialize options subcommand __is_program__ __get_grammar__
-      __add_option__ __add_command__)
-
-    # Reserved option names
-    OPTION_RESERVED_WORDS = 
-        (BASIC_OBJECT_RESERVED_WORDS + AST_COMMAND_RESERVED_WORDS).grep(OPTION_NAME_RE)
-
-    # Reserved command names
-    COMMAND_RESERVED_WORDS = %w(subcommand)
-  end
-
-  include Constants
-end
-
-
-
-
-
-

data/lib/shellopts/exceptions.rb

@@ -1,21 +0,0 @@
-
-module ShellOpts
-  class CompileError < StandardError; end
-
-  class ShellOptsError < RuntimeError; end
-
-  class Error < ShellOptsError
-    attr_reader :subject
-
-    def initialize(subject = nil) 
-      super()
-      @subject = subject
-    end
-  end
-
-  class Fail < ShellOptsError; end
-end
-
-class NotYet < NotImplementedError; end
-class NotThis < ScriptError; end
-class NotHere < ScriptError; end