shellopts 2.0.0.pre.11 → 2.0.0

data/shellopts.gemspec

@@ -5,26 +5,16 @@ require "shellopts/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "shellopts"
-  spec.version       = Shellopts::VERSION
+  spec.version       = ShellOpts::VERSION
   spec.authors       = ["Claus Rasmussen"]
   spec.email         = ["claus.l.rasmussen@gmail.com"]
 
   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.11
+  version: 2.0.0
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-08 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,32 +143,35 @@ files:
 - bin/console
 - bin/mkdoc
 - bin/setup
+- doc/format.rb
+- doc/grammar.txt
 - doc/stylesheet.css
+- doc/syntax.rb
+- doc/syntax.txt
 - lib/ext/array.rb
-- lib/main.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/node.rb
-- 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/main.rb
-- lib/shellopts/option_struct.rb
+- lib/shellopts/argument_type.rb
+- lib/shellopts/dump.rb
+- lib/shellopts/formatter.rb
+- lib/shellopts/grammar.rb
+- lib/shellopts/interpreter.rb
+- lib/shellopts/lexer.rb
 - lib/shellopts/parser.rb
-- lib/shellopts/shellopts.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:
@@ -140,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/main.rb

@@ -1 +0,0 @@
-hej

data/lib/shellopts/ast/command.rb

@@ -1,41 +0,0 @@
-module ShellOpts
-  module Ast
-    class Command < Node
-      # Array of options (Ast::Option). Initially empty but filled out by the
-      # parser
-      attr_reader :options
-
-      # Optional sub-command (Ast::Command). Initially nil but assigned by the
-      # parser
-      attr_accessor :subcommand 
-
-      def initialize(grammar, name)
-        super(grammar, name)
-        @options = []
-        @subcommand = nil
-      end
-
-      # Array of option or command tuples
-      def values
-        (options + (Array(subcommand || []))).map { |node| node.to_tuple }
-      end
-
-      # :nocov:
-      def dump(&block)
-        super {
-          yield if block_given?
-          puts "options:"
-          indent { options.each { |opt| opt.dump } }
-          print "subcommand:"
-          if subcommand
-            puts
-            indent { subcommand.dump }
-          else
-            puts "nil"
-          end
-        }
-      end
-      # :nocov:
-    end
-  end
-end

data/lib/shellopts/ast/node.rb

@@ -1,37 +0,0 @@
-module ShellOpts
-  module Ast
-    class Node
-      # The associated Grammar::Node object
-      attr_reader :grammar
-
-      # Key of node. Shorthand for grammar.key
-      def key() @grammar.key end
-
-      # Name of node (either program, command, or option name)
-      attr_reader :name
-
-      # Initialize an +Ast::Node+ object. +grammar+ is the corresponding
-      # grammar object (+Grammar::Node+) and +name+ is the name of the option
-      # or sub-command
-      def initialize(grammar, name)
-        @grammar, @name = grammar, name
-      end
-
-      # Return a name/value pair
-      def to_tuple
-        [name, values]
-      end
-
-      # Return either a value (option value), an array of values (command), or
-      # nil (option without a value). It must be defined in sub-classes of Ast::Node
-      def values() raise end
-
-      # :nocov:
-      def dump(&block)
-        puts key.inspect
-        indent { yield } if block_given?
-      end
-      # :nocov:
-    end
-  end
-end

data/lib/shellopts/ast/option.rb

@@ -1,21 +0,0 @@
-module ShellOpts
-  module Ast
-    class Option < Node
-      # Optional value. Can be a String, Integer, or Float
-      attr_reader :value
-
-      def initialize(grammar, name, value)
-        super(grammar, name)
-        @value = value
-      end
-
-      def values() value end
-
-      # :nocov:
-      def dump
-        super { puts "values: #{values.inspect}" }
-      end
-      # :nocov:
-    end
-  end
-end

data/lib/shellopts/ast/program.rb

@@ -1,14 +0,0 @@
-module ShellOpts
-  module Ast
-    class Program < Command
-      # Command line arguments. Initially nil but assigned by the parser. This array
-      # is the same as the argument array returned by Ast.parse
-      attr_accessor :arguments
-
-      def initialize(grammar) 
-        super(grammar, grammar.name) 
-        @arguments = nil
-      end
-    end
-  end
-end

data/lib/shellopts/compiler.rb

@@ -1,128 +0,0 @@
-require "ext/array.rb"
-
-require 'shellopts/grammar/node.rb'
-require 'shellopts/grammar/option.rb'
-require 'shellopts/grammar/command.rb'
-require 'shellopts/grammar/program.rb'
-
-module ShellOpts
-  module Grammar
-    # Compiles an option definition string and returns a Grammar::Program
-    # object. name is the name of the program and source is the 
-    # option definition string
-    def self.compile(name, source)
-      name.is_a?(String) or raise Compiler::Error, "Expected String argument, got #{name.class}"
-      source.is_a?(String) or raise Compiler::Error, "Expected String argument, got #{source.class}"
-      Compiler.new(name, source).call
-    end
-
-    # Service object for compiling an option definition string. Returns a 
-    # Grammar::Program object
-    #
-    # Compiler implements a recursive descend algorithm to compile the option
-    # string. The algorithm uses state variables and is embedded in a
-    # Grammar::Compiler service object 
-    class Compiler
-      class Error < RuntimeError; end
-
-      # Initialize a Compiler object. source is the option definition string
-      def initialize(name, source)
-        @name, @tokens = name, source.split(/\s+/).reject(&:empty?)
-
-        # @subcommands_by_path is an hash from subcommand-path to Command or Program
-        # object. The top level Program object has nil as its path.
-        # @subcommands_by_path is used to check for uniqueness of subcommands and to
-        # link sub-subcommands to their parents
-        @subcommands_by_path = {}
-      end
-
-      def call
-        compile_program
-      end
-
-    private
-      using XArray # For Array#find_dup
-
-      # Returns the current token
-      def curr_token() @tokens.first end
-
-      # Returns the current token and advance to the next token
-      def next_token() @tokens.shift end
-
-      def compile_program
-        program = @subcommands_by_path[nil] = Grammar::Program.new(@name, compile_options)
-        while curr_token && curr_token != "--"
-          compile_subcommand
-        end
-        program.args.concat(@tokens[1..-1]) if curr_token
-        program
-      end
-
-      def compile_subcommand
-        path = curr_token[0..-2]
-        ident_list = compile_ident_list(path, ".")
-        parent_path = ident_list.size > 1 ? ident_list[0..-2].join(".") : nil
-        name = ident_list[-1]
-
-        parent = @subcommands_by_path[parent_path] or
-            raise Compiler::Error, "No such subcommand: #{parent_path.inspect}"
-        !@subcommands_by_path.key?(path) or raise Compiler::Error, "Duplicate subcommand: #{path.inspect}"
-        next_token
-        @subcommands_by_path[path] = Grammar::Command.new(parent, name, compile_options)
-      end
-
-      def compile_options
-        option_list = []
-        while curr_token && curr_token != "--" && !curr_token.end_with?("!")
-          option_list << compile_option
-        end
-        dup = option_list.map(&:names).flatten.find_dup and 
-            raise Compiler::Error, "Duplicate option name: #{dup.inspect}"
-        option_list
-      end
-
-      def compile_option
-        # Match string and build flags
-        flags = []
-        curr_token =~ /^(\+)?(.+?)(?:(=)(\$|\#)?(.*?)(\?)?)?$/
-        flags << :repeated if $1 == "+"
-        names = $2
-        flags << :argument if $3 == "="
-        flags << :integer if $4 == "#"
-        flags << :float if $4 == "$"
-        label = $5 == "" ? nil : $5
-        flags << :optional if $6 == "?"
-
-        # Build names
-        short_names = []
-        long_names = []
-        ident_list = compile_ident_list(names, ",")
-        (dup = ident_list.find_dup).nil? or 
-            raise Compiler::Error, "Duplicate identifier #{dup.inspect} in #{curr_token.inspect}"
-        ident_list.each { |ident|
-          if ident.size == 1
-            short_names << "-#{ident}"
-          else
-            long_names << "--#{ident}"
-          end
-        }
-
-        next_token
-        Grammar::Option.new(short_names, long_names, flags, label)
-      end
-
-      # Compile list of option names or a subcommand path
-      def compile_ident_list(ident_list_str, sep)
-        ident_list_str.split(sep, -1).map { |str| 
-          !str.empty? or 
-              raise Compiler::Error, "Empty identifier in #{curr_token.inspect}"
-          !str.start_with?("-") or 
-              raise Compiler::Error, "Identifier can't start with '-' in #{curr_token.inspect}"
-          str !~ /([^\w\d#{sep}-])/ or 
-              raise Compiler::Error, "Illegal character #{$1.inspect} in #{curr_token.inspect}"
-          str
-        }
-      end
-    end
-  end
-end

data/lib/shellopts/generator.rb

@@ -1,15 +0,0 @@
-
-require 'shellopts/idr.rb'
-
-module ShellOpts
-  module Idr
-    # Generates an Idr::Program from a ShellOpts object
-    def self.generate(shellopts)
-      Idr::Program.new(shellopts)
-    end
-  end
-end
-
-
-
-

data/lib/shellopts/grammar/command.rb

@@ -1,80 +0,0 @@
-module ShellOpts
-  module Grammar
-    # A command. Commands are organized hierarchically with a Program object as
-    # the root node
-    #
-    # Sets Node#key to the name of the command incl. the exclamation point
-    class Command < Node
-      # Parent command. Nil if this is the top level command (the program)
-      attr_reader :parent
-
-      # Name of command (String). Name doesn't include the exclamation point ('!')
-      attr_reader :name
-
-      # Same as #name. TODO Define in Grammar::Node instead
-      alias :key_name :name
-
-      # List of options in declaration order
-      attr_reader :option_list
-
-      # List of commands in declaration order
-      attr_reader :subcommand_list
-
-      # Multihash from option key or names (both short and long names) to option. This
-      # means an option can occur more than once as the hash value
-      def options() 
-        @option_multihash ||= @option_list.flat_map { |option| 
-          option.identifiers.map { |ident| [ident, option] }
-        }.to_h
-      end
-
-      # Sub-commands of this command. Is a multihash from sub-command key or
-      # name to command object. Lazily constructed because subcommands are added
-      # after initialization
-      def subcommands()
-        @subcommand_multihash ||= @subcommand_list.flat_map { |subcommand| 
-          subcommand.identifiers.map { |name| [name, subcommand] }
-        }.to_h
-      end
-
-      # Initialize a Command object. parent is the parent Command object or nil
-      # if this is the root object. name is the name of the command (without
-      # the exclamation mark), and option_list a list of Option objects
-      def initialize(parent, name, option_list)
-        super("#{name}!".to_sym, name)
-        parent.attach(self) if parent
-        @option_list = option_list
-        @subcommand_list = []
-      end
-
-      # Return key for the identifier
-      def identifier2key(ident)
-        options[ident]&.key || subcommands[ident]&.key
-      end
-
-      # Return list of identifiers for the command
-      def identifiers() [key, name] end
-
-      # :nocov:
-      def dump(&block)
-        puts "#{key.inspect}"
-        indent {
-          puts "parent: #{parent&.key.inspect}"
-          puts "name: #{name.inspect}"
-          yield if block_given?
-          puts "options:"
-          indent { option_list.each { |opt| opt.dump } }
-          puts "subcommands: "
-          indent { subcommand_list.each { |cmd| cmd.dump } }
-        }
-      end
-      # :nocov:
-
-    protected
-      def attach(subcommand)
-        subcommand.instance_variable_set(:@parent, self)
-        @subcommand_list << subcommand
-      end
-    end
-  end
-end

data/lib/shellopts/grammar/node.rb

@@ -1,33 +0,0 @@
-module ShellOpts
-  module Grammar
-    # Root class for Grammar objects
-    #
-    # Node objects are created by ShellOpts::Grammar.compile that returns a
-    # Program object that in turn contains other node objects in a hierarchical
-    # structure that reflects the grammar of the program. Only
-    # ShellOpts::Grammar.compile should create node objects
-    class Node
-      # Key (Symbol) of node. Unique within the enclosing command
-      attr_reader :key
-
-      # Name of node. The name of an option is without the prefixed '-' or
-      # '--', the name of a command is without the suffixed '!'. Note that name
-      # collisions can happen between options and commands names
-      attr_reader :name
-
-      def initialize(key, name)
-        @key, @name = key, name
-      end
-
-      # :nocov:
-      def dump(&block) 
-        puts key.inspect
-        indent { 
-          puts "name: #{name.inspect}"
-          yield if block_given?
-        }
-      end
-      # :nocov:
-    end
-  end
-end