jsonapi-renderer 0.1.3 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 64a6b359e09767d1fb82f5c99e5c00493180fee2
-  data.tar.gz: 7cbe497431c5af06536206776c5ea4c791085e3c
+SHA256:
+  metadata.gz: 221e35b89366443f6a4e545e42b0026b824c0fc7915170354f5e2b4989cd6d76
+  data.tar.gz: 22912dac4be273f88d701e07fcc154de4a745962113a07e3bac3f075bec7fb8d
 SHA512:
-  metadata.gz: 560dd5946e8a744de498eabc762f1f90f4c834a215a2b57e58adba24b9b5f6d6e1e5b878123195b82c2ec6f58f64468cdb530159cd30e5bb99f226134238d66a
-  data.tar.gz: 4fdf98ad9829edfc5e254b4df9a7a7f765ee9de05784c76c6f6e35ee73f64b154e75bf40af6953873f0d1cfdeb0dbb096401cc982eac546388930b0219a5741b
+  metadata.gz: bbe2e5a3ec1c4b7c2fe25b04f386b8fc792c75faf1f924dba3e647f46962db8ab87d2a575f03622ab5dd3dba84528f0721423f11ad761344e9c5c1527da15716
+  data.tar.gz: efa85300205e568b7e4348bfe8f76d182be85948287170fee67f2f2d5220a9aa02a07dd64af7d370e8d921d7eaff05eb6d2e11ba79db453f7e250bcb14ce6415

data/README.md

@@ -48,7 +48,7 @@ class ResourceInterface
   # @return [String]
   def jsonapi_id; end
 
-  # Returns a hash containing, for each included relationship, an array of the 
+  # Returns a hash containing, for each included relationship, an array of the
   # resources to be included from that one.
   # @param included_relationships [Array<Symbol>] The keys of the relationships
   #   to be included.
@@ -57,8 +57,8 @@ class ResourceInterface
 
   # Returns a JSON API-compliant representation of the resource as a hash.
   # @param options [Hash]
-  #   @option fields [Array<Symbol>, Nil] The requested fields, or nil.
-  #   @option include [Array<Symbol>] The requested relationships to 
+  #   @option fields [Set<Symbol>, Nil] The requested fields, or nil.
+  #   @option include [Set<Symbol>] The requested relationships to
   #     include (defaults to []).
   # @return [Hash]
   def as_jsonapi(options = {}); end
@@ -87,6 +87,18 @@ JSONAPI.render(data: resources,
 
 This returns a JSON API compliant hash representing the described document.
 
+#### Rendering a relationship
+```ruby
+JSONAPI.render(data: resource,
+               relationship: :posts,
+               include: include_string,
+               fields: fields_hash,
+               meta: meta_hash,
+               links: links_hash)
+```
+
+This returns a JSON API compliant hash representing the described document.
+
 ### Rendering errors
 
 ```ruby
@@ -100,6 +112,32 @@ returns a JSON API-compliant representation of the error.
 
 This returns a JSON API compliant hash representing the described document.
 
+### Caching
+
+The generated JSON fragments can be cached in any cache implementation
+supporting the `fetch_multi` method.
+
+When using caching, the serializable resources must implement an
+additional `jsonapi_cache_key` method:
+```ruby
+  # Returns a cache key for the resource, parameterized by the `include` and
+  #   `fields` options.
+  # @param options [Hash]
+  #   @option fields [Set<Symbol>, Nil] The requested fields, or nil.
+  #   @option include [Set<Symbol>] The requested relationships to
+  #     include (defaults to []).
+  # @return [String]
+  def jsonapi_cache_key(options = {}); end
+```
+
+The cache instance must be passed to the renderer as follows:
+```ruby
+JSONAPI.render(data: resources,
+               include: include_string,
+               fields: fields_hash,
+               cache: cache_instance)
+```
+
 ## License
 
 jsonapi-renderer is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/jsonapi/include_directive.rb

@@ -16,6 +16,8 @@ module JSONAPI
     def initialize(include_args, options = {})
       include_hash = Parser.parse_include_args(include_args)
       @hash = include_hash.each_with_object({}) do |(key, value), hash|
+        raise InvalidKey, key unless valid?(key)
+
         hash[key] = self.class.new(value, options)
       end
       @options = options
@@ -68,5 +70,18 @@ module JSONAPI
 
       string_array.join(',')
     end
+
+    class InvalidKey < StandardError; end
+
+    private
+
+    def valid?(key)
+      key.match(valid_json_key_name_regex)
+    end
+
+    def valid_json_key_name_regex
+      # https://jsonapi.org/format/#document-member-names
+      /^(?![\s\-_])[\u0080-\u10FFA-Za-z0-9* _-]+(?<![\s\-_])$/
+    end
   end
 end

data/lib/jsonapi/renderer/cached_resources_processor.rb

@@ -0,0 +1,47 @@
+require 'jsonapi/renderer/resources_processor'
+
+module JSONAPI
+  class Renderer
+    # @private
+    class CachedResourcesProcessor < ResourcesProcessor
+      class JSONString < String
+        def to_json(*)
+          self
+        end
+      end
+
+      def initialize(cache)
+        @cache = cache
+      end
+
+      def process_resources
+        # NOTE(beauby): This is necessary for cache keys consistency.
+        @include_rels = @include_rels.each_with_object({}) do |(k, v), h|
+          h[k] = v.to_a.sort!
+        end
+
+        [@primary, @included].each do |resources|
+          cache_hash = cache_key_map(resources)
+          processed_resources = @cache.fetch_multi(*cache_hash.keys) do |key|
+            res, include, fields = cache_hash[key]
+            json = res.as_jsonapi(include: include, fields: fields).to_json
+
+            JSONString.new(json)
+          end
+
+          resources.replace(processed_resources.values)
+        end
+      end
+
+      def cache_key_map(resources)
+        resources.each_with_object({}) do |res, h|
+          ri = [res.jsonapi_type, res.jsonapi_id]
+          include_dir = @include_rels[ri]
+          fields = @fields[ri.first.to_sym]
+          h[res.jsonapi_cache_key(include: include_dir, fields: fields)] =
+            [res, include_dir, fields]
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/renderer/document.rb

@@ -1,17 +1,21 @@
 require 'jsonapi/include_directive'
-require 'jsonapi/renderer/resources_processor'
+require 'jsonapi/renderer/simple_resources_processor'
+require 'jsonapi/renderer/cached_resources_processor'
 
 module JSONAPI
   class Renderer
+    # @private
     class Document
       def initialize(params = {})
         @data    = params.fetch(:data,    :no_data)
         @errors  = params.fetch(:errors,  [])
         @meta    = params[:meta]
         @links   = params[:links] || {}
-        @fields  = _symbolize_fields(params[:fields] || {})
+        @fields  = _canonize_fields(params[:fields] || {})
         @jsonapi = params[:jsonapi]
         @include = JSONAPI::IncludeDirective.new(params[:include] || {})
+        @relationship = params[:relationship]
+        @cache = params[:cache]
       end
 
       def to_hash
@@ -21,37 +25,75 @@ module JSONAPI
 
       private
 
+      # rubocop:disable Metrics/PerceivedComplexity, Metrics/MethodLength
+      # rubocop:disable Metrics/CyclomaticComplexity
       def document_hash
         {}.tap do |hash|
-          if @data != :no_data
+          if @relationship
+            hash.merge!(relationship_hash)
+          elsif @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?
+          hash[:links]   = @links   if @links.any?
+          hash[:meta]    = @meta    unless @meta.nil?
+          hash[:jsonapi] = @jsonapi unless @jsonapi.nil?
         end
       end
+      # rubocop:enable Metrics/PerceivedComplexity, Metrics/MethodLength
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       def data_hash
         primary, included =
-          ResourcesProcessor.new(Array(@data), @include, @fields).process
+          resources_processor.process(Array(@data), @include, @fields)
         {}.tap do |hash|
           hash[:data]     = @data.respond_to?(:to_ary) ? primary : primary[0]
           hash[:included] = included if included.any?
         end
       end
 
+      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      def relationship_hash
+        rel_name = @relationship.to_sym
+        data = @data.jsonapi_related([rel_name])[rel_name]
+        included =
+          if @include.key?(rel_name)
+            resources_processor.process(data, @include[rel_name], @fields)
+                               .flatten!
+          else
+            []
+          end
+
+        res = @data.as_jsonapi(fields: [rel_name], include: [rel_name])
+        rel = res[:relationships][rel_name]
+        @links = rel[:links].merge!(@links)
+        @meta ||= rel[:meta]
+
+        {}.tap do |hash|
+          hash[:data]     = rel[:data]
+          hash[:included] = included if included.any?
+        end
+      end
+      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+
       def errors_hash
         {}.tap do |hash|
-          hash[:errors] = @errors.map(&:as_jsonapi)
+          hash[:errors] = @errors.flat_map(&:as_jsonapi)
+        end
+      end
+
+      def resources_processor
+        if @cache
+          CachedResourcesProcessor.new(@cache)
+        else
+          SimpleResourcesProcessor.new
         end
       end
 
-      def _symbolize_fields(fields)
+      def _canonize_fields(fields)
         fields.each_with_object({}) do |(k, v), h|
-          h[k.to_sym] = v.map(&:to_sym)
+          h[k.to_sym] = v.map(&:to_sym).sort!
         end
       end
     end

data/lib/jsonapi/renderer/resources_processor.rb

@@ -2,14 +2,13 @@ require 'set'
 
 module JSONAPI
   class Renderer
+    # @private
     class ResourcesProcessor
-      def initialize(resources, include, fields)
+      def process(resources, include, fields)
         @resources = resources
         @include   = include
         @fields    = fields
-      end
 
-      def process
         traverse_resources
         process_resources
 
@@ -73,14 +72,7 @@ module JSONAPI
       end
 
       def process_resources
-        [@primary, @included].each do |resources|
-          resources.map! do |res|
-            ri = [res.jsonapi_type, res.jsonapi_id]
-            include_dir = @include_rels[ri]
-            fields = @fields[res.jsonapi_type.to_sym]
-            res.as_jsonapi(include: include_dir, fields: fields)
-          end
-        end
+        raise 'Not implemented'
       end
     end
   end

data/lib/jsonapi/renderer/simple_resources_processor.rb

@@ -0,0 +1,19 @@
+require 'jsonapi/renderer/resources_processor'
+
+module JSONAPI
+  class Renderer
+    # @api private
+    class SimpleResourcesProcessor < ResourcesProcessor
+      def process_resources
+        [@primary, @included].each do |resources|
+          resources.map! do |res|
+            ri = [res.jsonapi_type, res.jsonapi_id]
+            include_dir = @include_rels[ri]
+            fields = @fields[res.jsonapi_type.to_sym]
+            res.as_jsonapi(include: include_dir, fields: fields)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-renderer
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.2
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2019-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
 description: Efficiently render JSON API documents.
 email: lucas.hosseini@gmail.com
 executables: []
@@ -62,8 +62,10 @@ files:
 - lib/jsonapi/include_directive.rb
 - lib/jsonapi/include_directive/parser.rb
 - lib/jsonapi/renderer.rb
+- lib/jsonapi/renderer/cached_resources_processor.rb
 - lib/jsonapi/renderer/document.rb
 - lib/jsonapi/renderer/resources_processor.rb
+- lib/jsonapi/renderer/simple_resources_processor.rb
 homepage: https://github.com/jsonapi-rb/jsonapi-renderer
 licenses:
 - MIT
@@ -84,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Render JSONAPI documents.