naughty_words 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d85fccb7a94fab7fb39c18575bd3489c31ff0da5d0bfba585df0dda4fd49f560
-  data.tar.gz: f2bbf7546a3e1c7ae53657060b39ef80cc4ec1a7eccae82cd74450f2dc6c7bd4
+  metadata.gz: d57b97899577e770df8be076a260356960598772f8b35d14b70f0c1fcd346ddf
+  data.tar.gz: '093ef5e005fb5c73516ce20d78ec205b37b814232ac62ebb6cf3b2aac40380b0'
 SHA512:
-  metadata.gz: a5cefb81ba419a3868697f08660b4931bda9ad09d68d609aa85adb40aeb4c286e96747cb30f5f7f289529da2009611e74db53bbf351609398b456630a44594bc
-  data.tar.gz: 15b967ffd773daa055b5af6bb0395681b4a9669b9df9f642bb2f36871c6a218dd15b48ef15568c415ee4d03e52d2febaec1d8b2f8ed107bc053e00db5509991f
+  metadata.gz: 684f809efaac39ce2261e50f5d63886ab50e310a6192295c22745d3f3082551d2acb5d9e8bd9822947c78a02bfee54a730387dc5fc2a572c9a5a372036b746cc
+  data.tar.gz: c032f4abd47b5b1990540dbaa914234912ea80d2ae2980f5d6238f661f463072ce654e3600526bc489c4f180b7426368f0f8208881b0850db7ee21b06cc2e038

data/.rubocop.yml

@@ -15,3 +15,17 @@ Layout/LineLength:
 Style/Documentation:
   Description: 'Document classes and non-namespace modules.'
   Enabled: false
+
+Metrics/BlockLength:
+  CountComments: true
+  Max: 25
+  Exclude:
+    - 'spec/**/*'
+    - 'config/**/*'
+    - 'lib/tasks/**/*'
+
+Style/FrozenStringLiteralComment:
+  Description: >-
+    Add the frozen_string_literal comment to the top of files
+    to help transition from Ruby 2.3.0 to Ruby 3.0.
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    naughty_words (0.1.0)
+    naughty_words (0.1.3)
 
 GEM
   remote: https://rubygems.org/
@@ -58,4 +58,4 @@ DEPENDENCIES
   rubocop (~> 1.21)
 
 BUNDLED WITH
-   2.2.30
+   2.3.24

data/README.md

@@ -45,11 +45,30 @@ The `filter` method takes a `string:` argument and an optional `replacement:` ar
     NaughtyWords.filter(string: "hello asshole")
     => "hello *******"
     
+    # you can filter out consecutive naughty words
+    NaughtyWords.filter(string: "shitshitshityeah")
+    => "************yeah"
+    
     # you can use in your own filter character by passing it in as an argument  ("*" is by default)
     NaughtyWords.filter(string: "hello asshole", replacement: "!")
     => "hello !!!!!!!"
 ```
-Note: Current, this is comically easy to circumvent. String like "shitshitshit" will only filter out the first match, returning "*****shitshit". A fix is enroute.
+
+### Validating in Rails example
+We can use a custom validator in our User model to make sure a user cannot sign up with a username containing profanities in tandem with our normal `validates` methods.
+
+```ruby
+# app/models/user.rb
+
+validates :username, uniqueness: true, presence: true # basic username validation 
+validate :username_profanity_check # our custom validator
+
+...
+
+def username_profanity_check
+    errors.add(:username, "contains profanity") if NaughtyWords.check(string: username)
+end
+```
 
 ## Development
 

data/lib/naughty_words/base.rb

@@ -4,30 +4,54 @@ module NaughtyWords
   class Base
     class << self
       def profanity?(string:)
-        blacklist_file.each do |line|
-          return true if string.include?(line.chomp)
+        allow_list_array.each do |line|
+          return false if string.include?(line)
+        end
+
+        deny_list_array.each do |line|
+          return true if string.include?(line)
         end
 
         false
       end
 
       def filter(string:, replacement:)
-        # TODO: Fix filtering full words ending with 'ing' and repeated words such as 'fuckfuckfuck'
-        blacklist_file.each do |line|
-          word = line.chomp
+        deny_list_array.each do |line|
+          word = line
           string.gsub!(word, replacement * word.length)
         end
 
         string
       end
 
+      def add_to_list(list:, string:)
+        File.open(send(list), "a+") do |file|
+          file.puts(string)
+        end
+      end
+
+      def show_list(list:)
+        if list == "deny"
+          deny_list_array
+        else
+          allow_list_array
+        end
+      end
+
       private
 
-      def blacklist_file
-        txt_file = File.join(File.dirname(File.expand_path(__FILE__)), "config/en.txt")
-        file = File.open(txt_file)
+      def deny_list_array
+        file = File.open(File.join(File.dirname(File.expand_path(__FILE__)),
+                                   "config/deny_list.txt"))
+
+        @deny_list_array ||= File.readlines(file, chomp: true)
+      end
+
+      def allow_list_array
+        file = File.open(File.join(File.dirname(File.expand_path(__FILE__)),
+                                   "config/allow_list.txt"))
 
-        @blacklist_file ||= file.readlines
+        @allow_list_array ||= File.readlines(file, chomp: true)
       end
     end
   end

data/lib/naughty_words/config/allow_list.txt

@@ -0,0 +1,5 @@
+cummings
+baldasso
+shitake
+sex
+scunthorpe

data/lib/naughty_words/config/{en.txt → deny_list.txt}

@@ -10,7 +10,6 @@ apeshit
 arsehole
 asshole
 assmunch
-ass
 auto erotic
 autoerotic
 babeland
@@ -96,10 +95,9 @@ cornhole
 coon
 coons
 creampie
-cum
-cumming
 cumshot
 cumshots
+cumming
 cunnilingus
 cunting
 cunt
@@ -398,7 +396,6 @@ whore
 worldsex
 wrapping men
 wrinkled starfish
-xx
 xxx
 yaoi
 yellow showers

data/lib/naughty_words/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NaughtyWords
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/naughty_words.rb

@@ -13,5 +13,17 @@ module NaughtyWords
     def filter(string:, replacement: "*")
       Base.filter(string: string, replacement: replacement)
     end
+
+    def add_to_deny_list(string:)
+      Base.add_to_list(list: "deny_list_file", string: string)
+    end
+
+    def add_to_allow_list(string:)
+      Base.add_to_list(list: "allow_list_file", string: string)
+    end
+
+    def show_list(list:)
+      Base.show_list(list: list)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: naughty_words
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - John Arnold
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-19 00:00:00.000000000 Z
+date: 2023-05-17 00:00:00.000000000 Z
 dependencies: []
 description: This gem will detect simple profanity and can substitute them with a
   specified replacement.
@@ -31,9 +31,9 @@ files:
 - bin/setup
 - lib/naughty_words.rb
 - lib/naughty_words/base.rb
-- lib/naughty_words/config/en.txt
+- lib/naughty_words/config/allow_list.txt
+- lib/naughty_words/config/deny_list.txt
 - lib/naughty_words/version.rb
-- naughty_words-0.1.0.gem
 homepage: https://github.com/jaarnie/naughty_words
 licenses:
 - MIT