dependent_option_checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e03c96889e5fc45953006a43fd53e44293774a8843aaeedb44dcbe00ef06c434
+  data.tar.gz: 83d1adf802a900300caf508526299c5090a800dca52ad12acc3bda30ab539180
+SHA512:
+  metadata.gz: 854c450ac46eb74d7463202b0eedd7662261d919bf5403692962e22e10e3cfd9070fd1c52e50227bf5b5369fefb49b2efad99618f3c75722294cda9550ff428f
+  data.tar.gz: 6bce7b79d4f319c1c0bf77d40aba16d5066ea17b75c057d6a31784e179951c4837f5830864871ebadbe4a1caa5db5b4ba7265f1b45d9d2bc8958c9a11e39f92c

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 muryoimpl
+
+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,64 @@
+# DependentOptionChecker
+
+`dependent_option_checker` is a simple gem that provides a Rake task to detect missing `dependent` options in `has_many` / `has_one` associations in ActiveRecord models. It also helps identify missing `has_many` / `has_one` associations themselves.
+
+## Features
+
+- Detects associations lacking a dependent: ... option.
+- Identifies missing has_many / has_one associations.
+- Outputs the names of models and the specific missing configurations.
+- Allows excluding specific tables from the check via a YAML config file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'dependent_option_checker'
+```
+
+And then execute:
+```console
+bundle install
+
+bin/rails g dependent_option_checker:install
+```
+
+This will generate a configuration file at config/dependent_option_checker.yml, which you can edit to specify tables to ignore during checks.
+
+## Usage
+
+Run the following command:
+
+```console
+bin/rails dependent_option_checker:check
+```
+
+If any missing configuration is detected, the task will output the corresponding model names and the details of what is missing.
+
+
+## Configuration
+
+You can create a `dependent_option_checker.yml` file in your Rails `config` directory to exclude specific tables and relations from the check:
+
+```yaml
+ignored_tables:
+  - users
+
+ignored_relations:
+  Organization:
+    - employees # alert: this is table name
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/muryoimpl/dependent_option_checker.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/dependent_option_checker/checker/dependent_checker.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'active_record/reflection'
+
+module DependentOptionChecker
+  class Checker
+    class DependentChecker
+      DEPENDENT_OPTION_VALUES = %i[
+        destroy
+        destroy_async
+        delete_all
+        nullify
+        restrict_with_exception
+        restrict_with_error
+      ].freeze
+
+      def initialize(model)
+        @model = model
+      end
+
+      def extract_unspecified_relations
+        reflections.filter_map do |reflection|
+          option_specified?(reflection.options) ? nil : reflection.name.to_s
+        end
+      end
+
+      private
+
+      def reflections
+        @model.reflections.select do |_, reflection|
+          ::DependentOptionChecker::Checker::TARGET_CLASSES.include?(reflection.class)
+        end.values
+      end
+
+      def option_specified?(options)
+        options.key?(:dependent) &&
+          (
+            DEPENDENT_OPTION_VALUES.include?(options[:dependent]) ||
+            options[:dependent].nil?
+          )
+      end
+    end
+  end
+end

data/lib/dependent_option_checker/checker/relation_declaration_checker.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'active_record/reflection'
+require 'active_support/core_ext/string'
+
+module DependentOptionChecker
+  class Checker
+    class RelationDeclarationChecker
+      def initialize(model:, table_cache:, ignored_relations:)
+        @model = model
+        @table_cache = table_cache
+        @ignored_relations = ignored_relations || []
+      end
+
+      def extract_undeclared_tables
+        tables = table_names_having_attribute
+        tables - relation_table_names - @ignored_relations
+      end
+
+      private
+
+      def table_names_having_attribute
+        @table_cache.select do |_, attributes|
+          attributes.include?(attribute_name)
+        end.keys
+      end
+
+      def attribute_name
+        @attribute_name ||= "#{@model.table_name.singularize.underscore}_id"
+      end
+
+      def relation_table_names
+        @model.reflections.select do |_, relation|
+          ::DependentOptionChecker::Checker::TARGET_CLASSES.include?(relation.class)
+        end.values.map(&:plural_name)
+      end
+    end
+  end
+end

data/lib/dependent_option_checker/checker.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'active_support/core_ext/module/delegation'
+require 'active_record'
+
+require_relative 'configuration'
+require_relative 'model_loader'
+require_relative 'checker/dependent_checker'
+require_relative 'checker/relation_declaration_checker'
+
+module DependentOptionChecker
+  class Checker
+    TARGET_CLASSES = [
+      ActiveRecord::Reflection::HasOneReflection,
+      ActiveRecord::Reflection::HasManyReflection
+    ].freeze
+
+    def initialize
+      super
+      @config = Configuration.load
+    end
+
+    def execute
+      ModelLoader.load_files!
+
+      model_loader.load_table_attributes
+
+      model_loader.application_record_classes.each_with_object([]) do |model, acc|
+        unspecified = dependent_checker(model).extract_unspecified_relations
+        undeclared = relation_declaration_checker(model).extract_undeclared_tables
+
+        next if unspecified.empty? && undeclared.empty?
+
+        acc << result.new(table_name: model.table_name, unspecified:, undeclared:)
+      end
+    end
+
+    private
+
+    def model_loader
+      @model_loader ||= ModelLoader.new(@config)
+    end
+
+    def dependent_checker(model)
+      DependentChecker.new(model)
+    end
+
+    def relation_declaration_checker(model)
+      RelationDeclarationChecker.new(
+        model:,
+        table_cache: model_loader.cache_table_attributes,
+        ignored_relations: @config.ignored_relations[model.name]
+      )
+    end
+
+    def result
+      @result ||= Data.define(:table_name, :unspecified, :undeclared)
+    end
+  end
+end

data/lib/dependent_option_checker/configuration.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DependentOptionChecker
+  class Configuration
+    def self.load = new
+
+    def initialize
+      @config = if File.exist?(config_file_path)
+                  load_config
+                else
+                  {}
+                end
+    end
+
+    def ignored_tables = @config['ignored_tables'] || []
+    def ignored_relations = @config['ignored_relations'] || {}
+
+    private
+
+    def config_file_path = Rails.root.join('config/dependent_option_checker.yml')
+
+    def load_config = YAML.safe_load_file(config_file_path)
+  end
+end

data/lib/dependent_option_checker/model_loader.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DependentOptionChecker
+  class ModelLoader
+    def self.load_files!
+      Rails.autoloaders.main.eager_load_dir(Rails.root.join('app', 'models')) unless Rails.env.production?
+    end
+
+    attr_reader :cache_table_attributes
+
+    def initialize(config)
+      @config = config
+    end
+
+    def application_record_classes
+      @application_record_classes ||= ::ApplicationRecord.descendants.filter(&:base_class?)
+    end
+
+    def application_table_models
+      @application_table_models ||= application_record_classes.reject do |klass|
+        next if @config.nil?
+
+        @config.ignored_tables.include?(klass.table_name)
+      end
+    end
+
+    def load_table_attributes
+      @cache_table_attributes = application_table_models.each_with_object({}) do |klass, acc|
+        acc[klass.table_name] = klass.attribute_names
+      end
+    end
+  end
+end

data/lib/dependent_option_checker/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module DependentOptionChecker
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load 'dependent_option_checker/tasks/dependent_option_checker.rake'
+    end
+  end
+end

data/lib/dependent_option_checker/tasks/dependent_option_checker.rake

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+namespace :dependent_option_checker do
+  desc 'Detect omissions of the dependent option and related definitions in the AR models'
+  task check: :environment do
+    data = DependentOptionChecker::Checker.new.execute
+
+    if data.empty?
+      puts 'No omission detected.'
+    else
+      puts 'Detected `dependent` option or omissions of has_many/has_one denifition.'
+      puts
+
+      data.each do |d|
+        puts "# Model: \e[32m#{d.table_name.classify}\e[0m"
+
+        puts '  * dependent option omission' if d.unspecified.size.positive?
+        d.unspecified.each do |relation_name|
+          puts "    + \e[31m#{relation_name}\e[0m"
+        end
+
+        puts '  - has_many/has_one omission' if d.undeclared.size.positive?
+        d.undeclared.each do |table_name|
+          puts "    + \e[31m#{table_name}\e[0m"
+        end
+      end
+
+      exit(1)
+    end
+  end
+end

data/lib/dependent_option_checker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DependentOptionChecker
+  VERSION = '0.1.0'
+end

data/lib/dependent_option_checker.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'dependent_option_checker/version'
+require_relative 'dependent_option_checker/checker'
+
+module DependentOptionChecker
+  class Error < StandardError; end
+end
+
+require_relative 'dependent_option_checker/railtie'

data/lib/generators/dependent_option_checker/install_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module DependentOptionChecker
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def create_yml_file
+      copy_file 'dependent_option_checker.yml', 'config/dependent_option_checker.yml'
+    end
+  end
+end

data/lib/generators/dependent_option_checker/templates/dependent_option_checker.yml

@@ -0,0 +1,6 @@
+ignored_tables:
+  # - users
+
+ignored_relations:
+  # Organization:
+  #   - employees # this is table name, not relation name

data/sig/dependent_option_checker.rbs

@@ -0,0 +1,4 @@
+module DependentOptionChecker
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: dependent_option_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- muryoimpl
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+description: ActiveRecord has_many/has_one dependent option checker
+email:
+- muryoimpl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/dependent_option_checker.rb
+- lib/dependent_option_checker/checker.rb
+- lib/dependent_option_checker/checker/dependent_checker.rb
+- lib/dependent_option_checker/checker/relation_declaration_checker.rb
+- lib/dependent_option_checker/configuration.rb
+- lib/dependent_option_checker/model_loader.rb
+- lib/dependent_option_checker/railtie.rb
+- lib/dependent_option_checker/tasks/dependent_option_checker.rake
+- lib/dependent_option_checker/version.rb
+- lib/generators/dependent_option_checker/install_generator.rb
+- lib/generators/dependent_option_checker/templates/dependent_option_checker.yml
+- sig/dependent_option_checker.rbs
+homepage: https://github.com/muryoimpl/dependent_option_checker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/muryoimpl/dependent_option_checker
+  source_code_uri: https://github.com/muryoimpl/dependent_option_checker
+  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: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: ActiveRecord has_many/has_one dependent option checker
+test_files: []