content_flagging 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1fe5a29d1160fecce845a934e83a92a4bc00f3da61f76f5db6b3f15aea73f006
+  data.tar.gz: 6c41f75667eddab18eb96206f8057c4287d0df2e315afb973e51ed2f5a2f0d2b
+SHA512:
+  metadata.gz: 0e85b31a49a5d4a52144763dd9e321bc71e7bb504d858ad084727d938d74e2a08e576fa388ae1c1391f41425272998cf3f3bfc14ca54edc2408f7d0cf5ba8f39
+  data.tar.gz: a3a969baa59ebabe9babe391cfb9635bd84357dea69bc4fcec8b13984ae30d0be0bcec7ac7b1d7a3b7c432283fa721f2724d5efeb21e7f75661dbf7a7ff0de4d

data/.gitignore

@@ -0,0 +1,52 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+.yardopts
+
+# bundler
+/vendor/bundle
+/.bundle/
+/Gemfile.lock
+
+# ruby/rails
+*.log
+*.sqlite3
+*.sqlite3-*
+.byebug_history
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# dummy app
+dummy_app/log/
+dummy_app/tmp/
+dummy_app/db/*.sqlite3
+dummy_app/.byebug_history

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Arshdeep Singh
+
+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,143 @@
+# 🚩 ContentFlagging
+
+> **The `acts_as_paranoid` for content moderation**
+
+A powerful Rails gem that automatically hides inappropriate content when it gets flagged too many times. Just like `acts_as_paranoid` hides deleted records, `acts_as_flaggable` hides flagged content from your default scopes.
+
+## ⚡ Quick Start
+
+```ruby
+# Gemfile
+gem 'content_flagging'
+
+# Terminal
+rails generate content_flagging:install
+rails db:migrate
+
+# Model
+class Post < ApplicationRecord
+  acts_as_flaggable  # 🎯 That's it!
+end
+```
+
+## 🎯 The Magic
+
+```ruby
+post = Post.create(title: "Controversial Content")
+
+# Users start flagging...
+post.flag!(flagged_by: user1)
+post.flag!(flagged_by: user2)
+post.flag!  # Anonymous flag
+
+# 💥 BOOM! Post disappears from default scope
+Post.all.include?(post)  # => false (auto-hidden!)
+post.flagged?            # => true
+post.flagged_at          # => 2024-01-01 12:00:00 UTC
+
+# But admins can still see everything
+Post.with_flagged.count  # => All posts (including flagged)
+Post.with_flagged.flagged # => Only flagged posts
+```
+
+## 🛠️ Setup
+
+### 1. Add the Magic Method
+```ruby
+class Post < ApplicationRecord
+  acts_as_flaggable                    # Default threshold: 3
+end
+
+class Comment < ApplicationRecord
+  acts_as_flaggable threshold: 5       # Custom threshold
+end
+
+class Review < ApplicationRecord
+  acts_as_flaggable threshold: 1       # Zero tolerance
+end
+```
+
+### 2. Add Database Columns
+```ruby
+# Migration
+add_column :posts, :flagged_count, :integer, default: 0
+add_column :posts, :flagged_at, :datetime
+```
+
+## 🚀 Real-World Examples
+
+### Community Moderation
+```ruby
+# Users can flag inappropriate content
+def flag_post
+  @post.flag!(flagged_by: current_user)
+  redirect_to posts_path, notice: "Thanks for keeping our community safe! 🛡️"
+end
+
+# Content automatically disappears when threshold is hit
+Post.all  # Only shows clean content ✨
+```
+
+### Admin Dashboard
+```ruby
+# See what's been flagged
+@flagged_posts = Post.with_flagged.flagged.order(:flagged_at)
+@recent_flags = Post.with_flagged.where('flagged_at > ?', 1.day.ago)
+
+# Bulk operations
+Post.with_flagged.flagged.pluck(:flagged_at)  # When were they flagged?
+Post.with_flagged.where('flagged_count > 10') # Heavily flagged content
+```
+
+### Smart Queries
+```ruby
+# Different ways to slice and dice
+Post.count                    # Clean content only
+Post.with_flagged.count      # Everything
+Post.not_flagged.count       # Explicitly clean
+Post.with_flagged.flagged    # The naughty list 😈
+```
+
+## ⚙️ Configuration
+
+```ruby
+# config/initializers/content_flagging.rb
+ContentFlagging.configure do |config|
+  config.flag_threshold = 5  # Global default (can be overridden per model)
+end
+```
+
+## 🎪 API Reference
+
+| Method | Description | Example |
+|--------|-------------|----------|
+| `flag!(flagged_by: user)` | Flag content | `post.flag!(flagged_by: current_user)` |
+| `unflag!(flagged_by: user)` | Remove flag | `post.unflag!(flagged_by: current_user)` |
+| `flagged?` | Check if flagged | `post.flagged? # => true/false` |
+| `flag_count` | Number of flags | `post.flag_count # => 3` |
+| `flagged_at` | When first flagged | `post.flagged_at # => Time` |
+
+| Scope | Description | Example |
+|-------|-------------|----------|
+| `Model.all` | Clean content (default) | `Post.all` |
+| `Model.with_flagged` | Everything | `Post.with_flagged` |
+| `Model.flagged` | Only flagged | `Post.with_flagged.flagged` |
+| `Model.not_flagged` | Explicitly clean | `Post.not_flagged` |
+
+## 🔥 Why This Rocks
+
+- **🎯 Zero Config**: Works out of the box with sensible defaults
+- **🔒 Thread-Safe**: Database-level counters prevent race conditions
+- **🚀 Performance**: Efficient queries with proper indexing
+- **🎨 Flexible**: Flag anything - posts, comments, users, you name it
+- **👥 Community-Driven**: Let your users moderate themselves
+- **🛡️ Admin-Friendly**: Easy oversight and management tools
+- **🗄️ Database Agnostic**: Works with PostgreSQL, MySQL, SQLite
+
+## 🤝 Contributing
+
+Found a bug? Want a feature? PRs welcome!
+
+## 📄 License
+
+MIT License - go wild! 🎉

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/content_flagging.gemspec

@@ -0,0 +1,48 @@
+require_relative 'lib/content_flagging/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'content_flagging'
+  spec.version       = ContentFlagging::VERSION
+  spec.authors       = ['Arshdeep Singh']
+  spec.email         = ['arsh199820@gmail.com']
+  spec.summary       = 'The acts_as_paranoid for content moderation - automatic flagging system for Rails'
+  spec.description   = 'A powerful Rails gem that automatically hides inappropriate content when flagged. Like acts_as_paranoid for deleted records, acts_as_flaggable hides flagged content from default scopes with configurable thresholds.'
+  spec.homepage      = 'https://github.com/arshdeepsingh/content_flagging'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+  
+  spec.metadata = {
+    'homepage_uri' => 'https://github.com/arshdeepsingh/content_flagging',
+    'source_code_uri' => 'https://github.com/arshdeepsingh/content_flagging',
+    'changelog_uri' => 'https://github.com/arshdeepsingh/content_flagging/blob/main/CHANGELOG.md',
+    'bug_tracker_uri' => 'https://github.com/arshdeepsingh/content_flagging/issues',
+    'documentation_uri' => 'https://github.com/arshdeepsingh/content_flagging/blob/main/README.md',
+    'rubygems_mfa_required' => 'true'
+  }
+  
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  
+  # Runtime dependencies
+  spec.add_dependency 'activerecord', '>= 6.0'
+  spec.add_dependency 'activesupport', '>= 6.0'
+  spec.add_dependency 'railties', '>= 6.0'
+  
+  # Development dependencies
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-rails', '~> 5.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.4'
+  spec.add_development_dependency 'pg', '~> 1.0'
+  spec.add_development_dependency 'mysql2', '~> 0.5'
+  spec.add_development_dependency 'rails', '>= 6.0'
+  spec.add_development_dependency 'factory_bot_rails', '~> 6.0'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
+  spec.add_development_dependency 'rubocop-rails', '~> 2.0'
+  spec.add_development_dependency 'simplecov', '~> 0.21'
+end

data/dummy_app/.dockerignore

@@ -0,0 +1,37 @@
+# See https://docs.docker.com/engine/reference/builder/#dockerignore-file for more about ignoring files.
+
+# Ignore git directory.
+/.git/
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all environment files (except templates).
+/.env*
+!/.env*.erb
+
+# Ignore all default key files.
+/config/master.key
+/config/credentials/*.key
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/.keep
+
+# Ignore storage (uploaded files in development and any SQLite databases).
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/.keep
+
+# Ignore assets.
+/node_modules/
+/app/assets/builds/*
+!/app/assets/builds/.keep
+/public/assets

data/dummy_app/.ruby-version

@@ -0,0 +1 @@
+3.0.6

data/dummy_app/Dockerfile

@@ -0,0 +1,62 @@
+# syntax = docker/dockerfile:1
+
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version and Gemfile
+ARG RUBY_VERSION=3.0.6
+FROM registry.docker.com/library/ruby:$RUBY_VERSION-slim as base
+
+# Rails app lives here
+WORKDIR /rails
+
+# Set production environment
+ENV RAILS_ENV="production" \
+    BUNDLE_DEPLOYMENT="1" \
+    BUNDLE_PATH="/usr/local/bundle" \
+    BUNDLE_WITHOUT="development"
+
+
+# Throw-away build stage to reduce size of final image
+FROM base as build
+
+# Install packages needed to build gems
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y build-essential git libvips pkg-config
+
+# Install application gems
+COPY Gemfile Gemfile.lock ./
+RUN bundle install && \
+    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git && \
+    bundle exec bootsnap precompile --gemfile
+
+# Copy application code
+COPY . .
+
+# Precompile bootsnap code for faster boot times
+RUN bundle exec bootsnap precompile app/ lib/
+
+# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
+RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
+
+
+# Final stage for app image
+FROM base
+
+# Install packages needed for deployment
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y curl libsqlite3-0 libvips && \
+    rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+# Copy built artifacts: gems, application
+COPY --from=build /usr/local/bundle /usr/local/bundle
+COPY --from=build /rails /rails
+
+# Run and own only the runtime files as a non-root user for security
+RUN useradd rails --create-home --shell /bin/bash && \
+    chown -R rails:rails db log storage tmp
+USER rails:rails
+
+# Entrypoint prepares the database.
+ENTRYPOINT ["/rails/bin/docker-entrypoint"]
+
+# Start the server by default, this can be overwritten at runtime
+EXPOSE 3000
+CMD ["./bin/rails", "server"]

data/dummy_app/Gemfile

@@ -0,0 +1,65 @@
+source "https://rubygems.org"
+
+ruby "3.0.6"
+
+# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
+gem "rails", "~> 7.1.4"
+
+# The original asset pipeline for Rails [https://github.com/rails/sprockets-rails]
+gem "sprockets-rails"
+
+# Use sqlite3 as the database for Active Record
+gem "sqlite3", ">= 1.4"
+
+# Content flagging gem
+gem "content_flagging", path: ".."
+
+# Use the Puma web server [https://github.com/puma/puma]
+gem "puma", ">= 5.0"
+
+# Use JavaScript with ESM import maps [https://github.com/rails/importmap-rails]
+gem "importmap-rails"
+
+# Hotwire's SPA-like page accelerator [https://turbo.hotwired.dev]
+gem "turbo-rails"
+
+# Hotwire's modest JavaScript framework [https://stimulus.hotwired.dev]
+gem "stimulus-rails"
+
+# Build JSON APIs with ease [https://github.com/rails/jbuilder]
+gem "jbuilder"
+
+# Use Redis adapter to run Action Cable in production
+# gem "redis", ">= 4.0.1"
+
+# Use Kredis to get higher-level data types in Redis [https://github.com/rails/kredis]
+# gem "kredis"
+
+# Use Active Model has_secure_password [https://guides.rubyonrails.org/active_model_basics.html#securepassword]
+# gem "bcrypt", "~> 3.1.7"
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: %i[ windows jruby ]
+
+# Reduces boot times through caching; required in config/boot.rb
+gem "bootsnap", require: false
+
+# Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images]
+# gem "image_processing", "~> 1.2"
+
+group :development, :test do
+  # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
+  gem "debug", platforms: %i[ mri windows ]
+end
+
+group :development do
+  # Use console on exceptions pages [https://github.com/rails/web-console]
+  gem "web-console"
+
+  # Add speed badges [https://github.com/MiniProfiler/rack-mini-profiler]
+  # gem "rack-mini-profiler"
+
+  # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
+  # gem "spring"
+end
+