jei 0.1.0 → 0.2.0

data/lib/jei.rb

@@ -1,14 +1,7 @@
 require 'json'
 require 'set'
 
-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/error'
 
 require 'jei/nodes/node'
 
@@ -28,14 +21,23 @@ require 'jei/nodes/resource_node'
 require 'jei/nodes/data_node'
 require 'jei/nodes/collection_data_node'
 
-require 'jei/attribute'
+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/fieldset'
 require 'jei/link'
 require 'jei/path'
-require 'jei/relationship'
 require 'jei/serializer'
 
-require 'jei/version'
+require 'jei/field'
+require 'jei/attribute'
+require 'jei/relationship'
 
-module Jei
-end
+require 'jei/version'

data/lib/jei/attribute.rb

@@ -1,22 +1,4 @@
 module Jei
-  class Attribute
-    # @return [Symbol]
-    attr_reader :name
-
-    # @param [Symbol] name
-    # @param [Proc, Symbol] value
-    def initialize(name, value = name)
-      @name = name
-      @value = value
-    end
-
-    # @param [Serializer] serializer
-    def evaluate(serializer)
-      if @value.is_a?(Proc)
-        serializer.instance_eval(&@value)
-      else
-        serializer.resource.send(@value)
-      end
-    end
+  class Attribute < Field
   end
 end

data/lib/jei/builders/attributes_node_builder.rb

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

data/lib/jei/builders/data_node_builder.rb

@@ -1,6 +1,8 @@
 module Jei
-  module Builder
+  module Builders
     module DataNodeBuilder
+      include Nodes
+
       # @param [Serializer] serializer
       # @return [DataNode]
       def self.build(serializer)

data/lib/jei/builders/document_builder.rb

@@ -1,6 +1,8 @@
 module Jei
-  module Builder
+  module Builders
     module DocumentBuilder
+      include Nodes
+
       # @param [Object] resource
       # @param [Hash<Symbol, Object>] options
       # @return [Document]
@@ -17,57 +19,48 @@ module Jei
           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])
-            included_resources = Set.new
+            serializers = Set.new
 
             resource.each do |r|
-              Path.find(paths, r, included_resources)
-
-              serializer =
-                if options[:serializer]
-                  options[:serializer].new(r)
-                else
-                  Serializer.factory(r)
-                end
-
-              node.children << ResourceNodeBuilder.build(serializer)
+              serializer = Serializer.factory(r, options[:serializer])
+              Path.find(paths, serializer, serializers)
+              fieldset = fieldsets[serializer.type]
+              node.children << ResourceNodeBuilder.build(serializer, fieldset)
             end
 
-            root.children << IncludedNode.build(included_resources)
+            root.children << IncludedNodeBuilder.build(serializers, fieldsets)
           else
             resource.each do |r|
-              serializer =
-                if options[:serializer]
-                  options[:serializer].new(r)
-                else
-                  Serializer.factory(r)
-                end
-
-              node.children << ResourceNodeBuilder.build(serializer)
+              serializer = Serializer.factory(r, options[:serializer])
+              fieldset = fieldsets[serializer.type]
+              node.children << ResourceNodeBuilder.build(serializer, fieldset)
             end
           end
 
           root.children << node
         else
-          serializer =
-            if options[:serializer]
-              options[:serializer].new(resource)
-            else
-              Serializer.factory(resource)
-            end
+          node = DataNode.new
+
+          serializer = Serializer.factory(resource, options[:serializer])
+          fieldset = fieldsets[serializer.type]
 
-          root.children << DataNodeBuilder.build(serializer)
+          node.children << ResourceNodeBuilder.build(serializer, fieldset)
 
           if options[:include]
             paths = Path.parse(options[:include])
-            included_resources = Set.new
-            Path.find(paths, resource, included_resources)
-            root.children << IncludedNodeBuilder.build(included_resources)
+            serializers = Set.new
+            Path.find(paths, serializer, serializers)
+            root.children << IncludedNodeBuilder.build(serializers, fieldsets)
           end
+
+          root.children << node
         end
 
         document

data/lib/jei/builders/included_node_builder.rb

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

data/lib/jei/builders/links_node_builder.rb

@@ -1,6 +1,8 @@
 module Jei
-  module Builder
+  module Builders
     module LinksNodeBuilder
+      include Nodes
+
       # @param [Array<Link>] links
       # @return [LinksNode]
       def self.build(links)

data/lib/jei/builders/relationship_node_builder.rb

@@ -1,13 +1,15 @@
 module Jei
-  module Builder
+  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[:no_data]
+        if relationship.options[:data]
           node.children <<
             case relationship
             when BelongsToRelationship
@@ -33,7 +35,7 @@ module Jei
         node = DataNode.new
         resource = relationship.evaluate(serializer)
 
-        serializer = Serializer.factory(resource)
+        serializer = Serializer.factory(resource, relationship.options[:serializer])
         node.children << ResourceIdentifierNode.new(serializer)
 
         node
@@ -47,7 +49,7 @@ module Jei
         resources = relationship.evaluate(serializer)
 
         resources.each do |resource|
-          serializer = Serializer.factory(resource)
+          serializer = Serializer.factory(resource, relationship.options[:serializer])
           node.children << ResourceIdentifierNode.new(serializer)
         end
 

data/lib/jei/builders/relationships_node_builder.rb

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

data/lib/jei/builders/resource_node_builder.rb

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

data/lib/jei/document.rb

@@ -6,23 +6,27 @@ module Jei
     # @return [DocumentNode]
     attr_reader :root
 
+    # Builds a document from a resource.
+    #
     # @param [Object] resource
     # @param [Hash<Symbol, Object>] options
-    # @option options [Boolean] :jsonapi Add the top level JSON API object to
-    #   the document.
-    # @option options [Array<Link>] :links Add links related to the primary
-    #   data.
-    # @option options [Hash<Symbol, Object>] :meta Add top level meta
-    #   information to the document.
-    # @option options [Class] :serializer Override the default serializer. For
-    #   collections, this works only if all the resources are of the same type.
+    # @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
+    # @option options [Boolean] :jsonapi add the top level JSON API object to
+    #   the document
+    # @option options [Array<Link>] :links add links related to the primary
+    #   data
+    # @option options [Hash<Symbol, Object>] :meta add top level meta
+    #   information to the document
+    # @option options [Class] :serializer override the default serializer
     # @return [Document]
     def self.build(resource, options = {})
-      Builder::DocumentBuilder.build(resource, options)
+      Builders::DocumentBuilder.build(resource, options)
     end
 
     def initialize
-      @root = DocumentNode.new
+      @root = Nodes::DocumentNode.new
     end
 
     # @return [Hash<Symbol, Object>]

data/lib/jei/error.rb

@@ -0,0 +1,4 @@
+module Jei
+  class Error < RuntimeError
+  end
+end

data/lib/jei/field.rb

@@ -0,0 +1,22 @@
+module Jei
+  class Field
+    # @return [Symbol]
+    attr_reader :name
+
+    # @param [Symbol] name
+    # @param [Proc, Symbol] value
+    def initialize(name, value = name)
+      @name = name
+      @value = value
+    end
+
+    # @param [Serializer] serializer
+    def evaluate(serializer)
+      if @value.is_a?(Proc)
+        serializer.instance_eval(&@value)
+      else
+        serializer.resource.send(@value)
+      end
+    end
+  end
+end

data/lib/jei/fieldset.rb

@@ -0,0 +1,15 @@
+module Jei
+  class Fieldset
+    NAME_SEPARATOR = ','
+
+    def self.parse(raw_fields)
+      fields = {}
+
+      raw_fields.each do |type, names|
+        fields[type] = names.split(NAME_SEPARATOR).map(&:to_sym)
+      end
+
+      fields
+    end
+  end
+end

data/lib/jei/nodes/attribute_node.rb

@@ -1,17 +1,19 @@
 module Jei
-  # @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
+  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)
+      # @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,11 +1,13 @@
 module Jei
-  # @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
+  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