ngwords 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8597c1279bb002b6e362fd1000e33cdf6b1c4ba4
+  data.tar.gz: 3e13e8724e97ebceed2b3cc39e2a1b91576d7995
+SHA512:
+  metadata.gz: 9cc70d0bf7aa05b4dd25615c9edb2425c8630ff4f8171c1ec79cf1c7304e73b9a4e4f17642672cc1fb11c13c8f58ba842470ec5836c071819ee1ddaf1ea38bf0
+  data.tar.gz: ecb8f890923d1d74747eaeac0fd6e45fac023dd48954b504059b7a239136e069fe8b16720bab6314c6c9d62551c50e7af4ffbadc26c714ab5324a82757fe4924

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 chitamano
+
+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,74 @@
+# Ngwords
+Ngwords prevents prohibited words from being registered in your application. The prohibited word list can be set in the YAML data format. Ngwords currently only works with Rails.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ngwords'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install ngwords
+```
+## Usage
+
+#### 1. Create your settings in `config/ngwords.yml`
+
+```yml
+defaults: &defaults
+  en:
+    - shit
+    - id password input
+  ja:
+    - 白痴
+    - ID パスワード 入力
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults
+```
+
+Block of `en` is a list of prohibited words for space-separated languages ​​such as English. The block in `ja` is for non-space delimited languages ​​such as Japanese.
+
+Note: To prevent data registration when all words are included, set prohibited words with a space delimiter like `id password input`.
+
+#### 2. Add `ngwords: true` to your model's validates method
+
+```ruby
+class Post < ApplicationRecord
+  validates :title, presence: true, ngwords: true
+  validates :body, ngwords: true
+end
+```
+
+Note: If you want to customize the error message, set your locale setting file (e.g.: `config/locales/ja.yml`) as follows.
+
+```yml
+ja:
+  activerecord:
+    errors:
+      messages:
+        includes_ngwords: "は禁止単語を含んでいます。"
+```
+
+## Contributing
+1. Fork it ( https://github.com/chitamano/ngwords/fork )
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create new Pull Request
+
+## 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,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Ngwords'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/ngwords/config.rb

@@ -0,0 +1,8 @@
+require 'settingslogic'
+
+module Ngwords
+  class Settings < Settingslogic
+    source "#{Rails.root}/config/ngwords.yml"
+    namespace Rails.env
+  end
+end

data/lib/ngwords/railtie.rb

@@ -0,0 +1,10 @@
+module Ngwords
+  class Railtie < ::Rails::Railtie
+    initializer 'ngwords' do |_app|
+      ActiveSupport.on_load :after_initialize do
+        require 'ngwords/config'
+        require 'ngwords/validator'
+      end
+    end
+  end
+end

data/lib/ngwords/validator.rb

@@ -0,0 +1,31 @@
+require 'moji'
+
+module ActiveModel
+  module Validations
+    class NgwordsValidator < EachValidator
+      @@ngwords = nil
+
+      def validate_each(record, attribute, value)
+        return if value.blank?
+        if Moji.normalize_zen_han(value) =~ ngwords
+          record.errors.add(attribute, I18n.t('activerecord.errors.messages.includes_ngwords', default: 'includes prohibited words.'))
+        end
+      end
+
+      private
+
+      def ngwords
+        return @@ngwords unless @@ngwords.nil?
+        ngwords = []
+        Ngwords::Settings.each do |lang, list|
+          delim = lang == :en ? '\\b' : ''
+          Array(list).reject(&:blank?).each do |ngword|
+            escaped_ngword = ngword.split(/\p{blank}/).reject(&:blank?).map { |word| '(?=.*' + delim + Regexp.escape(word) + delim + ')' }.join('')
+            ngwords.push(Regexp.compile("^#{escaped_ngword}", Regexp::IGNORECASE))
+          end
+        end
+        @@ngwords = Regexp.union(ngwords)
+      end
+    end
+  end
+end

data/lib/ngwords/version.rb

@@ -0,0 +1,3 @@
+module Ngwords
+  VERSION = '0.1.0'
+end

data/lib/ngwords.rb

@@ -0,0 +1 @@
+require 'ngwords/railtie'

data/lib/tasks/ngwords_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ngwords do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: ngwords
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- chitamano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: moji
+  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: rails
+  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: settingslogic
+  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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ngwords prevents prohibited words from being registered in your application.
+  The prohibited word list can be set in the YAML data format. Ngwords currently only
+  works with Rails.
+email:
+- yonesuke3000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/ngwords.rb
+- lib/ngwords/config.rb
+- lib/ngwords/railtie.rb
+- lib/ngwords/validator.rb
+- lib/ngwords/version.rb
+- lib/tasks/ngwords_tasks.rake
+homepage: https://github.com/chitamano/ngwords
+licenses:
+- MIT
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Ngwords prevents prohibited words from being registered in your application.
+test_files: []