transit-ruby 0.8.467

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 858abe150e0ef0a4aff5aac2c6c51634c64c6ed5
4
+ data.tar.gz: 2f008bd4e87acdb2486ebd26f46f65f2db024d53
5
+ SHA512:
6
+ metadata.gz: 43cfd91c10e42ccc8c6d347a3164cfbe752acf4f23416c484227ecf1bcb61d3249ac0af49e1fb9aec8f23be08e8b749a7e3df8bb66b7b10fbf7ee1257be40e55
7
+ data.tar.gz: 3e2b9036f53e01ebafb276cd115429eb898c7b86d02b9aba0672b288cfcefaadb8bee508c38d235e346f3b5d5c6fc499f30bf10a61dca93f56e5390f19cf3421
checksums.yaml.gz.sig ADDED
@@ -0,0 +1 @@
1
+ �����Drpa�
data.tar.gz.sig ADDED
@@ -0,0 +1 @@
1
+ ��Úߕ�yu&ڌ�d7"5h�u�7O�(!�_�̉�T�6��cz�G3�2Zܬ�9�v���Μe�U9�����s��71Z­�
@@ -0,0 +1 @@
1
+ :tables
data/.yardopts ADDED
@@ -0,0 +1,5 @@
1
+ --markup markdown
2
+ --markup-provider redcarpet
3
+ --plugin redcarpet-ext
4
+ -
5
+ LICENSE
data/LICENSE ADDED
@@ -0,0 +1,202 @@
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.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,167 @@
1
+ transit-ruby
2
+ ===================
3
+
4
+ Transit is a data format and a set of libraries for conveying
5
+ values between applications written in different languages. This
6
+ library provides support for marshalling Transit data to/from Ruby.
7
+
8
+ [Rationale](http://blog.cognitect.com/blog/2014/7/22/transit)<br>
9
+ [API docs](http://rubydoc.info/gems/transit-ruby)<br>
10
+ [Specification](https://github.com/cognitect/transit-format)
11
+
12
+ This implementation's major.minor version number corresponds to the
13
+ version of the Transit specification it supports.
14
+
15
+ _NOTE: Transit is a work in progress and may evolve based on feedback.
16
+ As a result, while Transit is a great option for transferring data
17
+ between applications, it should not yet be used for storing data
18
+ durably over time. This recommendation will change when the
19
+ specification is complete._
20
+
21
+ ## Releases and Dependency Information
22
+
23
+ See https://rubygems.org/gems/transit-ruby
24
+
25
+ ## Install
26
+
27
+ ```sh
28
+ gem install transit-ruby
29
+ ```
30
+
31
+ ## Basic Usage
32
+
33
+ ```ruby
34
+ # io can be any Ruby IO
35
+
36
+ writer = Transit::Writer.new(:json, io) # or :json-verbose, :msgpack
37
+ writer.write(value)
38
+
39
+ reader = Transit::Reader.new(:json, io) # or :msgpack
40
+ reader.read
41
+
42
+ # or
43
+
44
+ reader.read {|val| do_something_with(val)}
45
+ ```
46
+
47
+ For example:
48
+
49
+ ```
50
+ irb(2.1.1): io = StringIO.new('', 'w+')
51
+ ==========> #<StringIO:0x007faab2ec3970>
52
+ irb(2.1.1): writer = Transit::Writer.new(:json, io)
53
+ ==========> #<Transit::Writer:0x007faab2e8c1c8 @marshaler=#<Transit::JsonMarshaler:0x007faab2e1a168..........(snip)..........
54
+ irb(2.1.1): writer.write("abc")
55
+ ==========> nil
56
+ irb(2.1.1): writer.write(123456789012345678901234567890)
57
+ ==========> nil
58
+ irb(2.1.1): io.string
59
+ ==========> "[\"~#'\",\"abc\"]\n[\"~#'\",\"~n123456789012345678901234567890\"]\n"
60
+ irb(2.1.1): reader = Transit::Reader.new(:json, StringIO.new(io.string))
61
+ ==========> #<Transit::Reader:0x007faab2db48e0 @reader=#<Transit::JsonUnmarshaler:0x007faab2dae030 @..........(snip)..........
62
+ irb(2.1.1): reader.read {|val| puts val}
63
+ abc
64
+ 123456789012345678901234567890
65
+ ```
66
+
67
+ ## Custom Handlers
68
+
69
+ ### Custom Write Handlers
70
+
71
+ Implement `tag`, `rep(obj)` and `string_rep(obj)` methods. For example:
72
+
73
+ ```ruby
74
+ require 'ostruct'
75
+ Point = Struct.new(:x,:y) do
76
+ def to_a; [x,y] end
77
+ end
78
+
79
+ class PointWriteHandler
80
+ def tag(_) "point" end
81
+ def rep(o) o.to_a end
82
+ def string_rep(_) nil end
83
+ end
84
+ ```
85
+
86
+ ### Custom Read Handlers
87
+
88
+ Implement `from_rep(rep)` method. For example:
89
+
90
+ ```ruby
91
+ class PointReadHandler
92
+ def from_rep(rep)
93
+ Point.new(*rep)
94
+ end
95
+ end
96
+ ```
97
+
98
+ ### Example Usage
99
+
100
+ ```ruby
101
+ io = StringIO.new('', 'w+')
102
+ writer = Transit::Writer.new(:json, io,
103
+ :handlers => {Point => PointWriteHandler.new})
104
+ writer.write(Point.new(37,42))
105
+
106
+ p io.string.chomp
107
+ #=> "[\"~#point\",[37,42]]"
108
+
109
+ reader = Transit::Reader.new(:json, StringIO.new(io.string),
110
+ :handlers => {"point" => PointReadHandler.new})
111
+ p reader.read
112
+ #=> #<struct Point x=37, y=42>
113
+ ```
114
+
115
+ See
116
+ [Transit::WriteHandlers](http://rubydoc.info/gems/transit-ruby/Transit/WriteHandlers)
117
+ for more info.
118
+
119
+ ## Default Type Mapping
120
+
121
+ |Transit type|Write accepts|Read returns|Example(write)|Example(read)|
122
+ |------------|-------------|------------|--------------|-------------|
123
+ |null|nil|nil|nil|nil|
124
+ |string|String|String|"abc"|"abc"|
125
+ |boolean|true, false|true, false|false|false|
126
+ |integer|Fixnum, Bignum|Fixnum, Bignum|123|123|
127
+ |decimal|Float|Float|123.456|123.456|
128
+ |keyword|Symbol|Symbol|:abc|:abc|
129
+ |symbol|Transit::Symbol|Transit::Symbol|Transit::Symbol.new("foo")|`#<Transit::Symbol "foo">`|
130
+ |big decimal|BigDecimal|BigDecimal|BigDecimal.new("2**64")|`#<BigDecimal:7f9e6d33c558>`|
131
+ |big integer|Fixnum, Bignum|Fixnum, Bignum|2**128|340282366920938463463374607431768211456|
132
+ |time|DateTime, Date, Time|DateTime|DateTime.now|`#<DateTime: 2014-07-15T15:52:27+00:00 ((2456854j,57147s,23000000n),+0s,2299161j)>`|
133
+ |uri|Addressable::URI, URI|Addressable::URI|Addressable::URI.parse("http://example.com")|`#<Addressable::URI:0x3fc0e20390d4 URI:http://example.com>`|
134
+ |uuid|Transit::UUID|Transit::UUID|Transit::UUID.new|`#<Transit::UUID "defa1cce-f70b-4ddb-bb6e-b6ac817d8bc8">`|
135
+ |char|Transit::TaggedValue|String|Transit::TaggedValue.new("c", "a")|"a"|
136
+ |array|Array|Array|[1, 2, 3]|[1, 2, 3]|
137
+ |list|Transit::TaggedValue|Array|Transit::TaggedValue.new("list", [1, 2, 3])|[1, 2, 3]|
138
+ |set|Set|Set|Set.new([1, 2, 3])|`#<Set: {1, 2, 3}>`|
139
+ |map|Hash|Hash|`{a: 1, b: 2, c: 3}`|`{:a=>1, :b=>2, :c=>3}`|
140
+ |bytes|Transit::ByteArray|Transit::ByteArray|Transit::ByteArray.new("base64")|base64|
141
+ |link|Transit::Link|Transit::Link|Transit::Link.new(Addressable::URI.parse("http://example.org/search"), "search")|`#<Transit::Link:0x007f81c405b7f0 @values={"href"=>#<Addressable::URI:0x3fc0e202dfb8 URI:http://example.org/search>, "rel"=>"search", "name"=>nil, "render"=>nil, "prompt"=>nil}>`|
142
+
143
+
144
+ ## Supported Rubies
145
+
146
+ * MRI 1.9.3, 2.0.0, 2.1.0, 2.1.1, 2.1.2
147
+
148
+ ## Contributing
149
+
150
+ This library is open source, developed internally by Cognitect. We welcome discussions of potential problems and enhancement suggestions on the [transit-format mailing list](https://groups.google.com/forum/#!forum/transit-format). Issues can be filed using GitHub [issues](https://github.com/cognitect/transit-ruby/issues) for this project. Because transit is incorporated into products and client projects, we prefer to do development internally and are not accepting pull requests or patches.
151
+
152
+ ## Copyright and License
153
+
154
+ Copyright © 2014 Cognitect
155
+
156
+ Licensed under the Apache License, Version 2.0 (the "License");
157
+ you may not use this file except in compliance with the License.
158
+ You may obtain a copy of the License at
159
+
160
+ http://www.apache.org/licenses/LICENSE-2.0
161
+
162
+ Unless required by applicable law or agreed to in writing, software
163
+ distributed under the License is distributed on an "AS IS" BASIS,
164
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
165
+ implied.
166
+ See the License for the specific language governing permissions and
167
+ limitations under the License.
data/lib/transit.rb ADDED
@@ -0,0 +1,86 @@
1
+ # Copyright 2014 Cognitect. All Rights Reserved.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS-IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+
16
+ # WriteHandlers convert instances of Ruby types to their corresponding Transit
17
+ # semantic types, and ReadHandlers read convert transit values back into instances
18
+ # of Ruby types. transit-ruby ships with default sets of WriteHandlers for each
19
+ # of the Ruby types that map naturally to transit types, and ReadHandlers for each
20
+ # transit type. For the common case, the
21
+ # built-in handlers will suffice, but you can add your own extension types and/or
22
+ # override the built-in handlers.
23
+ #
24
+ # For example, Ruby has Date, Time, and DateTime, each with their
25
+ # own semantics. Transit has an instance type, which does not
26
+ # differentiate between Date and Time, so transit-ruby writes Dates,
27
+ # Times, and DateTimes as transit instances, and reads transit
28
+ # instances as DateTimes. If your application cares that Dates are
29
+ # different from DateTimes, you could register custom write and read
30
+ # handlers, overriding the built-in DateHandler and adding a new DateReadHandler.
31
+ #
32
+ # ```ruby
33
+ # class DateWriteHandler
34
+ # def tag(_) "D" end
35
+ # def rep(o) o.to_s end
36
+ # def string_rep(o) o.to_s end
37
+ # end
38
+ #
39
+ # class DateReadHandler
40
+ # def from_rep(rep)
41
+ # Date.parse(rep)
42
+ # end
43
+ # end
44
+ #
45
+ # io = StringIO.new('','w+')
46
+ # writer = Transit::Writer.new(:json, io, :handlers => {Date => DateWriteHandler.new})
47
+ # writer.write(Date.new(2014,7,22))
48
+ # io.string
49
+ # # => "[\"~#'\",\"~D2014-07-22\"]\n"
50
+ #
51
+ # reader = Transit::Reader.new(:json, StringIO.new(io.string), :handlers => {"D" => DateReadHandler.new})
52
+ # reader.read
53
+ # # => #<Date: 2014-07-22 ((2456861j,0s,0n),+0s,2299161j)>
54
+ # ```
55
+ module Transit
56
+ ESC = "~"
57
+ SUB = "^"
58
+ RES = "`"
59
+ TAG = "~#"
60
+ MAP_AS_ARRAY = "^ "
61
+ TIME_FORMAT = "%FT%H:%M:%S.%LZ"
62
+ QUOTE = "'"
63
+
64
+ MAX_INT = 2**63 - 1
65
+ MIN_INT = -2**63
66
+
67
+ JSON_MAX_INT = 2**53 - 1
68
+ JSON_MIN_INT = -JSON_MAX_INT
69
+ end
70
+
71
+ require 'set'
72
+ require 'time'
73
+ require 'uri'
74
+ require 'base64'
75
+ require 'bigdecimal'
76
+ require 'securerandom'
77
+ require 'forwardable'
78
+ require 'addressable/uri'
79
+ require 'transit/date_time_util'
80
+ require 'transit/transit_types'
81
+ require 'transit/rolling_cache'
82
+ require 'transit/write_handlers'
83
+ require 'transit/read_handlers'
84
+ require 'transit/writer'
85
+ require 'transit/decoder'
86
+ require 'transit/reader'