Made changes:
- Updated .gitignore to include specs - Re-licensed to MPL-2.0 as I want any modifications to be pushed back to the main codebase so that the ecosystem can benefit from developer adoption - Updated LICENSE & shard.yml with new license - Changed author to personal email as this is not being done for my company
This commit is contained in:
@@ -11,3 +11,5 @@
|
||||
!docs/**
|
||||
!Makefile
|
||||
!LICENSE
|
||||
!spec/
|
||||
!spec/**
|
||||
|
||||
@@ -1,21 +1,373 @@
|
||||
MIT License
|
||||
Mozilla Public License Version 2.0
|
||||
==================================
|
||||
|
||||
Copyright (c) 2026 Tristan Ancelet <tristan.ancelet@acumera.com>
|
||||
1. Definitions
|
||||
--------------
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
1.1. "Contributor"
|
||||
means each individual or legal entity that creates, contributes to
|
||||
the creation of, or owns Covered Software.
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
1.2. "Contributor Version"
|
||||
means the combination of the Contributions of others (if any) used
|
||||
by a Contributor and that particular Contributor's Contribution.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
1.3. "Contribution"
|
||||
means Covered Software of a particular Contributor.
|
||||
|
||||
1.4. "Covered Software"
|
||||
means Source Code Form to which the initial Contributor has attached
|
||||
the notice in Exhibit A, the Executable Form of such Source Code
|
||||
Form, and Modifications of such Source Code Form, in each case
|
||||
including portions thereof.
|
||||
|
||||
1.5. "Incompatible With Secondary Licenses"
|
||||
means
|
||||
|
||||
(a) that the initial Contributor has attached the notice described
|
||||
in Exhibit B to the Covered Software; or
|
||||
|
||||
(b) that the Covered Software was made available under the terms of
|
||||
version 1.1 or earlier of the License, but not also under the
|
||||
terms of a Secondary License.
|
||||
|
||||
1.6. "Executable Form"
|
||||
means any form of the work other than Source Code Form.
|
||||
|
||||
1.7. "Larger Work"
|
||||
means a work that combines Covered Software with other material, in
|
||||
a separate file or files, that is not Covered Software.
|
||||
|
||||
1.8. "License"
|
||||
means this document.
|
||||
|
||||
1.9. "Licensable"
|
||||
means having the right to grant, to the maximum extent possible,
|
||||
whether at the time of the initial grant or subsequently, any and
|
||||
all of the rights conveyed by this License.
|
||||
|
||||
1.10. "Modifications"
|
||||
means any of the following:
|
||||
|
||||
(a) any file in Source Code Form that results from an addition to,
|
||||
deletion from, or modification of the contents of Covered
|
||||
Software; or
|
||||
|
||||
(b) any new file in Source Code Form that contains any Covered
|
||||
Software.
|
||||
|
||||
1.11. "Patent Claims" of a Contributor
|
||||
means any patent claim(s), including without limitation, method,
|
||||
process, and apparatus claims, in any patent Licensable by such
|
||||
Contributor that would be infringed, but for the grant of the
|
||||
License, by the making, using, selling, offering for sale, having
|
||||
made, import, or transfer of either its Contributions or its
|
||||
Contributor Version.
|
||||
|
||||
1.12. "Secondary License"
|
||||
means either the GNU General Public License, Version 2.0, the GNU
|
||||
Lesser General Public License, Version 2.1, the GNU Affero General
|
||||
Public License, Version 3.0, or any later versions of those
|
||||
licenses.
|
||||
|
||||
1.13. "Source Code Form"
|
||||
means the form of the work preferred for making modifications.
|
||||
|
||||
1.14. "You" (or "Your")
|
||||
means an individual or a legal entity exercising rights under this
|
||||
License. For legal entities, "You" includes any entity that
|
||||
controls, is controlled by, or is under common control with You. For
|
||||
purposes of this definition, "control" means (a) the power, direct
|
||||
or indirect, to cause the direction or management of such entity,
|
||||
whether by contract or otherwise, or (b) ownership of more than
|
||||
fifty percent (50%) of the outstanding shares or beneficial
|
||||
ownership of such entity.
|
||||
|
||||
2. License Grants and Conditions
|
||||
--------------------------------
|
||||
|
||||
2.1. Grants
|
||||
|
||||
Each Contributor hereby grants You a world-wide, royalty-free,
|
||||
non-exclusive license:
|
||||
|
||||
(a) under intellectual property rights (other than patent or trademark)
|
||||
Licensable by such Contributor to use, reproduce, make available,
|
||||
modify, display, perform, distribute, and otherwise exploit its
|
||||
Contributions, either on an unmodified basis, with Modifications, or
|
||||
as part of a Larger Work; and
|
||||
|
||||
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
||||
for sale, have made, import, and otherwise transfer either its
|
||||
Contributions or its Contributor Version.
|
||||
|
||||
2.2. Effective Date
|
||||
|
||||
The licenses granted in Section 2.1 with respect to any Contribution
|
||||
become effective for each Contribution on the date the Contributor first
|
||||
distributes such Contribution.
|
||||
|
||||
2.3. Limitations on Grant Scope
|
||||
|
||||
The licenses granted in this Section 2 are the only rights granted under
|
||||
this License. No additional rights or licenses will be implied from the
|
||||
distribution or licensing of Covered Software under this License.
|
||||
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
||||
Contributor:
|
||||
|
||||
(a) for any code that a Contributor has removed from Covered Software;
|
||||
or
|
||||
|
||||
(b) for infringements caused by: (i) Your and any other third party's
|
||||
modifications of Covered Software, or (ii) the combination of its
|
||||
Contributions with other software (except as part of its Contributor
|
||||
Version); or
|
||||
|
||||
(c) under Patent Claims infringed by Covered Software in the absence of
|
||||
its Contributions.
|
||||
|
||||
This License does not grant any rights in the trademarks, service marks,
|
||||
or logos of any Contributor (except as may be necessary to comply with
|
||||
the notice requirements in Section 3.4).
|
||||
|
||||
2.4. Subsequent Licenses
|
||||
|
||||
No Contributor makes additional grants as a result of Your choice to
|
||||
distribute the Covered Software under a subsequent version of this
|
||||
License (see Section 10.2) or under the terms of a Secondary License (if
|
||||
permitted under the terms of Section 3.3).
|
||||
|
||||
2.5. Representation
|
||||
|
||||
Each Contributor represents that the Contributor believes its
|
||||
Contributions are its original creation(s) or it has sufficient rights
|
||||
to grant the rights to its Contributions conveyed by this License.
|
||||
|
||||
2.6. Fair Use
|
||||
|
||||
This License is not intended to limit any rights You have under
|
||||
applicable copyright doctrines of fair use, fair dealing, or other
|
||||
equivalents.
|
||||
|
||||
2.7. Conditions
|
||||
|
||||
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
||||
in Section 2.1.
|
||||
|
||||
3. Responsibilities
|
||||
-------------------
|
||||
|
||||
3.1. Distribution of Source Form
|
||||
|
||||
All distribution of Covered Software in Source Code Form, including any
|
||||
Modifications that You create or to which You contribute, must be under
|
||||
the terms of this License. You must inform recipients that the Source
|
||||
Code Form of the Covered Software is governed by the terms of this
|
||||
License, and how they can obtain a copy of this License. You may not
|
||||
attempt to alter or restrict the recipients' rights in the Source Code
|
||||
Form.
|
||||
|
||||
3.2. Distribution of Executable Form
|
||||
|
||||
If You distribute Covered Software in Executable Form then:
|
||||
|
||||
(a) such Covered Software must also be made available in Source Code
|
||||
Form, as described in Section 3.1, and You must inform recipients of
|
||||
the Executable Form how they can obtain a copy of such Source Code
|
||||
Form by reasonable means in a timely manner, at a charge no more
|
||||
than the cost of distribution to the recipient; and
|
||||
|
||||
(b) You may distribute such Executable Form under the terms of this
|
||||
License, or sublicense it under different terms, provided that the
|
||||
license for the Executable Form does not attempt to limit or alter
|
||||
the recipients' rights in the Source Code Form under this License.
|
||||
|
||||
3.3. Distribution of a Larger Work
|
||||
|
||||
You may create and distribute a Larger Work under terms of Your choice,
|
||||
provided that You also comply with the requirements of this License for
|
||||
the Covered Software. If the Larger Work is a combination of Covered
|
||||
Software with a work governed by one or more Secondary Licenses, and the
|
||||
Covered Software is not Incompatible With Secondary Licenses, this
|
||||
License permits You to additionally distribute such Covered Software
|
||||
under the terms of such Secondary License(s), so that the recipient of
|
||||
the Larger Work may, at their option, further distribute the Covered
|
||||
Software under the terms of either this License or such Secondary
|
||||
License(s).
|
||||
|
||||
3.4. Notices
|
||||
|
||||
You may not remove or alter the substance of any license notices
|
||||
(including copyright notices, patent notices, disclaimers of warranty,
|
||||
or limitations of liability) contained within the Source Code Form of
|
||||
the Covered Software, except that You may alter any license notices to
|
||||
the extent required to remedy known factual inaccuracies.
|
||||
|
||||
3.5. Application of Additional Terms
|
||||
|
||||
You may choose to offer, and to charge a fee for, warranty, support,
|
||||
indemnity or liability obligations to one or more recipients of Covered
|
||||
Software. However, You may do so only on Your own behalf, and not on
|
||||
behalf of any Contributor. You must make it absolutely clear that any
|
||||
such warranty, support, indemnity, or liability obligation is offered by
|
||||
You alone, and You hereby agree to indemnify every Contributor for any
|
||||
liability incurred by such Contributor as a result of warranty, support,
|
||||
indemnity or liability terms You offer. You may include additional
|
||||
disclaimers of warranty and limitations of liability specific to any
|
||||
jurisdiction.
|
||||
|
||||
4. Inability to Comply Due to Statute or Regulation
|
||||
---------------------------------------------------
|
||||
|
||||
If it is impossible for You to comply with any of the terms of this
|
||||
License with respect to some or all of the Covered Software due to
|
||||
statute, judicial order, or regulation then You must: (a) comply with
|
||||
the terms of this License to the maximum extent possible; and (b)
|
||||
describe the limitations and the code they affect. Such description must
|
||||
be placed in a text file included with all distributions of the Covered
|
||||
Software under this License. Except to the extent prohibited by statute
|
||||
or regulation, such description must be sufficiently detailed for a
|
||||
recipient of ordinary skill to be able to understand it.
|
||||
|
||||
5. Termination
|
||||
--------------
|
||||
|
||||
5.1. The rights granted under this License will terminate automatically
|
||||
if You fail to comply with any of its terms. However, if You become
|
||||
compliant, then the rights granted under this License from a particular
|
||||
Contributor are reinstated (a) provisionally, unless and until such
|
||||
Contributor explicitly and finally terminates Your grants, and (b) on an
|
||||
ongoing basis, if such Contributor fails to notify You of the
|
||||
non-compliance by some reasonable means prior to 60 days after You have
|
||||
come back into compliance. Moreover, Your grants from a particular
|
||||
Contributor are reinstated on an ongoing basis if such Contributor
|
||||
notifies You of the non-compliance by some reasonable means, this is the
|
||||
first time You have received notice of non-compliance with this License
|
||||
from such Contributor, and You become compliant prior to 30 days after
|
||||
Your receipt of the notice.
|
||||
|
||||
5.2. If You initiate litigation against any entity by asserting a patent
|
||||
infringement claim (excluding declaratory judgment actions,
|
||||
counter-claims, and cross-claims) alleging that a Contributor Version
|
||||
directly or indirectly infringes any patent, then the rights granted to
|
||||
You by any and all Contributors for the Covered Software under Section
|
||||
2.1 of this License shall terminate.
|
||||
|
||||
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
||||
end user license agreements (excluding distributors and resellers) which
|
||||
have been validly granted by You or Your distributors under this License
|
||||
prior to termination shall survive termination.
|
||||
|
||||
************************************************************************
|
||||
* *
|
||||
* 6. Disclaimer of Warranty *
|
||||
* ------------------------- *
|
||||
* *
|
||||
* Covered Software is provided under this License on an "as is" *
|
||||
* basis, without warranty of any kind, either expressed, implied, or *
|
||||
* statutory, including, without limitation, warranties that the *
|
||||
* Covered Software is free of defects, merchantable, fit for a *
|
||||
* particular purpose or non-infringing. The entire risk as to the *
|
||||
* quality and performance of the Covered Software is with You. *
|
||||
* Should any Covered Software prove defective in any respect, You *
|
||||
* (not any Contributor) assume the cost of any necessary servicing, *
|
||||
* repair, or correction. This disclaimer of warranty constitutes an *
|
||||
* essential part of this License. No use of any Covered Software is *
|
||||
* authorized under this License except under this disclaimer. *
|
||||
* *
|
||||
************************************************************************
|
||||
|
||||
************************************************************************
|
||||
* *
|
||||
* 7. Limitation of Liability *
|
||||
* -------------------------- *
|
||||
* *
|
||||
* Under no circumstances and under no legal theory, whether tort *
|
||||
* (including negligence), contract, or otherwise, shall any *
|
||||
* Contributor, or anyone who distributes Covered Software as *
|
||||
* permitted above, be liable to You for any direct, indirect, *
|
||||
* special, incidental, or consequential damages of any character *
|
||||
* including, without limitation, damages for lost profits, loss of *
|
||||
* goodwill, work stoppage, computer failure or malfunction, or any *
|
||||
* and all other commercial damages or losses, even if such party *
|
||||
* shall have been informed of the possibility of such damages. This *
|
||||
* limitation of liability shall not apply to liability for death or *
|
||||
* personal injury resulting from such party's negligence to the *
|
||||
* extent applicable law prohibits such limitation. Some *
|
||||
* jurisdictions do not allow the exclusion or limitation of *
|
||||
* incidental or consequential damages, so this exclusion and *
|
||||
* limitation may not apply to You. *
|
||||
* *
|
||||
************************************************************************
|
||||
|
||||
8. Litigation
|
||||
-------------
|
||||
|
||||
Any litigation relating to this License may be brought only in the
|
||||
courts of a jurisdiction where the defendant maintains its principal
|
||||
place of business and such litigation shall be governed by laws of that
|
||||
jurisdiction, without reference to its conflict-of-law provisions.
|
||||
Nothing in this Section shall prevent a party's ability to bring
|
||||
cross-claims or counter-claims.
|
||||
|
||||
9. Miscellaneous
|
||||
----------------
|
||||
|
||||
This License represents the complete agreement concerning the subject
|
||||
matter hereof. If any provision of this License is held to be
|
||||
unenforceable, such provision shall be reformed only to the extent
|
||||
necessary to make it enforceable. Any law or regulation which provides
|
||||
that the language of a contract shall be construed against the drafter
|
||||
shall not be used to construe this License against a Contributor.
|
||||
|
||||
10. Versions of the License
|
||||
---------------------------
|
||||
|
||||
10.1. New Versions
|
||||
|
||||
Mozilla Foundation is the license steward. Except as provided in Section
|
||||
10.3, no one other than the license steward has the right to modify or
|
||||
publish new versions of this License. Each version will be given a
|
||||
distinguishing version number.
|
||||
|
||||
10.2. Effect of New Versions
|
||||
|
||||
You may distribute the Covered Software under the terms of the version
|
||||
of the License under which You originally received the Covered Software,
|
||||
or under the terms of any subsequent version published by the license
|
||||
steward.
|
||||
|
||||
10.3. Modified Versions
|
||||
|
||||
If you create software not governed by this License, and you want to
|
||||
create a new license for such software, you may create and use a
|
||||
modified version of this License if you rename the license and remove
|
||||
any references to the name of the license steward (except to note that
|
||||
such modified license differs from this License).
|
||||
|
||||
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
||||
Licenses
|
||||
|
||||
If You choose to distribute Source Code Form that is Incompatible With
|
||||
Secondary Licenses under the terms of this version of the License, the
|
||||
notice described in Exhibit B of this License must be attached.
|
||||
|
||||
Exhibit A - Source Code Form License Notice
|
||||
-------------------------------------------
|
||||
|
||||
This Source Code Form is subject to the terms of the Mozilla Public
|
||||
License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
If it is not possible or desirable to put the notice in a particular
|
||||
file, then You may include the notice in a location (such as a LICENSE
|
||||
file in a relevant directory) where a recipient would be likely to look
|
||||
for such a notice.
|
||||
|
||||
You may add additional accurate notices of copyright ownership.
|
||||
|
||||
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
||||
---------------------------------------------------------
|
||||
|
||||
This Source Code Form is "Incompatible With Secondary Licenses", as
|
||||
defined by the Mozilla Public License, v. 2.0.
|
||||
|
||||
@@ -2,8 +2,8 @@ name: cligen
|
||||
version: 0.1.0
|
||||
|
||||
authors:
|
||||
- Tristan Ancelet <tristan.ancelet@acumera.com>
|
||||
- Tristan Ancelet <tristanancelet@yahoo.com>
|
||||
|
||||
crystal: '>= 1.19.1'
|
||||
|
||||
license: MIT
|
||||
license: MPL-2.0
|
||||
|
||||
@@ -0,0 +1,94 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
require "../spec_helper"
|
||||
|
||||
def make_arg(val, index = 0) : CliGen::Arg
|
||||
CliGen::Arg.new(value: val, index: index)
|
||||
end
|
||||
|
||||
describe CliGen::Arg do
|
||||
describe "#processed" do
|
||||
it "will raise a ArgReprocessedError exception when re-processed" do
|
||||
arg = make_arg("abc")
|
||||
arg.processed
|
||||
expect_raises(CliGen::ArgReprocessedError) do
|
||||
arg.processed
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "#flag?" do
|
||||
it "will return true when value is in long flag format --[a-zA-Z0-9-_]+" do
|
||||
arg = make_arg("--help")
|
||||
arg.flag?.should be_true
|
||||
end
|
||||
|
||||
it "will return true when value is in short flag format -[a-zA-Z0-9]" do
|
||||
arg = make_arg("-h")
|
||||
arg.flag?.should be_true
|
||||
end
|
||||
|
||||
it "will return false when value is literally anything else" do
|
||||
arg = make_arg("abc")
|
||||
arg.flag?.should be_false
|
||||
end
|
||||
end
|
||||
|
||||
describe "#uint?" do
|
||||
it "will return true on a value in an unigned int format ^[[:digit:]]+$" do
|
||||
make_arg("3").uint?.should be_true
|
||||
end
|
||||
|
||||
it "will return false on a value in an signed int format ^[+-][[:digit:]]+$" do
|
||||
make_arg("-3").uint?.should be_false
|
||||
make_arg("+3").uint?.should be_false
|
||||
end
|
||||
|
||||
it "will return false on a value in a mixed format" do
|
||||
make_arg("a2").uint?.should be_false
|
||||
end
|
||||
|
||||
it "will return false on a value in any other format" do
|
||||
make_arg("a").uint?.should be_false
|
||||
end
|
||||
end
|
||||
|
||||
describe "#int?" do
|
||||
it "will return true on a value in int format ^[[:digit:]]+$" do
|
||||
make_arg("3").int?.should be_true
|
||||
end
|
||||
|
||||
it "will return true on a value in an signed int format ^[+-][[:digit:]]+$" do
|
||||
make_arg("-3").int?.should be_true
|
||||
make_arg("+3").int?.should be_true
|
||||
end
|
||||
|
||||
it "will return false on a value in a mixed format" do
|
||||
make_arg("a2").int?.should be_false
|
||||
end
|
||||
|
||||
it "will return false on a value in any other format" do
|
||||
make_arg("a").int?.should be_false
|
||||
end
|
||||
end
|
||||
|
||||
describe "#float?" do
|
||||
it "will return true on a value in a float format ^[[:digit:]]+\.[[:digit:]]+$" do
|
||||
make_arg("1.1").float?.should be_true
|
||||
end
|
||||
|
||||
it "will return true on a value in a int format ^[[:digit:]]$" do
|
||||
make_arg("1").float?.should be_true
|
||||
end
|
||||
|
||||
it "will return false on a value in any other format" do
|
||||
make_arg("a").float?.should be_false
|
||||
end
|
||||
|
||||
it "will return false on a value that isn't fully int's" do
|
||||
make_arg("a1").float?.should be_false
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,438 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
require "../spec_helper"
|
||||
|
||||
module CliGen
|
||||
class Flag(T)
|
||||
def test_coerce(var : String)
|
||||
coerce(var)
|
||||
end
|
||||
|
||||
def process(args : Array(String))
|
||||
process(make_args(args))
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
enum TestEnum
|
||||
ABC
|
||||
DEF
|
||||
GHI
|
||||
end
|
||||
|
||||
class MyGoodData
|
||||
extend CliGen::Coercable
|
||||
extend CliGen::Parsable
|
||||
|
||||
getter value : TestEnum
|
||||
|
||||
def initialize(@value)
|
||||
end
|
||||
|
||||
def self.to_s
|
||||
nil
|
||||
end
|
||||
|
||||
def to_s
|
||||
@value.to_s
|
||||
end
|
||||
|
||||
def to_s(io : IO)
|
||||
io << @value.to_s
|
||||
end
|
||||
|
||||
def self.coerce(arg : String)
|
||||
case arg
|
||||
when "abc"
|
||||
new(TestEnum::ABC)
|
||||
when "def"
|
||||
new(TestEnum::DEF)
|
||||
when "ghi"
|
||||
new(TestEnum::GHI)
|
||||
else
|
||||
raise "WTF?"
|
||||
end
|
||||
end
|
||||
|
||||
def self.parse_args(args : Array(CliGen::Arg))
|
||||
raise "ERROR" if args.empty?
|
||||
arg = args.first
|
||||
arg.processed
|
||||
coerce(arg.value)
|
||||
end
|
||||
end
|
||||
|
||||
class MyBadData < MyGoodData
|
||||
def self.parse_args(args : Array(CliGen::Arg))
|
||||
raise "ERROR" if args.empty?
|
||||
arg = args.first
|
||||
coerce(arg.value)
|
||||
end
|
||||
end
|
||||
|
||||
def make_arg(value, index : Int32 = 0) : CliGen::Arg
|
||||
CliGen::Arg.new(value: value, index: index)
|
||||
end
|
||||
|
||||
|
||||
def make_args(values : Array(String)) : Array(CliGen::Arg)
|
||||
output = [] of CliGen::Arg
|
||||
|
||||
values.each_with_index{|v, i| output << make_arg(v,i)}
|
||||
|
||||
output
|
||||
end
|
||||
|
||||
macro make_flag(type, long = "--test", env_var = "TEST", var = "", description = "", short = nil, delimiter = ",", default = nil, options = nil, validate = nil, on_match = nil, format = nil)
|
||||
CliGen::Flag({{type}}).new(
|
||||
var: {{var}},
|
||||
env_var: {{env_var}},
|
||||
short: {{short}},
|
||||
long: {{long}},
|
||||
description: {{description}},
|
||||
delimiter: {{delimiter}},
|
||||
default: {{default}},
|
||||
options: {{options}},
|
||||
validate: {{validate}},
|
||||
on_match: {{on_match}},
|
||||
format: {{format}}
|
||||
)
|
||||
end
|
||||
|
||||
describe CliGen::Flag do
|
||||
before_each { ENV.delete("TEST") }
|
||||
|
||||
describe "#check!" do
|
||||
it "will throw CliGen::ReservedFlagError if -h is used as short" do
|
||||
expect_raises(CliGen::ReservedFlagError) do
|
||||
make_flag(type: Bool, short: "-h", long: "--not-help").check!
|
||||
end
|
||||
end
|
||||
|
||||
it "will throw CliGen::ReservedFlagError if --help is used in long" do
|
||||
expect_raises(CliGen::ReservedFlagError) do
|
||||
make_flag(type: Bool, short: "-b", long: "--help TOPIC").check!
|
||||
end
|
||||
end
|
||||
|
||||
it "will throw CliGen::ReservedFlagError if --help is used as long_key" do
|
||||
expect_raises(CliGen::ReservedFlagError) do
|
||||
make_flag(type: Bool, short: "-b", long: "--help").check!
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "#value!" do
|
||||
it "will throw CliGen::MissingRequiredFlagError if a flag without a default value is called with no way of determining a value" do
|
||||
flg = make_flag(type: String)
|
||||
expect_raises(CliGen::MissingRequiredFlagError) do
|
||||
flg.value!
|
||||
end
|
||||
end
|
||||
|
||||
it "will fallback to provided default if no data is provided by the user" do
|
||||
make_flag(type: String, default: "abc").value!.should eq "abc"
|
||||
end
|
||||
|
||||
it "will resolve values from ENV VAR if not directly supplied with one" do
|
||||
flg = make_flag(type: String, env_var: "MYTESTVAR")
|
||||
ENV["MYTESTVAR"] = "abc"
|
||||
flg.value!.should eq "abc"
|
||||
end
|
||||
|
||||
describe "Flag(Array(String))" do
|
||||
it "returns a valid array when resolving from ENV VAR" do
|
||||
flg = make_flag(type: Array(String), env_var: "ABCDEF")
|
||||
ENV["ABCDEF"]="a,b,c"
|
||||
flg.value!.should eq %w[ a b c ]
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
end
|
||||
|
||||
describe "#coerce" do
|
||||
{% for int in Int.subclasses %}
|
||||
{% uint = int.stringify =~ /^UInt/ ? true : false %}
|
||||
describe "Flag({{int}})" do
|
||||
it "can correctly coerce {{int}}" do
|
||||
make_flag(type: {{int}}).test_coerce("1").should be_a {{int}}
|
||||
end
|
||||
|
||||
it "will raise CliGen::InvalidFlagValueError if provided a value that is not an {{int}}" do
|
||||
expect_raises(CliGen::InvalidFlagValueError) do
|
||||
make_flag(type: {{int}}).test_coerce("abc")
|
||||
end
|
||||
end
|
||||
|
||||
{% if uint %}
|
||||
it "will raise CliGen::InvalidFlagValueError if provided a value in a signed int" do
|
||||
expect_raises(CliGen::InvalidFlagValueError) do
|
||||
make_flag(type: {{int}}).test_coerce("-1")
|
||||
end
|
||||
end
|
||||
{% end %}
|
||||
end
|
||||
|
||||
{% if uint %}
|
||||
describe "Flag(Array({{int}}))" do
|
||||
it "Will be correctly parsed when providing an unsigned int" do
|
||||
abc = "1,2,3"
|
||||
make_flag(type: Array({{int}})).test_coerce(abc).should eq([ 1, 2, 3 ] of {{int}})
|
||||
end
|
||||
it "will raise CliGen::InvalidFlagValueError if an signed int is provided" do
|
||||
abc = "-1,2,3"
|
||||
expect_raises(CliGen::InvalidFlagValueError) do
|
||||
make_flag(type: Array({{int}})).test_coerce(abc)
|
||||
end
|
||||
end
|
||||
end
|
||||
{% else %}
|
||||
describe "Flag(Array({{int}}))" do
|
||||
it "Will be correctly parsed when providing a signed int" do
|
||||
abc = "-1,2,3"
|
||||
make_flag(type: Array({{int}})).test_coerce(abc).should eq([ -1, 2, 3 ] of {{int}})
|
||||
end
|
||||
end
|
||||
{% end %}
|
||||
{% end %}
|
||||
|
||||
{% for float in Float.subclasses %}
|
||||
describe "Flag({{float}})" do
|
||||
it "can correctly coerce {{float}}" do
|
||||
make_flag(type: {{float}}).test_coerce("1.1").should be_a {{float}}
|
||||
end
|
||||
|
||||
it "will raise CliGen::InvalidFlagValueError if provided value isn't a {{float}}" do
|
||||
expect_raises(CliGen::InvalidFlagValueError) do
|
||||
make_flag(type: {{float}}).test_coerce("why")
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "Flag(Array({{float}}))" do
|
||||
it "will correctly coerce data in a unsigned int format" do
|
||||
abc = "1,2,3"
|
||||
make_flag(type: Array({{float}})).test_coerce(abc).should eq([1,2,3] of {{float}})
|
||||
end
|
||||
|
||||
it "will correctly coerce data in a signed int format" do
|
||||
abc = "-1,2,3"
|
||||
make_flag(type: Array({{float}})).test_coerce(abc).should eq([-1,2,3] of {{float}})
|
||||
end
|
||||
|
||||
it "will correctly coerce data in a mixed int & float format" do
|
||||
abc = "-1,2,3.2"
|
||||
make_flag(type: Array({{float}})).test_coerce(abc).should eq([-1,2,3.2] of {{float}})
|
||||
end
|
||||
end
|
||||
{% end %}
|
||||
|
||||
describe "Flag(Bool)" do
|
||||
it "correctly coerces with valid data" do
|
||||
%w[ t true 1 y yes ].each do |opt|
|
||||
make_flag(type: Bool).test_coerce(opt).should be_true
|
||||
end
|
||||
%w[ f false 0 n no ].each do |opt|
|
||||
make_flag(type: Bool).test_coerce(opt).should be_false
|
||||
end
|
||||
end
|
||||
|
||||
it "raises CliGen::InvalidFlagValueError if provided an invalid value" do
|
||||
expect_raises(CliGen::InvalidFlagValueError) do
|
||||
make_flag(type: Bool).test_coerce("why?")
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "Flag(Array(CustomObj))" do
|
||||
it "can correctly coerce data from the custom object" do
|
||||
flg = make_flag(type: Array(MyGoodData))
|
||||
flg.test_coerce("abc,def").map(&.to_s.downcase).should eq %w[ abc def ]
|
||||
end
|
||||
end
|
||||
|
||||
describe "Flag(Array(String))" do
|
||||
it "correctly splits based on delimiter" do
|
||||
flg = make_flag(type: Array(String), long: "--mytest", delimiter: "|")
|
||||
flg.test_coerce("a|b|c").should eq %w[ a b c ]
|
||||
end
|
||||
|
||||
it "will raise CliGen::InvalidFlagValueError if an element of the array doesn't match the format defined" do
|
||||
flg = make_flag(type: Array(String), format: /^test[A-Z]$/)
|
||||
expect_raises(CliGen::InvalidFlagValueError) do
|
||||
flg.test_coerce("testA,testB,test1")
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "#validate!" do
|
||||
it "will raise CliGen::InvalidOptionError if the provided value isn't in the static list of options" do
|
||||
flg = make_flag(type: String, long: "--test", env_var: "TESTVAR", options: %w[ a b c ])
|
||||
ENV["TESTVAR"] = "d"
|
||||
expect_raises(CliGen::InvalidOptionError) do
|
||||
flg.validate!
|
||||
end
|
||||
end
|
||||
|
||||
it "will raise CliGen::ValidationError if the dev provided validation fails" do
|
||||
flg = make_flag(type: String, long: "--test", env_var: "TESTVAR", validate: ->(v : String) : Bool { v == "abc" })
|
||||
ENV["TESTVAR"] = "def"
|
||||
expect_raises(CliGen::ValidationError) do
|
||||
flg.validate!
|
||||
end
|
||||
end
|
||||
|
||||
describe "Flag(Array(String))" do
|
||||
flg = make_flag(type: Array(String), long: "--test", env_var: "TESTVAR2", options: [%w[ a b c ]])
|
||||
it "will raise CliGen::InvalidOptionError if the provided value isn't in the static list of options" do
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "#process" do
|
||||
describe "Flag(String)" do
|
||||
it "will raise CliGen::InvalidFlagValueError if provided string doesn't match format" do
|
||||
flg = make_flag(type: String, env_var: "TEST", short: "-t", long: "--test", format: /^abc$/)
|
||||
expect_raises(CliGen::InvalidFlagValueError) do
|
||||
flg.process(%w[ def ])
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
{% for int in Int.subclasses %}
|
||||
{% uint = int.stringify =~ /^UInt/ ? true : false %}
|
||||
describe "Flag({{int}})" do
|
||||
it "coerces a valid {{int}} from provided arguments" do
|
||||
{% if uint %}
|
||||
val = 1
|
||||
{% else %}
|
||||
val = -1
|
||||
{% end %}
|
||||
|
||||
flg = make_flag(type: {{int}})
|
||||
flg.process(make_args([val.to_s]))
|
||||
flg.value!.should eq val
|
||||
end
|
||||
|
||||
{% if uint %}
|
||||
it "will raise CliGen::InvalidFlagValueError if provided a signed int" do
|
||||
expect_raises(CliGen::InvalidFlagValueError) do
|
||||
make_flag(type: {{int}}).process([make_arg("-1", 0)])
|
||||
end
|
||||
end
|
||||
{% end %}
|
||||
end
|
||||
|
||||
describe "Flag(Array({{int}}))" do
|
||||
{% if uint %}
|
||||
it "will raise when a signed int is provided" do
|
||||
args = make_args(%w[ 1 2 -3 ])
|
||||
flg = make_flag(type: Array({{int}}))
|
||||
expect_raises(CliGen::InvalidFlagValueError) do
|
||||
flg.process(args)
|
||||
end
|
||||
end
|
||||
it "will raise when a signed int is provided in a delimited string" do
|
||||
args = [make_arg("1,2,-3")]
|
||||
flg = make_flag(type: Array({{int}}))
|
||||
expect_raises(CliGen::InvalidFlagValueError) do
|
||||
flg.process(args)
|
||||
end
|
||||
end
|
||||
{% end %}
|
||||
|
||||
it "can consume positive ints" do
|
||||
args = make_args(%w[ 1 2 3 ])
|
||||
flg = make_flag(type: Array({{int}}))
|
||||
flg.process(args)
|
||||
flg.value!.should eq([1, 2, 3] of {{int}})
|
||||
end
|
||||
|
||||
it "can consume positive ints in a delimited string" do
|
||||
args = [make_arg("1,2,3", 0)]
|
||||
flg = make_flag(type: Array({{int}}))
|
||||
flg.process(args)
|
||||
flg.value!.should eq([1, 2, 3] of {{int}})
|
||||
end
|
||||
|
||||
it "can consume positive ints in a delimited string and will strip whitespace" do
|
||||
args = [make_arg("1 ,2,3", 0)]
|
||||
flg = make_flag(type: Array({{int}}))
|
||||
flg.process(args)
|
||||
flg.value!.should eq([1, 2, 3] of {{int}})
|
||||
end
|
||||
|
||||
it "can consume positive ints in multiple arguments" do
|
||||
args = make_args(%w[ 1,2,3 4 ])
|
||||
flg = make_flag(type: Array({{int}}))
|
||||
flg.process(args)
|
||||
flg.value!.should eq([1, 2, 3, 4] of {{int}})
|
||||
end
|
||||
|
||||
{% unless uint %}
|
||||
it "can consume signed ints" do
|
||||
args = make_args(%w[ 1 2 -3 ])
|
||||
flg = make_flag(type: Array({{int}}))
|
||||
flg.process(args)
|
||||
flg.value!.should eq([1, 2, -3] of {{int}})
|
||||
end
|
||||
|
||||
it "can consume signed ints in a delimited string" do
|
||||
args = [make_arg("1,2,-3")]
|
||||
flg = make_flag(type: Array({{int}}))
|
||||
flg.process(args)
|
||||
flg.value!.should eq([1, 2, -3] of {{int}})
|
||||
end
|
||||
{% end %}
|
||||
|
||||
end
|
||||
{% end %}
|
||||
|
||||
{% for float in Float.subclasses %}
|
||||
describe "Flag({{float}})" do
|
||||
it "coerces a valid {{float}} from provided arguments" do
|
||||
val = {{float}}.new("1.1")
|
||||
flg = make_flag(type: {{float}})
|
||||
flg.process(make_args([val.to_s]))
|
||||
flg.value!.should eq val
|
||||
end
|
||||
end
|
||||
|
||||
describe "Flag(Array({{float}}))" do
|
||||
it "can handle an array of int/float formatted values" do
|
||||
args = make_args(%w[ 1 2 3 1.1 -1])
|
||||
flg = make_flag(type: Array({{float}}))
|
||||
flg.process(args)
|
||||
flg.value!.should eq([1, 2, 3, 1.1, -1] of {{float}})
|
||||
end
|
||||
end
|
||||
{% end %}
|
||||
describe "Flag(Array(String))" do
|
||||
it "will throw CliGen::InvalidFlagValueError if a deserialized var/item is an invalid format" do
|
||||
flg = make_flag(type: Array(String), format: /^(a|b|c)$/)
|
||||
expect_raises(CliGen::InvalidFlagValueError) do
|
||||
flg.process([ "a,b,c,d" ])
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
describe "Flag(CustomObj)" do
|
||||
it "will throw a CliGen::ParseableInvariantError if object doesn't mark data as processed" do
|
||||
flg = make_flag(type: MyBadData)
|
||||
expect_raises(CliGen::ParseableInvariantError) do
|
||||
flg.process(["abc"])
|
||||
end
|
||||
end
|
||||
|
||||
it "will correctly set the value if parsed" do
|
||||
flg = make_flag(type: MyGoodData)
|
||||
flg.process(["abc"])
|
||||
flg.value!.value.should eq TestEnum::ABC
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
require "spec"
|
||||
require "../src/cligen"
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
require "./cligen/exceptions"
|
||||
require "./cligen/coercable"
|
||||
require "./cligen/parsable"
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
module CliGen
|
||||
annotation ProxyCommand
|
||||
end
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
require "./arg"
|
||||
require "./command_node"
|
||||
require "./flag"
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
module CliGen
|
||||
macro finished
|
||||
class App
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
module CliGen
|
||||
# This class serves as a "argument wrapper" to force a fail-fast approach to
|
||||
# arg-parsing.
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
module CliGen::Coercable
|
||||
abstract def coerce(arg : String)
|
||||
end
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
require "colorize"
|
||||
require "time"
|
||||
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
module CliGen
|
||||
class Command
|
||||
macro argument(variable, description, long = nil, short = nil, validation = nil, on_match = nil, def_setter = false, def_getter = false, options = nil, delimiter = ",", format = nil, allow_no_verification = false)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
module CliGen
|
||||
class Command
|
||||
macro def_init
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
module CliGen
|
||||
class Command
|
||||
macro define_command_initializer
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
module CliGen
|
||||
class Command
|
||||
macro help_template(filepath)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
module CliGen
|
||||
class Command
|
||||
macro selection(variable, description, options, short = nil, long = nil, validation = nil, on_match = nil)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
module CliGen
|
||||
class Command
|
||||
macro subcommand(func, description, examples = nil, &block)
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
require "./global_flag"
|
||||
require "./match_type"
|
||||
require "./flag"
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
module CliGen
|
||||
# Base for all CliGen exceptions
|
||||
class Error < Exception; end
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
require "./arg"
|
||||
|
||||
module CliGen
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
module CliGen::Format
|
||||
INPUT_DATE_PARTIAL = "%Y-%m-%d %H:%M:%S"
|
||||
INPUT_DATE_FULL = "%Y-%m-%d %H:%M:%S %z"
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
require "./flag"
|
||||
|
||||
module CliGen
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
module CliGen
|
||||
enum MatchType
|
||||
FlagWithArg
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
module CliGen::Parsable
|
||||
abstract def parse_args(args : Array(CliGen::Arg))
|
||||
end
|
||||
|
||||
+32
-10
@@ -1,18 +1,40 @@
|
||||
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
|
||||
module CliGen::Regex
|
||||
FLAG_REGEX=/^(-[a-zA-Z]|--[a-zA-Z-_0-9]+)$/
|
||||
FLAG_WITH_ARG=/^(?<flag>(-[a-zA-Z]|--[a-zA-Z-_]+))="?(?<arg>\S+?)"?$/
|
||||
FLAG_MULTIPLE_SHORT=/^-[a-zA-Z0-9]+$/
|
||||
|
||||
INPUT_TIMEZONE = /(?<timezone>[-+][0-9]{4})/
|
||||
INPUT_TIME = /(?<time>(?<hour>[0-9]{2}):(?<minute>[0-9]{2}):(?<second>[0-9]{2}))/
|
||||
INPUT_DATE_SIMPLE = /(?<year>[0-9]{4})-(?<month>[0-9]{2})-(?<day>[0-9]{2})/
|
||||
INPUT_DATE_SIMPLE_WITH_TIMEZONE = /^#{INPUT_DATE_SIMPLE}\s+#{INPUT_TIMEZONE}$/
|
||||
INPUT_DATE_FULL = /^(?<date>#{INPUT_DATE_SIMPLE})\s+#{INPUT_TIME}\s+#{INPUT_TIMEZONE}$/
|
||||
INPUT_DATE_PARTIAL = /^(?<date>#{INPUT_DATE_SIMPLE})\s+#{INPUT_TIME}$/
|
||||
INPUT_DATE_RELATIVE = /(?<sign>[+-])?(?<quantity>[0-9]+)\s+(?<unit>seconds?|days?|hours?|minutes?|years?)/
|
||||
INPUT_DATE_RELATIVE_WITH_TIMEZONE = /#{INPUT_DATE_RELATIVE}\s+#{INPUT_TIMEZONE}/
|
||||
INPUT_DATE_EPOCH = /@(?<epoch>[0-9]+)/
|
||||
INPUT_DATE_EPOCH_WITH_TIMEZONE = /#{INPUT_DATE_EPOCH}\s+#{INPUT_TIMEZONE}/
|
||||
# ---------------------------------------------------------------------------
|
||||
# Date/time components.
|
||||
#
|
||||
# These are building blocks ONLY — they are interpolated into the anchored
|
||||
# matchers below and must stay unanchored. Interpolating a Regex renders it
|
||||
# as `(?-imsx:...)`, so an anchor here would end up buried mid-pattern in the
|
||||
# composites (`^(?-imsx:^...$)\s+...$`) and could never match.
|
||||
#
|
||||
# Never match user input against these directly — use the INPUT_DATE_*
|
||||
# matchers, which are anchored.
|
||||
# ---------------------------------------------------------------------------
|
||||
TIMEZONE = /(?<timezone>[-+][0-9]{4})/
|
||||
TIME = /(?<time>(?<hour>[0-9]{2}):(?<minute>[0-9]{2}):(?<second>[0-9]{2}))/
|
||||
DATE = /(?<date>(?<year>[0-9]{4})-(?<month>[0-9]{2})-(?<day>[0-9]{2}))/
|
||||
EPOCH = /@(?<epoch>[0-9]+)/
|
||||
RELATIVE = /(?<sign>[+-])(?<quantity>[0-9]+)\s+(?<unit>seconds?|minutes?|hours?|days?|months?|years?)/
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Date/time matchers — fully anchored so a partial match can't slip through.
|
||||
# ---------------------------------------------------------------------------
|
||||
INPUT_DATE_FULL = /^#{DATE}\s+#{TIME}\s+#{TIMEZONE}$/
|
||||
INPUT_DATE_PARTIAL = /^#{DATE}\s+#{TIME}$/
|
||||
INPUT_DATE_SIMPLE_WITH_TIMEZONE = /^#{DATE}\s+#{TIMEZONE}$/
|
||||
INPUT_DATE_SIMPLE = /^#{DATE}$/
|
||||
INPUT_DATE_EPOCH_WITH_TIMEZONE = /^#{EPOCH}\s+#{TIMEZONE}$/
|
||||
INPUT_DATE_EPOCH = /^#{EPOCH}$/
|
||||
INPUT_DATE_RELATIVE_WITH_TIMEZONE = /^#{RELATIVE}\s+#{TIMEZONE}$/
|
||||
INPUT_DATE_RELATIVE = /^#{RELATIVE}$/
|
||||
|
||||
FLOAT = /^[-+]?[[:digit:]]+(\.[[:digit:]]+)?$/
|
||||
UINT = /^[[:digit:]]+$/
|
||||
|
||||
Reference in New Issue
Block a user