moderate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7c7f6fd1cfa1c2ba6b28e2d0b75ce803d0ae2eec002011b18a9a25b2b98ce6f
+  data.tar.gz: 71bab2651af6c3ff8520360281811b53d21a711496a9ef392334e8b2a59646b5
+SHA512:
+  metadata.gz: adfb034df21d5ecfa8fec498f34df2d6595d33033f05e7fb2832ec52f7c0012fa43806950b9c9d723cc0508563159972e57ceb051e3263ca0cfff11583bb9959
+  data.tar.gz: 2dd06af75442e89d39e18f44c7dc61e37030dfbee6406f5be096903418489f9061dea5262aeaa874431ec4c3ac82f3c93933036d7715e3255e6431715c6923ff

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2024-11-03
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Javi R
+
+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,78 @@
+# 👮‍♂️ `moderate` - Moderate and block bad words from your Rails app
+
+`moderate` is a Ruby gem that moderates user-generated text content by adding a simple validation to block bad words in any text field.
+
+Simply add this to your model:
+
+```ruby
+validates :text_field, moderate: true
+```
+
+That's it! You're done. `moderate` will work seamlessly with your existing validations and error messages.
+
+> [!WARNING]
+> This gem is under development. It currently only supports a limited set of English profanity words. Word matching is very basic now, and it may be prone to false positives, and false negatives. I use it for very simple things like preventing new submissions if they contain bad words, but the gem can be improved for more complex use cases and sophisticated matching and content moderation. Please consider contributing if you can improve the gem, or have good ideas for additional features.
+
+# Why
+
+Any text field where users can input text may be a place where bad words can be used. This gem blocks records from being created if they contain bad words, profanity, naughty / obscene words, etc.
+
+It's good for Rails applications where you need to maintain a clean and respectful environment in comments, posts, or any other user input.
+
+# How
+
+`moderate` currently downloads a list of ~1k English profanity words from the [google-profanity-words](https://github.com/coffee-and-fun/google-profanity-words) repository and caches it in your Rails app's tmp directory.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'moderate'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Then, just add the `moderate` validation to any model with a text field:
+
+```ruby
+validates :text_field, moderate: true
+```
+
+`moderate` will raise an error if a bad word is found in the text field, preventing the record from being saved.
+
+It works seamlessly with your existing validations and error messages.
+
+## Configuration
+
+You can configure the `moderate` gem behavior by adding a `config/initializers/moderate.rb` file:
+```ruby
+Moderate.configure do |config|
+  # Custom error message when bad words are found
+  config.error_message = "contains inappropriate language"
+
+  # Add your own words to the blacklist
+  config.additional_words = ["badword1", "badword2"]
+
+  # Exclude words from the default list (false positives)
+  config.excluded_words = ["good"]
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rameerez/moderate. Our code of conduct is: just be nice and make your mom proud of what you do and post online.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/moderate/text.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Moderate
+  class Text
+    class << self
+      def bad_words?(text)
+        return false if text.blank?
+
+        @words_set ||= Set.new(compute_word_list)
+        text.downcase.split(/\W+/).any? { |word| @words_set.include?(word) }
+      end
+
+      private
+
+      def compute_word_list
+        @default_words ||= begin
+          words = WordList.load
+          logger.info("[moderate gem] Loaded #{words.size} words from word list")
+          words
+        end
+
+        result = (@default_words + Moderate.configuration.additional_words -
+                 Moderate.configuration.excluded_words).to_set
+        logger.debug("[moderate gem] Final word list size: #{result.size}")
+        result
+      end
+
+      def reset_word_list!
+        @words_set = nil
+        @default_words = nil
+      end
+
+      def logger
+        @logger ||= defined?(Rails) ? Rails.logger : Logger.new($stdout)
+      end
+    end
+  end
+end

data/lib/moderate/text_validator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ActiveModel
+  module Validations
+    class ModerateValidator < EachValidator
+      def validate_each(record, attribute, value)
+        return if value.blank?
+
+        begin
+          text = value.to_s
+          return if text.nil?
+
+          if Moderate::Text.bad_words?(text)
+            record.errors.add(attribute, options[:message] || Moderate.configuration.error_message)
+          end
+        rescue Moderate::Error => e
+          Rails.logger.error "Moderate validation error: #{e.message}"
+          record.errors.add(attribute, "Moderation check failed: #{e.message}")
+        rescue StandardError => e
+          Rails.logger.error "Unexpected error in moderate validation: #{e.message}"
+          record.errors.add(attribute, "Moderation check failed")
+        end
+      end
+    end
+
+  end
+end

data/lib/moderate/version.rb

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

data/lib/moderate/word_list.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+require 'tmpdir'
+require 'logger'
+
+module Moderate
+  class WordList
+    WORD_LIST_URL = 'https://raw.githubusercontent.com/coffee-and-fun/google-profanity-words/main/data/en.txt'
+    CACHE_TTL = 30 * 24 * 60 * 60 # 30 days in seconds
+
+    class << self
+      def load
+        cache_path = cache_file_path
+
+        begin
+          if File.exist?(cache_path)
+            if cache_valid?(cache_path)
+              words = File.read(cache_path, encoding: 'UTF-8').split("\n").to_set
+              return words unless words.empty?
+            else
+              logger.info("[moderate gem] Cache expired (older than #{CACHE_TTL / 86400} days). Refreshing word list...")
+              return download_and_cache(cache_path)
+            end
+          end
+
+          logger.info("[moderate gem] No cache found. Downloading word list for the first time...")
+          download_and_cache(cache_path)
+        rescue StandardError => e
+          logger.error("[moderate gem] Error loading word list: #{e.message}")
+          logger.debug("[moderate gem] #{e.backtrace.join("\n")}")
+          raise Moderate::Error, "Failed to load bad words list: #{e.message}"
+        end
+      end
+
+      def refresh_word_list!
+        logger.info("[moderate gem] Manually refreshing word list")
+        cache_path = cache_file_path
+        File.delete(cache_path) if File.exist?(cache_path)
+        download_and_cache(cache_path)
+      end
+
+      private
+
+      def cache_valid?(cache_path)
+        return false unless File.exist?(cache_path)
+
+        cache_age = Time.now - File.mtime(cache_path)
+        cache_age <= CACHE_TTL
+      end
+
+      def cache_file_path
+        if defined?(Rails)
+          Rails.root.join('tmp', 'moderate_bad_words.txt')
+        else
+          File.join(Dir.tmpdir, 'moderate_bad_words.txt')
+        end
+      end
+
+      def download_and_cache(cache_path)
+        uri = URI(WORD_LIST_URL)
+        response = Net::HTTP.get_response(uri)
+
+        unless response.is_a?(Net::HTTPSuccess)
+          raise Moderate::Error, "Failed to download word list. HTTP Status: #{response.code}"
+        end
+
+        content = response.body.force_encoding('UTF-8')
+        words = content.split("\n").map(&:strip).reject(&:empty?).to_set
+
+        if words.empty?
+          raise Moderate::Error, "Downloaded word list is empty"
+        end
+
+        logger.info("[moderate gem] Successfully downloaded and cached #{words.size} words to #{cache_path}")
+        logger.info("[moderate gem] Next cache refresh will occur after: #{Time.now + CACHE_TTL}")
+
+        File.write(cache_path, content, encoding: 'UTF-8')
+        logger.debug("[moderate gem] Cached word list to: #{cache_path}")
+
+        words
+      end
+
+      def logger
+        @logger ||= defined?(Rails) ? Rails.logger : Logger.new($stdout)
+      end
+    end
+  end
+end

data/lib/moderate.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "moderate/version"
+require_relative "moderate/text"
+require_relative "moderate/text_validator"
+require_relative "moderate/word_list"
+
+module Moderate
+  class Error < StandardError; end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configuration=(config)
+      @configuration = config
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+
+  class Configuration
+    attr_accessor :error_message, :additional_words, :excluded_words
+
+    def initialize
+      @error_message = "contains moderatable content (bad words)"
+      @additional_words = []
+      @excluded_words = []
+    end
+  end
+end

data/sig/moderate.rbs

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

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: moderate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rameerez
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: Moderate user-generated content by adding a simple validation to block
+  bad words in any text field. Good for applications where you need to maintain a
+  clean and respectful environment in comments, posts, or any other user input.
+email:
+- rubygems@rameerez.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/moderate.rb
+- lib/moderate/text.rb
+- lib/moderate/text_validator.rb
+- lib/moderate/version.rb
+- lib/moderate/word_list.rb
+- sig/moderate.rbs
+homepage: https://github.com/rameerez/moderate
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rameerez/moderate
+  source_code_uri: https://github.com/rameerez/moderate
+  changelog_uri: https://github.com/rameerez/moderate/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: Moderate and block bad words from your Rails app
+test_files: []