ruby_hocon 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +202 -0
- data/README.md +19 -0
- data/lib/hocon.rb +2 -0
- data/lib/hocon/config_error.rb +12 -0
- data/lib/hocon/config_factory.rb +9 -0
- data/lib/hocon/config_object.rb +4 -0
- data/lib/hocon/config_parse_options.rb +53 -0
- data/lib/hocon/config_render_options.rb +46 -0
- data/lib/hocon/config_syntax.rb +7 -0
- data/lib/hocon/config_value_type.rb +26 -0
- data/lib/hocon/impl.rb +5 -0
- data/lib/hocon/impl/abstract_config_object.rb +64 -0
- data/lib/hocon/impl/abstract_config_value.rb +130 -0
- data/lib/hocon/impl/config_concatenation.rb +136 -0
- data/lib/hocon/impl/config_float.rb +9 -0
- data/lib/hocon/impl/config_impl.rb +10 -0
- data/lib/hocon/impl/config_impl_util.rb +78 -0
- data/lib/hocon/impl/config_int.rb +31 -0
- data/lib/hocon/impl/config_number.rb +27 -0
- data/lib/hocon/impl/config_string.rb +37 -0
- data/lib/hocon/impl/full_includer.rb +4 -0
- data/lib/hocon/impl/origin_type.rb +9 -0
- data/lib/hocon/impl/parseable.rb +151 -0
- data/lib/hocon/impl/parser.rb +882 -0
- data/lib/hocon/impl/path.rb +59 -0
- data/lib/hocon/impl/path_builder.rb +36 -0
- data/lib/hocon/impl/resolve_status.rb +18 -0
- data/lib/hocon/impl/simple_config.rb +11 -0
- data/lib/hocon/impl/simple_config_list.rb +70 -0
- data/lib/hocon/impl/simple_config_object.rb +178 -0
- data/lib/hocon/impl/simple_config_origin.rb +174 -0
- data/lib/hocon/impl/simple_include_context.rb +7 -0
- data/lib/hocon/impl/simple_includer.rb +19 -0
- data/lib/hocon/impl/token.rb +32 -0
- data/lib/hocon/impl/token_type.rb +42 -0
- data/lib/hocon/impl/tokenizer.rb +370 -0
- data/lib/hocon/impl/tokens.rb +157 -0
- data/lib/hocon/impl/unmergeable.rb +4 -0
- metadata +84 -0
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
202
|
+
|
data/README.md
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
ruby-hocon
|
2
|
+
==========
|
3
|
+
|
4
|
+
This is a port of the [Typesafe Config](https://github.com/typesafehub/config) library to Ruby.
|
5
|
+
|
6
|
+
The library provides Ruby support for the [HOCON](https://github.com/typesafehub/config/blob/master/HOCON.md) configuration file format.
|
7
|
+
|
8
|
+
At present, the only features it supports are explicit parsing of config files (.conf/HOCON, .json, .properties) via `ConfigFactory.parse_file`, and rendering a parsed config object back to a String. Testing is minimal and not all data types are supported yet. It also does not yet support `include` or interpolated settings.
|
9
|
+
|
10
|
+
The implementation is intended to be as close to a line-for-line port as the two languages allow, in hopes of making it fairly easy to port over new changesets from the Java code base over time.
|
11
|
+
|
12
|
+
Basic Usage
|
13
|
+
===========
|
14
|
+
|
15
|
+
```rb
|
16
|
+
require 'hocon/config_factory'
|
17
|
+
|
18
|
+
conf = Hocon::ConfigFactory.parse_file("myapp.conf")
|
19
|
+
conf_map = conf.root.unwrapped
|
data/lib/hocon.rb
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
require 'hocon'
|
2
|
+
require 'hocon/config_parse_options'
|
3
|
+
require 'hocon/impl/parseable'
|
4
|
+
|
5
|
+
class Hocon::ConfigFactory
|
6
|
+
def self.parse_file(file_path, options = Hocon::ConfigParseOptions.defaults)
|
7
|
+
Hocon::Impl::Parseable.new_file(file_path, options).parse.to_config
|
8
|
+
end
|
9
|
+
end
|
@@ -0,0 +1,53 @@
|
|
1
|
+
require 'hocon'
|
2
|
+
|
3
|
+
class Hocon::ConfigParseOptions
|
4
|
+
attr_accessor :syntax, :origin_description, :allow_missing, :includer
|
5
|
+
|
6
|
+
def self.defaults
|
7
|
+
self.new(nil, nil, true, nil)
|
8
|
+
end
|
9
|
+
|
10
|
+
def initialize(syntax, origin_description, allow_missing, includer)
|
11
|
+
@syntax = syntax
|
12
|
+
@origin_description = origin_description
|
13
|
+
@allow_missing = allow_missing
|
14
|
+
@includer = includer
|
15
|
+
end
|
16
|
+
|
17
|
+
def allow_missing?
|
18
|
+
@allow_missing
|
19
|
+
end
|
20
|
+
|
21
|
+
def with_syntax(syntax)
|
22
|
+
if @syntax == syntax
|
23
|
+
self
|
24
|
+
else
|
25
|
+
Hocon::ConfigParseOptions.new(syntax,
|
26
|
+
@origin_description,
|
27
|
+
@allow_missing,
|
28
|
+
@includer)
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
32
|
+
def with_includer(includer)
|
33
|
+
if @includer == includer
|
34
|
+
self
|
35
|
+
else
|
36
|
+
Hocon::ConfigParseOptions.new(@syntax,
|
37
|
+
@origin_description,
|
38
|
+
@allow_missing,
|
39
|
+
includer)
|
40
|
+
end
|
41
|
+
end
|
42
|
+
|
43
|
+
def append_includer(includer)
|
44
|
+
if @includer == includer
|
45
|
+
self
|
46
|
+
elsif @includer
|
47
|
+
with_includer(@includer.with_fallback(includer))
|
48
|
+
else
|
49
|
+
with_includer(includer)
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
end
|
@@ -0,0 +1,46 @@
|
|
1
|
+
require 'hocon'
|
2
|
+
|
3
|
+
class Hocon::ConfigRenderOptions
|
4
|
+
def initialize(origin_comments, comments, formatted, json)
|
5
|
+
@origin_comments = origin_comments
|
6
|
+
@comments = comments
|
7
|
+
@formatted = formatted
|
8
|
+
@json = json
|
9
|
+
end
|
10
|
+
|
11
|
+
attr_writer :origin_comments, :comments, :formatted, :json
|
12
|
+
|
13
|
+
def origin_comments?
|
14
|
+
@origin_comments
|
15
|
+
end
|
16
|
+
def comments?
|
17
|
+
@comments
|
18
|
+
end
|
19
|
+
def formatted?
|
20
|
+
@formatted
|
21
|
+
end
|
22
|
+
def json?
|
23
|
+
@json
|
24
|
+
end
|
25
|
+
|
26
|
+
#
|
27
|
+
# Returns the default render options which are verbose (commented and
|
28
|
+
# formatted). See {@link ConfigRenderOptions#concise} for stripped-down
|
29
|
+
# options. This rendering will not be valid JSON since it has comments.
|
30
|
+
#
|
31
|
+
# @return the default render options
|
32
|
+
#
|
33
|
+
def self.defaults
|
34
|
+
Hocon::ConfigRenderOptions.new(true, true, true, true)
|
35
|
+
end
|
36
|
+
|
37
|
+
#
|
38
|
+
# Returns concise render options (no whitespace or comments). For a
|
39
|
+
# resolved {@link Config}, the concise rendering will be valid JSON.
|
40
|
+
#
|
41
|
+
# @return the concise render options
|
42
|
+
#
|
43
|
+
def self.concise
|
44
|
+
Hocon::ConfigRenderOptions.new(false, false, false, true)
|
45
|
+
end
|
46
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
require 'hocon'
|
2
|
+
|
3
|
+
#
|
4
|
+
# The type of a configuration value (following the <a
|
5
|
+
# href="http://json.org">JSON</a> type schema).
|
6
|
+
#
|
7
|
+
module Hocon::ConfigValueType
|
8
|
+
OBJECT = 0
|
9
|
+
LIST = 1
|
10
|
+
NUMBER = 2
|
11
|
+
BOOLEAN = 3
|
12
|
+
NULL = 4
|
13
|
+
STRING = 5
|
14
|
+
|
15
|
+
def self.name(config_value_type)
|
16
|
+
case config_value_type
|
17
|
+
when OBJECT then "OBJECT"
|
18
|
+
when LIST then "LIST"
|
19
|
+
when NUMBER then "NUMBER"
|
20
|
+
when BOOLEAN then "BOOLEAN"
|
21
|
+
when NULL then "NULL"
|
22
|
+
when STRING then "STRING"
|
23
|
+
else raise ConfigBugError, "Unrecognized value type '#{config_value_type}'"
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
data/lib/hocon/impl.rb
ADDED
@@ -0,0 +1,64 @@
|
|
1
|
+
require 'hocon/impl'
|
2
|
+
require 'hocon/impl/abstract_config_value'
|
3
|
+
require 'hocon/impl/simple_config'
|
4
|
+
require 'hocon/config_object'
|
5
|
+
require 'hocon/config_value_type'
|
6
|
+
require 'hocon/impl/resolve_status'
|
7
|
+
require 'hocon/impl/simple_config_origin'
|
8
|
+
|
9
|
+
class Hocon::Impl::AbstractConfigObject < Hocon::Impl::AbstractConfigValue
|
10
|
+
include Hocon::ConfigObject
|
11
|
+
|
12
|
+
def initialize(origin)
|
13
|
+
super(origin)
|
14
|
+
@config = Hocon::Impl::SimpleConfig.new(self)
|
15
|
+
end
|
16
|
+
|
17
|
+
def to_config
|
18
|
+
@config
|
19
|
+
end
|
20
|
+
|
21
|
+
def to_fallback_value
|
22
|
+
self
|
23
|
+
end
|
24
|
+
|
25
|
+
def value_type
|
26
|
+
Hocon::ConfigValueType::OBJECT
|
27
|
+
end
|
28
|
+
|
29
|
+
def new_copy(origin)
|
30
|
+
new_copy_with_status(resolve_status, origin)
|
31
|
+
end
|
32
|
+
|
33
|
+
def merge_origins(stack)
|
34
|
+
if stack.empty?
|
35
|
+
raise ConfigBugError, "can't merge origins on empty list"
|
36
|
+
end
|
37
|
+
origins = []
|
38
|
+
first_origin = nil
|
39
|
+
num_merged = 0
|
40
|
+
stack.each do |v|
|
41
|
+
if first_origin.nil?
|
42
|
+
first_origin = v.origin
|
43
|
+
end
|
44
|
+
|
45
|
+
if (v.is_a?(Hocon::Impl::AbstractConfigObject)) &&
|
46
|
+
(v.resolve_status == Hocon::Impl::ResolveStatus::RESOLVED) &&
|
47
|
+
v.empty?
|
48
|
+
# don't include empty files or the .empty()
|
49
|
+
# config in the description, since they are
|
50
|
+
# likely to be "implementation details"
|
51
|
+
else
|
52
|
+
origins.push(v.origin)
|
53
|
+
num_merged += 1
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
if num_merged == 0
|
58
|
+
# the configs were all empty, so just use the first one
|
59
|
+
origins.push(first_origin)
|
60
|
+
end
|
61
|
+
|
62
|
+
Hocon::Impl::SimpleConfigOrigin.merge_origins(origins)
|
63
|
+
end
|
64
|
+
end
|