rails_schema_cleaner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dcc1e8a0e8351e3fab096c5ed0e38758cd998cb7472f31e3b7c03b7adcb9d3af
+  data.tar.gz: cd21d7ec9586ce7345ce3fad4885755e544a43fdd0ebeea0b9bf36cb2e936724
+SHA512:
+  metadata.gz: 0f327bc26e101aa549cac433c8cca3971920bcaaf8bd9f4f7ae459b64791ae8122b09562a90a0ef0ea30f163fe03fa332c62803fc636ac3986fcd07b0f07a489
+  data.tar.gz: aeca7ea631cae4a193479803099ee38adab348c7f7235fda3946bf82722ec1f36d088953d0fb0e2d47043cf6a7f2370a45a9152a36395816008a7ca6d0635dea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-02-28
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Hassan Murtaza
+
+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,79 @@
+# RailsSchemaCleaner
+
+## Overview
+`rails_schema_cleaner` is a Ruby gem that helps keep your Rails database schema clean by identifying and removing orphaned tables (tables that do not have corresponding ActiveRecord models). It generates a migration file to drop these unused tables safely.
+
+## Installation
+Add this gem to your `Gemfile`:
+
+```ruby
+gem "rails_schema_cleaner"
+```
+
+Then run:
+
+```sh
+bundle install
+```
+
+Alternatively, install it manually:
+
+```sh
+gem install rails_schema_cleaner
+```
+
+## Usage
+### **1. Detect Orphaned Tables**
+To list all tables in the database that do not have an associated model, run:
+
+```sh
+bundle exec rails_schema_cleaner detect
+```
+
+This will return an array of orphaned table names.
+
+### **2. Generate Migration to Drop Orphaned Tables**
+To create a Rails migration file that drops these tables, run:
+
+```sh
+bundle exec rails_schema_cleaner clean
+```
+
+This will generate a timestamped migration file in `db/migrate/`, e.g.:
+
+```sh
+db/migrate/20240228123456_drop_orphaned_tables.rb
+```
+
+### **3. Run the Migration**
+Execute the migration to drop the orphaned tables:
+
+```sh
+rails db:migrate
+```
+
+## Compatibility
+- Works with Rails >=5.0
+- Supports SQLite, PostgreSQL, and MySQL
+
+## How It Works
+1. Fetches all database tables using `ActiveRecord::Base.connection.tables`
+2. Fetches all existing model table names using `ActiveRecord::Base.descendants.map(&:table_name)`
+3. Compares both lists and identifies tables that do not have an associated model
+4. Generates a Rails migration file to drop those tables
+
+## Running Tests
+Run RSpec tests with:
+
+```sh
+rspec
+```
+
+## License
+This project is licensed under the MIT License.
+
+## Contributions
+Pull requests are welcome! Please open an issue to discuss any significant changes before submitting a PR.
+
+## Author
+Created by [Hassan Murtaza](https://github.com/hmurtaza7).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/bin/rails_schema_cleaner

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+
+begin
+  require "rails"
+  require "active_record"
+  require "rails_schema_cleaner"
+
+  # Ensure we are inside a Rails application
+  unless Dir.exist?("config") && File.exist?("config/application.rb")
+    puts "Error: This command must be run inside a Rails application."
+    exit 1
+  end
+
+  # Command-line arguments
+  command = ARGV[0]
+
+  case command
+  when "detect"
+    puts "Orphaned tables: #{RailsSchemaCleaner.orphaned_tables.join(', ')}"
+  when "clean"
+    RailsSchemaCleaner.generate_migration
+    puts "Migration file created to drop orphaned tables."
+  else
+    puts "Usage:"
+    puts "  rails_schema_cleaner detect   # Lists orphaned tables"
+    puts "  rails_schema_cleaner clean    # Generates migration to drop orphaned tables"
+  end
+
+rescue LoadError 
+  puts "Error: Rails is not installed. Ensure you are running this inside a Rails application."
+  exit 1
+end

data/lib/rails_schema_cleaner/version.rb

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

data/lib/rails_schema_cleaner.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "rails_schema_cleaner/version"
+
+module RailsSchemaCleaner
+  class Error < StandardError; end
+
+  DEFAULT_TABLES = ["ar_internal_metadata", "schema_migrations"].to_set
+
+  def self.orphaned_tables
+    establish_db_connection! unless ActiveRecord::Base.connected?
+
+    db_tables = ActiveRecord::Base.connection.tables.to_set
+    model_tables = ActiveRecord::Base.descendants.map(&:table_name).compact.to_set
+    db_tables - model_tables - DEFAULT_TABLES
+  end
+
+  def self.generate_migration
+    tables_to_drop = orphaned_tables
+    return puts "No orphaned tables found." if tables_to_drop.empty?
+
+    timestamp = Time.now.utc.strftime("%Y%m%d%H%M%S")
+    migration_filename = "db/migrate/#{timestamp}_drop_orphaned_tables.rb"
+
+    # Define the migration class with the correct format
+    migration_class = "ActiveRecord::Migration[#{Rails::VERSION::MAJOR}.0]"
+
+    migration_content = <<-RUBY
+      class DropOrphanedTables < #{migration_class}
+        def change
+          #{tables_to_drop.map { |t| "drop_table :#{t}" }.join("\n    ")}
+        end
+      end
+    RUBY
+
+    File.write(migration_filename, migration_content)
+    puts "Migration created: #{migration_filename}"
+  end
+
+  def self.establish_db_connection!
+    require File.expand_path(Dir.pwd + "/config/environment", __FILE__)
+
+    db_config = Rails.configuration.database_configuration[Rails.env]
+    ActiveRecord::Base.establish_connection(db_config)
+
+    Rails.application.eager_load!
+
+    puts "Database connection established!"
+  end
+end

data/sig/rails_schema_cleaner.rbs

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

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: rails_schema_cleaner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hassan Murtaza
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Finds and drops tables that have no corresponding ActiveRecord model
+email:
+- "...@gmail.com"
+executables:
+- rails_schema_cleaner
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rails_schema_cleaner
+- lib/rails_schema_cleaner.rb
+- lib/rails_schema_cleaner/version.rb
+- sig/rails_schema_cleaner.rbs
+homepage: https://github.com/hmurtaza7/rails_schema_cleaner
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hmurtaza7/rails_schema_cleaner
+  source_code_uri: https://github.com/hmurtaza7/rails_schema_cleaner
+  changelog_uri: https://github.com/hmurtaza7/rails_schema_cleaner/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Cleans up orphaned tables in your Rails database
+test_files: []