polite_text 0.1.2 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 975a036dc2224dc4f4511c9bb9c10e2cebf2b5e9ff53c5a832dbc1a8321ab885
-  data.tar.gz: b64fc451921d3d344ec50e1c406718abc36290a55ade06181390adf877b8e6db
+  metadata.gz: 574591328155e7985751a85bfdb2610376f9c976b4d0a589c1d735ec9bfb9816
+  data.tar.gz: b0f61d51a49c6882dbd666a495b20b2e0f12a5a2ae716c20350b2739e3910afe
 SHA512:
-  metadata.gz: 90cf022213168d75beec317b0e4b2e2eb50e62d3036a27c29c135efed9b2068d15c91a92de09f125dd3bcec61755e0e228d45c2a1d4ac5fd55de56835dd75ca4
-  data.tar.gz: bc51b523c94300e81e2243c839bdf8e54a570f25e6b159d11c58994ac2d304adf10c346161d3024af721fb90e56dce542abee6a46410c5e56cb261e3e3de72bd
+  metadata.gz: d678889edb60886cfb83f6a186335e6371238cd45669eec435f1cf0f52f981cd074cfa04cbb8181243314edb68c371b0e9ca45805d9184719a1b8f1518839064
+  data.tar.gz: 705cbb3d6f397a4292aa858fc734d3dea33d7fa4c6989d4d848b3968948b2f9b57ca367c076a00968eafb9d931b58ab823b24e3c0b2421594ee4c5f13ceeba2f

data/Gemfile.lock

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

data/README.md

@@ -25,6 +25,9 @@ Or install it yourself as:
 
 ## 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).
+
 ### Remove swear words 🤬
 ```
 include PoliteText
@@ -47,16 +50,43 @@ 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
+```
+
 ## 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
+- [ ] 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/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,8 +3,6 @@ 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!

data/lib/polite_text/base.rb

@@ -16,7 +16,7 @@ module PoliteText
 
     private
 
-    # Todo: Implement dynamic locale with I18N
+    # TODO: Implement dynamic locale with I18N
     def locale
       @locale ||= 'en'
     end

data/lib/polite_text/text_cleaner.rb

@@ -3,19 +3,13 @@ module PoliteText
     attr_reader :text
 
     def initialize(text)
-      @text = text.to_s
+      raise ArgumentError.new('The text can not be nil') if text.nil?
 
-      validate_text!
+      @text = text.to_s
     end
 
     def clean!
       text.gsub!(swear_words, '***')
     end
-
-    private
-
-    def validate_text!
-      raise ArgumentError.new('The text can not be empty') if @text.empty?
-    end
   end
 end

data/lib/polite_text/text_scanner.rb

@@ -3,19 +3,13 @@ module PoliteText
     attr_reader :text
 
     def initialize(text)
-      @text = text.to_s
+      raise ArgumentError.new('The text can not be nil') if text.nil?
 
-      validate_text!
+      @text = text.to_s
     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?
-    end
   end
 end

data/lib/polite_text/version.rb

@@ -1,3 +1,3 @@
 module PoliteText
-  VERSION = "0.1.2"
+  VERSION = "0.1.21"
 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.21
 platform: ruby
 authors:
 - DumasOlivier