init
This commit is contained in:
Denis Knauf
commit
fb9a9898ee
6
Gemfile
Normal file
6
Gemfile
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
source "https://rubygems.org"
|
||||||
|
|
||||||
|
# Specify your gem's dependencies in dencli.gemspec
|
||||||
|
gemspec
|
||||||
|
|
||||||
|
gem "rake", "~> 12.0"
|
||||||
34
Gemfile.lock
Normal file
34
Gemfile.lock
Normal file
|
|
@ -0,0 +1,34 @@
|
||||||
|
PATH
|
||||||
|
remote: .
|
||||||
|
specs:
|
||||||
|
dencli (0.1.0)
|
||||||
|
|
||||||
|
GEM
|
||||||
|
remote: https://rubygems.org/
|
||||||
|
specs:
|
||||||
|
diff-lcs (1.4.4)
|
||||||
|
rake (12.3.3)
|
||||||
|
rspec (3.10.0)
|
||||||
|
rspec-core (~> 3.10.0)
|
||||||
|
rspec-expectations (~> 3.10.0)
|
||||||
|
rspec-mocks (~> 3.10.0)
|
||||||
|
rspec-core (3.10.0)
|
||||||
|
rspec-support (~> 3.10.0)
|
||||||
|
rspec-expectations (3.10.0)
|
||||||
|
diff-lcs (>= 1.2.0, < 2.0)
|
||||||
|
rspec-support (~> 3.10.0)
|
||||||
|
rspec-mocks (3.10.0)
|
||||||
|
diff-lcs (>= 1.2.0, < 2.0)
|
||||||
|
rspec-support (~> 3.10.0)
|
||||||
|
rspec-support (3.10.0)
|
||||||
|
|
||||||
|
PLATFORMS
|
||||||
|
ruby
|
||||||
|
|
||||||
|
DEPENDENCIES
|
||||||
|
dencli!
|
||||||
|
rake (~> 12.0)
|
||||||
|
rspec (~> 3.2)
|
||||||
|
|
||||||
|
BUNDLED WITH
|
||||||
|
2.1.4
|
||||||
165
LICENSE.txt
Normal file
165
LICENSE.txt
Normal file
|
|
@ -0,0 +1,165 @@
|
||||||
|
GNU LESSER GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
|
||||||
|
This version of the GNU Lesser General Public License incorporates
|
||||||
|
the terms and conditions of version 3 of the GNU General Public
|
||||||
|
License, supplemented by the additional permissions listed below.
|
||||||
|
|
||||||
|
0. Additional Definitions.
|
||||||
|
|
||||||
|
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||||
|
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||||
|
General Public License.
|
||||||
|
|
||||||
|
"The Library" refers to a covered work governed by this License,
|
||||||
|
other than an Application or a Combined Work as defined below.
|
||||||
|
|
||||||
|
An "Application" is any work that makes use of an interface provided
|
||||||
|
by the Library, but which is not otherwise based on the Library.
|
||||||
|
Defining a subclass of a class defined by the Library is deemed a mode
|
||||||
|
of using an interface provided by the Library.
|
||||||
|
|
||||||
|
A "Combined Work" is a work produced by combining or linking an
|
||||||
|
Application with the Library. The particular version of the Library
|
||||||
|
with which the Combined Work was made is also called the "Linked
|
||||||
|
Version".
|
||||||
|
|
||||||
|
The "Minimal Corresponding Source" for a Combined Work means the
|
||||||
|
Corresponding Source for the Combined Work, excluding any source code
|
||||||
|
for portions of the Combined Work that, considered in isolation, are
|
||||||
|
based on the Application, and not on the Linked Version.
|
||||||
|
|
||||||
|
The "Corresponding Application Code" for a Combined Work means the
|
||||||
|
object code and/or source code for the Application, including any data
|
||||||
|
and utility programs needed for reproducing the Combined Work from the
|
||||||
|
Application, but excluding the System Libraries of the Combined Work.
|
||||||
|
|
||||||
|
1. Exception to Section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
You may convey a covered work under sections 3 and 4 of this License
|
||||||
|
without being bound by section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
2. Conveying Modified Versions.
|
||||||
|
|
||||||
|
If you modify a copy of the Library, and, in your modifications, a
|
||||||
|
facility refers to a function or data to be supplied by an Application
|
||||||
|
that uses the facility (other than as an argument passed when the
|
||||||
|
facility is invoked), then you may convey a copy of the modified
|
||||||
|
version:
|
||||||
|
|
||||||
|
a) under this License, provided that you make a good faith effort to
|
||||||
|
ensure that, in the event an Application does not supply the
|
||||||
|
function or data, the facility still operates, and performs
|
||||||
|
whatever part of its purpose remains meaningful, or
|
||||||
|
|
||||||
|
b) under the GNU GPL, with none of the additional permissions of
|
||||||
|
this License applicable to that copy.
|
||||||
|
|
||||||
|
3. Object Code Incorporating Material from Library Header Files.
|
||||||
|
|
||||||
|
The object code form of an Application may incorporate material from
|
||||||
|
a header file that is part of the Library. You may convey such object
|
||||||
|
code under terms of your choice, provided that, if the incorporated
|
||||||
|
material is not limited to numerical parameters, data structure
|
||||||
|
layouts and accessors, or small macros, inline functions and templates
|
||||||
|
(ten or fewer lines in length), you do both of the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the object code that the
|
||||||
|
Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
4. Combined Works.
|
||||||
|
|
||||||
|
You may convey a Combined Work under terms of your choice that,
|
||||||
|
taken together, effectively do not restrict modification of the
|
||||||
|
portions of the Library contained in the Combined Work and reverse
|
||||||
|
engineering for debugging such modifications, if you also do each of
|
||||||
|
the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the Combined Work that
|
||||||
|
the Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
c) For a Combined Work that displays copyright notices during
|
||||||
|
execution, include the copyright notice for the Library among
|
||||||
|
these notices, as well as a reference directing the user to the
|
||||||
|
copies of the GNU GPL and this license document.
|
||||||
|
|
||||||
|
d) Do one of the following:
|
||||||
|
|
||||||
|
0) Convey the Minimal Corresponding Source under the terms of this
|
||||||
|
License, and the Corresponding Application Code in a form
|
||||||
|
suitable for, and under terms that permit, the user to
|
||||||
|
recombine or relink the Application with a modified version of
|
||||||
|
the Linked Version to produce a modified Combined Work, in the
|
||||||
|
manner specified by section 6 of the GNU GPL for conveying
|
||||||
|
Corresponding Source.
|
||||||
|
|
||||||
|
1) Use a suitable shared library mechanism for linking with the
|
||||||
|
Library. A suitable mechanism is one that (a) uses at run time
|
||||||
|
a copy of the Library already present on the user's computer
|
||||||
|
system, and (b) will operate properly with a modified version
|
||||||
|
of the Library that is interface-compatible with the Linked
|
||||||
|
Version.
|
||||||
|
|
||||||
|
e) Provide Installation Information, but only if you would otherwise
|
||||||
|
be required to provide such information under section 6 of the
|
||||||
|
GNU GPL, and only to the extent that such information is
|
||||||
|
necessary to install and execute a modified version of the
|
||||||
|
Combined Work produced by recombining or relinking the
|
||||||
|
Application with a modified version of the Linked Version. (If
|
||||||
|
you use option 4d0, the Installation Information must accompany
|
||||||
|
the Minimal Corresponding Source and Corresponding Application
|
||||||
|
Code. If you use option 4d1, you must provide the Installation
|
||||||
|
Information in the manner specified by section 6 of the GNU GPL
|
||||||
|
for conveying Corresponding Source.)
|
||||||
|
|
||||||
|
5. Combined Libraries.
|
||||||
|
|
||||||
|
You may place library facilities that are a work based on the
|
||||||
|
Library side by side in a single library together with other library
|
||||||
|
facilities that are not Applications and are not covered by this
|
||||||
|
License, and convey such a combined library under terms of your
|
||||||
|
choice, if you do both of the following:
|
||||||
|
|
||||||
|
a) Accompany the combined library with a copy of the same work based
|
||||||
|
on the Library, uncombined with any other library facilities,
|
||||||
|
conveyed under the terms of this License.
|
||||||
|
|
||||||
|
b) Give prominent notice with the combined library that part of it
|
||||||
|
is a work based on the Library, and explaining where to find the
|
||||||
|
accompanying uncombined form of the same work.
|
||||||
|
|
||||||
|
6. Revised Versions of the GNU Lesser General Public License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions
|
||||||
|
of the GNU Lesser General Public License from time to time. Such new
|
||||||
|
versions will be similar in spirit to the present version, but may
|
||||||
|
differ in detail to address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Library as you received it specifies that a certain numbered version
|
||||||
|
of the GNU Lesser General Public License "or any later version"
|
||||||
|
applies to it, you have the option of following the terms and
|
||||||
|
conditions either of that published version or of any later version
|
||||||
|
published by the Free Software Foundation. If the Library as you
|
||||||
|
received it does not specify a version number of the GNU Lesser
|
||||||
|
General Public License, you may choose any version of the GNU Lesser
|
||||||
|
General Public License ever published by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Library as you received it specifies that a proxy can decide
|
||||||
|
whether future versions of the GNU Lesser General Public License shall
|
||||||
|
apply, that proxy's public statement of acceptance of any version is
|
||||||
|
permanent authorization for you to choose that version for the
|
||||||
|
Library.
|
||||||
63
README.adoc
Normal file
63
README.adoc
Normal file
|
|
@ -0,0 +1,63 @@
|
||||||
|
# DenCli
|
||||||
|
|
||||||
|
Provides a Command-Line-Interface-API for providing commands.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Add this line to your application's Gemfile:
|
||||||
|
|
||||||
|
[source,ruby]
|
||||||
|
----
|
||||||
|
gem 'dencli'
|
||||||
|
----
|
||||||
|
|
||||||
|
And then execute:
|
||||||
|
|
||||||
|
[source,sh]
|
||||||
|
----
|
||||||
|
$ bundle install
|
||||||
|
----
|
||||||
|
|
||||||
|
Or install it yourself as:
|
||||||
|
|
||||||
|
[source,sh]
|
||||||
|
----
|
||||||
|
$ gem install dencli
|
||||||
|
----
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
[source,ruby]
|
||||||
|
----
|
||||||
|
#!/usr/bin/env ruby
|
||||||
|
|
||||||
|
require 'dencli'
|
||||||
|
|
||||||
|
cli = CLI.new "This is an example for generate a CLI-API"
|
||||||
|
cli.cmd( :example, "I have an example command") { STDERR.puts "This is an example" }
|
||||||
|
cli.cmd( :help) {|*args| STDERR.puts cli.help(*args) }
|
||||||
|
|
||||||
|
cli.sub( :more, "Sub-Commands are also possible with a new cli") do |sub|
|
||||||
|
sub.cmd( :help) {|*args| STDERR.puts cli.help( 'more', *args) }
|
||||||
|
sub.cmd( :example, "Here is an example, too") { STDERR.puts "This is an other example" }
|
||||||
|
sub.cmd( :foo, "BAR") { STDERR.puts "FOO bar"}
|
||||||
|
|
||||||
|
sub.sub( :deeper, "You want to have Sub-Sub-Commands?") do |sub2|
|
||||||
|
sub2.cmd( :help) {|*args| STDERR.puts cli.help( 'more', 'deeper', *args) }
|
||||||
|
sub2.cmd( :last, "The last example") { STDERR.puts "The last example" }
|
||||||
|
|
||||||
|
sub2.sub( :'sub-commands', "Endless Sub-Sub- ...") do |sub3|
|
||||||
|
sub2.cmd( :help) {|*args| STDERR.puts cli.help( 'more', 'deeper', 'sub-commands', *args) }
|
||||||
|
sub3.cmd( :hehe, "The real last example", min: 2) { STDERR.puts "Trust me!" }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
cli.call *ARGV
|
||||||
|
----
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Bug reports and pull requests are welcome on git at https://git.denkn.at/deac/dencli.
|
||||||
31
dencli.gemspec
Normal file
31
dencli.gemspec
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
require_relative 'lib/dencli/version'
|
||||||
|
|
||||||
|
Gem::Specification.new do |spec|
|
||||||
|
spec.name = "dencli"
|
||||||
|
spec.version = DenCli::VERSION
|
||||||
|
spec.authors = ["Denis Knauf"]
|
||||||
|
spec.email = ["git+dencli@denkn.at"]
|
||||||
|
spec.licenses = ["LGPL-3.0"]
|
||||||
|
|
||||||
|
spec.summary = %q{Commands and Subcommands}
|
||||||
|
spec.description = %q{Embedded commands for Command-Line-Interfaces}
|
||||||
|
spec.homepage = "https://git.denkn.at/deac/dencli"
|
||||||
|
spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
|
||||||
|
|
||||||
|
#spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
|
||||||
|
|
||||||
|
spec.metadata["homepage_uri"] = spec.homepage
|
||||||
|
spec.metadata["source_code_uri"] = spec.homepage
|
||||||
|
spec.metadata["changelog_uri"] = spec.homepage
|
||||||
|
|
||||||
|
spec.add_development_dependency "rspec", "~> 3.2"
|
||||||
|
|
||||||
|
# Specify which files should be added to the gem when it is released.
|
||||||
|
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
||||||
|
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
||||||
|
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
||||||
|
end
|
||||||
|
spec.bindir = "bin"
|
||||||
|
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
||||||
|
spec.require_paths = ["lib"]
|
||||||
|
end
|
||||||
183
lib/dencli.rb
Executable file
183
lib/dencli.rb
Executable file
|
|
@ -0,0 +1,183 @@
|
||||||
|
class DenCli
|
||||||
|
class UsageError < ::RuntimeError
|
||||||
|
end
|
||||||
|
class UnknownCommand < UsageError
|
||||||
|
end
|
||||||
|
|
||||||
|
class <<self
|
||||||
|
# Helper Function for generate Regular Expressions of string,
|
||||||
|
# which matches all strings which has parts fron beginning of the given string.
|
||||||
|
# `n("abc")` would produce: `/(?:a|ab|abc)/`
|
||||||
|
# You can define a minimum length to match:
|
||||||
|
# `n("abcdef",4)` => `/abcd(?:|e|ef)/`
|
||||||
|
def n s, min = nil
|
||||||
|
min ||= 1
|
||||||
|
/#{s.length <= min ?
|
||||||
|
Regexp.quote(s) :
|
||||||
|
"#{Regexp.quote s[0...min]}#{
|
||||||
|
s[min...-1].
|
||||||
|
reverse.
|
||||||
|
each_char.
|
||||||
|
reduce( "#{Regexp.quote s[-1]}?") {|f,n|
|
||||||
|
"(?:#{Regexp.quote n}#{f})?"
|
||||||
|
}
|
||||||
|
}"
|
||||||
|
}/
|
||||||
|
end
|
||||||
|
|
||||||
|
# Wraps `n(s,min=)` in a full matching RegExp with ending `\0`:
|
||||||
|
# `r("abc")` would produce: `/\A(?:a|ab|abc)\0\z/`
|
||||||
|
# You can define a minimum length to match:
|
||||||
|
# `r("abcdef",4)` => `/\aabcd(?:|e|ef)\0\z/`
|
||||||
|
def r s, min = nil
|
||||||
|
/\A#{n s, min}\0\z/
|
||||||
|
end
|
||||||
|
|
||||||
|
# Generates a list of aliases for given `cmd`:
|
||||||
|
# `g(:abc)` => `["a", "ab", "abc"]`
|
||||||
|
# `g(:abcdef, 4)` => `["abcd", "abcde", "abcdef"]`
|
||||||
|
def gen_aliases cmd, min = nil
|
||||||
|
r = ((min||1)-1).upto cmd.length-1
|
||||||
|
if block_given?
|
||||||
|
r.each {|i| yield cmd[0..i] }
|
||||||
|
else
|
||||||
|
r.map {|i| cmd[0..i] }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
alias g gen_aliases
|
||||||
|
end
|
||||||
|
|
||||||
|
class CMD
|
||||||
|
attr_reader :parent, :name, :desc, :exe
|
||||||
|
def initialize parent, name, desc, exe
|
||||||
|
raise "Proc expected, instead of: #{exe.inspect}" unless Proc === exe
|
||||||
|
@parent, @name, @desc, @exe = parent, name, desc, exe
|
||||||
|
end
|
||||||
|
|
||||||
|
def _full_cmd post
|
||||||
|
parent._full_cmd [@name]+post
|
||||||
|
end
|
||||||
|
|
||||||
|
def full_cmd
|
||||||
|
_full_cmd []
|
||||||
|
end
|
||||||
|
|
||||||
|
def call *a
|
||||||
|
@exe.call *a
|
||||||
|
end
|
||||||
|
|
||||||
|
def help
|
||||||
|
"#{parent.full_cmd.join ' '} #{name}\n#{ desc}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def inspect
|
||||||
|
"#<%s:0x%x %s @name=%p @desc=%p @parent=<%s:0x%x %s> @exe=<arity=%d>>" % [
|
||||||
|
self.class.name, self.object_id, self.full_cmd,
|
||||||
|
@name, @desc, @parent.class.name, @parent.class.object_id, @parent.full_cmd,
|
||||||
|
@exe.arity
|
||||||
|
]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
class Sub
|
||||||
|
attr_reader :parent, :name, :desc, :subs
|
||||||
|
def initialize parent, name, desc
|
||||||
|
@parent, @name, @desc, @subs, @aliases = parent, name, desc, {}, {}
|
||||||
|
end
|
||||||
|
|
||||||
|
def _full_cmd post
|
||||||
|
parent._full_cmd [@name]+post
|
||||||
|
end
|
||||||
|
|
||||||
|
def full_cmd
|
||||||
|
_full_cmd []
|
||||||
|
end
|
||||||
|
|
||||||
|
def [] k
|
||||||
|
@aliases[k]
|
||||||
|
end
|
||||||
|
|
||||||
|
def help n = nil, *a
|
||||||
|
if n.nil?
|
||||||
|
r = "#{full_cmd.join ' '}: #{desc}\n\n"
|
||||||
|
m = @subs.map {|k,_| k.length }.max
|
||||||
|
@subs.each do |k, c|
|
||||||
|
r += " % -#{m}s %s\n" % [k, c.desc] unless k.nil?
|
||||||
|
end
|
||||||
|
r
|
||||||
|
elsif @aliases.has_key? n
|
||||||
|
@aliases[n].help *a
|
||||||
|
else
|
||||||
|
raise UnknownCommand, "unknown command: #{_full_cmd( [n])[1..-1].join ' '}, available for #{full_cmd[1..-1].join' '}: #{@subs.keys.inspect}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def call *a
|
||||||
|
n, *a = *a
|
||||||
|
if @aliases.has_key? n
|
||||||
|
@aliases[n].call *a
|
||||||
|
else
|
||||||
|
raise UnknownCommand, "unknown command: #{_full_cmd( [n])[1..-1].join ' '}, available for #{full_cmd[1..-1].join' '}: #{@subs.keys.inspect}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def _add name, min, obj, aliases
|
||||||
|
name = name.to_s unless name.nil?
|
||||||
|
@subs[name] = obj
|
||||||
|
CL.gen_aliases( name, min) {|a| @aliases[a] = obj }
|
||||||
|
if aliases
|
||||||
|
[*aliases].each {|a| @aliases[a] = obj }
|
||||||
|
end
|
||||||
|
obj
|
||||||
|
end
|
||||||
|
private :_add
|
||||||
|
|
||||||
|
def sub name, desc, min: nil, aliases: nil, &exe
|
||||||
|
r = _add name, min, Sub.new( self, name, desc), aliases
|
||||||
|
block_given? ? yield( r) : r
|
||||||
|
end
|
||||||
|
|
||||||
|
def cmd name, desc, min: nil, aliases: nil, &exe
|
||||||
|
_add name, min, CMD.new( self, name, desc, exe), aliases
|
||||||
|
end
|
||||||
|
|
||||||
|
def inspect
|
||||||
|
"#<%s:0x%x %s @name=%p @desc=%p @subs={%s} @aliases={%s} @parent=<%s:0x%x %s>>" % [
|
||||||
|
self.class.name, self.object_id, self.full_cmd,
|
||||||
|
@name, @desc, @subs.keys.join(', '), @aliases.keys.join(', '), @parent.class.name, @parent.class.object_id, @parent.full_cmd
|
||||||
|
]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def initialize progname, desc
|
||||||
|
@subs = Sub.new self, progname, desc
|
||||||
|
end
|
||||||
|
|
||||||
|
def full_cmd
|
||||||
|
[]
|
||||||
|
end
|
||||||
|
|
||||||
|
def _full_cmd post
|
||||||
|
post
|
||||||
|
end
|
||||||
|
|
||||||
|
def sub *a, &exe
|
||||||
|
@subs.sub *a, &exe
|
||||||
|
end
|
||||||
|
|
||||||
|
def cmd *a, &exe
|
||||||
|
@subs.cmd *a, &exe
|
||||||
|
end
|
||||||
|
|
||||||
|
def call *a
|
||||||
|
@subs.call *a
|
||||||
|
end
|
||||||
|
|
||||||
|
def help *args
|
||||||
|
@subs.help *args
|
||||||
|
end
|
||||||
|
|
||||||
|
def [] k
|
||||||
|
@subs[k]
|
||||||
|
end
|
||||||
|
end
|
||||||
3
lib/dencli/version.rb
Normal file
3
lib/dencli/version.rb
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
class DenCli
|
||||||
|
VERSION = '0.1.0'
|
||||||
|
end
|
||||||
Loading…
Reference in a new issue