granola 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83004a0de438c36e72d1b6e9a42a4247532d54ac
-  data.tar.gz: f393e6a7bc0b330978a89dffdf6bb39aca568716
+  metadata.gz: 889ae25405985efae9deccf2120d07a6c9e18562
+  data.tar.gz: faa849493f9d6e280d370a3e28852e153ac594f3
 SHA512:
-  metadata.gz: 8b8767a91cfafb4fcbe99475988ae6a4de500eb8c71f08acde98833ebbd1ad7a1805d5b79aa8b43770b45cdd7b03b9517e8452d9c004a29c40b473db9dc4e041
-  data.tar.gz: f97a298c5cbfa89d5ff3d7358fa803347c226f247113174ef28439f39bda9d2cae5505e092cde5d5e03a08e4edd6fa730f7b06ada2adac8d19a315a8efcc28e1
+  metadata.gz: f2f705f01edc749d319c9e5a0cdf6eb0689cea3575152e9ba1696138c48a979a4e86d8b5fc5a69079060166162af3bc6efa79219e0ca61f9ff73115bae9aee22
+  data.tar.gz: 3c711e64c563d5c68e18a7e4490c96ad2889ca2d3c9b2147c5c375bdafa04c72082454e5045551c73513398cb5bf6db7d5975eb482c808f0c2703d14bfc6242b

data/README.md

@@ -30,21 +30,16 @@ PersonSerializer.new(person).to_json #=> '{"name":"John Doe",...}'
 
 Granola doesn't make assumptions about your code, so it shouldn't depend on a
 specific JSON backend. It defaults to the native JSON backend, but you're free
-to change it. For example, if you were using [Yajl][]:
+to change it. For example, if you were using [Oj][]:
 
 ``` ruby
-Granola.json = Yajl::Encoder.method(:encode)
+Granola.render :json, via: Oj.method(:dump),
+                      content_type: "application/json"
 ```
 
-If your project already uses [MultiJson][] then we will default to whatever it's
-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)).
+[Oj]: https://github.com/ohler55/oj
 
-[Yajl]: https://github.com/brianmario/yajl-ruby
-[MultiJson]: https://github.com/intridea/multi_json
-
-## Handling lists of models
+## Handling lists of entities
 
 A Granola serializer can handle a list of entities of the same type by using the
 `Serializer.list` method (instead of `Serializer.new`). For example:
@@ -134,17 +129,12 @@ support (via the [msgpack-ruby][] library), you'd do this:
 ``` ruby
 require "msgpack"
 
-class BaseSerializer < Granola::Serializer
-  MIME_TYPES[:msgpack] = "application/x-msgpack".freeze
-
-  def to_msgpack(*)
-    MsgPack.pack(data)
-  end
-end
+Granola.render :msgpack, via: MessagePack.method(:pack),
+                         content_type: "application/x-msgpack"
 ```
 
-Now all serializers that inherit from `BaseSerializer` can be data into
-MsgPack. In order to use this from our Rack helpers, you'd do:
+Now all serializers can be serialized into MsgPack using a `to_msgpack` method.
+In order to use this from our Rack helpers, you'd do:
 
 ``` ruby
 granola(object, as: :msgpack)

data/lib/granola.rb

@@ -1,4 +1,4 @@
 require "granola/version"
 require "granola/serializer"
-require "granola/json"
+require "granola/rendering"
 require "granola/rack"

data/lib/granola/rack.rb

@@ -3,7 +3,6 @@ require "time"
 require "granola/serializer"
 require "granola/util"
 require "granola/caching"
-require "granola/json"
 
 module Granola
   # Mixin to render JSON in the context of a Rack application. See the #json
@@ -51,7 +50,7 @@ module Granola
       headers["Content-Type".freeze] = serializer.mime_type(as)
 
       body = Enumerator.new do |yielder|
-        yielder << serializer.public_send(:"to_#{as}", opts)
+        yielder << serializer.render(as, opts)
       end
 
       [status, headers, body]

data/lib/granola/serializer.rb

@@ -4,12 +4,6 @@ module Granola
   class Serializer
     attr_reader :object
 
-    # Public: Map of the default MIME type for each given type of serialization
-    # for this object. If your API returns a different MIME type for your
-    # responses (for example, `application/vnd.company+json`) you should replace
-    # it here.
-    MIME_TYPES = {}
-
     # Public: Instantiates a list serializer that wraps around an iterable of
     # objects of the type expected by this serializer class.
     #
@@ -39,15 +33,6 @@ module Granola
     def data
       fail NotImplementedError
     end
-
-    # Internal: Returns the MIME type generated by this serializer.
-    #
-    # type - A Symbol describing the expected mime type.
-    #
-    # Returns a String.
-    def mime_type(type = :json)
-      MIME_TYPES.fetch(type)
-    end
   end
 
   # Internal: The List serializer provides an interface for serializing lists of

data/lib/granola/util.rb

@@ -33,20 +33,18 @@ module Granola
     # Raises NameError if no matching class exists.
     # Returns a Class.
     def self.serializer_class_for(object)
-      object = object.respond_to?(:to_ary) ? object.to_ary.fetch(0, nil) : object
-      name = object.class.name
-      Object.const_get("%sSerializer" % name)
-    rescue NameError
+      object = object.respond_to?(:to_ary) ? object.to_ary[0] : object
+
       case object
       when NilClass, TrueClass, FalseClass, Numeric, String
         PrimitiveTypesSerializer
       else
-        raise
+        name = object.class.name
+        Object.const_get("%sSerializer" % name)
       end
     end
 
-    # Internal: Null serializer that transparently handles rendering primitive
-    # types.
+    # Internal: Serializer that transparently handles rendering primitive types.
     class PrimitiveTypesSerializer < Granola::Serializer
       def data
         object

data/lib/granola/version.rb

@@ -1,3 +1,3 @@
 module Granola
-  VERSION = "0.10.1"
+  VERSION = "0.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: granola
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Nicolas Sanguinetti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-01 00:00:00.000000000 Z
+date: 2016-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cutest
@@ -49,7 +49,6 @@ files:
 - README.md
 - lib/granola.rb
 - lib/granola/caching.rb
-- lib/granola/json.rb
 - lib/granola/rack.rb
 - lib/granola/serializer.rb
 - lib/granola/util.rb
@@ -74,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: 'Granola: JSON Serializers for your app.'

data/lib/granola/json.rb

@@ -1,37 +0,0 @@
-require "granola/serializer"
-require "json"
-
-module Granola
-  class << self
-    # Public: Get/Set a Proc that takes an Object and a Hash of options and
-    # returns a JSON String.
-    #
-    # The default implementation uses the standard library's JSON module, but
-    # you're welcome to swap it out.
-    #
-    # Example:
-    #
-    #   require "yajl"
-    #   Granola.json = ->(obj, **opts) { Yajl::Encoder.encode(obj, opts) }
-    attr_accessor :json
-  end
-
-  if defined?(MultiJson)
-    self.json = MultiJson.method(:dump)
-  else
-    self.json = JSON.method(:generate)
-  end
-
-  class Serializer
-    MIME_TYPES[:json] = "application/json".freeze
-
-    # Public: Generate the JSON String.
-    #
-    # **options - Any options to be passed to the `Granola.json` Proc.
-    #
-    # Returns a String.
-    def to_json(**options)
-      Granola.json.(data, options)
-    end
-  end
-end