shellopts 2.0.21 → 2.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2e9d4e1a3ad5eca9fd21a3bad085a252ff7b6921ec889e4da404c989304bf9c
-  data.tar.gz: fa9f67483fcfb303e76f8b6b2282948f117f2497b734b6fdd6ca6f91a29b3d96
+  metadata.gz: fff67178855b9164ee7e432d2074040c4c7d8249231e83f27ce1b6a345dbad4c
+  data.tar.gz: 9c9816fda6e7361e310080fd9d150d0c9e7419de929e42a552cfa8dd4c9d7740
 SHA512:
-  metadata.gz: 29c8d07d8fdf63c8b4e04d031ec1c7b779ed3410265103514ade6f8e5fd2b45d3f5b804de934722e0f49d11119e14e463507b7d63c0c6d2059018b75fec281a6
-  data.tar.gz: 2f7cad783bd109dc264574cb6ed76ec1f947d1591e15267bf071ebd243b5b646039bdec9fc2dac7983db38463fb6eddb328d920beaa35052647e647f9020ed49
+  metadata.gz: 4c6f20dd0afbf624cc671ffc2468977861a3533c5f447acadf3082cdf577dbb9547a96e5ece6cc78fc9f93045dea99581d37f6f7e521e2bcc43261bec07cf653
+  data.tar.gz: 773fde53cd201e58c8d860d19861c5d33c2ce0214d5c5986cc9ce5d91d5b920e33f54398a2b6e9185c7300504ce82169c94e1d92854d68ce76c8cf9050b035f8

data/lib/shellopts/argument_type.rb

@@ -18,7 +18,8 @@ module ShellOpts
       # if type is an IntegerArgument
       def value?(value) true end
 
-      # Convert value to Ruby type
+      # Convert value to Ruby type. This method can also be used to translate
+      # special keywords
       def convert(value) value end
 
       # String representation. Equal to #name
@@ -60,69 +61,120 @@ module ShellOpts
       attr_reader :kind
 
       def initialize(kind)
-        constrain kind, :file, :dir, :path, :efile, :edir, :epath, :nfile, :ndir, :npath
+        constrain kind, :file, :dir, :path, :efile, :edir, :epath, :nfile, :ndir, :npath, :ifile, :ofile
         @kind = kind 
       end
 
       def match?(name, literal)
-        case kind
-          when :file; match_path(name, literal, kind, :file?, :default)
-          when :dir; match_path(name, literal, kind, :directory?, :default)
-          when :path; match_path(name, literal, kind, :exist?, :default)
-
-          when :efile; match_path(name, literal, kind, :file?, :exist)
-          when :edir; match_path(name, literal, kind, :directory?, :exist)
-          when :epath; match_path(name, literal, kind, :exist?, :exist)
-
-          when :nfile; match_path(name, literal, kind, :file?, :new)
-          when :ndir; match_path(name, literal, kind, :directory?, :new)
-          when :npath; match_path(name, literal, kind, :exist?, :new)
+        # Special-case '-' keyword
+        if literal == '-' && [:ifile, :ofile].include?(kind)
+          true
+
+        # Special-case standard I/O files
+        elsif %w(/dev/stdin /dev/stdout /dev/stderr /dev/null).include?(literal)
+          case kind
+            when :file, :path, :efile, :epath, :nfile, :npath
+              true
+            when :ifile
+              %w(/dev/stdin /dev/null).include? literal or 
+                  set_message "Can't read #{literal}"
+            when :ofile
+              %w(/dev/stdout /dev/stderr /dev/null).include?(literal) or 
+                  set_message "Can't write to #{literal}"
+            when :dir, :edir, :ndir
+              set_message "Expected file, got directory #{literal}"
+          else
+            raise ArgumentError, "Unhandled kind: #{kind.inspect}"
+          end
+
+        # All other files or directories
         else
-          raise InternalError, "Illegal kind: #{kind.inspect}"
+          case kind # TODO: node, enode, npath - special files: character, block, socket, etc.
+            when :file; match_path(name, literal, kind, :file?, :default)
+            when :dir; match_path(name, literal, kind, :directory?, :default)
+            when :path; match_path(name, literal, kind, :exist?, :default)
+
+            when :efile; match_path(name, literal, kind, :file?, :exist)
+            when :edir; match_path(name, literal, kind, :directory?, :exist)
+            when :epath; match_path(name, literal, kind, :exist?, :exist)
+
+            when :nfile; match_path(name, literal, kind, :file?, :new)
+            when :ndir; match_path(name, literal, kind, :directory?, :new)
+            when :npath; match_path(name, literal, kind, :exist?, :new)
+
+            when :ifile; match_path(name, literal, kind, :readable?, :default)
+            when :ofile; match_path(name, literal, kind, :writable?, :default)
+          else
+            raise InternalError, "Illegal kind: #{kind.inspect}"
+          end
         end
       end
 
       # Note: No checks done, not sure if it is a feature or a bug
       def value?(value) value.is_a?(String) end
 
+      def convert(value)
+        if value == "-"
+          case kind
+            when :ifile; "/dev/stdin"
+            when :ofile; "/dev/stdout"
+          else
+            value
+          end
+        else
+          value
+        end
+      end
+
     protected
       def match_path(name, literal, kind, method, mode)
         subject = 
             case kind
-              when :file, :efile, :nfile; "regular file"
+              when :file, :efile, :nfile, :ifile, :ofile; "file"
               when :dir, :edir, :ndir; "directory"
               when :path, :epath, :npath; "path"
             else
               raise ArgumentError
             end
 
-        if File.send(method, literal) # exists?
+        # file exists and is the rigth type?
+        if File.send(method, literal)
           if mode == :new
             set_message "#{subject.capitalize} already exists in #{name}: #{literal}"
           elsif kind == :path || kind == :epath
             if File.file?(literal) || File.directory?(literal)
               true
             else
-              set_message "Expected regular file or directory as #{name} argument: #{literal}"
+              set_message "Expected file or directory as #{name} argument: #{literal}"
             end
+          elsif (kind == :ifile || kind == :ofile) && File.directory?(literal)
+            set_message "File expected, got directory: #{literal}"
           else
             true
           end
-        elsif File.exist?(literal) # exists but not the right type
-          if mode == :new
-            set_message "#{subject.capitalize} already exists"
+
+        # file exists but not the right type?
+        elsif File.exist?(literal)
+          if kind == :ifile
+            set_message "Can't read #{literal}"
+          elsif kind == :ofile
+            set_message "Can't write to #{literal}"
+          elsif mode == :new
+            set_message "#{subject.capitalize} already exists - #{literal}"
           else
             set_message "Expected #{subject} as #{name} argument: #{literal}"
           end
-        else # does not exist
+
+        # file does not exist
+        else 
           if [:default, :new].include? mode
-            if File.exist?(File.dirname(literal))
+            if File.exist?(File.dirname(literal)) || kind == :ofile
               true
             else
               set_message "Illegal path in #{name}: #{literal}"
             end
           else
-            set_message "Error in #{name} argument: Can't find #{literal}"
+            set_message "Can't find #{literal}"
           end
         end
       end

data/lib/shellopts/formatter.rb

@@ -30,8 +30,8 @@ module ShellOpts
     class Command
       using Ext::Array::Wrap
 
-      def puts_usage(bol: false)
-        width = [Formatter.rest, Formatter::USAGE_MAX_WIDTH].min
+      def puts_usage(bol: false, max_width: Formatter::USAGE_MAX_WIDTH)
+        width = [Formatter.rest, max_width].min
         if descrs.size == 0
           print (lead = Formatter.command_prefix || "")
           indent(lead.size, ' ', bol: bol && lead == "") { 
@@ -41,7 +41,7 @@ module ShellOpts
           lead = Formatter.command_prefix || ""
           descrs.each { |descr|
             print lead
-            puts render(:single, width, args: [descr.text]) 
+            puts render(:multi, width, args: descr.text.split(' ')) 
           } 
         end
       end
@@ -58,7 +58,7 @@ module ShellOpts
         end
 
         puts "Usage"
-        indent { puts_usage(bol: true) }
+        indent { puts_usage(bol: true, max_width: Formatter::HELP_MAX_WIDTH) }
 
         if options.any?
           puts
@@ -112,14 +112,13 @@ module ShellOpts
         puts
 
         puts Ansi.bold "USAGE"
-        indent { puts_usage(bol: true) }
+        indent { puts_usage(bol: true, max_width: Formatter::HELP_MAX_WIDTH) }
 
         section = {
           Paragraph => "DESCRIPTION",
           OptionGroup => "OPTION",
           Command => "COMMAND"
         }
-
         seen_sections = {}
         newline = false # True if a newline should be printed before child 
         indent {
@@ -173,7 +172,10 @@ module ShellOpts
     end
 
     module WrappedNode
-      def puts_descr(width = Formatter.rest) puts lines(width) end
+      def puts_descr
+        width = [Formatter.rest, Formatter::HELP_MAX_WIDTH].min
+        puts lines(width) 
+      end
     end
 
     class Code
@@ -217,6 +219,9 @@ module ShellOpts
     # Indent to use in help output
     HELP_INDENT = 4
 
+    # Max. width of help text (not including indent)
+    HELP_MAX_WIDTH = 85 
+
     # Command prefix when subject is a sub-command
     def self.command_prefix() @command_prefix end
 

data/lib/shellopts/parser.rb

@@ -83,8 +83,8 @@ module ShellOpts
             when "$"
               @argument_name ||= "NUM"
               @argument_type = FloatArgument.new
-            when "FILE", "DIR", "PATH", "EFILE", "EDIR", "EPATH", "NFILE", "NDIR", "NPATH"
-              @argument_name ||= arg.sub(/^(?:E|N)/, "")
+            when "FILE", "DIR", "PATH", "EFILE", "EDIR", "EPATH", "NFILE", "NDIR", "NPATH", "IFILE", "OFILE"
+              @argument_name ||= arg.sub(/^(?:E|N|I|O)/, "")
               @argument_type = FileArgument.new(arg.downcase.to_sym)
             when /,/
               @argument_name ||= arg

data/lib/shellopts/renderer.rb

@@ -15,9 +15,9 @@ require 'terminfo'
 #
 # Command rendering
 #   cmd --all --beta [cmd1|cmd2] ARG1 ARG2    # Single-line formats (:single)
-#   cmd --all --beta [cmd1|cmd2] ARGS...     
+#   cmd --all --beta [cmd1|cmd2] ARGS...      # Not used
 #   cmd -a -b [cmd1|cmd2] ARG1 ARG2
-#   cmd -a -b [cmd1|cmd2] ARGS...
+#   cmd -a -b [cmd1|cmd2] ARGS...             # Not used
 #
 #   cmd -a -b [cmd1|cmd2] ARG1 ARG2           # One line for each argument description (:enum)
 #   cmd -a -b [cmd1|cmd2] ARG3 ARG4           # (used in the USAGE section)
@@ -108,7 +108,7 @@ module ShellOpts
       def get_args(args: nil)
         case descrs.size
           when 0; []
-          when 1; [descrs.first.text]
+          when 1; descrs.first.text.split(' ')
           else [DESCRS_ABBR]
         end
       end
@@ -120,6 +120,7 @@ module ShellOpts
       end
 
       # Force one line. Compact options, commands, arguments if needed
+      #
       def render_single(width, args: nil)
         long_options = options.map { |option| option.render(:long) }
         short_options = options.map { |option| option.render(:short) }
@@ -164,32 +165,30 @@ module ShellOpts
       def render_multi(width, args: nil)
         long_options = options.map { |option| option.render(:long) }
         short_options = options.map { |option| option.render(:short) }
-        short_commands = commands.empty? ? [] : ["[#{commands.map(&:name).join("|")}]"]
-        compact_commands = [COMMANDS_ABBR]
+        compact_options = options.empty? ? [] : [OPTIONS_ABBR]
+
+        # Only compact commands if they can't fit on one line
+        if commands.empty?
+          use_commands = []
+        else
+          short_command = "[#{commands.map(&:name).join("|")}]"
+          use_commands = [short_command.size > width ? COMMANDS_ABBR : short_command]
+        end
 
         args ||= get_args
 
         # On one line
-        words = [name] + long_options + short_commands + args
+        words = [name] + long_options + use_commands + args
         return [words.join(" ")] if pass?(words, width)
-        words = [name] + short_options + short_commands + args
+        words = [name] + short_options + use_commands + args
+        return [words.join(" ")] if pass?(words, width)
+        words = [name] + compact_options + use_commands + args
         return [words.join(" ")] if pass?(words, width)
 
         # On multiple lines
         lead = name + " "
-        options = long_options.wrap(width - lead.size)
-        options = [lead + options[0]] + indent_lines(lead.size, options[1..-1])
-
-        begin
-          words = short_commands + args
-          break if pass?(words, width)
-          words = compact_commands + args
-          break if pass?(words, width)
-          words = compact_commands + [DESCRS_ABBR]
-        end while false
-
-        cmdargs = words.empty? ? [] : [words.join(" ")]
-        options + indent_lines(lead.size, cmdargs)
+        words = (long_options + use_commands + args).wrap(width - lead.size)
+        lines = [lead + words[0]] + indent_lines(lead.size, words[1..-1])
       end
 
     protected

data/lib/shellopts/version.rb

@@ -1,3 +1,3 @@
 module ShellOpts
-  VERSION = "2.0.21"
+  VERSION = "2.0.24"
 end

data/lib/shellopts.rb

@@ -140,7 +140,7 @@ module ShellOpts
         float: true,
 
         # Let exceptions through
-        exceptions: false
+        exception: false
       )
         
       @name = name || File.basename($PROGRAM_NAME)

data/shellopts.gemspec

@@ -28,8 +28,7 @@ Gem::Specification.new do |spec|
   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 "rake"
+  spec.add_development_dependency "rspec"
   spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shellopts
 version: !ruby/object:Gem::Version
-  version: 2.0.21
+  version: 2.0.24
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-21 00:00:00.000000000 Z
+date: 2022-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forward_to
@@ -66,48 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.10
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '0'
   type: :development
   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
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement