recycle_bin 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ecca5bc61bc12faa00187f0a37d0f73eebd8658b1192e8b45d61e9f839cdbc48
+  data.tar.gz: cf86c31ba03eeb84276afb3d213a436cb7a4d0d989037d6a2f22f6fab11bfb1c
+SHA512:
+  metadata.gz: dcea5e5846a8ae0377132fa8de1e6fb39b9e3566999ada4c396697a7ddc40eaea27a0569ede0c2d367e56849e334bf2ea1b4a1ef0c5ad68d83d49d9212c62883
+  data.tar.gz: 40bf89241c9f86b8d2923c95f6bf03140dbc78a0c7fceccec451a433c3552e9021b15e293ec77e76f3f379ccbe901b1f12d05f2c347e1cc5a2bf4f37e2fcefe2

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## [1.0.0] - 2025-05-25
+
+### Added
+- Initial release of RecycleBin gem
+- Soft delete functionality for ActiveRecord models
+- Web interface for managing trashed items
+- Restore functionality for deleted records
+- Bulk operations for multiple items
+- JSON API support for programmatic access
+
+### Contributors
+- Rishi Somani
+- Raghav Agrawal
+- Shobhit Jain

data/Gemfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in recycle_bin.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+
+# Development dependencies
+group :development, :test do
+  gem 'factory_bot_rails', '~> 6.2'
+  gem 'rspec-rails', '>= 6.0'
+  gem 'sqlite3', '~> 2.0'
+end
+
+group :development do
+  gem 'rubocop', '~> 1.50', require: false
+  gem 'rubocop-rails', '~> 2.19', require: false
+  gem 'rubocop-rspec', '~> 2.20', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Rishi Somani, Raghav Agrawal, Shobhit Jain
+
+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,425 @@
+# RecycleBin 🗑️
+
+A simple and elegant soft delete solution for Rails applications with a beautiful web interface to manage your deleted records.
+
+**RecycleBin** provides a "trash can" or "recycle bin" functionality where deleted records are marked as deleted instead of being permanently removed from your database. You can easily restore them or permanently delete them through a clean web interface.
+
+## Features ✨
+
+- **Soft Delete**: Records are marked as deleted instead of being permanently removed
+- **Web Interface**: Beautiful, responsive dashboard to view and manage deleted items
+- **Easy Integration**: Simple module inclusion in your models
+- **Bulk Operations**: Restore or permanently delete multiple items at once
+- **Model Filtering**: Filter deleted items by model type and time
+- **Rails Generators**: Automated setup with generators
+- **Configurable**: Flexible configuration options
+- **Statistics Dashboard**: Overview of your deleted items
+
+## Installation 📦
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'recycle_bin'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install recycle_bin
+```
+
+## Quick Setup 🚀
+
+### 1. Run the install generator
+
+```bash
+$ rails generate recycle_bin:install
+```
+
+This will:
+- Create a configuration file at `config/initializers/recycle_bin.rb`
+- Add the mount point to your routes
+- Display setup instructions
+
+### 2. Add deleted_at column to your models
+
+For each model you want to soft delete, run:
+
+```bash
+$ rails generate recycle_bin:add_deleted_at ModelName
+```
+
+For example:
+```bash
+$ rails generate recycle_bin:add_deleted_at User
+$ rails generate recycle_bin:add_deleted_at Post
+$ rails generate recycle_bin:add_deleted_at Comment
+```
+
+This generates a migration to add the `deleted_at` column and index.
+
+### 3. Run the migrations
+
+```bash
+$ rails db:migrate
+```
+
+### 4. Include the module in your models
+
+Add `RecycleBin::SoftDeletable` to any model you want to soft delete:
+
+```ruby
+class User < ApplicationRecord
+  include RecycleBin::SoftDeletable
+end
+
+class Post < ApplicationRecord
+  include RecycleBin::SoftDeletable
+end
+
+class Comment < ApplicationRecord
+  include RecycleBin::SoftDeletable
+end
+```
+
+### 5. Visit the web interface
+
+Navigate to `/recycle_bin` in your Rails application to see the web interface!
+
+## Usage 💡
+
+### Basic Operations
+
+Once you've included the `RecycleBin::SoftDeletable` module in your models:
+
+```ruby
+# Create a record
+user = User.create(name: "John Doe", email: "john@example.com")
+
+# Soft delete (goes to trash)
+user.destroy
+# or
+user.soft_delete
+
+# Check if deleted
+user.deleted? # => true
+
+# Restore from trash
+user.restore
+
+# Permanently delete (careful!)
+user.destroy!
+```
+
+### Querying Records
+
+The module provides several useful scopes:
+
+```ruby
+# Get all active (non-deleted) records (default scope)
+User.all
+
+# Get only deleted records
+User.deleted
+
+# Get all records including deleted ones
+User.with_deleted
+
+# Get only deleted records (alias)
+User.only_deleted
+
+# Get non-deleted records explicitly
+User.not_deleted
+
+# Restore a deleted record by ID
+User.restore(123)
+```
+
+### Web Interface Features
+
+The web interface (`/recycle_bin`) provides:
+
+- **Dashboard Overview**: Statistics about deleted items
+- **Item Listing**: View all deleted records with details
+- **Filtering**: Filter by model type (User, Post, Comment, etc.)
+- **Time Filters**: View items deleted today, this week, or this month
+- **Individual Actions**: Restore or permanently delete single items
+- **Bulk Actions**: Select multiple items to restore or delete
+- **Item Details**: Click on any item to see full details and history
+
+## Configuration ⚙️
+
+Configure RecycleBin in `config/initializers/recycle_bin.rb`:
+
+```ruby
+RecycleBin.configure do |config|
+  # Enable/disable web interface (default: true)
+  config.enable_web_interface = true
+
+  # Items per page in web interface (default: 25)
+  config.items_per_page = 50
+
+  # Auto-cleanup items after specified time (default: nil - disabled)
+  config.auto_cleanup_after = 30.days
+
+  # Method to get current user for audit trail (default: :current_user)
+  config.current_user_method = :current_user
+
+  # Authorization callback - restrict access to admins only
+  config.authorize_with do |controller|
+    # Example: Only allow admins
+    controller.current_user&.admin?
+  end
+end
+```
+
+### Authorization
+
+To restrict access to the web interface, use the `authorize_with` configuration:
+
+```ruby
+RecycleBin.configure do |config|
+  config.authorize_with do |controller|
+    # Only allow admins
+    controller.current_user&.admin?
+  end
+end
+```
+
+If authorization fails, users will be redirected with an "Access denied" message.
+
+## Advanced Usage 🔧
+
+### Custom Title Display
+
+By default, RecycleBin tries to use `title`, `name`, or `email` fields for display. You can customize this:
+
+```ruby
+class User < ApplicationRecord
+  include RecycleBin::SoftDeletable
+
+  def recyclable_title
+    "#{first_name} #{last_name} (#{email})"
+  end
+end
+```
+
+### Associations and Dependencies
+
+RecycleBin works with Rails associations. The web interface will show related items:
+
+```ruby
+class User < ApplicationRecord
+  include RecycleBin::SoftDeletable
+  has_many :posts, dependent: :destroy
+end
+
+class Post < ApplicationRecord
+  include RecycleBin::SoftDeletable
+  belongs_to :user
+  has_many :comments, dependent: :destroy
+end
+```
+
+### Statistics and Reporting
+
+Get statistics about your deleted items:
+
+```ruby
+# Get overall statistics
+RecycleBin.stats
+# => { deleted_items: 45, models_with_soft_delete: ["User", "Post", "Comment"] }
+
+# Count deleted items across all models
+RecycleBin.count_deleted_items # => 45
+
+# Get models that have soft delete enabled
+RecycleBin.models_with_soft_delete # => ["User", "Post", "Comment"]
+```
+
+## API Reference 📚
+
+### Instance Methods
+
+- `soft_delete` - Mark record as deleted
+- `restore` - Restore deleted record
+- `deleted?` - Check if record is deleted
+- `destroy` - Soft delete (overrides Rails default)
+- `destroy!` - Permanently delete from database
+- `recyclable_title` - Display title for web interface
+
+### Class Methods
+
+- `.deleted` - Scope for deleted records only
+- `.not_deleted` - Scope for active records only
+- `.with_deleted` - Scope for all records including deleted
+- `.only_deleted` - Alias for `.deleted`
+- `.restore(id)` - Restore a record by ID
+- `.deleted_records` - Get all deleted records
+
+### Configuration Options
+
+- `enable_web_interface` - Enable/disable web UI (default: true)
+- `items_per_page` - Pagination limit (default: 25)
+- `auto_cleanup_after` - Auto-delete after time period (default: nil)
+- `current_user_method` - Method to get current user (default: :current_user)
+- `authorize_with` - Authorization callback block
+
+## Generators 🛠️
+
+### Install Generator
+
+```bash
+$ rails generate recycle_bin:install
+```
+
+Sets up RecycleBin in your Rails application.
+
+### Add DeletedAt Generator
+
+```bash
+$ rails generate recycle_bin:add_deleted_at ModelName
+```
+
+Adds the `deleted_at` column to the specified model.
+
+## Web Interface Routes 🛣️
+
+The gem adds these routes to your application:
+
+```
+GET    /recycle_bin              # Dashboard/index
+GET    /recycle_bin/trash        # List all deleted items
+GET    /recycle_bin/trash/:model_type/:id # Show specific item
+PATCH  /recycle_bin/trash/:model_type/:id/restore # Restore item
+DELETE /recycle_bin/trash/:model_type/:id # Permanently delete
+PATCH  /recycle_bin/trash/bulk_restore    # Bulk restore
+DELETE /recycle_bin/trash/bulk_destroy    # Bulk delete
+```
+
+## Requirements 📋
+
+- **Ruby**: >= 2.7.0
+- **Rails**: >= 6.0
+- **Database**: Any database supported by Rails (PostgreSQL, MySQL, SQLite, etc.)
+
+## Examples 💼
+
+### E-commerce Store
+
+```ruby
+class Product < ApplicationRecord
+  include RecycleBin::SoftDeletable
+  
+  def recyclable_title
+    "#{name} - #{sku}"
+  end
+end
+
+# Soft delete a product
+product = Product.find(1)
+product.destroy # Goes to trash, can be restored
+
+# View deleted products in admin panel at /recycle_bin
+```
+
+### Blog System
+
+```ruby
+class Post < ApplicationRecord
+  include RecycleBin::SoftDeletable
+  belongs_to :author, class_name: 'User'
+  
+  def recyclable_title
+    title.truncate(50)
+  end
+end
+
+class Comment < ApplicationRecord
+  include RecycleBin::SoftDeletable
+  belongs_to :post
+  belongs_to :user
+  
+  def recyclable_title
+    "Comment by #{user.name}: #{body.truncate(30)}"
+  end
+end
+```
+
+### User Management
+
+```ruby
+class User < ApplicationRecord
+  include RecycleBin::SoftDeletable
+  
+  def recyclable_title
+    "#{name} (#{email})"
+  end
+end
+
+# Admin can restore accidentally deleted users
+User.deleted.each do |user|
+  puts "Deleted user: #{user.recyclable_title}"
+end
+```
+
+## Troubleshooting 🔍
+
+### Common Issues
+
+**1. "uninitialized constant RecycleBin" error**
+- Make sure you've added the gem to your Gemfile and run `bundle install`
+- Restart your Rails server
+
+**2. Routes not working**
+- Ensure you've run `rails generate recycle_bin:install`
+- Check that `mount RecycleBin::Engine => '/recycle_bin'` is in your `config/routes.rb`
+
+**3. Records not appearing in trash**
+- Verify you've included `RecycleBin::SoftDeletable` in your model
+- Ensure the `deleted_at` column exists (run the migration)
+- Check that you're calling `.destroy` not `.delete`
+
+**4. Web interface shows "Access denied"**
+- Check your authorization configuration in the initializer
+- Ensure the current user meets your authorization requirements
+
+### Debugging
+
+Enable debug logging to see what's happening:
+
+```ruby
+# In development.rb or console
+Rails.logger.level = :debug
+```
+
+## Contributing 🤝
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/R95-del/recycle_bin.
+
+## License 📄
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Changelog 📝
+
+### Version 0.1.0 (2025-05-24)
+- Initial release
+- Basic soft delete functionality
+- Web interface for managing deleted items
+- Rails generators for easy setup
+- Bulk operations support
+- Model filtering and statistics
+
+---
+
+**Made with ❤️ for the Rails community**
+
+*Need help? Open an issue on [GitHub](https://github.com/R95-del/recycle_bin) or check out the web interface at `/recycle_bin` in your Rails app.*

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/app/controllers/recycle_bin/application_controller.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module RecycleBin
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+
+    before_action :authorize_access
+
+    layout 'recycle_bin/application'
+
+    protected
+
+    # Helper method to handle RecycleBin-specific errors gracefully
+    def handle_recycle_bin_error(error)
+      log_error(error)
+      error_message = user_friendly_error_message(error)
+      respond_with_error(error_message)
+    end
+
+    # Helper method to check if the current request is for JSON
+    def json_request?
+      request.format.json?
+    end
+
+    # Helper method to safely constantize model names
+    def safe_constantize_model(model_name)
+      return nil unless model_name.present?
+
+      model_class = model_name.constantize
+      model_class < ActiveRecord::Base ? model_class : nil
+    rescue NameError
+      nil
+    end
+
+    # Helper method to format timestamps for consistent display
+    def format_timestamp(timestamp)
+      return 'N/A' unless timestamp
+
+      timestamp.strftime('%B %d, %Y at %I:%M %p')
+    end
+
+    # Helper to check current page for navigation
+    def current_page?(path)
+      request.path == path
+    end
+    helper_method :current_page?
+
+    private
+
+    def authorize_access
+      return true unless RecycleBin.config.authorization_method
+
+      return if instance_eval(&RecycleBin.config.authorization_method)
+
+      if defined?(main_app)
+        redirect_to main_app.root_path, alert: 'Access denied.'
+      else
+        render plain: 'Access denied.', status: :forbidden
+      end
+    end
+
+    def log_error(error)
+      return unless Rails.logger
+
+      Rails.logger.error "RecycleBin Error: #{error.message}"
+      Rails.logger.error error.backtrace.join("\n") if error.backtrace
+    end
+
+    def user_friendly_error_message(error)
+      case error
+      when ActiveRecord::RecordNotFound
+        'The requested item could not be found.'
+      when NameError
+        'Invalid model type specified.'
+      when NoMethodError
+        'This operation is not supported for this item type.'
+      else
+        'An unexpected error occurred. Please try again.'
+      end
+    end
+
+    def respond_with_error(message)
+      respond_to do |format|
+        format.html { redirect_with_flash_error(message) }
+        format.json { render_json_error(message) }
+      end
+    end
+
+    def redirect_with_flash_error(message)
+      flash[:alert] = message
+      redirect_to main_app.respond_to?(:recycle_bin_path) ? main_app.recycle_bin_path : root_path
+    end
+
+    def render_json_error(message)
+      render json: {
+        message: message,
+        status: 'error',
+        error_type: 'RecycleBinError'
+      }, status: :internal_server_error
+    end
+  end
+end