add support for API controller

.github/workflows/ci.yml

@@ -26,4 +26,4 @@ jobs:
       - name: Install appraisal dependencies
         run: bundle exec appraisal install
       - name: Run tests
-        run: bundle exec appraisal rake test
+        run: bundle exec appraisal rake test

Appraisals

@@ -28,4 +28,4 @@ end
 
 appraise 'haml-6.3' do
   gem 'haml', '>= 6.3', '< 6.4'
-end
+end

CHANGELOG.md

@@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
+- Compatibility with `ActionController::API` - [@emfy0](https://github.com/emfy0)
+
 ### Removed
 
 > _Add your own contributions to the next release on a new line above this; please include your name too._

lib/rails-route-checker/loaded_app.rb

@@ -48,13 +48,24 @@ def all_route_names
     end
 
     def controller_information
-      @controller_information ||= ActionController::Base.descendants.map do |controller|
+      return @controller_information if @controller_information
+
+      base_controllers_descendants = [ActionController::Base, ActionController::API].flat_map(&:descendants)
+
+      @controller_information = base_controllers_descendants.map do |controller|
         next if controller.controller_path.nil? || controller.controller_path.start_with?('rails/')
 
+        controller_helper_methods =
+          if controller.respond_to?(:helpers)
+            controller.helpers.methods.map(&:to_s)
+          else
+            []
+          end
+
         [
           controller.controller_path,
           {
-            helpers: controller.helpers.methods.map(&:to_s),
+            helpers: controller_helper_methods,
             actions: controller.action_methods.to_a,
             instance_methods: instance_methods(controller),
             lookup_context: lookup_context(controller)

rails-route-checker.gemspec

@@ -28,4 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 0.86'
   spec.add_development_dependency 'appraisal', '~> 2.5.0'
   spec.add_development_dependency 'minitest'
-end
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'propshaft'
+end

test/dummy/app/controllers/articles_api_controller.rb

@@ -0,0 +1,4 @@
+class ArticlesApiController < BaseApiController
+  def index
+  end
+end

test/dummy/app/controllers/base_api_controller.rb

@@ -0,0 +1,2 @@
+class BaseApiController < ActionController::API
+end

test/dummy/app/views/articles_api/index.json.jbuilder

@@ -0,0 +1 @@
+json.response 'This is json response'

test/dummy/config/routes.rb

@@ -1,3 +1,4 @@
 Rails.application.routes.draw do
   resources :articles, only: [:index_erb, :index_haml]
+  resources :articles_api, only: :index
 end

test/rails-route-checker/loaded_app_test.rb

@@ -0,0 +1,17 @@
+require 'minitest/autorun'
+
+require 'rails-route-checker/loaded_app'
+
+describe RailsRouteChecker::LoadedApp do
+  let(:loaded_app) do
+    Dir.stub(:pwd, File.join(__dir__, '../dummy')) do
+      RailsRouteChecker::LoadedApp.new
+    end
+  end
+
+  it 'parses ActionController::Base and ActionController::API descendants' do
+    assert_equal(
+      loaded_app.controller_information.keys.sort, %w[application articles base_api articles_api].sort
+    )
+  end
+end