roar-jsonapi 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab2ea6e72551ddf89ce11262cdb0dfbaa8cfb5c0
-  data.tar.gz: a9b2759b687e1c1979b8ceaf12293431e9543630
+  metadata.gz: 71ddcd3402871acd7cf0d96ef5d8744fd94c4864
+  data.tar.gz: 63f93a300efc0a3d914faffef32fc2be050c9d5e
 SHA512:
-  metadata.gz: ff1affc535bb8292dc85014417bfa388bad872e72ac3d26a195615f5e4d401d63fbf28030445014d5fe836dfbbcd63245d7565418f092702907580d69e464946
-  data.tar.gz: 56d8ef80e9980d5abb6e967d4d5a04e21e335c6ce9dfd9e8db04ee289ddf2baf4acea781cb1784dd469511c9fba7c0eb521c4ffde189a5abf5da8d2a09896869
+  metadata.gz: 6a9c053a8ea8e43b8b1d0f09b62ec7d1bdacbfe42470b04405b00c94ce23ba9dadb09f0767e87402f260a4a3957aacd2795e30f2e1c8cc73434296951e1f0796
+  data.tar.gz: 35d8fab2888a1e5e4e49a59e54e98cb205b2590666560d855c40d8a6708630fe498dc7d35542ac3527fafb0061aa5570430baaaee47bc54199bf4abaaf1391f9

data/CHANGES.md

@@ -1,3 +1,9 @@
+# 0.0.3
+
+* Make `Document` module part of public API. This allows other libraries to hook
+ing into the parsing/rendering of all JSON API documents, whether their data
+contains a single Resource Object or a collection of Resource Objects.
+
 # 0.0.2
 
 * Require Representable 3.0.3, which replaces `Uber::Option` with the new [`Declarative::Option`](https://github.com/apotonick/declarative-option).

data/lib/roar/json/json_api.rb

@@ -7,10 +7,13 @@ require 'roar/json/json_api/member_name'
 require 'roar/json/json_api/defaults'
 require 'roar/json/json_api/meta'
 require 'roar/json/json_api/declarative'
-require 'roar/json/json_api/for_collection'
 require 'roar/json/json_api/options'
 require 'roar/json/json_api/document'
 
+require 'roar/json/json_api/single_resource'
+require 'roar/json/json_api/resource_collection'
+require 'roar/json/json_api/for_collection'
+
 module Roar
   module JSON
     module JSONAPI
@@ -101,6 +104,7 @@ module Roar
             extend JSONAPI::Declarative
             extend JSONAPI::ForCollection
             include JSONAPI::Document
+            include JSONAPI::SingleResource
             self.representation_wrap = :data
 
             nested :relationships do

data/lib/roar/json/json_api/document.rb

@@ -9,7 +9,7 @@ module Roar
         # @example Simple rendering
         #   representer.to_json
         #
-        # @example Rendering with compount documents and sparse fieldsets
+        # @example Rendering with compound documents and sparse fieldsets
         #   uri   = Addressable::URI.parse('/articles/1?include=author,comments.author')
         #   query = Rack::Utils.parse_nested_query(uri.query)
         #   # => {"include"=>"author", "fields"=>{"articles"=>"title,body", "people"=>"name"}}
@@ -51,52 +51,7 @@ module Roar
         #
         # @api public
         def to_hash(options = {})
-          document  = super(Options::Include.(options, mappings))
-          unwrapped = options[:wrap] == false
-          resource  = unwrapped ? document : document['data']
-          resource['type'] = JSONAPI::MemberName.(self.class.type)
-
-          links = Renderer::Links.new.(resource, options)
-          meta  = render_meta(options)
-
-          resource.reject! do |_, v| v && v.empty? end
-
-          unless unwrapped
-            included = resource.delete('included')
-
-            HashUtils.store_if_any(document, 'included',
-                                   Fragment::Included.(included, options))
-          end
-
-          HashUtils.store_if_any(resource, 'links', links)
-          HashUtils.store_if_any(document, 'meta',  meta)
-
-          document
-        end
-
-        private
-
-        def mappings
-          @mappings ||= begin
-            mappings = {}
-            mappings[:id]             = find_id_mapping
-            mappings[:relationships]  = find_relationship_mappings
-            mappings[:relationships]['_self'] = self.class.type
-            mappings
-          end
-        end
-
-        def find_id_mapping
-          self.class.definitions.detect { |definition|
-            definition[:as] && definition[:as].(:value) == 'id'
-          }.name
-        end
-
-        def find_relationship_mappings
-          included_definitions = self.class.definitions['included'].representer_module.definitions
-          included_definitions.each_with_object({}) do |definition, hash|
-            hash[definition.name] = definition.representer_module.type
-          end
+          super
         end
       end
     end

data/lib/roar/json/json_api/for_collection.rb

@@ -8,25 +8,9 @@ module Roar
 
           nested_builder.(_base: default_nested_class, _features: [Roar::JSON, Roar::Hypermedia, JSONAPI::Defaults, JSONAPI::Meta], _block: proc do
             collection :to_a, as: :data, decorator: singular, wrap: false
-            # rubocop:disable Lint/NestedMethodDefinition
-            def to_hash(options = {})
-              document = super(to_a: options, user_options: options[:user_options]) # [{data: {..}, data: {..}}]
 
-              links = Renderer::Links.new.(document, options)
-              meta  = render_meta(options)
-              included = []
-              document['data'].each do |single|
-                included += single.delete('included') || []
-              end
-
-              HashUtils.store_if_any(document, 'included',
-                                     Fragment::Included.(included, options))
-              HashUtils.store_if_any(document, 'links',    links)
-              HashUtils.store_if_any(document, 'meta',     meta)
-
-              document
-            end
-            # rubocop:enable Lint/NestedMethodDefinition
+            include Document
+            include ResourceCollection
           end)
         end
       end

data/lib/roar/json/json_api/options.rb

@@ -6,7 +6,7 @@ module Roar
         # Transforms `field:` and `include:`` options to their internal
         # equivalents.
         #
-        # @see Document#to_hash
+        # @see SingleResource#to_hash
         class Include
           DEFAULT_INTERNAL_INCLUDES = [:attributes, :relationships].freeze
 

data/lib/roar/json/json_api/resource_collection.rb

@@ -0,0 +1,29 @@
+module Roar
+  module JSON
+    module JSONAPI
+      # Instance method API for JSON API Documents representing an array of Resources
+      #
+      # @api private
+      module ResourceCollection
+        # @see Document#to_hash
+        def to_hash(options = {})
+          document = super(to_a: options, user_options: options[:user_options]) # [{data: {..}, data: {..}}]
+
+          links = Renderer::Links.new.(document, options)
+          meta  = render_meta(options)
+          included = []
+          document['data'].each do |single|
+            included += single.delete('included') || []
+          end
+
+          HashUtils.store_if_any(document, 'included',
+                                 Fragment::Included.(included, options))
+          HashUtils.store_if_any(document, 'links',    links)
+          HashUtils.store_if_any(document, 'meta',     meta)
+
+          document
+        end
+      end
+    end
+  end
+end

data/lib/roar/json/json_api/single_resource.rb

@@ -0,0 +1,60 @@
+module Roar
+  module JSON
+    module JSONAPI
+      # Instance method API for JSON API Documents representing a single Resource
+      #
+      # @api private
+      module SingleResource
+        # @see Document#to_hash
+        def to_hash(options = {})
+          document  = super(Options::Include.(options, mappings))
+          unwrapped = options[:wrap] == false
+          resource  = unwrapped ? document : document['data']
+          resource['type'] = JSONAPI::MemberName.(self.class.type)
+
+          links = Renderer::Links.new.(resource, options)
+          meta  = render_meta(options)
+
+          resource.reject! do |_, v| v && v.empty? end
+
+          unless unwrapped
+            included = resource.delete('included')
+
+            HashUtils.store_if_any(document, 'included',
+                                   Fragment::Included.(included, options))
+          end
+
+          HashUtils.store_if_any(resource, 'links', links)
+          HashUtils.store_if_any(document, 'meta',  meta)
+
+          document
+        end
+
+        private
+
+        def mappings
+          @mappings ||= begin
+            mappings = {}
+            mappings[:id]             = find_id_mapping
+            mappings[:relationships]  = find_relationship_mappings
+            mappings[:relationships]['_self'] = self.class.type
+            mappings
+          end
+        end
+
+        def find_id_mapping
+          self.class.definitions.detect { |definition|
+            definition[:as] && definition[:as].(:value) == 'id'
+          }.name
+        end
+
+        def find_relationship_mappings
+          included_definitions = self.class.definitions['included'].representer_module.definitions
+          included_definitions.each_with_object({}) do |definition, hash|
+            hash[definition.name] = definition.representer_module.type
+          end
+        end
+      end
+    end
+  end
+end

data/lib/roar/json/json_api/version.rb

@@ -1,7 +1,7 @@
 module Roar
   module JSON
     module JSONAPI
-      VERSION = '0.0.2'.freeze
+      VERSION = '0.0.3'.freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roar-jsonapi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Nick Sutterer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-28 00:00:00.000000000 Z
+date: 2017-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roar
@@ -115,6 +115,8 @@ files:
 - lib/roar/json/json_api/member_name.rb
 - lib/roar/json/json_api/meta.rb
 - lib/roar/json/json_api/options.rb
+- lib/roar/json/json_api/resource_collection.rb
+- lib/roar/json/json_api/single_resource.rb
 - lib/roar/json/json_api/version.rb
 - roar-jsonapi.gemspec
 - test/jsonapi/collection_render_test.rb