droppable_table 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ba364fbb050de85a819bf4271302bcf442dc59e79ade28e8f2055e70f7b58dd4
+  data.tar.gz: f4d90336ff5debca79df4ddf6d555feee2445d4b2681a15284f96af637b09132
+SHA512:
+  metadata.gz: c5fd213a9080bbca424289a6ca6c126388eef4c2fd6909938d09da2a58272d5705fd1a58fb32f4ad62a74c097204dd7a21d515b3508bb342d71d2ba0aae45db6
+  data.tar.gz: 207ec1f2d311c6aa9a5cc294a94ee32a0726433bd326d62459e0a74c6b74d77e134ae8df14c2e41325a810ad15fcef511254ee19eaea9932c4dbea5242f9cb37

data/.rubocop.yml

@@ -0,0 +1,58 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+    - 'test/fixtures/**/*'
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 30
+  Exclude:
+    - 'test/**/*'
+
+Metrics/AbcSize:
+  Max: 40
+  Exclude:
+    - 'test/**/*'
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+  Exclude:
+    - 'test/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'test/**/*'
+    - 'spec/**/*'
+    - '*.gemspec'
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+# Allow both styles for arrays
+Style/WordArray:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+# Disable development dependencies warning (they're fine in gemspec)
+Gemspec/DevelopmentDependencies:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.3.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-07-12
+
+- Initial release

data/CLAUDE.md

@@ -0,0 +1,154 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Overview
+
+DroppableTable is a Ruby gem that analyzes Rails applications to identify potentially droppable database tables - tables that exist in the schema but have no corresponding ActiveRecord models. This helps with database cleanup and maintenance.
+
+## Commands
+
+### Development Setup
+```bash
+# Install dependencies
+bundle install
+
+# Run all tests
+bundle exec rake test
+
+# Run a specific test file
+bundle exec ruby -Ilib:test test/test_analyzer.rb
+
+# Run tests from dummy app directory (required for some tests)
+cd test/fixtures/dummy_app && RAILS_ENV=test bundle exec ruby -I../../../lib:../../.. ../../../test/test_analyzer.rb
+
+# Run linter
+bundle exec rubocop
+
+# Run linter with auto-correction
+bundle exec rubocop -A
+
+# Build the gem
+gem build droppable_table.gemspec
+
+# Install gem locally
+gem install ./droppable_table-0.1.0.gem
+```
+
+### Release Process
+```bash
+# Ensure all tests pass
+bundle exec rake test
+
+# Check RuboCop
+bundle exec rubocop
+
+# Build and test locally
+gem build droppable_table.gemspec
+gem install ./droppable_table-*.gem
+
+# Release to RubyGems (requires credentials)
+bundle exec rake release
+```
+
+### Testing the Gem
+```bash
+# From a Rails application directory
+bundle exec droppable_table analyze
+bundle exec droppable_table analyze --json
+bundle exec droppable_table analyze --strict
+bundle exec droppable_table version
+
+# Test with GitHub source
+# In target app's Gemfile: gem 'droppable_table', github: 'konpyu/droppable_table'
+```
+
+## Architecture
+
+### Core Components
+
+1. **Analyzer** (`lib/droppable_table/analyzer.rb`)
+   - Central orchestrator that coordinates the analysis process
+   - Workflow: check migrations → detect schema format → collect schema tables → load models → identify droppable tables
+   - Handles both text and JSON report generation
+   - Manages multi-database support (primary, secondary databases)
+
+2. **SchemaParser** (`lib/droppable_table/schema_parser.rb`)
+   - Parses Rails schema files (`schema.rb` or `structure.sql`)
+   - Currently implements Ruby schema parsing, SQL parsing is TODO
+   - Returns array of table information
+
+3. **ModelCollector** (`lib/droppable_table/model_collector.rb`)
+   - Loads Rails environment and collects all ActiveRecord models
+   - Detects STI (Single Table Inheritance) base tables
+   - Identifies HABTM (has_and_belongs_to_many) join tables
+   - Handles custom table names and multi-database models
+
+4. **Config** (`lib/droppable_table/config.rb`)
+   - Loads configuration from YAML files
+   - Manages exclusion lists (Rails internal tables, gem tables, user-defined)
+   - Handles strict mode settings for CI integration
+   - Default configs in `config/rails_internal_tables.yml` and `config/known_gems.yml`
+
+5. **CLI** (`lib/droppable_table/cli.rb`)
+   - Thor-based command line interface
+   - Commands: `analyze` (default), `version`
+   - Handles output formatting, strict mode, and error reporting
+
+### Key Design Decisions
+
+- **Multi-database Support**: Detects and analyzes multiple schema files (e.g., `schema.rb`, `secondary_schema.rb`)
+- **Exclusion System**: Three-tier exclusion (Rails internal, known gems, user-defined)
+- **STI Awareness**: STI base tables are not considered droppable even if no direct model exists
+- **HABTM Recognition**: Join tables are recognized and not marked as droppable
+- **Test Environment**: Migration checks are skipped in test environment to avoid false positives
+
+### Testing Infrastructure
+
+The gem includes a full Rails dummy application in `test/fixtures/dummy_app/` with:
+- Multiple databases (primary and secondary)
+- STI models (Vehicle → Car)
+- HABTM relationships (User ↔ Role)
+- Custom table names (CustomTableModel)
+- Orphaned tables for testing (abandoned_logs, legacy_data)
+
+### Configuration
+
+Users can create `droppable_table.yml` to:
+- Exclude specific tables
+- Exclude tables from specific gems
+- Enable strict mode for CI (fails if new droppable tables are found)
+
+Sample configuration:
+```yaml
+excluded_tables:
+  - legacy_payments
+  - archived_data
+
+excluded_gems:
+  - papertrail
+  - delayed_job
+
+strict_mode:
+  enabled: true
+  baseline_file: .droppable_table_baseline.json
+```
+
+### RuboCop Configuration
+
+The project enforces Ruby style guidelines with some customizations:
+- String style: double quotes
+- Line length: 120 characters
+- Method length: 30 lines (relaxed for complex analysis methods)
+- Test files excluded from some metrics
+
+## Important Implementation Notes
+
+### Migration Status Checking
+The migration check in `Analyzer#check_migration_status` is skipped in test environment and handles different Rails versions gracefully by trying multiple approaches.
+
+### Executable Setup
+The gem's executable is configured in `gemspec` with `spec.executables = ["droppable_table"]` and must be included when building the gem.
+
+### Test Execution Context
+Some tests (particularly `test_model_collector.rb` and `test_analyzer.rb`) must be run from within the dummy app directory to properly load the Rails environment.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 konpyu
+
+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,146 @@
+# DroppableTable
+
+[![Gem Version](https://badge.fury.io/rb/droppable_table.svg)](https://badge.fury.io/rb/droppable_table)
+[![Ruby](https://github.com/konpyu/droppable_table/actions/workflows/main.yml/badge.svg)](https://github.com/konpyu/droppable_table/actions/workflows/main.yml)
+
+A Ruby gem that helps identify potentially droppable tables in Rails applications by analyzing schema files and ActiveRecord models. It finds tables that exist in your database schema but have no corresponding models, helping with database cleanup and maintenance.
+
+## Features
+
+- 🔍 Detects tables without corresponding ActiveRecord models
+- 🚀 Supports multiple databases (primary, secondary, etc.)
+- 🎯 Recognizes STI (Single Table Inheritance) tables
+- 🔗 Identifies HABTM (has_and_belongs_to_many) join tables
+- ⚙️ Configurable exclusion lists for tables and gems
+- 📊 Multiple output formats (text and JSON)
+- 🔒 Strict mode for CI integration
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development, :test do
+  gem 'droppable_table'
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install droppable_table
+
+## Usage
+
+### Basic Usage
+
+From your Rails application root directory:
+
+```bash
+# Analyze and show results (default command)
+bundle exec droppable_table
+
+# Same as above - analyze is the default command
+bundle exec droppable_table analyze
+
+# Output in JSON format
+bundle exec droppable_table analyze --json
+
+# Use custom configuration file
+bundle exec droppable_table analyze --config custom_config.yml
+
+# Show version
+bundle exec droppable_table version
+```
+
+### Configuration
+
+Create a `droppable_table.yml` file in your Rails root:
+
+```yaml
+# Tables to exclude from the droppable list
+excluded_tables:
+  - legacy_payments    # Keep for audit trail
+  - archived_data      # Historical data
+  - temp_migration     # Temporary migration table
+
+# Exclude tables from specific gems
+excluded_gems:
+  - papertrail         # Exclude papertrail's versions table
+  - delayed_job        # Exclude delayed_jobs table
+
+# Strict mode for CI
+strict_mode:
+  enabled: true
+  baseline_file: .droppable_table_baseline.json
+```
+
+### Strict Mode (CI Integration)
+
+Strict mode helps prevent accidental table additions:
+
+```bash
+# First run creates a baseline
+bundle exec droppable_table analyze --strict
+
+# Subsequent runs will fail if new droppable tables are found
+bundle exec droppable_table analyze --strict
+```
+
+### Example Output
+
+```
+DroppableTable Analysis Report
+========================================
+
+Summary:
+  Total tables in schema: 25
+  Tables with models: 20
+  STI base tables: 2
+  HABTM join tables: 3
+  Excluded tables: 15
+  Potentially droppable: 2
+
+Potentially droppable tables:
+  - abandoned_logs
+  - legacy_sessions
+```
+
+## How It Works
+
+1. **Schema Analysis**: Parses your `db/schema.rb` (or `structure.sql`) to find all tables
+2. **Model Detection**: Loads all ActiveRecord models in your application
+3. **Relationship Analysis**: 
+   - Identifies STI base tables (won't be marked as droppable)
+   - Detects HABTM join tables (won't be marked as droppable)
+4. **Exclusion Processing**: Applies exclusion rules from configuration
+5. **Report Generation**: Shows tables that exist in schema but have no models
+
+## Built-in Exclusions
+
+The gem automatically excludes:
+- Rails internal tables (schema_migrations, ar_internal_metadata, etc.)
+- Active Storage tables
+- Action Text tables
+- Common gem tables (when gems are listed in excluded_gems)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/konpyu/droppable_table. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/konpyu/droppable_table/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DroppableTable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/konpyu/droppable_table/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "droppable_table"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/droppable_table

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "droppable_table"
+
+DroppableTable::CLI.start(ARGV)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/known_gems.yml

@@ -0,0 +1,34 @@
+# Tables created by popular gems
+papertrail:
+  - versions
+  - version_associations
+
+delayed_job:
+  - delayed_jobs
+
+devise:
+  - users  # Note: This might be customized
+
+friendly_id:
+  - friendly_id_slugs
+
+acts_as_taggable:
+  - tags
+  - taggings
+
+impressionist:
+  - impressions
+
+audited:
+  - audits
+
+ahoy:
+  - ahoy_visits
+  - ahoy_events
+
+blazer:
+  - blazer_queries
+  - blazer_audits
+  - blazer_dashboards
+  - blazer_dashboard_queries
+  - blazer_checks

data/config/rails_internal_tables.yml

@@ -0,0 +1,19 @@
+# Rails internal tables that should always be excluded
+- schema_migrations
+- ar_internal_metadata
+- active_storage_blobs
+- active_storage_attachments
+- active_storage_variant_records
+- action_text_rich_texts
+- action_mailbox_inbound_emails
+- action_mailbox_entries
+- solid_queue_blocked_executions
+- solid_queue_claimed_executions
+- solid_queue_failed_executions
+- solid_queue_jobs
+- solid_queue_pauses
+- solid_queue_processes
+- solid_queue_ready_executions
+- solid_queue_recurring_executions
+- solid_queue_scheduled_executions
+- solid_queue_semaphores

data/droppable_table.yml.sample

@@ -0,0 +1,19 @@
+# Example configuration file for droppable_table gem
+# Copy this file to droppable_table.yml and customize as needed
+
+# Tables to exclude from the droppable list (user defined)
+excluded_tables:
+  - countries
+  - languages
+  - static_data
+
+# Gems to exclude (in addition to the default list)
+excluded_gems:
+  - papertrail
+  - delayed_job
+  - custom_gem
+
+# Strict mode settings for CI integration
+strict_mode:
+  enabled: false
+  baseline_file: .droppable_table_baseline.json