jsonapi-serializable 0.1.1.beta3 → 0.1.1.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a382b6d5802f167908d0d6ee82605a7a52d43a0
-  data.tar.gz: 9c9211218919e4a05e74b010cbc9a5ad51c6533e
+  metadata.gz: 5b7a55ca51fb13e04ac2c96153ea3558aef19d35
+  data.tar.gz: 7a378903d6206bdc7cb203bd47a5ec415034ec87
 SHA512:
-  metadata.gz: bf14811ff7b926f43b45c9cf49032d3fc0c0fe507d4c446d2108fd948de2c5c782cba5b3e90bfe5e6893ee0ef18dcddaf6c91de9e7052445fae25f1b747f65e0
-  data.tar.gz: 14e585466ae7124d51c0d7562e52fbff0982f91025ed71ad9f6a01e1100379b241e1ccea9248d2ebe84a273bdf50d020671b41a80c672f819226c4cfdc0c9a69
+  metadata.gz: a29424f72a6a0170319503da5f7aa3a8bb62633cdcd496d0e0ae89f5a7431fe6b9dd763e8ff6fe44aa2823fa897c191434f6fe211836cc3133dcc57654ebb065
+  data.tar.gz: 18ead5e2f56d6cad50e432c4d09f5f7590df9d27e1b52348d0d3ca1f72e8efd22065d0c763cd3e1b8340ab692fb7c1fb8633674f572dc5dfa9eeb5475a19d66f

data/README.md

@@ -11,11 +11,8 @@ the [jsonapi-renderer](https://github.com/jsonapi-rb/renderer) gem.
 
   - [Installation](#installation)
   - [Usage](#usage)
-    - [Example for Model-based Resources](#example-for-model-based-resources)
-    - [Example for General Resources](#example-for-general-resources)
   - [Documentation](#documentation)
     - [`JSONAPI::Serializable::Resource` DSL](#jsonapiserializableresource-dsl)
-    - [`JSONAPI::Serializable::Model` DSL](#jsonapiserializablemodel-dsl)
     - [`JSONAPI::Serializable::Relationship` DSL](#jsonapiserializablerelationship-dsl)
     - [`JSONAPI::Serializable::Link` DSL](#jsonapiserializablelink-dsl)
     - [`JSONAPI::Serializable::Error` DSL](#jsonapiserializableerror-dsl)
@@ -44,26 +41,22 @@ require 'jsonapi/serializable'
 
 Then, define some resource classes:
 
-### Example for Model-based Resources
-
-For resources that are simple representations of models, the DSL is simplified:
-
 ```ruby
-class PostResource < JSONAPI::Serializable::Model
+class PostResource < JSONAPI::Serializable::Resource
   type 'posts'
 
   attribute :title
 
   attribute :date do
-    @model.created_at
+    @object.created_at
   end
 
-  has_one :author, UserResource do
+  has_one :author, 'V2::SerializableUser' do
     link(:self) do
-      href @url_helper.link_for_rel('posts', @model.id, 'author')
+      href @url_helpers.link_for_rel('posts', @object.id, 'author')
       meta link_meta: 'some meta'
     end
-    link(:related) { @url_helper.link_for_res('users', @model.author.id) }
+    link(:related) { @url_helpers.link_for_res('users', @object.author.id) }
     meta do
       { relationship_meta: 'some meta' }
     end
@@ -76,78 +69,24 @@ class PostResource < JSONAPI::Serializable::Model
   end
 
   link(:self) do
-    @url_helper.link_for_res('posts', @model.id)
+    @url_helpers.link_for_res('posts', @object.id)
   end
 end
 ```
 
-Then, build your resources from your models and render them:
-```ruby
-# post = some post model
-# UrlHelper is some helper class
-resource = PostResource.new(model: post, url_helper: UrlHelper)
-document = JSONAPI.render(data: resource)
-```
-
-### Example for General Resources
-
-In case your resource is not a simple representation of one of your models,
-the more general `JSONAPI::Serializable::Resource` class can be used.
-
-```ruby
-class PostResource < JSONAPI::Serializable::Resource
-  type 'posts'
-
-  id do
-    @post.id.to_s
-  end
-
-  attribute :title do
-    @post.title
-  end
-
-  attribute :date do
-    @post.date
-  end
-
-  relationship :author do
-    link(:self) do
-      href @url_helper.link_for_rel('posts', @post.id, 'author')
-      meta link_meta: 'some meta'
-    end
-    link(:related) { @url_helper.link_for_res('users', @post.author.id) }
-    data do
-      if @post.author.nil?
-        nil
-      else
-        UserResource.new(user: @post.author, url_helper: @url_helper)
-      end
-    end
-    meta do
-      { relationship_meta: 'some meta' }
-    end
-  end
-
-  meta do
-    { resource_meta: 'some meta' }
-  end
-
-  link(:self) do
-    @url_helper.link_for_res('posts', @post.id)
-  end
-end
-```
-Finally, build your resources from your models and render them:
+Then, render your resources:
 ```ruby
-# post = some post model
-# UrlHelper is some helper class
-resource = PostResource.new(post: post, url_helper: UrlHelper)
-document = JSONAPI.render(data: resource)
+# `post` is some `Post` object
+# `UrlHelpers` is some helper class
+document = JSONAPI::Serializable::Renderer.render(
+  post,
+  expose: { url_helpers: UrlHelpers.new }
+)
 ```
 
 ## Documentation
 
-### `JSONAPI::Serializable::Resource` DSL
+### `JSONAPI::Serializable::AbstractResource` DSL
 
 + `#initialize(hash)`
 
@@ -156,8 +95,8 @@ variables within all DSLs.
 
 Example:
 ```ruby
-SerializablePost.new(post: post, url_helper: url_helper)
-# => You can then use @post and @url_helper from within the DSL.
+SerializablePost.new(post: post, url_helpers: url_helpers)
+# => You can then use @post and @url_helpers from within the DSL.
 ```
 
 + `::type(value = nil, &block)`
@@ -191,13 +130,13 @@ the [`JSONAPI::Serializable::Relationship` DSL](#jsonapiserializablerelationship
 Example:
 ```ruby
 relationship :comments do
-  data do
+  resources do
     @post.comments.map do |c|
-      SerializableComment.new(comment: c, url_helper: @url_helper)
+      SerializableComment.new(comment: c, url_helpers: @url_helpers)
     end
   end
   link :self do
-    @url_helper.link_for_post_comments(post_id: @post.id)
+    @url_helpers.link_for_post_comments(post_id: @post.id)
   end
   meta do
     { count: @post.comments.count }
@@ -232,25 +171,25 @@ meta do
 end
 ```
 
-### `JSONAPI::Serializable::Model` DSL
+### `JSONAPI::Serializable::Resource` DSL
 
-This class is a subclass of `JSONAPI::Serializable::Resource` with a more
+This class is a subclass of `JSONAPI::Serializable::AbstractResource` with a more
 convenient DSL tailored for resources that are direct representation of some
 business models.
 
 + `#initialize(hash)`
 
-See `JSONAPI::Serializable::Resource` DSL.
+See `JSONAPI::Serializable::AbstractResource` DSL.
 
 The model is expected to be provided in the hash with the key `:model`.
 
 + `::type(value = nil, &block)`
 
-See `JSONAPI::Serializable::Resource` DSL.
+See `JSONAPI::Serializable::AbstractResource` DSL.
 
 + `::id(&block)`
 
-See `JSONAPI::Serializable::Resource` DSL.
+See `JSONAPI::Serializable::AbstractResource` DSL.
 
 Defaults to:
 ```ruby
@@ -259,7 +198,7 @@ id { @model.id }
 
 + `::attribute(key, &block)`
 
-See `JSONAPI::Serializable::Resource` DSL.
+See `JSONAPI::Serializable::AbstractResource` DSL.
 
 Defaults to the following when no block is provided:
 ```ruby
@@ -268,6 +207,10 @@ attribute key do
 end
 ```
 
++ `::attributes(*keys)`
+
+Define multiple attributes.
+
 + `::has_one(key, resource_klass = nil, &block)`
 
 Define a `has_one` relationship on the resource.
@@ -296,28 +239,28 @@ end
 
 + `::relationship(key, &block)`
 
-See `JSONAPI::Serializable::Resource` DSL.
+See `JSONAPI::Serializable::AbstractResource` DSL.
 
 + `::link(key, &block)`
 
-See `JSONAPI::Serializable::Resource` DSL.
+See `JSONAPI::Serializable::AbstractResource` DSL.
 
 + `::meta(value = nil, &block)`
 
-See `JSONAPI::Serializable::Resource` DSL.
+See `JSONAPI::Serializable::AbstractResource` DSL.
 
 ### `JSONAPI::Serializable::Relationship` DSL
 
-+ `::data(resource_class = nil, &block)`
++ `::resources(resource_class = nil, &block)`
 
-NOTE: This section is outdated. It is still valid, but the data method is now
-much more flexible.
+NOTE: This section is outdated. It is still valid, but the resources method is
+now much more flexible.
 
 Defines the related serializable resources for the relationship.
 
 Example:
 ```ruby
-data do
+resources do
   if @post.author.nil?
     nil
   else
@@ -326,17 +269,21 @@ data do
 end
 ```
 
++ `::data(&block)`
+
+Explicitly define linkage data (optional).
+
 + `::link(key, &block)`
 
 Define a relationship-level link.
 
-See `JSONAPI::Serializable::Resource` DSL.
+See `JSONAPI::Serializable::AbstractResource` DSL.
 
 + `::meta(value = nil, &block)`
 
 Define some relationship-level meta member.
 
-See `JSONAPI::Serializable::Resource` DSL.
+See `JSONAPI::Serializable::AbstractResource` DSL.
 
 ### `JSONAPI::Serializable::Link` DSL
 

data/lib/jsonapi/serializable/abstract_resource.rb

@@ -0,0 +1,122 @@
+require 'jsonapi/serializable/link'
+require 'jsonapi/serializable/relationship'
+require 'jsonapi/serializable/abstract_resource_dsl'
+
+module JSONAPI
+  module Serializable
+    class AbstractResource
+      include AbstractResourceDSL
+
+      class << self
+        attr_accessor :id_block,
+                      :type_val, :type_block,
+                      :meta_val, :meta_block,
+                      :attribute_blocks,
+                      :relationship_blocks,
+                      :link_blocks
+      end
+
+      self.attribute_blocks    = {}
+      self.relationship_blocks = {}
+      self.link_blocks         = {}
+
+      def self.inherited(klass)
+        super
+        klass.type_val            = type_val
+        klass.type_block          = type_block
+        klass.id_block            = id_block
+        klass.meta_val            = meta_val
+        klass.meta_block          = meta_block
+        klass.attribute_blocks    = attribute_blocks.dup
+        klass.relationship_blocks = relationship_blocks.dup
+        klass.link_blocks         = link_blocks.dup
+      end
+
+      def initialize(exposures = {})
+        exposures.each { |k, v| instance_variable_set("@#{k}", v) }
+        @_exposures     = exposures
+        @_type          = _type
+        @_id            = _id
+        @_attributes    = {}
+        @_relationships = _relationships
+        @_meta          = _meta
+        @_links         = _links
+      end
+
+      def as_jsonapi(fields: nil, include: [])
+        {}.tap do |hash|
+          hash[:id]    = @_id
+          hash[:type]  = @_type
+          hash[:links] = @_links if @_links.any?
+          hash[:meta]  = @_meta  unless @_meta.nil?
+
+          attrs = requested_attributes(fields)
+          hash[:attributes] = attrs if attrs.any?
+
+          rels = requested_relationships(fields, include)
+          hash[:relationships] = rels if rels.any?
+        end
+      end
+
+      def jsonapi_type
+        @_type
+      end
+
+      def jsonapi_id
+        @_id
+      end
+
+      def jsonapi_related(include)
+        @_relationships
+          .select { |k, _| include.include?(k) }
+          .each_with_object({}) { |(k, v), h| h[k] = v.related_resources }
+      end
+
+      private
+
+      def _type
+        self.class.type_val || instance_eval(&self.class.type_block)
+      end
+
+      def _id
+        instance_eval(&self.class.id_block)
+      end
+
+      def _relationships
+        self.class.relationship_blocks
+            .each_with_object({}) do |(k, v), h|
+          h[k] = Relationship.new(@_exposures, &v)
+        end
+      end
+
+      def _meta
+        if self.class.meta_block
+          instance_eval(&self.class.meta_block)
+        else
+          self.class.meta_val
+        end
+      end
+
+      def _links
+        self.class.link_blocks
+            .each_with_object({}) do |(k, v), h|
+          h[k] = Link.as_jsonapi(@_exposures, &v)
+        end
+      end
+
+      def requested_attributes(fields)
+        self.class.attribute_blocks
+            .select { |k, _| fields.nil? || fields.include?(k) }
+            .each_with_object({}) { |(k, v), h| h[k] = instance_eval(&v) }
+      end
+
+      def requested_relationships(fields, include)
+        @_relationships
+          .select { |k, _| fields.nil? || fields.include?(k) }
+          .each_with_object({}) do |(k, v), h|
+          h[k] = v.as_jsonapi(include.include?(k))
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/serializable/abstract_resource_dsl.rb

@@ -0,0 +1,130 @@
+module JSONAPI
+  module Serializable
+    module AbstractResourceDSL
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        # @overload type(value)
+        #   Declare the JSON API type of this resource.
+        #   @param [String] value The value of the type.
+        #
+        #   @example
+        #     type 'users'
+        #
+        # @overload type(value)
+        #   Declare the JSON API type of this resource.
+        #   @yieldreturn [String] The value of the type.
+        #
+        #   @example
+        #     type { @user.admin? ? "admin" : "users" }
+        def type(value = nil, &block)
+          self.type_val = value
+          self.type_block = block
+        end
+
+        # Declare the JSON API id of this resource.
+        #
+        # @yieldreturn [String] The id of the resource.
+        #
+        # @example
+        #   id { @user.id.to_s }
+        def id(&block)
+          self.id_block = block
+        end
+
+        # @overload meta(value)
+        #   Declare the meta information for this resource.
+        #   @param [Hash] value The meta information hash.
+        #
+        #   @example
+        #     meta key: value
+        #
+        # @overload meta(&block)
+        #   Declare the meta information for this resource.
+        #   @yieldreturn [String] The meta information hash.
+        #   @example
+        #     meta do
+        #       { key: value }
+        #     end
+        def meta(value = nil, &block)
+          self.meta_val = value
+          self.meta_block = block
+        end
+
+        # Declare an attribute for this resource.
+        #
+        # @param [Symbol] name The key of the attribute.
+        # @yieldreturn [Hash, String, nil] The block to compute the value.
+        #
+        # @example
+        #   attribute(:name) { @user.name }
+        def attribute(name, &block)
+          attribute_blocks[name] = block
+        end
+
+        # Declare a relationship for this resource. The properties of the
+        #   relationship are set by providing a block in which the DSL methods
+        #   of +JSONAPI::Serializable::Relationship+ are called.
+        # @see JSONAPI::Serializable::Relationship
+        #
+        # @param [Symbol] name The key of the relationship.
+        #
+        # @example
+        #   relationship :posts do
+        #     data { @user.posts.map { |p| PostResource.new(post: p) } }
+        #   end
+        #
+        # @example
+        #   relationship :author do
+        #     data do
+        #       @post.author && UserResource.new(user: @post.author)
+        #     end
+        #     linkage_data do
+        #       { type: 'users', id: @post.author_id }
+        #     end
+        #     link(:self) do
+        #       "http://api.example.com/posts/#{@post.id}/relationships/author"
+        #     end
+        #     link(:related) do
+        #       "http://api.example.com/posts/#{@post.id}/author"
+        #     end
+        #     meta do
+        #       { author_online: @post.author.online? }
+        #     end
+        #   end
+        def relationship(name, &block)
+          relationship_blocks[name] = block
+        end
+        alias has_many   relationship
+        alias has_one    relationship
+        alias belongs_to relationship
+
+        # Declare a link for this resource. The properties of the link are set
+        #   by providing a block in which the DSL methods of
+        #   +JSONAPI::Serializable::Link+ are called, or the value of the link
+        #   is returned directly.
+        # @see JSONAPI::Serialiable::Link
+        #
+        # @param [Symbol] name The key of the link.
+        # @yieldreturn [Hash, String, nil] The block to compute the value, if
+        #   any.
+        #
+        # @example
+        #   link(:self) do
+        #     "http://api.example.com/users/#{@user.id}"
+        #   end
+        #
+        # @example
+        #    link(:self) do
+        #      href "http://api.example.com/users/#{@user.id}"
+        #      meta is_self: true
+        #    end
+        def link(name, &block)
+          link_blocks[name] = block
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/serializable/error.rb

@@ -40,9 +40,9 @@ module JSONAPI
         klass.link_blocks = self.class.link_blocks.dup
       end
 
-      def initialize(params = {})
-        @_param_hash = params
-        params.each { |k, v| instance_variable_set("@#{k}", v) }
+      def initialize(exposures = {})
+        @_exposures = exposures
+        exposures.each { |k, v| instance_variable_set("@#{k}", v) }
       end
 
       def as_jsonapi
@@ -58,12 +58,12 @@ module JSONAPI
 
       def links
         @_links ||= self.class.link_blocks.each_with_object({}) do |(k, v), h|
-          h[k] = Link.as_jsonapi(@_param_hash, v)
+          h[k] = Link.as_jsonapi(@_exposures, v)
         end
       end
 
       def source
-        @_source ||= ErrorSource.as_jsonapi(@_param_hash,
+        @_source ||= ErrorSource.as_jsonapi(@_exposures,
                                             self.class.source_block)
       end
 

data/lib/jsonapi/serializable/link.rb

@@ -1,12 +1,12 @@
 module JSONAPI
   module Serializable
     class Link
-      def self.as_jsonapi(param_hash = {}, &block)
-        new(param_hash, &block).as_jsonapi
+      def self.as_jsonapi(exposures = {}, &block)
+        new(exposures, &block).as_jsonapi
       end
 
-      def initialize(param_hash = {}, &block)
-        param_hash.each { |k, v| instance_variable_set("@#{k}", v) }
+      def initialize(exposures = {}, &block)
+        exposures.each { |k, v| instance_variable_set("@#{k}", v) }
         static_value = instance_eval(&block)
         if static_value.is_a?(Hash)
           @_hash = static_value

data/lib/jsonapi/serializable/relationship.rb

@@ -6,31 +6,42 @@ module JSONAPI
     class Relationship
       include RelationshipDSL
 
-      def initialize(param_hash = {}, &block)
-        param_hash.each { |k, v| instance_variable_set("@#{k}", v) }
-        @_param_hash = param_hash
-        @_links = {}
+      def initialize(exposures = {}, &block)
+        exposures.each { |k, v| instance_variable_set("@#{k}", v) }
+        @_exposures = exposures
+        @_links     = {}
         instance_eval(&block)
       end
 
       def as_jsonapi(included)
-        hash = {}
-        hash[:links] = @_links if @_links.any?
-        hash[:meta] = @_meta unless @_meta.nil?
-        return hash unless included || (!@_links.any? && @_meta.nil?)
-        hash[:data] = linkage_data
+        {}.tap do |hash|
+          hash[:links] = @_links if @_links.any?
+          hash[:meta]  = @_meta  unless @_meta.nil?
+          include_linkage = included || (!@_links.any? && @_meta.nil?)
+          hash[:data] = linkage_data if include_linkage
+        end
+      end
+
+      def related_resources
+        return @_related_resources if @_related_resources
 
-        hash
+        resources = @_resources_block.call
+        @_arity = resources.respond_to?(:each) ? :many : :one
+        @_related_resources = Array(resources)
+
+        @_related_resources
       end
 
       private
 
       def linkage_data
-        linkage_data = Array(data).map do |res|
+        return @_linkage_block.call if @_linkage_block
+
+        linkage_data = related_resources.map do |res|
           { type: res.jsonapi_type, id: res.jsonapi_id }
         end
 
-        data.respond_to?(:each) ? linkage_data : linkage_data.first
+        @_arity == :many ? linkage_data : linkage_data.first
       end
     end
   end

data/lib/jsonapi/serializable/relationship_dsl.rb

@@ -3,55 +3,58 @@ require 'jsonapi/serializable/resource_builder'
 module JSONAPI
   module Serializable
     module RelationshipDSL
-      # Declare the data for this relationship.
+      # Declare the related resources for this relationship.
       # @param [String,Constant,Hash{Symbol=>String,Constant}] resource_class
-      # @yieldreturn The data for this relationship.
+      # @yieldreturn The related resources for this relationship.
       #   If it is nil, an object implementing the Serializable::Resource
       #   interface, an empty array, or an array of objects implementing the
       #   Serializable::Resource interface, then it is used as is.
-      #   Otherwise an appropriate Serializable::Model subclass is inferred
+      #   Otherwise an appropriate Serializable::Resource subclass is inferred
       #   from the object(s)' namespace/class, the resource_class parameter if
       #   provided, and the @_resource_inferer.
       #
       # @example
-      #   data do
+      #   resources do
       #     @user.posts.map { |p| PostResource.new(post: p) }
       #   end
       #
       # @example
-      #   data do
+      #   resources do
       #     @post.author && UserResource.new(user: @user.author)
       #   end
       #
       # @example
-      #   data do
+      #   resources do
       #     @user.posts
       #   end
       # end
       #
       # @example
-      #   data SerializablePost do
+      #   resources SerializablePost do
       #     @user.posts
       #   end
       #
       # @example
-      #   data "SerializableUser" do
+      #   resources "SerializableUser" do
       #     @post.author
       #   end
-      def data(resource_class = nil)
-        if block_given?
-          # NOTE(beauby): Lazify computation since it is only needed when
-          #   the corresponding relationship is included.
-          @_data_block = proc do
-            _resources_for(yield, resource_class)
-          end
-        else
-          # NOTE(beauby): In the case of a computation heavy relationship with
-          #   nil value, this block might be executed multiple times.
-          @_data ||= @_data_block.call
+      def resources(resource_class = nil)
+        # NOTE(beauby): Lazify computation since it is only needed when
+        #   the corresponding relationship is included.
+        @_resources_block = proc do
+          _resources_for(yield, resource_class)
         end
       end
 
+      # Explicitly declare linkage data.
+      # @yieldreturn The resource linkage.
+      def data(&block)
+        # NOTE(beauby): Lazify computation since it is only executed when
+        #   the corresponding relationship is included (or no links and
+        #   no meta was specified).
+        @_linkage_block = block
+      end
+
       # @overload meta(value)
       #   Declare the meta information for this relationship.
       #   @param [Hash] value The meta information hash.
@@ -90,16 +93,16 @@ module JSONAPI
       #      meta authorization_needed: true
       #    end
       def link(name, &block)
-        @_links[name] = Link.as_jsonapi(@_param_hash, &block)
+        @_links[name] = Link.as_jsonapi(@_exposures, &block)
       end
 
       private
 
       # @api private
-      def _resources_for(models, resource_class)
+      def _resources_for(objects, resource_class)
         resource_class ||= @_resource_inferer
 
-        ResourceBuilder.build(models, @_param_hash, resource_class)
+        ResourceBuilder.build(objects, @_exposures, resource_class)
       end
     end
   end

data/lib/jsonapi/serializable/renderer.rb

@@ -1,14 +1,15 @@
 require 'jsonapi/renderer'
+require 'jsonapi/serializable/resource_builder'
 
 module JSONAPI
   module Serializable
     class Renderer
-      def self.render(resources, options)
-        new(resources, options).render
+      def self.render(objects, options)
+        new(objects, options).render
       end
 
-      def initialize(resources, options)
-        @resources  = resources
+      def initialize(objects, options)
+        @objects    = objects
         @options    = options.dup
         @klass      = @options.delete(:class)
         @namespace  = @options.delete(:namespace)
@@ -29,7 +30,7 @@ module JSONAPI
 
       def jsonapi_resources
         toplevel_inferer = @klass || @inferer
-        JSONAPI::Serializable::ResourceBuilder.build(@resources,
+        JSONAPI::Serializable::ResourceBuilder.build(@objects,
                                                      @exposures,
                                                      toplevel_inferer)
       end

data/lib/jsonapi/serializable/resource.rb

@@ -1,106 +1,12 @@
-require 'jsonapi/serializable/link'
-require 'jsonapi/serializable/relationship'
+require 'jsonapi/serializable/abstract_resource'
 require 'jsonapi/serializable/resource_dsl'
 
 module JSONAPI
   module Serializable
-    class Resource
+    class Resource < AbstractResource
       include ResourceDSL
 
-      class << self
-        attr_accessor :type_val, :type_block, :id_block, :attribute_blocks,
-                      :relationship_blocks, :link_blocks, :meta_val, :meta_block
-      end
-
-      self.attribute_blocks = {}
-      self.relationship_blocks = {}
-      self.link_blocks = {}
-
-      def self.inherited(klass)
-        super
-        klass.type_val = type_val
-        klass.type_block = type_block
-        klass.id_block = id_block
-        klass.meta_val = meta_val
-        klass.meta_block = meta_block
-        klass.attribute_blocks = attribute_blocks.dup
-        klass.relationship_blocks = relationship_blocks.dup
-        klass.link_blocks = link_blocks.dup
-      end
-
-      def initialize(param_hash = {})
-        @_param_hash = param_hash
-        param_hash.each { |k, v| instance_variable_set("@#{k}", v) }
-      end
-
-      def as_jsonapi(params = {})
-        return nil if nil?
-
-        {}.tap do |hash|
-          hash[:id] = jsonapi_id
-          hash[:type] = jsonapi_type
-          requested_attrs = params[:fields] || self.class.attribute_blocks.keys
-          attrs = attributes(requested_attrs)
-          hash[:attributes] = attrs if attrs.any?
-          requested_rels = params[:fields] ||
-                           self.class.relationship_blocks.keys
-          rels = relationships(requested_rels, params[:include] || [])
-          hash[:relationships] = rels if rels.any?
-          hash[:links] = links if links.any?
-          hash[:meta] = meta unless meta.nil?
-        end
-      end
-
-      def jsonapi_type
-        @_type ||= self.class.type_val || instance_eval(&self.class.type_block)
-      end
-
-      def jsonapi_id
-        @_id ||= instance_eval(&self.class.id_block)
-      end
-
-      def jsonapi_related(include)
-        @_relationships
-          .select { |k, _| include.include?(k) }
-          .each_with_object({}) { |(k, v), h| h[k] = Array(v.data) }
-      end
-
-      private
-
-      def attributes(fields)
-        @_attributes ||= {}
-        self.class.attribute_blocks
-            .select { |k, _| !@_attributes.key?(k) && fields.include?(k) }
-            .each { |k, v| @_attributes[k] = instance_eval(&v) }
-        @_attributes.select { |k, _| fields.include?(k) }
-      end
-
-      def relationships(fields, include)
-        @_relationships ||= self.class.relationship_blocks
-                                .each_with_object({}) do |(k, v), h|
-          h[k] = Relationship.new(@_param_hash, &v)
-        end
-        @_relationships
-          .select { |k, _| fields.include?(k) }
-          .each_with_object({}) do |(k, v), h|
-          h[k] = v.as_jsonapi(include.include?(k))
-        end
-      end
-
-      def meta
-        @_meta ||=
-          if self.class.meta_val
-            self.class.meta_val
-          elsif self.class.meta_block
-            instance_eval(&self.class.meta_block)
-          end
-      end
-
-      def links
-        @_links ||= self.class.link_blocks.each_with_object({}) do |(k, v), h|
-          h[k] = Link.as_jsonapi(@_param_hash, &v)
-        end
-      end
+      id { @object.public_send(:id).to_s }
     end
   end
 end

data/lib/jsonapi/serializable/resource_builder.rb

@@ -1,8 +1,8 @@
 module JSONAPI
   module Serializable
     class ResourceBuilder
-      DEFAULT_RESOURCE_INFERER = lambda do |model_klass_name|
-        names = model_klass_name.split('::'.freeze)
+      DEFAULT_RESOURCE_INFERER = lambda do |object_klass_name|
+        names = object_klass_name.split('::'.freeze)
         klass_name = names.pop
         namespace = names.join('::'.freeze)
 
@@ -14,20 +14,21 @@ module JSONAPI
         Object.const_get(klass_name)
       end
 
-      def self.build(models, expose, klass)
-        return models if models.nil? ||
-                         Array(models).first.respond_to?(:as_jsonapi)
+      def self.build(objects, expose, klass)
+        return objects if objects.nil? ||
+                          Array(objects).first.respond_to?(:as_jsonapi)
 
-        resources =
-          Array(models).map { |model| new(model, expose, klass).resource }
-
-        models.respond_to?(:each) ? resources : resources.first
+        if objects.respond_to?(:each)
+          objects.map { |obj| new(obj, expose, klass).resource }
+        else
+          new(objects, expose, klass).resource
+        end
       end
 
       attr_reader :resource
 
-      def initialize(model, expose, klass)
-        @model    = model
+      def initialize(object, expose, klass)
+        @object   = object
         @expose   = expose || {}
         @klass    = klass
         @resource = serializable_class.new(serializable_params)
@@ -37,18 +38,18 @@ module JSONAPI
       private
 
       def serializable_params
-        @expose.merge(model: @model)
+        @expose.merge(object: @object)
       end
 
       # rubocop:disable Metrics/MethodLength
       def serializable_class
         klass =
           if @klass.respond_to?(:call)
-            @klass.call(@model.class.name)
+            @klass.call(@object.class.name)
           elsif @klass.is_a?(Hash)
-            @klass[@model.class.name.to_sym]
+            @klass[@object.class.name.to_sym]
           elsif @klass.nil?
-            DEFAULT_RESOURCE_INFERER.call(@model.class.name)
+            DEFAULT_RESOURCE_INFERER.call(@object.class.name)
           else
             @klass
           end

data/lib/jsonapi/serializable/resource_dsl.rb

@@ -6,124 +6,27 @@ module JSONAPI
       end
 
       module ClassMethods
-        # @overload type(value)
-        #   Declare the JSON API type of this resource.
-        #   @param [String] value The value of the type.
-        #
-        #   @example
-        #     type 'users'
-        #
-        # @overload type(value)
-        #   Declare the JSON API type of this resource.
-        #   @yieldreturn [String] The value of the type.
-        #
-        #   @example
-        #     type { @user.admin? ? "admin" : "users" }
-        def type(value = nil, &block)
-          self.type_val = value
-          self.type_block = block
+        def attribute(attr, &block)
+          block ||= proc { @object.public_send(attr) }
+          super(attr, &block)
         end
 
-        # Declare the JSON API id of this resource.
-        #
-        # @yieldreturn [String] The id of the resource.
-        #
-        # @example
-        #   id { @user.id.to_s }
-        def id(&block)
-          self.id_block = block
+        def attributes(*args)
+          args.each do |attr|
+            attribute(attr)
+          end
         end
 
-        # @overload meta(value)
-        #   Declare the meta information for this resource.
-        #   @param [Hash] value The meta information hash.
-        #
-        #   @example
-        #     meta key: value
-        #
-        # @overload meta(&block)
-        #   Declare the meta information for this resource.
-        #   @yieldreturn [String] The meta information hash.
-        #   @example
-        #     meta do
-        #       { key: value }
-        #     end
-        def meta(value = nil, &block)
-          self.meta_val = value
-          self.meta_block = block
-        end
-
-        # Declare an attribute for this resource.
-        #
-        # @param [Symbol] name The key of the attribute.
-        # @yieldreturn [Hash, String, nil] The block to compute the value.
-        #
-        # @example
-        #   attribute(:name) { @user.name }
-        def attribute(name, &block)
-          attribute_blocks[name] = block
-        end
-
-        # Declare a relationship for this resource. The properties of the
-        #   relationship are set by providing a block in which the DSL methods
-        #   of +JSONAPI::Serializable::Relationship+ are called.
-        # @see JSONAPI::Serializable::Relationship
-        #
-        # @param [Symbol] name The key of the relationship.
-        #
-        # @example
-        #   relationship :posts do
-        #     data { @user.posts.map { |p| PostResource.new(post: p) } }
-        #   end
-        #
-        # @example
-        #   relationship :author do
-        #     data do
-        #       @post.author && UserResource.new(user: @post.author)
-        #     end
-        #     linkage_data do
-        #       { type: 'users', id: @post.author_id }
-        #     end
-        #     link(:self) do
-        #       "http://api.example.com/posts/#{@post.id}/relationships/author"
-        #     end
-        #     link(:related) do
-        #       "http://api.example.com/posts/#{@post.id}/author"
-        #     end
-        #     meta do
-        #       { author_online: @post.author.online? }
-        #     end
-        #   end
-        def relationship(name, &block)
-          relationship_blocks[name] = block
+        def relationship(rel, resource_class = nil, &block)
+          rel_block = proc do
+            resources(resource_class) { @object.public_send(rel) }
+            instance_eval(&block) unless block.nil?
+          end
+          super(rel, &rel_block)
         end
         alias has_many   relationship
         alias has_one    relationship
         alias belongs_to relationship
-
-        # Declare a link for this resource. The properties of the link are set
-        #   by providing a block in which the DSL methods of
-        #   +JSONAPI::Serializable::Link+ are called, or the value of the link
-        #   is returned directly.
-        # @see JSONAPI::Serialiable::Link
-        #
-        # @param [Symbol] name The key of the link.
-        # @yieldreturn [Hash, String, nil] The block to compute the value, if
-        #   any.
-        #
-        # @example
-        #   link(:self) do
-        #     "http://api.example.com/users/#{@user.id}"
-        #   end
-        #
-        # @example
-        #    link(:self) do
-        #      href "http://api.example.com/users/#{@user.id}"
-        #      meta is_self: true
-        #    end
-        def link(name, &block)
-          link_blocks[name] = block
-        end
       end
     end
   end

data/lib/jsonapi/serializable.rb

@@ -1,4 +1,3 @@
 require 'jsonapi/serializable/error'
-require 'jsonapi/serializable/model'
 require 'jsonapi/serializable/resource'
 require 'jsonapi/serializable/renderer'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializable
 version: !ruby/object:Gem::Version
-  version: 0.1.1.beta3
+  version: 0.1.1.beta4
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-15 00:00:00.000000000 Z
+date: 2016-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-renderer
@@ -60,11 +60,11 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/jsonapi/serializable.rb
+- lib/jsonapi/serializable/abstract_resource.rb
+- lib/jsonapi/serializable/abstract_resource_dsl.rb
 - lib/jsonapi/serializable/error.rb
 - lib/jsonapi/serializable/error_dsl.rb
 - lib/jsonapi/serializable/link.rb
-- lib/jsonapi/serializable/model.rb
-- lib/jsonapi/serializable/model_dsl.rb
 - lib/jsonapi/serializable/relationship.rb
 - lib/jsonapi/serializable/relationship_dsl.rb
 - lib/jsonapi/serializable/renderer.rb

data/lib/jsonapi/serializable/model.rb

@@ -1,12 +0,0 @@
-require 'jsonapi/serializable/model_dsl'
-require 'jsonapi/serializable/resource'
-
-module JSONAPI
-  module Serializable
-    class Model < Resource
-      include ModelDSL
-
-      id { @model.public_send(:id).to_s }
-    end
-  end
-end

data/lib/jsonapi/serializable/model_dsl.rb

@@ -1,27 +0,0 @@
-module JSONAPI
-  module Serializable
-    module ModelDSL
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        def attribute(attr, &block)
-          block ||= proc { @model.public_send(attr) }
-          super(attr, &block)
-        end
-
-        def relationship(rel, resource_class = nil, &block)
-          rel_block = proc do
-            data(resource_class) { @model.public_send(rel) }
-            instance_eval(&block) unless block.nil?
-          end
-          super(rel, &rel_block)
-        end
-        alias has_many   relationship
-        alias has_one    relationship
-        alias belongs_to relationship
-      end
-    end
-  end
-end