polite_text 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbfcbe17185f2648936f26afaca7ddacaba70a9901f882c2a517e4baa96f2818
-  data.tar.gz: 9bbfdbc8729c77a9d008a6a70836785ea467def92219a204e72472a8973373f4
+  metadata.gz: 975a036dc2224dc4f4511c9bb9c10e2cebf2b5e9ff53c5a832dbc1a8321ab885
+  data.tar.gz: b64fc451921d3d344ec50e1c406718abc36290a55ade06181390adf877b8e6db
 SHA512:
-  metadata.gz: 2f3d14c0213deac733467cf9f920ac03246453a88f04703db4c2fd3244e0fe1e6564366c62411d8a000dcf9df355b72717c09db24396ff5c4d6b7f877996096e
-  data.tar.gz: 6a2db207e7522e085a77342abe9019b3334462982be396c57fa1ab19e2c9f97e1878bdb51b3f8873c0dc36badb5c336108ffeeb45d3cd180c0213b020fb5445f
+  metadata.gz: 90cf022213168d75beec317b0e4b2e2eb50e62d3036a27c29c135efed9b2068d15c91a92de09f125dd3bcec61755e0e228d45c2a1d4ac5fd55de56835dd75ca4
+  data.tar.gz: bc51b523c94300e81e2243c839bdf8e54a570f25e6b159d11c58994ac2d304adf10c346161d3024af721fb90e56dce542abee6a46410c5e56cb261e3e3de72bd

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.1)
+
+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,4 +1,7 @@
 # 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 👀
 
@@ -50,7 +53,6 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/OpenGe
 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

data/lib/polite_text.rb

@@ -1,18 +1,17 @@
 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
+      PoliteText::TextCleaner.new(text).clean!
     end
 
     def is_polite?(text)
-      PoliteText::SwearWordsScanner.new(text).match_swear_word?
+      PoliteText::TextScanner.new(text).match_swear_word?
     end
   end
 end

data/lib/polite_text/base.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 module PoliteText
   class Base
     def swear_words

data/lib/polite_text/text_cleaner.rb

@@ -0,0 +1,21 @@
+module PoliteText
+  class TextCleaner < Base
+    attr_reader :text
+
+    def initialize(text)
+      @text = text.to_s
+
+      validate_text!
+    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

@@ -0,0 +1,21 @@
+module PoliteText
+  class TextScanner < Base
+    attr_reader :text
+
+    def initialize(text)
+      @text = text.to_s
+
+      validate_text!
+    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.1"
+  VERSION = "0.1.2"
 end

data/polite_text.gemspec

@@ -24,8 +24,9 @@ Gem::Specification.new do |spec|
   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.1.2
 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