rails-explicit_override 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d08fc1fad8e50f31008de96e6cbfcd5ba4b50bf7313cdbe0ff1766444e20a34
+  data.tar.gz: fcf10efaa1b06ea96f51fdf16091e9053837d81e84bc9775436205e726c2adc0
+SHA512:
+  metadata.gz: 676707469dacce3844c57253e36418398d43cfd25aaad3b1361f3383c4ca1610e9e11d02a477fecbe9b11bce8f6240773c3bd020dd5ac2b0456ef1bc2964ef88
+  data.tar.gz: 48f9f1f74be43f4bdbee8c9974441c6439e764b7ce624329430be1764b08a49bf3074cb290f3e438b0880b2928e56501e3e40adfa8215068ef6f960b60fc6f99

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026-present Kevin Newton
+
+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,73 @@
+# rails-explicit_override
+
+[![Build Status](https://github.com/kddnewton/rails-explicit_override/workflows/Main/badge.svg)](https://github.com/kddnewton/rails-explicit_override/actions)
+[![Gem](https://img.shields.io/gem/v/rails-explicit_override.svg)](https://rubygems.org/gems/rails-explicit_override)
+
+Rails has many built-in methods that can be overridden by user code to change behavior. For example if you override `ActionController::action_methods`, you can change which methods are considered routing actions. However, overriding built-in methods can be accidental if you do not realize it exists in the first place. This gem solves that problem by requiring you to explicitly declare which methods you are overriding. If you forget to declare an override, or if you declare an override for a method that does not exist, an error will be raised.
+
+Take the example of the `ActionController::action_methods` method. If you want to override it, you would do the following:
+
+```ruby
+class HomeController < ApplicationController
+  explicit_overrides!(Rails.env.development?)
+
+  def index
+    # ...
+  end
+
+  private
+
+  explicit_override
+  def action_methods
+    # ...
+  end
+end
+```
+
+If you forgot to declare the explicit override, you would get the following error:
+
+```
+HomeController is marked as requiring explicit overrides, and already has a
+method named 'action_methods' defined. To override this method, you must call
+'explicit_override' on the line before the method definition.
+```
+
+## API
+
+There are two main methods you interact with in this gem. The first is:
+
+```ruby
+Rails::ExplicitOverride::ClassMethods#explicit_overrides!(development = false)
+```
+
+This method is used to enable tracking explicit overrides for a class. This module is automatically extended into `ActiveRecord::Base` and `ActionController::Base`, so you can call it in any subclass of those classes. Otherwise you must explicitly extend it into your class. The `development` parameter controls whether or not it will raise, and for best-practice it is expected to only be enabled in development environments to avoid raising errors in production. Once this method is called, any method that is defined that overrides a superclass method must be marked with:
+
+```ruby
+Rails::ExplicitOverride#explicit_override
+```
+
+which must be placed on the line immediately before the method definition. If a method is overridden without being marked, or if a method is marked but does not override a superclass method, an error will be raised.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails-explicit_override"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-explicit_override
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kddnewton/rails-explicit_override.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rails/explicit_override/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rails
+  class ExplicitOverride < Module
+    VERSION = "0.1.0"
+  end
+end

data/lib/rails/explicit_override.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "action_controller"
+require "rails/explicit_override/version"
+
+module Rails
+  class ExplicitOverride < Module
+    class Error < StandardError
+    end
+
+    class MissingExplicitOverrideError < Error
+      def initialize(cls, name)
+        super(<<~MSG)
+          #{cls.name || cls.inspect} is marked as requiring explicit overrides,
+          and already has a method named '#{name}' defined. To override this
+          method, you must call 'explicit_override' on the line before the
+          method definition.
+        MSG
+      end
+    end
+
+    class UnexpectedExplicitOverrideError < Error
+      def initialize(cls, name)
+        super(<<~MSG)
+          #{cls.name || cls.inspect} is marked as requiring explicit overrides,
+          but '#{name}' is not defined in the superclass, so this call to
+          'explicit_override' is unexpected.
+        MSG
+      end
+    end
+
+    def initialize(method_names)
+      explicit_override_lineno = nil
+
+      define_method(:explicit_override) do
+        explicit_override_lineno = caller_locations(1, 1).first.lineno
+      end
+
+      define_method(:method_added) do |name|
+        explicit_override = false
+        if explicit_override_lineno
+          explicit_override = (caller_locations(1, 1).first.lineno - explicit_override_lineno) <= 1
+          explicit_override_lineno = nil
+        end
+
+        if explicit_override != (method_defined = method_names.include?(name))
+          error = method_defined ? MissingExplicitOverrideError : UnexpectedExplicitOverrideError
+          raise error.new(self, name)
+        end
+
+        super(name)
+      end
+    end
+
+    module ClassMethods
+      # Provides the same interface as Rails::ExplicitOverride, but does
+      # nothing. This is meant to be used in non-development environments to
+      # avoid both the overhead of tracking method definitions and the risk of
+      # raising errors.
+      module Noop
+        def explicit_override; end
+      end
+
+      private_constant :Noop
+
+      # Track method definitions to see if they override methods defined in any
+      # superclass. If they do, require that they be marked with
+      # `explicit_override`. If they are not marked or are marked incorrectly,
+      # raise an error.
+      def explicit_overrides!(development = false)
+        extend(development ? ExplicitOverride.new(instance_methods) : Noop)
+      end
+
+      ActiveRecord::Base.extend(self)
+      ActionController::Base.extend(self)
+    end
+  end
+end

data/rails-explicit_override.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails/explicit_override/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rails-explicit_override"
+  spec.version = Rails::ExplicitOverride::VERSION
+  spec.authors = ["Kevin Newton"]
+  spec.email = ["kddnewton@gmail.com"]
+
+  spec.summary = "Explicitly mark Rails methods as overridden"
+  spec.homepage = "https://github.com/kddnewton/rails-explicit_override"
+  spec.license = "MIT"
+
+  spec.files = %w[
+    LICENSE
+    README.md
+    lib/rails/explicit_override.rb
+    lib/rails/explicit_override/version.rb
+    rails-explicit_override.gemspec
+  ]
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.metadata = { "rubygems_mfa_required" => "true" }
+
+  spec.add_dependency "activerecord"
+  spec.add_dependency "actionpack"
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: rails-explicit_override
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Newton
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- kddnewton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/rails/explicit_override.rb
+- lib/rails/explicit_override/version.rb
+- rails-explicit_override.gemspec
+homepage: https://github.com/kddnewton/rails-explicit_override
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Explicitly mark Rails methods as overridden
+test_files: []