jsonapi-serializable 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2bfb6228e6b03c8bde3724af76fdbcedc097e0e
-  data.tar.gz: 28e75ac8293502f8e2a617c79fff3f803ca172d7
+  metadata.gz: e06e5be75e2c53c3f257807493bb7c896a669241
+  data.tar.gz: b0c29ac61252006bc763a1e08567037cff3f9e49
 SHA512:
-  metadata.gz: 909fa65c618b4507da112491cc7b84646c07146dd027c5ba52386509ed9ea090916b413e78940f3fd4dad8cc2c518d56bd727953ad871ef4b404205ba5c9f39d
-  data.tar.gz: 8d924e246526821a8ab66d571054cdbe50b235c3d909e5c4c3ca935d6f57fac9b6221e3dcde1ce81eeebfcd32e99bf40bbc87e980a1113c0811bf7c76a32133a
+  metadata.gz: a3d7759a8a216e92a71e56f1324082a69b6f51ce69653136c39187b527a37dafd2dd17919c70b1389b48412938098af9d6f83fdfaa0167be257e09cb18b6c8fd
+  data.tar.gz: 333ba881f8e1799bd2db5a0ed8c92b86f5906530550f0a0e03de63d451d41d66b0674198e91c572d312aee21c9f02d6048480fddc615451373828f06f62b504f

data/lib/jsonapi/serializable/error.rb

@@ -35,12 +35,6 @@ module JSONAPI
                       :link_blocks
       end
 
-      def self.create(hash)
-        hash.each_with_object(new) do |(k, v), e|
-          e.instance_variable_set("@_#{k}", v)
-        end
-      end
-
       self.link_blocks = {}
 
       def self.inherited(klass)

data/lib/jsonapi/serializable/relationship/dsl.rb

@@ -1,38 +1,31 @@
-require 'jsonapi/serializable/resource_builder'
-
 module JSONAPI
   module Serializable
     class Relationship
       module DSL
         # Declare the related resources 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::Resource subclass is inferred
-        #   from the object(s)' namespace/class, the `class` relationship
-        #   option, and the @_resource_builder.
-        #
-        # @example
-        #   data do
-        #     @user.posts.map { |p| PostResource.new(post: p) }
-        #   end
-        #
-        # @example
-        #   data do
-        #     @post.author && UserResource.new(user: @user.author)
-        #   end
         #
         # @example
         #   data do
-        #     @user.posts
+        #     @object.posts
         #   end
         # end
         def data
           # NOTE(beauby): Lazify computation since it is only needed when
           #   the corresponding relationship is included.
           @_resources_block = proc do
-            @_resource_builder.build(yield, @_exposures, @_options[:class])
+            resources = yield
+            if resources.nil?
+              nil
+            elsif resources.respond_to?(:to_ary)
+              Array(resources).map do |obj|
+                @_class[obj.class.name.to_sym]
+                  .new(@_exposures.merge(object: obj))
+              end
+            else
+              @_class[resources.class.name.to_sym]
+                .new(@_exposures.merge(object: resources))
+            end
           end
         end
 

data/lib/jsonapi/serializable/renderer.rb

@@ -1,9 +1,8 @@
 require 'jsonapi/renderer'
-require 'jsonapi/serializable/resource_builder'
 
 module JSONAPI
   module Serializable
-    class SuccessRenderer
+    class Renderer
       def initialize(renderer = JSONAPI::Renderer.new)
         @renderer = renderer
       end
@@ -11,13 +10,9 @@ module JSONAPI
       # Serialize resources into a JSON API document.
       #
       # @param resources [nil,Object,Array]
-      # @param options [Hash]@see JSONAPI.render
-      # @option class [Class,Symbol,String,Hash{Symbol,String=>Class,Symbol,String}]
-      #   The serializable resource class(es) to use for the primary resources.
-      # @option namespace [String] The namespace in which to look for
-      #   serializable resource classes.
-      # @option inferrer [#call] The callable used for inferring a serializable
-      #   resource class name from a resource class name.
+      # @param options [Hash] @see JSONAPI.render
+      # @option class [Hash{Symbol=>Class}] A map specifying for each type
+      #   the corresponding serializable resource class.
       # @option expose [Hash] The exposures made available in serializable
       #   resource class instances as instance variables.
       # @return [Hash]
@@ -27,7 +22,7 @@ module JSONAPI
       #   # => { data: nil }
       #
       # @example
-      #   renderer.render(user)
+      #   renderer.render(user, class: { User: SerializableUser })
       #   # => {
       #          data: {
       #            type: 'users',
@@ -38,52 +33,60 @@ module JSONAPI
       #        }
       #
       # @example
-      #   renderer.render([user1, user2])
+      #   renderer.render([user1, user2], class: { User: SerializableUser })
       #   # => { data: [{ type: 'users', id: 'foo', ... }, ...] }
       def render(resources, options = {})
         options   = options.dup
-        klass     = options.delete(:class)
-        namespace = options.delete(:namespace)
-        inferrer  = options.delete(:inferrer) || namespace_inferrer(namespace)
-        expose    = options.delete(:expose) || {}
-        resource_builder = JSONAPI::Serializable::ResourceBuilder.new(inferrer)
-        exposures = expose.merge(_resource_builder: resource_builder)
+        klass     = options.delete(:class) || {}
+        exposures = options.delete(:expose) || {}
+        exposures = exposures.merge(_class: klass)
 
-        resources = resource_builder.build(resources, exposures, klass)
+        resources = build_resources(resources, exposures, klass)
 
         @renderer.render(options.merge(data: resources))
       end
 
-      private
-
-      # @api private
-      def namespace_inferrer(namespace)
-        proc do |class_name|
-          names = class_name.split('::')
-          klass = names.pop
-          [namespace, *names, "Serializable#{klass}"].reject(&:nil?).join('::')
-        end
-      end
-    end
-
-    class ErrorsRenderer
-      def initialize(renderer = JSONAPI::Renderer.new)
-        @renderer = renderer
-      end
-
       # Serialize errors into a JSON API document.
       #
       # @param errors [Array]
       # @param options [Hash] @see JSONAPI.render
+      # @option class [Hash{Symbol=>Class}] A map specifying for each type
+      #   the corresponding serializable error class.
+      # @option expose [Hash] The exposures made available in serializable
+      #   error class instances as instance variables.
       # @return [Hash]
       #
       # @example
       #   error = JSONAPI::Serializable::Error.create(id: 'foo', title: 'bar')
       #   renderer.render([error])
       #   # => { errors: [{ id: 'foo', title: 'bar' }] }
-      def render(errors, options = {})
+      def render_errors(errors, options = {})
+        options   = options.dup
+        klass     = options.delete(:class) || {}
+        exposures = options.delete(:expose) || {}
+
+        errors = errors.map { |e| _build(e, exposures, klass) }
+
         @renderer.render(options.merge(errors: errors))
       end
+
+      private
+
+      # @api private
+      def build_resources(resources, exposures, klass)
+        if resources.nil?
+          nil
+        elsif resources.respond_to?(:to_ary)
+          Array(resources).map { |obj| _build(obj, exposures, klass) }
+        else
+          _build(resources, exposures, klass)
+        end
+      end
+
+      # @api private
+      def _build(object, exposures, klass)
+        klass[object.class.name.to_sym].new(exposures.merge(object: object))
+      end
     end
   end
 end

data/lib/jsonapi/serializable/resource.rb

@@ -1,5 +1,3 @@
-require 'jsonapi/serializable/resource_builder'
-
 require 'jsonapi/serializable/resource/dsl'
 
 require 'jsonapi/serializable/link'
@@ -18,9 +16,7 @@ module JSONAPI
 
       # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       def initialize(exposures = {})
-        @_exposures = {
-          _resource_builder: JSONAPI::Serializable::ResourceBuilder.new
-        }.merge(exposures)
+        @_exposures = exposures
         @_exposures.each { |k, v| instance_variable_set("@#{k}", v) }
 
         @_id = instance_eval(&self.class.id_block).to_s
@@ -81,6 +77,12 @@ module JSONAPI
           .each_with_object({}) { |(k, v), h| h[k] = v.related_resources }
       end
 
+      def jsonapi_cache_key(options)
+        "#{jsonapi_type} - #{jsonapi_id}" \
+        "- #{options[:include].to_a.sort}" \
+        "- #{(options[:fields] || Set.new).to_a.sort}"
+      end
+
       private
 
       # @api private

data/lib/jsonapi/serializable/resource/conditional_fields.rb

@@ -29,14 +29,14 @@ module JSONAPI
               attr_accessor :link_condition_blocks
             end
             self.field_condition_blocks ||= {}
-            self.link_condition_blocks ||= {}
+            self.link_condition_blocks  ||= {}
           end
         end
 
         def inherited(klass)
           super
           klass.field_condition_blocks = field_condition_blocks.dup
-          klass.link_condition_blocks = link_condition_blocks.dup
+          klass.link_condition_blocks  = link_condition_blocks.dup
         end
 
         # Handle the `if` and `unless` options for attributes.

data/lib/jsonapi/serializable/resource/dsl.rb

@@ -34,7 +34,7 @@ module JSONAPI
         # @yieldreturn [String] The id of the resource.
         #
         # @example
-        #   id { @user.id.to_s }
+        #   id { @object.id.to_s }
         def id(&block)
           self.id_block = block
         end
@@ -93,12 +93,12 @@ module JSONAPI
         #
         # @example
         #   link(:self) do
-        #     "http://api.example.com/users/#{@user.id}"
+        #     "http://api.example.com/users/#{@object.id}"
         #   end
         #
         # @example
         #    link(:self) do
-        #      href "http://api.example.com/users/#{@user.id}"
+        #      href "http://api.example.com/users/#{@object.id}"
         #      meta is_self: true
         #    end
         def link(name, &block)
@@ -133,26 +133,21 @@ module JSONAPI
         # @param [Hash] options The options for the relationship.
         #
         # @example
-        #   relationship :posts do
-        #     resources { @user.posts.map { |p| PostResource.new(post: p) } }
-        #   end
-        #
-        # @example
         #   relationship :author do
-        #     resources do
-        #       @post.author && UserResource.new(user: @post.author)
-        #     end
         #     data do
-        #       { type: 'users', id: @post.author_id }
+        #       @object.author
+        #     end
+        #     linkage do
+        #       { type: 'users', id: @object.author_id }
         #     end
         #     link(:self) do
-        #       "http://api.example.com/posts/#{@post.id}/relationships/author"
+        #       "http://api.example.com/posts/#{@object.id}/relationships/author"
         #     end
         #     link(:related) do
-        #       "http://api.example.com/posts/#{@post.id}/author"
+        #       "http://api.example.com/posts/#{@object.id}/author"
         #     end
         #     meta do
-        #       { author_online: @post.author.online? }
+        #       { author_online: @object.author.online? }
         #     end
         #   end
         def relationship(name, options = {}, &block)
@@ -164,8 +159,8 @@ module JSONAPI
           relationship_options[name.to_sym] = options
         end
 
-        alias has_many relationship
-        alias has_one relationship
+        alias has_many   relationship
+        alias has_one    relationship
         alias belongs_to relationship
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializable
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-13 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-renderer
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -59,19 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
 description: Powerful DSL for building resource classes - efficient and flexible rendering.
 email: lucas.hosseini@gmail.com
 executables: []
@@ -90,9 +98,6 @@ files:
 - lib/jsonapi/serializable/resource/conditional_fields.rb
 - lib/jsonapi/serializable/resource/dsl.rb
 - lib/jsonapi/serializable/resource/key_format.rb
-- lib/jsonapi/serializable/resource/relationship.rb
-- lib/jsonapi/serializable/resource/relationship/dsl.rb
-- lib/jsonapi/serializable/resource_builder.rb
 homepage: https://github.com/jsonapi-rb/jsonapi-serializable
 licenses:
 - MIT
@@ -113,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Conveniently serialize JSON API resources.

data/lib/jsonapi/serializable/resource/relationship.rb

@@ -1,62 +0,0 @@
-require 'jsonapi/serializable/link'
-require 'jsonapi/serializable/resource/relationship/dsl'
-
-module JSONAPI
-  module Serializable
-    class Resource
-      class Relationship
-        include DSL
-
-        def initialize(exposures = {}, options = {}, &block)
-          exposures.each { |k, v| instance_variable_set("@#{k}", v) }
-          @_exposures = exposures
-          @_options   = options
-          @_links     = {}
-          instance_eval(&block)
-        end
-
-        def as_jsonapi(included)
-          {}.tap do |hash|
-            hash[:links] = @_links             if @_links.any?
-            hash[:data]  = linkage_data        if included || @_include_linkage
-            hash[:meta]  = @_meta              unless @_meta.nil?
-            hash[:meta]  = { included: false } if hash.empty?
-          end
-        end
-
-        # @api private
-        def related_resources
-          @_related_resources ||= Array(resources)
-        end
-
-        # @api private
-        def links
-          @_links
-        end
-
-        # @api private
-        def meta
-          @_meta
-        end
-
-        # @api private
-        def resources
-          @_resources ||= @_resources_block.call
-        end
-
-        private
-
-        # @api private
-        def linkage_data
-          return @_linkage_block.call if @_linkage_block
-
-          linkage_data = related_resources.map do |res|
-            { type: res.jsonapi_type, id: res.jsonapi_id }
-          end
-
-          resources.respond_to?(:each) ? linkage_data : linkage_data.first
-        end
-      end
-    end
-  end
-end

data/lib/jsonapi/serializable/resource/relationship/dsl.rb

@@ -1,103 +0,0 @@
-require 'jsonapi/serializable/resource_builder'
-
-module JSONAPI
-  module Serializable
-    class Resource
-      class Relationship
-        module DSL
-          # Declare the related resources 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::Resource subclass is
-          #   inferred from the object(s)' namespace/class, the `class`
-          #   relationship option, and the @_resource_builder.
-          #
-          # @example
-          #   data do
-          #     @user.posts.map { |p| PostResource.new(post: p) }
-          #   end
-          #
-          # @example
-          #   data do
-          #     @post.author && UserResource.new(user: @user.author)
-          #   end
-          #
-          # @example
-          #   data do
-          #     @user.posts
-          #   end
-          # end
-          def data
-            # NOTE(beauby): Lazify computation since it is only needed when
-            #   the corresponding relationship is included.
-            @_resources_block = proc do
-              @_resource_builder.build(yield, @_exposures, @_options[:class])
-            end
-          end
-
-          # @overload linkage(options = {}, &block)
-          #   Explicitly declare linkage data.
-          #   @yieldreturn The resource linkage.
-          #
-          #   @example
-          #     linkage do
-          #       @object.posts.map { |p| { id: p.id.to_s, type: 'posts' } }
-          #     end
-          #
-          # @overload linkage(options = {})
-          #   Forces standard linkage even if relationship not included.
-          #
-          #   @example
-          #     linkage always: true
-          def linkage(always: false, &block)
-            @_include_linkage = always
-            @_linkage_block = block
-          end
-
-          # @overload meta(value)
-          #   Declare the meta information for this relationship.
-          #   @param [Hash] value The meta information hash.
-          #
-          #   @example
-          #     meta paginated: true
-          #
-          # @overload meta(&block)
-          #   Declare the meta information for this relationship.
-          #   @yieldreturn [Hash] The meta information hash.
-          #
-          #   @example
-          #     meta do
-          #       { paginated: true }
-          #     end
-          def meta(value = nil)
-            @_meta = value || yield
-          end
-
-          # Declare a link for this relationship. The properties of the link are set
-          #   by providing a block in which the DSL methods of
-          #   +JSONAPI::Serializable::Link+ are called.
-          # @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}/relationships/posts"
-          #   end
-          #
-          # @example
-          #    link(:related) do
-          #      href "http://api.example.com/users/#{@user.id}/posts"
-          #      meta authorization_needed: true
-          #    end
-          def link(name, &block)
-            @_links[name] = Link.as_jsonapi(@_exposures, &block)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jsonapi/serializable/resource_builder.rb

@@ -1,56 +0,0 @@
-module JSONAPI
-  module Serializable
-    class ResourceBuilder
-      # @api private
-      def initialize(inferrer = nil)
-        @inferrer = inferrer
-        @lookup_cache = {}
-
-        freeze
-      end
-
-      # @api private
-      def build(objects, expose, klass = nil)
-        return objects if objects.nil? ||
-                          Array(objects).first.respond_to?(:as_jsonapi)
-
-        if objects.respond_to?(:to_ary)
-          Array(objects).map { |obj| _build(obj, expose, klass) }
-        else
-          _build(objects, expose, klass)
-        end
-      end
-
-      private
-
-      # @api private
-      def _build(object, expose, klass)
-        serializable_class(object.class.name, klass)
-          .new(expose.merge(object: object))
-      end
-
-      # @api private
-      def serializable_class(object_class_name, klass)
-        klass = klass[object_class_name.to_sym] if klass.is_a?(Hash)
-
-        @lookup_cache[[object_class_name, klass.to_s]] ||=
-          reify_class(klass || @inferrer.call(object_class_name))
-      end
-
-      # @api private
-      def reify_class(klass)
-        if klass.is_a?(Class)
-          klass
-        elsif klass.is_a?(String) || klass.is_a?(Symbol)
-          begin
-            Object.const_get(klass)
-          rescue NameError
-            raise NameError, "Undefined serializable class #{klass}"
-          end
-        else
-          raise ArgumentError, "Invalid serializable class #{klass}"
-        end
-      end
-    end
-  end
-end