content_flagging 1.0.0

data/dummy_app/public/robots.txt

@@ -0,0 +1 @@
+# See https://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file

data/dummy_app/test_console.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+# Rails Console Test Script for ContentFlagging
+
+puts "=== ContentFlagging Rails Console Test ==="
+puts "Run: rails console"
+puts "Then copy/paste these commands:"
+puts
+
+puts <<~RUBY
+# 1. Create test data
+post1 = Post.create(title: "Normal Post")
+post2 = Post.create(title: "Controversial Post")
+user = User.create(name: "Test User")
+
+# 2. Check initial state
+puts "Initial posts count: \#{Post.count}"
+puts "Post2 flagged?: \#{post2.flagged?}"
+puts "Post2 flag count: \#{post2.flag_count}"
+
+# 3. Flag the post (below threshold)
+post2.flag!(flagged_by: user)
+post2.flag!
+puts "After 2 flags - Post2 flagged?: \#{post2.flagged?}"
+puts "Posts in default scope: \#{Post.count}"
+
+# 4. Hit the threshold (3 flags)
+post2.flag!
+puts "After 3 flags - Post2 flagged?: \#{post2.flagged?}"
+puts "Post2 flagged at: \#{post2.flagged_at}"
+puts "Posts in default scope: \#{Post.count}"
+puts "Posts with flagged: \#{Post.with_flagged.count}"
+
+# 5. Test scopes
+puts "Flagged posts: \#{Post.with_flagged.flagged.count}"
+puts "Not flagged posts: \#{Post.not_flagged.count}"
+
+# 6. Unflag
+post2.unflag!(flagged_by: user)
+puts "After unflagging - Post2 flagged?: \#{post2.flagged?}"
+puts "Posts in default scope: \#{Post.count}"
+RUBY
+
+puts
+puts "=== Quick Test Commands ==="
+puts "Post.create(title: 'Test').tap { |p| 3.times { p.flag! } }.flagged?"
+puts "Post.count vs Post.with_flagged.count"

data/example_usage.rb

@@ -0,0 +1,46 @@
+# Example usage in a Rails application
+
+# 1. Model setup
+class Post < ApplicationRecord
+  acts_as_flaggable
+  # Requires: flagged_count integer column (default: 0)
+end
+
+class Comment < ApplicationRecord
+  acts_as_flaggable threshold: 5
+end
+
+class User < ApplicationRecord
+  # Can flag content
+end
+
+# 2. Configuration (config/initializers/content_flagging.rb)
+ContentFlagging.configure do |config|
+  config.flag_threshold = 3
+end
+
+# 3. Usage examples
+post = Post.create(title: "Controversial Post")
+user1 = User.create(name: "User 1")
+user2 = User.create(name: "User 2")
+
+# Flag the post
+post.flag!(flagged_by: user1)
+post.flag!(flagged_by: user2)
+post.flag_count # => 2
+post.flagged? # => false
+
+# Third flag triggers threshold
+post.flag!
+post.flagged? # => true
+
+# Post is now excluded from default scope
+Post.all # Won't include this post
+Post.with_flagged.all # Will include this post
+Post.with_flagged.flagged # Returns only flagged posts
+Post.not_flagged # Returns only non-flagged posts
+
+# Unflagging
+post.unflag!(flagged_by: user1)
+post.flag_count # => 2
+post.flagged? # => false (back in default scope)

data/lib/content_flagging/configuration.rb

@@ -0,0 +1,9 @@
+module ContentFlagging
+  class Configuration
+    attr_accessor :flag_threshold
+
+    def initialize
+      @flag_threshold = 3
+    end
+  end
+end

data/lib/content_flagging/flag.rb

@@ -0,0 +1,36 @@
+module ContentFlagging
+  class Flag < ActiveRecord::Base
+    self.table_name = 'content_flags'
+    
+    belongs_to :flaggable, polymorphic: true
+    belongs_to :flagged_by, polymorphic: true, optional: true
+    
+    validates :flaggable, presence: true
+    validates :flagged_at, presence: true
+    
+    before_validation :set_flagged_at, on: :create
+    after_create :increment_flagged_count
+    after_destroy :decrement_flagged_count
+    
+    private
+    
+    def set_flagged_at
+      self.flagged_at ||= Time.current
+    end
+    
+    def increment_flagged_count
+      flaggable.class.where(id: flaggable.id).update_all(
+        'flagged_count = COALESCE(flagged_count, 0) + 1, flagged_at = CASE WHEN COALESCE(flagged_count, 0) = 0 THEN ? ELSE flagged_at END',
+        flagged_at
+      )
+      flaggable.reload
+    end
+    
+    def decrement_flagged_count
+      count_sql = 'flagged_count = GREATEST(COALESCE(flagged_count, 0) - 1, 0)'
+      flagged_at_sql = 'flagged_at = CASE WHEN GREATEST(COALESCE(flagged_count, 0) - 1, 0) = 0 THEN NULL ELSE flagged_at END'
+      flaggable.class.where(id: flaggable.id).update_all("#{count_sql}, #{flagged_at_sql}")
+      flaggable.reload
+    end
+  end
+end

data/lib/content_flagging/flaggable.rb

@@ -0,0 +1,46 @@
+module ContentFlagging
+  module Flaggable
+    module ClassMethods
+      def acts_as_flaggable(options = {})
+        threshold = options[:threshold] || ContentFlagging.config.flag_threshold
+        
+        has_many :flags, as: :flaggable, class_name: 'ContentFlagging::Flag', dependent: :destroy
+        
+        scope :not_flagged, -> { where('COALESCE(flagged_count, 0) < ?', threshold) }
+        scope :flagged, -> { where('flagged_count >= ?', threshold) }
+        scope :with_flagged, -> { unscoped }
+        
+        default_scope { not_flagged }
+        
+        include ContentFlagging::Flaggable::InstanceMethods
+        
+        class_attribute :flag_threshold
+        self.flag_threshold = threshold
+      end
+    end
+    
+    module InstanceMethods
+      def flag!(flagged_by: nil)
+        flags.create!(flagged_by: flagged_by)
+      end
+      
+      def unflag!(flagged_by: nil)
+        flag_record = flagged_by ? flags.where(flagged_by: flagged_by).first : flags.first
+        flag_record&.destroy
+      end
+      
+      def flagged?
+        (flagged_count || 0) >= self.class.flag_threshold
+      end
+      
+      def flag_count
+        flagged_count || 0
+      end
+      
+      def flagged_at
+        return nil unless flagged?
+        read_attribute(:flagged_at) || flags.minimum(:flagged_at)
+      end
+    end
+  end
+end

data/lib/content_flagging/version.rb

@@ -0,0 +1,3 @@
+module ContentFlagging
+  VERSION = '1.0.0'
+end

data/lib/content_flagging.rb

@@ -0,0 +1,22 @@
+require 'active_record'
+require 'content_flagging/version'
+require 'content_flagging/flaggable'
+require 'content_flagging/flag'
+require 'content_flagging/configuration'
+
+module ContentFlagging
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.config
+    self.configuration ||= Configuration.new
+  end
+end
+
+ActiveRecord::Base.extend(ContentFlagging::Flaggable::ClassMethods)

data/lib/generators/content_flagging/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module ContentFlagging
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      
+      source_root File.expand_path('templates', __dir__)
+      
+      def self.next_migration_number(path)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+      
+      def create_migration
+        migration_template 'create_content_flags.rb.erb', 'db/migrate/create_content_flags.rb'
+      end
+      
+      def create_initializer
+        template 'content_flagging.rb', 'config/initializers/content_flagging.rb'
+      end
+    end
+  end
+end

data/lib/generators/content_flagging/templates/content_flagging.rb

@@ -0,0 +1,4 @@
+ContentFlagging.configure do |config|
+  # Set the threshold for flagged content to be excluded from default scope
+  config.flag_threshold = 3
+end

data/lib/generators/content_flagging/templates/create_content_flags.rb.erb

@@ -0,0 +1,13 @@
+class CreateContentFlags < ActiveRecord::Migration[7.0]
+  def change
+    create_table :content_flags do |t|
+      t.references :flaggable, polymorphic: true, null: false, index: true
+      t.references :flagged_by, polymorphic: true, null: true, index: true
+      t.datetime :flagged_at, null: false
+      t.timestamps
+    end
+    
+    add_index :content_flags, [:flaggable_type, :flaggable_id, :flagged_by_type, :flagged_by_id], 
+              unique: true, name: 'unique_flag_per_entity'
+  end
+end

data/test_manual.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+require_relative 'spec/spec_helper'
+
+# Manual testing script
+puts "Testing ContentFlagging gem..."
+
+# Create test data
+post = Post.create(title: "Test Post")
+user = User.create(name: "Test User")
+
+puts "\n1. Initial state:"
+puts "Post flagged?: #{post.flagged?}"
+puts "Flag count: #{post.flag_count}"
+puts "Posts in default scope: #{Post.count}"
+
+puts "\n2. Flag the post twice:"
+post.flag!(flagged_by: user)
+post.flag!
+puts "Post flagged?: #{post.flagged?}"
+puts "Flag count: #{post.flag_count}"
+puts "Posts in default scope: #{Post.count}"
+
+puts "\n3. Flag once more (hits threshold):"
+post.flag!
+puts "Post flagged?: #{post.flagged?}"
+puts "Flag count: #{post.flag_count}"
+puts "Posts in default scope: #{Post.count}"
+puts "Posts with flagged: #{Post.with_flagged.count}"
+
+puts "\n4. Unflag once:"
+post.unflag!(flagged_by: user)
+puts "Post flagged?: #{post.flagged?}"
+puts "Flag count: #{post.flag_count}"
+puts "Posts in default scope: #{Post.count}"
+
+puts "\nTest completed!"

metadata

@@ -0,0 +1,342 @@
+--- !ruby/object:Gem::Specification
+name: content_flagging
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Arshdeep Singh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: 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: factory_bot_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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+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.
+email:
+- arsh199820@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- Rakefile
+- content_flagging.gemspec
+- dummy_app/.dockerignore
+- dummy_app/.ruby-version
+- dummy_app/Dockerfile
+- dummy_app/Gemfile
+- dummy_app/Gemfile.lock
+- dummy_app/README.md
+- dummy_app/Rakefile
+- dummy_app/app/assets/config/manifest.js
+- dummy_app/app/assets/images/.keep
+- dummy_app/app/assets/stylesheets/application.css
+- dummy_app/app/channels/application_cable/channel.rb
+- dummy_app/app/channels/application_cable/connection.rb
+- dummy_app/app/controllers/application_controller.rb
+- dummy_app/app/controllers/concerns/.keep
+- dummy_app/app/helpers/application_helper.rb
+- dummy_app/app/jobs/application_job.rb
+- dummy_app/app/mailers/application_mailer.rb
+- dummy_app/app/models/application_record.rb
+- dummy_app/app/models/concerns/.keep
+- dummy_app/app/models/post.rb
+- dummy_app/app/models/user.rb
+- dummy_app/app/views/layouts/application.html.erb
+- dummy_app/app/views/layouts/mailer.html.erb
+- dummy_app/app/views/layouts/mailer.text.erb
+- dummy_app/bin/docker-entrypoint
+- dummy_app/bin/rails
+- dummy_app/bin/rake
+- dummy_app/bin/setup
+- dummy_app/config.ru
+- dummy_app/config/application.rb
+- dummy_app/config/boot.rb
+- dummy_app/config/cable.yml
+- dummy_app/config/credentials.yml.enc
+- dummy_app/config/database.yml
+- dummy_app/config/environment.rb
+- dummy_app/config/environments/development.rb
+- dummy_app/config/environments/production.rb
+- dummy_app/config/environments/test.rb
+- dummy_app/config/initializers/assets.rb
+- dummy_app/config/initializers/content_security_policy.rb
+- dummy_app/config/initializers/filter_parameter_logging.rb
+- dummy_app/config/initializers/inflections.rb
+- dummy_app/config/initializers/permissions_policy.rb
+- dummy_app/config/locales/en.yml
+- dummy_app/config/master.key
+- dummy_app/config/puma.rb
+- dummy_app/config/routes.rb
+- dummy_app/config/storage.yml
+- dummy_app/db/migrate/20250920174734_create_content_flags.rb
+- dummy_app/db/migrate/20250920174750_create_posts.rb
+- dummy_app/db/migrate/20250920174757_create_users.rb
+- dummy_app/db/schema.rb
+- dummy_app/db/seeds.rb
+- dummy_app/lib/assets/.keep
+- dummy_app/lib/tasks/.keep
+- dummy_app/public/404.html
+- dummy_app/public/422.html
+- dummy_app/public/500.html
+- dummy_app/public/apple-touch-icon-precomposed.png
+- dummy_app/public/apple-touch-icon.png
+- dummy_app/public/favicon.ico
+- dummy_app/public/robots.txt
+- dummy_app/storage/.keep
+- dummy_app/test_console.rb
+- dummy_app/vendor/.keep
+- example_usage.rb
+- lib/content_flagging.rb
+- lib/content_flagging/configuration.rb
+- lib/content_flagging/flag.rb
+- lib/content_flagging/flaggable.rb
+- lib/content_flagging/version.rb
+- lib/generators/content_flagging/install_generator.rb
+- lib/generators/content_flagging/templates/content_flagging.rb
+- lib/generators/content_flagging/templates/create_content_flags.rb.erb
+- test_manual.rb
+homepage: https://github.com/arshdeepsingh/content_flagging
+licenses:
+- MIT
+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'
+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.0.3.1
+signing_key: 
+specification_version: 4
+summary: The acts_as_paranoid for content moderation - automatic flagging system for
+  Rails
+test_files: []