shellopts 2.0.22 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3f9f19d62ccf36d5de39421163eb70e7aa8ae621cee13381d48ce68e7ab593d
-  data.tar.gz: 13351ee8dceceea7c5da573de7c5bd257aa2efd1c4690be760f6ebe1445ca8c9
+  metadata.gz: f1d0ed936b5b28c84361778049101596d995b5b38f9f23be0dc5643f86dc3592
+  data.tar.gz: d856b85fc55bf2f58b7d5245318e122f3c3508301775d281d579f0acdc0441be
 SHA512:
-  metadata.gz: 4afd636e92e1ff74b45c77399d4dbaba6afaccd441ee528800a727ed5e4db802d481d8dcaaddcd46bdbcd7c28f3b121b35e42b63e44f02d006c557eafda29692
-  data.tar.gz: 7c12cd6d9f0dede5c7931cf82b8e1ff32d4de738c2d3dd42fb5c2f65740ed0804078eb65ca0b951ce28a1095fd9b43289df01501275a5f9c178a965e569aa054
+  metadata.gz: 3ebba6fac6a845cc7a71d468db989a34379ead52aeb5ce634df83ea8eafad4a9cfc3bea553fa5d477a2cff50a9e3056865e50490b721a7e3df38094fbdfae102
+  data.tar.gz: 52403c31f4f35b19b52cb7e41f5cdfb15733b28eeb4e374dbb2f9b0f6f1ebff8085d047342cb3860173e5bfc1fe039c022b40f17e4e2a06c8b88213c393d6617

data/.ruby-version

@@ -1 +1 @@
-ruby-2.7.1
+ruby-3.1.2

data/TODO

@@ -1,4 +1,5 @@
 
+o Assigner methods for options
 o Make opts[] point at the main object
     opts[].subcommand is the direct subcommand of main
 o Make opts be the aggrated set of options in a subcommand

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/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/version.rb

@@ -1,3 +1,3 @@
 module ShellOpts
-  VERSION = "2.0.22"
+  VERSION = "2.1.0"
 end

data/lib/shellopts.rb

@@ -27,6 +27,17 @@ require 'shellopts/renderer.rb'
 require 'shellopts/formatter.rb'
 require 'shellopts/dump.rb'
 
+# TODO: Describe exception handling
+#
+# Notes
+#   * Two kinds of exceptions: Expected & unexpected. Expected exceptions are
+#     RuntimeError or IOError. Unexpected exceptions are the rest. Both results
+#     in shellopts.failure messages if shellopts error handling is enabled 
+#   * Describe the difference between StandardError, RuntimeError, and IOError
+#   * Add an #internal error handling for the production environment that
+#     prints an intelligble error message and prettyfies stack dump. This
+#     should catch non-RuntimeError/UIError exceptions
+#   * Find a reliable way of testing environment
 
 module ShellOpts
   # Base error class
@@ -140,7 +151,7 @@ module ShellOpts
         float: true,
 
         # Let exceptions through
-        exceptions: false
+        exception: false
       )
         
       @name = name || File.basename($PROGRAM_NAME)

data/shellopts.gemspec

@@ -25,11 +25,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "forward_to"
   spec.add_dependency "constrain", "~> 0.5.1"
-  spec.add_dependency "ruby-terminfo"
+  spec.add_dependency "ruby-terminfo-r3"
   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.22
+  version: 2.1.0
 platform: ruby
 authors:
 - Claus Rasmussen
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-23 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forward_to
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.1
 - !ruby/object:Gem::Dependency
-  name: ruby-terminfo
+  name: ruby-terminfo-r3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -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
@@ -172,7 +158,7 @@ files:
 homepage: http://github.com/clrgit/shellopts
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -187,8 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.18
+signing_key:
 specification_version: 4
 summary: Parse command line options and arguments
 test_files: []