granola-schema 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 361ab0951c367d4e574849c14618f3706d0b3ee7
-  data.tar.gz: 6c925857257d586bcd8abaf6a83ac147cb7711cf
+  metadata.gz: daabbe93588ef1fbe61574bbf47abed87ec7892f
+  data.tar.gz: e6ad6bc20ea0641593815ce46d347920c16cea22
 SHA512:
-  metadata.gz: 45260d91c3143723a6a52063a1ba3bde5360eac45740951675943a5aaae695637a918f0152ef56fbf67e3c658c0ed963218b6cba3d1882819bc5c24703a51f71
-  data.tar.gz: a38320a37f9f50c9dfb13c386279ed58febf997d5124a13773de94ec782a6c269405b098ecafb42b88736897db5ee3fafbd1d6d585a3aa7f153262b2ddb48207
+  metadata.gz: 0fee957f63aaf9441cda7113acda7b8ab59c6146c979ce69e6697c1500ee009bca583ec604266c9ad558f3241dade963ba1083326c024981d9a8adeea2f89729
+  data.tar.gz: da5b1169178f638a4b79d5de4d9d3898b8d95ab9e2dca7c44ac81342279e18c78681bc8c10e67a6e283556093b805d3ded6520a8d3e5bc83390ee13324b0603b

data/README.md

@@ -1,8 +1,7 @@
-# Granola, a JSON serializer [![Build Status](https://travis-ci.org/foca/granola.svg?branch=master)](https://travis-ci.org/foca/granola)
+# Granola, a JSON serializer [![Build Status](https://img.shields.io/travis/foca/granola.svg)](https://travis-ci.org/foca/granola) [![RubyGem](https://img.shields.io/gem/v/granola.svg)](https://rubygems.org/gems/granola)
 
 ![A tasty bowl of Granola](https://cloud.githubusercontent.com/assets/437/4827156/9e8d33da-5f76-11e4-8574-7803e84845f2.JPG)
 
-
 Granola aims to provide a simple interface to generate JSON responses based on
 your application's domain models. It doesn't make assumptions about anything and
 gets out of your way. You just write plain ruby.
@@ -11,7 +10,7 @@ gets out of your way. You just write plain ruby.
 
 ``` ruby
 class PersonSerializer < Granola::Serializer
-  def serialized
+  def data
     {
       "name" => object.name,
       "email" => object.email,
@@ -38,7 +37,9 @@ Granola.json = Yajl::Encoder.method(:encode)
 ```
 
 If your project already uses [MultiJson][] then we will default to whatever it's
-using, so you shouldn't worry.
+using, so you shouldn't worry. Be warned that using MultiJson instead of
+using a library (such as Yajl) straight away incurs a small performance penalty
+(see, and run, [the benchmark](./benchmarks/multi_json.rb)).
 
 [Yajl]: https://github.com/brianmario/yajl-ruby
 [MultiJson]: https://github.com/intridea/multi_json
@@ -63,10 +64,6 @@ granola(person) #=> This will infer PersonSerializer from a Person instance
 granola(person, with: AnotherSerializer)
 ```
 
-*NOTE* The method relies on being an `env` method that returns the Rack
-environment Hash in the same context where you call the method. See [the
-documentation](./lib/granola/rack.rb) for further details.
-
 This method returns a Rack response tuple that you can use like so (this example
 uses [Cuba][], but similar code will work for other frameworks):
 
@@ -99,7 +96,7 @@ generating the JSON response altogether. For example, using Cuba:
 
 ``` ruby
 class UserSerializer < Granola::Serializer
-  def serialized
+  def data
     { "id" => object.id, "name" => object.name, "email" => object.email }
   end
 
@@ -141,12 +138,12 @@ class BaseSerializer < Granola::Serializer
   MIME_TYPES[:msgpack] = "application/x-msgpack".freeze
 
   def to_msgpack(*)
-    MsgPack.pack(serialized)
+    MsgPack.pack(data)
   end
 end
 ```
 
-Now all serializers that inherit from `BaseSerializer` can be serialized into
+Now all serializers that inherit from `BaseSerializer` can be data into
 MsgPack. In order to use this from our Rack helpers, you'd do:
 
 ``` ruby
@@ -159,5 +156,7 @@ This will set the correct MIME type.
 
 ## License
 
-This project is shared under the MIT license. See the attached LICENSE file for
-details.
+This project is shared under the MIT license. See the attached [LICENSE][] file
+for details.
+
+[LICENSE]: ./LICENSE

data/lib/granola/schema.rb

@@ -1,5 +1,6 @@
 require "json-schema"
-require "granola"
+require "granola/serializer"
+require "granola/json"
 
 module Granola
   class Serializer
@@ -26,7 +27,7 @@ module Granola
       def valid?
         validation_errors.clear
         validation_errors.concat(
-          JSON::Validator.fully_validate(self.class.schema, serialized)
+          JSON::Validator.fully_validate(self.class.schema, data)
         )
         validation_errors.empty?
       end
@@ -52,15 +53,13 @@ module Granola
   #   serializer = SchemaSerializer.new(PersonSerializer.schema)
   #   serializer.to_json
   class SchemaSerializer < Serializer
-    def serialized
+    MIME_TYPES[:json] = "application/schema+json".freeze
+
+    def data
       {
         "$schema".freeze => "http://json-schema.org/schema#".freeze,
         "type".freeze => "object".freeze
       }.merge(object)
     end
-
-    def mime_type
-      "application/schema+json".freeze
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: granola-schema
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Nicolas Sanguinetti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-15 00:00:00.000000000 Z
+date: 2015-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: granola
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement