polite_text 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 975a036dc2224dc4f4511c9bb9c10e2cebf2b5e9ff53c5a832dbc1a8321ab885
-  data.tar.gz: b64fc451921d3d344ec50e1c406718abc36290a55ade06181390adf877b8e6db
+  metadata.gz: 4b3eeefd6c47fe3bdc029ddfd592486673db2b55bcfff7405fc17e3a45c4c960
+  data.tar.gz: 891412e5952963ea6109a9ac649b05b250bc0ae19035f5f80de10bb245f45a7d
 SHA512:
-  metadata.gz: 90cf022213168d75beec317b0e4b2e2eb50e62d3036a27c29c135efed9b2068d15c91a92de09f125dd3bcec61755e0e228d45c2a1d4ac5fd55de56835dd75ca4
-  data.tar.gz: bc51b523c94300e81e2243c839bdf8e54a570f25e6b159d11c58994ac2d304adf10c346161d3024af721fb90e56dce542abee6a46410c5e56cb261e3e3de72bd
+  metadata.gz: 3b87c8045b5f0cab33be0462390fac0d28c628ec3a28d9345748d620578930d83c21eeedb02fb7431a4049f835c18e9e8e397feccc247e0bcaff6606a0966ccb
+  data.tar.gz: 3ce5f283f3b2775564581aeb7bde43c0b4995de59c9824838537facfef5348eee23068367fea1f6f8ba8d2a124473e43b00a2477e6532d6eade19749d3f3abc7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    polite_text (0.1.1)
+    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,10 @@ 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).
 
 ### Remove swear words 🤬
 ```
@@ -32,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"
 ```
 
@@ -43,20 +45,82 @@ include PoliteText
 str = "This gem is a fucking big shit but let's try it"
 
 PoliteText.is_polite?(str)
+=> false
+```
+
+### Example for an Article model
+
+```
+# == Schema Information
+#
+# Table name: articles
+#
+#  id         :bigint           not null, primary key
+#  text      :string           default(""), not null
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
+
+class Article < ApplicationRecord
+  include PoliteText
+
+  # Callbacks
+  before_save :make_text_polite
+
+  # Methods
+  def make_text_polite
+    PoliteText.be_polite!(text)
+  end
+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
+- [ ] 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/locales/en.yml

@@ -4,18 +4,24 @@ swear_words:
   - fuck
   - fuckyou
   - fucker
+  - fuckers
   - fucking 
   - dick head
   - dick
   - dickhole
   - cock
   - asshole
+  - assholes
   - son of a bitch
   - bitch
+  - bitches
   - biatch
   - whore
+  - whores
   - bastard
+  - bastards
   - wanker
+  - wankers
   - shit
   - piss
   - pussy

data/lib/polite_text.rb

@@ -3,15 +3,13 @@ require 'polite_text/text_scanner'
 require 'polite_text/text_cleaner'
 
 module PoliteText
-  class Error < StandardError; end
-
   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,23 +2,24 @@ 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
 
-    # Todo: Implement dynamic locale with I18N
+    # TODO: Implement dynamic locale with I18N
     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,20 +2,15 @@ module PoliteText
   class TextCleaner < Base
     attr_reader :text
 
-    def initialize(text)
-      @text = text.to_s
+    def initialize(text, custom_swear_words_path = nil)
+      raise ArgumentError.new('The text can not be nil') if text.nil?
 
-      validate_text!
+      @text = text.to_s
+      @custom_swear_words_path = custom_swear_words_path
     end
 
     def clean!
-      text.gsub!(swear_words, '***')
-    end
-
-    private
-
-    def validate_text!
-      raise ArgumentError.new('The text can not be empty') if @text.empty?
+      text.gsub!(swear_words(@custom_swear_words_path), '***') || text
     end
   end
 end

data/lib/polite_text/text_scanner.rb

@@ -2,20 +2,15 @@ module PoliteText
   class TextScanner < Base
     attr_reader :text
 
-    def initialize(text)
-      @text = text.to_s
+    def initialize(text, custom_swear_words_path = nil)
+      raise ArgumentError.new('The text can not be nil') if text.nil?
 
-      validate_text!
+      @text = text.to_s
+      @custom_swear_words_path = custom_swear_words_path
     end
 
     def match_swear_word?
-      !@text.match?(swear_words)
-    end
-
-    private
-
-    def validate_text!
-      raise ArgumentError.new('The text can not be empty') if @text.empty?
+      !@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.2"
+  VERSION = "0.1.3"
 end

data/polite_text.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'

metadata

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