Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add README content, LICENSE and CHANGELOG stub

  • Loading branch information...
commit b6562036f9f0ba8f85c53bfd9f8671e2d2975e1a 1 parent 7146a4a
@sirthias sirthias authored
Showing with 384 additions and 2 deletions.
  1. +3 −0  CHANGELOG
  2. +201 −0 LICENSE
  3. +180 −2 README.markdown
View
3  CHANGELOG
@@ -0,0 +1,3 @@
+Version 1.0.0 (2011-xx-xx)
+--------------------------
+first public release
View
201 LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
View
182 README.markdown
@@ -1,3 +1,181 @@
-## _spray_ JSON
+## _spray-json_
-(coming soon)
+_spray-json_ is a lightweight, clean and simple [JSON][] implementation in Scala.
+
+It sports the following features:
+
+* Simple immutable model of the JSON language elements
+* An efficient JSON PEG parser (implemented with [parboiled][])
+* Choice of either compact or pretty JSON to-string-printing
+* Type-class based (de)serialization of custom objects (no reflection, no intrusion)
+
+
+### Installation
+
+_spray-json_ is available from the [scala-tools.org][] respositories.
+There is no official release yet, but the current snapshot is `1.0-SNAPSHOT`.
+If you use SBT you can include it in your project with
+
+ val sprayJsonModuleConfig = ModuleConfiguration("cc.spray", ScalaToolsSnapshots)
+ val sprayJson = "cc.spray" %% "spray-json" % "1.0.0-SNAPSHOT" % "compile" withSources()
+
+_spray-json_ has only one dependency: the parsing library [parboiled][] (which is also a dependency of _spray-server_ and _spray_client_, so if you use _spray-json_ with either of them you are not incurring any additional dependency).
+
+
+### Usage
+
+_spray-json_ is really easy to use.
+Just bring all relevant elements in scope with
+
+ import cc.spray.json._
+
+and do one or more of the following things:
+
+1. Parse a JSON string into it's Abstract Syntax Tree (AST) representation
+
+ val json = """{ "some": "JSON source" }"""
+ val jsonAst = JsonParser(json)
+
+2. Print a JSON AST back to a String using either the `CompactPrinter` or the `PrettyPrinter`
+
+ val json = PrettyPrinter(jsonAst)
+
+3. Convert any Scala object to a JSON AST using the pimped "toJson" method
+
+ val jsonAst = List(1, 2, 3).toJson
+
+4. Convert a JSON AST to a Scala object with the "fromJson" method
+
+ val myObject = jsonAst.fromJson[MyObjectType]
+
+ or
+
+ val myObject: MyObjectType = jsonAst.fromJson
+
+
+In order to make steps 3 and 4 work for an object of type `T` you need to bring implicit values in scope that
+provide `JsonFormat[T]`s for `T` and all types used by `T` (directly or indirectly).
+The way you normally do this is via a "JsonProtocol".
+
+
+### JsonProtocol
+
+_spray-json_ uses [SJSON][]s Scala-idiomatic type-class based approach to connect an existing type `T` with the information how to (de)serialize its instances to and from JSON. (In fact _spray-json_ even reuses [SJSON][] code, see the 'Credits' section below).
+
+This approach has the advantage of not requiring any change (or even access) to `T`s source code. All (de)serialization
+logic is attached 'from the outside'. There is no reflection involved, so the resulting conversions are fast. Scalas excellent type inference reduces verbosity and boilerplate to a minimum, while the Scala compiler will make sure at compile time that you provided all required (de)serialization logic.
+
+In _spray-jsons_ terminology a 'JsonProtocol' is nothing but a bunch of implicit values of type `JsonFormat[T]`, whereby each `JsonFormat[T]` contains the logic of how to convert instance of `T` to and from JSON. All `JsonFormat[T]`s of a protocol need to be "MECE" (mutually exclusive, collectively exhaustive), i.e. they are not allowed to overlap and together need to span all types required by the application.
+
+This may sound more complicated than it is.
+_spray-json_ comes with a `DefaultJsonProtocol` which already covers all of Scalas value types as well as the most important reference and collection types. As long as your code uses nothing more than these you only need the `DefaultJsonProtocol`.
+Here are the types already taken care off by the `DefaultJsonProtocol`:
+
+* Byte, Short, Int, Long, Float, Double, Char, Unit, Boolean
+* String, Symbol
+* BigInt, BigDecimal
+* Option, Tuple1 - Tuple7
+* List, Array, immutable.Map, immutable.Set, mutable.Set
+
+In most cases however you'll also want to convert types not covered by the `DefaultJsonProtocol`. In these cases you need to provide `JsonFormat[T]`s for your custom types. This is not hard at all.
+
+
+### Providing JsonFormats for Case Classes
+
+If your custom type `T` is a case class then augmenting the `DefaultJsonProtocol` with a `JsonFormat[T]` is really easy:
+
+ case class Color(name: String, red: Int, green: Int, blue: Int)
+
+ object MyJsonProtocol extends DefaultJsonProtocol {
+ implicit val colorFormat = jsonFormat(Color, "name", "red", "green", "blue")
+ }
+
+ import MyJsonProtocol._
+
+ val json = Color("CadetBlue", 95, 158, 160).toJson
+ val color = json.fromJson[Color]
+
+The `jsonFormat` method reduces the boilerplate to a minimum, just pass it the companion object of your case class as well as the field names (in order) and it will return a ready-to-use `JsonFormat` for your type.
+
+
+### Providing JsonFormats for other Types
+
+Of course you can also supply (de)serialization logic for types that aren't case classes.
+Here is one way to do it:
+
+ class Color(val name: String, val red: Int, val green: Int, val blue: Int)
+
+ object MyJsonProtocol extends DefaultJsonProtocol {
+ implicit object ColorJsonFormat extends JsonFormat[Color] {
+ def write(c: Color) = {
+ JsArray(JsString(c.name), JsNumber(c.red), JsNumber(c.green), JsNumber(c.blue))
+ }
+ def read(value: JsValue) = value match {
+ case JsArray(JsString(name) :: JsNumber(red) :: JsNumber(green) :: JsNumber(blue) :: Nil) => {
+ new Color(name, red.toInt, green.toInt, blue.toInt)
+ }
+ case _ => throw new DeserializationException("Color expected")
+ }
+ }
+ }
+
+ import MyJsonProtocol._
+
+ val json = Color("CadetBlue", 95, 158, 160).toJson
+ val color = json.fromJson[Color]
+
+This serializes `Color` instances as a JSON array, which is compact but does not make the elements semantics explicit.
+You need to know that the color components are ordered "red, green, blue".
+
+Another way would be to serialize `Color`s as JSON objects:
+
+ object MyJsonProtocol extends DefaultJsonProtocol {
+ implicit object ColorJsonFormat extends JsonFormat[Color] {
+ def write(c: Color) = JsObject(
+ JsField("name", c.name),
+ JsField("red", c.red),
+ JsField("green", c.green),
+ JsField("blue", c.blue)
+ )
+ def read(value: JsValue) = value match {
+ case JsObject(
+ JsField("name", JsString(name)),
+ JsField("red", JsNumber(red)),
+ JsField("green", JsNumber(green)),
+ JsField("blue", JsNumber(blue))
+ ) => {
+ new Color(name.value, red.value.toInt, green.value.toInt, blue.value.toInt)
+ }
+ case _ => throw new DeserializationException("Color expected")
+ }
+ }
+ }
+
+This is a bit more verbose in its definition and the resulting JSON but transports the field semantics over to the JSON side.
+Note that this is the approach _spray-json_ uses for case classes.
+
+
+### Credits
+
+Most of type-class (de)serialization code is nothing but a polished copy of what **Debasish Ghosh** made available
+with his [SJSON library][]. These code parts therefore bear his copyright.
+Additionally the JSON AST model is heavily inspired by the one from [Databinder-Dispatch][] by **Nathan Hamblen**.
+
+
+### License
+
+_spray-json_ is licensed under [APL 2.0][].
+
+
+### Patch Policy
+
+Feedback and contributions to the project, no matter what kind, are always very welcome.
+However, patches can only be accepted from their original author.
+Along with any patches, please state that the patch is your original work and that you license the work to the pegdown project under the project’s open source license.
+
+
+ [parboiled]: http://parboiled.org
+ [scala-tools.org]: http://scala-tools.org
+ [SJSON]: https://github.com/debasishg/sjson
+ [Databinder-Dispatch]: https://github.com/n8han/Databinder-Dispatch
+ [APL 2.0]: http://www.apache.org/licenses/LICENSE-2.0
Please sign in to comment.
Something went wrong with that request. Please try again.