polite_text 0.1.22 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '00696f507481712af5a77b82abc07cc702964927fff97aa3b05babe07ba0c446'
-  data.tar.gz: 4c1b77cafdfac87010951bce6ea7adac6813657d9f704c40022e61befdf3479b
+  metadata.gz: b61709fd69469a4a019e0a041b18c95700d72132992293b2e2f49eebe9df6662
+  data.tar.gz: d243724fa7ef4eb931e4b6e295b6b1d8afec2a81c82d399e5759f764f808c1e4
 SHA512:
-  metadata.gz: c4d9788bfe42ea5196f6e3c5261df476fe8644366e4fa19d96f34370974ed35bf99142af85a51fdef1bca9631c0924e5778d5149b951bb6200ad04998fdd1c3d
-  data.tar.gz: cf7e94f809f18d5b43ccb0df506d5bfa140d54d2dbded21d907196e780faa7d560d82fa6cefc5a00465e3e7a7029b62cbbfb0ce15e632c449faf29800d4fcc16
+  metadata.gz: 1a4fbc965f3c668bedbe5e0bf1df64f72077199c743938ec009c82a71e6c889f11492c92d18c58776303e31d34acbacdd01ea6dc47666731a41ade9abb044255
+  data.tar.gz: c232a79a3dd3c5bd8ea7abfbfbe99f807de817143d54a57db31e1feb85a88ec5e6c75c3f040a3c05f14f89401b265b00f1e3c1b47a7daaad0dbf9e1a72c64613

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    polite_text (0.1.21)
+    polite_text (0.1.22)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -5,9 +5,9 @@
 
 PoliteText is making your users' input polite 👀
 
-👉 Replace the swear words or execute callbacks if the input is not polite.
+👉 Replace the swear words or execute callbacks if the input is not polite based on a default swear words list or your own.
 
-## Installation
+## Installation 👨‍💻 👩‍💻
 
 Add this line to your application's Gemfile:
 
@@ -23,7 +23,7 @@ Or install it yourself as:
 
     $ gem install polite_text
 
-## Usage
+## Usage with the default swear words list 🌝
 
 ### Swear words  🔞
 PoliteText has a default list of forbidden words, this list includes the most common swear words used on the web. You can acces the list of swear words [here](https://github.com/OpenGems/polite_text/blob/master/lib/locales/en.yml).
@@ -35,7 +35,6 @@ include PoliteText
 str = "This gem is a fucking big shit but let's try it"
 
 PoliteText.be_polite!(str)
-
 => "This gem is a *** big *** but let's try it"
 ```
 
@@ -46,7 +45,6 @@ include PoliteText
 str = "This gem is a fucking big shit but let's try it"
 
 PoliteText.is_polite?(str)
-
 => false
 ```
 
@@ -76,17 +74,53 @@ class Article < ApplicationRecord
 end
 ```
 
+## Usage with custom swear words list 🌞
+
+### Custom swear words list  🔞
+Create a custom list in a **YAML** file following this format :
+```
+# my_custom_swear_words.yml
+
+swear_words:
+  - gem
+  - big
+  - but
+```
+
+Place it where you want in your app, we recommend here : `./lib/polite_text/my_custom_swear_words.yml`
+
+👉 You just need to pass the path to this file as a second argument.
+
+### Example for an Article model
+
+### Remove or detect swear words 🤬  🙅‍♂️ 🙅‍♀️
+```
+# Inside a random_model.rb
+
+include PoliteText
+
+str = "This gem is a fucking big shit but let's try it"
+
+current_dir = __dir__
+custom_path = "#{current_dir}/../lib/polite_text/fr.yml"
+
+PoliteText.be_polite!(str, custom_path)
+=> "This *** is a fucking *** shit *** let's try it" 
+
+PoliteText.is_polite?(str, custom_path)
+=> false
+```
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/OpenGems/polite_text.
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
 
 ### Todo 💪
-- [ ] Allow users to add their own swear words list.
-- [ ] Allow users to remove swear words from the default list.
-- [ ] Manage locales with I18N.
-- [ ] Add swear words from multiple languages.
-- [ ] Improve swear words list and keeping it short.
+- [ ] Manage locales with I18N for default swear words lists by country.
+- [ ] Add default swear words lists from multiple languages.
+- [ ] Improve the default swear words list and keeping it short.
 
 ## License
 

data/lib/polite_text.rb

@@ -4,12 +4,12 @@ require 'polite_text/text_cleaner'
 
 module PoliteText
   class << self
-    def be_polite!(text)
-      PoliteText::TextCleaner.new(text).clean!
+    def be_polite!(text, custom_swear_words_path = nil)
+      PoliteText::TextCleaner.new(text, custom_swear_words_path).clean!
     end
 
-    def is_polite?(text)
-      PoliteText::TextScanner.new(text).match_swear_word?
+    def is_polite?(text, custom_swear_words_path = nil)
+      PoliteText::TextScanner.new(text, custom_swear_words_path).match_swear_word?
     end
   end
 end

data/lib/polite_text/base.rb

@@ -2,16 +2,13 @@ require 'yaml'
 
 module PoliteText
   class Base
-    def swear_words
-      @swear_words ||= /\b(#{Regexp.union(swear_words_list).source})\b/
+    def swear_words(custom_swear_words_path)
+      @swear_words ||= /\b(#{Regexp.union(swear_words_list(custom_swear_words_path)).source})\b/
     end
 
-    def swear_words_load_path
-      "#{__dir__}/../locales/#{locale}.yml"
-    end
-
-    def swear_words_list
-      YAML.load_file(swear_words_load_path)['swear_words']
+    def swear_words_list(custom_swear_words_path = nil)
+      path = custom_swear_words_path ? custom_swear_words_path.to_s : swear_words_load_path
+      YAML.load_file(path)['swear_words']
     end
 
     private
@@ -20,5 +17,9 @@ module PoliteText
     def locale
       @locale ||= 'en'
     end
+
+    def swear_words_load_path
+      "#{__dir__}/../locales/#{locale}.yml"
+    end
   end
 end

data/lib/polite_text/text_cleaner.rb

@@ -2,14 +2,15 @@ module PoliteText
   class TextCleaner < Base
     attr_reader :text
 
-    def initialize(text)
+    def initialize(text, custom_swear_words_path = nil)
       raise ArgumentError.new('The text can not be nil') if text.nil?
 
       @text = text.to_s
+      @custom_swear_words_path = custom_swear_words_path
     end
 
     def clean!
-      text.gsub!(swear_words, '***') || text
+      text.gsub!(swear_words(@custom_swear_words_path), '***') || text
     end
   end
 end

data/lib/polite_text/text_scanner.rb

@@ -2,14 +2,15 @@ module PoliteText
   class TextScanner < Base
     attr_reader :text
 
-    def initialize(text)
+    def initialize(text, custom_swear_words_path = nil)
       raise ArgumentError.new('The text can not be nil') if text.nil?
 
       @text = text.to_s
+      @custom_swear_words_path = custom_swear_words_path
     end
 
     def match_swear_word?
-      !@text.match?(swear_words)
+      !@text.match?(swear_words(@custom_swear_words_path))
     end
   end
 end

data/lib/polite_text/version.rb

@@ -1,3 +1,3 @@
 module PoliteText
-  VERSION = "0.1.22"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polite_text
 version: !ruby/object:Gem::Version
-  version: 0.1.22
+  version: 0.2.0
 platform: ruby
 authors:
 - DumasOlivier