shellopts 1.0.1 → 2.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3096c35af16a39ffc98b52f02799aa25efa311b20916309496ee33b2a50dcf47
-  data.tar.gz: ebc336b7a5595412d1f705378f24dc6136c17e3257db7ca5ddec021349ec2a88
+  metadata.gz: e60db3cf5de50dcd106cb0fca007d064e18354278a65207bb167bf8aa63d3433
+  data.tar.gz: 85b0108262357d6e5654e725ab12293f51fd2579beb13fa0d910be2200c32310
 SHA512:
-  metadata.gz: d44d80cc028fa9c9a7add7206b6a0f096cc3deb1c7e3f756075171c4ebfb20fdb6246215ec02d8920e9b450ebfcd5355a0c3b4179cc03d7fb4f6f89eea6f3a15
-  data.tar.gz: 5bb562a9806196a6b6594897d3a09b8a1dc70abebf9f51194a6d31c031e86c54e69d1531acbb5ba6d675afb97c12d86ad2da4216af06bdcac8e056430787a97a
+  metadata.gz: 375fe97651622560d786b288217e1a8581d12bbc497dee55b36848597d9410d393a127e86088cfe4ac8f949270d9f6797d6f135f65492f15bb9d4a84bff1ffbc
+  data.tar.gz: c69a813e4672d87c6a4da69e0e8086d8acfe54c8506cda64ce6dc36dbc12669cc79c29ffd480c6871937d87491139f4e7448fd35a6d6a7d333451addd6c634a6

data/README.md

@@ -378,6 +378,16 @@ release a new version, update the version number in `version.rb`, and then run
 git commits and tags, and push the `.gem` file to
 [rubygems.org](https://rubygems.org).
 
+## Implementation
+
+FIXME
+# ShellOpts is a library for parsing command line options and commands. It
+# consists of the interface module {ShellOpts}, the implementation class
+# {ShellOpts::ShellOpts} and the representation classes
+# {ShellOpts::OptionsHash} and {ShellOpts::OptionsStruct}.
+# {ShellOpts::Messenger} is used for error messages
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at

data/TODO

@@ -1,5 +1,18 @@
 
 TODO
+  o Add validation block to ShellOpts class methods
+  o Get rid of key_name. Define #name on Grammar::Node instead
+  o Define #name to the string name of the option/command without prefixed '--'
+    for options. This can cause collisions but they can be avoided using aliases
+  o Clean-up
+    o Grammar::options -> Grammar::option_multihash
+    o Clean-up identifiers etc.
+    o Un-multi-izing Grammar::option_multihash and turn it into a regular hash from key to option
+    o subcommand vs. command consistency
+  o Implement ObjectStruct#key! and ObjectStruct#value! (?)
+  o Allow command_alias == nil to suppress the method
+  o Raise on non-existing names/keys. Only return nil for declared names/keys that are not present
+  o Use hash_tree
   o Also allow assignment to usage string for ShellOpts::ShellOpts objects
   o Create a ShellOpts.args method? It would be useful when processing commands:
       case opt
@@ -9,7 +22,10 @@ TODO
     ShellOpts.args would be a shorthand for ShellOpts.shellopts.args
     Another option would be to create an argument-processing method:
       shellopts.argv(2) -> call error if not exactly two arguments else return elements
-      
+  o Add a ShellOpts.option method:
+      file = ShellOpts.option("--file")
+    This will only work for options on the outermost level... maybe:
+      file = ShellOpts.option("load! --file")
   o Check on return value from #process block to see if all options was handled:
       case opt
         when '-v'; verbose = true # Return value 'true' is ok

data/lib/shellopts/ast/node.rb

@@ -23,7 +23,7 @@ module ShellOpts
       end
 
       # Return either a value (option value), an array of values (command), or
-      # nil (option without a value). Should be defined in sub-classes
+      # nil (option without a value). It must be defined in sub-classes of Ast::Node
       def values() raise end
 
       # :nocov:

data/lib/shellopts/compiler.rb

@@ -8,12 +8,12 @@ require 'shellopts/grammar/program.rb'
 module ShellOpts
   module Grammar
     # Compiles an option definition string and returns a Grammar::Program
-    # object. program_name is the name of the program and source is the 
+    # object. name is the name of the program and source is the 
     # option definition string
-    def self.compile(program_name, source)
-      program_name.is_a?(String) or raise Compiler::Error, "Expected String argument, got #{program_name.class}"
+    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(program_name, source).call
+      Compiler.new(name, source).call
     end
 
     # Service object for compiling an option definition string. Returns a 
@@ -26,8 +26,8 @@ module ShellOpts
       class Error < RuntimeError; end
 
       # Initialize a Compiler object. source is the option definition string
-      def initialize(program_name, source)
-        @program_name, @tokens = program_name, source.split(/\s+/).reject(&:empty?)
+      def initialize(name, source)
+        @name, @tokens = name, source.split(/\s+/).reject(&:empty?)
 
         # @commands_by_path is an hash from command-path to Command or Program
         # object. The top level Program object has nil as its path.
@@ -54,7 +54,7 @@ module ShellOpts
       end
 
       def compile_program
-        program = @commands_by_path[nil] = Grammar::Program.new(@program_name, compile_options)
+        program = @commands_by_path[nil] = Grammar::Program.new(@name, compile_options)
         while curr_token && curr_token != "--"
           compile_command
         end

data/lib/shellopts/generator.rb

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

data/lib/shellopts/grammar/command.rb

@@ -11,12 +11,8 @@ module ShellOpts
       # Name of command (String). Name doesn't include the exclamation point ('!')
       attr_reader :name
 
-      # Hash from option names (both short and long names) to option. This
-      # means an option can occur more than once as the hash value
-      attr_reader :options 
-
-      # Sub-commands of this command. Is a hash from sub-command name to command object
-      attr_reader :commands 
+      # Same as #name. TODO Define in Grammar::Node instead
+      alias :key_name :name
 
       # List of options in declaration order
       attr_reader :option_list
@@ -24,6 +20,23 @@ module ShellOpts
       # List of commands in declaration order
       attr_reader :command_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 commands()
+        @command_multihash ||= @command_list.flat_map { |command| 
+          command.identifiers.map { |name| [name, command] }
+        }.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
@@ -32,11 +45,17 @@ module ShellOpts
         @name = name
         parent.attach(self) if parent
         @option_list = option_list
-        @options = @option_list.flat_map { |opt| opt.names.map { |name| [name, opt] } }.to_h
-        @commands = {}
         @command_list = []
       end
 
+      # Return key for the identifier
+      def identifier2key(ident)
+        options[ident]&.key || commands[ident]&.key
+      end
+
+      # Return list of identifiers for the command
+      def identifiers() [key, name] end
+
       # :nocov:
       def dump(&block)
         puts "#{key.inspect}"
@@ -55,7 +74,6 @@ module ShellOpts
     protected
       def attach(command)
         command.instance_variable_set(:@parent, self)
-        @commands[command.name] = command
         @command_list << command
       end
     end

data/lib/shellopts/grammar/option.rb

@@ -10,6 +10,9 @@ module ShellOpts
       # List of long names (incl. '--')
       attr_reader :long_names
 
+      # Name of the key attribute (eg. if key is :all then key_name is '--all'
+      attr_reader :key_name
+
       # List of flags (Symbol)
       def flags() @flags.keys end
 
@@ -23,7 +26,8 @@ module ShellOpts
       # there's no :string flag, it's status is inferred. label is the optional
       # informal name of the option argument (eg. 'FILE') or nil if not present
       def initialize(short_names, long_names, flags, label = nil)
-        super((long_names.first || short_names.first).sub(/^-+/, "").to_sym)
+        @key_name = long_names.first || short_names.first
+        super(@key_name.sub(/^-+/, "").to_sym)
         @short_names, @long_names = short_names, long_names
         @flags = flags.map { |flag| [flag, true] }.to_h
         @label = label
@@ -32,6 +36,12 @@ module ShellOpts
       # Array of option names with short names first and then the long names
       def names() @short_names + @long_names end
 
+      # Array of names and the key
+      def identifiers() names + [key] end
+
+      # Return true if +ident+ is equal to any name or to key
+      def match?(ident) names.include?(ident) || ident == key end
+
       # Flag query methods. Returns true if the flag is present and otherwise nil
       def repeated?() @flags[:repeated] || false end
       def argument?() @flags[:argument] || false end

data/lib/shellopts/grammar/program.rb

@@ -17,7 +17,7 @@ module ShellOpts
       def usage
         (
           render_options(option_list) + 
-          commands.values.map { |cmd| render_command(cmd) } + 
+          command_list.map { |cmd| render_command(cmd) } + 
           args
         ).flatten.join(" ")
       end
@@ -34,7 +34,7 @@ module ShellOpts
     private
       def render_command(command)
         [command.name] + render_options(command.option_list) + 
-            command.commands.values.map { |cmd| render_command(cmd) }.flatten
+            command.command_list.map { |cmd| render_command(cmd) }.flatten
       end
 
       def render_options(options)

data/lib/shellopts/idr.rb

@@ -0,0 +1,209 @@
+
+module ShellOpts
+  # Idr models the Internal Data Representation of a program. It is the native
+  # representation of a command
+  #
+  # The IDR should ideally be completely detached from the compile-time grammar
+  # and AST but they are only hidden from view in this implementation. Create
+  # a Shellopts object instead to access the compiler data
+  #
+  module Idr
+    # Base class for the Idr class hierarchy. It is constructed from an Ast
+    # object by #generate. Node is modelled as an element of a hash with a key
+    # and a value. Options have their (optional) argument as value while
+    # commands use +self+ as value
+    class Node
+      # Unique key (within context) for the option or command. nil for the
+      # top-level Program object
+      #
+      # It is usually the first long option if present and else the first short
+      # option turned into a Symbol by first removing prefixed dashed, eg.
+      # '--all' becomes :all
+      attr_reader :key
+
+      # Name of command and option as used on the command line
+      attr_reader :name
+
+      # Value of node. This can be a simple value (String, Integer, or Float),
+      # an Array of values, or a Idr::Command object. Note that the value of a
+      # Command object is the object itself
+      #
+      # Repeated options are implemented as an Array with one element for each
+      # use of the option. The element is nil if the option doesn't take
+      # arguments or if an optional argument is missing. 
+      attr_reader :value
+
+    protected
+      # Copy arguments into instance variables
+      def initialize(ast, key, name, value)
+        @ast, @key, @name, @value = ast, key, name, value
+      end
+
+      # The AST node for this Idr object
+      attr_reader :ast
+
+      # Shorthand to the grammar node for this Idr object
+      def grammar() @ast.grammar end
+    end
+
+    # Base class for Options
+    class Option < Node
+    end
+
+    class SimpleOption < Option
+    protected
+      # Initialize with defauls from the Ast. +value+ is set to true if option
+      # doesn't take an argument
+      def initialize(ast)
+        value = ast.grammar.argument? ? ast.value : true
+        super(ast, ast.key, ast.name, value)
+      end
+    end
+
+    # An OptionGroup models repeated options collapsed into a single key. The
+    # name of the group should be set to the name of the key (eg. '--all' if
+    # the key is :all)
+    class OptionGroup < Option
+      # Array of names of the options
+      attr_reader :names
+
+      # Array of values of the options
+      alias :values :value
+
+      # Name is set to the key name and value to an array of option values
+      def initialize(key, name, options)
+        @names = options.map(&:name)
+        super(nil, key, name, options.map(&:value))
+      end
+    end
+
+    class Command < Node
+      # Hash from key to options with repeated option_list collapsed into a
+      # option group. It also include an entry for the subcommand.  Options are
+      # ordered by first use on the command line. The command entry will always
+      # be last
+      attr_reader :options
+
+      # List of command line options in the same order as on the command line
+      attr_reader :option_list
+
+      # Subcommand object. Possibly nil
+      attr_reader :subcommand
+
+      # True if ident is declared
+      def declared?(ident) option?(ident) || command?(ident) end
+
+      # True if ident is declared as an option
+      def option?(ident) grammar.options.key?(ident) end
+
+      # True if ident is declared as a command
+      def command?(ident) grammar.commands.key?(ident) end 
+      
+      # True if ident is present
+      def key?(ident)
+        declared?(ident) or raise InternalError, "Undefined identifier: #{ident.inspect}"
+        key = grammar.identifier2key(ident)
+        @options.key?(key)
+      end
+
+      # Value of ident. Repeated options are collapsed into an OptionGroup object
+      def [](ident)
+        declared?(ident) or raise InternalError, "Undefined identifier: #{ident.inspect}"
+        key = grammar.identifier2key(ident)
+        if @options.key?(key)
+          @options[key].value
+        elsif option?(key)
+          false
+        else
+          nil
+        end
+      end
+
+      # Apply defaults recursively. Values can be lambdas that will be evaluated to
+      # get the default value
+      def apply(defaults = {}) end
+
+      # Return options and command as an array
+      def to_a() @ast.values end
+
+      # Return options and command as a hash. The hash also define the
+      # singleton method #subcommand that returns the key of the subcommand
+      #
+      # +key+ controls the type of keys used: +:key+ (the default) use the
+      # symbolic key, +:name+ use key_name. Note that using +:name+ can cause name collisions between
+      # option and command names and that #to_s raises an exception if it detects a collision
+      #
+      # +aliases+ maps from key to replacement key (which could be any object).
+      # +aliases+ can be used to avoid name collisions between options and
+      # commands
+      #
+      # IDEA: Make subcommand _not_ follow the +key+ setting so that setting key to
+      # IDEA: Add a singleton method #subcommand to the hash
+      #
+      def to_h(use: :key, aliases: {})
+        value = {}
+        value.define_singleton_method(:subcommand) { nil }
+        options.values.each { |opt|
+          ident = aliases[opt.key] || (use == :key ? opt.key : opt.ast.grammar.key_name)
+          !value.key?(ident) or raise ConversionError, "Duplicate key: #{ident.inspect}"
+          case opt
+            when Option
+              value[ident] = opt.value
+            when Command
+              value[ident] = opt.value.to_h
+              value.define_singleton_method(:subcommand) { ident } # Redefine
+          else
+            raise InternalError, "Oops"
+          end
+        }
+        value
+      end
+
+      # Return options and command as a struct
+      def to_struct(key = :key, aliases = {}) OptionStruct.new(self, key, aliases) end
+
+    protected
+      # Initialize an Idr::Command object and all dependent objects
+      def initialize(ast)
+        super(ast, ast.key, ast.name, self)
+        @option_list = ast.options.map { |node| SimpleOption.new(node) }
+        @subcommand = Command.new(ast.command) if ast.command
+        @options = @option_list.group_by { |option| option.key }.map { |key, option_list|
+          option = 
+              if ast.grammar.options[key].repeated?
+                OptionGroup.new(key, ast.grammar.options[key].key_name, option_list)
+              else
+                option_list.first
+              end
+          [key, option]
+        }.to_h
+        @options[subcommand.key] = @subcommand if @subcommand
+      end
+    end
+
+    class Program < Command
+      # #key is nil for the top-level Program object
+      def key() nil end
+
+      # Remaining command line arguments
+      def args() @ast.arguments end
+
+      # Messenger object that is used to emit error messages. It should
+      # implement #error(*args) and #fail(*args)
+      attr_reader :messenger
+
+      # Initialize the top-level Idr::Program object
+      def initialize(ast, messenger)
+        @messenger = messenger
+        super(ast)
+      end
+
+      # Emit error message and a usage description before exiting with status 1
+      def error(*args) messenger.error(*error_messages) end
+
+      # Emit error message before exiting with status 1
+      def fail(*args) messenger.fail(*error_messages) end
+    end
+  end
+end
+

data/lib/shellopts/messenger.rb

@@ -0,0 +1,71 @@
+
+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
+