polite_text 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbfcbe17185f2648936f26afaca7ddacaba70a9901f882c2a517e4baa96f2818
-  data.tar.gz: 9bbfdbc8729c77a9d008a6a70836785ea467def92219a204e72472a8973373f4
+  metadata.gz: b61709fd69469a4a019e0a041b18c95700d72132992293b2e2f49eebe9df6662
+  data.tar.gz: d243724fa7ef4eb931e4b6e295b6b1d8afec2a81c82d399e5759f764f808c1e4
 SHA512:
-  metadata.gz: 2f3d14c0213deac733467cf9f920ac03246453a88f04703db4c2fd3244e0fe1e6564366c62411d8a000dcf9df355b72717c09db24396ff5c4d6b7f877996096e
-  data.tar.gz: 6a2db207e7522e085a77342abe9019b3334462982be396c57fa1ab19e2c9f97e1878bdb51b3f8873c0dc36badb5c336108ffeeb45d3cd180c0213b020fb5445f
+  metadata.gz: 1a4fbc965f3c668bedbe5e0bf1df64f72077199c743938ec009c82a71e6c889f11492c92d18c58776303e31d34acbacdd01ea6dc47666731a41ade9abb044255
+  data.tar.gz: c232a79a3dd3c5bd8ea7abfbfbe99f807de817143d54a57db31e1feb85a88ec5e6c75c3f040a3c05f14f89401b265b00f1e3c1b47a7daaad0dbf9e1a72c64613

data/.gitignore

@@ -9,3 +9,12 @@
 
 # rspec failure tracking
 .rspec_status
+
+# IDE
+/.idea
+.idea/workspace.xml
+.rakeTasks
+.generators
+
+# Gem
+*.gem

data/Gemfile

@@ -2,6 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in polite_text.gemspec
 gemspec
-
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    polite_text (0.1.22)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    faker (2.14.0)
+      i18n (>= 1.6, < 2)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    rake (13.0.1)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    simplecov (0.19.1)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faker (~> 2.14)
+  polite_text!
+  rake (~> 13.0, >= 13.0.1)
+  rspec (~> 3.10)
+  simplecov (~> 0.19.1)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,10 +1,13 @@
 # PoliteText
+[![Gem Version](https://badge.fury.io/rb/polite_text.svg)](https://badge.fury.io/rb/polite_text)
+[![security](https://hakiri.io/github/OpenGems/polite_text/master.svg)](https://hakiri.io/github/OpenGems/polite_text/master)
+![Gem](https://img.shields.io/gem/dt/polite_text)
 
 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:
 
@@ -20,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 🤬
 ```
@@ -29,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"
 ```
 
@@ -40,21 +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 💪
-- [ ] Testing
-- [ ] 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

@@ -1,18 +1,15 @@
 require 'polite_text/base'
-require 'polite_text/swear_words_scanner'
-require 'polite_text/swear_words_cleaner'
+require 'polite_text/text_scanner'
+require 'polite_text/text_cleaner'
 
 module PoliteText
-  class Error < StandardError; end
-
   class << self
-    # Replace swear words in a text. Can provide optional arg to replace by something.
-    def be_polite!(text)
-      PoliteText::SwearWordsCleaner.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::SwearWordsScanner.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

@@ -1,22 +1,25 @@
+require 'yaml'
+
 module PoliteText
   class Base
-    def swear_words
-      @swear_words ||= /\b(#{Regexp.union(swear_words_list).source})\b/
-    end
-
-    def swear_words_load_path
-      "#{__dir__}/../locales/#{locale}.yml"
+    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_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

@@ -0,0 +1,16 @@
+module PoliteText
+  class TextCleaner < Base
+    attr_reader :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(@custom_swear_words_path), '***') || text
+    end
+  end
+end

data/lib/polite_text/text_scanner.rb

@@ -0,0 +1,16 @@
+module PoliteText
+  class TextScanner < Base
+    attr_reader :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(@custom_swear_words_path))
+    end
+  end
+end

data/lib/polite_text/version.rb

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

data/polite_text.gemspec

@@ -17,15 +17,16 @@ 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'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  # TODO: Add testing
-    #spec.add_development_dependency 'coveralls', '~> 0.8'
-    #spec.add_development_dependency 'rspec-rails', '~> 4.0.0'
-    #spec.add_development_dependency 'simplecov', '~> 0.16'
+  # TODO: Add testing + coverage
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.1'
+  spec.add_development_dependency 'simplecov', '~> 0.19.1'
+  spec.add_development_dependency 'faker', '~> 2.14'
 end

metadata

@@ -1,15 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: polite_text
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - DumasOlivier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
-dependencies: []
+date: 2020-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
 description: Replace swear words from users' inputs or be notified and execute your
   own callbacks.
 email:
@@ -22,6 +84,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -30,10 +93,9 @@ files:
 - lib/locales/en.yml
 - lib/polite_text.rb
 - lib/polite_text/base.rb
-- lib/polite_text/swear_words_cleaner.rb
-- lib/polite_text/swear_words_scanner.rb
+- lib/polite_text/text_cleaner.rb
+- lib/polite_text/text_scanner.rb
 - lib/polite_text/version.rb
-- polite_text-0.1.0.gem
 - polite_text.gemspec
 homepage: https://github.com/OpenGems/polite_text
 licenses:

data/lib/polite_text/swear_words_cleaner.rb

@@ -1,15 +0,0 @@
-module PoliteText
-  class SwearWordsCleaner < Base
-    attr_reader :text
-
-    def initialize(text)
-      return '' if text.nil? || text.empty?
-
-      @text = text
-    end
-
-    def clean
-      text.gsub!(swear_words, '***')
-    end
-  end
-end

data/lib/polite_text/swear_words_scanner.rb

@@ -1,15 +0,0 @@
-module PoliteText
-  class SwearWordsScanner < Base
-    attr_reader :text
-
-    def initialize(text)
-      return false if text.nil? || text.empty?
-
-      @text = text
-    end
-
-    def match_swear_word?
-      !@text.match?(swear_words)
-    end
-  end
-end