jei 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bf0d7bbd5077695a2e1219961576f894a5cd41f
-  data.tar.gz: 34cb6f17efada6cd82e01d23e8e67a16f7f2414e
+  metadata.gz: 171c14fb585c7f29a0c740386776f278d423a72a
+  data.tar.gz: c8eeded9a3066460a0ff6946bac4d3b6e78d6adb
 SHA512:
-  metadata.gz: 89a27cbfe0af409953efaf4da6d83f7a8f78659bf2ca58a40a22a1b148d8df1eb9d48a2b65e76f374b38598618a2fcf8310b425d001977ef0580a2a3186ed59b
-  data.tar.gz: 5972dc16d4c2df09654730607ffbfa92165751a12fc3c6284923b4516af448c987e2b7747f99c4d39bf7266bfb09a5915b0bec0b2496685049bd5388c78764e3
+  metadata.gz: 1cc6431cfd6b4959b7af2fe826e5dec6a0f062b091f76aeff1bdcda88dbbc1926105c6f3bc89e62a5169021e617814e71988c6bb4057c3c65a010d299ad87793
+  data.tar.gz: 35d9daae8116b08430315435ae4b5f3e36e5781eb2fedca6531597c55192d38b0a9d21d1d687728903142a7914900c67accf6a9d0ef0beb9878548d8e3b37ebf

data/.travis.yml

@@ -1,4 +1,5 @@
+sudo: false
 language: ruby
 rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.11.2
+  - 2.3.1
+before_install: gem install bundler -v 1.12.1

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## HEAD
 
+## 0.3.0 (2016-05-03)
+
+* [CHANGE] Compound documents include full linkage. A relationship path
+  overrides a relationship's `:data` option.
+* [ADD] Add `:errors` document build option to override primary data with an
+  array of error objects.
+* [CHANGE] Directly build a document rather than building and evaluating a
+  parse tree. The tree ended up not being a very useful intermediate
+  representation, and removing it improves synthetic benchmarks by ~25%.
+
 ## 0.2.0 (2016-03-22)
 
 * [ADD] Add `:fields` document build option for sparse fieldsets.

data/README.md

@@ -1,5 +1,8 @@
 # Jei
 
+[![Gem Version](https://badge.fury.io/rb/jei.svg)](https://badge.fury.io/rb/jei)
+[![Build Status](https://travis-ci.org/zaeleus/jei.svg?branch=master)](https://travis-ci.org/zaeleus/jei)
+
 **Jei** is a simple serializer for Ruby that formats a JSON document described
 by [JSON API][jsonapi].
 
@@ -71,6 +74,33 @@ class Artist; end
 class ArtistSerializer < Jei::Serializer; end
 ```
 
+#### Resource Identifiers
+
+A serializer wraps a resource, which has an id and type. By default, the
+serializer assumes the resource responds to `id`. If not, override
+`Jei::Serializer#id` and return a custom id as a string.
+
+```ruby
+class ArtistSerializer < Jei::Serializer
+  def id
+    resource.uuid
+  end
+end
+```
+
+The default resource type is the resource's lowercased class name with an 's'
+appended.  For example, `Artist` becomes "artists" and `Person` becomes
+"persons". For a custom type, override `Jei::Serializer#type` and return a
+string.
+
+```ruby
+class PersonSerializer < Jei::Serializer
+  def type
+    'people'.freeze
+  end
+end
+```
+
 #### Attributes
 
 Attributes represent model data. They are defined in a serializer by using the
@@ -181,6 +211,9 @@ Each relationship object can be modified with the following options.
   building a data object with resource identifiers. Note that doing so does not
   emit a valid JSON API document unless a links or meta object is present.
 
+  To ensure full linkage, this option is overridden to `true` when the resource
+  is on the included relationship path.
+
     ```ruby
     class ArtistSerializer < Jei::Serializer
       has_many :albums, data: false
@@ -287,6 +320,38 @@ string (`#to_json`).
 
 Top level objects can be added using the following options.
 
+* `:errors`: (`Array<Hash<Symbol, Object>>`) An array of
+  [error objects][error-objects]. Setting this prevents the primary data
+  member from being added to the document.
+
+    ```ruby
+    artist = Artist.new(id: 1, name: '')
+
+    errors = [{
+      status: '422',
+      source: {
+        pointer: '/data/attributes/name'
+      },
+      detail: "Name can't be blank"
+    }]
+
+    Jei::Document.build(artist, errors: errors)
+    ```
+
+    ```json
+    {
+      "errors": [{
+        "status": "422",
+        "source": {
+          "pointer": "/data/attributes/name"
+        },
+        "detail": "Name can't be blank"
+      }]
+    }
+    ```
+
+[error-objects]: http://jsonapi.org/format/1.0/#error-objects
+
 * `:fields`: (`Hash<String, String>`) A map of resource type-fields that define
   sparse fieldsets. Keys are resource types, and fields are a comma-separated
   list of field names. For example, `{ 'artists' => 'name,albums', 'albums' =>

data/lib/jei.rb

@@ -3,34 +3,8 @@ require 'set'
 
 require 'jei/error'
 
-require 'jei/nodes/node'
-
-require 'jei/nodes/attribute_node'
-require 'jei/nodes/attributes_node'
-require 'jei/nodes/document_node'
-require 'jei/nodes/included_node'
-require 'jei/nodes/json_api_node'
-require 'jei/nodes/link_node'
-require 'jei/nodes/links_node'
-require 'jei/nodes/meta_node'
-require 'jei/nodes/relationship_node'
-require 'jei/nodes/relationships_node'
-require 'jei/nodes/resource_identifier_node'
-require 'jei/nodes/resource_node'
-
-require 'jei/nodes/data_node'
-require 'jei/nodes/collection_data_node'
-
-require 'jei/builders/attributes_node_builder'
-require 'jei/builders/data_node_builder'
-require 'jei/builders/document_builder'
-require 'jei/builders/included_node_builder'
-require 'jei/builders/links_node_builder'
-require 'jei/builders/relationship_node_builder'
-require 'jei/builders/relationships_node_builder'
-require 'jei/builders/resource_node_builder'
-
 require 'jei/document'
+require 'jei/document/builder'
 require 'jei/fieldset'
 require 'jei/link'
 require 'jei/path'

data/lib/jei/document.rb

@@ -1,15 +1,18 @@
 module Jei
   class Document
     # @return [String]
-    VERSION = '1.0'
+    VERSION = '1.0'.freeze
 
-    # @return [DocumentNode]
+    # @return [Hash<Symbol, Object>]
     attr_reader :root
+    alias_method :to_h, :root
 
     # Builds a document from a resource.
     #
     # @param [Object] resource
     # @param [Hash<Symbol, Object>] options
+    # @option options [Array<Hash<Symbol, Object>>] :errors override primary
+    #   data with an array of error objects
     # @option options [Hash<String, String>] :fields restrict resource
     #   attributes and relationships to a user-defined set of fields
     # @option options [String] :include a list of relationship paths
@@ -22,18 +25,11 @@ module Jei
     # @option options [Class] :serializer override the default serializer
     # @return [Document]
     def self.build(resource, options = {})
-      Builders::DocumentBuilder.build(resource, options)
-    end
-
-    def initialize
-      @root = Nodes::DocumentNode.new
+      Builder.build(resource, options)
     end
 
-    # @return [Hash<Symbol, Object>]
-    def to_h
-      document = {}
-      root.visit(document)
-      document
+    def initialize(root = {})
+      @root = root
     end
 
     # @return [String]

data/lib/jei/document/builder.rb

@@ -0,0 +1,282 @@
+module Jei
+  class Document
+    module Builder
+      EMPTY_COLLECTION = [].freeze
+      EMPTY_FIELDSETS = {}.freeze
+
+      module_function
+
+      # @param [Object] resource
+      # @param [Hash<Symbol, Object>] options
+      # @return [Document]
+      def build(resource, options = {})
+        document = Document.new
+        root = document.root
+
+        build_json_api(root) if options[:jsonapi]
+        build_meta(root, options[:meta]) if options[:meta]
+        build_links(root, options[:links]) if options[:links]
+
+        if options[:errors]
+          build_errors(root, options[:errors])
+        elsif resource.nil?
+          root[:data] = nil
+        elsif resource.is_a?(Enumerable)
+          build_collection(root, resource, options)
+        else
+          build_single(root, resource, options)
+        end
+
+        document
+      end
+
+      # @see http://jsonapi.org/format/1.0/#document-jsonapi-object
+      # @param [Hash<Symbol, Object>] context
+      def build_json_api(context)
+        context[:jsonapi] = { version: Document::VERSION }
+      end
+
+      # @see http://jsonapi.org/format/1.0/#document-meta
+      # @param [Hash<Symbol, Object>] context
+      # @param [Hash<Symbol, Object>] meta
+      def build_meta(context, meta)
+        context[:meta] = meta
+      end
+
+      # @see http://jsonapi.org/format/1.0/#document-links
+      # @param [Hash<Symbol, Object>] context
+      # @param [Array<Link>] links
+      def build_links(context, links)
+        root = {}
+        links.each { |link| build_link(root, link) }
+        context[:links] = root
+      end
+
+      # @see http://jsonapi.org/format/1.0/#document-links
+      # @param [Hash<Symbol, Object>] context
+      # @param [Link] link
+      def build_link(context, link)
+        context[link.name] =
+          if link.meta.any?
+            { href: link.href, meta: link.meta }
+          else
+            link.href
+          end
+      end
+
+      # @see http://jsonapi.org/format/1.0/#document-top-level
+      # @param [Hash<Symbol, Object>] context
+      # @param [Object] resource
+      # @param [Hash<Symbol, Object>] options
+      def build_single(context, resource, options)
+        fieldsets = options[:fields] ? Fieldset.parse(options[:fields]) : EMPTY_FIELDSETS
+
+        serializer = Serializer.factory(resource, options[:serializer])
+        fieldset = fieldsets[serializer.type]
+
+        if options[:include]
+          paths = Path.parse(options[:include])
+          serializers = Set.new
+          Path.find(paths, serializer, serializers)
+        end
+
+        root = {}
+        build_resource(root, serializer, fieldset)
+        context[:data] = root
+
+        if options[:include]
+          build_included(context, serializers, fieldsets)
+        end
+      end
+
+      # @see http://jsonapi.org/format/1.0/#document-top-level
+      # @param [Hash<Symbol, Object>] context
+      # @param [Enumerable] resources
+      # @param [Hash<Symbol, Object>] options
+      def build_collection(context, resources, options)
+        if resources.empty?
+          context[:data] = EMPTY_COLLECTION
+          return
+        end
+
+        fieldsets = options[:fields] ? Fieldset.parse(options[:fields]) : EMPTY_FIELDSETS
+
+        if options[:include]
+          paths = Path.parse(options[:include])
+          serializers = Set.new
+
+          context[:data] = resources.map do |resource|
+            serializer = Serializer.factory(resource, options[:serializer])
+
+            Path.find(paths, serializer, serializers)
+
+            root = {}
+            fieldset = fieldsets[serializer.type]
+
+            build_resource(root, serializer, fieldset)
+
+            root
+          end
+
+          build_included(context, serializers, fieldsets)
+        else
+          context[:data] = resources.map do |resource|
+            root = {}
+            serializer = Serializer.factory(resource, options[:serializer])
+            fieldset = fieldsets[serializer.type]
+
+            build_resource(root, serializer, fieldset)
+
+            root
+          end
+        end
+      end
+
+      # @see http://jsonapi.org/format/1.0/#document-resource-identifier-objects
+      # @param [Hash<Symbol, Object>] context
+      # @param [Serializer] serializer
+      def build_resource_identifier(context, serializer)
+        context[:id] = serializer.id
+        context[:type] = serializer.type
+      end
+
+      # @see http://jsonapi.org/format/1.0/#document-resource-objects
+      # @param [Hash<Symbol, Object>] context
+      # @param [Serializer] serializer
+      # @param [Array<Symbol>, nil] fieldset
+      def build_resource(context, serializer, fieldset)
+        build_resource_identifier(context, serializer)
+
+        attributes = serializer.attributes(fieldset).values
+
+        if attributes.any?
+          build_attributes(context, attributes, serializer)
+        end
+
+        relationships = serializer.relationships(fieldset).values
+
+        if relationships.any?
+          build_relationships(context, relationships, serializer)
+        end
+
+        links = serializer.links
+
+        if links
+          build_links(context, links)
+        end
+      end
+
+      # @see http://jsonapi.org/format/1.0/#document-resource-object-attributes
+      # @param [Hash<Symbol, Object>] context
+      # @param [Array<Attribute>] attributes
+      # @param [Serializer] serializer
+      def build_attributes(context, attributes, serializer)
+        root = {}
+
+        attributes.each do |attribute|
+          root[attribute.name] = attribute.evaluate(serializer)
+        end
+
+        context[:attributes] = root
+      end
+
+      # @see http://jsonapi.org/format/1.0/#document-resource-object-relationships
+      # @param [Hash<Symbol, Object>] context
+      # @param [Array<Relationship>] relationships
+      # @param [Serializer] serializer
+      def build_relationships(context, relationships, serializer)
+        root = {}
+
+        relationships.each do |relationship|
+          build_relationship(root, relationship, serializer)
+        end
+
+        context[:relationships] = root
+      end
+
+      # @see http://jsonapi.org/format/1.0/#document-resource-object-relationships
+      # @see http://jsonapi.org/format/1.0/#document-resource-object-linkage
+      # @param [Hash<Symbol, Object>] context
+      # @param [Relationship] relationship
+      # @param [Serializer] serializer
+      def build_relationship(context, relationship, serializer)
+        root = {}
+
+        if relationship.options[:data] ||
+            override_data?(serializer.options[:linkages], relationship)
+          case relationship
+          when BelongsToRelationship
+            build_belongs_to_relationship(root, relationship, serializer)
+          when HasManyRelationship
+            build_has_many_relationship(root, relationship, serializer)
+          else
+            raise ArgumentError, 'invalid relationship type'
+          end
+        end
+
+        if relationship.options[:links]
+          links = relationship.links(serializer)
+          build_links(root, links)
+        end
+
+        context[relationship.name] = root
+      end
+
+      def override_data?(linkages, relationship)
+        linkages && linkages.include?(relationship.name)
+      end
+
+      # @see http://jsonapi.org/format/1.0/#document-resource-object-linkage
+      # @param [Hash<Symbol, Object>] context
+      # @param [Relationship] relationship
+      # @param [Serializer] serializer
+      def build_belongs_to_relationship(context, relationship, serializer)
+        root = {}
+        resource = relationship.evaluate(serializer)
+        serializer = Serializer.factory(resource, relationship.options[:serializer])
+        build_resource_identifier(root, serializer)
+        context[:data] = root
+      end
+
+      # @see http://jsonapi.org/format/1.0/#document-resource-object-linkage
+      # @param [Hash<Symbol, Object>] context
+      # @param [Relationship] relationship
+      # @param [Serializer] serializer
+      def build_has_many_relationship(context, relationship, serializer)
+        resources = relationship.evaluate(serializer)
+
+        context[:data] =
+          if resources.empty?
+            EMPTY_COLLECTION
+          else
+            resources.map do |resource|
+              root = {}
+              serializer = Serializer.factory(resource, relationship.options[:serializer])
+              build_resource_identifier(root, serializer)
+              root
+            end
+        end
+      end
+
+      # @see http://jsonapi.org/format/1.0/#document-compound-documents
+      # @param [Hash<Symbol, Object>] context
+      # @param [Set<Serializer>] serializers
+      # @param [Hash<String, Array<Symbol>>] fieldsets
+      def build_included(context, serializers, fieldsets)
+        context[:included] = serializers.map do |serializer|
+          root = {}
+          fieldset = fieldsets[serializer.type]
+          build_resource(root, serializer, fieldset)
+          root
+        end
+      end
+
+      # @see http://jsonapi.org/format/1.0/#error-objects
+      # @param [Hash<Symbol, Object>] context
+      # @param [Array<Hash<Symbol, Object>>] errors
+      def build_errors(context, errors)
+        context[:errors] = errors
+      end
+    end
+  end
+end

data/lib/jei/fieldset.rb

@@ -1,6 +1,6 @@
 module Jei
   class Fieldset
-    NAME_SEPARATOR = ','
+    NAME_SEPARATOR = ','.freeze
 
     def self.parse(raw_fields)
       fields = {}

data/lib/jei/path.rb

@@ -2,8 +2,8 @@ module Jei
   class Path
     class NameError < Jei::Error; end
 
-    PATH_SEPARATOR = ','
-    NAME_SEPARATOR = '.'
+    PATH_SEPARATOR = ','.freeze
+    NAME_SEPARATOR = '.'.freeze
 
     # @return [Array<Symbol>]
     attr_reader :names
@@ -37,8 +37,15 @@ module Jei
       return if level >= @names.length
 
       name = @names[level]
+
       relationship = serializer.relationships[name]
       raise NameError, "invalid relationship name `#{name}'" unless relationship
+
+      unless relationship.options[:data]
+        serializer.options[:linkages] = Set.new unless serializer.options[:linkages]
+        serializer.options[:linkages] << name
+      end
+
       resources = [*relationship.evaluate(serializer)]
 
       resources.each do |resource|

data/lib/jei/serializer.rb

@@ -1,6 +1,6 @@
 module Jei
   class Serializer
-    # @return [#id]
+    # @return [Object]
     attr_reader :resource
 
     # @return [Hash<Symbol, Attribute>]
@@ -62,8 +62,10 @@ module Jei
     end
 
     # @param [#id] resource
-    def initialize(resource)
+    # @param [Hash<Symbol, Object>] options
+    def initialize(resource, options = nil)
       @resource = resource
+      @options = options
     end
 
     # @return [String]
@@ -93,6 +95,11 @@ module Jei
       nil
     end
 
+    # @return [Hash<Symbol, Object>]
+    def options
+      @options ||= {}
+    end
+
     # @return [Array<String>]
     def key
       [type, id]
@@ -100,13 +107,17 @@ module Jei
 
     # @return [Boolean]
     def ==(other)
-      key == other.key
+      hash == other.hash
     end
     alias_method :eql?, :==
 
+    # Returns a digest for this serializer.
+    #
+    # The second element is shifted to preserve order.
+    #
     # @return [Fixnum]
     def hash
-      key.hash
+      type.hash ^ (id.hash >> 1)
     end
 
     private

data/lib/jei/version.rb

@@ -1,3 +1,3 @@
 module Jei
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jei
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Macias
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-22 00:00:00.000000000 Z
+date: 2016-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,34 +86,12 @@ files:
 - jei.gemspec
 - lib/jei.rb
 - lib/jei/attribute.rb
-- lib/jei/builders/attributes_node_builder.rb
-- lib/jei/builders/data_node_builder.rb
-- lib/jei/builders/document_builder.rb
-- lib/jei/builders/included_node_builder.rb
-- lib/jei/builders/links_node_builder.rb
-- lib/jei/builders/relationship_node_builder.rb
-- lib/jei/builders/relationships_node_builder.rb
-- lib/jei/builders/resource_node_builder.rb
 - lib/jei/document.rb
+- lib/jei/document/builder.rb
 - lib/jei/error.rb
 - lib/jei/field.rb
 - lib/jei/fieldset.rb
 - lib/jei/link.rb
-- lib/jei/nodes/attribute_node.rb
-- lib/jei/nodes/attributes_node.rb
-- lib/jei/nodes/collection_data_node.rb
-- lib/jei/nodes/data_node.rb
-- lib/jei/nodes/document_node.rb
-- lib/jei/nodes/included_node.rb
-- lib/jei/nodes/json_api_node.rb
-- lib/jei/nodes/link_node.rb
-- lib/jei/nodes/links_node.rb
-- lib/jei/nodes/meta_node.rb
-- lib/jei/nodes/node.rb
-- lib/jei/nodes/relationship_node.rb
-- lib/jei/nodes/relationships_node.rb
-- lib/jei/nodes/resource_identifier_node.rb
-- lib/jei/nodes/resource_node.rb
 - lib/jei/path.rb
 - lib/jei/relationship.rb
 - lib/jei/serializer.rb

data/lib/jei/builders/attributes_node_builder.rb

@@ -1,19 +0,0 @@
-module Jei
-  module Builders
-    module AttributesNodeBuilder
-      include Nodes
-
-      # @param [Serializer] serializer
-      # @return [AttributesNode]
-      def self.build(attributes, serializer)
-        node = AttributesNode.new
-
-        attributes.each do |attribute|
-          node.children << AttributeNode.new(serializer, attribute)
-        end
-
-        node
-      end
-    end
-  end
-end

data/lib/jei/builders/data_node_builder.rb

@@ -1,15 +0,0 @@
-module Jei
-  module Builders
-    module DataNodeBuilder
-      include Nodes
-
-      # @param [Serializer] serializer
-      # @return [DataNode]
-      def self.build(serializer)
-        node = DataNode.new
-        node.children << ResourceNodeBuilder.build(serializer)
-        node
-      end
-    end
-  end
-end

data/lib/jei/builders/document_builder.rb

@@ -1,70 +0,0 @@
-module Jei
-  module Builders
-    module DocumentBuilder
-      include Nodes
-
-      # @param [Object] resource
-      # @param [Hash<Symbol, Object>] options
-      # @return [Document]
-      def self.build(resource, options = {})
-        document = Document.new
-        root = document.root
-
-        root.children << JSONAPINode.new if options[:jsonapi]
-        root.children << MetaNode.new(options[:meta]) if options[:meta]
-        root.children << LinksNodeBuilder.build(options[:links]) if options[:links]
-
-        if resource.nil?
-          root.children << DataNode.new
-          return document
-        end
-
-        fieldsets = options[:fields] ? Fieldset.parse(options[:fields]) : {}
-
-        if resource.is_a?(Enumerable)
-          node = CollectionDataNode.new
-
-          if options[:include]
-            paths = Path.parse(options[:include])
-            serializers = Set.new
-
-            resource.each do |r|
-              serializer = Serializer.factory(r, options[:serializer])
-              Path.find(paths, serializer, serializers)
-              fieldset = fieldsets[serializer.type]
-              node.children << ResourceNodeBuilder.build(serializer, fieldset)
-            end
-
-            root.children << IncludedNodeBuilder.build(serializers, fieldsets)
-          else
-            resource.each do |r|
-              serializer = Serializer.factory(r, options[:serializer])
-              fieldset = fieldsets[serializer.type]
-              node.children << ResourceNodeBuilder.build(serializer, fieldset)
-            end
-          end
-
-          root.children << node
-        else
-          node = DataNode.new
-
-          serializer = Serializer.factory(resource, options[:serializer])
-          fieldset = fieldsets[serializer.type]
-
-          node.children << ResourceNodeBuilder.build(serializer, fieldset)
-
-          if options[:include]
-            paths = Path.parse(options[:include])
-            serializers = Set.new
-            Path.find(paths, serializer, serializers)
-            root.children << IncludedNodeBuilder.build(serializers, fieldsets)
-          end
-
-          root.children << node
-        end
-
-        document
-      end
-    end
-  end
-end

data/lib/jei/builders/included_node_builder.rb

@@ -1,21 +0,0 @@
-module Jei
-  module Builders
-    module IncludedNodeBuilder
-      include Nodes
-
-      # @param [Set<Serializer>] serializers
-      # @param [Hash<String, String>] fieldset
-      # @return [IncludedNode]
-      def self.build(serializers, fieldsets = {})
-        node = IncludedNode.new
-
-        serializers.each do |serializer|
-          fieldset = fieldsets[serializer.type]
-          node.children << ResourceNodeBuilder.build(serializer, fieldset)
-        end
-
-        node
-      end
-    end
-  end
-end

data/lib/jei/builders/links_node_builder.rb

@@ -1,19 +0,0 @@
-module Jei
-  module Builders
-    module LinksNodeBuilder
-      include Nodes
-
-      # @param [Array<Link>] links
-      # @return [LinksNode]
-      def self.build(links)
-        links_node = LinksNode.new
-
-        links.each do |link|
-          links_node.children << LinkNode.new(link)
-        end
-
-        links_node
-      end
-    end
-  end
-end

data/lib/jei/builders/relationship_node_builder.rb

@@ -1,68 +0,0 @@
-module Jei
-  module Builders
-    module RelationshipNodeBuilder
-      include Nodes
-
-      # @param [Relationship] relationship
-      # @param [Serializer] serializer
-      # @return [RelationshipNode]
-      def self.build(relationship, serializer)
-        node = RelationshipNode.new(relationship)
-
-        if relationship.options[:data]
-          node.children <<
-            case relationship
-            when BelongsToRelationship
-              build_data_node(relationship, serializer)
-            when HasManyRelationship
-              build_collection_data_node(relationship, serializer)
-            else
-              raise ArgumentError, 'invalid relationship type'
-            end
-        end
-
-        if relationship.options[:links]
-          node.children << build_links_node(relationship, serializer)
-        end
-
-        node
-      end
-
-      # @param [Relationship] relationship
-      # @param [Serializer] serializer
-      # @return [DataNode]
-      def self.build_data_node(relationship, serializer)
-        node = DataNode.new
-        resource = relationship.evaluate(serializer)
-
-        serializer = Serializer.factory(resource, relationship.options[:serializer])
-        node.children << ResourceIdentifierNode.new(serializer)
-
-        node
-      end
-
-      # @param [Relationship] relationship
-      # @param [Serializer] serializer
-      # @return [CollectionDataNode]
-      def self.build_collection_data_node(relationship, serializer)
-        node = CollectionDataNode.new
-        resources = relationship.evaluate(serializer)
-
-        resources.each do |resource|
-          serializer = Serializer.factory(resource, relationship.options[:serializer])
-          node.children << ResourceIdentifierNode.new(serializer)
-        end
-
-        node
-      end
-
-      # @param [Relationship] relationship
-      # @param [Serializer] serializer
-      # @return [LinksNode]
-      def self.build_links_node(relationship, serializer)
-        links = relationship.links(serializer)
-        LinksNodeBuilder.build(links)
-      end
-    end
-  end
-end

data/lib/jei/builders/relationships_node_builder.rb

@@ -1,19 +0,0 @@
-module Jei
-  module Builders
-    module RelationshipsNodeBuilder
-      include Nodes
-
-      # @param [Serializer] serializer
-      # @return [RelationshipsNode]
-      def self.build(relationships, serializer)
-        node = RelationshipsNode.new
-
-        relationships.each do |relationship|
-          node.children << RelationshipNodeBuilder.build(relationship, serializer)
-        end
-
-        node
-      end
-    end
-  end
-end

data/lib/jei/builders/resource_node_builder.rb

@@ -1,36 +0,0 @@
-module Jei
-  module Builders
-    module ResourceNodeBuilder
-      include Nodes
-
-      # @param [Serializer] serializer
-      # @param [Array<Symbol>] fieldset
-      # @return [ResourceNode]
-      def self.build(serializer, fieldset = nil)
-        node = ResourceNode.new
-
-        node.children << ResourceIdentifierNode.new(serializer)
-
-        attributes = serializer.attributes(fieldset).values
-
-        if attributes.any?
-          node.children << AttributesNodeBuilder.build(attributes, serializer)
-        end
-
-        relationships = serializer.relationships(fieldset).values
-
-        if relationships.any?
-          node.children << RelationshipsNodeBuilder.build(relationships, serializer)
-        end
-
-        links = serializer.links
-
-        if links
-          node.children << LinksNodeBuilder.build(links)
-        end
-
-        node
-      end
-    end
-  end
-end

data/lib/jei/nodes/attribute_node.rb

@@ -1,19 +0,0 @@
-module Jei
-  module Nodes
-    # @see http://jsonapi.org/format/1.0/#document-resource-object-attributes
-    class AttributeNode < Node
-      # @param [Serializer] serializer
-      # @param [Attribute] attribute
-      def initialize(serializer, attribute)
-        super()
-        @serializer = serializer
-        @attribute = attribute
-      end
-
-      # @param [Hash<Symbol, Object>] context
-      def visit(context)
-        context[@attribute.name] = @attribute.evaluate(@serializer)
-      end
-    end
-  end
-end

data/lib/jei/nodes/attributes_node.rb

@@ -1,13 +0,0 @@
-module Jei
-  module Nodes
-    # @see http://jsonapi.org/format/1.0/#document-resource-object-attributes
-    class AttributesNode < Node
-      # @param [Hash<Symbol, Object>] context
-      def visit(context)
-        attributes = {}
-        children.each { |child| child.visit(attributes) }
-        context[:attributes] = attributes
-      end
-    end
-  end
-end

data/lib/jei/nodes/collection_data_node.rb

@@ -1,15 +0,0 @@
-module Jei
-  module Nodes
-    # @see http://jsonapi.org/format/#document-top-level
-    class CollectionDataNode < DataNode
-      # @param [Hash<Symbol, Object>] context
-      def visit(context)
-        context[:data] = children.map do |child|
-          data = {}
-          child.visit(data)
-          data
-        end
-      end
-    end
-  end
-end

data/lib/jei/nodes/data_node.rb

@@ -1,18 +0,0 @@
-module Jei
-  module Nodes
-    # @see http://jsonapi.org/format/#document-top-level
-    class DataNode < Node
-      # @param [Hash<Symbol, Object>] context
-      def visit(context)
-        context[:data] =
-          if children.empty?
-            nil
-          else
-            data = {}
-            children.each { |child| child.visit(data) }
-            data
-          end
-      end
-    end
-  end
-end

data/lib/jei/nodes/document_node.rb

@@ -1,11 +0,0 @@
-module Jei
-  module Nodes
-    # @see http://jsonapi.org/format/1.0/#document-top-level
-    class DocumentNode < Node
-      # @param [Hash<Symbol, Object>] context
-      def visit(context)
-        children.each { |child| child.visit(context) }
-      end
-    end
-  end
-end

data/lib/jei/nodes/included_node.rb

@@ -1,14 +0,0 @@
-module Jei
-  module Nodes
-    # @see http://jsonapi.org/format/1.0/#document-compound-documents
-    class IncludedNode < Node
-      def visit(context)
-        context[:included] = children.map do |child|
-          data = {}
-          child.visit(data)
-          data
-        end
-      end
-    end
-  end
-end

data/lib/jei/nodes/json_api_node.rb

@@ -1,11 +0,0 @@
-module Jei
-  module Nodes
-    # @see http://jsonapi.org/format/1.0/#document-jsonapi-object
-    class JSONAPINode < Node
-      # @param [Hash<Symbol, Object>] context
-      def visit(context)
-        context[:jsonapi] = { version: Document::VERSION }
-      end
-    end
-  end
-end

data/lib/jei/nodes/link_node.rb

@@ -1,22 +0,0 @@
-module Jei
-  module Nodes
-    # @see http://jsonapi.org/format/1.0/#document-links
-    class LinkNode < Node
-      # @param [Link] link
-      def initialize(link)
-        super()
-        @link = link
-      end
-
-      # @param [Hash<Symbol, Object>] context
-      def visit(context)
-        context[@link.name] =
-          if @link.meta.any?
-            { href: @link.href, meta: @link.meta }
-          else
-            @link.href
-          end
-      end
-    end
-  end
-end

data/lib/jei/nodes/links_node.rb

@@ -1,13 +0,0 @@
-module Jei
-  module Nodes
-    # @see http://jsonapi.org/format/1.0/#document-links
-    class LinksNode < Node
-      # @param [Hash<Symbol, Object>] context
-      def visit(context)
-        data = {}
-        children.each { |child| child.visit(data) }
-        context[:links] = data
-      end
-    end
-  end
-end

data/lib/jei/nodes/meta_node.rb

@@ -1,17 +0,0 @@
-module Jei
-  module Nodes
-    # @see http://jsonapi.org/format/1.0/#document-meta
-    class MetaNode < Node
-      # param [Hash<Symbol, Object>] meta
-      def initialize(meta)
-        super()
-        @meta = meta
-      end
-
-      # @param [Hash<Symbol, Object>] context
-      def visit(context)
-        context[:meta] = @meta
-      end
-    end
-  end
-end

data/lib/jei/nodes/node.rb

@@ -1,19 +0,0 @@
-module Jei
-  module Nodes
-    # @abstract
-    class Node
-      # @return [Array<Node>]
-      attr_reader :children
-
-      def initialize
-        @children = []
-      end
-
-      # @abstract
-      # @param [Hash<Symbol, Object>] _context
-      def visit(_context)
-        raise NotImplementedError
-      end
-    end
-  end
-end

data/lib/jei/nodes/relationship_node.rb

@@ -1,19 +0,0 @@
-module Jei
-  module Nodes
-    # @see http://jsonapi.org/format/1.0/#document-resource-object-relationships
-    class RelationshipNode < Node
-      # @param [Relationship] relationship
-      def initialize(relationship)
-        super()
-        @relationship = relationship
-      end
-
-      # @param [Hash<Symbol, Object>] context
-      def visit(context)
-        data = {}
-        children.each { |child| child.visit(data) }
-        context[@relationship.name] = data
-      end
-    end
-  end
-end

data/lib/jei/nodes/relationships_node.rb

@@ -1,13 +0,0 @@
-module Jei
-  module Nodes
-    # @see http://jsonapi.org/format/1.0/#document-resource-object-relationships
-    class RelationshipsNode < Node
-      # @param [Hash<Symbol, Object>] context
-      def visit(context)
-        relationships = {}
-        children.each { |child| child.visit(relationships) }
-        context[:relationships] = relationships
-      end
-    end
-  end
-end

data/lib/jei/nodes/resource_identifier_node.rb

@@ -1,18 +0,0 @@
-module Jei
-  module Nodes
-    # http://jsonapi.org/format/1.0/#document-resource-identifier-objects
-    class ResourceIdentifierNode < Node
-      # param [Serializer] serializer
-      def initialize(serializer)
-        super()
-        @serializer = serializer
-      end
-
-      # @param [Hash<Symbol, Object>] context
-      def visit(context)
-        context[:id] = @serializer.id
-        context[:type] = @serializer.type
-      end
-    end
-  end
-end

data/lib/jei/nodes/resource_node.rb

@@ -1,11 +0,0 @@
-module Jei
-  module Nodes
-    # http://jsonapi.org/format/1.0/#document-resource-objects
-    class ResourceNode < Node
-      # @param [Hash<Symbol, Object>] context
-      def visit(context)
-        children.each { |child| child.visit(context) }
-      end
-    end
-  end
-end