hiwai 0.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in hiwai.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 hibariya
+
+MIT License
+
+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,49 @@
+# Hiwai
+
+レシーバがひわいかどうかを確認します。
+公の場で表示されると困るオブジェクトをフィルタするのが目的です。
+
+そのような文字列をなるべく目にしないで管理できるようにすることも目標にしています。
+
+## Installation
+
+** under construction **
+
+Add this line to your application's Gemfile:
+
+    gem 'hiwai'
+
+Or install it yourself as:
+
+    $ gem install hiwai
+
+## Usage
+
+```ruby
+require 'hiwai'
+
+# if you have your own dictionary
+Hiwai.dictionary = 'path/to/dictionary'
+
+# String
+'hibariya'.hiwai? # => false
+'とっても<<よくない文字列>>です'.hiwai? # => true
+'とっても<<よくない文字列>>です'.hiwai! # Hiwai::Censored: Receiver includes hiwai object
+
+# Array
+['とっても<<よくない文字列>>です'].hiwai? # => true
+```
+
+今は単純にString#matchでマッチさせています（もっと精度の高い方法にしたい）。
+ワードの一覧はvendor/hiwai.txtの下に改行区切で置いています（まだ何もない）。
+管理するときになるべく見ないためにBase64エンコーディングしています。
+
+マッチ候補の文字列はHiwaiモジュールが持っていますが、inspectしたときにうっかり表示されないように拡張しています。
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+

data/hiwai.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+
+require 'hiwai/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'hiwai'
+  s.version     = Hiwai::VERSION
+  s.authors     = ['hibariya']
+  s.email       = ['celluloid.key@gmail.com']
+  s.homepage    = 'https://github.com/hibariya/hiwai'
+  s.summary     = %q{detect hiwai string}
+  s.description = %q{detect hiwai string in japanese}
+
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| file.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rake', ['>= 0.9.2']
+  s.add_development_dependency 'rspec', ['>= 2.6.0']
+end

data/lib/hiwai.rb

@@ -0,0 +1,30 @@
+require 'base64'
+require 'hiwai/version'
+require 'hiwai/object'
+require 'hiwai/masked'
+
+module Hiwai
+  class Censored < StandardError; end
+
+  GEM_ROOT = File.dirname(__FILE__) + '/..'
+
+  class << self
+    attr_accessor :dictionary
+
+    def censorable_words
+      @censorable_words ||=
+        File.read(dictionary).split("\n").map {|line|
+          # TODO: support other encoding
+          str = Base64.decode64(line).force_encoding('utf-8')
+
+          MaskedString.new(str)
+        }
+    end
+
+    def reset!
+      @censorable_words = nil
+    end
+  end
+end
+
+Hiwai.dictionary = Hiwai::GEM_ROOT + '/vendor/hiwai.txt'

data/lib/hiwai/masked.rb

@@ -0,0 +1,18 @@
+module Hiwai
+  module Masked
+    def masked_string
+      '<censored>'
+    end
+
+    alias_method :to_s, :masked_string
+    alias_method :inspect, :masked_string
+  end
+
+  class MaskedString < String
+    include Masked
+  end
+
+  class MaskedRegexp < Regexp
+    include Masked
+  end
+end

data/lib/hiwai/object.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+class Object
+  def hiwai?
+    inspected = inspect
+
+    @hiwai_matches = Hiwai.censorable_words.select {|word|
+      inspected.match Regexp.new(word)
+    }
+
+    @hiwai_matches.any?
+  end
+
+  def hiwai!
+    raise Hiwai::Censored, 'Receiver includes hiwai object' if hiwai?
+  end
+
+  def censored
+    @hiwai_matches
+  end
+end

data/lib/hiwai/version.rb

@@ -0,0 +1,3 @@
+module Hiwai
+  VERSION = '0.0.0'
+end

data/spec/hiwai_spec.rb

@@ -0,0 +1,22 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe Hiwai do
+  describe '#hiwai?' do
+    it { "これは#{censored}です".should be_hiwai }
+    it { "小麦粉か何かだ".should_not be_hiwai }
+  end
+
+  describe '#hiwai!' do
+    it { expect { "これは#{censored}です".hiwai! }.should raise_error(Hiwai::Censored) }
+    it { expect { "小麦粉か何かだ".hiwai! }.should_not raise_error(Hiwai::Censored) }
+  end
+
+  describe 'censorable_words' do
+    subject { Hiwai.censorable_words }
+
+    its(:inspect) { should_not match /#{censored}/ }
+    its(:to_s) { should_not match /#{censored}/ }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# coding: utf-8
+
+require File.dirname(__FILE__) + '/../lib/hiwai'
+
+Dir[File.dirname(__FILE__) + '/support/*'].each {|f| require f }
+
+RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+  config.include ExampleGroupHelper
+end

data/spec/support/example_group_helper.rb

@@ -0,0 +1,7 @@
+# coding: utf-8
+
+module ExampleGroupHelper
+  def censored
+    Base64.decode64('PDzjgajjgabjgoLljZHnjKXjgarmloflrZfliJc+Pg==').force_encoding('utf-8')
+  end
+end

data/vendor/hiwai.txt

@@ -0,0 +1,2 @@
+PDzjgajjgabjgoLljZHnjKXjgarmloflrZfliJc+Pg==
+PDzjgojjgY/jgarjgYTmloflrZfliJc+Pg==

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: hiwai
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- hibariya
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70155429296240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70155429296240
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70155429295720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70155429295720
+description: detect hiwai string in japanese
+email:
+- celluloid.key@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hiwai.gemspec
+- lib/hiwai.rb
+- lib/hiwai/masked.rb
+- lib/hiwai/object.rb
+- lib/hiwai/version.rb
+- spec/hiwai_spec.rb
+- spec/spec_helper.rb
+- spec/support/example_group_helper.rb
+- vendor/hiwai.txt
+homepage: https://github.com/hibariya/hiwai
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: detect hiwai string
+test_files:
+- spec/hiwai_spec.rb
+- spec/spec_helper.rb
+- spec/support/example_group_helper.rb