polite_text 0.1.3 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b3eeefd6c47fe3bdc029ddfd592486673db2b55bcfff7405fc17e3a45c4c960
-  data.tar.gz: 891412e5952963ea6109a9ac649b05b250bc0ae19035f5f80de10bb245f45a7d
+  metadata.gz: 574591328155e7985751a85bfdb2610376f9c976b4d0a589c1d735ec9bfb9816
+  data.tar.gz: b0f61d51a49c6882dbd666a495b20b2e0f12a5a2ae716c20350b2739e3910afe
 SHA512:
-  metadata.gz: 3b87c8045b5f0cab33be0462390fac0d28c628ec3a28d9345748d620578930d83c21eeedb02fb7431a4049f835c18e9e8e397feccc247e0bcaff6606a0966ccb
-  data.tar.gz: 3ce5f283f3b2775564581aeb7bde43c0b4995de59c9824838537facfef5348eee23068367fea1f6f8ba8d2a124473e43b00a2477e6532d6eade19749d3f3abc7
+  metadata.gz: d678889edb60886cfb83f6a186335e6371238cd45669eec435f1cf0f52f981cd074cfa04cbb8181243314edb68c371b0e9ca45805d9184719a1b8f1518839064
+  data.tar.gz: 705cbb3d6f397a4292aa858fc734d3dea33d7fa4c6989d4d848b3968948b2f9b57ca367c076a00968eafb9d931b58ab823b24e3c0b2421594ee4c5f13ceeba2f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    polite_text (0.1.22)
+    polite_text (0.1.2)
 
 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 based on a default swear words list or your own.
+👉 Replace the swear words or execute callbacks if the input is not polite.
 
-## Installation 👨‍💻 👩‍💻
+## Installation
 
 Add this line to your application's Gemfile:
 
@@ -23,7 +23,7 @@ Or install it yourself as:
 
     $ gem install polite_text
 
-## Usage with the default swear words list 🌝
+## Usage
 
 ### 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,6 +35,7 @@ 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"
 ```
 
@@ -45,6 +46,7 @@ include PoliteText
 str = "This gem is a fucking big shit but let's try it"
 
 PoliteText.is_polite?(str)
+
 => false
 ```
 
@@ -62,7 +64,7 @@ PoliteText.is_polite?(str)
 #
 
 class Article < ApplicationRecord
-  include PoliteText
+  include Politetext
 
   # Callbacks
   before_save :make_text_polite
@@ -74,53 +76,17 @@ 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 💪
-- [ ] 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.
+- [ ] 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.
 
 ## License
 

data/lib/polite_text/base.rb

@@ -2,13 +2,16 @@ require 'yaml'
 
 module PoliteText
   class Base
-    def swear_words(custom_swear_words_path)
-      @swear_words ||= /\b(#{Regexp.union(swear_words_list(custom_swear_words_path)).source})\b/
+    def swear_words
+      @swear_words ||= /\b(#{Regexp.union(swear_words_list).source})\b/
     end
 
-    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']
+    def swear_words_load_path
+      "#{__dir__}/../locales/#{locale}.yml"
+    end
+
+    def swear_words_list
+      YAML.load_file(swear_words_load_path)['swear_words']
     end
 
     private
@@ -17,9 +20,5 @@ 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,15 +2,14 @@ module PoliteText
   class TextCleaner < Base
     attr_reader :text
 
-    def initialize(text, custom_swear_words_path = nil)
+    def initialize(text)
       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(@custom_swear_words_path), '***') || text
+      text.gsub!(swear_words, '***')
     end
   end
 end

data/lib/polite_text/text_scanner.rb

@@ -2,15 +2,14 @@ module PoliteText
   class TextScanner < Base
     attr_reader :text
 
-    def initialize(text, custom_swear_words_path = nil)
+    def initialize(text)
       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(@custom_swear_words_path))
+      !@text.match?(swear_words)
     end
   end
 end

data/lib/polite_text/version.rb

@@ -1,3 +1,3 @@
 module PoliteText
-  VERSION = "0.1.3"
+  VERSION = "0.1.21"
 end

data/lib/polite_text.rb

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

metadata

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