shellopts 2.0.23 → 2.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.ruby-version +1 -1
- data/TODO +1 -0
- data/lib/shellopts/args.rb +3 -3
- data/lib/shellopts/argument_type.rb +76 -24
- data/lib/shellopts/parser.rb +2 -2
- data/lib/shellopts/version.rb +1 -1
- data/lib/shellopts.rb +11 -0
- data/shellopts.gemspec +3 -4
- metadata +13 -27
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 130dd1af11ce3370f270266c9a6b48bda041cdaa195526394b1740e21a5501b8
|
4
|
+
data.tar.gz: 51a3b79454a7fcbca825a3a227da2c9349263b9bb321611f69f4047d24dd0d78
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7444f82972751e540863b31451b6bc2990bb3bc28e6904e2a42fe8dbdd80bf79246a3da29ae3300ff9168fa0f9f85202cd9efdac8d6c1fdc3780e6587c0e4a51
|
7
|
+
data.tar.gz: 7b37d02c7f1b006b7d2120f563f6ce7e6e4f56cad2c68e53abd6eb4ec24c7c2b8949448eb79c49e18ae7096355495e49a79c79e36d6133253775f1838fcd20bc
|
data/.ruby-version
CHANGED
@@ -1 +1 @@
|
|
1
|
-
ruby-
|
1
|
+
ruby-3.1.2
|
data/TODO
CHANGED
data/lib/shellopts/args.rb
CHANGED
@@ -46,8 +46,8 @@ module ShellOpts
|
|
46
46
|
end
|
47
47
|
end
|
48
48
|
|
49
|
-
# As #extract except
|
50
|
-
#
|
49
|
+
# As #extract except the array is expected to be emptied by the operation.
|
50
|
+
# Raise a #inoa exception if count is negative
|
51
51
|
#
|
52
52
|
# #expect raise a ShellOpts::Error exception if the array is not emptied
|
53
53
|
# by the operation
|
@@ -57,7 +57,7 @@ module ShellOpts
|
|
57
57
|
when Range
|
58
58
|
count_or_range === self.size or inoa(message)
|
59
59
|
when Integer
|
60
|
-
count_or_range >= 0 or
|
60
|
+
count_or_range >= 0 or inoa(message)
|
61
61
|
count_or_range.abs == self.size or inoa(message)
|
62
62
|
end
|
63
63
|
extract(count_or_range) # Can't fail
|
@@ -18,7 +18,8 @@ module ShellOpts
|
|
18
18
|
# if type is an IntegerArgument
|
19
19
|
def value?(value) true end
|
20
20
|
|
21
|
-
# Convert value to Ruby type
|
21
|
+
# Convert value to Ruby type. This method can also be used to translate
|
22
|
+
# special keywords
|
22
23
|
def convert(value) value end
|
23
24
|
|
24
25
|
# String representation. Equal to #name
|
@@ -60,69 +61,120 @@ module ShellOpts
|
|
60
61
|
attr_reader :kind
|
61
62
|
|
62
63
|
def initialize(kind)
|
63
|
-
constrain kind, :file, :dir, :path, :efile, :edir, :epath, :nfile, :ndir, :npath
|
64
|
+
constrain kind, :file, :dir, :path, :efile, :edir, :epath, :nfile, :ndir, :npath, :ifile, :ofile
|
64
65
|
@kind = kind
|
65
66
|
end
|
66
67
|
|
67
68
|
def match?(name, literal)
|
68
|
-
case
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
69
|
+
# Special-case '-' keyword
|
70
|
+
if literal == '-' && [:ifile, :ofile].include?(kind)
|
71
|
+
true
|
72
|
+
|
73
|
+
# Special-case standard I/O files
|
74
|
+
elsif %w(/dev/stdin /dev/stdout /dev/stderr /dev/null).include?(literal)
|
75
|
+
case kind
|
76
|
+
when :file, :path, :efile, :epath, :nfile, :npath
|
77
|
+
true
|
78
|
+
when :ifile
|
79
|
+
%w(/dev/stdin /dev/null).include? literal or
|
80
|
+
set_message "Can't read #{literal}"
|
81
|
+
when :ofile
|
82
|
+
%w(/dev/stdout /dev/stderr /dev/null).include?(literal) or
|
83
|
+
set_message "Can't write to #{literal}"
|
84
|
+
when :dir, :edir, :ndir
|
85
|
+
set_message "Expected file, got directory #{literal}"
|
86
|
+
else
|
87
|
+
raise ArgumentError, "Unhandled kind: #{kind.inspect}"
|
88
|
+
end
|
89
|
+
|
90
|
+
# All other files or directories
|
80
91
|
else
|
81
|
-
|
92
|
+
case kind # TODO: node, enode, npath - special files: character, block, socket, etc.
|
93
|
+
when :file; match_path(name, literal, kind, :file?, :default)
|
94
|
+
when :dir; match_path(name, literal, kind, :directory?, :default)
|
95
|
+
when :path; match_path(name, literal, kind, :exist?, :default)
|
96
|
+
|
97
|
+
when :efile; match_path(name, literal, kind, :file?, :exist)
|
98
|
+
when :edir; match_path(name, literal, kind, :directory?, :exist)
|
99
|
+
when :epath; match_path(name, literal, kind, :exist?, :exist)
|
100
|
+
|
101
|
+
when :nfile; match_path(name, literal, kind, :file?, :new)
|
102
|
+
when :ndir; match_path(name, literal, kind, :directory?, :new)
|
103
|
+
when :npath; match_path(name, literal, kind, :exist?, :new)
|
104
|
+
|
105
|
+
when :ifile; match_path(name, literal, kind, :readable?, :default)
|
106
|
+
when :ofile; match_path(name, literal, kind, :writable?, :default)
|
107
|
+
else
|
108
|
+
raise InternalError, "Illegal kind: #{kind.inspect}"
|
109
|
+
end
|
82
110
|
end
|
83
111
|
end
|
84
112
|
|
85
113
|
# Note: No checks done, not sure if it is a feature or a bug
|
86
114
|
def value?(value) value.is_a?(String) end
|
87
115
|
|
116
|
+
def convert(value)
|
117
|
+
if value == "-"
|
118
|
+
case kind
|
119
|
+
when :ifile; "/dev/stdin"
|
120
|
+
when :ofile; "/dev/stdout"
|
121
|
+
else
|
122
|
+
value
|
123
|
+
end
|
124
|
+
else
|
125
|
+
value
|
126
|
+
end
|
127
|
+
end
|
128
|
+
|
88
129
|
protected
|
89
130
|
def match_path(name, literal, kind, method, mode)
|
90
131
|
subject =
|
91
132
|
case kind
|
92
|
-
when :file, :efile, :nfile; "
|
133
|
+
when :file, :efile, :nfile, :ifile, :ofile; "file"
|
93
134
|
when :dir, :edir, :ndir; "directory"
|
94
135
|
when :path, :epath, :npath; "path"
|
95
136
|
else
|
96
137
|
raise ArgumentError
|
97
138
|
end
|
98
139
|
|
99
|
-
|
140
|
+
# file exists and is the rigth type?
|
141
|
+
if File.send(method, literal)
|
100
142
|
if mode == :new
|
101
143
|
set_message "#{subject.capitalize} already exists in #{name}: #{literal}"
|
102
144
|
elsif kind == :path || kind == :epath
|
103
145
|
if File.file?(literal) || File.directory?(literal)
|
104
146
|
true
|
105
147
|
else
|
106
|
-
set_message "Expected
|
148
|
+
set_message "Expected file or directory as #{name} argument: #{literal}"
|
107
149
|
end
|
150
|
+
elsif (kind == :ifile || kind == :ofile) && File.directory?(literal)
|
151
|
+
set_message "File expected, got directory: #{literal}"
|
108
152
|
else
|
109
153
|
true
|
110
154
|
end
|
111
|
-
|
112
|
-
|
113
|
-
|
155
|
+
|
156
|
+
# file exists but not the right type?
|
157
|
+
elsif File.exist?(literal)
|
158
|
+
if kind == :ifile
|
159
|
+
set_message "Can't read #{literal}"
|
160
|
+
elsif kind == :ofile
|
161
|
+
set_message "Can't write to #{literal}"
|
162
|
+
elsif mode == :new
|
163
|
+
set_message "#{subject.capitalize} already exists - #{literal}"
|
114
164
|
else
|
115
165
|
set_message "Expected #{subject} as #{name} argument: #{literal}"
|
116
166
|
end
|
117
|
-
|
167
|
+
|
168
|
+
# file does not exist
|
169
|
+
else
|
118
170
|
if [:default, :new].include? mode
|
119
|
-
if File.exist?(File.dirname(literal))
|
171
|
+
if File.exist?(File.dirname(literal)) || kind == :ofile
|
120
172
|
true
|
121
173
|
else
|
122
174
|
set_message "Illegal path in #{name}: #{literal}"
|
123
175
|
end
|
124
176
|
else
|
125
|
-
set_message "
|
177
|
+
set_message "Can't find #{literal}"
|
126
178
|
end
|
127
179
|
end
|
128
180
|
end
|
data/lib/shellopts/parser.rb
CHANGED
@@ -83,8 +83,8 @@ module ShellOpts
|
|
83
83
|
when "$"
|
84
84
|
@argument_name ||= "NUM"
|
85
85
|
@argument_type = FloatArgument.new
|
86
|
-
when "FILE", "DIR", "PATH", "EFILE", "EDIR", "EPATH", "NFILE", "NDIR", "NPATH"
|
87
|
-
@argument_name ||= arg.sub(/^(?:E|N)/, "")
|
86
|
+
when "FILE", "DIR", "PATH", "EFILE", "EDIR", "EPATH", "NFILE", "NDIR", "NPATH", "IFILE", "OFILE"
|
87
|
+
@argument_name ||= arg.sub(/^(?:E|N|I|O)/, "")
|
88
88
|
@argument_type = FileArgument.new(arg.downcase.to_sym)
|
89
89
|
when /,/
|
90
90
|
@argument_name ||= arg
|
data/lib/shellopts/version.rb
CHANGED
data/lib/shellopts.rb
CHANGED
@@ -27,6 +27,17 @@ require 'shellopts/renderer.rb'
|
|
27
27
|
require 'shellopts/formatter.rb'
|
28
28
|
require 'shellopts/dump.rb'
|
29
29
|
|
30
|
+
# TODO: Describe exception handling
|
31
|
+
#
|
32
|
+
# Notes
|
33
|
+
# * Two kinds of exceptions: Expected & unexpected. Expected exceptions are
|
34
|
+
# RuntimeError or IOError. Unexpected exceptions are the rest. Both results
|
35
|
+
# in shellopts.failure messages if shellopts error handling is enabled
|
36
|
+
# * Describe the difference between StandardError, RuntimeError, and IOError
|
37
|
+
# * Add an #internal error handling for the production environment that
|
38
|
+
# prints an intelligble error message and prettyfies stack dump. This
|
39
|
+
# should catch non-RuntimeError/UIError exceptions
|
40
|
+
# * Find a reliable way of testing environment
|
30
41
|
|
31
42
|
module ShellOpts
|
32
43
|
# Base error class
|
data/shellopts.gemspec
CHANGED
@@ -25,11 +25,10 @@ Gem::Specification.new do |spec|
|
|
25
25
|
|
26
26
|
spec.add_dependency "forward_to"
|
27
27
|
spec.add_dependency "constrain", "~> 0.5.1"
|
28
|
-
spec.add_dependency "ruby-terminfo"
|
28
|
+
spec.add_dependency "ruby-terminfo-r3"
|
29
29
|
spec.add_dependency "indented_io"
|
30
30
|
|
31
|
-
spec.add_development_dependency "
|
32
|
-
spec.add_development_dependency "
|
33
|
-
spec.add_development_dependency "rspec", "~> 3.0"
|
31
|
+
spec.add_development_dependency "rake"
|
32
|
+
spec.add_development_dependency "rspec"
|
34
33
|
spec.add_development_dependency "simplecov"
|
35
34
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: shellopts
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 2.
|
4
|
+
version: 2.1.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Claus Rasmussen
|
8
|
-
autorequire:
|
8
|
+
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-07-27 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: forward_to
|
@@ -39,7 +39,7 @@ dependencies:
|
|
39
39
|
- !ruby/object:Gem::Version
|
40
40
|
version: 0.5.1
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
|
-
name: ruby-terminfo
|
42
|
+
name: ruby-terminfo-r3
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
44
44
|
requirements:
|
45
45
|
- - ">="
|
@@ -66,48 +66,34 @@ dependencies:
|
|
66
66
|
- - ">="
|
67
67
|
- !ruby/object:Gem::Version
|
68
68
|
version: '0'
|
69
|
-
- !ruby/object:Gem::Dependency
|
70
|
-
name: bundler
|
71
|
-
requirement: !ruby/object:Gem::Requirement
|
72
|
-
requirements:
|
73
|
-
- - "~>"
|
74
|
-
- !ruby/object:Gem::Version
|
75
|
-
version: 2.2.10
|
76
|
-
type: :development
|
77
|
-
prerelease: false
|
78
|
-
version_requirements: !ruby/object:Gem::Requirement
|
79
|
-
requirements:
|
80
|
-
- - "~>"
|
81
|
-
- !ruby/object:Gem::Version
|
82
|
-
version: 2.2.10
|
83
69
|
- !ruby/object:Gem::Dependency
|
84
70
|
name: rake
|
85
71
|
requirement: !ruby/object:Gem::Requirement
|
86
72
|
requirements:
|
87
73
|
- - ">="
|
88
74
|
- !ruby/object:Gem::Version
|
89
|
-
version:
|
75
|
+
version: '0'
|
90
76
|
type: :development
|
91
77
|
prerelease: false
|
92
78
|
version_requirements: !ruby/object:Gem::Requirement
|
93
79
|
requirements:
|
94
80
|
- - ">="
|
95
81
|
- !ruby/object:Gem::Version
|
96
|
-
version:
|
82
|
+
version: '0'
|
97
83
|
- !ruby/object:Gem::Dependency
|
98
84
|
name: rspec
|
99
85
|
requirement: !ruby/object:Gem::Requirement
|
100
86
|
requirements:
|
101
|
-
- - "
|
87
|
+
- - ">="
|
102
88
|
- !ruby/object:Gem::Version
|
103
|
-
version: '
|
89
|
+
version: '0'
|
104
90
|
type: :development
|
105
91
|
prerelease: false
|
106
92
|
version_requirements: !ruby/object:Gem::Requirement
|
107
93
|
requirements:
|
108
|
-
- - "
|
94
|
+
- - ">="
|
109
95
|
- !ruby/object:Gem::Version
|
110
|
-
version: '
|
96
|
+
version: '0'
|
111
97
|
- !ruby/object:Gem::Dependency
|
112
98
|
name: simplecov
|
113
99
|
requirement: !ruby/object:Gem::Requirement
|
@@ -172,7 +158,7 @@ files:
|
|
172
158
|
homepage: http://github.com/clrgit/shellopts
|
173
159
|
licenses: []
|
174
160
|
metadata: {}
|
175
|
-
post_install_message:
|
161
|
+
post_install_message:
|
176
162
|
rdoc_options: []
|
177
163
|
require_paths:
|
178
164
|
- lib
|
@@ -187,8 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
187
173
|
- !ruby/object:Gem::Version
|
188
174
|
version: '0'
|
189
175
|
requirements: []
|
190
|
-
rubygems_version: 3.
|
191
|
-
signing_key:
|
176
|
+
rubygems_version: 3.3.18
|
177
|
+
signing_key:
|
192
178
|
specification_version: 4
|
193
179
|
summary: Parse command line options and arguments
|
194
180
|
test_files: []
|