jsonapi_compliable 0.11.34 → 1.0.alpha.2

data/lib/generators/jsonapi/templates/create_request_spec.rb.erb

@@ -1,29 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe "<%= type %>#create", type: :request do
-  subject(:make_request) do
-    jsonapi_post "/<%= api_namespace %>/v1/<%= type %>", payload
-  end
-
-  describe 'basic create' do
-    let(:payload) do
-      {
-        data: {
-          type: '<%= type %>',
-          attributes: {
-            # ... your attrs here
-          }
-        }
-      }
-    end
-
-    it 'creates the resource' do
-      expect {
-        make_request
-      }.to change { <%= model_klass %>.count }.by(1)
-      <%= file_name %> = <%= model_klass %>.last
-
-      assert_payload(:<%= file_name %>, <%= file_name %>, json_item)
-    end
-  end
-end

data/lib/generators/jsonapi/templates/destroy_request_spec.rb.erb

@@ -1,20 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe "<%= type %>#destroy", type: :request do
-  subject(:make_request) do
-    jsonapi_delete "/<%= api_namespace %>/v1/<%= type %>/#{<%= file_name %>.id}"
-  end
-
-  describe 'basic destroy' do
-    let!(:<%= file_name %>) { create(:<%= file_name %>) }
-
-    it 'updates the resource' do
-      expect {
-        make_request
-      }.to change { <%= model_klass %>.count }.by(-1)
-
-      expect(response.status).to eq(200)
-      expect(json).to eq('meta' => {})
-    end
-  end
-end

data/lib/generators/jsonapi/templates/index_request_spec.rb.erb

@@ -1,22 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe "<%= file_name.pluralize %>#index", type: :request do
-  let(:params) { {} }
-
-  subject(:make_request) do
-    jsonapi_get "/<%= api_namespace %>/v1/<%= file_name.pluralize %>",
-      params: params
-  end
-
-  describe 'basic fetch' do
-    let!(:<%= file_name %>1) { create(:<%= file_name %>) }
-    let!(:<%= file_name %>2) { create(:<%= file_name %>) }
-
-    it 'serializes the list correctly' do
-      make_request
-      expect(json_ids(true)).to match_array([<%= file_name %>1.id, <%= file_name %>2.id])
-      assert_payload(:<%= file_name %>, <%= file_name %>1, json_items[0])
-      assert_payload(:<%= file_name %>, <%= file_name %>2, json_items[1])
-    end
-  end
-end

data/lib/generators/jsonapi/templates/payload.rb.erb

@@ -1,39 +0,0 @@
-<%- unless omit_comments? -%>
-# Register a payload to validate against.
-# Add expected attributes within this block, e.g.:
-#
-# key(:name)
-#
-# Optionally validate the type as well:
-#
-# key(:name, String)
-#
-# This will:
-#
-# * Compare record.name == json['name']
-# * Ensure no extra keys are in the json payload
-# * Ensure no values are nil (unless allow_nil: true is passed)
-# * Ensures json['name'] is a string
-#
-# If you have custom serialization logic and want to compare against
-# something other than "record.name", pass a block:
-#
-# key(:name) { |record| record.name.upcase }
-#
-# Or, if this is a one-off for a particular spec, do that customization at
-# runtime:
-#
-# assert_payload(:person, person_record, json_item) do
-#   key(:name) { 'Homer Simpson' }
-# end
-#
-# For more information, see https://jsonapi-suite.github.io/jsonapi_spec_helpers/
-<%- end -%>
-JsonapiSpecHelpers::Payload.register(:<%= file_name %>) do
-  <%- attributes.each do |a| -%>
-  <%- type = a.type == :boolean ? [TrueClass, FalseClass] : a.type.to_s.classify -%>
-  <%- type = String if a.type == :text -%>
-  <%- type = Float if a.type == :decimal -%>
-  key(:<%= a.name %>, <%= type %>)
-  <%- end -%>
-end

data/lib/generators/jsonapi/templates/serializer.rb.erb

@@ -1,25 +0,0 @@
-<%- unless omit_comments? -%>
-# Serializers define the rendered JSON for a model instance.
-# We use jsonapi-rb, which is similar to active_model_serializers.
-<%- end -%>
-<% module_namespacing do -%>
-class Serializable<%= class_name %> < JSONAPI::Serializable::Resource
-  type :<%= type %>
-
-  <%- unless omit_comments? -%>
-  # Add attributes here to ensure they get rendered, .e.g.
-  #
-  # attribute :name
-  #
-  # To customize, pass a block and reference the underlying @object
-  # being serialized:
-  #
-  # attribute :name do
-  #   @object.name.upcase
-  # end
-  <%- end -%>
-  <%- attributes.each do |a| -%>
-  attribute :<%= a.name %>
-  <%- end -%>
-end
-<% end -%>

data/lib/generators/jsonapi/templates/show_request_spec.rb.erb

@@ -1,19 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe "<%= file_name.pluralize %>#show", type: :request do
-  let(:params) { {} }
-
-  subject(:make_request) do
-    jsonapi_get "/<%= api_namespace %>/v1/<%= file_name.pluralize %>/#{<%= file_name %>.id}",
-      params: params
-  end
-
-  describe 'basic fetch' do
-    let!(:<%= file_name %>) { create(:<%= file_name %>) }
-
-    it 'serializes the resource correctly' do
-      make_request
-      assert_payload(:<%= file_name %>, <%= file_name %>, json_item)
-    end
-  end
-end

data/lib/generators/jsonapi/templates/update_request_spec.rb.erb

@@ -1,33 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe "<%= type %>#update", type: :request do
-  subject(:make_request) do
-    jsonapi_put "/<%= api_namespace %>/v1/<%= type %>/#{<%= file_name %>.id}", payload
-  end
-
-  describe 'basic update' do
-    let!(:<%= file_name %>) { create(:<%= file_name %>) }
-
-    let(:payload) do
-      {
-        data: {
-          id: <%= file_name %>.id.to_s,
-          type: '<%= type %>',
-          attributes: {
-            # ... your attrs here
-          }
-        }
-      }
-    end
-
-    # Replace 'xit' with 'it' after adding attributes
-    xit 'updates the resource' do
-      expect {
-        make_request
-      }.to change { <%= file_name %>.reload.attributes }
-      assert_payload(:<%= file_name %>, <%= file_name %>, json_item)
-
-      # ... assert updates attributes ...
-    end
-  end
-end

data/lib/jsonapi_compliable/adapters/active_record_sideloading.rb

@@ -1,152 +0,0 @@
-module JsonapiCompliable
-  module Adapters
-    module ActiveRecordSideloading
-      def has_many(association_name, scope: nil, resource:, foreign_key:, primary_key: :id, &blk)
-        _scope = scope
-
-        allow_sideload association_name, type: :has_many, resource: resource, foreign_key: foreign_key, primary_key: primary_key do
-          scope do |parents|
-            parent_ids = parents.map { |p| p.send(primary_key) }
-            _scope.call.where(foreign_key => parent_ids.uniq.compact)
-          end
-
-          assign do |parents, children|
-            children_hash = children.group_by(&foreign_key)
-            parents.each do |parent|
-              parent.association(association_name).loaded!
-              relevant_children = children_hash[parent.send(primary_key)] || []
-              relevant_children.each do |c|
-                parent.association(association_name).add_to_target(c, :skip_callbacks)
-              end
-            end
-          end
-
-          instance_eval(&blk) if blk
-        end
-      end
-
-      def belongs_to(association_name, scope: nil, resource:, foreign_key:, primary_key: :id, &blk)
-        _scope = scope
-
-        allow_sideload association_name, type: :belongs_to, resource: resource, foreign_key: foreign_key, primary_key: primary_key do
-          scope do |parents|
-            parent_ids = parents.map { |p| p.send(foreign_key) }
-            _scope.call.where(primary_key => parent_ids.uniq.compact)
-          end
-
-          assign do |parents, children|
-            children_hash = children.index_by(&primary_key)
-            parents.each do |parent|
-              relevant_child = children_hash[parent.send(foreign_key)]
-              parent.send(:"#{association_name}=", relevant_child)
-            end
-          end
-
-          instance_eval(&blk) if blk
-        end
-      end
-
-      def has_one(association_name, scope: nil, resource:, foreign_key:, primary_key: :id, &blk)
-        _scope = scope
-
-        allow_sideload association_name, type: :has_one, foreign_key: foreign_key, primary_key: primary_key, resource: resource do
-          scope do |parents|
-            parent_ids = parents.map { |p| p.send(primary_key) }
-            _scope.call.where(foreign_key => parent_ids.uniq.compact)
-          end
-
-          # The 'assigned' code here is to remove all children that do not
-          # get assigned. This is because there is no 'limit(1)' in the query.
-          # If we did 'limit(1)' for the query, it wouldn't work for index
-          # actions (only 1 would come back, when we want one *per result*).
-          #
-          # Instead, avoid pagination in the query, assign only one result, and
-          # remove anything else. This is more or less what AR does.
-          assign do |parents, children|
-            assigned = []
-            children_hash = children.group_by(&foreign_key)
-            parents.each do |parent|
-              parent.association(association_name).loaded!
-              relevant_children = children_hash[parent.send(primary_key)]
-              next unless relevant_children
-              relevant_child = relevant_children.first
-
-              # Use private methods because of Rails bug
-              # https://github.com/rails/rails/issues/32886
-              association = parent.association(association_name)
-              association.send(:set_owner_attributes, relevant_child)
-              association.send(:set_inverse_instance, relevant_child)
-              association.send(:target=, relevant_child)
-              assigned << relevant_child
-            end
-            children.replace(assigned)
-          end
-
-          instance_eval(&blk) if blk
-        end
-      end
-
-      def has_and_belongs_to_many(association_name, scope: nil, resource:, foreign_key:, primary_key: :id, as: nil, &blk)
-        through = foreign_key.keys.first
-        fk      = foreign_key.values.first
-        _scope  = scope
-
-        allow_sideload association_name, type: :habtm, foreign_key: foreign_key, primary_key: primary_key, resource: resource do
-          scope do |parents|
-            parent_ids = parents.map { |p| p.send(primary_key) }
-            parent_ids.uniq!
-            parent_ids.compact!
-
-            table_name = parents[0]
-              .class.reflections[through.to_s].klass.table_name
-
-            _scope.call
-              .includes(through)
-              .where(table_name => { fk => parent_ids })
-              .distinct
-          end
-
-          assign do |parents, children|
-            parents.each do |parent|
-              parent.association(association_name).loaded!
-              relevant_children = children.select { |c| c.send(through).any? { |ct| ct.send(fk) == parent.send(primary_key) } }
-              relevant_children.each do |c|
-                parent.association(association_name).add_to_target(c, :skip_callbacks)
-              end
-            end
-          end
-
-          instance_eval(&blk) if blk
-        end
-      end
-
-      def polymorphic_belongs_to(association_name, group_by:, groups:, &blk)
-        allow_sideload association_name, type: :polymorphic_belongs_to, polymorphic: true do
-          group_by(group_by)
-
-          groups.each_pair do |type, config|
-            primary_key = config[:primary_key] || :id
-            foreign_key = config[:foreign_key]
-
-            allow_sideload type, parent: self, primary_key: primary_key, foreign_key: foreign_key, type: :belongs_to, resource: config[:resource] do
-              scope do |parents|
-                parent_ids = parents.map { |p| p.send(foreign_key) }
-                parent_ids.compact!
-                parent_ids.uniq!
-                config[:scope].call.where(primary_key => parent_ids)
-              end
-
-              assign do |parents, children|
-                parents.each do |parent|
-                  parent.send(:"#{association_name}=", children.find { |c| c.send(primary_key) == parent.send(foreign_key) })
-                end
-              end
-            end
-          end
-        end
-
-        instance_eval(&blk) if blk
-      end
-    end
-  end
-end

data/lib/jsonapi_compliable/scoping/extra_fields.rb

@@ -1,58 +0,0 @@
-module JsonapiCompliable
-  # Apply logic when an extra field is requested. Useful for eager loading
-  # associations used to compute the extra field.
-  #
-  # Given a Resource
-  #
-  #   class PersonResource < ApplicationResource
-  #     extra_field :net_worth do |scope|
-  #       scope.includes(:assets)
-  #     end
-  #   end
-  #
-  # And a corresponding serializer:
-  #
-  #   class SerializablePerson < JSONAPI::Serializable::Resource
-  #     extra_attribute :net_worth do
-  #       @object.assets.sum(&:value)
-  #     end
-  #   end
-  #
-  # When the user requests the extra field 'net_worth':
-  #
-  #   GET /people?extra_fields[people]=net_worth
-  #
-  # The +assets+ will be eager loaded and the 'net_worth' attribute
-  # will be present in the response. If this field is not explicitly
-  # requested, none of this logic fires.
-  #
-  # @see Resource.extra_field
-  # @see Extensions::ExtraAttribute
-  class Scoping::ExtraFields < Scoping::Base
-    # Loop through all requested extra fields. If custom scoping
-    # logic is define for that field, run it. Otherwise, do nothing.
-    #
-    # @return the scope object we are chaining/modofying
-    def apply
-      each_extra_field do |callable|
-        @scope = callable.call(@scope, resource.context)
-      end
-
-      @scope
-    end
-
-    private
-
-    def each_extra_field
-      resource.extra_fields.each_pair do |name, callable|
-        if extra_fields.include?(name)
-          yield callable
-        end
-      end
-    end
-
-    def extra_fields
-      query_hash[:extra_fields][resource.type] || []
-    end
-  end
-end