graphiti 2.0.0.beta.7 → 2.0.0.beta.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acced292af02bc2826f89f6e1d9388bcc7fdedabada42e4cc65d1bfaf9f713f5
-  data.tar.gz: 79f966dc31ccb9b3aee687e7dc31a92e943e17845b6017258e366bebee066446
+  metadata.gz: b5605ecf7bc316cef1342565d7cd54cf7136a98915d669905550dcce32452d7c
+  data.tar.gz: 71be03dd2e18fed5485fe154957e8d5366ec21d648cfaf023281277e7d7c5e5a
 SHA512:
-  metadata.gz: 22584fd2a83e017219fb8202c965d3d295ac341fed01b2e543355c32722cae741866f3188970ee480018d6063c78b06281045f22934c42b9645de72c6cc9562f
-  data.tar.gz: 502371f38ad71f5e901b57ba187be70bb4d7c85c94544324e825207bc03f120fa652d0859fe56744efbdbcf826376dad84a4917444c62a7e30193482bca47700
+  metadata.gz: facebd92bdb5be565324696a089595e2b224cbf79872e60cc92dc4422ded817ad22937a3e9b9008744140f55b1519b97f00cb0e7708a92a7bfda88d5339a18a9
+  data.tar.gz: cb80adbf97d38e470c1a6b56bb0cbe49b59abfbe4a81cc0438696cc6452b2677a6f4d2d43a859c6eb4e06815ac4912ae3aa4c52085fbff89f8f05b1f5c9c32eb

data/.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# standardrb reformat from the 1.4 -> 1.56 upgrade
+5fe4fe5188f75461be817528c8d911090ce94340

data/.github/workflows/ci.yml

@@ -15,13 +15,17 @@ jobs:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: "3.2"
           bundler-cache: true
       - name: Run standardrb
-        run: bundle exec standardrb --no-fix --format progress
+        run: |
+          bundle exec standardrb --no-fix --format progress || {
+            echo "::error::Lint failed. Almost everything standard flags is auto-fixable — run 'bundle exec standardrb --fix' locally and push the result."
+            exit 1
+          }
   test:
     name: "Tests - ${{ matrix.ruby }} | ${{ matrix.gemfile }}"
     runs-on: ubuntu-latest
@@ -74,13 +78,61 @@ jobs:
       - name: Set up Appraisal
         if: matrix.appraisal
         run: echo "APPRAISAL_INITIALIZED=true" >> $GITHUB_ENV
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
       - name: Run tests
         run: bundle exec rspec
+  example-app:
+    name: "Example app (employee_directory)"
+    runs-on: ubuntu-latest
+    # The example app lives in its own repo and can lag behind; it is an
+    # integration canary, not a merge gate.
+    continue-on-error: true
+    env:
+      GRAPHITI_PATH: ${{ github.workspace }}/graphiti
+      BUNDLE_FROZEN: "false" # the path override rewrites the checked-in lockfile
+    defaults:
+      run:
+        working-directory: employee_directory
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          path: graphiti
+      - uses: actions/checkout@v4
+        with:
+          repository: graphiti-api/employee_directory
+          path: employee_directory
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.3"
+      - name: Bundle against this graphiti
+        run: bundle install
+      - name: Run the example app suite
+        run: |
+          bundle exec rails db:test:prepare
+          bundle exec rspec
+  examples:
+    name: "Examples (plain ruby, sinatra)"
+    runs-on: ubuntu-latest
+    # In-tree examples run against the working copy via their path: Gemfiles.
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.3"
+      - name: Run the plain ruby example
+        working-directory: examples/plain_ruby
+        run: |
+          bundle install
+          bundle exec ruby index.rb
+      - name: Run the sinatra example
+        working-directory: examples/sinatra
+        run: |
+          bundle install
+          bundle exec ruby smoke.rb
   publish:
     name: Release
     runs-on: ubuntu-latest

data/.github/workflows/docs.yml

@@ -25,7 +25,7 @@ jobs:
     name: Build and publish
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: '20'

data/.github/workflows/notify-example-app.yml

@@ -0,0 +1,18 @@
+name: Notify example app
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  dispatch:
+    name: Dispatch employee_directory update
+    runs-on: ubuntu-latest
+    steps:
+      - name: Send repository_dispatch
+        run: |
+          gh api -X POST repos/graphiti-api/employee_directory/dispatches \
+            -f event_type=graphiti-release \
+            -f 'client_payload[version]=${{ github.event.release.tag_name }}'
+        env:
+          GH_TOKEN: ${{ secrets.EXAMPLE_APP_TOKEN }}

data/.gitignore

@@ -22,3 +22,5 @@ website/.docusaurus/
 
 .DS_Store
 .idea/
+examples/*/Gemfile.lock
+examples/sinatra/*.sqlite3*

data/.standard.yml

@@ -4,6 +4,12 @@ ruby_version: 3.2
 
 ignore:
   - 'vendor/**/*'
+  # The Rails app template's heredocs are written into the user's files, so
+  # their literal indentation is load-bearing and the <<~ autofix would
+  # change what gets generated.
+  - 'templates/**/*':
+    - Layout/HeredocIndentation
+    - Layout/ClosingHeredocIndentation
   # The docs site, including the frozen 1.x archive under static/. None of it
   # is ours to restyle, and some of it is generated.
   - 'website/**/*'

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 graphiti changelog
 
+# [2.0.0-beta.8](https://github.com/graphiti-api/graphiti/compare/v2.0.0-beta.7...v2.0.0-beta.8) (2026-08-10)
+
+
+### Bug Fixes
+
+* accept a single value for array filters ([#517](https://github.com/graphiti-api/graphiti/issues/517)) ([ee685b6](https://github.com/graphiti-api/graphiti/commit/ee685b625e967a8225d48b486bd093e3a6970176))
+* accept a single value for array filters ([#517](https://github.com/graphiti-api/graphiti/issues/517)) ([23f3e80](https://github.com/graphiti-api/graphiti/commit/23f3e80b583b0bf0843d8bb9334970ae56d83299))
+* drop the relationship guard install notice ([65b8be6](https://github.com/graphiti-api/graphiti/commit/65b8be65455a7d034c9dca082434c1dbfe610a7a))
+* reject invalid page parameters ([#537](https://github.com/graphiti-api/graphiti/issues/537)) ([fbb5683](https://github.com/graphiti-api/graphiti/commit/fbb5683393301e17ffcea84990ac5a95bdd3e15f)), closes [#347](https://github.com/graphiti-api/graphiti/issues/347)
+* treat empty polymorphic configuration as unset ([#538](https://github.com/graphiti-api/graphiti/issues/538)) ([a27eeea](https://github.com/graphiti-api/graphiti/commit/a27eeea6eeb72749376c1f7959cadc89012142b9)), closes [#199](https://github.com/graphiti-api/graphiti/issues/199)
+* typecast null values in filter lists ([#515](https://github.com/graphiti-api/graphiti/issues/515)) ([3756fd1](https://github.com/graphiti-api/graphiti/commit/3756fd12c48d2fb3cf5e2d40c38aab92f12218b0))
+* typecast null values in filter lists ([#515](https://github.com/graphiti-api/graphiti/issues/515)) ([3dcf4c8](https://github.com/graphiti-api/graphiti/commit/3dcf4c868abb12eb6b6d59cd0814b227d4838ece))
+
+
+### Features
+
+* add full set of commented-out Resource defaults in ApplicationResource when using the generator ([367678e](https://github.com/graphiti-api/graphiti/commit/367678eb3c2c737331f8edb00e00e70483a778b4))
+* **generators:** explicit rendering by default, respond_with only when Responders is included ([70741fe](https://github.com/graphiti-api/graphiti/commit/70741fef2a3a585bbef32c3e535027ff610fda77))
+* in-tree plain ruby and sinatra examples ([b92c6d9](https://github.com/graphiti-api/graphiti/commit/b92c6d9af22f759cc1f1eaccc250ecd04901e2aa))
+* ship the Rails application template in this repo ([76d5329](https://github.com/graphiti-api/graphiti/commit/76d53291f94c576792e3649044784f88fbaa47a7))
+
 # [2.0.0-beta.7](https://github.com/graphiti-api/graphiti/compare/v2.0.0-beta.6...v2.0.0-beta.7) (2026-08-10)
 
 
@@ -101,6 +122,30 @@ GraphitiErrors::Validation::Serializer is now Graphiti::ErrorSerializers::Valida
 * around_persistence hooks receive the assigned model instead of the attributes hash. Move attribute-hash modifications to before_attributes, or set values on the model. Custom create/update overrides that should receive a pre-assigned model must accept an assigned_model: keyword. See UPGRADING.md
 * Ruby >= 3.0 / Rails >= 6 are now required.
 
+## [1.13.3](https://github.com/graphiti-api/graphiti/compare/v1.13.2...v1.13.3) (2026-08-09)
+
+
+### Bug Fixes
+
+* reject invalid page parameters ([#537](https://github.com/graphiti-api/graphiti/issues/537)) ([fbb5683](https://github.com/graphiti-api/graphiti/commit/fbb5683393301e17ffcea84990ac5a95bdd3e15f)), closes [#347](https://github.com/graphiti-api/graphiti/issues/347)
+* treat empty polymorphic configuration as unset ([#538](https://github.com/graphiti-api/graphiti/issues/538)) ([a27eeea](https://github.com/graphiti-api/graphiti/commit/a27eeea6eeb72749376c1f7959cadc89012142b9)), closes [#199](https://github.com/graphiti-api/graphiti/issues/199)
+
+## [1.13.2](https://github.com/graphiti-api/graphiti/compare/v1.13.1...v1.13.2) (2026-08-07)
+
+
+### Bug Fixes
+
+* drop the relationship guard install notice ([65b8be6](https://github.com/graphiti-api/graphiti/commit/65b8be65455a7d034c9dca082434c1dbfe610a7a))
+
+## [1.13.1](https://github.com/graphiti-api/graphiti/compare/v1.13.0...v1.13.1) (2026-08-02)
+
+
+### Bug Fixes
+
+* accept a single value for array filters ([#517](https://github.com/graphiti-api/graphiti/issues/517)) ([23f3e80](https://github.com/graphiti-api/graphiti/commit/23f3e80b583b0bf0843d8bb9334970ae56d83299))
+* typecast null values in filter lists ([#515](https://github.com/graphiti-api/graphiti/issues/515)) ([3dcf4c8](https://github.com/graphiti-api/graphiti/commit/3dcf4c868abb12eb6b6d59cd0814b227d4838ece))
+
+
 # [1.13.0](https://github.com/graphiti-api/graphiti/compare/v1.12.2...v1.13.0) (2026-07-30)
 
 

data/CONTRIBUTING.md

@@ -65,7 +65,7 @@ The Rails integration specs are gated behind an environment variable and are
 covering none of the ActiveRecord adapter:
 
 ```sh
-BUNDLE_GEMFILE=gemfiles/rails_8_0_graphiti_rails.gemfile \
+BUNDLE_GEMFILE=gemfiles/rails_8_0.gemfile \
   APPRAISAL_INITIALIZED=1 \
   bundle exec rspec spec/integration/rails/
 ```
@@ -75,3 +75,5 @@ Lint with:
 ```sh
 bundle exec standardrb
 ```
+
+CI fails PRs that don't pass lint, and almost everything standard flags is auto-fixable — run `bundle exec standardrb --fix` before pushing. (A bare `rake` also runs lint before the specs.)

data/README.md

@@ -1,4 +1,4 @@
-#### Graphiti
+### Graphiti
 
 [![CI](https://github.com/graphiti-api/graphiti/actions/workflows/ci.yml/badge.svg)](https://github.com/graphiti-api/graphiti/actions/workflows/ci.yml)
 [![Gem Version](https://badge.fury.io/rb/graphiti.svg)](https://badge.fury.io/rb/graphiti)
@@ -7,233 +7,40 @@
 
 
 [![discord](https://img.shields.io/badge/community-discord-8A2BE2?logo=discord)](https://discord.gg/wgqkMBsSRV)
-[![guides](https://img.shields.io/badge/guides-https://www.graphiti.dev-F565A5)](https://www.graphiti.dev)
+[![guides](https://img.shields.io/badge/guides-https://graphiti.dev-F565A5)](https://graphiti.dev)
 
 
 
 <img align="right" src="https://user-images.githubusercontent.com/55264/54884141-c10ada00-4e43-11e9-866b-e3c01e33a7c7.png" alt="Graphiti logo" width="150px" />
-Graphiti is a resource-oriented framework that sits on top of your models (usually ActiveRecord) and exposes them via a JSON:API-compliant interface. It abstracts common concerns like serialization, filtering, sorting, pagination, and sideloading relationships, so you can build powerful APIs with minimal boilerplate. By defining resources instead of controllers and serializers, Graphiti helps you keep your API logic organized, consistent, and easy to maintain.
 
+Graphiti sits on top of your models (usually ActiveRecord) and exposes them over a JSON:API-compliant interface. You define Resources instead of controllers and serializers, and get filtering, sorting, pagination, sparse fieldsets, statistics, and nested reads and writes across relationships, all over one endpoint.
 
-#### Examples 
-Here's an example resource from the [example app](https://github.com/graphiti-api/employee_directory/) just to give you a taste of the possibilities. 
+It's built on the [JSON:API](https://jsonapi.org) spec, which settles the decisions every API accumulates: response shapes, filtering, sorting, pagination, error formats, and how related data rides along. Your client layer speaks this protocol in return. It isn't complicated, so client logic can be hand-rolled or you can use one of the [many available libraries](https://jsonapi.org/implementations/#client-libraries) that work with the standard.
 
+A Resource looks like this:
 
 ```ruby
 class EmployeeResource < ApplicationResource
   attribute :first_name, :string
   attribute :last_name, :string
   attribute :age, :integer
-  attribute :created_at, :datetime, writable: false
-  attribute :updated_at, :datetime, writable: false
-  attribute :title, :string, only: [:filterable, :sortable]
 
   has_many :positions
-  has_many :tasks
-  many_to_many :teams
-  polymorphic_has_many :notes, as: :notable
-  has_one :current_position, resource: PositionResource do
-    params do |hash|
-      hash[:filter][:current] = true
-    end
-  end
-
-  filter :title, only: [:eq] do
-    eq do |scope, value|
-      scope.joins(:current_position).merge(Position.where(title: value))
-    end
-  end
-
-  sort :title do |scope, value|
-    scope.joins(:current_position).merge(Position.order(title: value))
-  end
-
-  sort :department_name, :string do |scope, value|
-    scope.joins(current_position: :department)
-      .merge(Department.order(name: value))
-  end
 end
 ```
 
-In Rails, controllers serving resources include `Graphiti::Rails::Controller`. Putting it in `ApplicationController` covers the whole app; putting it in an API base class scopes it there and leaves the rest alone.
+That Resource serves `?filter[age][gt]=30`, `?sort=-age`, `?page[size]=10`, `?include=positions` and more, without writing any of them. See [graphiti.dev](https://graphiti.dev/) for the whole loop, or the [example app](https://github.com/graphiti-api/employee_directory/) for a full working API.
 
-```ruby
-class ApplicationController < ActionController::Base
-  include Graphiti::Rails::Controller
-end
-```
+### Documentation
 
-That gives those controllers the Graphiti context, the debugger, and JSON:API rendering for Graphiti's exceptions plus anything else raised. Registering your own exceptions does not require it — `register_exception` is available on every controller — but only controllers with the include render *unregistered* exceptions as JSON:API rather than falling through to Rails.
+Docs live at [graphiti.dev](https://graphiti.dev/) and are rendered from this repo: the markdown is in [`/docs`](docs), and the Docusaurus site that serves it is in [`/website`](website). Fixes and improvements are welcome (every page has an "Edit this page" link at the bottom, which makes opening a PR with a change easy).
 
-A pretty boilerplate controller that just interfaces with the resource. `respond_with` comes from the [`responders`](https://github.com/heartcombo/responders) gem; with it in your Gemfile, add `include Graphiti::Rails::Responders` as well. Otherwise use `render jsonapi:` as the write actions below do.
+To preview locally:
 
-```ruby
-class EmployeesController < ApplicationController
-  def index
-    employees = EmployeeResource.all(params)
-    respond_with(employees)
-  end
-
-  def show
-    employee = EmployeeResource.find(params)
-    respond_with(employee)
-  end
-
-  def create
-    employee = EmployeeResource.build(params)
-
-    if employee.save
-      render jsonapi: employee, status: 201
-    else
-      render jsonapi_errors: employee
-    end
-  end
-
-  def update
-    employee = EmployeeResource.find(params)
-
-    if employee.update_attributes
-      render jsonapi: employee
-    else
-      render jsonapi_errors: employee
-    end
-  end
-
-  def destroy
-    employee = EmployeeResource.find(params)
-
-    if employee.destroy
-      render jsonapi: { meta: {} }, status: 200
-    else
-      render jsonapi_errors: employee
-    end
-  end
-end
-```
-  
-</details>
-
-
-Now you can query your endpoints simply and powerfully, like: 
-
-
-
-Request:
-```http://localhost:3000/api/v1/employees?filter[title][eq]=Future Government Administrator&filter[age][lt]=40```
-
-<details>
-<summary>JSON-API response</summary>
-
-```json
-{
-  "data": [
-    {
-      "id": "1",
-      "type": "employees",
-      "attributes": {
-        "first_name": "Quinn",
-        "last_name": "Homenick",
-        "age": 36,
-        "created_at": "2025-03-21T23:04:40+00:00",
-        "updated_at": "2025-03-21T23:04:40+00:00"
-      },
-      "relationships": {
-        "positions": {
-          "links": {
-            "related": "/api/v1/positions?filter[employee_id]=1"
-          },
-          "data": [
-            {
-              "type": "positions",
-              "id": "1"
-            },
-            {
-              "type": "positions",
-              "id": "2"
-            }
-          ]
-        },
-        "tasks": {
-          "links": {
-            "related": "/api/v1/tasks?filter[employee_id]=1"
-          }
-        },
-        "teams": {
-          "links": {
-            "related": "/api/v1/teams?filter[employee_id]=1"
-          }
-        },
-        "notes": {
-          "links": {
-            "related": "/api/v1/notes?filter[notable_id]=1&filter[notable_type][eql]=Employee"
-          }
-        },
-        "current_position": {
-          "links": {
-            "related": "/api/v1/positions?filter[current]=true&filter[employee_id]=1"
-          },
-          "data": {
-            "type": "positions",
-            "id": "1"
-          }
-        }
-      }
-    }
-  ],
-  "included": [
-    {
-      "id": "1",
-      "type": "positions",
-      "attributes": {
-        "title": "Future Government Administrator",
-        "active": true
-      },
-      "relationships": {
-        "employee": {
-          "links": {
-            "related": "/api/v1/employees/1"
-          }
-        },
-        "department": {
-          "links": {
-            "related": "/api/v1/departments/3"
-          }
-        }
-      }
-    },
-    {
-      "id": "2",
-      "type": "positions",
-      "attributes": {
-        "title": "Manufacturing Specialist",
-        "active": false
-      },
-      "relationships": {
-        "employee": {
-          "links": {
-            "related": "/api/v1/employees/1"
-          }
-        },
-        "department": {
-          "links": {
-            "related": "/api/v1/departments/2"
-          }
-        }
-      }
-    }
-  ],
-  "meta": {}
-}
+```bash
+cd website
+npm install
+npm run start
 ```
 
-</details>
-
-
-
-[Graphiti Documentation](https://www.graphiti.dev/)
-
 [Join the Discord](https://discord.gg/wgqkMBsSRV)
-
-
-
-

data/Rakefile

@@ -1,6 +1,9 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "appraisal"
+# Standard is silent on success; show the inspected-files summary.
+ENV["STANDARDOPTS"] ||= "--format progress"
+require "standard/rake"
 
 RSpec::Core::RakeTask.new(:spec) do |t|
   if ENV["APPRAISAL_INITIALIZED"]
@@ -8,8 +11,8 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   end
 end
 
-if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
-  task default: [:spec, :appraisal]
-else
+if ENV["APPRAISAL_INITIALIZED"]
   task default: [:spec]
+else
+  task default: [:standard, :spec, :appraisal]
 end

data/UPGRADING.md

@@ -1,5 +1,5 @@
 # Upgrading Graphiti
 
-The upgrade guide lives with the rest of the documentation, so it can link into the concept pages and offer the same version picker: **https://www.graphiti.dev/upgrading**
+The upgrade guide lives with the rest of the documentation, so it can link into the concept pages and offer the same version picker: **https://graphiti.dev/upgrading**
 
 In this repository it is [docs/upgrading/](docs/upgrading/index.md).

data/graphiti.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/graphiti-api/graphiti"
   spec.license = "MIT"
 
-  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|templates|website|docs|examples)/}) }
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
@@ -27,12 +27,16 @@ Gem::Specification.new do |spec|
   # Bundled (no longer default) as of Ruby 4.0; graphiti uses OpenStruct in lib/
   spec.add_dependency "ostruct", ">= 0.5"
 
-  spec.add_development_dependency "faraday", "~> 0.15"
-  spec.add_development_dependency "kaminari", "~> 0.17"
+  spec.add_development_dependency "faraday", ">= 2.0", "< 3"
+  spec.add_development_dependency "kaminari", "~> 1.2"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", ">= 10.0"
-  spec.add_development_dependency "standard", "~> 1.4.0"
+  spec.add_development_dependency "standard", "~> 1.56"
   spec.add_development_dependency "activemodel", ">= 7.1"
+  # Only the specs need this, for ActiveSupport's Hash.from_xml when asserting
+  # on to_xml output. It used to arrive transitively via rubocop; rubocop 1.88
+  # dropped it, and it is a bundled (not default) gem since Ruby 3.0.
+  spec.add_development_dependency "rexml"
   # Was reaching the suite transitively through graphiti_spec_helpers, which is
   # now part of this gem.
   spec.add_development_dependency "rspec", "~> 3.0"

data/lib/generators/graphiti/generator_mixin.rb

@@ -39,7 +39,7 @@ module Graphiti
 
     def update_config!(attrs)
       config = graphiti_config.merge(attrs)
-      File.open(".graphiticfg.yml", "w") { |f| f.write(config.to_yaml) }
+      File.write(".graphiticfg.yml", config.to_yaml)
     end
 
     def id_or_rawid

data/lib/generators/graphiti/install_generator.rb

@@ -6,7 +6,7 @@ module Graphiti
 
     source_root File.expand_path("templates", __dir__)
 
-    class_option :'omit-comments',
+    class_option :"omit-comments",
       type: :boolean,
       default: false,
       aliases: ["-c"],

data/lib/generators/graphiti/resource_generator.rb

@@ -8,7 +8,7 @@ module Graphiti
 
     argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
 
-    class_option :'omit-comments',
+    class_option :"omit-comments",
       type: :boolean,
       default: false,
       aliases: ["--omit-comments", "-c"],
@@ -26,7 +26,7 @@ module Graphiti
       aliases: ["--actions", "-a"],
       desc: 'Array of controller actions to support, e.g. "index show destroy"'
 
-    class_option :'attributes-from',
+    class_option :"attributes-from",
       banner: "Model",
       type: :string,
       aliases: ["--model", "-m"],
@@ -127,8 +127,11 @@ module Graphiti
       end
     end
 
+    # Generated controllers only use respond_with when it will actually work:
+    # the responders gem being installed is not enough, the controller chain
+    # must include Graphiti::Rails::Responders.
     def responders?
-      defined?(::Responders)
+      "ApplicationController".safe_constantize&.include?(Graphiti::Rails::Responders)
     end
 
     # Api::V1::Posts, Api::V1::PostsController and api/v1/posts all name the

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

@@ -12,4 +12,23 @@ class ApplicationResource < Graphiti::Resource
   self.adapter = Graphiti::Adapters::ActiveRecord
   self.base_url = Rails.application.routes.default_url_options[:host]
   self.endpoint_namespace = '<%= api_namespace %>'
+  <%- unless omit_comments? -%>
+
+  # Defaults every Resource inherits. These are already the values shown;
+  # uncomment to change them API-wide, or set them on individual Resources.
+  # See https://graphiti.dev/concepts/resources
+  #
+  # self.attributes_readable_by_default     = true
+  # self.attributes_writable_by_default     = true
+  # self.attributes_sortable_by_default     = true
+  # self.attributes_filterable_by_default   = true
+  # self.attributes_schema_by_default       = true
+  # self.relationships_readable_by_default  = true
+  # self.relationships_writable_by_default  = true
+  # self.belongs_to_resource_ids_by_default = :foreign_key
+  # self.filters_accept_nil_by_default      = false
+  # self.filters_deny_empty_by_default      = false
+  # self.default_page_size                  = 20
+  # self.max_page_size                      = 1_000
+  <%- end -%>
 end

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

@@ -1,25 +1,43 @@
 <% module_namespacing do -%>
 class <%= controller_class_name %> < ApplicationController
   <%- if actions?('index') -%>
+  <%- if responders? -%>
   def index
     <%= file_name.pluralize %> = <%= resource_klass %>.all(params)
-    <%- if responders? -%>
     respond_with(<%= file_name.pluralize %>)
-    <%- else -%>
-    render jsonapi: <%= file_name.pluralize %>
-    <%- end -%>
   end
+  <%- else -%>
+  <%- unless omit_comments? -%>
+  # With Graphiti::Rails::Responders included, these blocks collapse to
+  # respond_with(<%= file_name.pluralize %>). See https://graphiti.dev/getting-started/installation#responders
+  <%- end -%>
+  def index
+    <%= file_name.pluralize %> = <%= resource_klass %>.all(params)
+
+    respond_to do |format|
+      format.jsonapi { render jsonapi: <%= file_name.pluralize %> }
+      format.json { render json: <%= file_name.pluralize %> }
+    end
+  end
+  <%- end -%>
   <%- end -%>
   <%- if actions?('show') -%>
 
+  <%- if responders? -%>
   def show
     <%= file_name %> = <%= resource_klass %>.find(params)
-    <%- if responders? -%>
     respond_with(<%= file_name %>)
-    <%- else -%>
-    render jsonapi: <%= file_name %>
-    <%- end -%>
   end
+  <%- else -%>
+  def show
+    <%= file_name %> = <%= resource_klass %>.find(params)
+
+    respond_to do |format|
+      format.jsonapi { render jsonapi: <%= file_name %> }
+      format.json { render json: <%= file_name %> }
+    end
+  end
+  <%- end -%>
   <%- end -%>
   <%- if actions?('create') -%>