Refactor renderer. (#21)

* Fix yarddoc in lib/jsonapi/renderer.rb.

* Make JSONAPI::Renderer an actual class.

* Make tests use the JSONAPI::Renderer class directly.

Author: beauby

lib/jsonapi/renderer.rb

@@ -1,25 +1,32 @@
 require 'jsonapi/renderer/document'
 
 module JSONAPI
+  class Renderer
+    # Render a JSON API document.
+    #
+    # @param params [Hash]
+    #   @option data [(#jsonapi_id, #jsonapi_type, #jsonapi_related, #as_jsonapi),
+    #           Array<(#jsonapi_id, #jsonapi_type, #jsonapi_related,
+    #           #as_jsonapi)>,
+    #           nil] Primary resource(s) to be rendered.
+    #   @option errors [Array<#jsonapi_id>] Errors to be rendered.
+    #   @option include Relationships to be included. See
+    #     JSONAPI::IncludeDirective.
+    #   @option fields [Hash{Symbol, Array<Symbol>}, Hash{String, Array<String>}]
+    #     List of requested fields for some or all of the resource types.
+    #   @option meta [Hash] Non-standard top-level meta information to be
+    #     included.
+    #   @option links [Hash] Top-level links to be included.
+    #   @option jsonapi_object [Hash] JSON API object.
+    def render(params)
+      Document.new(params).to_hash
+    end
+  end
+
   module_function
 
-  # Render a JSON API document.
-  #
-  # @param [Hash] params
-  #   @option [(#jsonapi_id, #jsonapi_type, #jsonapi_related, #as_jsonapi),
-  #           Array<(#jsonapi_id, #jsonapi_type, #jsonapi_related,
-  #           #as_jsonapi)>,
-  #           nil] data Primary resource(s) to be rendered.
-  #   @option [Array<#jsonapi_id>] errors Errors to be rendered.
-  #   @option include Relationships to be included. See
-  #     JSONAPI::IncludeDirective.
-  #   @option [Hash{Symbol, Array<Symbol>}, Hash{String, Array<String>}] fields
-  #     List of requested fields for some or all of the resource types.
-  #   @option [Hash] meta Non-standard top-level meta information to be
-  #     included.
-  #   @option [Hash] links Top-level links to be included.
-  #   @option [Hash] jsonapi_object JSON API object.
+  # @see JSONAPI::Renderer#render
   def render(params)
-    Renderer::Document.new(params).to_hash
+    Renderer.new.render(params)
   end
 end

lib/jsonapi/renderer/document.rb

@@ -2,7 +2,7 @@
 require 'jsonapi/renderer/resources_processor'
 
 module JSONAPI
-  module Renderer
+  class Renderer
     class Document
       def initialize(params = {})
         @data    = params.fetch(:data,    :no_data)

lib/jsonapi/renderer/resources_processor.rb

@@ -1,7 +1,7 @@
 require 'set'
 
 module JSONAPI
-  module Renderer
+  class Renderer
     class ResourcesProcessor
       def initialize(resources, include, fields)
         @resources = resources

spec/renderer_spec.rb

@@ -119,7 +119,7 @@ def as_jsonapi(options = {})
   end
 end
 
-describe JSONAPI, '#render' do
+describe JSONAPI::Renderer, '#render' do
   before(:all) do
     @users = [
       UserResource.new(1, 'User 1', '123 Example st.', []),
@@ -137,7 +137,7 @@ def as_jsonapi(options = {})
   end
 
   it 'renders nil' do
-    actual = JSONAPI.render(data: nil)
+    actual = subject.render(data: nil)
     expected = {
       data: nil
     }
@@ -146,7 +146,7 @@ def as_jsonapi(options = {})
   end
 
   it 'renders an empty array' do
-    actual = JSONAPI.render(data: [])
+    actual = subject.render(data: [])
     expected = {
       data: []
     }
@@ -155,7 +155,7 @@ def as_jsonapi(options = {})
   end
 
   it 'renders a single resource' do
-    actual = JSONAPI.render(data: @users[0])
+    actual = subject.render(data: @users[0])
     expected = {
       data: {
         type: 'users',
@@ -193,7 +193,7 @@ def as_jsonapi(options = {})
   end
 
   it 'renders a collection of resources' do
-    actual = JSONAPI.render(data: [@users[0],
+    actual = subject.render(data: [@users[0],
                                    @users[1]])
     expected = {
       data: [
@@ -264,7 +264,7 @@ def as_jsonapi(options = {})
   end
 
   it 'renders included relationships' do
-    actual = JSONAPI.render(data: @users[0],
+    actual = subject.render(data: @users[0],
                             include: 'posts')
     expected = {
       data: {
@@ -325,7 +325,7 @@ def as_jsonapi(options = {})
   end
 
   it 'filters out fields' do
-    actual = JSONAPI.render(data: @users[0],
+    actual = subject.render(data: @users[0],
                             fields: { users: [:name] })
     expected = {
       data: {
@@ -347,7 +347,7 @@ def as_jsonapi(options = {})
   end
 
   it 'renders a toplevel meta' do
-    actual = JSONAPI.render(data: nil,
+    actual = subject.render(data: nil,
                             meta: { this: 'is_meta' })
     expected = {
       data: nil,
@@ -358,7 +358,7 @@ def as_jsonapi(options = {})
   end
 
   it 'renders toplevel links' do
-    actual = JSONAPI.render(data: nil,
+    actual = subject.render(data: nil,
                             links: { self: 'http://api.example.com/users' })
     expected = {
       data: nil,
@@ -369,7 +369,7 @@ def as_jsonapi(options = {})
   end
 
   it 'renders a toplevel jsonapi object' do
-    actual = JSONAPI.render(data: nil,
+    actual = subject.render(data: nil,
                             jsonapi: {
                               version: '1.0',
                               meta: 'For real'
@@ -386,7 +386,7 @@ def as_jsonapi(options = {})
   end
 
   it 'renders an empty hash if neither errors nor data provided' do
-    actual = JSONAPI.render({})
+    actual = subject.render({})
     expected = {}
 
     expect(actual).to eq(expected)
@@ -406,7 +406,7 @@ def as_jsonapi
   it 'renders errors' do
     errors = [ErrorResource.new('1', 'Not working'),
               ErrorResource.new('2', 'Works poorly')]
-    actual = JSONAPI.render(errors: errors)
+    actual = subject.render(errors: errors)
     expected = {
       errors: [{ id: '1', title: 'Not working' },
                { id: '2', title: 'Works poorly' }]