stringify-hash 0.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +15 -0
- data/.gitignore +25 -0
- data/.rspec +3 -0
- data/.simplecov +9 -0
- data/Gemfile +3 -0
- data/LICENSE +202 -0
- data/README.md +2 -0
- data/lib/stringify-hash.rb +298 -0
- data/lib/version.rb +3 -0
- data/spec/spec_helper.rb +2 -0
- data/spec/stringify-hash/stringify-hash_spec.rb +103 -0
- data/stringify-hash.gemspec +31 -0
- metadata +157 -0
checksums.yaml
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
!binary "U0hBMQ==":
|
3
|
+
metadata.gz: !binary |-
|
4
|
+
Yzg2YWVlZWQ0MTA5ODU5Njg1NGQ2MjRkMjQ3NWFjMWEwZmE4YTEwNg==
|
5
|
+
data.tar.gz: !binary |-
|
6
|
+
OTEyYmU2YjFkZmQyMGM0NmMzNDFjMWQyNzA0M2RiODU4MjUzYzcyNg==
|
7
|
+
SHA512:
|
8
|
+
metadata.gz: !binary |-
|
9
|
+
YzhkNWM0ZTA0Y2VjZTM2MWU4ODQ2YzUxODMxZDg5NjJiOTg5YWY4MjE5ZDBk
|
10
|
+
ZjBjYmE0YjU1OWE0ZTJlN2VjZTQzODhiMjNlODk3MTk5ZTZmY2NkNWI3YjAz
|
11
|
+
ODNlZmNlNWExODM2NjliODQ0YzA3YjI5NTUwZjkwMDE2M2FlYzU=
|
12
|
+
data.tar.gz: !binary |-
|
13
|
+
OTY1ZGIwZWM1ODlhZTQwNjcyMGNiNTk4ZWQ0YzY4OGI2NzIyNWZlZmI2YjZj
|
14
|
+
ZGU3NzBiOTYyZTI5MWNiNzU1NzdiMWYwYzg0Nzg2YzNkMjZhODE2YmY4ZGQ1
|
15
|
+
ZDc4ZWJjZGNhMjkzNmY2NjM4MjIyMTE0YzE4NDE4ZmZmZGMwMTk=
|
data/.gitignore
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
*.swp
|
2
|
+
log/*
|
3
|
+
!.gitignore
|
4
|
+
junit
|
5
|
+
acceptance-tests
|
6
|
+
pkg
|
7
|
+
Gemfile.lock
|
8
|
+
options.rb
|
9
|
+
test.cfg
|
10
|
+
.yardoc
|
11
|
+
coverage
|
12
|
+
.bundle
|
13
|
+
.vendor
|
14
|
+
_vendor
|
15
|
+
tmp/
|
16
|
+
doc
|
17
|
+
# JetBrains IDEA
|
18
|
+
*.iml
|
19
|
+
.idea/
|
20
|
+
# rbenv file
|
21
|
+
.ruby-version
|
22
|
+
.ruby-gemset
|
23
|
+
# Vagrant folder
|
24
|
+
.vagrant/
|
25
|
+
.vagrant_files/
|
data/.rspec
ADDED
data/.simplecov
ADDED
data/Gemfile
ADDED
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,298 @@
|
|
1
|
+
# A hash that treats Symbol and String keys interchangeably
|
2
|
+
# and recursively merges hashes
|
3
|
+
class StringifyHash < Hash
|
4
|
+
|
5
|
+
# The dividor between elements when StringifyHash is dumped
|
6
|
+
DIV = ' '
|
7
|
+
|
8
|
+
# The end of line when dumping
|
9
|
+
EOL = "\n"
|
10
|
+
|
11
|
+
# Get value for given key, search for both k as String and k as Symbol,
|
12
|
+
# if not present return nil
|
13
|
+
#
|
14
|
+
# @param [Object] k The key to find, searches for both k as String
|
15
|
+
# and k as Symbol
|
16
|
+
#
|
17
|
+
# @example Use this method to return the value for a given key
|
18
|
+
# a['key'] = 'value'
|
19
|
+
# a['key'] == a[:key] == 'value'
|
20
|
+
#
|
21
|
+
# @return [nil, Object] Return the Object found at given key,
|
22
|
+
# or nil if no Object found
|
23
|
+
def [] k
|
24
|
+
super(k.to_s) || super(k.to_sym)
|
25
|
+
end
|
26
|
+
|
27
|
+
# Set Symbol key to Object value
|
28
|
+
# @param [Object] k The key to associated with the value,
|
29
|
+
# converted to Symbol key
|
30
|
+
# @param [Object] v The value to store in the ObjectHash
|
31
|
+
#
|
32
|
+
# @example Use this method to set the value for a key
|
33
|
+
# a['key'] = 'value'
|
34
|
+
#
|
35
|
+
# @return [Object] Return the Object value just stored
|
36
|
+
def []=k,v
|
37
|
+
super(k.to_sym, v)
|
38
|
+
end
|
39
|
+
|
40
|
+
# Determine if key is stored in ObjectHash
|
41
|
+
# @param [Object] k The key to find in ObjectHash, searches for
|
42
|
+
# both k as String and k as Symbol
|
43
|
+
#
|
44
|
+
# @example Use this method to set the value for a key
|
45
|
+
# a['key'] = 'value'
|
46
|
+
# a.has_key[:key] == true
|
47
|
+
#
|
48
|
+
# @return [Boolean]
|
49
|
+
def has_key? k
|
50
|
+
super(k.to_s) || super(k.to_sym)
|
51
|
+
end
|
52
|
+
|
53
|
+
# Determine key=>value entry in StringifyHash, remove both value at
|
54
|
+
# String key and value at Symbol key
|
55
|
+
#
|
56
|
+
# @param [Object] k The key to delete in ObjectHash,
|
57
|
+
# deletes both k as String and k as Symbol
|
58
|
+
#
|
59
|
+
# @example Use this method to set the value for a key
|
60
|
+
# a['key'] = 'value'
|
61
|
+
# a.delete[:key] == 'value'
|
62
|
+
#
|
63
|
+
# @return [Object, nil] The Object deleted at value,
|
64
|
+
# nil if no Object deleted
|
65
|
+
def delete k
|
66
|
+
super(k.to_s) || super(k.to_sym)
|
67
|
+
end
|
68
|
+
|
69
|
+
# Recursively merge and StringifyHash with an OptionsHash or Hash
|
70
|
+
#
|
71
|
+
# @param [StringifyHash] base The hash to merge into
|
72
|
+
# @param [StringifyHash, Hash] hash The hash to merge from
|
73
|
+
#
|
74
|
+
# @example
|
75
|
+
# base = { :key => { :subkey1 => 'subval', :subkey2 => 'subval' } }
|
76
|
+
# hash = { :key => { :subkey1 => 'newval'} }
|
77
|
+
#
|
78
|
+
# rmerge(base, hash)
|
79
|
+
# #=> {:key =>
|
80
|
+
# {:subkey1 => 'newval',
|
81
|
+
# :subkey2 => 'subval'}}
|
82
|
+
#
|
83
|
+
# @return [StringifyHash] The combined bash and hash
|
84
|
+
def rmerge base, hash
|
85
|
+
return base unless hash.is_a?(Hash) || hash.is_a?(StringifyHash)
|
86
|
+
hash.each do |key, v|
|
87
|
+
if (base[key].is_a?(Hash) || base[key].is_a?(StringifyHash)) && (hash[key].is_a?(Hash) || hash[key].is_a?(OptionsHash))
|
88
|
+
rmerge(base[key], hash[key])
|
89
|
+
elsif hash[key].is_a?(Hash)
|
90
|
+
base[key] = StringifyHash.new.merge(hash[key])
|
91
|
+
else
|
92
|
+
base[key]= hash[key]
|
93
|
+
end
|
94
|
+
end
|
95
|
+
base
|
96
|
+
end
|
97
|
+
|
98
|
+
# Create new StringifyHash from recursively merged self with an OptionsHash or Hash
|
99
|
+
#
|
100
|
+
# @param [StringifyHash, Hash] hash The hash to merge from
|
101
|
+
#
|
102
|
+
# @example
|
103
|
+
# base = { :key => { :subkey1 => 'subval', :subkey2 => 'subval' } }
|
104
|
+
# hash = { :key => { :subkey1 => 'newval'} }
|
105
|
+
#
|
106
|
+
# base.merge(hash)
|
107
|
+
# #=> {:key =>
|
108
|
+
# {:subkey1 => 'newval',
|
109
|
+
# :subkey2 => 'subval' }
|
110
|
+
#
|
111
|
+
# @return [StringifyHash] The combined hash
|
112
|
+
def merge hash
|
113
|
+
#make a deep copy into an empty hash object
|
114
|
+
merged_hash = rmerge(StringifyHash.new, self)
|
115
|
+
rmerge(merged_hash, hash)
|
116
|
+
end
|
117
|
+
|
118
|
+
# Recursively merge self with an StringifyHash or Hash
|
119
|
+
#
|
120
|
+
# @param [StringifyHash, Hash] hash The hash to merge from
|
121
|
+
#
|
122
|
+
# @example
|
123
|
+
# base = { :key => { :subkey1 => 'subval', :subkey2 => 'subval' } }
|
124
|
+
# hash = { :key => { :subkey1 => 'newval'} }
|
125
|
+
#
|
126
|
+
# base.merge!(hash)
|
127
|
+
# #=> {:key =>
|
128
|
+
# {:subkey1 => 'newval',
|
129
|
+
# :subkey2 => 'subval' }
|
130
|
+
#
|
131
|
+
# @return [StringifyHash] The combined hash
|
132
|
+
def merge! hash
|
133
|
+
rmerge(self, hash)
|
134
|
+
end
|
135
|
+
|
136
|
+
# Helper for formatting collections
|
137
|
+
# Computes the indentation level for elements of the collection
|
138
|
+
# Yields indentation to block to so the caller can create
|
139
|
+
# map of element strings
|
140
|
+
# Places delimiters in the correct location
|
141
|
+
# Joins everything with correct EOL
|
142
|
+
#
|
143
|
+
#
|
144
|
+
# !@visibility private
|
145
|
+
def as_coll( opening, closing, in_lvl, in_inc, &block )
|
146
|
+
delim_indent = in_inc * in_lvl
|
147
|
+
elem_indent = in_inc * (in_lvl + 1)
|
148
|
+
|
149
|
+
open_brace = opening
|
150
|
+
close_brace = delim_indent + closing
|
151
|
+
|
152
|
+
fmtd_coll = block.call( elem_indent )
|
153
|
+
str_coll = fmtd_coll.join( ',' + EOL )
|
154
|
+
|
155
|
+
return open_brace + EOL + str_coll + EOL + close_brace
|
156
|
+
end
|
157
|
+
|
158
|
+
# Pretty prints a collection
|
159
|
+
#
|
160
|
+
# @param [Enumerable] collection The collection to be printed
|
161
|
+
# @param [Integer] in_lvl The level of indentation
|
162
|
+
# @param [String] in_inc The increment to indent
|
163
|
+
#
|
164
|
+
# @example
|
165
|
+
# base = {:key => { :subkey1 => 'subval', :subkey2 => ['subval'] }}
|
166
|
+
# self.fmt_collection( base )
|
167
|
+
# #=> '{
|
168
|
+
# "key": {
|
169
|
+
# "subkey": "subval",
|
170
|
+
# "subkey2": [
|
171
|
+
# "subval"
|
172
|
+
# ]
|
173
|
+
# }
|
174
|
+
# }'
|
175
|
+
#
|
176
|
+
# @return [String] The collection as a pretty JSON object
|
177
|
+
def fmt_collection( collection, in_lvl = 0, in_inc = DIV )
|
178
|
+
if collection.respond_to? :each_pair
|
179
|
+
string = fmt_assoc( collection, in_lvl, in_inc )
|
180
|
+
else
|
181
|
+
string = fmt_list( collection, in_lvl, in_inc )
|
182
|
+
end
|
183
|
+
|
184
|
+
return string
|
185
|
+
end
|
186
|
+
|
187
|
+
# Pretty prints an associative collection
|
188
|
+
#
|
189
|
+
# @param [#each_pair] coll The collection to be printed
|
190
|
+
# @param [Integer] in_lvl The level of indentation
|
191
|
+
# @param [String] in_inc The increment to indent
|
192
|
+
#
|
193
|
+
# @example
|
194
|
+
# base = { :key => 'value', :key2 => 'value' }
|
195
|
+
# self.fmt_assoc( base )
|
196
|
+
# #=> '{
|
197
|
+
# "key": "value",
|
198
|
+
# "key2": "value"
|
199
|
+
# }'
|
200
|
+
#
|
201
|
+
# @return [String] The collection as a pretty JSON object
|
202
|
+
def fmt_assoc( coll, in_lvl = 0, in_inc = DIV )
|
203
|
+
if coll.empty?
|
204
|
+
return '{}'
|
205
|
+
else
|
206
|
+
as_coll '{', '}', in_lvl, in_inc do |elem_indent|
|
207
|
+
coll.map do |key, value|
|
208
|
+
assoc_line = elem_indent + '"' + key.to_s + '"' + ': '
|
209
|
+
assoc_line += fmt_value( value, in_lvl, in_inc )
|
210
|
+
end
|
211
|
+
end
|
212
|
+
end
|
213
|
+
end
|
214
|
+
|
215
|
+
# Pretty prints a list collection
|
216
|
+
#
|
217
|
+
# @param [#each] coll The collection to be printed
|
218
|
+
# @param [Integer] in_lvl The level of indentation
|
219
|
+
# @param [String] in_inc The increment to indent
|
220
|
+
#
|
221
|
+
# @example
|
222
|
+
# base = [ 'first', 'second' ]
|
223
|
+
# self.fmt_list( base )
|
224
|
+
# #=> '[
|
225
|
+
# "first",
|
226
|
+
# "second"
|
227
|
+
# ]'
|
228
|
+
#
|
229
|
+
# @return [String] The collection as a pretty JSON object
|
230
|
+
def fmt_list( coll, in_lvl = 0, in_inc = DIV )
|
231
|
+
if coll.empty?
|
232
|
+
return '[]'
|
233
|
+
else
|
234
|
+
as_coll '[', ']', in_lvl, in_inc do |indent|
|
235
|
+
coll.map do |el|
|
236
|
+
indent + fmt_value( el, in_lvl, in_inc )
|
237
|
+
end
|
238
|
+
end
|
239
|
+
end
|
240
|
+
end
|
241
|
+
|
242
|
+
# Chooses between collection and primitive formatting
|
243
|
+
#
|
244
|
+
# !@visibility private
|
245
|
+
def fmt_value( value, in_lvl = 0, in_inc = DIV )
|
246
|
+
if value.kind_of? Enumerable and not value.is_a? String
|
247
|
+
fmt_collection( value, in_lvl + 1, in_inc )
|
248
|
+
else
|
249
|
+
fmt_basic( value )
|
250
|
+
end
|
251
|
+
end
|
252
|
+
|
253
|
+
# Pretty prints primitive JSON values
|
254
|
+
#
|
255
|
+
# @param [Object] value The collection to be printed
|
256
|
+
#
|
257
|
+
# @example
|
258
|
+
# self.fmt_value( 4 )
|
259
|
+
# #=> '4'
|
260
|
+
#
|
261
|
+
# @example
|
262
|
+
# self.fmt_value( true )
|
263
|
+
# #=> 'true'
|
264
|
+
#
|
265
|
+
# @example
|
266
|
+
# self.fmt_value( nil )
|
267
|
+
# #=> 'null'
|
268
|
+
#
|
269
|
+
# @example
|
270
|
+
# self.fmt_value( 'string' )
|
271
|
+
# #=> '"string"'
|
272
|
+
#
|
273
|
+
# @return [String] The value as a valid JSON primitive
|
274
|
+
def fmt_basic( value )
|
275
|
+
case value
|
276
|
+
when Numeric, TrueClass, FalseClass then value.to_s
|
277
|
+
when NilClass then "null"
|
278
|
+
else "\"#{value}\""
|
279
|
+
end
|
280
|
+
end
|
281
|
+
|
282
|
+
# Pretty print the options as JSON
|
283
|
+
#
|
284
|
+
# @example
|
285
|
+
# base = { :key => { :subkey1 => 'subval', :subkey2 => 'subval' } }
|
286
|
+
# base.dump
|
287
|
+
# #=> '{
|
288
|
+
# "key": {
|
289
|
+
# "subkey1": "subval",
|
290
|
+
# "subkey2": 2
|
291
|
+
# }
|
292
|
+
# }
|
293
|
+
#
|
294
|
+
# @return [String] The description of self
|
295
|
+
def dump
|
296
|
+
fmt_collection( self, 0, DIV )
|
297
|
+
end
|
298
|
+
end
|
data/lib/version.rb
ADDED
data/spec/spec_helper.rb
ADDED
@@ -0,0 +1,103 @@
|
|
1
|
+
require "spec_helper"
|
2
|
+
|
3
|
+
describe StringifyHash do
|
4
|
+
let(:options) { StringifyHash.new }
|
5
|
+
|
6
|
+
#test options hash methods
|
7
|
+
it "converts all string keys to symbols when doing direct assignment" do
|
8
|
+
options['key'] = 'value'
|
9
|
+
expect(options.has_key?(:key)) === true and expect(options.has_key?('key')) === false
|
10
|
+
end
|
11
|
+
|
12
|
+
it "can look up by string or symbol key" do
|
13
|
+
options.merge({'key' => 'value'})
|
14
|
+
expect(options['key']) === 'value' and expect(options[:key]) === 'value'
|
15
|
+
end
|
16
|
+
|
17
|
+
it "can delete by string of symbol key" do
|
18
|
+
options['key'] = 'value'
|
19
|
+
expect(options.delete('key')) === 'value' and expect(options.delete(:key)) === 'value'
|
20
|
+
end
|
21
|
+
|
22
|
+
it "when merged with a Hash remains an StringifyHash" do
|
23
|
+
options.merge({'key' => 'value'})
|
24
|
+
expect(options.is_a?(StringifyHash)) === true
|
25
|
+
end
|
26
|
+
|
27
|
+
it "when merged with a hash that contains a hash, the sub-hash becomes an StringifyHash" do
|
28
|
+
newhash = options.merge({'key' => {'subkey' => 'subvalue'}})
|
29
|
+
expect(newhash[:key].is_a?(StringifyHash)) === true and expect(newhash[:key][:subkey]) === 'subvalue'
|
30
|
+
end
|
31
|
+
|
32
|
+
it "does not alter the original hash when doing a merge" do
|
33
|
+
options.merge({'key' => {'subkey' => 'subvalue'}})
|
34
|
+
expect(options[:key]).to be === nil
|
35
|
+
end
|
36
|
+
|
37
|
+
context 'pretty prints itself' do
|
38
|
+
|
39
|
+
it 'in valid JSON' do
|
40
|
+
require 'json'
|
41
|
+
|
42
|
+
options['array'] = ['one', 'two', 'three']
|
43
|
+
options['hash'] = {'subkey' => { 'subsub' => 1 }}
|
44
|
+
options['nil'] = nil
|
45
|
+
options['number'] = 4
|
46
|
+
options['float'] = 1.0
|
47
|
+
options['string'] = 'string'
|
48
|
+
options['true'] = true
|
49
|
+
|
50
|
+
expect{ JSON.parse( options.dump ) }.to_not raise_error
|
51
|
+
end
|
52
|
+
|
53
|
+
context 'for non collection values shows' do
|
54
|
+
it 'non-string like values as bare words' do
|
55
|
+
expect( options.fmt_value( 4 ) ).to be == "4"
|
56
|
+
expect( options.fmt_value( 1.0 ) ).to be == "1.0"
|
57
|
+
expect( options.fmt_value( true ) ).to be == "true"
|
58
|
+
expect( options.fmt_value( false ) ).to be == "false"
|
59
|
+
end
|
60
|
+
|
61
|
+
it 'nil values as null' do
|
62
|
+
expect( options.fmt_value( nil ) ).to be == 'null'
|
63
|
+
end
|
64
|
+
|
65
|
+
it 'strings within double quotes' do
|
66
|
+
expect( options.fmt_value( 'thing' ) ).to be == '"thing"'
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
context 'for list like collections shows' do
|
71
|
+
it 'each element on a new line' do
|
72
|
+
fmt_list = options.fmt_value( %w{ one two three } )
|
73
|
+
|
74
|
+
expect( fmt_list ).to match(/^\s*"one",?$/)
|
75
|
+
expect( fmt_list ).to match(/^\s*"two",?$/)
|
76
|
+
expect( fmt_list ).to match(/^\s*"three",?$/)
|
77
|
+
end
|
78
|
+
|
79
|
+
it 'square brackets on either end of the list' do
|
80
|
+
fmt_list = options.fmt_value( %w{ one two three } )
|
81
|
+
|
82
|
+
expect( fmt_list ).to match( /\A\[\s*$/ )
|
83
|
+
expect( fmt_list ).to match( /^\s*\]\Z/ )
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
context 'for dict like collections shows' do
|
88
|
+
it 'each element on a new line' do
|
89
|
+
fmt_assoc = options.fmt_value( {:one => 'two', :two => 'three'} )
|
90
|
+
|
91
|
+
expect( fmt_assoc ).to match(/^\s*"one": "two",?$/)
|
92
|
+
expect( fmt_assoc ).to match(/^\s*"two": "three",?$/)
|
93
|
+
end
|
94
|
+
|
95
|
+
it 'curly braces on either end of the list' do
|
96
|
+
fmt_assoc = options.fmt_value( {:one => 'two', :two => 'three'} )
|
97
|
+
|
98
|
+
expect( fmt_assoc ).to match( /\A\{\s*$/ )
|
99
|
+
expect( fmt_assoc ).to match( /^\s*\}\Z/ )
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
|
3
|
+
require 'version'
|
4
|
+
|
5
|
+
Gem::Specification.new do |s|
|
6
|
+
s.name = "stringify-hash"
|
7
|
+
s.version = Version::STRING
|
8
|
+
s.authors = ["Puppetlabs", "anode"]
|
9
|
+
s.email = ["qe-team@puppetlabs.com"]
|
10
|
+
s.homepage = "https://github.com/puppetlabs/stringify-hash"
|
11
|
+
s.summary = %q{A Ruby Hash that treats symbols and strings interchangeably!}
|
12
|
+
s.description = %q{:test == "test"}
|
13
|
+
s.license = 'Apache2'
|
14
|
+
|
15
|
+
s.files = `git ls-files`.split("\n")
|
16
|
+
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
|
17
|
+
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
|
18
|
+
s.require_paths = ["lib"]
|
19
|
+
|
20
|
+
# Testing dependencies
|
21
|
+
s.add_development_dependency 'rspec', '~> 3.0'
|
22
|
+
s.add_development_dependency 'rake', '~> 10.1'
|
23
|
+
s.add_development_dependency 'simplecov'
|
24
|
+
s.add_development_dependency 'pry', '~> 0.10'
|
25
|
+
|
26
|
+
# Documentation dependencies
|
27
|
+
s.add_development_dependency 'yard'
|
28
|
+
s.add_development_dependency 'markdown'
|
29
|
+
s.add_development_dependency 'thin'
|
30
|
+
|
31
|
+
end
|
metadata
ADDED
@@ -0,0 +1,157 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: stringify-hash
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Puppetlabs
|
8
|
+
- anode
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2015-07-10 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: rspec
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
requirements:
|
18
|
+
- - ~>
|
19
|
+
- !ruby/object:Gem::Version
|
20
|
+
version: '3.0'
|
21
|
+
type: :development
|
22
|
+
prerelease: false
|
23
|
+
version_requirements: !ruby/object:Gem::Requirement
|
24
|
+
requirements:
|
25
|
+
- - ~>
|
26
|
+
- !ruby/object:Gem::Version
|
27
|
+
version: '3.0'
|
28
|
+
- !ruby/object:Gem::Dependency
|
29
|
+
name: rake
|
30
|
+
requirement: !ruby/object:Gem::Requirement
|
31
|
+
requirements:
|
32
|
+
- - ~>
|
33
|
+
- !ruby/object:Gem::Version
|
34
|
+
version: '10.1'
|
35
|
+
type: :development
|
36
|
+
prerelease: false
|
37
|
+
version_requirements: !ruby/object:Gem::Requirement
|
38
|
+
requirements:
|
39
|
+
- - ~>
|
40
|
+
- !ruby/object:Gem::Version
|
41
|
+
version: '10.1'
|
42
|
+
- !ruby/object:Gem::Dependency
|
43
|
+
name: simplecov
|
44
|
+
requirement: !ruby/object:Gem::Requirement
|
45
|
+
requirements:
|
46
|
+
- - ! '>='
|
47
|
+
- !ruby/object:Gem::Version
|
48
|
+
version: '0'
|
49
|
+
type: :development
|
50
|
+
prerelease: false
|
51
|
+
version_requirements: !ruby/object:Gem::Requirement
|
52
|
+
requirements:
|
53
|
+
- - ! '>='
|
54
|
+
- !ruby/object:Gem::Version
|
55
|
+
version: '0'
|
56
|
+
- !ruby/object:Gem::Dependency
|
57
|
+
name: pry
|
58
|
+
requirement: !ruby/object:Gem::Requirement
|
59
|
+
requirements:
|
60
|
+
- - ~>
|
61
|
+
- !ruby/object:Gem::Version
|
62
|
+
version: '0.10'
|
63
|
+
type: :development
|
64
|
+
prerelease: false
|
65
|
+
version_requirements: !ruby/object:Gem::Requirement
|
66
|
+
requirements:
|
67
|
+
- - ~>
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
version: '0.10'
|
70
|
+
- !ruby/object:Gem::Dependency
|
71
|
+
name: yard
|
72
|
+
requirement: !ruby/object:Gem::Requirement
|
73
|
+
requirements:
|
74
|
+
- - ! '>='
|
75
|
+
- !ruby/object:Gem::Version
|
76
|
+
version: '0'
|
77
|
+
type: :development
|
78
|
+
prerelease: false
|
79
|
+
version_requirements: !ruby/object:Gem::Requirement
|
80
|
+
requirements:
|
81
|
+
- - ! '>='
|
82
|
+
- !ruby/object:Gem::Version
|
83
|
+
version: '0'
|
84
|
+
- !ruby/object:Gem::Dependency
|
85
|
+
name: markdown
|
86
|
+
requirement: !ruby/object:Gem::Requirement
|
87
|
+
requirements:
|
88
|
+
- - ! '>='
|
89
|
+
- !ruby/object:Gem::Version
|
90
|
+
version: '0'
|
91
|
+
type: :development
|
92
|
+
prerelease: false
|
93
|
+
version_requirements: !ruby/object:Gem::Requirement
|
94
|
+
requirements:
|
95
|
+
- - ! '>='
|
96
|
+
- !ruby/object:Gem::Version
|
97
|
+
version: '0'
|
98
|
+
- !ruby/object:Gem::Dependency
|
99
|
+
name: thin
|
100
|
+
requirement: !ruby/object:Gem::Requirement
|
101
|
+
requirements:
|
102
|
+
- - ! '>='
|
103
|
+
- !ruby/object:Gem::Version
|
104
|
+
version: '0'
|
105
|
+
type: :development
|
106
|
+
prerelease: false
|
107
|
+
version_requirements: !ruby/object:Gem::Requirement
|
108
|
+
requirements:
|
109
|
+
- - ! '>='
|
110
|
+
- !ruby/object:Gem::Version
|
111
|
+
version: '0'
|
112
|
+
description: ':test == "test"'
|
113
|
+
email:
|
114
|
+
- qe-team@puppetlabs.com
|
115
|
+
executables: []
|
116
|
+
extensions: []
|
117
|
+
extra_rdoc_files: []
|
118
|
+
files:
|
119
|
+
- .gitignore
|
120
|
+
- .rspec
|
121
|
+
- .simplecov
|
122
|
+
- Gemfile
|
123
|
+
- LICENSE
|
124
|
+
- README.md
|
125
|
+
- lib/stringify-hash.rb
|
126
|
+
- lib/version.rb
|
127
|
+
- spec/spec_helper.rb
|
128
|
+
- spec/stringify-hash/stringify-hash_spec.rb
|
129
|
+
- stringify-hash.gemspec
|
130
|
+
homepage: https://github.com/puppetlabs/stringify-hash
|
131
|
+
licenses:
|
132
|
+
- Apache2
|
133
|
+
metadata: {}
|
134
|
+
post_install_message:
|
135
|
+
rdoc_options: []
|
136
|
+
require_paths:
|
137
|
+
- lib
|
138
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
139
|
+
requirements:
|
140
|
+
- - ! '>='
|
141
|
+
- !ruby/object:Gem::Version
|
142
|
+
version: '0'
|
143
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
144
|
+
requirements:
|
145
|
+
- - ! '>='
|
146
|
+
- !ruby/object:Gem::Version
|
147
|
+
version: '0'
|
148
|
+
requirements: []
|
149
|
+
rubyforge_project:
|
150
|
+
rubygems_version: 2.4.5
|
151
|
+
signing_key:
|
152
|
+
specification_version: 4
|
153
|
+
summary: A Ruby Hash that treats symbols and strings interchangeably!
|
154
|
+
test_files:
|
155
|
+
- spec/spec_helper.rb
|
156
|
+
- spec/stringify-hash/stringify-hash_spec.rb
|
157
|
+
has_rdoc:
|