shellopts 2.0.5 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3a8b18b0a610c14ac4a85f80cd70ff5f85ca7dc868b25615a67a3ad71f737b5
-  data.tar.gz: 2b0442868d8ddf102a5f8ee1b3d3307ecbea17a95512f5164d4a64a9d3fa9ec7
+  metadata.gz: e6c52f313fee54283e1d5e704dd8b75a96239db6cff70584eefe747cf56270c1
+  data.tar.gz: 67b50b7b3a993bf77533246c9634ce7850d765891381244fedf2b1ecf3f6bc76
 SHA512:
-  metadata.gz: c90ab9e0049ba64e21c2b0fd408b438df84c0265fced52b84d221bdb2b96f92e75624c00ab59526c9caa80f67e2e7d55c5bcf0cb8138b803722b424e08ea9202
-  data.tar.gz: 372e29956c8f3e27f8f5617215cf610403d40a307257c0c63605e94bd39fffaa8bf9cb165e82fe61497fcc8f0519c4298c1bf4480fa26735f5bf5c01e12fe8e2
+  metadata.gz: 3cf5cd91d92bce24b1d04a3a526d6f43f8fe761f760319bf60191e2e638c3301fdbf9c63aa9f465aa8755cd18aa56293f0ae68e01870d6a877928bc1c0eebf5c
+  data.tar.gz: 0e1fa649cff6a072d676a33dab6a3cbb038cb6799b59088f7ebff1144e6983843fe16658c80fa75308f057caf24e5b232aea15c92f80290d0969d868e653159e

data/TODO

@@ -1,4 +1,5 @@
 
+o Add brackets to optional option arguments: '--all=FILE?' -> '--all[=FILE]'
 o Ignore all text after ' # ' (doesn't conflict with option flag)
 o Command aliases
 o Add user-defined setions

data/lib/shellopts/analyzer.rb

@@ -28,10 +28,13 @@ module ShellOpts
         @options = option_groups.map(&:options).flatten
       end
 
-      # Move options before first command
+      # Move options before first command or before explicit COMMAND section
       def reorder_options
         if commands.any?
-          if i = children.find_index { |child| child.is_a?(Command) }
+          i = children.find_index { |child| 
+            child.is_a?(Command) || child.is_a?(Section) && child.name == "COMMAND"
+          }
+          if i
             options, rest = children[i+1..-1].partition { |child| child.is_a?(OptionGroup) }
             @children = children[0, i] + options + children[i..i] + rest
           end

data/lib/shellopts/args.rb

@@ -2,21 +2,31 @@
 module ShellOpts
   # Specialization of Array for arguments lists. Args extends Array with a
   # #extract and an #expect method to extract elements from the array. The
-  # methods raise a ShellOpts::UserError exception in case of errors
+  # methods raise a ShellOpts::Error exception in case of errors
   #
   class Args < Array
+    def initialize(*args, exception: false)
+      super(*args)
+      @exception = exception
+    end
+
+    # :call-seq:
+    #   extract(count, message = nil)
+    #   extract(range, message = nil)
+    #
     # Remove and return elements from beginning of the array
     #
     # If +count_or_range+ is a number, that number of elements will be
     # returned.  If the count is one, a simple value is returned instead of an
     # array. If the count is negative, the elements will be removed from the
     # end of the array. If +count_or_range+ is a range, the number of elements
-    # returned will be in that range. The range can't contain negative numbers 
+    # returned will be in that range. Note that the range can't contain
+    # negative numbers 
     #
-    # #extract raise a ShellOpts::UserError exception if there's is not enough
+    # #extract raise a ShellOpts::Error exception if there's is not enough
     # elements in the array to satisfy the request
     #
-    def extract(count_or_range, message = nil) 
+    def extract(count_or_range, message = nil)
       case count_or_range
         when Range
           range = count_or_range
@@ -30,16 +40,16 @@ module ShellOpts
           count.abs <= self.size or inoa(message)
           start = count >= 0 ? 0 : size + count
           r = slice!(start, count.abs)
-          r.size <= 0 ? nil : (r.size == 1 ? r.first : r)
+          r.size == 1 ? r.first : r
         else
           raise ArgumentError
       end
     end
 
     # As #extract except it doesn't allow negative counts and that the array is
-    # expect to be emptied by the operation
+    # expected to be emptied by the operation
     #
-    # #expect raise a ShellOpts::UserError exception if the array is not emptied 
+    # #expect raise a ShellOpts::Error exception if the array is not emptied 
     # by the operation
     #
     def expect(count_or_range, message = nil)
@@ -54,8 +64,10 @@ module ShellOpts
     end
 
   private
-    def inoa(message = nil) 
-      raise ArgumentError, message || "Illegal number of arguments"
+    def inoa(message = nil)
+      message ||= "Illegal number of arguments"
+      raise Error, message if @exception
+      ::ShellOpts.error(message)
     end
   end
 end

data/lib/shellopts/formatter.rb

@@ -200,8 +200,8 @@ module ShellOpts
     # Number of characters between columns in brief output
     BRIEF_COL_SEP = 2
 
-    # Maximum width of first column in brief option and command lists
-    BRIEF_COL1_MIN_WIDTH = 6
+    # Minimum width of first column in brief option and command lists
+    BRIEF_COL1_MIN_WIDTH = 20
 
     # Maximum width of first column in brief option and command lists
     BRIEF_COL1_MAX_WIDTH = 40

data/lib/shellopts/grammar.rb

@@ -151,6 +151,10 @@ module ShellOpts
     class OptionGroup < Node
       alias_method :command, :parent
 
+      # Duck typing for compatibility with IdrNode (TODO: maybe just make
+      # OptionGroup an IdrNode and be over with it)
+      def name() options.first&.name end
+
       # Array of options in declaration order
       attr_reader :options
 
@@ -352,6 +356,10 @@ module ShellOpts
     end
 
     class Section < Node
+      def initialize(parent, token)
+        constrain token.source, *%w(DESCRIPTION OPTION COMMAND)
+        super
+      end
       def name() token.source end
     end
 

data/lib/shellopts/interpreter.rb

@@ -32,7 +32,7 @@ module ShellOpts
           end
         end
       end
-      [@expr, Args.new(@args + @argv)]
+      [@expr, Args.new(@args + @argv, exception: @exception)]
     end
 
     def self.interpret(grammar, argv, **opts)

data/lib/shellopts/lexer.rb

@@ -45,7 +45,7 @@ module ShellOpts
     # Match ArgDescr words (should be at least two characters long)
     DESCR_RE = /^[^a-z]{2,}$/
 
-    SECTIONS = %w(DESCRIPTION OPTIONS COMMANDS)
+    SECTIONS = %w(DESCRIPTION OPTION OPTIONS COMMAND COMMANDS)
 
     using Ext::Array::ShiftWhile
 
@@ -109,7 +109,7 @@ module ShellOpts
 
         # Sections
         elsif SECTIONS.include?(line.text)
-          @tokens << Token.new(:section, line.lineno, line.charno, line.text)
+          @tokens << Token.new(:section, line.lineno, line.charno, line.text.sub(/S$/, ""))
 
         # Options, commands, usage, arguments, and briefs
         elsif line =~ DECL_RE

data/lib/shellopts/parser.rb

@@ -122,6 +122,23 @@ module ShellOpts
       def self.parse(token)
         super(nil, token)
       end
+
+      def add_stdopts
+        option_token = Token.new(:option, 1, 1, "--version")
+        brief_token = Token.new(:brief, 1, 1, "Write version number and exit")
+        group = OptionGroup.new(self, option_token)
+        option = Option.parse(group, option_token)
+        brief = Brief.parse(group, brief_token)
+
+        option_token = Token.new(:option, 1, 1, "-h,help")
+        brief_token = Token.new(:brief, 1, 1, "Write help text and exit")
+        paragraph_token = Token.new(:text, 1, 1, 
+            "-h prints a brief help text, --help prints a longer man-style description of the command")
+        group = OptionGroup.new(self, option_token)
+        option = Option.parse(group, option_token)
+        brief = Brief.parse(group, brief_token)
+        paragraph = Paragraph.parse(group, paragraph_token)
+      end
     end
 
     class ArgSpec
@@ -146,6 +163,14 @@ module ShellOpts
       @nodes = {}
     end
 
+#   def add_stdopts
+#     version_token = Token.new(:option, 1, 1, "--version")
+#     version_brief = Token.new(:brief, 1, 1, "Gryf gryf")
+#     group = Grammar::OptionGroup.new(@program, version_token)
+#     option = Grammar::Option.parse(group, version_token)
+#     brief = Grammr::Brief.parse(option, version_brief)
+#   end
+
     def parse()
       @program = Grammar::Program.parse(@tokens.shift)
       oneline = @tokens.first.lineno == @tokens.last.lineno

data/lib/shellopts/version.rb

@@ -1,3 +1,3 @@
 module ShellOpts
-  VERSION = "2.0.5"
+  VERSION = "2.0.8"
 end

data/lib/shellopts.rb

@@ -127,16 +127,13 @@ module ShellOpts
     # Compile source and return grammar object. Also sets #spec and #grammar.
     # Returns the grammar
     def compile(spec)
-      if stdopts
-        spec += "\n--version\n  Write version number and exit\n-h,help @ Write help text and exit\n  Write help text. -h prints a brief text, --help prints a longer man-style description of the command"
-      end
       handle_exceptions {
         @oneline = spec.index("\n").nil?
         @spec = spec.sub(/^\s*\n/, "")
         @file = find_caller_file
         @tokens = Lexer.lex(name, @spec, @oneline)
         ast = Parser.parse(tokens)
-        # TODO: Add standard and message options and their handlers
+        ast.add_stdopts if stdopts
         @grammar = Analyzer.analyze(ast)
       }
       self
@@ -197,7 +194,7 @@ module ShellOpts
       saved = $stdout
       $stdout = $stderr
       $stderr.puts "#{name}: #{message}"
-      Formatter.usage(program)
+      Formatter.usage(grammar)
       exit 1
     ensure
       $stdout = saved

data/main

@@ -9,7 +9,9 @@ include ShellOpts
 
 VERSION = "1.2.3"
 
-SPEC = "-a"
+SPEC = %(
+  -a @ An option
+)
 opts, args = ShellOpts::process(SPEC, ARGV, version: VERSION)
 #ShellOpts::ShellOpts.help
 

data/shellopts.gemspec

@@ -1,7 +1,5 @@
 
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "shellopts/version"
+require_relative "lib/shellopts/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "shellopts"
@@ -15,15 +13,18 @@ Gem::Specification.new do |spec|
                           and has built-in help and error messages}
   spec.homepage      = "http://github.com/clrgit/shellopts"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
   end
+
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "forward_to"
-  spec.add_dependency "constrain"
+  spec.add_dependency "constrain", "~> 0.5.1"
   spec.add_dependency "ruby-terminfo"
   spec.add_dependency "indented_io"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shellopts
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.8
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-01 00:00:00.000000000 Z
+date: 2022-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forward_to
@@ -28,16 +28,16 @@ dependencies:
   name: constrain
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: ruby-terminfo
   requirement: !ruby/object:Gem::Requirement
@@ -132,10 +132,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile

data/.gitignore

@@ -1,30 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/rdoc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-# simplecov
-/coverage/
-
-# Ignore Gemfile.lock. See https://stackoverflow.com/questions/4151495/should-gemfile-lock-be-included-in-gitignore
-/Gemfile.lock
-
-# Ignore vim files
-.*.swp
-
-# Ignore t.* files
-t
-t.*
-tt
-tt.*
-s
-s.*
-
-# Ignore temporary directory
-/spec/tmpdir/

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.1