polite_text 0.1.1

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 DumasOlivier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# PoliteText
+
+PoliteText is making your users' input polite 👀
+
+👉 Replace the swear words or execute callbacks if the input is not polite.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'polite_text'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install polite_text
+
+## Usage
+
+### Remove swear words 🤬
+```
+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"
+```
+
+### Check if string is polite 🙅‍♂️ 🙅‍♀️
+```
+include PoliteText
+
+str = "This gem is a fucking big shit but let's try it"
+
+PoliteText.is_polite?(str)
+
+=> 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
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "polite_text"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/locales/en.yml

@@ -0,0 +1,21 @@
+# Don t show this to your mom.
+
+swear_words:
+  - fuck
+  - fuckyou
+  - fucker
+  - fucking 
+  - dick head
+  - dick
+  - dickhole
+  - cock
+  - asshole
+  - son of a bitch
+  - bitch
+  - biatch
+  - whore
+  - bastard
+  - wanker
+  - shit
+  - piss
+  - pussy

data/lib/polite_text.rb

@@ -0,0 +1,18 @@
+require 'polite_text/base'
+require 'polite_text/swear_words_scanner'
+require 'polite_text/swear_words_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
+    end
+
+    def is_polite?(text)
+      PoliteText::SwearWordsScanner.new(text).match_swear_word?
+    end
+  end
+end

data/lib/polite_text/base.rb

@@ -0,0 +1,22 @@
+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"
+    end
+
+    def swear_words_list
+      YAML.load_file(swear_words_load_path)['swear_words']
+    end
+
+    private
+
+    # Todo: Implement dynamic locale with I18N
+    def locale
+      @locale ||= 'en'
+    end
+  end
+end

data/lib/polite_text/swear_words_cleaner.rb

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,15 @@
+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

data/lib/polite_text/version.rb

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

data/polite_text.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/polite_text/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'polite_text'
+  spec.version       = PoliteText::VERSION
+  spec.authors       = ['DumasOlivier']
+  spec.email         = ['dumas.olivier@outlook.fr']
+
+  spec.summary       = 'PoliteText is making your users\' input polite.'
+  spec.description   = 'Replace swear words from users\' inputs or be notified and execute your own callbacks.'
+  spec.homepage      = 'https://github.com/OpenGems/polite_text'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # 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
+    `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'
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: polite_text
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- DumasOlivier
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-04 00:00:00.000000000 Z
+dependencies: []
+description: Replace swear words from users' inputs or be notified and execute your
+  own callbacks.
+email:
+- dumas.olivier@outlook.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- 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/version.rb
+- polite_text-0.1.0.gem
+- polite_text.gemspec
+homepage: https://github.com/OpenGems/polite_text
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/OpenGems/polite_text
+  source_code_uri: https://github.com/OpenGems/polite_text
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: PoliteText is making your users' input polite.
+test_files: []