jkproof 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5b40a5b66b05016fe7f0e165aa934a276a161a2135512a5d19e0ea51d805e58
-  data.tar.gz: 830c43770bed8434d4f57626f4b564a056022b28e25b9df8fadf9effdccc3811
+  metadata.gz: 0addda3ea12086f43d3170f5e24aae959c91c6c37b6ef2a493f2308c4cb0650c
+  data.tar.gz: 88f34a95526329f102c061f9f6cc99568437b36257a70724f18435b87b89344c
 SHA512:
-  metadata.gz: 5785d7aa4b1dced88f426151ddfc29c765340219d46693b84f606a5da65ecbc1a1858907ec02e8edcffe6e755aefad95c92b92927b29fc4ea3560d64a508e9e2
-  data.tar.gz: af5c999b529a289c52419595f8466afcb92cfb9f0d051e84245227734fb589f5b62d8c59443b52f9d33150ac0f140a76d96b96d9d021247c00f73a3f8edee9cd
+  metadata.gz: 82beac07b25fa4677d459301af44475d03ffafdb1fcf31e550fd81eb63c95726db6d81551c1dcac0ca45ea098cc0746a357bffecae5c1a91f91644ecbe0d21ac
+  data.tar.gz: 87bcf0b06d7dc56fe73ebc658abc95d990e2f97cbdb2859c0c5e2f9abbb6b2e779819442a133377fc8b192e289e8e991347bd53f07181e2aad624f8c479bde68

data/.env.sample

@@ -0,0 +1,2 @@
+YAHOO_API_KEY="ref: https://e.developer.yahoo.co.jp/dashboard/"
+DICTIONARY_YML_PATH="your own dicionary file(ex: ./spec/dictionary.yml)"

data/.gitignore

@@ -7,6 +7,7 @@
 /spec/reports/
 /tmp/
 /vendor
+.env
 
 # rspec failure tracking
 .rspec_status

data/Gemfile.lock

@@ -2,6 +2,10 @@ PATH
   remote: .
   specs:
     jkproof (0.1.0)
+      activesupport
+      dotenv
+      highline
+      xml-simple
 
 GEM
   remote: https://rubygems.org/
@@ -13,6 +17,8 @@ GEM
       tzinfo (~> 1.1)
     concurrent-ruby (1.1.4)
     diff-lcs (1.3)
+    dotenv (2.5.0)
+    highline (2.0.0)
     i18n (1.3.0)
       concurrent-ruby (~> 1.0)
     minitest (5.11.3)
@@ -39,12 +45,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport
   bundler (~> 1.17)
   jkproof!
   rake (~> 10.0)
   rspec (~> 3.0)
-  xml-simple
 
 BUNDLED WITH
    1.17.1

data/README.md

@@ -1,6 +1,6 @@
-# Maoproof
+# [Jkproof](https://rubygems.org/gems/jkproof)
 
-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/maoproof`. To experiment with that code, run `bin/console` for an interactive prompt.
+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
 
@@ -9,7 +9,7 @@ TODO: Delete this and the text above, and describe your gem
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'maoproof'
+gem 'jkproof'
 ```
 
 And then execute:
@@ -18,11 +18,55 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install maoproof
+    $ gem install jkproof
+
+### `dictionary.yml` を任意の場所に追加する
+
+`config/dictionary.yml` など、好きな場所に辞書ファイルを準備します。  
+
+**config/dictionary.yml**  
+```yml
+word1:
+  correct : correct_word_1
+  wrongs  :
+    word1 : wrong-word-1
+    word2 : WrongWord1
+word2:
+  correct : CorrectWord2
+  wrongs  :
+    word1 : wrong_word_2
+    word1 : wrongword2
+```
+
+一つの単号に対して、誤りのある単語を複数追加できます。
+
+必ず文字数が多いものから降順になるように並べてください。
+
+```yml
+# いい例
+wrongs  :
+  word1 : wrong-word-1
+  word2 : WrongWord1
+  word3 : Wrong1
+
+# 悪い例
+wrongs  :
+  word1 : Wrong1
+  word2 : WrongWord1
+  word3 : wrong-word-1
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# 検出された場合
+Jkproof.detect_words_has_error("検知したい文章", "config/dictionary.yml")
+# => [{ wrong: WrongWord, correct:CorrectWord }]
+
+# 検出されなかった場合
+Jkproof.detect_words_has_error("", "config/dictionary.yml")
+# => []
+```
 
 ## Development
 
@@ -32,4 +76,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]/maoproof.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jkproof.

data/jkproof.gemspec

@@ -7,9 +7,8 @@ Gem::Specification.new do |spec|
   spec.version       = Jkproof::VERSION
   spec.authors       = ['tosite']
   spec.email         = ['tl091264@gmail.com']
-
-  spec.summary       = 'test.'
-  spec.description   = 'test.'
+  spec.summary       = 'This performs sentence proofreading using a dictionary.yml.'
+  spec.description   = 'This performs sentence proofreading using a dictionary.yml.'
   spec.homepage      = 'https://github.com/tosite0345/jkproof'
 
   # spec.summary       = %q{TODO: Write a short summary, because RubyGems requires one.}
@@ -41,7 +40,8 @@ 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_runtime_dependency 'active_support'
-  spec.add_development_dependency 'activesupport'
-  spec.add_development_dependency 'xml-simple'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'xml-simple'
+  spec.add_dependency 'dotenv'
+  spec.add_dependency 'highline'
 end

data/lib/jkproof/sentence.rb

@@ -2,12 +2,16 @@ module Jkproof
   class Sentence
     require 'yaml'
     require 'uri'
+    require 'dotenv'
     require 'net/https'
     require 'active_support'
     require 'active_support/core_ext'
 
-    def initialize(buf, yml_path)
-      @dictionary_words = YAML.load_file(yml_path)
+    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
       fetch_yahoo_lint_words
@@ -36,13 +40,16 @@ module Jkproof
     private
 
     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/)"
+      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)
       http.use_ssl = true
       reqest       = Net::HTTP::Post.new(uri.path)
       reqest.set_form_data(
-        appid: 'dj00aiZpPXM0WksyN2NJaHhCZSZzPWNvbnN1bWVyc2VjcmV0Jng9ZTk-',
+        appid: @yahoo_api_key,
         sentence: @buf,
         no_filter: '11'
         # no_filter: "11,12,14,15"
@@ -52,8 +59,6 @@ module Jkproof
         [Hash.from_xml(s)['ResultSet']['Result']].flatten.each do |r|
           next unless r['Surface']
           next unless r['ShitekiWord']
-
-          # p r
           @yahoo_words.push(correct: r['ShitekiWord'], wrong: r['Surface'])
         end
       end

data/lib/jkproof/version.rb

@@ -1,3 +1,3 @@
 module Jkproof
-  VERSION = '0.1.0'.freeze
+  VERSION = '1.0.0' # バージョンアップ
 end

data/lib/jkproof.rb

@@ -1,16 +1,11 @@
 require 'jkproof/version'
 require 'jkproof/sentence'
-require 'yaml'
-require 'uri'
-require 'net/https'
-require 'active_support'
-require 'active_support/core_ext'
 
 module Jkproof
   class Error < StandardError; end
 
-  def self.detect_words_has_error(sentence, dictionary_yml_path)
-    obj = Sentence.new(sentence, dictionary_yml_path)
+  def self.detect_words_has_error(sentence)
+    obj = Sentence.new(sentence)
     obj.fetch_wrong_words
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jkproof
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - tosite
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-28 00:00:00.000000000 Z
+date: 2018-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,7 +59,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -73,20 +73,49 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: test.
+description: This performs sentence proofreading using a dictionary.yml.
 email:
 - tl091264@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -126,5 +155,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: test.
+summary: This performs sentence proofreading using a dictionary.yml.
 test_files: []