jsonapi-serializer 2.0.0

data/lib/fast_jsonapi/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+class Railtie < Rails::Railtie
+  initializer 'fast_jsonapi.active_record' do
+    ActiveSupport.on_load :active_record do
+      require 'extensions/has_one'
+    end
+  end
+end

data/lib/fast_jsonapi/relationship.rb

@@ -0,0 +1,224 @@
+module FastJsonapi
+  class Relationship
+    attr_reader :owner, :key, :name, :id_method_name, :record_type, :object_method_name, :object_block, :serializer, :relationship_type, :cached, :polymorphic, :conditional_proc, :transform_method, :links, :lazy_load_data
+
+    def initialize(
+      owner:,
+      key:,
+      name:,
+      id_method_name:,
+      record_type:,
+      object_method_name:,
+      object_block:,
+      serializer:,
+      relationship_type:,
+      cached: false,
+      polymorphic:,
+      conditional_proc:,
+      transform_method:,
+      links:,
+      lazy_load_data: false
+    )
+      @owner = owner
+      @key = key
+      @name = name
+      @id_method_name = id_method_name
+      @record_type = record_type
+      @object_method_name = object_method_name
+      @object_block = object_block
+      @serializer = serializer
+      @relationship_type = relationship_type
+      @cached = cached
+      @polymorphic = polymorphic
+      @conditional_proc = conditional_proc
+      @transform_method = transform_method
+      @links = links || {}
+      @lazy_load_data = lazy_load_data
+      @record_types_for = {}
+      @serializers_for_name = {}
+    end
+
+    def serialize(record, included, serialization_params, output_hash)
+      if include_relationship?(record, serialization_params)
+        empty_case = relationship_type == :has_many ? [] : nil
+
+        output_hash[key] = {}
+        output_hash[key][:data] = ids_hash_from_record_and_relationship(record, serialization_params) || empty_case unless lazy_load_data && !included
+        add_links_hash(record, serialization_params, output_hash) if links.present?
+      end
+    end
+
+    def fetch_associated_object(record, params)
+      return FastJsonapi.call_proc(object_block, record, params) unless object_block.nil?
+
+      record.send(object_method_name)
+    end
+
+    def include_relationship?(record, serialization_params)
+      if conditional_proc.present?
+        FastJsonapi.call_proc(conditional_proc, record, serialization_params)
+      else
+        true
+      end
+    end
+
+    def serializer_for(record, serialization_params)
+      # TODO: Remove this, dead code...
+      if @static_serializer
+        @static_serializer
+
+      elsif polymorphic
+        name = polymorphic[record.class] if polymorphic.is_a?(Hash)
+        name ||= record.class.name
+        serializer_for_name(name)
+
+      elsif serializer.is_a?(Proc)
+        FastJsonapi.call_proc(serializer, record, serialization_params)
+
+      elsif object_block
+        serializer_for_name(record.class.name)
+
+      else
+        # TODO: Remove this, dead code...
+        raise "Unknown serializer for object #{record.inspect}"
+      end
+    end
+
+    def static_serializer
+      initialize_static_serializer unless @initialized_static_serializer
+      @static_serializer
+    end
+
+    def static_record_type
+      initialize_static_serializer unless @initialized_static_serializer
+      @static_record_type
+    end
+
+    private
+
+    def ids_hash_from_record_and_relationship(record, params = {})
+      initialize_static_serializer unless @initialized_static_serializer
+
+      return ids_hash(fetch_id(record, params), @static_record_type) if @static_record_type
+
+      return unless associated_object = fetch_associated_object(record, params)
+
+      if associated_object.respond_to? :map
+        return associated_object.map do |object|
+          id_hash_from_record object, params
+        end
+      end
+
+      id_hash_from_record associated_object, params
+    end
+
+    def id_hash_from_record(record, params)
+      associated_record_type = record_type_for(record, params)
+      id_hash(record.public_send(id_method_name), associated_record_type)
+    end
+
+    def ids_hash(ids, record_type)
+      return ids.map { |id| id_hash(id, record_type) } if ids.respond_to? :map
+
+      id_hash(ids, record_type) # ids variable is just a single id here
+    end
+
+    def id_hash(id, record_type, default_return = false)
+      if id.present?
+        { id: id.to_s, type: record_type }
+      else
+        default_return ? { id: nil, type: record_type } : nil
+      end
+    end
+
+    def fetch_id(record, params)
+      if object_block.present?
+        object = FastJsonapi.call_proc(object_block, record, params)
+        return object.map { |item| item.public_send(id_method_name) } if object.respond_to? :map
+
+        return object.try(id_method_name)
+      end
+      record.public_send(id_method_name)
+    end
+
+    def add_links_hash(record, params, output_hash)
+      output_hash[key][:links] = if links.is_a?(Symbol)
+                                   record.public_send(links)
+                                 else
+                                   links.each_with_object({}) do |(key, method), hash|
+                                     Link.new(key: key, method: method).serialize(record, params, hash)\
+                                   end
+                                 end
+    end
+
+    def run_key_transform(input)
+      if transform_method.present?
+        input.to_s.send(*transform_method).to_sym
+      else
+        input.to_sym
+      end
+    end
+
+    def initialize_static_serializer
+      return if @initialized_static_serializer
+
+      @static_serializer = compute_static_serializer
+      @static_record_type = compute_static_record_type
+      @initialized_static_serializer = true
+    end
+
+    def compute_static_serializer
+      if polymorphic
+        # polymorphic without a specific serializer --
+        # the serializer is determined on a record-by-record basis
+        nil
+
+      elsif serializer.is_a?(Symbol) || serializer.is_a?(String)
+        # a serializer was explicitly specified by name -- determine the serializer class
+        serializer_for_name(serializer)
+
+      elsif serializer.is_a?(Proc)
+        # the serializer is a Proc to be executed per object -- not static
+        nil
+
+      elsif serializer
+        # something else was specified, e.g. a specific serializer class -- return it
+        serializer
+
+      elsif object_block
+        # an object block is specified without a specific serializer --
+        # assume the objects might be different and infer the serializer by their class
+        nil
+
+      else
+        # no serializer information was provided -- infer it from the relationship name
+        serializer_name = name.to_s
+        serializer_name = serializer_name.singularize if relationship_type.to_sym == :has_many
+        serializer_for_name(serializer_name)
+      end
+    end
+
+    def serializer_for_name(name)
+      @serializers_for_name[name] ||= owner.serializer_for(name)
+    end
+
+    def record_type_for(record, serialization_params)
+      # if the record type is static, return it
+      return @static_record_type if @static_record_type
+
+      # if not, use the record type of the serializer, and memoize the transformed version
+      serializer = serializer_for(record, serialization_params)
+      @record_types_for[serializer] ||= run_key_transform(serializer.record_type)
+    end
+
+    def compute_static_record_type
+      if polymorphic
+        nil
+      elsif record_type
+        run_key_transform(record_type)
+      elsif @static_serializer
+        run_key_transform(@static_serializer.record_type)
+      end
+    end
+  end
+end

data/lib/fast_jsonapi/scalar.rb

@@ -0,0 +1,29 @@
+module FastJsonapi
+  class Scalar
+    attr_reader :key, :method, :conditional_proc
+
+    def initialize(key:, method:, options: {})
+      @key = key
+      @method = method
+      @conditional_proc = options[:if]
+    end
+
+    def serialize(record, serialization_params, output_hash)
+      if conditionally_allowed?(record, serialization_params)
+        if method.is_a?(Proc)
+          output_hash[key] = FastJsonapi.call_proc(method, record, serialization_params)
+        else
+          output_hash[key] = record.public_send(method)
+        end
+      end
+    end
+
+    def conditionally_allowed?(record, serialization_params)
+      if conditional_proc.present?
+        FastJsonapi.call_proc(conditional_proc, record, serialization_params)
+      else
+        true
+      end
+    end
+  end
+end

data/lib/fast_jsonapi/serialization_core.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module FastJsonapi
+  MandatoryField = Class.new(StandardError)
+
+  module SerializationCore
+    extend ActiveSupport::Concern
+
+    included do
+      class << self
+        attr_accessor :attributes_to_serialize,
+                      :relationships_to_serialize,
+                      :cachable_relationships_to_serialize,
+                      :uncachable_relationships_to_serialize,
+                      :transform_method,
+                      :record_type,
+                      :record_id,
+                      :cache_store_instance,
+                      :cache_store_options,
+                      :data_links,
+                      :meta_to_serialize
+      end
+    end
+
+    class_methods do
+      def id_hash(id, record_type, default_return = false)
+        if id.present?
+          { id: id.to_s, type: record_type }
+        else
+          default_return ? { id: nil, type: record_type } : nil
+        end
+      end
+
+      def links_hash(record, params = {})
+        data_links.each_with_object({}) do |(_k, link), hash|
+          link.serialize(record, params, hash)
+        end
+      end
+
+      def attributes_hash(record, fieldset = nil, params = {})
+        attributes = attributes_to_serialize
+        attributes = attributes.slice(*fieldset) if fieldset.present?
+        attributes = {} if fieldset == []
+
+        attributes.each_with_object({}) do |(_k, attribute), hash|
+          attribute.serialize(record, params, hash)
+        end
+      end
+
+      def relationships_hash(record, relationships = nil, fieldset = nil, includes_list = nil, params = {})
+        relationships = relationships_to_serialize if relationships.nil?
+        relationships = relationships.slice(*fieldset) if fieldset.present?
+        relationships = {} if fieldset == []
+
+        relationships.each_with_object({}) do |(key, relationship), hash|
+          included = includes_list.present? && includes_list.include?(key)
+          relationship.serialize(record, included, params, hash)
+        end
+      end
+
+      def meta_hash(record, params = {})
+        FastJsonapi.call_proc(meta_to_serialize, record, params)
+      end
+
+      def record_hash(record, fieldset, includes_list, params = {})
+        if cache_store_instance
+          record_hash = cache_store_instance.fetch(record, **cache_store_options) do
+            temp_hash = id_hash(id_from_record(record, params), record_type, true)
+            temp_hash[:attributes] = attributes_hash(record, fieldset, params) if attributes_to_serialize.present?
+            temp_hash[:relationships] = {}
+            temp_hash[:relationships] = relationships_hash(record, cachable_relationships_to_serialize, fieldset, includes_list, params) if cachable_relationships_to_serialize.present?
+            temp_hash[:links] = links_hash(record, params) if data_links.present?
+            temp_hash
+          end
+          record_hash[:relationships] = record_hash[:relationships].merge(relationships_hash(record, uncachable_relationships_to_serialize, fieldset, includes_list, params)) if uncachable_relationships_to_serialize.present?
+        else
+          record_hash = id_hash(id_from_record(record, params), record_type, true)
+          record_hash[:attributes] = attributes_hash(record, fieldset, params) if attributes_to_serialize.present?
+          record_hash[:relationships] = relationships_hash(record, nil, fieldset, includes_list, params) if relationships_to_serialize.present?
+          record_hash[:links] = links_hash(record, params) if data_links.present?
+        end
+
+        record_hash[:meta] = meta_hash(record, params) if meta_to_serialize.present?
+        record_hash
+      end
+
+      def id_from_record(record, params)
+        return FastJsonapi.call_proc(record_id, record, params) if record_id.is_a?(Proc)
+        return record.send(record_id) if record_id
+        raise MandatoryField, 'id is a mandatory field in the jsonapi spec' unless record.respond_to?(:id)
+
+        record.id
+      end
+
+      def parse_include_item(include_item)
+        return [include_item.to_sym] unless include_item.to_s.include?('.')
+
+        include_item.to_s.split('.').map!(&:to_sym)
+      end
+
+      def remaining_items(items)
+        return unless items.size > 1
+
+        [items[1..-1].join('.').to_sym]
+      end
+
+      # includes handler
+      def get_included_records(record, includes_list, known_included_objects, fieldsets, params = {})
+        return unless includes_list.present?
+
+        includes_list.sort.each_with_object([]) do |include_item, included_records|
+          items = parse_include_item(include_item)
+          remaining_items = remaining_items(items)
+
+          items.each do |item|
+            next unless relationships_to_serialize && relationships_to_serialize[item]
+
+            relationship_item = relationships_to_serialize[item]
+            next unless relationship_item.include_relationship?(record, params)
+
+            relationship_type = relationship_item.relationship_type
+
+            included_objects = relationship_item.fetch_associated_object(record, params)
+            next if included_objects.blank?
+
+            included_objects = [included_objects] unless relationship_type == :has_many
+
+            static_serializer = relationship_item.static_serializer
+            static_record_type = relationship_item.static_record_type
+
+            included_objects.each do |inc_obj|
+              serializer = static_serializer || relationship_item.serializer_for(inc_obj, params)
+              record_type = static_record_type || serializer.record_type
+
+              if remaining_items.present?
+                serializer_records = serializer.get_included_records(inc_obj, remaining_items, known_included_objects, fieldsets, params)
+                included_records.concat(serializer_records) unless serializer_records.empty?
+              end
+
+              code = "#{record_type}_#{serializer.id_from_record(inc_obj, params)}"
+              next if known_included_objects.key?(code)
+
+              known_included_objects[code] = inc_obj
+
+              included_records << serializer.record_hash(inc_obj, fieldsets[record_type], includes_list, params)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fast_jsonapi/version.rb

@@ -0,0 +1,3 @@
+module FastJsonapi
+  VERSION = JSONAPI::Serializer::VERSION
+end

data/lib/generators/serializer/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a serializer for the given model.
+
+Example:
+    rails generate serializer Movie
+
+    This will create:
+        app/serializers/movie_serializer.rb

data/lib/generators/serializer/serializer_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+class SerializerGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  argument :attributes, type: :array, default: [], banner: 'field field'
+
+  def create_serializer_file
+    template 'serializer.rb.tt', File.join('app', 'serializers', class_path, "#{file_name}_serializer.rb")
+  end
+
+  private
+
+  def attributes_names
+    attributes.map { |a| a.name.to_sym.inspect }
+  end
+end