granola 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b87c4322ddf8aa97dd49c26607172fe2119d681
-  data.tar.gz: 959742990805ff8890d821177d1c70c5804e5c18
+  metadata.gz: 83004a0de438c36e72d1b6e9a42a4247532d54ac
+  data.tar.gz: f393e6a7bc0b330978a89dffdf6bb39aca568716
 SHA512:
-  metadata.gz: 4cbdca00522d796177eaa836f822355fbda7959033b71a1eefaea8ceac9dcf48517fd8395c628cf3ab137fa30433d8e66e7a063eb74a42c88be8560caac63251
-  data.tar.gz: 05a3665f2b5e13385c014de61e6a213520a339ae162159ca4e86f5e753dc506c2ad2d02016119aa016198ae25b5fa56ffac28ec9e6f5ee5f0f08f1f208ba4240
+  metadata.gz: 8b8767a91cfafb4fcbe99475988ae6a4de500eb8c71f08acde98833ebbd1ad7a1805d5b79aa8b43770b45cdd7b03b9517e8452d9c004a29c40b473db9dc4e041
+  data.tar.gz: f97a298c5cbfa89d5ff3d7358fa803347c226f247113174ef28439f39bda9d2cae5505e092cde5d5e03a08e4edd6fa730f7b06ada2adac8d19a315a8efcc28e1

data/lib/granola/json.rb

@@ -0,0 +1,37 @@
+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

data/lib/granola/serializer.rb

@@ -0,0 +1,85 @@
+module Granola
+  # A Serializer describes how to serialize a certain type of object, by
+  # declaring the structure of JSON objects.
+  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.
+    #
+    # Example:
+    #
+    #   serializer = PersonSerializer.list(people)
+    #   serializer.to_json
+    #
+    # Returns a Granola::List.
+    def self.list(ary, *args)
+      List.new(ary, *args, with: self)
+    end
+
+    # Public: Initialize the serializer with a given object.
+    #
+    # object - The domain model that we want to serialize into JSON.
+    def initialize(object)
+      @object = object
+    end
+
+    # Public: Returns a primitive Object that can be serialized into JSON,
+    # meaning one of `nil`, `true`, `false`, a String, a Numeric, an Array of
+    # primitive objects, or a Hash with String keys and primitive objects as
+    # values.
+    #
+    # Raises NotImplementedError unless you override in subclasses.
+    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
+  # objects, wrapping around a specific serializer. The preferred API for this
+  # is to use `Granola::Serializer.list`.
+  #
+  # Example:
+  #
+  #   serializer = Granola::List.new(people, with: PersonSerializer)
+  #   serializer.to_json
+  #
+  # You should use Serializer.list instead of this class.
+  class List < Serializer
+    # Internal: Get the serializer class to use for each item of the list.
+    attr_reader :item_serializer
+
+    # Public: Instantiate a new list serializer.
+    #
+    # list  - An Array-like structure.
+    # *args - Any other arguments that the item serializer takes.
+    #
+    # Keywords:
+    #   with: The subclass of Granola::Serializer to use when serializing
+    #         specific elements in the list.
+    def initialize(list, *args, with: serializer)
+      @item_serializer = with
+      @list = list.map { |obj| @item_serializer.new(obj, *args) }
+    end
+
+    # Public: Returns an Array of Hashes that can be serialized into JSON.
+    def data
+      @list.map(&:data)
+    end
+  end
+end

data/lib/granola/util.rb

@@ -0,0 +1,56 @@
+require "granola/serializer"
+
+module Granola
+  module Util
+    # Public: Returns the serializer object for rendering a specific object. The
+    # class will attempt to be inferred based on the class of the passed object,
+    # but a specific serializer can be passed via a keyword argument `with`.
+    #
+    # object - The Object to serialize.
+    #
+    # Keywords
+    #   with: A specific serializer class to use. If this is `nil`,
+    #         `Util.serializer_class_for` will be used to infer the serializer
+    #         class. This is ignored if `object` is already a Serializer.
+    #
+    # Raises NameError if no specific serializer is provided and we fail to
+    # infer one for this object.
+    #
+    # Returns an instance of a Granola::Serializer subclass.
+    def self.serializer_for(object, with: nil)
+      return object if Granola::Serializer === object
+      serializer_class = with || serializer_class_for(object)
+      method = object.respond_to?(:to_ary) ? :list : :new
+      serializer_class.send(method, object)
+    end
+
+    # Internal: Infers the name of a serializer based on the class of the passed
+    # object. The pattern is the Object's class + "Serializer". So
+    # `PersonSerializer` for `Person`.
+    #
+    # object - An object of a class with a matching serializer.
+    #
+    # 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
+      case object
+      when NilClass, TrueClass, FalseClass, Numeric, String
+        PrimitiveTypesSerializer
+      else
+        raise
+      end
+    end
+
+    # Internal: Null serializer that transparently handles rendering primitive
+    # types.
+    class PrimitiveTypesSerializer < Granola::Serializer
+      def data
+        object
+      end
+    end
+  end
+end

data/lib/granola/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: granola
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Nicolas Sanguinetti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cutest
@@ -49,7 +49,10 @@ 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
 - lib/granola/version.rb
 homepage: http://github.com/foca/granola
 licenses: