graphiti-rails 0.2.0

data/lib/generators/graphiti/resource_test_generator.rb

@@ -0,0 +1,56 @@
+require_relative "generator_mixin"
+
+module Graphiti
+  class ResourceTestGenerator < ::Rails::Generators::Base
+    include GeneratorMixin
+
+    source_root File.expand_path("../templates", __FILE__)
+
+    argument :resource, type: :string
+    argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+    class_option :actions,
+      type: :array,
+      default: nil,
+      aliases: ["--actions", "-a"],
+      desc: 'Array of controller actions, e.g. "index show destroy"'
+
+    desc "Generates rspec request specs at spec/api"
+    def generate
+      generate_resource_specs
+    end
+
+    private
+
+    def var
+      dir.singularize
+    end
+
+    def dir
+      @resource.gsub("Resource", "").underscore.pluralize
+    end
+
+    def generate_resource_specs
+      if actions?("create", "update", "destroy")
+        to = "spec/resources/#{var}/writes_spec.rb"
+        template("resource_writes_spec.rb.erb", to)
+      end
+
+      if actions?("index", "show")
+        to = "spec/resources/#{var}/reads_spec.rb"
+        template("resource_reads_spec.rb.erb", to)
+      end
+    end
+
+    def resource_class
+      @resource.constantize
+    end
+
+    def type
+      resource_class.type
+    end
+
+    def model_class
+      resource_class.model
+    end
+  end
+end

data/lib/generators/graphiti/templates/application_resource.rb.erb

@@ -0,0 +1,15 @@
+<%- unless omit_comments? -%>
+# ApplicationResource is similar to ApplicationRecord - a base class that
+# holds configuration/methods for subclasses.
+# All Resources should inherit from ApplicationResource.
+<%- end -%>
+class ApplicationResource < Graphiti::Resource
+  <%- unless omit_comments? -%>
+  # Use the ActiveRecord Adapter for all subclasses.
+  # Subclasses can still override this default.
+  <%- end -%>
+  self.abstract_class = true
+  self.adapter = Graphiti::Adapters::ActiveRecord
+  self.base_url = Rails.application.routes.default_url_options[:host]
+  self.endpoint_namespace = '<%= api_namespace %>'
+end

data/lib/generators/graphiti/templates/controller.rb.erb

@@ -0,0 +1,61 @@
+<% module_namespacing do -%>
+class <%= model_klass.name.pluralize %>Controller < ApplicationController
+  <%- if actions?('index') -%>
+  def index
+    <%= file_name.pluralize %> = <%= resource_klass %>.all(params)
+    <%- if responders? -%>
+    respond_with(<%= file_name.pluralize %>)
+    <%- else -%>
+    render jsonapi: <%= file_name.pluralize %>
+    <%- end -%>
+  end
+  <%- end -%>
+  <%- if actions?('show') -%>
+
+  def show
+    <%= file_name %> = <%= resource_klass %>.find(params)
+    <%- if responders? -%>
+    respond_with(<%= file_name %>)
+    <%- else -%>
+    render jsonapi: <%= file_name %>
+    <%- end -%>
+  end
+  <%- end -%>
+  <%- if actions?('create') -%>
+
+  def create
+    <%= file_name %> = <%= resource_klass %>.build(params)
+
+    if <%= file_name %>.save
+      render jsonapi: <%= file_name %>, status: 201
+    else
+      render jsonapi_errors: <%= file_name %>
+    end
+  end
+  <%- end -%>
+  <%- if actions?('update') -%>
+
+  def update
+    <%= file_name %> = <%= resource_klass %>.find(params)
+
+    if <%= file_name %>.update_attributes
+      render jsonapi: <%= file_name %>
+    else
+      render jsonapi_errors: <%= file_name %>
+    end
+  end
+  <%- end -%>
+  <%- if actions?('destroy') -%>
+
+  def destroy
+    <%= file_name %> = <%= resource_klass %>.find(params)
+
+    if <%= file_name %>.destroy
+      render jsonapi: { meta: {} }, status: 200
+    else
+      render jsonapi_errors: <%= file_name %>
+    end
+  end
+  <%- end -%>
+end
+<% end -%>

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

@@ -0,0 +1,35 @@
+require 'rails_helper'
+
+RSpec.describe "<%= type %>#create", type: :request do
+  subject(:make_request) do
+    jsonapi_post "<%= api_namespace %>/<%= type %>", payload
+  end
+
+  describe 'basic create' do
+    let(:params) do
+      <%- if defined?(FactoryBot) -%>
+      attributes_for(:<%= type.to_s.singularize %>)
+      <%- else -%>
+      {
+        # ... your attrs here
+      }
+      <%- end -%>
+    end
+    let(:payload) do
+      {
+        data: {
+          type: '<%= type %>',
+          attributes: params
+        }
+      }
+    end
+
+    it 'works' do
+      expect(<%= resource_class %>).to receive(:build).and_call_original
+      expect {
+        make_request
+        expect(response.status).to eq(201), response.body
+      }.to change { <%= model_class %>.count }.by(1)
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require 'rails_helper'
+
+RSpec.describe "<%= type %>#destroy", type: :request do
+  subject(:make_request) do
+    jsonapi_delete "<%= api_namespace %>/<%= type %>/#{<%= var %>.id}"
+  end
+
+  describe 'basic destroy' do
+    let!(:<%= var %>) { create(:<%= var %>) }
+
+    it 'updates the resource' do
+      expect(<%= resource_class %>).to receive(:find).and_call_original
+      expect {
+        make_request
+        expect(response.status).to eq(200), response.body
+      }.to change { <%= model_class %>.count }.by(-1)
+      expect { <%= var %>.reload }
+        .to raise_error(ActiveRecord::RecordNotFound)
+      expect(json).to eq('meta' => {})
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require 'rails_helper'
+
+RSpec.describe "<%= type %>#index", type: :request do
+  let(:params) { {} }
+
+  subject(:make_request) do
+    jsonapi_get "<%= api_namespace %>/<%= type %>", params: params
+  end
+
+  describe 'basic fetch' do
+    let!(:<%= var %>1) { create(:<%= var %>) }
+    let!(:<%= var %>2) { create(:<%= var %>) }
+
+    it 'works' do
+      expect(<%= resource_class %>).to receive(:all).and_call_original
+      make_request
+      expect(response.status).to eq(200), response.body
+      expect(d.map(&:jsonapi_type).uniq).to match_array(['<%= type %>'])
+      expect(d.map(&:id)).to match_array([<%= var %>1.id, <%= var %>2.id])
+    end
+  end
+end

data/lib/generators/graphiti/templates/resource.rb.erb

@@ -0,0 +1,11 @@
+<% module_namespacing do -%>
+class <%= class_name %>Resource < ApplicationResource
+  <%- resource_attributes.each do |a| -%>
+  <%- if [:id, :created_at, :updated_at].include?(a.name.to_sym) -%>
+  attribute :<%= a.name %>, :<%= a.type %>, writable: false
+  <%- else -%>
+  attribute :<%= a.name %>, :<%= a.type %>
+  <%- end -%>
+  <%- end -%>
+end
+<% end -%>

data/lib/generators/graphiti/templates/resource_reads_spec.rb.erb

@@ -0,0 +1,78 @@
+require 'rails_helper'
+
+RSpec.describe <%= resource_class %>, type: :resource do
+  describe 'serialization' do
+    let!(:<%= var %>) { create(:<%= var %>) }
+
+    it 'works' do
+      render
+      data = jsonapi_data[0]
+      expect(data.id).to eq(<%= var %>.id)
+      expect(data.jsonapi_type).to eq('<%= type %>')
+      <%- attributes.each do |a| -%>
+      <%- if [:created_at, :updated_at].include?(a.name.to_sym) -%>
+      expect(data.<%= a.name %>).to eq(datetime(<%= file_name %>.<%= a.name %>))
+      <%- else -%>
+      expect(data.<%= a.name %>).to eq(<%= file_name %>.<%= a.name %>)
+      <%- end -%>
+      <%- end -%>
+    end
+  end
+  <%- if actions?('index') -%>
+
+  describe 'filtering' do
+    let!(:<%= var %>1) { create(:<%= var %>) }
+    let!(:<%= var %>2) { create(:<%= var %>) }
+
+    context 'by id' do
+      before do
+        params[:filter] = { id: { eq: <%= var %>2.id } }
+      end
+
+      it 'works' do
+        render
+        expect(d.map(&:id)).to eq([<%= var %>2.id])
+      end
+    end
+  end
+
+  describe 'sorting' do
+    describe 'by id' do
+      let!(:<%= var %>1) { create(:<%= var %>) }
+      let!(:<%= var %>2) { create(:<%= var %>) }
+
+      context 'when ascending' do
+        before do
+          params[:sort] = 'id'
+        end
+
+        it 'works' do
+          render
+          expect(d.map(&:id)).to eq([
+            <%= var %>1.id,
+            <%= var %>2.id
+          ])
+        end
+      end
+
+      context 'when descending' do
+        before do
+          params[:sort] = '-id'
+        end
+
+        it 'works' do
+          render
+          expect(d.map(&:id)).to eq([
+            <%= var %>2.id,
+            <%= var %>1.id
+          ])
+        end
+      end
+    end
+  end
+  <%- end -%>
+
+  describe 'sideloading' do
+    # ... your tests ...
+  end
+end

data/lib/generators/graphiti/templates/resource_writes_spec.rb.erb

@@ -0,0 +1,67 @@
+require 'rails_helper'
+
+RSpec.describe <%= resource_class %>, type: :resource do
+  describe 'creating' do
+    let(:payload) do
+      {
+        data: {
+          type: '<%= type %>',
+      <%- if defined?(FactoryBot) -%>
+          attributes: attributes_for(:<%= type.to_s.singularize %>)
+       <%- else -%>
+          attributes: { }
+       <%- end -%>
+        }
+      }
+    end
+
+    let(:instance) do
+      <%= resource_class %>.build(payload)
+    end
+
+    it 'works' do
+      expect {
+        expect(instance.save).to eq(true), instance.errors.full_messages.to_sentence
+      }.to change { <%= model_class %>.count }.by(1)
+    end
+  end
+
+  describe 'updating' do
+    let!(:<%= var %>) { create(:<%= var %>) }
+
+    let(:payload) do
+      {
+        data: {
+          id: <%= var %>.id.to_s,
+          type: '<%= type %>',
+          attributes: { } # Todo!
+        }
+      }
+    end
+
+    let(:instance) do
+      <%= resource_class %>.find(payload)
+    end
+
+    xit 'works (add some attributes and enable this spec)' do
+      expect {
+        expect(instance.update_attributes).to eq(true)
+      }.to change { <%= var %>.reload.updated_at }
+      # .and change { <%= var %>.foo }.to('bar') <- example
+    end
+  end
+
+  describe 'destroying' do
+    let!(:<%= var %>) { create(:<%= var %>) }
+
+    let(:instance) do
+      <%= resource_class %>.find(id: <%= var %>.id)
+    end
+
+    it 'works' do
+      expect {
+        expect(instance.destroy).to eq(true)
+      }.to change { <%= model_class %>.count }.by(-1)
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'rails_helper'
+
+RSpec.describe "<%= type %>#show", type: :request do
+  let(:params) { {} }
+
+  subject(:make_request) do
+    jsonapi_get "<%= api_namespace %>/<%= type %>/#{<%= var %>.id}", params: params
+  end
+
+  describe 'basic fetch' do
+    let!(:<%= var %>) { create(:<%= var %>) }
+
+    it 'works' do
+      expect(<%= resource_class %>).to receive(:find).and_call_original
+      make_request
+      expect(response.status).to eq(200)
+      expect(d.jsonapi_type).to eq('<%= type %>')
+      expect(d.id).to eq(<%= var %>.id)
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require 'rails_helper'
+
+RSpec.describe "<%= type %>#update", type: :request do
+  subject(:make_request) do
+    jsonapi_put "<%= api_namespace %>/<%= type %>/#{<%= var %>.id}", payload
+  end
+
+  describe 'basic update' do
+    let!(:<%= var %>) { create(:<%= var %>) }
+
+    let(:payload) do
+      {
+        data: {
+          id: <%= var %>.id.to_s,
+          type: '<%= type %>',
+          attributes: {
+            # ... your attrs here
+          }
+        }
+      }
+    end
+
+    # Replace 'xit' with 'it' after adding attributes
+    xit 'updates the resource' do
+      expect(<%= resource_class %>).to receive(:find).and_call_original
+      expect {
+        make_request
+        expect(response.status).to eq(200), response.body
+      }.to change { <%= var %>.reload.attributes }
+    end
+  end
+end

data/lib/graphiti-rails.rb

@@ -0,0 +1,4 @@
+require "graphiti"
+
+# Load our version, not the built-in one
+require_relative "graphiti/rails"

data/lib/graphiti/rails.rb

@@ -0,0 +1,60 @@
+require 'rescue_registry'
+require 'graphiti'
+require 'rails'
+
+module Graphiti
+  if defined?(Graphiti::Rails)
+    remove_const :Rails
+  end
+
+  # Rails integration for Graphiti. See {file:README.md} for more details.
+  module Rails
+    DEPRECATOR = ActiveSupport::Deprecation.new('1.0', 'graphiti-rails')
+
+    autoload :Context, "graphiti/rails/context"
+    autoload :Debugging, "graphiti/rails/debugging"
+    autoload :ExceptionHandler, "graphiti/rails/exception_handlers"
+    autoload :FallbackHandler, "graphiti/rails/exception_handlers"
+    autoload :GraphitiErrorsTesting, "graphiti/rails/graphiti_errors_testing"
+    autoload :InvalidRequestHandler, "graphiti/rails/exception_handlers"
+    autoload :Responders, "graphiti/rails/responders"
+    autoload :TestHelpers, "graphiti/rails/test_helpers"
+
+    def self.included(klass)
+      DEPRECATOR.deprecation_warning("Including Graphiti::Rails", "See https://www.graphiti.dev/guides/graphiti-rails-migration for help migrating to the new format")
+      require 'graphiti_errors'
+      klass.send(:include, GraphitiErrors)
+    end
+
+    # @!attribute self.handled_exception_formats
+    # A list of formats as symbols which will be handled by a GraphitiErrors::ExceptionHandler. See {Railtie}.
+    cattr_accessor :handled_exception_formats, default: []
+
+    # @!attribute self.respond_to_formats
+    # A list of formats as symbols which will be available for Graphiti::Rails::Responders. See {Railtie}.
+    cattr_accessor :respond_to_formats, default: []
+  end
+end
+
+ActiveSupport.on_load(:action_controller) do
+  include Graphiti::Rails::Context
+  include Graphiti::Rails::Debugging
+
+  # A global handler here is somewhat risky. However, we explicitly only handle JSON:API by default.
+  register_exception Exception, status: :passthrough, handler: Graphiti::Rails::FallbackHandler
+
+  register_exception Graphiti::Errors::InvalidRequest,   status: 400, handler: Graphiti::Rails::InvalidRequestHandler
+  register_exception Graphiti::Errors::RecordNotFound,   status: 404, handler: Graphiti::Rails::ExceptionHandler
+  register_exception Graphiti::Errors::RemoteWrite,      status: 400, handler: Graphiti::Rails::ExceptionHandler
+  register_exception Graphiti::Errors::SingularSideload, status: 400, handler: Graphiti::Rails::ExceptionHandler
+end
+
+ActiveSupport.on_load(:active_record) do
+  require "graphiti/adapters/active_record"
+end
+
+require "graphiti/rails/railtie"
+
+if defined?(GraphitiErrors) && Rails.respond_to?(:env) && Rails.env.test?
+  GraphitiErrors.singleton_class.prepend(Graphiti::Rails::GraphitiErrorsTesting)
+end