cloud_events 0.1.2 → 0.2.0

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 74c0ef2dc5dbf76ff7bf8622bfe06a6204efae852cb0c2357d61593d338f7d39
4
- data.tar.gz: 3c08218a9044b57f688d152e2251d57bdb30053fc118818c0f5311bc4f92c283
3
+ metadata.gz: 352989599792500818d6a7f57d28c131e88abd43f34eadda1a2533ef1407bf0c
4
+ data.tar.gz: edb587ea833390c5ecaeccf17dcf19c17cf5347d4928473deced3830a192433b
5
5
  SHA512:
6
- metadata.gz: 21e5169c373e299326ec652b9db50b0217f2824e252ad200a3d05870d5511b72d1f256b4cf79b6d837724e3613e285bf4c7438313f7e53e0a796a577dc4ecb48
7
- data.tar.gz: 3010f9740a6f9f16464232054ed4adc967987dd40b39a317c0758f272629bca750524cdfb7c757a05b2888936c0d5b23522086099e55b6a22f86ac881b90fb1c
6
+ metadata.gz: a45bae8560267d2f40212f193b2847c24302659699350a06def41c46d4d31a748e3459ef2073d66d9cbca5520598b834c2ddb020507cefd7db45c1b80ccb4ad9
7
+ data.tar.gz: cc19771ab81fed83130ca8114685251a3c9b814490a2232dd903cd6b1d9a4271be23258bdf174723cdeabe86df5c74cba05f511066d75ed92c9a1a19a7a1d72f
@@ -1,5 +1,10 @@
1
1
  # Changelog
2
2
 
3
+ ### v0.2.0 / 2021-01-25
4
+
5
+ * ADDED: Freeze event objects to make them Ractor-shareable
6
+ * DOCS: Fix formatting of Apache license
7
+
3
8
  ### v0.1.2 / 2020-09-02
4
9
 
5
10
  * Fix: Convert extension attributes to strings, and ignore nils
data/LICENSE.md CHANGED
@@ -1,192 +1,191 @@
1
- Apache License
2
- ==============
3
-
4
- * Version 2.0, January 2004
5
- * https://www.apache.org/licenses/
6
-
7
- ### TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
-
9
- 1. **Definitions.**
10
-
11
- "License" shall mean the terms and conditions for use, reproduction,
12
- and distribution as defined by Sections 1 through 9 of this document.
13
-
14
- "Licensor" shall mean the copyright owner or entity authorized by
15
- the copyright owner that is granting the License.
16
-
17
- "Legal Entity" shall mean the union of the acting entity and all
18
- other entities that control, are controlled by, or are under common
19
- control with that entity. For the purposes of this definition,
20
- "control" means (i) the power, direct or indirect, to cause the
21
- direction or management of such entity, whether by contract or
22
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
23
- outstanding shares, or (iii) beneficial ownership of such entity.
24
-
25
- "You" (or "Your") shall mean an individual or Legal Entity
26
- exercising permissions granted by this License.
27
-
28
- "Source" form shall mean the preferred form for making modifications,
29
- including but not limited to software source code, documentation
30
- source, and configuration files.
31
-
32
- "Object" form shall mean any form resulting from mechanical
33
- transformation or translation of a Source form, including but
34
- not limited to compiled object code, generated documentation,
35
- and conversions to other media types.
36
-
37
- "Work" shall mean the work of authorship, whether in Source or
38
- Object form, made available under the License, as indicated by a
39
- copyright notice that is included in or attached to the work
40
- (an example is provided in the Appendix below).
41
-
42
- "Derivative Works" shall mean any work, whether in Source or Object
43
- form, that is based on (or derived from) the Work and for which the
44
- editorial revisions, annotations, elaborations, or other modifications
45
- represent, as a whole, an original work of authorship. For the purposes
46
- of this License, Derivative Works shall not include works that remain
47
- separable from, or merely link (or bind by name) to the interfaces of,
48
- the Work and Derivative Works thereof.
49
-
50
- "Contribution" shall mean any work of authorship, including
51
- the original version of the Work and any modifications or additions
52
- to that Work or Derivative Works thereof, that is intentionally
53
- submitted to Licensor for inclusion in the Work by the copyright owner
54
- or by an individual or Legal Entity authorized to submit on behalf of
55
- the copyright owner. For the purposes of this definition, "submitted"
56
- means any form of electronic, verbal, or written communication sent
57
- to the Licensor or its representatives, including but not limited to
58
- communication on electronic mailing lists, source code control systems,
59
- and issue tracking systems that are managed by, or on behalf of, the
60
- Licensor for the purpose of discussing and improving the Work, but
61
- excluding communication that is conspicuously marked or otherwise
62
- designated in writing by the copyright owner as "Not a Contribution."
63
-
64
- "Contributor" shall mean Licensor and any individual or Legal Entity
65
- on behalf of whom a Contribution has been received by Licensor and
66
- subsequently incorporated within the Work.
67
-
68
- 2. **Grant of Copyright License.** Subject to the terms and conditions of
69
- this License, each Contributor hereby grants to You a perpetual,
70
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71
- copyright license to reproduce, prepare Derivative Works of,
72
- publicly display, publicly perform, sublicense, and distribute the
73
- Work and such Derivative Works in Source or Object form.
74
-
75
- 3. **Grant of Patent License.** Subject to the terms and conditions of
76
- this License, each Contributor hereby grants to You a perpetual,
77
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
- (except as stated in this section) patent license to make, have made,
79
- use, offer to sell, sell, import, and otherwise transfer the Work,
80
- where such license applies only to those patent claims licensable
81
- by such Contributor that are necessarily infringed by their
82
- Contribution(s) alone or by combination of their Contribution(s)
83
- with the Work to which such Contribution(s) was submitted. If You
84
- institute patent litigation against any entity (including a
85
- cross-claim or counterclaim in a lawsuit) alleging that the Work
86
- or a Contribution incorporated within the Work constitutes direct
87
- or contributory patent infringement, then any patent licenses
88
- granted to You under this License for that Work shall terminate
89
- as of the date such litigation is filed.
90
-
91
- 4. **Redistribution.** You may reproduce and distribute copies of the
92
- Work or Derivative Works thereof in any medium, with or without
93
- modifications, and in Source or Object form, provided that You
94
- meet the following conditions:
95
-
96
- * **(a)** You must give any other recipients of the Work or
97
- Derivative Works a copy of this License; and
98
-
99
- * **(b)** You must cause any modified files to carry prominent notices
100
- stating that You changed the files; and
101
-
102
- * **(c)** You must retain, in the Source form of any Derivative Works
103
- that You distribute, all copyright, patent, trademark, and
104
- attribution notices from the Source form of the Work,
105
- excluding those notices that do not pertain to any part of
106
- the Derivative Works; and
107
-
108
- * **(d)** If the Work includes a "NOTICE" text file as part of its
109
- distribution, then any Derivative Works that You distribute must
110
- include a readable copy of the attribution notices contained
111
- within such NOTICE file, excluding those notices that do not
112
- pertain to any part of the Derivative Works, in at least one
113
- of the following places: within a NOTICE text file distributed
114
- as part of the Derivative Works; within the Source form or
115
- documentation, if provided along with the Derivative Works; or,
116
- within a display generated by the Derivative Works, if and
117
- wherever such third-party notices normally appear. The contents
118
- of the NOTICE file are for informational purposes only and
119
- do not modify the License. You may add Your own attribution
120
- notices within Derivative Works that You distribute, alongside
121
- or as an addendum to the NOTICE text from the Work, provided
122
- that such additional attribution notices cannot be construed
123
- as modifying the License.
124
-
125
- You may add Your own copyright statement to Your modifications and
126
- may provide additional or different license terms and conditions
127
- for use, reproduction, or distribution of Your modifications, or
128
- for any such Derivative Works as a whole, provided Your use,
129
- reproduction, and distribution of the Work otherwise complies with
130
- the conditions stated in this License.
131
-
132
- 5. **Submission of Contributions.** Unless You explicitly state otherwise,
133
- any Contribution intentionally submitted for inclusion in the Work
134
- by You to the Licensor shall be under the terms and conditions of
135
- this License, without any additional terms or conditions.
136
- Notwithstanding the above, nothing herein shall supersede or modify
137
- the terms of any separate license agreement you may have executed
138
- with Licensor regarding such Contributions.
139
-
140
- 6. **Trademarks.** This License does not grant permission to use the trade
141
- names, trademarks, service marks, or product names of the Licensor,
142
- except as required for reasonable and customary use in describing the
143
- origin of the Work and reproducing the content of the NOTICE file.
144
-
145
- 7. **Disclaimer of Warranty.** Unless required by applicable law or
146
- agreed to in writing, Licensor provides the Work (and each
147
- Contributor provides its Contributions) on an "AS IS" BASIS,
148
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149
- implied, including, without limitation, any warranties or conditions
150
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151
- PARTICULAR PURPOSE. You are solely responsible for determining the
152
- appropriateness of using or redistributing the Work and assume any
153
- risks associated with Your exercise of permissions under this License.
154
-
155
- 8. **Limitation of Liability.** In no event and under no legal theory,
156
- whether in tort (including negligence), contract, or otherwise,
157
- unless required by applicable law (such as deliberate and grossly
158
- negligent acts) or agreed to in writing, shall any Contributor be
159
- liable to You for damages, including any direct, indirect, special,
160
- incidental, or consequential damages of any character arising as a
161
- result of this License or out of the use or inability to use the
162
- Work (including but not limited to damages for loss of goodwill,
163
- work stoppage, computer failure or malfunction, or any and all
164
- other commercial damages or losses), even if such Contributor
165
- has been advised of the possibility of such damages.
166
-
167
- 9. **Accepting Warranty or Additional Liability.** While redistributing
168
- the Work or Derivative Works thereof, You may choose to offer,
169
- and charge a fee for, acceptance of support, warranty, indemnity,
170
- or other liability obligations and/or rights consistent with this
171
- License. However, in accepting such obligations, You may act only
172
- on Your own behalf and on Your sole responsibility, not on behalf
173
- of any other Contributor, and only if You agree to indemnify,
174
- defend, and hold each Contributor harmless for any liability
175
- incurred by, or claims asserted against, such Contributor by reason
176
- of your accepting any such warranty or additional liability.
177
-
178
- _END OF TERMS AND CONDITIONS_
179
-
180
- ### APPENDIX: How to apply the Apache License to your work.
181
-
182
- To apply the Apache License to your work, attach the following
183
- boilerplate notice, with the fields enclosed by brackets "`[]`"
184
- replaced with your own identifying information. (Don't include
185
- the brackets!) The text should be enclosed in the appropriate
186
- comment syntax for the file format. We also recommend that a
187
- file or class name and description of purpose be included on the
188
- same "printed page" as the copyright notice for easier
189
- identification within third-party archives.
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
190
189
 
191
190
  Copyright [yyyy] [name of copyright owner]
192
191
 
@@ -194,7 +193,7 @@ identification within third-party archives.
194
193
  you may not use this file except in compliance with the License.
195
194
  You may obtain a copy of the License at
196
195
 
197
- https://www.apache.org/licenses/LICENSE-2.0
196
+ http://www.apache.org/licenses/LICENSE-2.0
198
197
 
199
198
  Unless required by applicable law or agreed to in writing, software
200
199
  distributed under the License is distributed on an "AS IS" BASIS,
data/README.md CHANGED
@@ -188,33 +188,24 @@ Releases can be performed only by users with write access to the repository.
188
188
 
189
189
  To perform a release:
190
190
 
191
- 1. Update `lib/cloud_events/version.rb` with the new release version.
191
+ 1. Go to the GitHub Actions tab, and launch the "Request Release" workflow.
192
+ You can leave the input field blank.
192
193
 
193
- 2. Add an entry to `CHANGELOG.md`. The changelog entry _must_ be headed by
194
- the version and release date, and _must_ be consistent with the format of
195
- previous entries.
194
+ 2. The workflow will analyze the commit messages since the last release, and
195
+ open a pull request with a new version and a changelog entry. You can
196
+ optionally edit this pull request to modify the changelog or change the
197
+ version released.
196
198
 
197
- 3. Ensure the above changes are pushed to the GitHub master branch at
198
- https://github.com/cloudevents/sdk-ruby.
199
+ 3. Merge the pull request (keeping the `release: pending` label set.) Once the
200
+ CI tests have run successfully, a job will run automatically to perform the
201
+ release, including tagging the commit in git, building and releasing a gem,
202
+ and building and pushing documentation.
199
203
 
200
- 4. Execute
204
+ These tasks can also be performed manually by running the appropriate scripts
205
+ locally. See `toys release request --help` and `toys release perform --help`
206
+ for more information.
201
207
 
202
- ```sh
203
- toys release trigger $VERSION
204
- ```
205
-
206
- where `$VERSION` is the version number (e.g. `0.1.0`). This script will
207
- verify the version and changelog and will not proceed unless they are
208
- correctly formatted and the master branch is up to date. It will also check
209
- that all GitHub checks against the current commit have succeeded. If these
210
- checks pass, the script will create and push a release tag.
211
-
212
- 5. A GitHub action will then perform the release within a few minutes. The
213
- [GitHub actions dashboard](https://github.com/cloudevents/sdk-ruby/actions?query=workflow%3A%22CloudEvents+Release%22)
214
- will provide status information on the release workflow.
215
-
216
- If the release workflow fails, fix the problem, and then you will need to
217
- delete the release tag manually before triggering the release again.
208
+ If a release fails, you may need to delete the release tag before retrying.
218
209
 
219
210
  ### For more information
220
211
 
@@ -14,6 +14,8 @@ module CloudEvents
14
14
  # can, and fill the rest with defaults as recommended in RFC 2045 sec 5.2.
15
15
  # In case of a parsing error, the {#error_message} field will be set.
16
16
  #
17
+ # This object is immutable, and Ractor-shareable on Ruby 3.
18
+ #
17
19
  class ContentType
18
20
  ##
19
21
  # Parse the given header value.
@@ -31,6 +33,7 @@ module CloudEvents
31
33
  parse consume_comments string.strip
32
34
  @canonical_string = "#{@media_type}/#{@subtype}" +
33
35
  @params.map { |k, v| "; #{k}=#{maybe_quote v}" }.join
36
+ full_freeze
34
37
  end
35
38
 
36
39
  ##
@@ -204,5 +207,17 @@ module CloudEvents
204
207
  str = str.gsub("\\", "\\\\\\\\").gsub("\"", "\\\\\"")
205
208
  "\"#{str}\""
206
209
  end
210
+
211
+ def full_freeze
212
+ instance_variables.each do |iv|
213
+ instance_variable_get(iv).freeze
214
+ end
215
+ @params.each do |name_val|
216
+ name_val[0].freeze
217
+ name_val[1].freeze
218
+ name_val.freeze
219
+ end
220
+ freeze
221
+ end
207
222
  end
208
223
  end
@@ -50,6 +50,11 @@ module CloudEvents
50
50
  # `spec_version`, the remaining keyword arguments will be passed
51
51
  # through to the {CloudEvents::Event::V1} constructor.
52
52
  #
53
+ # Note that argument objects passed in may get deep-frozen if they are
54
+ # used in the final event object. This is particularly important for the
55
+ # `:data` field, for example if you pass a structured hash. If this is an
56
+ # issue, make a deep copy of objects before passing them to this method.
57
+ #
53
58
  # @param spec_version [String] The required `specversion` field.
54
59
  # @param kwargs [keywords] Additional parameters for the event.
55
60
  #
@@ -15,10 +15,10 @@ module CloudEvents
15
15
 
16
16
  def finish_attributes
17
17
  @args.each do |key, value|
18
- @attributes[key] = value.to_s unless value.nil?
18
+ @attributes[key.freeze] = value.to_s.freeze unless value.nil?
19
19
  end
20
20
  @args = {}
21
- @attributes
21
+ @attributes.freeze
22
22
  end
23
23
 
24
24
  def string keys, required: false
@@ -102,7 +102,7 @@ module CloudEvents
102
102
  end
103
103
  end
104
104
 
105
- UNDEFINED = ::Object.new
105
+ UNDEFINED = ::Object.new.freeze
106
106
 
107
107
  def object keys, required: false, allow_nil: false
108
108
  value = UNDEFINED
@@ -117,15 +117,35 @@ module CloudEvents
117
117
  end
118
118
  if block_given?
119
119
  converted, raw = yield value
120
+ deep_freeze converted
120
121
  else
121
122
  converted = raw = value
122
123
  end
123
- @attributes[keys.first] = raw
124
+ @attributes[keys.first.freeze] = raw.freeze
124
125
  converted
125
126
  end
126
127
 
127
128
  private
128
129
 
130
+ def deep_freeze obj
131
+ case obj
132
+ when ::Hash
133
+ obj.each do |key, val|
134
+ deep_freeze key
135
+ deep_freeze val
136
+ end
137
+ when ::Array
138
+ obj.each do |val|
139
+ deep_freeze val
140
+ end
141
+ else
142
+ obj.instance_variables.each do |iv|
143
+ deep_freeze obj.instance_variable_get iv
144
+ end
145
+ end
146
+ obj.freeze
147
+ end
148
+
129
149
  def keys_to_strings hash
130
150
  result = {}
131
151
  hash.each do |key, val|
@@ -16,9 +16,10 @@ module CloudEvents
16
16
  # their own accessor methods that may return typed objects (such as
17
17
  # `DateTime` for the `time` attribute).
18
18
  #
19
- # This object is immutable. The data and attribute values can be
20
- # retrieved but not modified. To obtain an event with modifications, use
21
- # the {#with} method to create a copy with the desired changes.
19
+ # This object is immutable, and Ractor-shareable on Ruby 3. The data and
20
+ # attribute values can be retrieved but not modified. To obtain an event
21
+ # with modifications, use the {#with} method to create a copy with the
22
+ # desired changes.
22
23
  #
23
24
  # See https://github.com/cloudevents/spec/blob/v0.3/spec.md for
24
25
  # descriptions of the standard attributes.
@@ -59,6 +60,11 @@ module CloudEvents
59
60
  # They are not available as separate methods, but can be accessed via
60
61
  # the {Event::V1#[]} operator.
61
62
  #
63
+ # Note that attribute objects passed in may get deep-frozen if they are
64
+ # used in the final event object. This is particularly important for the
65
+ # `:data` field, for example if you pass a structured hash. If this is an
66
+ # issue, make a deep copy of objects before passing to this constructor.
67
+ #
62
68
  # @param attributes [Hash] The data and attributes, as a hash.
63
69
  # @param args [keywords] The data and attributes, as keyword arguments.
64
70
  #
@@ -75,6 +81,7 @@ module CloudEvents
75
81
  @subject = interpreter.string ["subject"]
76
82
  @time = interpreter.rfc3339_date_time ["time"]
77
83
  @attributes = interpreter.finish_attributes
84
+ freeze
78
85
  end
79
86
 
80
87
  ##
@@ -113,7 +120,8 @@ module CloudEvents
113
120
  end
114
121
 
115
122
  ##
116
- # Return a hash representation of this event.
123
+ # Return a hash representation of this event. The returned hash is an
124
+ # unfrozen copy. Modifications do not affect the original event.
117
125
  #
118
126
  # @return [Hash]
119
127
  #
@@ -214,7 +222,7 @@ module CloudEvents
214
222
 
215
223
  ## @private
216
224
  def hash
217
- @hash ||= @attributes.hash
225
+ @attributes.hash
218
226
  end
219
227
  end
220
228
  end
@@ -16,9 +16,10 @@ module CloudEvents
16
16
  # their own accessor methods that may return typed objects (such as
17
17
  # `DateTime` for the `time` attribute).
18
18
  #
19
- # This object is immutable. The data and attribute values can be
20
- # retrieved but not modified. To obtain an event with modifications, use
21
- # the {#with} method to create a copy with the desired changes.
19
+ # This object is immutable, and Ractor-shareable on Ruby 3. The data and
20
+ # attribute values can be retrieved but not modified. To obtain an event
21
+ # with modifications, use the {#with} method to create a copy with the
22
+ # desired changes.
22
23
  #
23
24
  # See https://github.com/cloudevents/spec/blob/v1.0/spec.md for
24
25
  # descriptions of the standard attributes.
@@ -56,6 +57,11 @@ module CloudEvents
56
57
  # They are not available as separate methods, but can be accessed via
57
58
  # the {Event::V1#[]} operator.
58
59
  #
60
+ # Note that attribute objects passed in may get deep-frozen if they are
61
+ # used in the final event object. This is particularly important for the
62
+ # `:data` field, for example if you pass a structured hash. If this is an
63
+ # issue, make a deep copy of objects before passing to this constructor.
64
+ #
59
65
  # @param attributes [Hash] The data and attributes, as a hash.
60
66
  # @param args [keywords] The data and attributes, as keyword arguments.
61
67
  #
@@ -71,6 +77,7 @@ module CloudEvents
71
77
  @subject = interpreter.string ["subject"]
72
78
  @time = interpreter.rfc3339_date_time ["time"]
73
79
  @attributes = interpreter.finish_attributes
80
+ freeze
74
81
  end
75
82
 
76
83
  ##
@@ -109,7 +116,8 @@ module CloudEvents
109
116
  end
110
117
 
111
118
  ##
112
- # Return a hash representation of this event.
119
+ # Return a hash representation of this event. The returned hash is an
120
+ # unfrozen copy. Modifications do not affect the original event.
113
121
  #
114
122
  # @return [Hash]
115
123
  #
@@ -201,7 +209,7 @@ module CloudEvents
201
209
 
202
210
  ## @private
203
211
  def hash
204
- @hash ||= @attributes.hash
212
+ @attributes.hash
205
213
  end
206
214
  end
207
215
  end
@@ -5,5 +5,5 @@ module CloudEvents
5
5
  # Version of the Ruby CloudEvents SDK
6
6
  # @return [String]
7
7
  #
8
- VERSION = "0.1.2"
8
+ VERSION = "0.2.0"
9
9
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cloud_events
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.2
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Daniel Azuma
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-09-02 00:00:00.000000000 Z
11
+ date: 2021-01-25 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: The official Ruby implementation of the CloudEvents Specification. Provides
14
14
  data types for events, and HTTP/JSON bindings for marshalling and unmarshalling
@@ -37,10 +37,10 @@ homepage: https://github.com/cloudevents/sdk-ruby
37
37
  licenses:
38
38
  - Apache-2.0
39
39
  metadata:
40
- changelog_uri: https://cloudevents.github.io/sdk-ruby/v0.1.2/file.CHANGELOG.html
40
+ changelog_uri: https://cloudevents.github.io/sdk-ruby/v0.2.0/file.CHANGELOG.html
41
41
  source_code_uri: https://github.com/cloudevents/sdk-ruby
42
42
  bug_tracker_uri: https://github.com/cloudevents/sdk-ruby/issues
43
- documentation_uri: https://cloudevents.github.io/sdk-ruby/v0.1.2
43
+ documentation_uri: https://cloudevents.github.io/sdk-ruby/v0.2.0
44
44
  post_install_message:
45
45
  rdoc_options: []
46
46
  require_paths:
@@ -56,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
56
56
  - !ruby/object:Gem::Version
57
57
  version: '0'
58
58
  requirements: []
59
- rubygems_version: 3.1.2
59
+ rubygems_version: 3.1.4
60
60
  signing_key:
61
61
  specification_version: 4
62
62
  summary: Ruby SDK for CloudEvents