jkproof 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0addda3ea12086f43d3170f5e24aae959c91c6c37b6ef2a493f2308c4cb0650c
-  data.tar.gz: 88f34a95526329f102c061f9f6cc99568437b36257a70724f18435b87b89344c
+  metadata.gz: fc1fc2ca6a94e4111aacb7222c70ec6c502ab1d44d99cf7cb0810f5d689e4737
+  data.tar.gz: 7b2cf8c0abfa848a30c5b5c58952fe08083bbc567479dc04af4c3ca6c582a36c
 SHA512:
-  metadata.gz: 82beac07b25fa4677d459301af44475d03ffafdb1fcf31e550fd81eb63c95726db6d81551c1dcac0ca45ea098cc0746a357bffecae5c1a91f91644ecbe0d21ac
-  data.tar.gz: 87bcf0b06d7dc56fe73ebc658abc95d990e2f97cbdb2859c0c5e2f9abbb6b2e779819442a133377fc8b192e289e8e991347bd53f07181e2aad624f8c479bde68
+  metadata.gz: bdb436cc0c1505c34bf24c684556831a3600b174f0faaf8f7c3255e3a9766cb6df77b54a26e9362698fe55dedee426757f0f1e9866f9f29d50dddd0dfb720d0f
+  data.tar.gz: 4b71c58b834c68fd435812bbe305679cb395f213829a538f789256bb543430e2e8f2c78c33ae1ada357889fe2c255c04f362d35ea37be0b1549528755c119771

data/.env.sample

@@ -1,2 +1,3 @@
 YAHOO_API_KEY="ref: https://e.developer.yahoo.co.jp/dashboard/"
-DICTIONARY_YML_PATH="your own dicionary file(ex: ./spec/dictionary.yml)"
+DICTIONARY_YML_PATH="your own dicionary file(ex: ./spec/dictionary.yml)"
+NO_FILTER="ref: https://developer.yahoo.co.jp/webapi/jlp/kousei/v1/kousei.html #no_filter"

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+# ChangeLog
+
+## v1.1.0
+
+- 辞書ファイルの記述を簡略化できるよう修正した
+- API側の検知レベルを `.env` から調整できるようにした
+- `正しい単語の文字長 < 誤りのある単語の文字長` を検知できるようにした
+
+```ruby
+# dictionary.yml
+# -
+#   correct: word
+#   wrongs:
+#     - words
+
+# 修正前：
+Jkproof.detect_words_has_error("words is wrong.")
+# => []
+
+# 修正後：
+Jkproof.detect_words_has_error("words is wrong.")
+# => [{ correct: "word", wrong: "words" }]
+
+# これは内部的な処理が次のようになっていたため発生していた。
+# 1.正しい単語を除去
+# 2.誤りのある単語を検知
+```
+
+## v1.0.0
+
+- APIキー・辞書ファイルのパス（ `dictionary.yml` ）を `.env` に記述できるようにした 
+
+正式版としてリリース。
+
+## v0.1.0
+プレリリース。

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jkproof (0.1.0)
+    jkproof (1.0.0)
       activesupport
       dotenv
       highline

data/README.md

@@ -1,8 +1,11 @@
+<img src="https://github.com/tosite0345/jkproof/blob/master/docs/logo.png" style="width: 100% !important;">
+
 # [Jkproof](https://rubygems.org/gems/jkproof)
 
+**Author:[@mao_sum](https://twitter.com/mao_sum)**
+
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jkproof`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -56,15 +59,33 @@ wrongs  :
   word3 : wrong-word-1
 ```
 
+### Yahoo APIキーを生成する
+https://e.developer.yahoo.co.jp/dashboard/ からAPIキーを生成してください。
+
+`Client ID` を使用します。
+
+### .envファイルを修正する
+
+`jkproof/.env.sample` をコピーして編集、もしくは既存の `.env` ファイルに追記してください。
+
+**追記する場合**
+
+```
+YAHOO_API_KEY=""
+DICTIONARY_YML_PATH=""
+```
+
+先に作成した辞書ファイルのパスを `DICTIONARY_YML_PATH` に、Yahoo APIキーを `YAHPP_API_KEY` にそれぞれ登録してください。
+
 ## Usage
 
 ```ruby
 # 検出された場合
-Jkproof.detect_words_has_error("検知したい文章", "config/dictionary.yml")
+Jkproof.detect_words_has_error("検知したい文章")
 # => [{ wrong: WrongWord, correct:CorrectWord }]
 
 # 検出されなかった場合
-Jkproof.detect_words_has_error("", "config/dictionary.yml")
+Jkproof.detect_words_has_error("")
 # => []
 ```
 
@@ -76,4 +97,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jkproof.
+Bug reports and pull requests are welcome on GitHub at https://github.com/tosite0345/jkproof.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'jkproof'

data/jkproof.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'jkproof/version'
@@ -17,7 +19,7 @@ Gem::Specification.new do |spec|
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
     # spec.metadata["homepage_uri"] = spec.homepage
     spec.metadata['homepage_uri']    = 'https://github.com/tosite0345/jkproof'
@@ -41,7 +43,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_dependency 'activesupport'
-  spec.add_dependency 'xml-simple'
   spec.add_dependency 'dotenv'
   spec.add_dependency 'highline'
+  spec.add_dependency 'xml-simple'
 end

data/lib/jkproof/sentence.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jkproof
   class Sentence
     require 'yaml'
@@ -9,26 +11,42 @@ module Jkproof
 
     def initialize(buf)
       Dotenv.load
-      yml_path          = ENV["DICTIONARY_YML_PATH"]
-      @yahoo_api_key    = ENV["YAHOO_API_KEY"]
-      @dictionary_words = (yml_path.blank?) ? [] : YAML.load_file(yml_path)
-      @yahoo_words      = []
-      @buf              = buf
+      yml_path       = ENV['DICTIONARY_YML_PATH']
+      @yahoo_api_key = ENV['YAHOO_API_KEY']
+      @no_filter     = ENV['NO_FILTER'].blank? ? '11' : ENV['NO_FILTER']
+
+      begin
+        @dictionary_words = yml_path.blank? ? [] : YAML.load_file(yml_path)
+      rescue StandardError => e
+        raise "#{e}(file_path: '#{yml_path}')"
+      end
+      @yahoo_words = []
+      @buf         = buf
       fetch_yahoo_lint_words
     end
 
     def fetch_wrong_words
-      wrong_words = []
+      wrong_words           = []
+      excluded_correct_word = @buf
 
       # 正しいワードを取り除く
-      @dictionary_words.each do |_key, word|
-        @buf.gsub!(word['correct'], '')
+      @dictionary_words.each do |word|
+        # 誤りのある単語の文字数 > 正しい単語の文字数の場合、先に検知する
+        wrongs = fetch_wrong_words_than_long_correct_word(word['correct'], word['wrongs'])
+        wrongs.each do |wrong|
+          if excluded_correct_word.include?(wrong)
+            wrong_words.push(correct: word['correct'], wrong: wrong)
+            excluded_correct_word = excluded_correct_word.gsub(wrong, '####')
+          end
+        end
+        # 正しいワードを取り除く
+        excluded_correct_word = excluded_correct_word.gsub(word['correct'], '****')
       end
 
-      @dictionary_words.each do |_key, word|
+      @dictionary_words.each do |word|
         correct_word = word['correct']
-        word['wrongs'].each do |_wkey, wrong|
-          if @buf.include?(wrong)
+        word['wrongs'].each do |wrong|
+          if excluded_correct_word.include?(wrong)
             wrong_words.push(wrong: wrong, correct: correct_word)
             break
           end
@@ -43,6 +61,7 @@ module Jkproof
       if @yahoo_api_key.blank? || @yahoo_api_key.size < 10
         raise "There is no Yahoo API Key.Please set API Key in 'jkproof/.env'.(ref: https://e.developer.yahoo.co.jp/dashboard/)"
       end
+
       # ref: http://developer.yahoo.co.jp/webapi/jlp/kousei/v1/kousei.html
       uri          = URI.parse('https://jlp.yahooapis.jp/KouseiService/V1/kousei')
       http         = Net::HTTP.new(uri.host, uri.port)
@@ -51,21 +70,24 @@ module Jkproof
       reqest.set_form_data(
         appid: @yahoo_api_key,
         sentence: @buf,
-        no_filter: '11'
-        # no_filter: "11,12,14,15"
+        no_filter: @no_filter
       )
       s = http.request(reqest).body
       unless Hash.from_xml(s)['ResultSet']['Result'].nil?
         [Hash.from_xml(s)['ResultSet']['Result']].flatten.each do |r|
           next unless r['Surface']
           next unless r['ShitekiWord']
+
           @yahoo_words.push(correct: r['ShitekiWord'], wrong: r['Surface'])
         end
       end
     end
 
-    def remove_correct_word(key, correct_word)
-      @buf.gsub!(correct_word, "[###{key}##]")
+    def fetch_wrong_words_than_long_correct_word(correct_word, wrong_words)
+      return_words = []
+      c_length     = correct_word.length
+      wrong_words.each { |wrong_word| return_words.push(wrong_word) if c_length < wrong_word.length }
+      return_words
     end
   end
 end

data/lib/jkproof/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jkproof
-  VERSION = '1.0.0' # バージョンアップ
+  VERSION = '1.1.0' # バージョンアップ
 end

data/lib/jkproof.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jkproof/version'
 require 'jkproof/sentence'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jkproof
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - tosite
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-31 00:00:00.000000000 Z
+date: 2019-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: xml-simple
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: highline
+  name: xml-simple
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -119,12 +119,14 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docs/logo.png
 - jkproof.gemspec
 - lib/jkproof.rb
 - lib/jkproof/sentence.rb