jei 0.1.0 → 0.2.0

data/lib/jei/nodes/collection_data_node.rb

@@ -1,12 +1,14 @@
 module Jei
-  # @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
+  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

data/lib/jei/nodes/data_node.rb

@@ -1,16 +1,18 @@
 module Jei
-  # @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
+  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,9 +1,11 @@
 module Jei
-  # @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) }
+  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,11 +1,13 @@
 module Jei
-  # @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
+  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

data/lib/jei/nodes/json_api_node.rb

@@ -1,9 +1,11 @@
 module Jei
-  # @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 }
+  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,20 +1,22 @@
 module Jei
-  # @see http://jsonapi.org/format/1.0/#document-links
-  class LinkNode < Node
-    # @param [Link] link
-    def initialize(link)
-      super()
-      @link = link
-    end
+  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
+      # @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,11 +1,13 @@
 module Jei
-  # @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
+  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,15 +1,17 @@
 module Jei
-  # @see http://jsonapi.org/format/1.0/#document-meta
-  class MetaNode < Node
-    # param [Hash<Symbol, Object>] meta
-    def initialize(meta)
-      super()
-      @meta = meta
-    end
+  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
+      # @param [Hash<Symbol, Object>] context
+      def visit(context)
+        context[:meta] = @meta
+      end
     end
   end
 end

data/lib/jei/nodes/node.rb

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

data/lib/jei/nodes/relationship_node.rb

@@ -1,17 +1,19 @@
 module Jei
-  # @see http://jsonapi.org/format/1.0/#document-resource-object-relationships
-  class RelationshipNode < Node
-    # @param [Relationship] relationship
-    def initialize(relationship)
-      super()
-      @relationship = relationship
-    end
+  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
+      # @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,11 +1,13 @@
 module Jei
-  # @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
+  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,16 +1,18 @@
 module Jei
-  # http://jsonapi.org/format/1.0/#document-resource-identifier-objects
-  class ResourceIdentifierNode < Node
-    # param [Serializer] serializer
-    def initialize(serializer)
-      super()
-      @serializer = serializer
-    end
+  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
+      # @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,9 +1,11 @@
 module Jei
-  # 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) }
+  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

data/lib/jei/path.rb

@@ -1,5 +1,7 @@
 module Jei
   class Path
+    class NameError < Jei::Error; end
+
     PATH_SEPARATOR = ','
     NAME_SEPARATOR = '.'
 
@@ -15,11 +17,11 @@ module Jei
     end
 
     # @param [Array<Path>] paths
-    # @param [Object] resource
-    # @param [Set<Object>] resources
-    def self.find(paths, resource, resources)
+    # @param [Serializer] serializer
+    # @param [Set<Serializer>] serializers
+    def self.find(paths, serializer, serializers)
       paths.each do |path|
-        path.walk(resource, resources)
+        path.walk(serializer, serializers)
       end
     end
 
@@ -28,22 +30,21 @@ module Jei
       @names = names
     end
 
-    # @param [Object] root
-    # @param [Set<Object>] set
+    # @param [Serializer] serializer
+    # @param [Set<Serializer>] serializers
     # @param [Integer] level
-    def walk(root, set = Set.new, level = 0)
+    def walk(serializer, serializers, level = 0)
       return if level >= @names.length
 
-      serializer = Serializer.factory(root)
-
       name = @names[level]
       relationship = serializer.relationships[name]
+      raise NameError, "invalid relationship name `#{name}'" unless relationship
       resources = [*relationship.evaluate(serializer)]
 
-      set.merge(resources)
-
       resources.each do |resource|
-        walk(resource, set, level + 1)
+        serializer = Serializer.factory(resource, relationship.options[:serializer])
+        serializers << serializer
+        walk(serializer, serializers, level + 1)
       end
     end
   end

data/lib/jei/relationship.rb

@@ -1,23 +1,26 @@
 module Jei
-  class Relationship < Attribute
+  class Relationship < Field
     # @return [Hash<Symbol, Object>] options
     attr_reader :options
 
     # @param [Symbol] name
     # @param [Proc, Symbol] value
     # @param [Hash<Symbol, Object>] options
-    # @option options [Boolean] :no_data Whether to exclude data from the
-    #   relationship.
-    # @option options [Proc] :links A Proc that evaulates to a list of links.
+    # @option options [Boolean] :data (true) whether to include data in the
+    #   relationship
+    # @option options [Proc] :links a `Proc` that evaulates to a list of links
+    # @option options [Class] :serializer override the default serializer used
+    #   for related resources
     def initialize(name, value = name, options = {})
       super(name, value)
+      options[:data] = options.fetch(:data, true)
       @options = options
     end
 
     # @param [Serializer] serializer
     # @return [Array<Link>]
     def links(serializer)
-      serializer.instance_eval(&options[:links])
+      serializer.instance_exec(&options[:links])
     end
   end
 

data/lib/jei/serializer.rb

@@ -4,8 +4,8 @@ module Jei
     attr_reader :resource
 
     # @return [Hash<Symbol, Attribute>]
-    def self.serialization_map
-      @serialization_map ||= Hash.new { |h, k| h[k] = {} }
+    def self.fields
+      @fields ||= Hash.new { |h, k| h[k] = {} }
     end
 
     # @overload attributes(name, ...)
@@ -18,27 +18,46 @@ module Jei
     # @param [Symbol] name
     def self.attribute(name, &blk)
       value = block_given? ? blk : name
-      serialization_map[:attributes][name] = Attribute.new(name, value)
+      fields[:attributes][name] = Attribute.new(name, value)
     end
 
     # @param [Symbol] name
+    # @param [Hash<Symbol, Object>] options
+    # @see Relationship#initialize
     def self.belongs_to(name, options = {}, &blk)
       value = block_given? ? blk : name
-      serialization_map[:relationships][name] =
+      fields[:relationships][name] =
         BelongsToRelationship.new(name, value, options)
     end
 
     # @param [Symbol] name
+    # @param [Hash<Symbol, Object>] options
+    # @see Relationship#initialize
     def self.has_many(name, options = {}, &blk)
       value = block_given? ? blk : name
-      serialization_map[:relationships][name] =
+      fields[:relationships][name] =
         HasManyRelationship.new(name, value, options)
     end
 
+    # Instantiates a new serializer based on the type of the given resource.
+    #
+    # This assumes serializer classes are defined in the global namespace. If
+    # not, a serializer class can be passed to override the lookup.
+    #
+    # @example
+    #   artist = Artist.new
+    #
+    #   serializer = Serializer.factory(artist)
+    #   # => #<ArtistSerializer>
+    #
+    #   serializer = Serializer.factory(artist, SimpleArtistSerializer)
+    #   # => #<SimpleArtistSerializer>
+    #
+    # @param [Object] resource
+    # @param [Class] klass the class used instead of serializer lookup
     # @return [Serializer]
-    def self.factory(resource)
-      name = resource.class.name
-      klass = const_get("#{name}Serializer")
+    def self.factory(resource, klass = nil)
+      klass ||= const_get("#{resource.class.name}Serializer")
       klass.new(resource)
     end
 
@@ -57,19 +76,58 @@ module Jei
       "#{resource.class.name.downcase}s"
     end
 
+    # @param [Array<Symbol>] fieldset
     # @return [Hash<Symbol, Attribute>]
-    def attributes
-      self.class.serialization_map[:attributes]
+    def attributes(fieldset = nil)
+      fields(:attributes, fieldset)
     end
 
+    # @param [Array<Symbol>] fieldset
     # @return [Hash<Symbol, Relationship>]
-    def relationships
-      self.class.serialization_map[:relationships]
+    def relationships(fieldset = nil)
+      fields(:relationships, fieldset)
     end
 
     # @return [Array<Link>, nil]
     def links
       nil
     end
+
+    # @return [Array<String>]
+    def key
+      [type, id]
+    end
+
+    # @return [Boolean]
+    def ==(other)
+      key == other.key
+    end
+    alias_method :eql?, :==
+
+    # @return [Fixnum]
+    def hash
+      key.hash
+    end
+
+    private
+
+    # @param [Symbol] type
+    # @param [Array<Symbol>] fieldset
+    # @return [Hash<Symbol, Field>]
+    def fields(type, fieldset = nil)
+      fields = self.class.fields[type]
+
+      if fieldset
+        slice = {}
+
+        fieldset.each do |name|
+          slice[name] = fields[name] if fields.has_key?(name)
+        end
+
+        slice
+      else
+        fields
+      end
+    end
   end
 end