jsonapi-renderer 0.1.1.beta2 → 0.1.1.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e66f583e5c95a9430c383949f4557e757613205
-  data.tar.gz: f70c2a5abe7c3104adbaf7ec45e78e1d1b0f8f6e
+  metadata.gz: 0e0ff29d67fa35e41f7a46f6f4bec480555d9318
+  data.tar.gz: 0d2a619490327182f40f978a917bc80b534f09ca
 SHA512:
-  metadata.gz: '034595ee5e138a7a604ad906a2ce05eb011bdaeb5ff7b27e66aa6cbd510f3599f16dc5193d8d1e77ef1903ea094a5855f0ef0d689933a1cfd9c7fd1433159a1b'
-  data.tar.gz: 44e6f00bc7b75f086afee84be0eb88b02dbc2afa34ce1a499d11d56e0da0103db59c91de3c1bcab6d67dcc5399fa6cdaf2d996e001f6c5adde17be1a8b13ea13
+  metadata.gz: 9c7b8a58093c1a7a01e1bf352b4232471f483c910386c24d77cc32301bfeb477089a163e78ab57a55d4d3e900a4945ee031cb892fe45e4a0854a3d8fab6d741f
+  data.tar.gz: e61f0a433b6a84b238e9717128073ec934557a9e7ec9e912a29adad883d9c29e902ab65c56862b456407bc617b50239c16a1638ce45f088c63e68bccf83755be

data/README.md

@@ -4,6 +4,7 @@ Ruby gem for rendering [JSON API](http://jsonapi.org) documents.
 ## Status
 
 [![Gem Version](https://badge.fury.io/rb/jsonapi-renderer.svg)](https://badge.fury.io/rb/jsonapi-renderer)
+[![Build Status](https://secure.travis-ci.org/jsonapi-rb/renderer.svg?branch=master)](http://travis-ci.org/jsonapi-rb/renderer?branch=master)
 
 ## Installation
 ```ruby
@@ -53,11 +54,12 @@ class ResourceInterface
   #     relationships, or nil.
   # @return [Hash]
   def as_jsonapi(options = {}); end
+end
 ```
 
 #### Rendering a single resource
 ```ruby
-JSONAPI.render(resource,
+JSONAPI.render(data: resource,
                include: include_string,
                fields: fields_hash,
                meta: meta_hash,
@@ -68,7 +70,7 @@ This returns a JSON API compliant hash representing the described document.
 
 #### Rendering a collection of resources
 ```ruby
-JSONAPI.render(resources,
+JSONAPI.render(data: resources,
                include: include_string,
                fields: fields_hash,
                meta: meta_hash,
@@ -80,7 +82,7 @@ This returns a JSON API compliant hash representing the described document.
 ### Rendering errors
 
 ```ruby
-JSONAPI.render_errors(errors,
+JSONAPI.render_errors(errors: errors,
                       meta: meta_hash,
                       links: links_hash)
 ```

data/lib/jsonapi/renderer/document.rb

@@ -0,0 +1,53 @@
+require 'jsonapi/include_directive'
+require 'jsonapi/renderer/resources_processor'
+
+module JSONAPI
+  module Renderer
+    class Document
+      def initialize(params = {})
+        @data    = params.fetch(:data,    :no_data)
+        @errors  = params.fetch(:errors,  [])
+        @meta    = params.fetch(:meta,    nil)
+        @links   = params.fetch(:links,   {})
+        @fields  = params.fetch(:fields,  {})
+        @jsonapi = params.fetch(:jsonapi, nil)
+        @include = JSONAPI::IncludeDirective.new(params.fetch(:include, {}))
+      end
+
+      def to_hash
+        @hash ||= document_hash
+      end
+      alias to_h to_hash
+
+      private
+
+      def document_hash
+        {}.tap do |hash|
+          if @data != :no_data
+            hash.merge!(data_hash)
+          elsif @errors.any?
+            hash.merge!(errors_hash)
+          end
+          hash[:links]   = @links    if @links.any?
+          hash[:meta]    = @meta     unless @meta.nil?
+          hash[:jsonapi] = @jsonapi  unless @jsonapi.nil?
+        end
+      end
+
+      def data_hash
+        primary, included =
+          ResourcesProcessor.new(Array(@data), @include, @fields).process
+        {}.tap do |hash|
+          hash[:data]     = @data.respond_to?(:each) ? primary : primary[0]
+          hash[:included] = included if included.any?
+        end
+      end
+
+      def errors_hash
+        {}.tap do |hash|
+          hash[:errors] = @errors.map(&:as_jsonapi)
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/renderer/resources_processor.rb

@@ -0,0 +1,67 @@
+require 'set'
+
+module JSONAPI
+  module Renderer
+    class ResourcesProcessor
+      def initialize(resources, include, fields)
+        @resources = resources
+        @include   = include
+        @fields    = fields
+        @primary   = []
+        @included  = []
+        @hashes    = {}
+        @queue     = []
+        @processed = Set.new # NOTE(beauby): Set of [type, id, prefix].
+      end
+
+      def process
+        @resources.each do |res|
+          process_resource(res, '', @include, true)
+          @processed.add([res.jsonapi_type, res.jsonapi_id, ''])
+        end
+        until @queue.empty?
+          res, prefix, include_dir = @queue.pop
+          process_resource(res, prefix, include_dir, false)
+        end
+
+        [@primary, @included]
+      end
+
+      private
+
+      def merge_resources!(a, b)
+        b[:relationships].each do |name, rel|
+          a[:relationships][name][:data] ||= rel[:data] if rel.key?(:data)
+          if rel.key?(:links)
+            (a[:relationships][name][:links] ||= {}).merge!(rel[:links])
+          end
+        end
+      end
+
+      def process_resource(res, prefix, include_dir, is_primary)
+        ri = [res.jsonapi_type, res.jsonapi_id]
+        hash = res.as_jsonapi(fields: @fields[res.jsonapi_type.to_sym],
+                              include: include_dir.keys)
+        if @hashes.key?(ri)
+          merge_resources!(@hashes[ri], hash)
+        else
+          (is_primary ? @primary : @included) << (@hashes[ri] = hash)
+        end
+        process_relationships(res, prefix, include_dir)
+      end
+
+      def process_relationships(res, prefix, include_dir)
+        res.jsonapi_related(include_dir.keys).each do |key, data|
+          Array(data).each do |child_res|
+            next if child_res.nil?
+            child_prefix = "#{prefix}.#{key}"
+            next unless @processed.add?([child_res.jsonapi_type,
+                                         child_res.jsonapi_id,
+                                         child_prefix])
+            @queue << [child_res, child_prefix, include_dir[key]]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/renderer.rb

@@ -1,98 +1,15 @@
-require 'jsonapi/include_directive'
+require 'jsonapi/renderer/document'
 
 module JSONAPI
-  class Renderer
-    def initialize(resources, options = {})
-      @resources = resources
-      @errors = options[:errors] || false
-      @meta = options[:meta] || nil
-      @links = options[:links] || {}
-      @fields = options[:fields] || {}
-      # NOTE(beauby): Room for some nifty defaults on those.
-      @jsonapi = options[:jsonapi_object] || nil
-      @include = JSONAPI::IncludeDirective.new(options[:include] || {})
-    end
-
-    def as_json
-      return @json unless @json.nil?
-
-      process_resources
-      @json = {}
-
-      if @errors
-        @json[:errors] = @resources.map(&:as_jsonapi)
-      else
-        @json[:data] = @resources.respond_to?(:each) ? @primary : @primary[0]
-        @json[:included] = @included if @included.any?
-      end
-      @json[:links] = @links if @links.any?
-      @json[:meta] = @meta unless @meta.nil?
-      @json[:jsonapi] = @jsonapi unless @jsonapi.nil?
-
-      @json
-    end
-
-    private
-
-    def process_resources
-      @primary = []
-      @included = []
-      @hashes = {}
-      @processed = Set.new # NOTE(beauby): Set of [type, id, prefix].
-      @queue = []
-
-      Array(@resources).each do |res|
-        process_resource(res, '', @include, true)
-        @processed.add([res.jsonapi_type, res.jsonapi_id, ''])
-      end
-      until @queue.empty?
-        res, prefix, include_dir = @queue.pop
-        process_resource(res, prefix, include_dir, false)
-      end
-    end
-
-    def merge_resources!(a, b)
-      b[:relationships].each do |name, rel|
-        a[:relationships][name][:data] ||= rel[:data] if rel.key?(:data)
-        (a[:relationships][name][:links] ||= {})
-          .merge!(rel[:links]) if rel.key?(:links)
-      end
-    end
-
-    def process_resource(res, prefix, include_dir, is_primary)
-      ri = [res.jsonapi_type, res.jsonapi_id]
-      hash = res.as_jsonapi(fields: @fields[res.jsonapi_type.to_sym],
-                            include: include_dir.keys)
-      if @hashes.key?(ri)
-        merge_resources!(@hashes[ri], hash)
-      else
-        (is_primary ? @primary : @included) << (@hashes[ri] = hash)
-      end
-      process_relationships(res, prefix, include_dir)
-    end
-
-    def process_relationships(res, prefix, include_dir)
-      res.jsonapi_related(include_dir.keys).each do |key, data|
-        Array(data).each do |child_res|
-          next if child_res.nil?
-          child_prefix = "#{prefix}.#{key}"
-          next unless @processed.add?([child_res.jsonapi_type,
-                                       child_res.jsonapi_id,
-                                       child_prefix])
-          @queue << [child_res, child_prefix, include_dir[key]]
-        end
-      end
-    end
-  end
-
   module_function
 
-  # Render a success JSON API document.
+  # Render a JSON API document.
   #
-  # @param [(#jsonapi_id, #jsonapi_type, #jsonapi_related, #as_jsonapi),
-  #         Array<(#jsonapi_id, #jsonapi_type, #jsonapi_related, #as_jsonapi)>,
-  #         nil] resources The primary resource(s) to be rendered.
-  # @param [Hash] options All optional.
+  # @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 [String, Hash{Symbol => Hash}] include Relationships to be
   #     included.
   #   @option [Hash{Symbol, Array<Symbol>}] fields List of requested fields
@@ -101,19 +18,7 @@ module JSONAPI
   #     included.
   #   @option [Hash] links Top-level links to be included.
   #   @option [Hash] jsonapi_object JSON API object.
-  def render(resources, options = {})
-    Renderer.new(resources, options).as_json
-  end
-
-  # Render an error JSON API document.
-  #
-  # @param [Array<#jsonapi_id>] errors Errors to be rendered.
-  # @param [Hash] options All optional.
-  #   @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.
-  def render_errors(errors)
-    Renderer.new(errors, errors: true).as_json
+  def render(params)
+    Renderer::Document.new(params).to_hash
   end
 end

metadata

@@ -1,16 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-renderer
 version: !ruby/object:Gem::Version
-  version: 0.1.1.beta2
+  version: 0.1.1.beta3
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-25 00:00:00.000000000 Z
-dependencies: []
-description: Low-level renderer for JSONAPI documents.
+date: 2016-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Efficiently render JSON API documents.
 email: lucas.hosseini@gmail.com
 executables: []
 extensions: []
@@ -20,7 +48,9 @@ files:
 - lib/jsonapi/include_directive.rb
 - lib/jsonapi/include_directive/parser.rb
 - lib/jsonapi/renderer.rb
-homepage: https://github.com/beauby/jsonapi
+- lib/jsonapi/renderer/document.rb
+- lib/jsonapi/renderer/resources_processor.rb
+homepage: https://github.com/jsonapi-rb/renderer
 licenses:
 - MIT
 metadata: {}