ng_word 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0a2b392753e735250209d1c7f72beb7a76bb8ec0c66dfaa3225e7e1e2bae0bc
+  data.tar.gz: 0402e29327e647d1f676cec0aa41499304c99f9872e023933d712feca484837e
+SHA512:
+  metadata.gz: e517d878be9d7ac30093263ea32207fa1715835be111908e1a071f4509b138bef95b4d3e239720e3bcd6b797f86f564578f08e9f279cab8a3cceb6b6a9fa1e29
+  data.tar.gz: 7ebb7744daf9e861f4cee1c05cd4d0fe34ee96cc9711ba5a4576441be7940472c48b8fb5ddb89d4506cb31ebe9de8bb5c587cfb3db2b245fab5ea605c27366a3

data/.circleci/config.yml

@@ -0,0 +1,30 @@
+version: 2
+
+jobs:
+  build: &build
+    docker:
+      - image: circleci/ruby:latest
+    steps:
+      - checkout
+      - run:
+          name: Install gems
+          command: bundle install
+      - run:
+          name: RSpec
+          command: rspec
+  ruby-2.4:
+    <<: *build
+    docker:
+      - image: circleci/ruby:2.4
+
+  ruby-2.5:
+    <<: *build
+    docker:
+      - image: circleci/ruby:2.5
+
+workflows:
+  version: 2
+  build-multiple-rubies:
+    jobs:
+      - ruby-2.4
+      - ruby-2.5

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ng_word.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Takahiro Ooishi
+
+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,47 @@
+# NgWord
+
+Verify NG words.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ng_word'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ng_word
+
+## Usage
+
+```ruby
+rule_list = NgWord::RuleList.new([
+  NgWord::Rule.new('ng', exclude_words: ['ng word']),
+  NgWord::Rule.new('hoge')
+])
+
+text = "This text is include NG word and hoge word."
+result = rule_list.verify(text)
+rule_list.match?(text)
+masked_text = rule_list.masked_text(text)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Code Status
+
+[![CircleCI](https://circleci.com/gh/taka0125/ng_word/tree/master.svg?style=svg)](https://circleci.com/gh/taka0125/ng_word/tree/master)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/taka0125/ng_word.

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 "ng_word"
+
+# 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/ng_word.rb

@@ -0,0 +1,11 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'ng_word/version'
+require 'ng_word/verification_result'
+require 'ng_word/exclude_word_rule'
+require 'ng_word/rule'
+require 'ng_word/rule_list'
+
+module NgWord
+  # Your code goes here...
+end

data/lib/ng_word/exclude_word_rule.rb

@@ -0,0 +1,26 @@
+module NgWord
+  class ExcludeWordRule
+    def initialize(downcased_ng_word, exclude_word)
+      @downcased_ng_word = downcased_ng_word
+      @exclude_word = exclude_word
+    end
+
+    def match?(downcased_text, matched_index)
+      downcased_text.slice(matched_index - index, length) == @downcased_exclude_word
+    end
+
+    private
+
+    def downcased_exclude_word
+      @downcased_exclude_word ||= @exclude_word.downcase
+    end
+
+    def index
+      @index ||= downcased_exclude_word.index(@downcased_ng_word)
+    end
+
+    def length
+      @length ||= downcased_exclude_word.length
+    end
+  end
+end

data/lib/ng_word/rule.rb

@@ -0,0 +1,66 @@
+module NgWord
+  class Rule
+    attr_reader :ng_word, :exclude_word_rules
+
+    def initialize(ng_word, exclude_words: [])
+      @ng_word = ng_word
+      @exclude_words = exclude_words
+    end
+
+    def verify(downcased_text, offset: 0)
+      index = downcased_text.index(downcased_ng_word, offset)
+      return VerificationResult.new(true) if index.nil?
+
+      exclude_word_rules.each do |rule|
+        return verify(downcased_text, offset: index + 1) if rule.match?(downcased_text, index)
+      end
+
+      VerificationResult.new(false, ng_word: @ng_word)
+    end
+
+    def masked_text(text, replace_text: '***', for_monitoring: false)
+      downcased_text = text.downcase
+      index = downcased_text.index(downcased_ng_word)
+      return text if index.nil?
+
+      index_list = split(downcased_text)
+
+      words = []
+      current_index = 0
+      index_list.each do |index|
+        words << text.slice(current_index, index - current_index)
+        current_index = index + downcased_ng_word.length
+      end
+      words << text.slice(current_index, text.length - current_index)
+
+      replaced_text = for_monitoring ? "#{replace_text}(#{@ng_word})" : replace_text
+      words.join(replaced_text)
+    end
+
+    def match?(downcased_text)
+      result = verify(downcased_text)
+      !result.valid?
+    end
+
+    private
+
+    def downcased_ng_word
+      @downcased_ng_word ||= @ng_word.downcase
+    end
+
+    def exclude_word_rules
+      @exclude_word_rules ||= Array(@exclude_words).map { |w| ExcludeWordRule.new(downcased_ng_word, w) }
+    end
+
+    def split(downcased_text, offset: 0, index_list: [])
+      index = downcased_text.index(downcased_ng_word, offset)
+      return index_list if index.nil?
+
+      exclude_word_rules.each do |rule|
+        return split(downcased_text, offset: index + 1, index_list: index_list) if rule.match?(downcased_text, index)
+      end
+
+      split(downcased_text, offset: index + 1, index_list: index_list + [index])
+    end
+  end
+end

data/lib/ng_word/rule_list.rb

@@ -0,0 +1,51 @@
+module NgWord
+  class RuleList
+    def initialize(rules)
+      @rules = {}
+      Array(rules).each do |rule|
+        @rules[rule.ng_word.downcase] = rule
+      end
+
+      @ng_words = @rules.keys
+      @regexp = Regexp.union(@rules.keys.map { |s| /#{s}/i })
+    end
+
+    def verify(text)
+      return VerificationResult.new(true) if text.blank?
+
+      candidate_ng_words = text.scan(@regexp)
+      return VerificationResult.new(true) if candidate_ng_words.blank?
+
+      downcased_text = text.downcase
+      candidate_ng_words.each do |ng_word|
+        rule = @rules[ng_word.downcase]
+        next if rule.blank?
+
+        return VerificationResult.new(false, ng_word: rule.ng_word) if rule.match?(downcased_text)
+      end
+
+      VerificationResult.new(true)
+    end
+
+    def masked_text(text, replace_text: '***', for_monitoring: false)
+      return text if text.blank?
+
+      candidate_ng_words = text.scan(@regexp)
+      return text if candidate_ng_words.blank?
+
+      candidate_ng_words.each do |ng_word|
+        rule = @rules[ng_word.downcase]
+        next if rule.blank?
+
+        text = rule.masked_text(text, replace_text: replace_text, for_monitoring: for_monitoring)
+      end
+
+      text
+    end
+
+    def match?(text)
+      result = verify(text)
+      !result.valid?
+    end
+  end
+end

data/lib/ng_word/verification_result.rb

@@ -0,0 +1,14 @@
+module NgWord
+  class VerificationResult
+    attr_reader :ng_word
+
+    def initialize(is_valid, ng_word: nil)
+      @is_valid = is_valid
+      @ng_word = ng_word
+    end
+
+    def valid?
+      @is_valid
+    end
+  end
+end

data/lib/ng_word/version.rb

@@ -0,0 +1,3 @@
+module NgWord
+  VERSION = "0.1.0"
+end

data/ng_word.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ng_word/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ng_word"
+  spec.version       = NgWord::VERSION
+  spec.authors       = ["Takahiro Ooishi"]
+  spec.email         = ["taka0125@gmail.com"]
+
+  spec.summary       = %q{Verify NG words.}
+  spec.description   = %q{Verify NG words.}
+  spec.homepage      = "https://github.com/taka0125/ng_word"
+
+  # 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"]
+
+  spec.add_dependency "activesupport"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: ng_word
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takahiro Ooishi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Verify NG words.
+email:
+- taka0125@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- aaa
+- bin/console
+- bin/setup
+- lib/ng_word.rb
+- lib/ng_word/exclude_word_rule.rb
+- lib/ng_word/rule.rb
+- lib/ng_word/rule_list.rb
+- lib/ng_word/verification_result.rb
+- lib/ng_word/version.rb
+- ng_word.gemspec
+homepage: https://github.com/taka0125/ng_word
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Verify NG words.
+test_files: []