shellopts 2.4.0 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68428ade0dd8ec48fa85a8d43362743d6dc5595d9f4af3347d0fa402eaf0e7bb
-  data.tar.gz: 51404fbc53ddbacb0b7a4552777e3de7c8abce1d508782f6c901da4b2cd332ba
+  metadata.gz: 93dc09edd7bd318c85134a93f7c45352f4b2e550663c1a80a029d4fcb1d8ab16
+  data.tar.gz: c9e0b523c15f372d5dd988d2fd804c01539e90f0ee02ef68d284b4a1340e7c9c
 SHA512:
-  metadata.gz: ca5499680c53cc74388102b130eb9a7dfc7dc53ba7556615991d93d882ddc4993e1854891d78bbd97ccb4d37e8d493fb1c4e199cc4361f96ddb2e55c536f4cc7
-  data.tar.gz: d75bef2e9b154a0332ed55a272341072654db8c615c5e4c9a27a94823efd6bae354fe32ca14679c92553af3e0e4f69f50ca3aeb675c5149d8394195f1f5a9f4a
+  metadata.gz: 520132f149801fb6d2bb8e325e38cdb6bf81a01c9d881f88165b02550dfae4a0f95706bcbd558e34b2232015b327c87f779cbf2cdef6d0355640db6e87acaaea
+  data.tar.gz: 7a26fe6f1a8501f9a52103224ea4cdfa2d95441e6253af6ecfcb71f09f8f57c84bae7734079fa5ab1c47756f859ac0eaddbac3c350ce1d8a6b845be011ecedc3

data/README.md

@@ -193,7 +193,6 @@ indicate that the option can be repeated
   --gamma=ARG?  @ --gamma, takes an optional argument
 ```
 
-
 An option argument has a name and a type. The type can be specified as '#'
 (integer), '$' (float), or as a comma-separated list of allowed values. It can
 also be defined by a keyword that expects a file or directory argument:
@@ -202,15 +201,17 @@ also be defined by a keyword that expects a file or directory argument:
   | --------- | ---- |
   | FILE      | A file if present or in an existing directory if not |
   | DIR       | A directory if present or in an existing directory if not |
-  | PATH      | Either a FILE or DIR |
+  | PATH      | FILE or DIR |
   | EFILE     | An existing file |
   | EDIR      | An existing directory |
-  | EPATH     | Either an EFILE or EDIR |
+  | EPATH     | EFILE or EDIR |
   | NFILE     | A new file |
   | NDIR      | A new directory |
-  | NPATH     | A new file or  directory |
+  | NPATH     | NFILE or NDIR |
+
 
-By default the option name is inferred from the type but it can be specified explicitly by separating it from the type with a ':'. Examples:
+By default the option name is inferred from the type but it can be specified
+explicitly by separating it from the type with a ':'. Examples:
 
 ```
   -a=#                  @ -a takes an integer argument
@@ -244,7 +245,7 @@ In single-line format, subcommands are specified by prefixing the supercommand's
 
 ## Example
 
-The rm(1) command could be specified like this:
+The standard rm(1) command could be specified like this:
 
 ```ruby
 

data/TODO

@@ -1,4 +1,14 @@
 
+o Remove IFILE and OFILE. Alternatively document them
+o Document special-case file argument '-'
+o Accept both strings and symbols for commands (maybe... ruins the global namespace in #[])
+o ShellOpts#command -> Full path. Eg. ':command.subcommand!'
+  ShellOpts#commands -> Array of commands. Eg. [:command!, :subcommand!]
+o Exclude -h, -v, and -q from short description and only include them in the
+  detailed option description
+o Output handling: mesg, verb, ... should record eols. error and failure should
+  use that to end the current line with a newline if necessary
+o Strings from ShellOpts are frozen. Is that what we want?
 o Assigner methods for options
 o Make opts[] point at the main object
     opts[].subcommand is the direct subcommand of main

data/lib/shellopts/argument_type.rb

@@ -26,7 +26,7 @@ module ShellOpts
       def to_s() name end
 
     protected
-      # it is important that #set_message return false
+      # Note that it is important that #set_message return false
       def set_message(msg)
         @message = msg
         false
@@ -60,6 +60,18 @@ module ShellOpts
     class FileArgument < ArgumentType
       attr_reader :kind
 
+      def subject # Used in error messages
+        @subject ||= 
+            case kind
+              when :file, :efile; "regular file"
+              when :nfile, :ifile, :ofile; "file"
+              when :dir, :edir, :ndir; "directory"
+              when :path, :epath, :npath; "path"
+            else
+              raise ArgumentError
+            end
+      end
+
       def initialize(kind)
         constrain kind, :file, :dir, :path, :efile, :edir, :epath, :nfile, :ndir, :npath, :ifile, :ofile
         @kind = kind 
@@ -70,19 +82,18 @@ module ShellOpts
         if literal == '-' && [:ifile, :ofile].include?(kind)
           true
 
-        # Special-case standard I/O files
+        # Special-case standard I/O files. These files have read-write (rw)
+        # filesystem permissions so they need to be handled individually
         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}"
+              %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}"
+              %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}"
+              set_message "#{literal} is not a directory"
           else
             raise ArgumentError, "Unhandled kind: #{kind.inspect}"
           end
@@ -128,50 +139,44 @@ module ShellOpts
 
     protected
       def match_path(name, literal, kind, method, mode)
-        subject = 
-            case kind
-              when :file, :efile, :nfile, :ifile, :ofile; "file"
-              when :dir, :edir, :ndir; "directory"
-              when :path, :epath, :npath; "path"
-            else
-              raise ArgumentError
-            end
-
-        # file exists and is the rigth type?
+        # file exists and the method returned true
         if File.send(method, literal)
           if mode == :new
-            set_message "#{subject.capitalize} already exists in #{name}: #{literal}"
+            set_message "Won't overwrite #{literal}"
           elsif kind == :path || kind == :epath
             if File.file?(literal) || File.directory?(literal)
               true
             else
-              set_message "Expected file or directory as #{name} argument: #{literal}"
+              set_message "#{literal} is not a file or a directory"
             end
           elsif (kind == :ifile || kind == :ofile) && File.directory?(literal)
-            set_message "File expected, got directory: #{literal}"
+            set_message "#{literal} is not a device file"
           else
             true
           end
 
-        # file exists but not the right type?
+        # file exists but the method returned false
         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}"
+            set_message "Won't overwrite #{literal}"
           else
-            set_message "Expected #{subject} as #{name} argument: #{literal}"
+            set_message "#{literal} is not a #{subject}"
           end
 
         # file does not exist
         else 
           if [:default, :new].include? mode
-            if File.exist?(File.dirname(literal)) || kind == :ofile
-              true
+            dir = File.dirname(literal)
+            if !File.directory?(dir)
+              set_message "Illegal path - #{literal}"
+            elsif !File.writable?(dir)
+              set_message "Can't create #{subject} #{literal}"
             else
-              set_message "Illegal path in #{name}: #{literal}"
+              true
             end
           else
             set_message "Can't find #{literal}"
@@ -183,7 +188,7 @@ module ShellOpts
     class EnumArgument < ArgumentType
       attr_reader :values
       def initialize(values) @values = values.dup end
-      def match?(name, literal) value?(literal) or set_message "Illegal value in #{name}: '#{literal}'" end
+      def match?(name, literal) value?(literal) or set_message "Illegal value - #{literal}" end
       def value?(value) @values.include?(value) end
     end
   end

data/lib/shellopts/version.rb

@@ -1,3 +1,3 @@
 module ShellOpts
-  VERSION = "2.4.0"
+  VERSION = "2.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shellopts
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.2
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-31 00:00:00.000000000 Z
+date: 2024-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forward_to