rubocop-guardrails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8c264ff422c6fd3a97c216a8473d3a267c20e141f3ba5a7afba72ae37d06ed7
+  data.tar.gz: 99a6cfaa8055b4616badb1a37feb9e4882ca40491fbc175fe730ee58e453c6de
+SHA512:
+  metadata.gz: 9d7da48d6b71734a2db38215c9b9e443fd9232cc44b2b71d8f3af62013139a44a6fef26903795ecc1a12a77e639e7ba6d680dda8526cf6d6961f8522c8418dbe
+  data.tar.gz: 2e9828ef7340c968362b26088072752765dce52c391fa0162bccec8698a65a4cc6cb65419515064c1018ff446236f6a094598e2817e13691b2da244133223c86

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Carl Dawson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# rubocop-guardrails
+
+RuboCop cops that keep Rails app on the golden path.
+
+Rails is a convention-over-configuration framework, but it's easy to drift — especially when AI coding agents are involved. Agents pull from a broad training set and love to introduce service objects, decorators, form objects, and other patterns that aren't advocated for by the framework itself. These cops push back, keeping your app conventional: rich models, RESTful controllers, shallow jobs, and nothing in between.
+
+## Installation
+
+Add it to your application's Gemfile:
+
+```ruby
+gem "rubocop-guardrails", require: false
+```
+
+## Usage
+
+### RuboCop plugin system (>= 1.72)
+
+Add to your `.rubocop.yml`:
+
+```yaml
+plugins:
+  - rubocop-guardrails
+```
+
+### Legacy
+
+```yaml
+require:
+  - rubocop-guardrails
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+To generate a new cop:
+
+```bash
+bundle exec rake 'new_cop[Guardrails/CopName]'
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+desc 'Generate a new cop with a template'
+task :new_cop, [:cop] do |_task, args|
+  require 'rubocop'
+
+  cop_name = args.fetch(:cop) do
+    warn 'usage: bundle exec rake new_cop[Department/Name]'
+    exit!
+  end
+
+  generator = RuboCop::Cop::Generator.new(cop_name)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: 'lib/rubocop/cop/guardrails_cops.rb')
+  generator.inject_config(config_file_path: 'config/default.yml')
+
+  puts generator.todo
+end

data/config/default.yml

@@ -0,0 +1,18 @@
+Guardrails/NoServiceObjects:
+  Enabled: true
+  Description: 'Disallows service objects.'
+  Include:
+    - 'app/services/**/*.rb'
+
+Guardrails/RestfulActions:
+  Enabled: true
+  Description: 'Prevents non-RESTful controller actions.'
+  Include:
+    - 'app/controllers/**/*.rb'
+
+Guardrails/RestfulRoutes:
+  Enabled: true
+  Description: 'Detects non-RESTful route definitions.'
+  Include:
+    - 'config/routes.rb'
+    - 'config/routes/**/*.rb'

data/lib/rubocop/cop/guardrails/no_service_objects.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Guardrails
+      # Disallows service objects.
+      #
+      # Service objects are a common pattern but they aren't the Rails way.
+      # Business logic belongs in your models — ActiveRecord models and
+      # plain old Ruby objects that live in `app/models`.
+      #
+      # @example
+      #   # bad - app/services/post_publisher.rb
+      #   class PostPublisher
+      #     def call
+      #       post.update!(published: true)
+      #     end
+      #   end
+      #
+      #   # good - logic belongs in the model
+      #   class Post < ApplicationRecord
+      #     def publish
+      #       update!(published: true)
+      #     end
+      #   end
+      class NoServiceObjects < Base
+        MSG = 'Avoid service objects. This logic belongs in your models.'
+
+        def on_class(node)
+          add_offense(node.loc.name)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/guardrails/restful_actions.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Guardrails
+      # Prevents non-RESTful actions in controllers.
+      #
+      # Rails advocates for RESTful resources. When you need a custom
+      # action, extract a new controller with standard RESTful actions.
+      #
+      # @example
+      #   # bad
+      #   class PostsController < ApplicationController
+      #     def publish
+      #     end
+      #   end
+      #
+      #   # good - extract a new resource
+      #   class Posts::PublicationsController < ApplicationController
+      #     def create
+      #     end
+      #   end
+      class RestfulActions < Base
+        MSG = 'Non-RESTful action `%<method>s`. Add a new resource to represent this action.'
+
+        RESTFUL_ACTIONS = %i[index show new create edit update destroy].to_set.freeze
+
+        def on_def(node)
+          return if RESTFUL_ACTIONS.include?(node.method_name)
+          return unless in_class?(node)
+          return unless public_method?(node)
+
+          add_offense(node.loc.name, message: format(MSG, method: node.method_name))
+        end
+
+        private
+
+        def in_class?(node)
+          node.each_ancestor(:class).any?
+        end
+
+        def public_method?(node)
+          return false if inline_visibility_modifier?(node)
+
+          effective_visibility(node) == :public
+        end
+
+        def inline_visibility_modifier?(node)
+          node.parent&.send_type? &&
+            %i[private protected].include?(node.parent.method_name)
+        end
+
+        def effective_visibility(node)
+          body = node.parent
+          return :public unless body&.begin_type?
+
+          body.children
+              .take_while { |child| !child.equal?(node) }
+              .select { |child| visibility_modifier?(child) }
+              .last&.method_name || :public
+        end
+
+        def visibility_modifier?(node)
+          node.send_type? &&
+            node.arguments.empty? &&
+            %i[private protected public].include?(node.method_name)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/guardrails/restful_routes.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Guardrails
+      # Detects non-RESTful route definitions.
+      #
+      # Routes should use `resources` and `resource` exclusively. When you
+      # need a custom action, extract a new resource rather than adding
+      # bare HTTP verb routes or `member`/`collection` blocks.
+      #
+      # @example
+      #   # bad
+      #   get '/posts/:id/publish', to: 'posts#publish'
+      #
+      #   resources :posts do
+      #     member do
+      #       get :publish
+      #     end
+      #   end
+      #
+      #   # good - extract a new resource
+      #   resources :posts do
+      #     resource :publication, only: :create
+      #   end
+      class RestfulRoutes < Base
+        MSG_VERB = 'Use `resources` or `resource` instead of bare HTTP verb routes.'
+        MSG_MEMBER = 'Use a new `resources` instead of `member` routes.'
+        MSG_COLLECTION = 'Use a new `resources` instead of `collection` routes.'
+
+        HTTP_VERBS = %i[get post put patch delete match].to_set.freeze
+
+        RESTRICT_ON_SEND = [*HTTP_VERBS, :member, :collection].freeze
+
+        # @!method route_draw_block?(node)
+        def_node_matcher :route_draw_block?, <<~PATTERN
+          (block (send (send (send (const nil? :Rails) :application) :routes) :draw) ...)
+        PATTERN
+
+        def on_send(node)
+          return unless inside_routes_draw?(node)
+
+          if HTTP_VERBS.include?(node.method_name)
+            return if inside_member_or_collection?(node)
+
+            add_offense(node.loc.selector, message: MSG_VERB)
+          elsif node.method_name == :member
+            add_offense(node.loc.selector, message: MSG_MEMBER)
+          elsif node.method_name == :collection
+            add_offense(node.loc.selector, message: MSG_COLLECTION)
+          end
+        end
+
+        private
+
+        def inside_routes_draw?(node)
+          node.each_ancestor(:block).any? { |block| route_draw_block?(block) }
+        end
+
+        def inside_member_or_collection?(node)
+          node.each_ancestor(:block).any? do |block|
+            block.send_node.method_name == :member || block.send_node.method_name == :collection
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/guardrails_cops.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'guardrails/no_service_objects'
+require_relative 'guardrails/restful_actions'
+require_relative 'guardrails/restful_routes'

data/lib/rubocop/guardrails/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module Guardrails
+    # A plugin that integrates rubocop-guardrails with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-guardrails',
+          version: VERSION,
+          homepage: 'https://github.com/carldawson/rubocop-guardrails',
+          description: 'RuboCop cops that keep Rails apps on the golden path'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join('../../../config/default.yml')
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/guardrails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Guardrails
+    VERSION = '0.1.0'
+  end
+end

data/lib/rubocop/guardrails.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'guardrails/version'
+
+module RuboCop
+  # RuboCop cops that keep Rails apps on the golden path.
+  module Guardrails
+  end
+end

data/lib/rubocop-guardrails.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/guardrails'
+require_relative 'rubocop/guardrails/version'
+require_relative 'rubocop/guardrails/plugin'
+
+require_relative 'rubocop/cop/guardrails_cops'

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-guardrails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carl Dawson
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.2
+description: Opinionated cops for developers who prefer conventional Rails — rich
+  models, RESTful controllers, shallow jobs, no service objects.
+email:
+- carldawson@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/default.yml
+- lib/rubocop-guardrails.rb
+- lib/rubocop/cop/guardrails/no_service_objects.rb
+- lib/rubocop/cop/guardrails/restful_actions.rb
+- lib/rubocop/cop/guardrails/restful_routes.rb
+- lib/rubocop/cop/guardrails_cops.rb
+- lib/rubocop/guardrails.rb
+- lib/rubocop/guardrails/plugin.rb
+- lib/rubocop/guardrails/version.rb
+homepage: https://github.com/carldaws/rubocop-guardrails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/carldaws/rubocop-guardrails
+  source_code_uri: https://github.com/carldaws/rubocop-guardrails
+  changelog_uri: https://github.com/carldaws/rubocop-guardrails/blob/main/CHANGELOG.md
+  default_lint_roller_plugin: RuboCop::Guardrails::Plugin
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: RuboCop cops that keep Rails apps on the golden path
+test_files: []