mixlib-json 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
data/.document ADDED
@@ -0,0 +1,5 @@
1
+ README.rdoc
2
+ lib/**/*.rb
3
+ bin/*
4
+ features/**/*.feature
5
+ LICENSE
data/.gitignore ADDED
@@ -0,0 +1,23 @@
1
+ ## MAC OS
2
+ .DS_Store
3
+
4
+ ## TEXTMATE
5
+ *.tmproj
6
+ tmtags
7
+
8
+ ## EMACS
9
+ *~
10
+ \#*
11
+ .\#*
12
+
13
+ ## VIM
14
+ *.swp
15
+
16
+ ## PROJECT::GENERAL
17
+ coverage
18
+ rdoc
19
+ pkg
20
+ doc
21
+ .yardoc
22
+
23
+ ## PROJECT::SPECIFIC
data/LICENSE ADDED
@@ -0,0 +1,201 @@
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.
data/NOTICE ADDED
@@ -0,0 +1,10 @@
1
+ ============
2
+ Mixlib::JSON Notices
3
+ ============
4
+
5
+ Developed at Opscode (http://www.opscode.com).
6
+
7
+ Contributors and Copyright holders:
8
+
9
+ * Copyright 2010, Opscode <legal@opscode.com>
10
+
data/README.rdoc ADDED
@@ -0,0 +1,57 @@
1
+ = Mixlib::JSON
2
+
3
+ Mixlib::JSON handles choosing a JSON serialization library, and then using that
4
+ library consistently.
5
+
6
+ It has the following preferences:
7
+
8
+ * YAJL-Ruby
9
+ * Json Gem
10
+ * ActiveSupport
11
+
12
+ It will first check to see if any of the above libraries are already loaded in memory - if so, it will use it. If not, it will attempt to load each library in order, and use it for serialzation.
13
+
14
+ The API is simple:
15
+
16
+ require 'mixlib/json'
17
+ Mixlib::JSON.encode({ :one => :two }) # Returns a JSON string
18
+ Mixlib::JSON.pretty({ :one => :two }) # Returns a JSON string, pretty formatted
19
+ Mixlib::JSON.decode('{"one":"two"}') # Decodes a JSON string
20
+
21
+ One feature of this library is that it can handle JSON gem style object
22
+ inflation. If your JSON data contains json_class, the class it refers to
23
+ exists, and it has a from_json class method, we will pass the inflated object
24
+ to that method. To enable this functionality, do the following:
25
+
26
+ Mixlib::JSON.create_objects = true
27
+
28
+ Before you decode a JSON object.
29
+
30
+ == Note on Patches/Pull Requests
31
+
32
+ * Fork the project.
33
+ * Make your feature addition or bug fix.
34
+ * Add tests for it. This is important so I don't break it in a
35
+ future version unintentionally.
36
+ * Commit, do not mess with rakefile, version, or history.
37
+ (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
38
+ * Send me a pull request. Bonus points for topic branches.
39
+
40
+ == Copyright and Licensing
41
+
42
+ Author:: Adam Jacob (<adam@opscode.com>)
43
+ Copyright:: Copyright (c) 2010 Opscode, Inc.
44
+ License:: Apache License, Version 2.0
45
+
46
+ Licensed under the Apache License, Version 2.0 (the "License");
47
+ you may not use this file except in compliance with the License.
48
+ You may obtain a copy of the License at
49
+
50
+ http://www.apache.org/licenses/LICENSE-2.0
51
+
52
+ Unless required by applicable law or agreed to in writing, software
53
+ distributed under the License is distributed on an "AS IS" BASIS,
54
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
55
+ See the License for the specific language governing permissions and
56
+ limitations under the License.
57
+
data/Rakefile ADDED
@@ -0,0 +1,45 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gem|
7
+ gem.name = "mixlib-json"
8
+ gem.summary = %Q{Selects best-available JSON library, and provides a common API.}
9
+ gem.description = %Q{Selects best-available JSON library, and provides a common API.}
10
+ gem.email = "adam@opscode.com"
11
+ gem.homepage = "http://github.com/adamhjk/mixlib-json"
12
+ gem.authors = ["Adam Jacob"]
13
+ gem.add_development_dependency "rspec", ">= 1.2.9"
14
+ gem.add_development_dependency "yard", ">= 0"
15
+ # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
16
+ end
17
+ Jeweler::GemcutterTasks.new
18
+ rescue LoadError
19
+ puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
20
+ end
21
+
22
+ require 'spec/rake/spectask'
23
+ Spec::Rake::SpecTask.new(:spec) do |spec|
24
+ spec.libs << 'lib' << 'spec'
25
+ spec.spec_files = FileList['spec/**/*_spec.rb']
26
+ end
27
+
28
+ Spec::Rake::SpecTask.new(:rcov) do |spec|
29
+ spec.libs << 'lib' << 'spec'
30
+ spec.pattern = 'spec/**/*_spec.rb'
31
+ spec.rcov = true
32
+ end
33
+
34
+ task :spec => :check_dependencies
35
+
36
+ task :default => :spec
37
+
38
+ begin
39
+ require 'yard'
40
+ YARD::Rake::YardocTask.new
41
+ rescue LoadError
42
+ task :yardoc do
43
+ abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
44
+ end
45
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.1.0
@@ -0,0 +1,140 @@
1
+ #
2
+ # Author:: Adam Jacob (<adam@opscode.com>)
3
+ # Copyright:: Copyright (c) 2010 Opscode, Inc.
4
+ # License:: Apache License, Version 2.0
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require 'mixlib/json/yajl'
20
+ require 'mixlib/json/gem'
21
+ require 'mixlib/json/activesupport'
22
+
23
+ module Mixlib
24
+ class JSON
25
+ class << self
26
+ attr_reader :json_obj
27
+
28
+ # If you want to force JSON gem style automatic object creation, set this to true.
29
+ #
30
+ # This means if your JSON has a json_class key with
31
+ # a valid class, and that class responds to
32
+ # from_json, it will have that method called with
33
+ # the JSON object as it's argument.
34
+ #
35
+ # @param [Boolean] Whether to create objects
36
+ def create_objects=(boolean)
37
+ @create_objects = boolean
38
+ end
39
+
40
+ def create_objects
41
+ @create_objects ||= false
42
+ end
43
+
44
+ # Set the order in which you prefer your serializers
45
+ # to be used, if none is already loaded. Should be
46
+ # class names that are children of Mixlib::JSON.
47
+ #
48
+ # Defaults to YAJL, JSON Gem, and ActiveSupport.
49
+ #
50
+ # @param [Array] An array of classes to use.
51
+ def json_load_order=(load_order)
52
+ @json_load_order = load_order
53
+ end
54
+
55
+ def json_load_order
56
+ @json_load_order ||= [
57
+ Mixlib::JSON::YAJL,
58
+ Mixlib::JSON::Gem,
59
+ Mixlib::JSON::ActiveSupport
60
+ ]
61
+ end
62
+
63
+ # Checks to see if a JSON library is already loaded
64
+ # - if it is, we'll use it for serialization.
65
+ #
66
+ # @return [Boolean] true if we loaded a library, false otherwise.
67
+ def detect_loaded_library
68
+ json_library_class = json_load_order.detect { |lib| lib.is_loaded? }
69
+ if json_library_class
70
+ @json_obj = json_library_class.new
71
+ true
72
+ else
73
+ false
74
+ end
75
+ end
76
+
77
+ # First detects if a JSON library is already loaded, and if it is, uses it.
78
+ #
79
+ # If it isn't, uses the json_load_order to select
80
+ # the best available library.
81
+ #
82
+ # @return [Mixlib::JSON::*] An appropriate JSON serialization object.
83
+ # @raises [ArgumentError] If a library cannot be loaded.
84
+ def select_json_library
85
+ unless detect_loaded_library
86
+ json_load_order.each do |lib|
87
+ @json_obj = lib.load
88
+ break if @json_obj
89
+ end
90
+ end
91
+ raise ArgumentError, "Cannot load a json library!" unless @json_obj
92
+ @json_obj
93
+ end
94
+
95
+ # Generates JSON.
96
+ #
97
+ # @param [Object] Generates JSON for this object.
98
+ # @return [JSON] Returns a JSON string.
99
+ def generate(obj)
100
+ select_json_library unless @json_obj
101
+ @json_obj.generate(obj)
102
+ end
103
+
104
+ # Pretty generates JSON.
105
+ #
106
+ # @param [Object] Generates pretty JSON for this object.
107
+ # @return [JSON] Returns a JSON string.
108
+ def pretty(obj)
109
+ select_json_library unless @json_obj
110
+ @json_obj.pretty(obj)
111
+ end
112
+
113
+ # Creates a Ruby object from a JSON string. If
114
+ # create_objects is true, might return a
115
+ # fully-inflated object of the class specified in
116
+ # json_class.
117
+ #
118
+ # @param [String] A JSON string.
119
+ # @return [Object] A ruby object.
120
+ def parse(data)
121
+ select_json_library unless @json_obj
122
+ o = @json_obj.parse(data)
123
+ if @create_objects && o.kind_of?(Hash)
124
+ if o.has_key?("json_class")
125
+ class_name = o["json_class"].split('::').inject(Kernel) do |scope, const_name|
126
+ scope.const_get(const_name)
127
+ end
128
+ if class_name.respond_to?(:from_json)
129
+ return class_name.from_json(o)
130
+ else
131
+ return o
132
+ end
133
+ end
134
+ else
135
+ return o
136
+ end
137
+ end
138
+ end
139
+ end
140
+ end
@@ -0,0 +1,55 @@
1
+ #
2
+ # Author:: Adam Jacob (<adam@opscode.com>)
3
+ # Copyright:: Copyright (c) 2010 Opscode, Inc.
4
+ # License:: Apache License, Version 2.0
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ # This class is kind of brought to you by the department of redundancy
20
+ # department. ActiveSupport uses Yajl, the JSON gem, or YAML behind the
21
+ # scenes.
22
+
23
+ module Mixlib
24
+ class JSON
25
+ class ActiveSupport
26
+ class << self
27
+ def is_loaded?
28
+ Object.const_defined?("ActiveSupport")
29
+ end
30
+
31
+ def load
32
+ begin
33
+ require 'active_support/json'
34
+ self.new
35
+ rescue LoadError
36
+ false
37
+ end
38
+ end
39
+ end
40
+
41
+ def generate(obj)
42
+ ::ActiveSupport::JSON.encode(obj)
43
+ end
44
+
45
+ def pretty(obj)
46
+ ::ActiveSupport::JSON.encode(obj)
47
+ end
48
+
49
+ def parse(obj)
50
+ ::ActiveSupport::JSON.decode(obj)
51
+ end
52
+ end
53
+ end
54
+ end
55
+
@@ -0,0 +1,51 @@
1
+ #
2
+ # Author:: Adam Jacob (<adam@opscode.com>)
3
+ # Copyright:: Copyright (c) 2010 Opscode, Inc.
4
+ # License:: Apache License, Version 2.0
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ module Mixlib
20
+ class JSON
21
+ class Gem
22
+ class << self
23
+ def is_loaded?
24
+ Object.const_defined?("JSON")
25
+ end
26
+
27
+ def load
28
+ begin
29
+ require 'json'
30
+ self.new
31
+ rescue LoadError
32
+ false
33
+ end
34
+ end
35
+ end
36
+
37
+ def generate(obj)
38
+ ::JSON.generate(obj)
39
+ end
40
+
41
+ def pretty(obj)
42
+ ::JSON.pretty_generate(obj)
43
+ end
44
+
45
+ def parse(obj)
46
+ ::JSON.parse(obj)
47
+ end
48
+ end
49
+ end
50
+ end
51
+
@@ -0,0 +1,50 @@
1
+ #
2
+ # Author:: Adam Jacob (<adam@opscode.com>)
3
+ # Copyright:: Copyright (c) 2010 Opscode, Inc.
4
+ # License:: Apache License, Version 2.0
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ module Mixlib
20
+ class JSON
21
+ class YAJL
22
+ class << self
23
+ def is_loaded?
24
+ Object.const_defined?("Yajl")
25
+ end
26
+
27
+ def load
28
+ begin
29
+ require 'yajl'
30
+ self.new
31
+ rescue LoadError
32
+ false
33
+ end
34
+ end
35
+ end
36
+
37
+ def generate(obj)
38
+ Yajl::Encoder.encode(obj)
39
+ end
40
+
41
+ def pretty(obj)
42
+ Yajl::Encoder.encode(obj, { :pretty => true})
43
+ end
44
+
45
+ def parse(obj)
46
+ Yajl::Parser.parse(obj)
47
+ end
48
+ end
49
+ end
50
+ end
@@ -0,0 +1,76 @@
1
+ #
2
+ # Author:: Adam Jacob (<adam@opscode.com>)
3
+ # Copyright:: Copyright (c) 2010 Opscode, Inc.
4
+ # License:: Apache License, Version 2.0
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", '/spec_helper'))
20
+
21
+ describe "Mixlib::JSON::ActiveSupport" do
22
+ describe "is_loaded?" do
23
+ it "should return false if the JSON ActiveSupport hasn't been loaded" do
24
+ # Sigh
25
+ Object.stub!(:const_defined?).with("ActiveSupport").and_return false
26
+ Mixlib::JSON::ActiveSupport.is_loaded?.should == false
27
+ end
28
+
29
+ it "should return true if JSON ActiveSupport is loaded before we are" do
30
+ require 'active_support/json'
31
+ Mixlib::JSON::ActiveSupport.is_loaded?.should == true
32
+ end
33
+ end
34
+
35
+ describe "load" do
36
+ it "should load return a new Mixlib::JSON::ActiveSupport object" do
37
+ Mixlib::JSON::ActiveSupport.load.should be_a_kind_of(Mixlib::JSON::ActiveSupport)
38
+ end
39
+ end
40
+
41
+ describe "generate" do
42
+ before :each do
43
+ Mixlib::JSON::ActiveSupport.load
44
+ @json_obj = Mixlib::JSON::ActiveSupport.new
45
+ end
46
+
47
+ it "should take an object and generate JSON from it" do
48
+ @json_obj.generate({ :one => "two" }).should == '{"one":"two"}'
49
+ end
50
+ end
51
+
52
+ describe "pretty" do
53
+ before :each do
54
+ Mixlib::JSON::ActiveSupport.load
55
+ @json_obj = Mixlib::JSON::ActiveSupport.new
56
+ end
57
+
58
+ it "should take an object and generate JSON from it" do
59
+ @json_obj.pretty({ :one => "two" }).should == '{"one":"two"}'
60
+ end
61
+ end
62
+
63
+ describe "parse" do
64
+ before :each do
65
+ Mixlib::JSON::ActiveSupport.load
66
+ @json_obj = Mixlib::JSON::ActiveSupport.new
67
+ end
68
+
69
+ it "should create a native ruby object from a json string" do
70
+ @json_obj.parse('{"one":"two"}').should == { "one" => "two" }
71
+ end
72
+ end
73
+ end
74
+
75
+
76
+
@@ -0,0 +1,75 @@
1
+ #
2
+ # Author:: Adam Jacob (<adam@opscode.com>)
3
+ # Copyright:: Copyright (c) 2010 Opscode, Inc.
4
+ # License:: Apache License, Version 2.0
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", '/spec_helper'))
20
+
21
+ describe "Mixlib::JSON::Gem" do
22
+ describe "is_loaded?" do
23
+ it "should return false if the JSON gem hasn't been loaded" do
24
+ # Sigh
25
+ Object.stub!(:const_defined?).with("JSON").and_return false
26
+ Mixlib::JSON::Gem.is_loaded?.should == false
27
+ end
28
+
29
+ it "should return true if JSON gem is loaded before we are" do
30
+ require 'json'
31
+ Mixlib::JSON::Gem.is_loaded?.should == true
32
+ end
33
+ end
34
+
35
+ describe "load" do
36
+ it "should load return a new Mixlib::JSON::Gem object" do
37
+ Mixlib::JSON::Gem.load.should be_a_kind_of(Mixlib::JSON::Gem)
38
+ end
39
+ end
40
+
41
+ describe "generate" do
42
+ before :each do
43
+ Mixlib::JSON::Gem.load
44
+ @json_obj = Mixlib::JSON::Gem.new
45
+ end
46
+
47
+ it "should take an object and generate JSON from it" do
48
+ @json_obj.generate({ :one => "two" }).should == '{"one":"two"}'
49
+ end
50
+ end
51
+
52
+ describe "pretty" do
53
+ before :each do
54
+ Mixlib::JSON::Gem.load
55
+ @json_obj = Mixlib::JSON::Gem.new
56
+ end
57
+
58
+ it "should take an object and generate JSON from it" do
59
+ @json_obj.pretty({ :one => "two" }).should == "{\n \"one\": \"two\"\n}"
60
+ end
61
+ end
62
+
63
+ describe "parse" do
64
+ before :each do
65
+ Mixlib::JSON::Gem.load
66
+ @json_obj = Mixlib::JSON::Gem.new
67
+ end
68
+
69
+ it "should create a native ruby object from a json string" do
70
+ @json_obj.parse('{"one":"two"}').should == { "one" => "two" }
71
+ end
72
+ end
73
+ end
74
+
75
+
@@ -0,0 +1,74 @@
1
+ #
2
+ # Author:: Adam Jacob (<adam@opscode.com>)
3
+ # Copyright:: Copyright (c) 2010 Opscode, Inc.
4
+ # License:: Apache License, Version 2.0
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", '/spec_helper'))
20
+
21
+ describe "Mixlib::JSON::YAJL" do
22
+ describe "is_loaded?" do
23
+ it "should return false if YAJL hasn't been loaded" do
24
+ # Sigh
25
+ Object.stub!(:const_defined?).with("Yajl").and_return false
26
+ Mixlib::JSON::YAJL.is_loaded?.should == false
27
+ end
28
+
29
+ it "should return true if YAJL is loaded before we are" do
30
+ require 'yajl'
31
+ Mixlib::JSON::YAJL.is_loaded?.should == true
32
+ end
33
+ end
34
+
35
+ describe "load" do
36
+ it "should load return a new Mixlib::JSON::YAJL object" do
37
+ Mixlib::JSON::YAJL.load.should be_a_kind_of(Mixlib::JSON::YAJL)
38
+ end
39
+ end
40
+
41
+ describe "generate" do
42
+ before :each do
43
+ Mixlib::JSON::YAJL.load
44
+ @json_obj = Mixlib::JSON::YAJL.new
45
+ end
46
+
47
+ it "should take an object and generate JSON from it" do
48
+ @json_obj.generate({ :one => "two" }).should == '{"one":"two"}'
49
+ end
50
+ end
51
+
52
+ describe "pretty" do
53
+ before :each do
54
+ Mixlib::JSON::YAJL.load
55
+ @json_obj = Mixlib::JSON::YAJL.new
56
+ end
57
+
58
+ it "should take an object and generate JSON from it" do
59
+ @json_obj.pretty({ :one => "two" }).should == "{\n \"one\": \"two\"\n}"
60
+ end
61
+ end
62
+
63
+ describe "parse" do
64
+ before :each do
65
+ Mixlib::JSON::YAJL.load
66
+ @json_obj = Mixlib::JSON::YAJL.new
67
+ end
68
+
69
+ it "should create a native ruby object from a json string" do
70
+ @json_obj.parse('{"one":"two"}').should == { "one" => "two" }
71
+ end
72
+ end
73
+ end
74
+
@@ -0,0 +1,67 @@
1
+ require File.expand_path(File.join(File.dirname(__FILE__), "..", '/spec_helper'))
2
+
3
+ describe "Mixlib::JSON" do
4
+ describe "detect_loaded_library" do
5
+ it "should return true if a library is pre-loaded" do
6
+ Mixlib::JSON::YAJL.should_receive(:is_loaded?).and_return(true)
7
+ Mixlib::JSON.detect_loaded_library.should == true
8
+ end
9
+
10
+ it "should set the json_obj to an instance of the pre-loaded libraries serializer" do
11
+ Mixlib::JSON::YAJL.should_receive(:is_loaded?).and_return(true)
12
+ Mixlib::JSON.detect_loaded_library
13
+ Mixlib::JSON.json_obj.should be_a_kind_of(Mixlib::JSON::YAJL)
14
+ end
15
+
16
+ it "should return false if no library is loaded" do
17
+ Mixlib::JSON.json_load_order = []
18
+ Mixlib::JSON.detect_loaded_library.should == false
19
+ end
20
+ end
21
+
22
+ describe "select_json_library" do
23
+ it "Should use the detected library" do
24
+ Mixlib::JSON.should_receive(:detect_loaded_library).and_return(true)
25
+ Mixlib::JSON.should_not_receive(:json_load_order)
26
+ Mixlib::JSON.select_json_library
27
+ end
28
+ end
29
+
30
+ describe "generate" do
31
+ it "should proxy to the real json_obj" do
32
+ Mixlib::JSON::YAJL.load
33
+ Mixlib::JSON.generate({ "one" => "two" }).should == '{"one":"two"}'
34
+ end
35
+ end
36
+
37
+ describe "pretty" do
38
+ it "should proxy to the real json_obj" do
39
+ Mixlib::JSON::YAJL.load
40
+ Mixlib::JSON.pretty({ "one" => "two" }).should == "{\n \"one\": \"two\"\n}"
41
+ end
42
+ end
43
+
44
+ describe "parse" do
45
+ it "should proxy to the real json_obj" do
46
+ Mixlib::JSON::YAJL.load
47
+ Mixlib::JSON.parse('{"one":"two"}').should == { "one" => "two" }
48
+ end
49
+
50
+ class Woobly
51
+ attr_accessor :one
52
+
53
+ def self.from_json(o)
54
+ woobly = Woobly.new
55
+ woobly.one = o["one"]
56
+ woobly
57
+ end
58
+ end
59
+
60
+ it "should honor JSON gem style object creation" do
61
+ Mixlib::JSON.create_objects = true
62
+ o = Mixlib::JSON.parse('{"one":"two","json_class":"Woobly"}')
63
+ o.should be_a_kind_of(Woobly)
64
+ o.one.should == "two"
65
+ end
66
+ end
67
+ end
data/spec/spec.opts ADDED
@@ -0,0 +1 @@
1
+ --color
@@ -0,0 +1,9 @@
1
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
2
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
3
+ require 'mixlib/json'
4
+ require 'spec'
5
+ require 'spec/autorun'
6
+
7
+ Spec::Runner.configure do |config|
8
+
9
+ end
metadata ADDED
@@ -0,0 +1,112 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: mixlib-json
3
+ version: !ruby/object:Gem::Version
4
+ prerelease: false
5
+ segments:
6
+ - 0
7
+ - 1
8
+ - 0
9
+ version: 0.1.0
10
+ platform: ruby
11
+ authors:
12
+ - Adam Jacob
13
+ autorequire:
14
+ bindir: bin
15
+ cert_chain: []
16
+
17
+ date: 2010-09-23 00:00:00 -07:00
18
+ default_executable:
19
+ dependencies:
20
+ - !ruby/object:Gem::Dependency
21
+ name: rspec
22
+ prerelease: false
23
+ requirement: &id001 !ruby/object:Gem::Requirement
24
+ none: false
25
+ requirements:
26
+ - - ">="
27
+ - !ruby/object:Gem::Version
28
+ segments:
29
+ - 1
30
+ - 2
31
+ - 9
32
+ version: 1.2.9
33
+ type: :development
34
+ version_requirements: *id001
35
+ - !ruby/object:Gem::Dependency
36
+ name: yard
37
+ prerelease: false
38
+ requirement: &id002 !ruby/object:Gem::Requirement
39
+ none: false
40
+ requirements:
41
+ - - ">="
42
+ - !ruby/object:Gem::Version
43
+ segments:
44
+ - 0
45
+ version: "0"
46
+ type: :development
47
+ version_requirements: *id002
48
+ description: Selects best-available JSON library, and provides a common API.
49
+ email: adam@opscode.com
50
+ executables: []
51
+
52
+ extensions: []
53
+
54
+ extra_rdoc_files:
55
+ - LICENSE
56
+ - README.rdoc
57
+ files:
58
+ - .document
59
+ - .gitignore
60
+ - LICENSE
61
+ - NOTICE
62
+ - README.rdoc
63
+ - Rakefile
64
+ - VERSION
65
+ - lib/mixlib/json.rb
66
+ - lib/mixlib/json/activesupport.rb
67
+ - lib/mixlib/json/gem.rb
68
+ - lib/mixlib/json/yajl.rb
69
+ - spec/mixlib/json/activesupport_spec.rb
70
+ - spec/mixlib/json/gem_spec.rb
71
+ - spec/mixlib/json/yajl_spec.rb
72
+ - spec/mixlib/json_spec.rb
73
+ - spec/spec.opts
74
+ - spec/spec_helper.rb
75
+ has_rdoc: true
76
+ homepage: http://github.com/adamhjk/mixlib-json
77
+ licenses: []
78
+
79
+ post_install_message:
80
+ rdoc_options:
81
+ - --charset=UTF-8
82
+ require_paths:
83
+ - lib
84
+ required_ruby_version: !ruby/object:Gem::Requirement
85
+ none: false
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ segments:
90
+ - 0
91
+ version: "0"
92
+ required_rubygems_version: !ruby/object:Gem::Requirement
93
+ none: false
94
+ requirements:
95
+ - - ">="
96
+ - !ruby/object:Gem::Version
97
+ segments:
98
+ - 0
99
+ version: "0"
100
+ requirements: []
101
+
102
+ rubyforge_project:
103
+ rubygems_version: 1.3.7
104
+ signing_key:
105
+ specification_version: 3
106
+ summary: Selects best-available JSON library, and provides a common API.
107
+ test_files:
108
+ - spec/mixlib/json_spec.rb
109
+ - spec/mixlib/json/gem_spec.rb
110
+ - spec/mixlib/json/activesupport_spec.rb
111
+ - spec/mixlib/json/yajl_spec.rb
112
+ - spec/spec_helper.rb