polite_text 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b61709fd69469a4a019e0a041b18c95700d72132992293b2e2f49eebe9df6662
-  data.tar.gz: d243724fa7ef4eb931e4b6e295b6b1d8afec2a81c82d399e5759f764f808c1e4
+  metadata.gz: 6441b50cc047fa72c872b0b2f4e1bcaff686461d28738426251f3562e7507494
+  data.tar.gz: 5cec91bda68345fdc0af048107edaf971b32848f823e9f2e4f88f46524d608f5
 SHA512:
-  metadata.gz: 1a4fbc965f3c668bedbe5e0bf1df64f72077199c743938ec009c82a71e6c889f11492c92d18c58776303e31d34acbacdd01ea6dc47666731a41ade9abb044255
-  data.tar.gz: c232a79a3dd3c5bd8ea7abfbfbe99f807de817143d54a57db31e1feb85a88ec5e6c75c3f040a3c05f14f89401b265b00f1e3c1b47a7daaad0dbf9e1a72c64613
+  metadata.gz: e6d59fba6f064483e5ffe3494d02694790d1d15cc2710463c49a64f25f487886518e68e33f6f23e6ed4ebc9bf87047f23a9fee49f8fb7b06802aea202d0ae134
+  data.tar.gz: d76c2d3b3eb20b90b03ff2f05fa5eb277e5d7b36100aa8ae5cae1650a55582da9a2146f6b06b14b208b397b3f752cf92abb9ae154c2199fc8b2dbdc2bf20b4a4

data/Gemfile.lock

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

data/README.md

@@ -79,7 +79,7 @@ end
 ### Custom swear words list  🔞
 Create a custom list in a **YAML** file following this format :
 ```
-# my_custom_swear_words.yml
+# custom_swear_words.yml
 
 swear_words:
   - gem
@@ -89,25 +89,29 @@ swear_words:
 
 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.
+## Confirguration
 
-### Example for an Article model
+📄 Create an initializer named `polite_text.rb`
+
+✌️ Add the path to your custom swear words list like this :
 
-### Remove or detect swear words 🤬  🙅‍♂️ 🙅‍♀️
 ```
-# Inside a random_model.rb
+# ./config/initializers/polite_text.rb
 
-include PoliteText
+PoliteText.configure do |config|
+  config.custom_swear_words_path = "#{__dir__}/../../lib/polite_text/custom_swear_words.yml"
+end
+```
 
+PoliteText is now configured with your custom list ✨💫
+```
 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)
+<<<<<<< HEAD
+PoliteText.be_polite!(str)
 => "This *** is a fucking *** shit *** let's try it" 
 
-PoliteText.is_polite?(str, custom_path)
+PoliteText.is_polite?(str)
 => false
 ```
 

data/lib/polite_text.rb

@@ -4,12 +4,27 @@ 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!
+    attr_accessor :custom_swear_words_path
+
+    def configure
+      yield self if block_given?
+      check_attrs
+    end
+
+    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
+
+    private
+
+    def check_attrs
+      unless custom_swear_words_path.is_a?(::String)
+        raise(ArgumentError, 'Invalid path to your custom swear words list.')
+      end
     end
   end
 end

data/lib/polite_text/base.rb

@@ -2,17 +2,21 @@ 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)
+    def swear_words_list()
       path = custom_swear_words_path ? custom_swear_words_path.to_s : swear_words_load_path
       YAML.load_file(path)['swear_words']
     end
 
     private
 
+    def custom_swear_words_path
+      @custom_swear_words_path ||= PoliteText.custom_swear_words_path
+    end
+
     # TODO: Implement dynamic locale with I18N
     def locale
       @locale ||= 'en'

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, '***') || text
     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.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polite_text
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - DumasOlivier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-05 00:00:00.000000000 Z
+date: 2020-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec