jkproof 1.1.3 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2928cc7b5794c0a9204c9e1a18de9480d410c6fbd32f41560af28cf5a9184f86
-  data.tar.gz: a90fe135a4b9eaa3cc3d78d13b6ec0d5e27160c100b8f37afea9e92e252d04d6
+  metadata.gz: cee32de691a9c30a7e5d4fb319128f7d1827650c8810e3c02194cbe268794301
+  data.tar.gz: 5db6b4644f9345b152162b592bbd6ecdf4aa2c716e394bfaaaf1aafea8cdb921
 SHA512:
-  metadata.gz: 96d4a39be90ab7d1a131c6f7663a031418d000fbe7e70ce835dc326856ea8b2f5f333799656b4d30b64c8cc912e2de89bb2350f99e1ed6706e201b87b368c7aa
-  data.tar.gz: da0d75018ca32cac561798766fc8f6764d242b89c39f061410f37c05f30185dc05f924a8147f41980007c0a2c3cede0c8626c6493ea056a4dae5810b8e7dbab1
+  metadata.gz: c92b5916cdecd22ef8010a6f0cce2705dc4b8cdf1d35cccd4862917674fe230d63dda3bacf25603061f6669bb0da55ca0b483a3f0dc2846ddda8125124cfb183
+  data.tar.gz: b654be09edc8ae6fc88f400c2fead7507f7a919359c3c98e26d9dbf72c34df7f7fa571102861857c79e965d539f52dfd4c54387f498ffe36cd640783a4ac2f48

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # ChangeLog
 
+## v1.2.2
+- JSON形式に対応した
+  - `Jkproof.detect_words_has_error(sentence, json_dictionary)` のように第二引数にJSONデータを渡すことで対応可能
+- `type` の `local` を `yml` と `json` に細分化した
+
 ## v1.1.3
 - 表記揺らぎのある用語が複数個あった場合にすべて表示されないバグの修正
   - 例：`"問合せ／問い合わせ／問い合せ" => [{wrong: "問い合わせ" correct: "お問い合わせ"}]`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jkproof (1.1.3)
+    jkproof (1.2.0)
       activesupport
       dotenv
       highline
@@ -17,9 +17,9 @@ GEM
       tzinfo (~> 1.1)
     concurrent-ruby (1.1.4)
     diff-lcs (1.3)
-    dotenv (2.5.0)
+    dotenv (2.6.0)
     highline (2.0.0)
-    i18n (1.3.0)
+    i18n (1.5.1)
       concurrent-ruby (~> 1.0)
     minitest (5.11.3)
     rake (10.5.0)

data/README.md

@@ -29,34 +29,57 @@ Or install it yourself as:
 
 **config/dictionary.yml**  
 ```yml
-word1:
+-
   correct : correct_word_1
   wrongs  :
-    word1 : wrong-word-1
-    word2 : WrongWord1
-word2:
+    - wrong-word-1
+    - WrongWord1
+-
   correct : CorrectWord2
   wrongs  :
-    word1 : wrong_word_2
-    word1 : wrongword2
+    - wrong_word_2
+    - wrongword2
 ```
 
 一つの単号に対して、誤りのある単語を複数追加できます。
 
 必ず文字数が多いものから降順になるように並べてください。
 
+
 ```yml
 # いい例
 wrongs  :
-  word1 : wrong-word-1
-  word2 : WrongWord1
-  word3 : Wrong1
+  - wrong-word-1
+  - WrongWord1
+  - Word1
 
 # 悪い例
 wrongs  :
-  word1 : Wrong1
-  word2 : WrongWord1
-  word3 : wrong-word-1
+  - Word1
+  - WrongWord1
+  - wrong-word-1
+# 悪い例では文章に "WrongWord1" が与えられた場合、 "Word1" を返してしまう
+```
+
+### JSONデータを用意する場合
+
+```json
+[
+  {
+    "correct" : "correct-json-word-1",
+    "wrongs" : [
+      "wrong_json_word_1",
+      "WrongJsonWord1"
+    ]
+  },
+  {
+    "correct" : "correct-json-word-2",
+    "wrongs" : [
+      "WrongJson2",
+      "Wrong2"
+    ]
+  }
+]
 ```
 
 ### Yahoo APIキーを生成する
@@ -70,23 +93,35 @@ https://e.developer.yahoo.co.jp/dashboard/ からAPIキーを生成してくだ
 
 **追記する場合**
 
+ref: https://github.com/tosite0345/jkproof/blob/master/.env.sample
+
 ```
 YAHOO_API_KEY=""
 DICTIONARY_YML_PATH=""
+NO_FILTER=""
 ```
 
-先に作成した辞書ファイルのパスを `DICTIONARY_YML_PATH` に、Yahoo APIキーを `YAHPP_API_KEY` にそれぞれ登録してください。
+先に作成した辞書ファイルのパスを `DICTIONARY_YML_PATH` に、Yahoo APIキーを `YAHOO_API_KEY` にそれぞれ登録してください。
+
+`NO_FILTER` を設定することで検出する精度を調整することができます。  
+設定値については [こちら](https://developer.yahoo.co.jp/webapi/jlp/kousei/v1/kousei.html) のno_filterをご覧ください。
+
+なお、複数の除外項目を設定する場合は `NO_FILTER="11,12,13"` のようにカンマ区切りの文字列で指定するようお願いいたします。
 
 ## Usage
 
 ```ruby
 # 検出された場合
 Jkproof.detect_words_has_error("検知したい文章")
-# => [{ wrong: WrongWord, correct:CorrectWord }]
+# => [{ type: "yml", wrong: WrongWord, correct:CorrectWord }]
 
 # 検出されなかった場合
 Jkproof.detect_words_has_error("")
 # => []
+
+# JSONを渡す場合
+Jkproof.detect_words_has_error("検知したい文章", json_dictionary)
+# => [{ type: "json", wrong: WrongWord, correct:CorrectWord }]
 ```
 
 ## Development

data/jkproof.gemspec

@@ -9,9 +9,15 @@ Gem::Specification.new do |spec|
   spec.version       = Jkproof::VERSION
   spec.authors       = ['tosite']
   spec.email         = ['tl091264@gmail.com']
-  spec.summary       = 'This performs sentence proofreading using a dictionary.yml.'
-  spec.description   = 'This performs sentence proofreading using a dictionary.yml.'
+  spec.summary       = 'This performs sentence proofreading using a dictionary.yml or JSON.'
+  spec.description   = <<-EOF
+  This performs sentence proofreading using a dictionary.yml.
+  Alternatively, by passing dictionary data in JSON format, we return an error word as an array.
+  ex1.use yml)  Jkproof.detect_words_has_error(sentence)
+  ex2.use JSON) Jkproof.detect_words_has_error(sentence, json)
+  EOF
   spec.homepage      = 'https://github.com/tosite0345/jkproof'
+  spec.license       = "MIT"
 
   # spec.summary       = %q{TODO: Write a short summary, because RubyGems requires one.}
   # spec.description   = %q{TODO: Write a longer description or delete this line.}
@@ -42,8 +48,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.17'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_dependency 'activesupport'
-  spec.add_dependency 'dotenv'
-  spec.add_dependency 'highline'
-  spec.add_dependency 'xml-simple'
+  spec.add_dependency 'activesupport', '~> 5.2'
+  spec.add_dependency 'dotenv', '~> 2.6'
+  spec.add_dependency 'xml-simple', '~> 1.1'
 end

data/lib/jkproof/sentence.rb

@@ -9,17 +9,13 @@ module Jkproof
     require 'active_support'
     require 'active_support/core_ext'
 
-    def initialize(buf)
+    def initialize(buf, json_dictionary)
       Dotenv.load
-      yml_path       = ENV['DICTIONARY_YML_PATH']
       @yahoo_api_key = ENV['YAHOO_API_KEY']
       @no_filter     = ENV['NO_FILTER'].blank? ? '' : ENV['NO_FILTER']
 
-      begin
-        @dictionary_words = yml_path.blank? ? [] : YAML.load_file(yml_path)
-      rescue StandardError => e
-        raise "#{e}(file_path: '#{yml_path}')"
-      end
+      set_dictionary(json_dictionary)
+
       @yahoo_words = []
       @buf         = buf
       fetch_yahoo_lint_words
@@ -35,7 +31,7 @@ module Jkproof
         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(type: 'local', correct: word['correct'], wrong: wrong)
+            wrong_words.push(type: @type, correct: word['correct'], wrong: wrong)
             excluded_correct_word = excluded_correct_word.gsub(wrong, '####')
           end
         end
@@ -47,7 +43,7 @@ module Jkproof
         correct_word = word['correct']
         word['wrongs'].each do |wrong|
           if excluded_correct_word.include?(wrong)
-            wrong_words.push(type: 'local', wrong: wrong, correct: correct_word)
+            wrong_words.push(type: @type, wrong: wrong, correct: correct_word)
             excluded_correct_word = excluded_correct_word.gsub(wrong, '####')
           end
         end
@@ -57,6 +53,24 @@ module Jkproof
 
     private
 
+    def set_dictionary(json_dictionary)
+      # JSON形式で辞書データが送られてきた場合
+      unless json_dictionary.blank?
+        @type = 'json'
+        @dictionary_words = json_dictionary
+        return
+      end
+
+      # ローカルの辞書データを使う場合
+      yml_path = ENV['DICTIONARY_YML_PATH']
+      begin
+        @type ='yml'
+        @dictionary_words = yml_path.blank? ? [] : YAML.load_file(yml_path)
+      rescue StandardError => e
+        raise "#{e}(file_path: '#{yml_path}')"
+      end
+    end
+
     def fetch_yahoo_lint_words
       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/)"

data/lib/jkproof/version.rb

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

data/lib/jkproof.rb

@@ -6,8 +6,8 @@ require 'jkproof/sentence'
 module Jkproof
   class Error < StandardError; end
 
-  def self.detect_words_has_error(sentence)
-    obj = Sentence.new(sentence)
+  def self.detect_words_has_error(sentence, json_dictionary = '')
+    obj = Sentence.new(sentence, json_dictionary)
     obj.fetch_wrong_words
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jkproof
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.2
 platform: ruby
 authors:
 - tosite
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-07 00:00:00.000000000 Z
+date: 2019-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,59 +56,49 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: dotenv
   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: highline
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: xml-simple
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: This performs sentence proofreading using a dictionary.yml.
+        version: '1.1'
+description: |2
+    This performs sentence proofreading using a dictionary.yml.
+    Alternatively, by passing dictionary data in JSON format, we return an error word as an array.
+    ex1.use yml)  Jkproof.detect_words_has_error(sentence)
+    ex2.use JSON) Jkproof.detect_words_has_error(sentence, json)
 email:
 - tl091264@gmail.com
 executables: []
@@ -132,7 +122,8 @@ files:
 - lib/jkproof/sentence.rb
 - lib/jkproof/version.rb
 homepage: https://github.com/tosite0345/jkproof
-licenses: []
+licenses:
+- MIT
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://twitter.com/mao_sum
@@ -157,5 +148,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: This performs sentence proofreading using a dictionary.yml.
+summary: This performs sentence proofreading using a dictionary.yml or JSON.
 test_files: []