recycle_bin 1.0.0

data/lib/generators/recycle_bin/install/install_generator.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module RecycleBin
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc 'Install RecycleBin in your Rails application'
+
+      def create_initializer
+        create_file 'config/initializers/recycle_bin.rb', <<~RUBY
+          # RecycleBin Configuration
+          RecycleBin.configure do |config|
+            # Enable web interface (default: true)
+            config.enable_web_interface = true
+
+            # Items per page in web interface (default: 25)
+            # config.items_per_page = 25
+
+            # Auto-cleanup items after specified time (default: nil - disabled)
+            # config.auto_cleanup_after = 30.days
+
+            # Method to get current user for audit trail#{'  '}
+            # config.current_user_method = :current_user
+
+            # Authorization callback - uncomment to restrict access
+            # config.authorize_with do |controller|
+            #   # Example: Only allow admins
+            #   controller.current_user&.admin?
+            # end
+          end
+        RUBY
+      end
+
+      def add_route
+        route "mount RecycleBin::Engine => '/recycle_bin'"
+      end
+
+      def print_installation_instructions
+        display_success_header
+        display_next_steps
+        display_configuration_info
+        display_success_footer
+      end
+
+      private
+
+      def display_success_header
+        say "\n#{'=' * 60}", :green
+        say '🗑️  RecycleBin installed successfully!', :green
+        say '=' * 60, :green
+        say ''
+      end
+
+      def display_next_steps
+        say 'Next steps:', :yellow
+        say '1. Add deleted_at column to your models:'
+        say '   rails generate migration AddDeletedAtToUsers deleted_at:datetime:index'
+        say ''
+        say '2. Include the module in your models:'
+        say '   class User < ApplicationRecord'
+        say '     include RecycleBin::SoftDeletable'
+        say '   end'
+        say ''
+        say '3. Run migrations:'
+        say '   rails db:migrate'
+        say ''
+        say '4. Visit /recycle_bin to see the web interface'
+        say ''
+      end
+
+      def display_configuration_info
+        say 'Configuration file created at:'
+        say '   config/initializers/recycle_bin.rb'
+      end
+
+      def display_success_footer
+        say '=' * 60, :green
+      end
+    end
+  end
+end

data/lib/generators/recycle_bin/install/templates/recycle_bin.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# RecycleBin Configuration
+RecycleBin.configure do |config|
+  # Enable web interface (default: true)
+  config.enable_web_interface = true
+
+  # Uncomment and customize as needed:
+
+  # Auto-cleanup items after specified time (default: nil - disabled)
+  # config.auto_cleanup_after = 30.days
+
+  # Method to get current user for audit trail
+  # config.current_user_method = :current_user
+
+  # Items per page in web interface
+  # config.items_per_page = 25
+
+  # Authorization callback
+  # config.authorize_with do |controller|
+  #   # Example: Only allow admins
+  #   controller.current_user&.admin?
+  # end
+end

data/lib/recycle_bin/engine.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rails/engine'
+
+module RecycleBin
+  class Engine < ::Rails::Engine
+    isolate_namespace RecycleBin
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    # This ensures generators are found
+    config.app_generators do |g|
+      g.rails = {
+        assets: false,
+        helper: false
+      }
+    end
+  end
+end

data/lib/recycle_bin/install/templates/recycle_bin.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# RecycleBin Configuration
+RecycleBin.configure do |config|
+  # Enable web interface (default: true)
+  config.enable_web_interface = true
+
+  # Uncomment and customize as needed:
+
+  # Auto-cleanup items after specified time (default: nil - disabled)
+  # config.auto_cleanup_after = 30.days
+
+  # Method to get current user for audit trail
+  # config.current_user_method = :current_user
+
+  # Items per page in web interface
+  # config.items_per_page = 25
+
+  # Authorization callback
+  # config.authorize_with do |controller|
+  #   # Example: Only allow admins
+  #   controller.current_user&.admin?
+  # end
+end

data/lib/recycle_bin/soft_deletable.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module RecycleBin
+  # SoftDeletable module provides soft delete functionality for ActiveRecord models.
+  # Instead of permanently deleting records, it marks them as deleted by setting
+  # a deleted_at timestamp, allowing for restoration and trash management.
+  module SoftDeletable
+    extend ActiveSupport::Concern
+
+    included do
+      # Only add ActiveRecord scopes if this is an ActiveRecord model
+      if self < ActiveRecord::Base
+        # Add a default scope to exclude deleted records
+        default_scope { where(deleted_at: nil) }
+
+        # Scopes for querying deleted/not deleted records
+        scope :deleted, -> { unscope(where: :deleted_at).where.not(deleted_at: nil) }
+        scope :not_deleted, -> { where(deleted_at: nil) }
+        scope :with_deleted, -> { unscope(where: :deleted_at) }
+        scope :only_deleted, -> { unscope(where: :deleted_at).where.not(deleted_at: nil) }
+      end
+    end
+
+    class_methods do
+      # Restore a record by ID (only for ActiveRecord models)
+      def restore(id)
+        raise NotImplementedError, 'restore method only available for ActiveRecord models' unless self < ActiveRecord::Base
+
+        with_deleted.find(id).restore
+      end
+
+      # Get all deleted records (only for ActiveRecord models)
+      def deleted_records
+        raise NotImplementedError, 'deleted_records method only available for ActiveRecord models' unless self < ActiveRecord::Base
+
+        deleted
+      end
+
+      # Find deleted records safely (bypasses default scope)
+      def find_deleted
+        unscoped.where.not(deleted_at: nil)
+      end
+    end
+
+    # Instance methods
+    def soft_delete
+      return false if deleted?
+
+      if respond_to?(:update_column)
+        # Use update_column to bypass validations and callbacks
+        update_column(:deleted_at, Time.current)
+      elsif respond_to?(:deleted_at=)
+        # For non-ActiveRecord objects, just set the attribute
+        self.deleted_at = Time.current
+        save if respond_to?(:save)
+      end
+    end
+
+    def restore
+      return false unless deleted?
+
+      if respond_to?(:update_column)
+        # Use update_column to bypass validations and callbacks
+        update_column(:deleted_at, nil)
+      elsif respond_to?(:deleted_at=)
+        # For non-ActiveRecord objects, just set the attribute
+        self.deleted_at = nil
+        save if respond_to?(:save)
+      end
+    end
+
+    def deleted?
+      respond_to?(:deleted_at) && deleted_at.present?
+    end
+
+    def destroy
+      # Override destroy to use soft delete instead
+      soft_delete
+    end
+
+    # For permanent deletion (use carefully!) - only for ActiveRecord
+    def destroy!
+      raise NotImplementedError, 'destroy! method only available for ActiveRecord models' unless respond_to?(:delete)
+
+      # Use delete to bypass callbacks and directly remove from database
+      self.class.unscoped.where(id: id).delete_all
+    end
+
+    # Helper for the trash controller
+    def recyclable_title
+      # Try common title fields safely
+      return try(:title) if respond_to?(:title) && try(:title).present?
+      return try(:name) if respond_to?(:name) && try(:name).present?
+      return try(:email) if respond_to?(:email) && try(:email).present?
+
+      "#{self.class.name} ##{id}"
+    end
+  end
+end

data/lib/recycle_bin/version.rb

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

data/lib/recycle_bin.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require_relative 'recycle_bin/version'
+require_relative 'recycle_bin/soft_deletable'
+
+# Only require Rails components if Rails is present
+require_relative 'recycle_bin/engine' if defined?(Rails)
+
+# RecycleBin provides soft delete functionality for Rails applications.
+# It adds a "recycle bin" feature where deleted records are marked as deleted
+# instead of being permanently removed from the database.
+module RecycleBin
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+    configuration
+  end
+
+  def self.config
+    configuration || (self.configuration = Configuration.new)
+  end
+
+  # Simple stats for V1
+  def self.stats
+    return {} unless defined?(Rails) && Rails.application
+
+    {
+      deleted_items: count_deleted_items,
+      models_with_soft_delete: models_with_soft_delete
+    }
+  end
+
+  def self.count_deleted_items
+    total = 0
+    models_with_soft_delete.each do |model_name|
+      total += count_deleted_items_for_model(model_name)
+    end
+    total
+  rescue StandardError => e
+    log_debug_message("Error counting deleted items: #{e.message}")
+    0
+  end
+
+  def self.count_deleted_items_for_model(model_name)
+    model = model_name.constantize
+    model.respond_to?(:deleted) ? model.deleted.count : 0
+  rescue StandardError => e
+    log_debug_message("Error counting deleted items for #{model_name}: #{e.message}")
+    0
+  end
+
+  def self.models_with_soft_delete
+    return [] unless rails_application_available?
+
+    # In test environment, we might not need to eager load
+    Rails.application.eager_load! if Rails.application.respond_to?(:eager_load!)
+
+    find_soft_deletable_models
+  end
+
+  def self.rails_application_available?
+    defined?(Rails) && Rails.application
+  end
+
+  def self.find_soft_deletable_models
+    return [] unless defined?(ActiveRecord)
+
+    ActiveRecord::Base.descendants.filter_map do |model|
+      model_name_if_soft_deletable(model)
+    end.compact
+  rescue StandardError => e
+    log_debug_message("Error finding soft deletable models: #{e.message}")
+    []
+  end
+
+  def self.model_name_if_soft_deletable(model)
+    return nil if model.abstract_class? || !model.table_exists?
+
+    model.name if model_has_soft_delete_capability?(model)
+  rescue StandardError => e
+    log_debug_message("Skipping model #{model.name}: #{e.message}")
+    nil
+  end
+
+  def self.model_has_soft_delete_capability?(model)
+    model.column_names.include?('deleted_at') && model.respond_to?(:deleted)
+  end
+
+  # Extract debug logging to reduce duplication
+  def self.log_debug_message(message)
+    Rails.logger.debug(message) if defined?(Rails) && Rails.logger
+  end
+
+  # Configuration class for RecycleBin
+  class Configuration
+    attr_accessor :enable_web_interface, :items_per_page, :ui_theme,
+                  :auto_cleanup_after, :current_user_method
+
+    def initialize
+      @enable_web_interface = true
+      @items_per_page = 25
+      @ui_theme = 'default'
+      @auto_cleanup_after = nil
+      @current_user_method = :current_user
+    end
+
+    def authorize_with(&block)
+      @authorization_method = block
+    end
+
+    def authorization_method
+      @authorization_method || proc { true }
+    end
+  end
+end

data/recycle_bin.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative 'lib/recycle_bin/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'recycle_bin'
+  spec.version = RecycleBin::VERSION
+  spec.authors = ['Rishi Somani', 'Shobhit Jain', 'Raghav Agrawal']
+  spec.email = ['somani.rishi81@gmail.com', 'shobhjain09@gmail.com', 'raghavagrawal019@gmail.com']
+
+  spec.summary = 'Soft delete and trash management for Ruby on Rails applications'
+  spec.description = 'RecycleBin provides soft delete functionality with a user-friendly trash/recycle bin interface for any Rails application. Easily restore deleted records with a simple web interface.'
+  spec.homepage = 'https://github.com/R95-del/recycle_bin'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      # Exclude the gemspec file itself and development files
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github]) ||
+        f.match?(/\A\./) ||          # Exclude dotfiles
+        f.end_with?('.gem') ||       # Exclude any .gem files
+        f.include?('Gemfile.lock')   # Exclude Gemfile.lock
+    end
+  end
+
+  spec.require_paths = ['lib']
+
+  # Runtime dependencies - Use pessimistic version constraints
+  spec.add_runtime_dependency 'rails', '>= 6.0', '< 9.0'
+
+  # Development dependencies with proper version constraints
+  spec.add_development_dependency 'factory_bot_rails', '~> 6.2'
+  spec.add_development_dependency 'rspec-rails', '~> 6.0'
+  spec.add_development_dependency 'sqlite3', '~> 2.1'
+
+  # Gem metadata with distinct URIs
+  spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/R95-del/recycle_bin'
+  spec.metadata['changelog_uri'] = 'https://github.com/R95-del/recycle_bin/blob/main/CHANGELOG.md'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/R95-del/recycle_bin/issues'
+  spec.metadata['documentation_uri'] = 'https://github.com/R95-del/recycle_bin/blob/main/README.md'
+  spec.metadata['wiki_uri'] = 'https://github.com/R95-del/recycle_bin/wiki'
+end

data/sig/recycle_bin.rbs

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

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: recycle_bin
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rishi Somani
+- Shobhit Jain
+- Raghav Agrawal
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: RecycleBin provides soft delete functionality with a user-friendly trash/recycle
+  bin interface for any Rails application. Easily restore deleted records with a simple
+  web interface.
+email:
+- somani.rishi81@gmail.com
+- shobhjain09@gmail.com
+- raghavagrawal019@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/recycle_bin/application_controller.rb
+- app/controllers/recycle_bin/trash_controller.rb
+- app/helpers/recycle_bin/application_helper.rb
+- app/views/layouts/recycle_bin/application.html.erb
+- app/views/layouts/recycle_bin/recycle_bin/application.html.erb
+- app/views/layouts/recycle_bin/recycle_bin/trash/index.html.erb
+- app/views/layouts/recycle_bin/recycle_bin/trash/show.html.erb
+- app/views/recycle_bin/trash/index.html.erb
+- app/views/recycle_bin/trash/show.html.erb
+- config/routes.rb
+- lib/generators/recycle_bin/add_deleted_at/add_deleted_at_generator.rb
+- lib/generators/recycle_bin/add_deleted_at/templates/add_deleted_at_migration.rb.erb
+- lib/generators/recycle_bin/install/install_generator.rb
+- lib/generators/recycle_bin/install/templates/recycle_bin.rb
+- lib/recycle_bin.rb
+- lib/recycle_bin/engine.rb
+- lib/recycle_bin/install/templates/recycle_bin.rb
+- lib/recycle_bin/soft_deletable.rb
+- lib/recycle_bin/version.rb
+- recycle_bin.gemspec
+- sig/recycle_bin.rbs
+homepage: https://github.com/R95-del/recycle_bin
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/R95-del/recycle_bin
+  source_code_uri: https://github.com/R95-del/recycle_bin
+  changelog_uri: https://github.com/R95-del/recycle_bin/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/R95-del/recycle_bin/issues
+  documentation_uri: https://github.com/R95-del/recycle_bin/blob/main/README.md
+  wiki_uri: https://github.com/R95-del/recycle_bin/wiki
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key:
+specification_version: 4
+summary: Soft delete and trash management for Ruby on Rails applications
+test_files: []