pronto-spell 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1f4b64675918e0fa51a628c161e4bbbaf774fca7a1f6508e22d4b9f8f7e8402
-  data.tar.gz: 6b6a768dd4ac49a4762334b68d3d8507af3f23567eac72372fcdb6c2c86a9ad8
+  metadata.gz: 07f54bc81dcc96ab8d9fa447d718925489a274569836eac59e70863774bdcf01
+  data.tar.gz: bc02b4e4e5466fb1c3a129c31e7dfa0b494d462772246d7f3849266c9c192e8d
 SHA512:
-  metadata.gz: 3a0a4d6c9e9eacc0e35fcd3263ae89c00d189b1fc0366666195cdbfe1a01ceb07efe7235eca8516d53cc7a489cb242c414bc3a18df671107907c86b580fe39e7
-  data.tar.gz: 557c522a42ae028a0c9db1d5a25267ed07c6b70f17264f815fec6020ee2433257834eda90a5f6db5495a6f92e0faa0bf7b42b9ccd67ad32621363c5754ae558c
+  metadata.gz: 46455fa1baafe659fe69c14a9db5a7803af4315e76ab9e340a67fce8f699a8bea215a0ebfae9750a401ce2a716d0a50dfaecdb06353bd35c39b07f126c3345ef
+  data.tar.gz: bfa0787135e7fcb72c54d021bb1d4d2c725f8c5602c9d0f4da8245d64208d22e2b5696dde5291366079163c3734022313a520e48188b38cc4cff5cb02b6f903d

data/.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# Order is important. The last matching pattern takes the most precedence.
+# Default owners for everything in the repo.
+* @prontolabs/core

data/.github/workflows/checks.yml

@@ -0,0 +1,22 @@
+name: Checks
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  ruby:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.3', '2.4', '2.5', '2.6', '2.7', '3.0']
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: rake spec
+      run: bundle exec rake spec

data/README.md

@@ -20,6 +20,7 @@ In order to change configuration, you need to create `.pronto_spell.yaml` file i
 
 ```YAML
 suggestion_mode: 'fast' # default
+language: 'en_US' # default
 min_word_length: 5 # default
 max_word_length: 999 # default is Infinity
 max_suggestions_number: 3 # default
@@ -27,6 +28,9 @@ ignored_words: # words in this list won't be marked as misspelled
   - aspell
   - boolean
   - datetime
+only_lines_matching: # spell checker will run only if the diff contains a word in this list
+  - context
+  - describe
 ```
 
 It's also handy to have `.pronto.yml`. Here is configuration, designed for rails project:

data/lib/pronto/spell.rb

@@ -1,14 +1,21 @@
+# frozen_string_literal: true
+
 require 'pronto'
 require 'ffi/aspell'
 
 module Pronto
   class Spell < Runner
-    CONFIG_FILE = '.pronto_spell.yml'.freeze
+    CONFIG_FILE = '.pronto_spell.yml'
 
     def ignored_words
       @ignored_words ||= begin
-        words = (spelling_config['ignored_words'] || []).map(&:downcase)
-        Set.new(words)
+        Set.new(spelling_config['ignored_words'].to_a.map(&:downcase))
+      end
+    end
+
+    def keywords
+      @keywords ||= begin
+        Set.new(spelling_config['only_lines_matching'].to_a.map(&:downcase))
       end
     end
 
@@ -16,7 +23,7 @@ module Pronto
       return [] if !@patches || @patches.count.zero?
 
       @patches
-        .select { |patch| patch.additions > 0 }
+        .select { |patch| patch.additions.positive? }
         .map { |patch| inspect(patch) }
         .flatten.compact
     end
@@ -25,6 +32,10 @@ module Pronto
 
     def inspect(patch)
       patch.added_lines.map do |line|
+        if keywords.any? && !keywords_regexp.match(line.content)
+          next
+        end
+
         words = line.content.scan(/([A-Z]{2,})|([A-Z]{0,1}[a-z]+)/)
           .flatten.compact.uniq
 
@@ -41,8 +52,9 @@ module Pronto
       suggestions = speller.suggestions(word)
 
       msg = %("#{word}" might not be spelled correctly.)
-      unless suggestions.empty?
-        msg += " Spelling suggestions: #{suggestions[0..2].join(', ')}"
+      if suggestions.any?
+        suggestions_text = suggestions[0..max_suggestions_number - 1].join(', ')
+        msg += " Spelling suggestions: #{suggestions_text}"
       end
 
       Message.new(path, line, level, msg, nil, self.class)
@@ -50,7 +62,7 @@ module Pronto
 
     def speller
       @speller ||= FFI::Aspell::Speller.new(
-        'en_US', :'sug-mode' => suggestion_mode
+        language, 'sug-mode': suggestion_mode
       )
     end
 
@@ -61,6 +73,14 @@ module Pronto
       end
     end
 
+    def keywords_regexp
+      @keywords_regexp ||= %r{#{keywords.to_a.join('|')}}
+    end
+
+    def language
+      spelling_config['language'] || 'en_US'
+    end
+
     def suggestion_mode
       spelling_config['suggestion_mode'] || 'fast'
     end

data/lib/pronto/spell/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Pronto
   module SpellVersion
-    VERSION = '0.10.0'.freeze
+    VERSION = '0.11.0'
   end
 end

data/pronto-spell.gemspec

@@ -1,8 +1,8 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
-require 'English'
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'pronto/spell/version'
+require 'English'
 
 Gem::Specification.new do |s|
   s.name = 'pronto-spell'
@@ -32,8 +32,8 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ['LICENSE', 'README.md']
   s.require_paths = ['lib']
 
-  s.add_dependency('pronto', '~> 0.10.0')
   s.add_dependency('ffi-aspell', '~> 1.1.0')
+  s.add_dependency('pronto', '~> 0.11.0')
   s.add_development_dependency('rake', '~> 12.0')
   s.add_development_dependency('rspec', '~> 3.4')
   s.add_development_dependency('rspec-its', '~> 1.2')

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: pronto-spell
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Mindaugas Mozūras
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-03 00:00:00.000000000 Z
+date: 2021-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pronto
+  name: ffi-aspell
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: ffi-aspell
+  name: pronto
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +88,8 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
+- ".github/CODEOWNERS"
+- ".github/workflows/checks.yml"
 - LICENSE
 - README.md
 - lib/pronto/spell.rb
@@ -112,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Pronto runner that uses Aspell for spell checking