jsonapi-realizer 6.0.0.rc3 → 6.1.0

data/lib/jsonapi/realizer/action.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     class Action
@@ -18,21 +20,81 @@ module JSONAPI
         raise Error::MissingAcceptHeader unless @headers.key?("Accept")
         raise Error::InvalidAcceptHeader, given: @headers.fetch("Accept"), wanted: JSONAPI::MEDIA_TYPE unless @headers.fetch("Accept") == JSONAPI::MEDIA_TYPE
         raise Error::IncludeWithoutDataProperty if @payload.key?("include") && !@payload.key?("data")
-        raise Error::MalformedDataRootProperty, given: data if @payload.key?("data") && !(data.kind_of?(Array) || data.kind_of?(Hash) || data.nil?)
+        raise Error::MalformedDataRootProperty, given: data if @payload.key?("data") && !(data.is_a?(Array) || data.is_a?(Hash) || data.nil?)
       end
 
       def call; end
 
+      def relation
+        relation_after_fields(
+          relation_after_inclusion(
+            @scope || model_class
+          )
+        )
+      end
+
+      def includes
+        return [] if payload.blank?
+        return [] unless payload.key?("include")
+
+        payload
+          .fetch("include").
+          # "carts.cart-items,carts.cart-items.product,carts.billing-information,payments"
+          split(/\s*,\s*/).
+          # ["carts.cart-items", "carts.cart-items.product", "carts.billing-information", "payments"]
+          map { |path| path.tr("-", "_") }.
+          # ["carts.cart_items", "carts.cart_items.product", "carts.billing_information", "payments"]
+          map { |path| path.split(".") }.
+          # [["carts", "cart_items"], ["carts", "cart_items", "product"], ["carts", "billing_information"], ["payments"]]
+          select do |chain|
+            # ["carts", "cart_items"]
+            chain.reduce(resource_class) do |last_resource_class, key|
+              break unless last_resource_class
+
+              JSONAPI::Realizer::Resource.type_mapping.fetch(last_resource_class.relationship(key).as).resource_class if last_resource_class.valid_includes?(key)
+            end
+          end
+        # [["carts", "cart_items", "product"], ["payments"]]
+      end
+
+      def fields
+        return [] if payload.blank?
+        return [] unless payload.key?("fields")
+
+        payload
+          .fetch("fields").
+          # "title,active-photographer.email,active-photographer.posts.title"
+          split(/\s*,\s*/).
+          # ["title", "active-photographer.email", "active-photographer.posts.title"]
+          map { |path| path.tr("-", "_") }.
+          # ["title", "active_photographer.email", "active_photographer.posts.title"]
+          map { |path| path.split(".") }.
+          # [["title"], ["active_photographer", "email"], ["active_photographer", "posts", "title"]]
+          select do |chain|
+            # ["active_photographer", "email"]
+            chain.reduce(resource_class) do |last_resource_class, key|
+              break unless last_resource_class
+
+              if last_resource_class.valid_includes?(key)
+                JSONAPI::Realizer::Resource.type_mapping.fetch(last_resource_class.relationship(key).as).resource_class
+              elsif last_resource_class.valid_sparse_field?(key)
+                last_resource_class
+              end
+            end
+          end
+        # [["title"], ["active_photographer", "email"]]
+      end
+
       private def model_class
-        resource_class.model_class if resource_class
+        resource_class&.model_class
       end
 
       private def resource_class
-        configuration.resource_class if configuration
+        configuration&.resource_class
       end
 
       private def adapter
-        configuration.adapter if configuration
+        configuration&.adapter
       end
 
       private def relation_after_inclusion(subrelation)
@@ -51,14 +113,6 @@ module JSONAPI
         end
       end
 
-      def relation
-        relation_after_fields(
-          relation_after_inclusion(
-            @scope || model_class
-          )
-        )
-      end
-
       private def data
         payload.fetch("data", nil)
       end
@@ -68,22 +122,26 @@ module JSONAPI
       end
 
       private def attributes
-        data.
-          fetch("attributes", {}).
-          transform_keys(&:underscore).
-          select(&resource_class.method(:valid_attribute?)) if data
+        return unless data
+
+        data
+          .fetch("attributes", {})
+          .transform_keys(&:underscore)
+          .select(&resource_class.method(:valid_attribute?))
       end
 
       private def relationships
-        data.
-          fetch("relationships", {}).
-          transform_keys(&:underscore).
-          select(&resource_class.method(:valid_relationship?)).
-          transform_values(&method(:as_relationship)) if data
+        return unless data
+
+        data
+          .fetch("relationships", {})
+          .transform_keys(&:underscore)
+          .select(&resource_class.method(:valid_relationship?))
+          .transform_values(&method(:as_relationship))
       end
 
       private def as_relationship(value)
-        if value.kind_of?(Array)
+        if value.is_a?(Array)
           value.map do |member|
             data = member.fetch("data")
             mapping = JSONAPI::Realizer.type_mapping.fetch(data.fetch("type"))
@@ -102,58 +160,6 @@ module JSONAPI
         end
       end
 
-      def includes
-        return [] unless payload.present?
-        return [] unless payload.key?("include")
-
-        payload.
-          fetch("include").
-          # "carts.cart-items,carts.cart-items.product,carts.billing-information,payments"
-          split(/\s*,\s*/).
-          # ["carts.cart-items", "carts.cart-items.product", "carts.billing-information", "payments"]
-          map { |path| path.gsub("-", "_") }.
-          # ["carts.cart_items", "carts.cart_items.product", "carts.billing_information", "payments"]
-          map { |path| path.split(".") }.
-          # [["carts", "cart_items"], ["carts", "cart_items", "product"], ["carts", "billing_information"], ["payments"]]
-          select do |chain|
-            # ["carts", "cart_items"]
-            chain.reduce(resource_class) do |last_resource_class, key|
-              break unless last_resource_class
-
-              JSONAPI::Realizer::Resource.type_mapping.fetch(last_resource_class.relationship(key).as).resource_class if last_resource_class.valid_includes?(key)
-            end
-          end
-          # [["carts", "cart_items", "product"], ["payments"]]
-      end
-
-      def fields
-        return [] unless payload.present?
-        return [] unless payload.key?("fields")
-
-        payload.
-          fetch("fields").
-          # "title,active-photographer.email,active-photographer.posts.title"
-          split(/\s*,\s*/).
-          # ["title", "active-photographer.email", "active-photographer.posts.title"]
-          map { |path| path.gsub("-", "_") }.
-          # ["title", "active_photographer.email", "active_photographer.posts.title"]
-          map { |path| path.split(".") }.
-          # [["title"], ["active_photographer", "email"], ["active_photographer", "posts", "title"]]
-          select do |chain|
-            # ["active_photographer", "email"]
-            chain.reduce(resource_class) do |last_resource_class, key|
-              break unless last_resource_class
-
-              if last_resource_class.valid_includes?(key)
-                JSONAPI::Realizer::Resource.type_mapping.fetch(last_resource_class.relationship(key).as).resource_class
-              elsif last_resource_class.valid_sparse_field?(key)
-                last_resource_class
-              end
-            end
-          end
-          # [["title"], ["active_photographer", "email"]]
-      end
-
       private def configuration
         JSONAPI::Realizer::Resource.type_mapping.fetch(type) if type
       end

data/lib/jsonapi/realizer/adapter/active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     class Adapter
@@ -16,14 +18,14 @@ module JSONAPI
 
         def sorting(scope, sorts)
           scope.order(
-            *sorts.
-              map do |(keychain, direction)|
-                [keychain, if direction == "-" then :DESC else :ASC end]
-              end.
-              map do |(keychain, direction)|
-                [keychain.map {|key| key.inspect}.join("."), direction]
-              end.
-              map do |pair|
+            *sorts
+              .map do |(keychain, direction)|
+                [keychain, direction == "-" ? :DESC : :ASC]
+              end
+              .map do |(keychain, direction)|
+                [keychain.map(&:inspect).join("."), direction]
+              end
+              .map do |pair|
                 Arel.sql(pair.join(" "))
               end
           )
@@ -49,7 +51,7 @@ module JSONAPI
           if chains.size == 1
             chains.first
           else
-            {chains.first => arel_chain(chains.drop(1))}
+            { chains.first => arel_chain(chains.drop(1)) }
           end
         end
       end

data/lib/jsonapi/realizer/adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     class Adapter
@@ -6,8 +8,8 @@ module JSONAPI
       require_relative("adapter/active_record")
 
       MAPPINGS = {
-        :active_record => JSONAPI::Realizer::Adapter::ActiveRecord
-      }
+        active_record: JSONAPI::Realizer::Adapter::ActiveRecord
+      }.freeze
       private_constant :MAPPINGS
 
       attr_accessor :interface
@@ -15,17 +17,15 @@ module JSONAPI
       validates_presence_of(:interface)
 
       def initialize(interface:)
-        super(interface: interface)
+        super(interface:)
 
         validate!
 
         mappings = MAPPINGS.merge(JSONAPI::Realizer.configuration.adapter_mappings).with_indifferent_access
 
-        unless mappings.key?(interface)
-          raise(ArgumentError, "you've given an invalid adapter alias: #{interface}, we support #{mappings.keys.to_sentence}")
-        end
+        raise(ArgumentError, "you've given an invalid adapter alias: #{interface}, we support #{mappings.keys.to_sentence}") unless mappings.key?(interface)
 
-        self.singleton_class.prepend(mappings.fetch(interface))
+        singleton_class.prepend(mappings.fetch(interface))
 
         raise(ArgumentError, "need to provide a Adapter#find_one interface") unless respond_to?(:find_one)
         raise(ArgumentError, "need to provide a Adapter#find_many interface") unless respond_to?(:find_many)

data/lib/jsonapi/realizer/adapter_spec.rb

@@ -1,5 +1,3 @@
-require("spec_helper")
-
-RSpec.describe(JSONAPI::Realizer::Adapter) do
+# frozen_string_literal: true
 
-end
+require("spec_helper")

data/lib/jsonapi/realizer/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     class Configuration

data/lib/jsonapi/realizer/context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     module Context

data/lib/jsonapi/realizer/controller.rb

@@ -1,9 +1,26 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     module Controller
+      private def reject_missing_accept_type_header
+        return if request.body.empty?
+        return if request.headers.key?("HTTP_ACCEPT")
+
+        raise(JSONAPI::Realizer.configuration.default_missing_accept_type_exception)
+      end
+
+      private def reject_invalid_accept_type_header
+        reject_missing_accept_type_header
+
+        return if request.headers.fetch("HTTP_ACCEPT").include?(JSONAPI::MEDIA_TYPE)
+
+        raise(JSONAPI::Realizer.configuration.default_invalid_accept_type_exception)
+      end
+
       private def reject_missing_content_type_header
-        return if request.body.size.zero?
-        return if request.headers.property?("Content-Type")
+        return if request.body.empty?
+        return if request.headers.key?("Content-Type")
 
         raise(JSONAPI::Realizer.configuration.default_missing_content_type_exception)
       end
@@ -18,8 +35,8 @@ module JSONAPI
 
       private def reject_missing_root_property
         return if request.parameters.key?("body")
-        return if request.paremters.key?("errors")
-        return if request.paremters.key?("meta")
+        return if request.parameters.key?("errors")
+        return if request.parameters.key?("meta")
 
         raise(Error::MissingRootProperty)
       end
@@ -46,7 +63,7 @@ module JSONAPI
         reject_missing_type_property
 
         return if request.parameters.fetch("data").is_a?(Hash) && request.parameters.fetch("data").fetch("type").is_a?(String) && request.parameters.fetch("data").fetch("type").present?
-        return if request.parameters.fetch("data").is_a?(Array) && request.parameters.fetch("data").map {|data| data.fetch("type")}.all? {|type| type.is_a?(String) && type.present? }
+        return if request.parameters.fetch("data").is_a?(Array) && request.parameters.fetch("data").map { |data| data.fetch("type") }.all? { |type| type.is_a?(String) && type.present? }
 
         raise(Error::InvalidDataTypeProperty)
       end

data/lib/jsonapi/realizer/error/include_without_data_property.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     class Error
       class IncludeWithoutDataProperty < Error
-
       end
     end
   end

data/lib/jsonapi/realizer/error/invalid_content_type_header.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     class Error

data/lib/jsonapi/realizer/error/invalid_data_type_property.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     class Error

data/lib/jsonapi/realizer/error/invalid_root_property.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     class Error

data/lib/jsonapi/realizer/error/missing_content_type_header.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     class Error
       class MissingContentTypeHeader < Error
-
       end
     end
   end

data/lib/jsonapi/realizer/error/missing_data_type_property.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     class Error
       class MissingDataTypeProperty < Error
-
       end
     end
   end

data/lib/jsonapi/realizer/error/missing_root_property.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     class Error
       class MissingRootProperty < Error
-
       end
     end
   end

data/lib/jsonapi/realizer/error/resource_attribute_not_found.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     class Error

data/lib/jsonapi/realizer/error/resource_relationship_not_found.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     class Error

data/lib/jsonapi/realizer/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     class Error < StandardError

data/lib/jsonapi/realizer/resource/attribute.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     module Resource

data/lib/jsonapi/realizer/resource/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     module Resource

data/lib/jsonapi/realizer/resource/relation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JSONAPI
   module Realizer
     module Resource