shellopts 2.9.4 → 2.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7defb9acfdec63e96a3ecb7d75c507d3bde7df529e5184d64721da771b8153f8
-  data.tar.gz: 4597ce11597a9e1f3a332b92a5ffc68a1460a59afbb18bf545bc31bd49056906
+  metadata.gz: 9b37c30aa585a54cf4683ef32bea5aa0ca0eabc7cdbb4d8e36ddc4d8a0f74747
+  data.tar.gz: 681b00e0bd4454b2b81dea46542c3c4579da6ba44d169bd4276b65d6c9c45168
 SHA512:
-  metadata.gz: 7d295bf5a9c353192cd2a7332003d0947ecf45c9fee698a97949389b57ad04155f102625a69749380eee372cad81451fe9d2eb9f6c477e67948f83c4140b51f8
-  data.tar.gz: b18c805a3b6212ad52f59bcbbcd3ab845fae9335ec02237a454070081e8e31580ac256a83c9a2fc8da5c4f6411800ce8ed14de306e08339f8a46d2a23b7358ae
+  metadata.gz: ddb846f437e6ceeb08f5c60a81408d1bbf17d2237bd9a01a2f41364833deac6e23c1f2478368a2c9fff2c50bd4679c1d389ae3ac29c3fa35140a0b34237d2bb4
+  data.tar.gz: f2cf6dae553ec03a33be9270925942f5f738cc4a768ee58325711f0971000607cffb9e940f82aef24a899cd5ec5c4536b3ef2ce684f42b2d52efb87419d5fe1c

data/lib/shellopts/analyzer.rb

@@ -27,12 +27,16 @@ module ShellOpts
       # Move options before first command or before explicit COMMAND section
       def reorder_options
         if commands.any?
-          i = children.find_index { |child|
+          command_index = 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
+          if command_index
+            initial, rest = children[0...command_index], children[command_index..]
+            option_sections, rest = rest.partition { |child|
+              child.is_a?(Section) && child.name == "OPTION"
+            }
+            option_groups, rest = rest.partition { |child| child.is_a?(OptionGroup) }
+            @children = initial + option_sections + option_groups + rest
           end
         end
       end

data/lib/shellopts/formatter.rb

@@ -26,6 +26,14 @@ module ShellOpts
       end
     end
 
+    class Section
+      # This is a hack since the section does not contain any elements - this
+      # is an error in the parser
+      def puts_descr
+        indent(-1) { print Ansi.bold(name) }
+      end
+    end
+
     # brief one-line commands should optionally use compact options
     class Command
       using Ext::Array::Wrap
@@ -123,8 +131,8 @@ module ShellOpts
         newline = false # True if a newline should be printed before child
         indent {
           children.each { |child|
-            klass = child.is_a?(Section) ?  section.key(child.name) : child.class
-            if s = section[klass] # Implicit section
+            klass = child.is_a?(Section) ? section.key(child.name) : child.class
+            if s = section[klass] # Built-in sections
               section.delete(klass)
               section.delete(Paragraph)
               if klass <= OptionGroup
@@ -136,6 +144,7 @@ module ShellOpts
               indent(-1) { puts Ansi.bold s }
               newline = false
               next if child.is_a?(Section)
+
             else # Any other node adds a newline
               puts if newline
               newline = true

data/lib/shellopts/grammar.rb

@@ -22,12 +22,9 @@ module ShellOpts
         @parent.send(:attach, self) if @parent
       end
 
-      def traverse(*klasses, &block)
-        do_traverse(Array(klasses).flatten, &block)
-      end
-
       def parents() parent ? [parent] + parent.parents : [] end
       def ancestors() parents.reverse end
+      def traverse(*klasses, &block) = do_traverse(Array(klasses).flatten, &block)
 
       def inspect
         self.class.to_s
@@ -337,9 +334,6 @@ module ShellOpts
       alias_method :command, :parent
     end
 
-    class Usage < ArgDescr
-    end
-
     module WrappedNode
       using Ext::Array::Wrap
       def words() @words ||= text.split(" ") end
@@ -362,10 +356,6 @@ 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
 
@@ -379,7 +369,7 @@ module ShellOpts
         Arg => [ArgSpec],
         ArgDescr => [Command],
         Brief => [Command, OptionGroup, ArgSpec, ArgDescr],
-        Paragraph => [Command, OptionGroup],
+        Paragraph => [Command, OptionGroup, Section],
         Code => [Command, OptionGroup],
         Section => [Program]
       }

data/lib/shellopts/lexer.rb

@@ -3,7 +3,7 @@ module ShellOpts
   class Line
     attr_reader :source
     attr_reader :lineno
-    attr_reader :charno
+    attr_reader :charno # aka "indent + 1"
     attr_reader :text
 
     def initialize(lineno, charno, source)
@@ -107,10 +107,14 @@ module ShellOpts
             @tokens << Token.new(kind, line.lineno, line.charno, line.text)
           }
 
-        # Sections
+        # Built-in sections
         elsif SECTIONS.include?(line.text)
           @tokens << Token.new(:section, line.lineno, line.charno, line.text.sub(/S$/, ""))
 
+        # User-defined sections
+        elsif line.text =~ /^[^a-z]*$/ && lines.first && lines.first.charno > line.charno
+          @tokens << Token.new(:section, line.lineno, line.charno, line)
+
         # Options, commands, usage, arguments, and briefs
         elsif line =~ DECL_RE
           words = line.words

data/lib/shellopts/parser.rb

@@ -244,7 +244,7 @@ module ShellOpts
             Grammar::ArgDescr.parse(cmds.top, token)
 
           when :text
-            # Text is only allowed on new lines
+            # Text is only allowed on new lines. FIXME Does nothing
             token.lineno > nodes.top.token.lineno
 
             # Detect indented comment groups (code)

data/lib/shellopts/version.rb

@@ -1,3 +1,3 @@
 module ShellOpts
-  VERSION = "2.9.4"
+  VERSION = "2.9.6"
 end

data/lib/shellopts.rb

@@ -40,6 +40,7 @@ require_relative 'shellopts/dump.rb'
 #     prints an intelligble error message and prettyfies stack dump. This
 #     should catch non-RuntimeError/IOError exceptions
 #   * Find a reliable way of testing environment
+#
 
 module ShellOpts
   # Base error class
@@ -171,6 +172,7 @@ module ShellOpts
       @debug = debug
       @float = float
       @exception = exception
+      @clear_screen = true
     end
 
     # Compile source and return grammar object. Also sets #spec and #grammar.
@@ -299,11 +301,11 @@ module ShellOpts
     def brief() Formatter.brief(@grammar) end
 
     # Print help for the given subject or the full documentation if +subject+
-    # is nil. Clears the screen beforehand if :clear is true
-    def help(subject = nil, clear: true)
+    # is nil. Clears the screen beforehand if #clear_screen is true
+    def help(subject = nil)
       node = (subject ? @grammar[subject] : @grammar) or
           raise ArgumentError, "No such command: '#{subject&.sub(".", " ")}'"
-      print '' if clear
+      print '' if ::ShellOpts.clear_screen
       Formatter.help(node)
     end
 
@@ -445,8 +447,15 @@ module ShellOpts
   def self.exception = @exception
   def self.exception=(value) @exception = value end
 
-  # The instance is a ShellOpts object. 'instance.program' and 'instance.argv'
-  # is the same as the values returned from ShellOpts.process
+  # Controls whether the --help option clears the screen before printing. This
+  # can be set to false in development to prevent debug output from being
+  # cleared
+  @clear_screen = true
+  def self.clear_screen = @clear_screen
+  def self.clear_screen=(clear) @clear_screen = clear end
+
+  # The instance is a ShellOpts object. 'instance.program' and 'instance.args'
+  # are the same as the values returned from ShellOpts.process
   @instance = nil
   def self.instance?() !@instance.nil? end
   def self.instance() @instance or raise Error, "ShellOpts is not initialized" end

data/main

@@ -4,25 +4,39 @@
 
 require_relative 'lib/shellopts.rb'
 
-#include ShellOpts::Message
-include ShellOpts::Verbose
-#include ShellOpts::Debug
+include ShellOpts
+ShellOpts.clear_screen = false
 
-#include ShellOpts::Messages
-#p ShellOpts::Messages.is_included?
 SPEC = %(
-  Test
+  @ Make RLS functions and policies
+
+  -- [DATABASE] SPEC-FILE
+
+  Read SPEC-FILE and generate acl_portal.acl_* data. DATABASE and USERNAME
+  variables are read from the environment and then .prick.state.yml if present;
+  otherwise the current user's database is used
+
+  OPTIONS
+    --dump
+      Dump internal format. Used for debugging
+
+  COMMANDS
+    update!
+      Update the current database. This just keeps the IDs in acl_tables
+      stable, all other involved tables are cleared before loading
+
+  SPEC FILE
+    The format is a YAML file where each root key represents a table. A table
+    consists of select, insert, update, delete, and attach/detach actions that
+    are arrays of ACL entries
+
+  ANOTHER SUBJECT
+    Bla bla bla
 
-  -a
-    An option
 )
 
-opts, args = ShellOpts.process(SPEC, ARGV, version: "--ver", version_number: "1.2.3")
+opts, args = ShellOpts.process(SPEC, ARGV)
 
-verb "Verbose default"
-(0..3).each { |i| verb i, "Verbose #{i}" }
-mesg "Message"
-notice "Notice"
-#debug "Debug"
-puts ShellOpts.instance.version_number
+pp opts.to_h
+pp args
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shellopts
 version: !ruby/object:Gem::Version
-  version: 2.9.4
+  version: 2.9.6
 platform: ruby
 authors:
 - Claus Rasmussen