pronto-spell 0.6.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 30fc7a9b7901c64d7406fdeedd2b868837f72fdd
-  data.tar.gz: 61c331d95672195dd274e4e520f2852668d08a13
+SHA256:
+  metadata.gz: 07f54bc81dcc96ab8d9fa447d718925489a274569836eac59e70863774bdcf01
+  data.tar.gz: bc02b4e4e5466fb1c3a129c31e7dfa0b494d462772246d7f3849266c9c192e8d
 SHA512:
-  metadata.gz: 501ebce54992da0b63934f268f0e1d6adacd026301d4f901e3669ca9dd7b64233dd4355eee1bed9cc5aef80131d5e450ff35f6c234b9155d16fac6c92bf99b7d
-  data.tar.gz: f3b2fe277ab7aae01d4822bea8061701a3c45b9b9edf48463b3e001128a681fc0deb8eb7b4e8f4e613407bf8564baddd1ed025b38d0cc95bbdc3b9ab512d3c5a
+  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/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2016 Mindaugas Mozūras
+Copyright (c) 2017 Mindaugas Mozūras
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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,34 @@ 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
+language: 'en_US' # 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
+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:
+```YAML
+spell:
+  exclude:
+    - 'yarn.lock'
+    - 'Gemfile.lock'
+    - 'Gemfile'
+    - 'package.json'
+    - '.*.yml'
+    - '*.json'
+```

data/lib/pronto/spell.rb

@@ -1,22 +1,46 @@
+# frozen_string_literal: true
+
 require 'pronto'
 require 'ffi/aspell'
 
 module Pronto
   class Spell < Runner
+    CONFIG_FILE = '.pronto_spell.yml'
+
+    def ignored_words
+      @ignored_words ||= begin
+        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
+
     def run
-      return [] unless @patches
+      return [] if !@patches || @patches.count.zero?
 
-      @patches.select { |patch| patch.additions > 0 }
+      @patches
+        .select { |patch| patch.additions.positive? }
         .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) }
+        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
+
+        words
+          .select { |word| misspelled?(word) }
           .map { |word| new_message(word, line) }
       end
     end
@@ -26,17 +50,60 @@ 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.)
+      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)
     end
 
     def speller
-      @speller ||= begin
-        result = FFI::Aspell::Speller.new('en_US')
-        result.suggestion_mode = 'fast'
-        result
+      @speller ||= FFI::Aspell::Speller.new(
+        language, '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 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
+
+    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,7 @@
+# frozen_string_literal: true
+
 module Pronto
   module SpellVersion
-    VERSION = '0.6.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'
@@ -10,11 +10,11 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.author = 'Mindaugas Mozūras'
   s.email = 'mindaugas.mozuras@gmail.com'
-  s.homepage = 'http://github.org/mmozuras/pronto-spell'
+  s.homepage = 'https://github.com/mmozuras/pronto-spell'
   s.summary = 'Pronto runner that uses Aspell for spell checking'
 
   s.licenses = ['MIT']
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.3.0'
   s.rubygems_version = '1.8.23'
 
   s.files = `git ls-files`.split($RS).reject do |file|
@@ -32,9 +32,9 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ['LICENSE', 'README.md']
   s.require_paths = ['lib']
 
-  s.add_dependency('pronto', '~> 0.6.0')
   s.add_dependency('ffi-aspell', '~> 1.1.0')
-  s.add_development_dependency('rake', '~> 11.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')
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: pronto-spell
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Mindaugas Mozūras
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-14 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.6.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -88,12 +88,14 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
+- ".github/CODEOWNERS"
+- ".github/workflows/checks.yml"
 - LICENSE
 - README.md
 - lib/pronto/spell.rb
 - lib/pronto/spell/version.rb
 - pronto-spell.gemspec
-homepage: http://github.org/mmozuras/pronto-spell
+homepage: https://github.com/mmozuras/pronto-spell
 licenses:
 - MIT
 metadata: {}
@@ -105,15 +107,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Pronto runner that uses Aspell for spell checking