pronto-spell 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b48a03947913a699f51a206f08c8c08e98d77e7e
-  data.tar.gz: 9c91c12ce5c3c44fa8734bcf2c25a0ab49f97c88
+SHA256:
+  metadata.gz: d1f4b64675918e0fa51a628c161e4bbbaf774fca7a1f6508e22d4b9f8f7e8402
+  data.tar.gz: 6b6a768dd4ac49a4762334b68d3d8507af3f23567eac72372fcdb6c2c86a9ad8
 SHA512:
-  metadata.gz: 7bd867909c671bc2128151eb7e459480a7dc5e0c7729120792784d655d45a1a524cb5a382aced39b4c1f4b5b36b3d9d3886a78107afd066f95a9791a5bbec5b9
-  data.tar.gz: d81acc29bc13733138f598a36e8770099c5a756322c70119d9ead32b418aadff4124f0e4ad35fda29e0b4e7092e9624d283d23002b6a2882ff26fa36bc20c239
+  metadata.gz: 3a0a4d6c9e9eacc0e35fcd3263ae89c00d189b1fc0366666195cdbfe1a01ceb07efe7235eca8516d53cc7a489cb242c414bc3a18df671107907c86b580fe39e7
+  data.tar.gz: 557c522a42ae028a0c9db1d5a25267ed07c6b70f17264f815fec6020ee2433257834eda90a5f6db5495a6f92e0faa0bf7b42b9ccd67ad32621363c5754ae558c

data/README.md

@@ -1,11 +1,11 @@
 # Pronto runner that uses Aspell for spell checking
 
-[![Code Climate](https://codeclimate.com/github/mmozuras/pronto-spell.png)](https://codeclimate.com/github/mmozuras/pronto-spell)
-[![Build Status](https://travis-ci.org/mmozuras/pronto-spell.png)](https://travis-ci.org/mmozuras/pronto-spell)
+[![Code Climate](https://codeclimate.com/github/prontolabs/pronto-spell.png)](https://codeclimate.com/github/prontolabs/pronto-spell)
+[![Build Status](https://travis-ci.org/prontolabs/pronto-spell.png)](https://travis-ci.org/prontolabs/pronto-spell)
 [![Gem Version](https://badge.fury.io/rb/pronto-spell.png)](http://badge.fury.io/rb/pronto-spell)
-[![Dependency Status](https://gemnasium.com/mmozuras/pronto-spell.png)](https://gemnasium.com/mmozuras/pronto-spell)
+[![Dependency Status](https://gemnasium.com/prontolabs/pronto-spell.png)](https://gemnasium.com/prontolabs/pronto-spell)
 
-Pronto runner that uses [Aspell](https://github.com/YorickPeterse/ffi-aspell) for spell checking. [What is Pronto?](https://github.com/mmozuras/pronto)
+Pronto runner that uses [Aspell](https://github.com/YorickPeterse/ffi-aspell) for spell checking. [What is Pronto?](https://github.com/prontolabs/pronto)
 
 ## Prerequisites
 
@@ -13,3 +13,30 @@ You'll need to install Aspell:
 
 * Arch Linux: `sudo pacman -S aspell`
 * OS X: (`brew install aspell --lang=en`)
+
+## Configuration
+
+In order to change configuration, you need to create `.pronto_spell.yaml` file in your project root directory. Awailable options are:
+
+```YAML
+suggestion_mode: 'fast' # default
+min_word_length: 5 # default
+max_word_length: 999 # default is Infinity
+max_suggestions_number: 3 # default
+ignored_words: # words in this list won't be marked as misspelled
+  - aspell
+  - boolean
+  - datetime
+```
+
+It's also handy to have `.pronto.yml`. Here is configuration, designed for rails project:
+```YAML
+spell:
+  exclude:
+    - 'yarn.lock'
+    - 'Gemfile.lock'
+    - 'Gemfile'
+    - 'package.json'
+    - '.*.yml'
+    - '*.json'
+```

data/lib/pronto/spell.rb

@@ -3,20 +3,33 @@ require 'ffi/aspell'
 
 module Pronto
   class Spell < Runner
+    CONFIG_FILE = '.pronto_spell.yml'.freeze
+
+    def ignored_words
+      @ignored_words ||= begin
+        words = (spelling_config['ignored_words'] || []).map(&:downcase)
+        Set.new(words)
+      end
+    end
+
     def run
-      return [] unless @patches
+      return [] if !@patches || @patches.count.zero?
 
-      @patches.select { |patch| patch.additions > 0 }
+      @patches
+        .select { |patch| patch.additions > 0 }
         .map { |patch| inspect(patch) }
         .flatten.compact
     end
 
+    private
+
     def inspect(patch)
       patch.added_lines.map do |line|
-        words = line.content.scan(/[0-9a-zA-Z]+/)
-        words.select { |word| word.length > 4 }
-          .uniq
-          .select { |word| !speller.correct?(word) }
+        words = line.content.scan(/([A-Z]{2,})|([A-Z]{0,1}[a-z]+)/)
+          .flatten.compact.uniq
+
+        words
+          .select { |word| misspelled?(word) }
           .map { |word| new_message(word, line) }
       end
     end
@@ -26,17 +39,51 @@ module Pronto
       level = :warning
 
       suggestions = speller.suggestions(word)
-      msg = "#{word} might not be spelled correctly. Spelling suggestions: #{suggestions}"
+
+      msg = %("#{word}" might not be spelled correctly.)
+      unless suggestions.empty?
+        msg += " Spelling suggestions: #{suggestions[0..2].join(', ')}"
+      end
 
       Message.new(path, line, level, msg, nil, self.class)
     end
 
     def speller
-      @speller ||= begin
-        result = FFI::Aspell::Speller.new('en_US')
-        result.suggestion_mode = 'fast'
-        result
+      @speller ||= FFI::Aspell::Speller.new(
+        'en_US', :'sug-mode' => suggestion_mode
+      )
+    end
+
+    def spelling_config
+      @spelling_config ||= begin
+        config_path = File.join(repo_path, CONFIG_FILE)
+        File.exist?(config_path) ? YAML.load_file(config_path) : {}
       end
     end
+
+    def suggestion_mode
+      spelling_config['suggestion_mode'] || 'fast'
+    end
+
+    def min_word_length
+      spelling_config['min_word_length'] || 5
+    end
+
+    def max_word_length
+      spelling_config['max_word_length'] || Float::INFINITY
+    end
+
+    def max_suggestions_number
+      spelling_config['max_suggestions_number'] || 3
+    end
+
+    def misspelled?(word)
+      lintable_word?(word) && !speller.correct?(word)
+    end
+
+    def lintable_word?(word)
+      (min_word_length..max_word_length).cover?(word.length) &&
+        !ignored_words.include?(word.downcase)
+    end
   end
 end

data/lib/pronto/spell/version.rb

@@ -1,5 +1,5 @@
 module Pronto
   module SpellVersion
-    VERSION = '0.9.0'.freeze
+    VERSION = '0.10.0'.freeze
   end
 end

data/pronto-spell.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.summary = 'Pronto runner that uses Aspell for spell checking'
 
   s.licenses = ['MIT']
-  s.required_ruby_version = '>= 2.0.0'
+  s.required_ruby_version = '>= 2.3.0'
   s.rubygems_version = '1.8.23'
 
   s.files = `git ls-files`.split($RS).reject do |file|
@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ['LICENSE', 'README.md']
   s.require_paths = ['lib']
 
-  s.add_dependency('pronto', '~> 0.9.0')
+  s.add_dependency('pronto', '~> 0.10.0')
   s.add_dependency('ffi-aspell', '~> 1.1.0')
   s.add_development_dependency('rake', '~> 12.0')
   s.add_development_dependency('rspec', '~> 3.4')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pronto-spell
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Mindaugas Mozūras
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-23 00:00:00.000000000 Z
+date: 2019-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pronto
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: ffi-aspell
   requirement: !ruby/object:Gem::Requirement
@@ -105,15 +105,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Pronto runner that uses Aspell for spell checking