rkwalify 1.4.0.pre.preview1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.github/workflows/ruby.yml +39 -0
- data/.gitignore +61 -0
- data/.overcommit.yml +33 -0
- data/.rubocop.yml +9 -0
- data/.rubocop_todo.yml +1369 -0
- data/.ruby-version +1 -0
- data/Attic/README-0.7.2.md +53 -0
- data/Attic/features/cli.feature +9 -0
- data/Attic/features/step_definitions/validation_steps.rb +20 -0
- data/Attic/features/support/env.rb +4 -0
- data/Attic/features/validate_schema.feature +12 -0
- data/Attic/s+h +53 -0
- data/Attic/setup.rb +1556 -0
- data/Attic/spec/my_cli_tool_spec.rb +52 -0
- data/Attic/spec/rspec-ex_spec.rb +10 -0
- data/Attic/spec/spec_helper.rb +104 -0
- data/Attic/test-15.1.rb +28 -0
- data/CHANGELOG.md +292 -0
- data/CONTRIBUTING.md +23 -0
- data/CONTRIBUTORS.md +8 -0
- data/Gemfile +16 -0
- data/Gemfile.lock +146 -0
- data/MIT-LICENSE +21 -0
- data/README.md +53 -0
- data/ROLL-OUT-STRATEGY.md +77 -0
- data/Rakefile +11 -0
- data/bin/kwalify.rb +4167 -0
- data/bin/kwalify.schema.yaml +59 -0
- data/contrib/inline-require +181 -0
- data/contrib/kwalify +4167 -0
- data/contrib/kwalify-0.7.2 +4160 -0
- data/devbin/README.md +22 -0
- data/devbin/chk-rad-repo.sh +20 -0
- data/devbin/chkcopyrights.sh +42 -0
- data/devbin/chkspelling.sh +16 -0
- data/devbin/got-all-rel-numbers.sh +5 -0
- data/devbin/mkbig-rkwalify.sh +7 -0
- data/devbin/mkgem_file.sh +5 -0
- data/devbin/runtests.sh +6 -0
- data/devbin/ug-tests.golden +242 -0
- data/devbin/ug-tests.sh +145 -0
- data/devbin/update-rel-numbers.sh +7 -0
- data/doc/docstyle.css +188 -0
- data/doc/img/fig01.png +0 -0
- data/doc/users-guide.html +2051 -0
- data/doc-api/classes/CommandOptionError.html +184 -0
- data/doc-api/classes/CommandOptionParser.html +325 -0
- data/doc-api/classes/Kwalify/AssertionError.html +148 -0
- data/doc-api/classes/Kwalify/BaseError.html +297 -0
- data/doc-api/classes/Kwalify/BaseParser.html +461 -0
- data/doc-api/classes/Kwalify/CommandOptionError.html +168 -0
- data/doc-api/classes/Kwalify/ErrorHelper.html +223 -0
- data/doc-api/classes/Kwalify/HashInterface.html +118 -0
- data/doc-api/classes/Kwalify/Json.html +105 -0
- data/doc-api/classes/Kwalify/KwalifyError.html +111 -0
- data/doc-api/classes/Kwalify/Main.html +339 -0
- data/doc-api/classes/Kwalify/MetaValidator.html +448 -0
- data/doc-api/classes/Kwalify/Parser.html +155 -0
- data/doc-api/classes/Kwalify/PlainYamlParser/Alias.html +165 -0
- data/doc-api/classes/Kwalify/PlainYamlParser.html +523 -0
- data/doc-api/classes/Kwalify/Rule.html +433 -0
- data/doc-api/classes/Kwalify/SchemaError.html +148 -0
- data/doc-api/classes/Kwalify/SyntaxError.html +185 -0
- data/doc-api/classes/Kwalify/Types.html +302 -0
- data/doc-api/classes/Kwalify/Util/HashLike.html +246 -0
- data/doc-api/classes/Kwalify/Util/OrderedHash.html +330 -0
- data/doc-api/classes/Kwalify/Util.html +390 -0
- data/doc-api/classes/Kwalify/ValidationError.html +148 -0
- data/doc-api/classes/Kwalify/Validator.html +381 -0
- data/doc-api/classes/Kwalify/Yaml/Parser.html +1538 -0
- data/doc-api/classes/Kwalify/Yaml.html +194 -0
- data/doc-api/classes/Kwalify/YamlParser.html +542 -0
- data/doc-api/classes/Kwalify/YamlSyntaxError.html +119 -0
- data/doc-api/classes/Kwalify.html +292 -0
- data/doc-api/classes/Test/Unit.html +101 -0
- data/doc-api/classes/Test.html +107 -0
- data/doc-api/created.rid +1 -0
- data/doc-api/files/__/README_txt.html +153 -0
- data/doc-api/files/kwalify/errors_rb.html +114 -0
- data/doc-api/files/kwalify/main_rb.html +118 -0
- data/doc-api/files/kwalify/messages_rb.html +107 -0
- data/doc-api/files/kwalify/meta-validator_rb.html +117 -0
- data/doc-api/files/kwalify/parser/base_rb.html +116 -0
- data/doc-api/files/kwalify/parser/yaml_rb.html +117 -0
- data/doc-api/files/kwalify/rule_rb.html +116 -0
- data/doc-api/files/kwalify/types_rb.html +114 -0
- data/doc-api/files/kwalify/util/assert-text-equal_rb.html +115 -0
- data/doc-api/files/kwalify/util/hash-interface_rb.html +114 -0
- data/doc-api/files/kwalify/util/hashlike_rb.html +107 -0
- data/doc-api/files/kwalify/util/option-parser_rb.html +107 -0
- data/doc-api/files/kwalify/util/ordered-hash_rb.html +107 -0
- data/doc-api/files/kwalify/util/testcase-helper_rb.html +115 -0
- data/doc-api/files/kwalify/util_rb.html +107 -0
- data/doc-api/files/kwalify/validator_rb.html +117 -0
- data/doc-api/files/kwalify/yaml-parser_rb.html +117 -0
- data/doc-api/files/kwalify_rb.html +121 -0
- data/doc-api/fr_class_index.html +57 -0
- data/doc-api/fr_file_index.html +45 -0
- data/doc-api/fr_method_index.html +168 -0
- data/doc-api/index.html +24 -0
- data/doc-api/rdoc-style.css +208 -0
- data/examples/address-book/Makefile +10 -0
- data/examples/address-book/address-book.schema.yaml +45 -0
- data/examples/address-book/address-book.yaml +36 -0
- data/examples/data-binding/BABEL.data.yaml +63 -0
- data/examples/data-binding/BABEL.schema.yaml +31 -0
- data/examples/data-binding/Makefile +8 -0
- data/examples/data-binding/Rakefile +13 -0
- data/examples/data-binding/main.rb +25 -0
- data/examples/invoice/Makefile +9 -0
- data/examples/invoice/invoice.schema.yaml +43 -0
- data/examples/invoice/invoice.yaml +32 -0
- data/examples/tapkit/Makefile +10 -0
- data/examples/tapkit/main.rb +7 -0
- data/examples/tapkit/tapkit.schema.yaml +146 -0
- data/examples/tapkit/tapkit.yaml +85 -0
- data/lib/kwalify/errors.rb +127 -0
- data/lib/kwalify/kwalify.schema.yaml +58 -0
- data/lib/kwalify/main.rb +442 -0
- data/lib/kwalify/messages.rb +173 -0
- data/lib/kwalify/meta-validator.rb +276 -0
- data/lib/kwalify/parser/base.rb +128 -0
- data/lib/kwalify/parser/yaml.rb +841 -0
- data/lib/kwalify/rule.rb +562 -0
- data/lib/kwalify/templates/genclass-java.eruby +222 -0
- data/lib/kwalify/templates/genclass-php.eruby +104 -0
- data/lib/kwalify/templates/genclass-ruby.eruby +113 -0
- data/lib/kwalify/types.rb +156 -0
- data/lib/kwalify/util/assert-text-equal.rb +46 -0
- data/lib/kwalify/util/hash-interface.rb +18 -0
- data/lib/kwalify/util/hashlike.rb +51 -0
- data/lib/kwalify/util/option-parser.rb +220 -0
- data/lib/kwalify/util/ordered-hash.rb +57 -0
- data/lib/kwalify/util/testcase-helper.rb +112 -0
- data/lib/kwalify/util.rb +159 -0
- data/lib/kwalify/validator.rb +282 -0
- data/lib/kwalify/version.rb +5 -0
- data/lib/kwalify/yaml-parser.rb +871 -0
- data/lib/kwalify.rb +61 -0
- data/rkwalify.gemspec +26 -0
- data/test/Rookbook.yaml +15 -0
- data/test/data/users-guide/AddressBook.java.expected +40 -0
- data/test/data/users-guide/BABEL.data.yaml +24 -0
- data/test/data/users-guide/BABEL.schema.yaml +30 -0
- data/test/data/users-guide/ExampleAddressBook.java +47 -0
- data/test/data/users-guide/Group.java.expected +24 -0
- data/test/data/users-guide/Person.java.expected +44 -0
- data/test/data/users-guide/address_book.rb +52 -0
- data/test/data/users-guide/address_book.schema.yaml +28 -0
- data/test/data/users-guide/address_book.yaml +27 -0
- data/test/data/users-guide/answers-schema.yaml +12 -0
- data/test/data/users-guide/answers-validator.rb +53 -0
- data/test/data/users-guide/babel_genclass.result +26 -0
- data/test/data/users-guide/config.schema.yaml +7 -0
- data/test/data/users-guide/config.yaml +4 -0
- data/test/data/users-guide/document01a.yaml +3 -0
- data/test/data/users-guide/document01b.yaml +3 -0
- data/test/data/users-guide/document02a.yaml +4 -0
- data/test/data/users-guide/document02b.yaml +4 -0
- data/test/data/users-guide/document03a.yaml +6 -0
- data/test/data/users-guide/document03b.yaml +6 -0
- data/test/data/users-guide/document04a.yaml +9 -0
- data/test/data/users-guide/document04b.yaml +9 -0
- data/test/data/users-guide/document05a.yaml +11 -0
- data/test/data/users-guide/document05b.yaml +12 -0
- data/test/data/users-guide/document06a.yaml +15 -0
- data/test/data/users-guide/document06b.yaml +16 -0
- data/test/data/users-guide/document07a.yaml +9 -0
- data/test/data/users-guide/document07b.yaml +7 -0
- data/test/data/users-guide/document12a.json +10 -0
- data/test/data/users-guide/document12b.json +6 -0
- data/test/data/users-guide/document13a.yaml +17 -0
- data/test/data/users-guide/document14a.yaml +3 -0
- data/test/data/users-guide/document14b.yaml +3 -0
- data/test/data/users-guide/document15a.yaml +6 -0
- data/test/data/users-guide/document15b.yaml +5 -0
- data/test/data/users-guide/example_address_book.rb +11 -0
- data/test/data/users-guide/example_address_book_java.result +32 -0
- data/test/data/users-guide/example_address_book_ruby.result +31 -0
- data/test/data/users-guide/genclass_java.result +4 -0
- data/test/data/users-guide/howto-validation-with-parsing.rb +28 -0
- data/test/data/users-guide/howto-validation.rb +25 -0
- data/test/data/users-guide/howto3.rb +6 -0
- data/test/data/users-guide/howto3.result +5 -0
- data/test/data/users-guide/howto3.yaml +8 -0
- data/test/data/users-guide/howto5_databinding.result +111 -0
- data/test/data/users-guide/invalid01.result +3 -0
- data/test/data/users-guide/invalid02.result +5 -0
- data/test/data/users-guide/invalid03.result +5 -0
- data/test/data/users-guide/invalid04.result +4 -0
- data/test/data/users-guide/invalid05.result +11 -0
- data/test/data/users-guide/invalid06.result +4 -0
- data/test/data/users-guide/invalid07.result +3 -0
- data/test/data/users-guide/invalid08.result +3 -0
- data/test/data/users-guide/invalid12.json +8 -0
- data/test/data/users-guide/invalid14.result +4 -0
- data/test/data/users-guide/invalid15.result +4 -0
- data/test/data/users-guide/loadbabel.rb +27 -0
- data/test/data/users-guide/loadconfig.rb +17 -0
- data/test/data/users-guide/loadconfig.result +6 -0
- data/test/data/users-guide/models.rb +24 -0
- data/test/data/users-guide/option_ha.result +6 -0
- data/test/data/users-guide/option_ha_genclass_java.result +7 -0
- data/test/data/users-guide/schema01.yaml +3 -0
- data/test/data/users-guide/schema02.yaml +12 -0
- data/test/data/users-guide/schema03.yaml +9 -0
- data/test/data/users-guide/schema04.yaml +20 -0
- data/test/data/users-guide/schema05.yaml +29 -0
- data/test/data/users-guide/schema06.yaml +11 -0
- data/test/data/users-guide/schema12.json +12 -0
- data/test/data/users-guide/schema13.yaml +13 -0
- data/test/data/users-guide/schema14.yaml +5 -0
- data/test/data/users-guide/schema15.yaml +21 -0
- data/test/data/users-guide/valid01.result +2 -0
- data/test/data/users-guide/valid02.result +2 -0
- data/test/data/users-guide/valid03.result +2 -0
- data/test/data/users-guide/valid04.result +2 -0
- data/test/data/users-guide/valid05.result +2 -0
- data/test/data/users-guide/valid06.result +2 -0
- data/test/data/users-guide/valid07.result +2 -0
- data/test/data/users-guide/valid08.result +2 -0
- data/test/data/users-guide/valid12.result +2 -0
- data/test/data/users-guide/valid13.result +2 -0
- data/test/data/users-guide/valid14.result +2 -0
- data/test/data/users-guide/valid15.result +2 -0
- data/test/data/users-guide/validate08.rb +37 -0
- data/test/test-action.rb +73 -0
- data/test/test-action.yaml +738 -0
- data/test/test-databinding.rb +84 -0
- data/test/test-databinding.yaml +339 -0
- data/test/test-main.rb +156 -0
- data/test/test-main.yaml +409 -0
- data/test/test-metavalidator.rb +80 -0
- data/test/test-metavalidator.yaml +1179 -0
- data/test/test-parser-yaml.rb +57 -0
- data/test/test-parser-yaml.yaml +1750 -0
- data/test/test-rule.rb +26 -0
- data/test/test-rule.yaml +317 -0
- data/test/test-users-guide.rb +82 -0
- data/test/test-util.rb +125 -0
- data/test/test-validator.rb +95 -0
- data/test/test-validator.yaml +986 -0
- data/test/test-yaml-parser.rb +47 -0
- data/test/test-yaml-parser.yaml +1226 -0
- data/test/test.rb +75 -0
- metadata +293 -0
data/MIT-LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
copyright(c) 2005-2010 kuwata-lab all rights reserved.
|
|
2
|
+
copyright(c) 2026 Al Snow all rights reserved.
|
|
3
|
+
|
|
4
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
|
5
|
+
a copy of this software and associated documentation files (the
|
|
6
|
+
"Software"), to deal in the Software without restriction, including
|
|
7
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
|
8
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
|
9
|
+
permit persons to whom the Software is furnished to do so, subject to
|
|
10
|
+
the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be
|
|
13
|
+
included in all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
16
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
17
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
18
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
19
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
20
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
21
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# rkwalify
|
|
2
|
+
|
|
3
|
+
* release:: 1.4.0-preview1
|
|
4
|
+
* lastupdate:: $Date$
|
|
5
|
+
* copyright:: copyright(c) 2005-2010 kuwata-lab all rights reserved.
|
|
6
|
+
|
|
7
|
+
## Introduction
|
|
8
|
+
|
|
9
|
+
Updated version of "RKwalify is a parser, schema validator, and data binding tool for YAML and JSON"
|
|
10
|
+
|
|
11
|
+
## Getting Started Using Gem
|
|
12
|
+
|
|
13
|
+
* See [documentation](doc/users-guide.html) for details.
|
|
14
|
+
|
|
15
|
+
* To install, add this line to your application's Gemfile:
|
|
16
|
+
|
|
17
|
+
* gem "rkwalify"
|
|
18
|
+
|
|
19
|
+
* Or install directly with "gem install rkwalify".
|
|
20
|
+
|
|
21
|
+
(Optional) The 'contrib/inline-require' script to concatenate
|
|
22
|
+
all scripts and libraries into a file.
|
|
23
|
+
```
|
|
24
|
+
$ cd rkwalify/
|
|
25
|
+
$ unset RUBYLIB
|
|
26
|
+
$ ruby contrib/inline-require -I ./lib bin/rkwalify > contrib/rkwalify
|
|
27
|
+
$ chmod a+x contrib/rkwalify
|
|
28
|
+
$ cp lib/kwalify/kwalify.schema.yaml $HOME/bin
|
|
29
|
+
$ mv contrib/rkwalify $HOME/bin
|
|
30
|
+
```
|
|
31
|
+
## CONTRIBUTE
|
|
32
|
+
|
|
33
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
|
|
34
|
+
|
|
35
|
+
## Contributing as developer
|
|
36
|
+
|
|
37
|
+
* To create Gemfile.lock file, run "bundle install".
|
|
38
|
+
|
|
39
|
+
* To run the tests, type "rake".
|
|
40
|
+
|
|
41
|
+
* To run the tests with (simplecov) coverage,
|
|
42
|
+
* type "COVERAGE='yes' rake",
|
|
43
|
+
* and then open **coverage/index.html** in a browser.
|
|
44
|
+
|
|
45
|
+
# License
|
|
46
|
+
|
|
47
|
+
[MIT License](MIT-LICENSE)
|
|
48
|
+
|
|
49
|
+
# Copyright
|
|
50
|
+
```
|
|
51
|
+
copyright(c) 2005-2010 kuwata-lab all rights reserved.
|
|
52
|
+
copyright(c) 2026 Al Snow all rights reserved.
|
|
53
|
+
```
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
## RKWALIFY Roll Out Stategy
|
|
2
|
+
|
|
3
|
+
**This document only focuses on the initial 2026 release: 1.4.0.**
|
|
4
|
+
|
|
5
|
+
1. Naming: Use "rkwalify" as repo and gem name, but use
|
|
6
|
+
"kwalify" inside code and tests. Use "Rkwalify" in documentaiton.
|
|
7
|
+
|
|
8
|
+
2. Step 1: First add [kwalify](https://rubygems.org/gems/kwalify) (0.7.2) into
|
|
9
|
+
"rkwalify" repo. This includes all files (code, docs, etc).
|
|
10
|
+
See commits for more details.
|
|
11
|
+
|
|
12
|
+
* Assume this original [kwalify](https://rubygems.org/gems/kwalify) gem will stay around.
|
|
13
|
+
* Add credit to repo to @kwatch.
|
|
14
|
+
|
|
15
|
+
3. Step 2: Then merge in [dc-kwalify](https://rubygems.org/gems/dc-kwalify)
|
|
16
|
+
(1.0.0) to "rkwalify" repo. See commits for more details.
|
|
17
|
+
* Add credit to repo @dafyddcrosby.
|
|
18
|
+
|
|
19
|
+
4. Step 3: Modernize the tool chain (bundler, rubygems, rvm, Rakefile,
|
|
20
|
+
several rubocop gems, markdown, ruby 3.4.7, simplecov).
|
|
21
|
+
See commits for more details. Also used my personal tools as needed.
|
|
22
|
+
|
|
23
|
+
5. Create "rkwalify" [issues](https://github.com/jasnow/rkwalify/issues) for major work items.
|
|
24
|
+
|
|
25
|
+
6. Initial Release Target
|
|
26
|
+
|
|
27
|
+
* rkwalify's "test" Github Action is green. Comment out [test/test.rb](https://github.com/jasnow/rkwalify/blob/main/test/test.rb)
|
|
28
|
+
tests that are broken. See [issue](https://github.com/jasnow/rkwalify/issues/2) for details.
|
|
29
|
+
|
|
30
|
+
* ruby-advisory-db (Ruby 3.4.7) tests are green using rkwalify code.
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
8. Must decide if anything else is added to .gitignore file in final release
|
|
35
|
+
* doc, doc-pai
|
|
36
|
+
* tests, examples, contrib
|
|
37
|
+
* Attic
|
|
38
|
+
|
|
39
|
+
9. Another technique is to comment code and tets not used by #7 repos.
|
|
40
|
+
|
|
41
|
+
10. Decide when to make repo public.
|
|
42
|
+
|
|
43
|
+
## RELEASE ORDER/NAMING
|
|
44
|
+
|
|
45
|
+
* Possible Release Order
|
|
46
|
+
* Preview1, Preview2,... release
|
|
47
|
+
* Beta, RC (Release Candidate) release
|
|
48
|
+
* Final release
|
|
49
|
+
|
|
50
|
+
*. Release Defintions (draft)
|
|
51
|
+
* MAJOR
|
|
52
|
+
* Introduces significant changes.
|
|
53
|
+
* May include breaking changes.
|
|
54
|
+
* Big architectural shifts
|
|
55
|
+
|
|
56
|
+
* MINOR
|
|
57
|
+
* Safe to upgrade within the same major version.
|
|
58
|
+
* Adds new features.
|
|
59
|
+
* No breaking changes.
|
|
60
|
+
* Maintains backward compatibility as much as possible.
|
|
61
|
+
|
|
62
|
+
* TEENY/PATCH
|
|
63
|
+
* Bug fixes and security updates.
|
|
64
|
+
* No new features.
|
|
65
|
+
|
|
66
|
+
* RELEASE CADENCE
|
|
67
|
+
* Major releases: roughly every 2 3 years.
|
|
68
|
+
* Released roughly every 2 3 years (often announced
|
|
69
|
+
at major ecosystem conference)
|
|
70
|
+
* Minor releases: every few months.
|
|
71
|
+
* Released annually (traditionally on specific day).
|
|
72
|
+
* Patch releases: frequent, as needed.
|
|
73
|
+
* Security Policy
|
|
74
|
+
* FYI: Rails maintains:
|
|
75
|
+
* Last 2 major versions with security patches.
|
|
76
|
+
* Older versions only get fixes from community forks.
|
|
77
|
+
EOF
|