spellr 0.8.2 → 0.8.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ed59cf5b3c7a98c77565b63809433c16e16e9f6445f911623d8f73aab0a42b3
-  data.tar.gz: 20d9208eb6ee13445bf14bf51ae87ef3e4f034bdaab63e2e45614488dbecf3e1
+  metadata.gz: c9df7410c75a7e4c7ff3b8defecfdd38252571090e5edacbf46e562be7f27d3e
+  data.tar.gz: a7f24ff28fccb5bf4da96891849994442d2d27ad2097bfce246543efd80d1274
 SHA512:
-  metadata.gz: 5b947e61408ed87bc8651f8f608550f8520cfbbcedbe22a7323a6dd385aff59bea8bae48d26812e042386bdd29e2cdfb3bbdcc2f4105ba99af2fe14ba5dd542a
-  data.tar.gz: 6cddbbc490a53949a5656ede17c1330dca3d8d1d94b25a3661dfae6c050116824116468890408dfca87d01b24cfe6946a9b3fe62e0965f79402ab800b3b4a649
+  metadata.gz: a582e1b04c1f5f39637877b1f28c468d89c671bc8675bcadd639206b03753ac1df2c83dda0f88d42fb0f0eda1869a33fbb217e0bea45aaa6abc30e363d35774f
+  data.tar.gz: 60065eb1def72bb64ed99ef1186eb80d2ea9a6ef908e538677ae830747893b30358f7eee3c8d384cc31186366ac3cb546e6522400d5bc43df2a900818d171e86

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# v0.8.7
+- Recognize URL with tilde in path
+
+# v0.8.6
+- `--suppress--file-rules` so you can check files that would usually be ignored
+
+# v0.8.5
+- Single line disable! use `spellr:disable-line` #25
+
+# v0.8.4
+- Update fast_ignore dependency, it's faster now (about 0.5s faster on rails codebase)
+
+# v0.8.3
+- Update fast_ignore dependency fixing symlinks to directories handling.
+
 # v0.8.2
 - Massive test refactor
   - Spellr now only pays attention to Spellr.pwd. Dir.pwd can be whatever

data/README.md

@@ -1,7 +1,7 @@
 # Spellr
 
+[![Build Status](https://travis-ci.com/robotdana/spellr.svg?branch=main)](https://travis-ci.com/robotdana/spellr)
 [![Gem Version](https://badge.fury.io/rb/spellr.svg)](https://rubygems.org/gems/spellr)
-[![Build Status](https://travis-ci.org/robotdana/spellr.svg?branch=master)](https://travis-ci.org/robotdana/spellr)
 
 Spell check your source code for fun and occasionally finding bugs
 
@@ -27,6 +27,8 @@ However, in a programming context spelling things _consistently_ is useful, wher
 
 ## Installation
 
+This is tested against ruby 2.4.0-3.0.0.preview1.
+
 ### With Bundler
 
 Add this line to your application's `Gemfile`:
@@ -175,20 +177,27 @@ Type `e` to add this word to the english wordlist and continue on through the sp
 
 ### Disabling the tokenizer
 
-If the tokenizer finds a word you don't want to add to the wordlist (perhaps it's an intentional example of a typo, or a non-word string not excluded by the heuristic) then place on the lines before and after
+If the tokenizer finds a word you don't want to add to the wordlist (perhaps it's an intentional example of a typo, or a non-word string not excluded by the heuristic) then add any kind of comment containing `spellr:disable-line` to the line.
+```ruby
+open('mispeled_filename.txt') # spellr:disable-line
+```
+
+You can also disable multiple lines, by surrounding the offending code with `spellr:disable` and `spellr:enable`
 ```ruby
 # spellr:disable
-"Test typo of the: teh"
+it "Test typo of the: teh" do
+  fill_in(field, with: "teh")
+end
 # spellr:enable
 ```
 
-This works with any kind of comment, even in the same line
+If your language supports inline comments you can also surround with `spellr:disable` and `spellr:enable` in the same line:
 ```html
 <span><!-- spellr:disable -->nonsenseword<!-- spellr:enable --></span>
 ```
 ## Configuration
 
-Spellr's configuration is a `.spellr.yml` file in your project root. This is combined with the gem defaults defined [here](https://github.com/robotdana/spellr/blob/master/lib/.spellr.yml).
+Spellr's configuration is a `.spellr.yml` file in your project root. This is combined with the gem defaults defined [here](https://github.com/robotdana/spellr/blob/main/lib/.spellr.yml).
 There are top-level keys and per-language keys.
 ```yml
 word_minimum_length: 3 # any words shorter than this will be ignored
@@ -297,6 +306,18 @@ Spellr::RakeTask.generate_task(:spellr, **spellr_arguments)
 task default: :spellr
 ```
 
+## Ignoring the configured patterns
+
+Sometimes you'll want to spell check something that would usually be ignored,
+e.g. `.git/COMMIT_EDITMSG` even though `spellr` ignores the `.git` directory.
+
+For this you can use the `--suppress-file-rules` command line argument.
+```bash
+$ spellr --suppress-file-rules .git/COMMIT_EDITMSG
+```
+
+**Note: This still ignores files outside of the current directory**
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
@@ -310,4 +331,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/robotd
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-Wordlists packaged with this gem have their own licenses, see them in https://github.com/robotdana/spellr/tree/master/wordlists
+Wordlists packaged with this gem have their own licenses, see them in https://github.com/robotdana/spellr/tree/main/wordlists

data/lib/.spellr.yml

@@ -44,6 +44,7 @@ languages:
       - Rakefile
       - config.ru
       - Capfile
+      - .simplecov
     hashbangs:
       - ruby
 

data/lib/spellr/check.rb

@@ -7,6 +7,7 @@ require_relative 'string_format'
 module Spellr
   class Check
     attr_reader :files, :reporter
+
     include StringFormat
 
     def exit_code

data/lib/spellr/cli_options.rb

@@ -28,6 +28,9 @@ module Spellr
           opts.separator('')
           opts.on('--[no-]parallel', 'Run in parallel or not, default --parallel', &method(:parallel_option))
           opts.on('-d', '--dry-run', 'List files to be checked', &method(:dry_run_option))
+          opts.on('-f', '--suppress-file-rules', <<~HELP, &method(:suppress_file_rules))
+            Suppress all configured, default, and gitignore include and exclude patterns
+          HELP
           opts.separator('')
           opts.on('-c', '--config FILENAME', String, <<~HELP, &method(:config_option))
             Path to the config file (default ./.spellr.yml)
@@ -56,6 +59,10 @@ module Spellr
           Spellr.config.checker = Spellr::CheckInteractive unless @parallel_option
         end
 
+        def suppress_file_rules(_)
+          Spellr.config.suppress_file_rules = true
+        end
+
         def config_option(file)
           file = Spellr.pwd.join(file).expand_path
 

data/lib/spellr/column_location.rb

@@ -4,8 +4,8 @@ require_relative 'line_location'
 
 module Spellr
   class ColumnLocation
-    attr_reader :char_offset
-    attr_reader :byte_offset
+    attr_reader :char_offset, :byte_offset
+
     attr_accessor :line_location
 
     def initialize(char_offset: 0, byte_offset: 0, line_location: LineLocation.new)

data/lib/spellr/config.rb

@@ -10,10 +10,11 @@ require 'pathname'
 
 module Spellr
   class Config
-    attr_writer :reporter
-    attr_writer :checker
+    attr_writer :reporter, :checker
+
+    attr_accessor :suppress_file_rules, :dry_run
+
     attr_reader :config_file
-    attr_accessor :dry_run
     alias_method :dry_run?, :dry_run
 
     def initialize
@@ -77,7 +78,7 @@ module Spellr
       Spellr::ConfigValidator.new.valid?
     end
 
-    def reset! # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
+    def reset! # rubocop:disable Metrics/MethodLength
       @config = ConfigLoader.new
       remove_instance_variable(:@languages) if defined?(@languages)
       remove_instance_variable(:@excludes) if defined?(@excludes)

data/lib/spellr/file.rb

@@ -4,25 +4,6 @@ require 'pathname'
 
 module Spellr
   class File < Pathname
-    def self.wrap(file)
-      file.is_a?(Spellr::File) ? file : Spellr::File.new(file)
-    end
-
-    # don't use FastIgnore shebang handling
-    # because i use lots of different FastIgnore instances and each would to open the files.
-    def hashbang
-      @hashbang ||= begin
-        return if extname != ''
-        return unless first_line&.start_with?('#!')
-
-        first_line
-      end
-    end
-
-    def first_line
-      @first_line ||= each_line.first
-    end
-
     def relative_path
       @relative_path ||= relative_path_from(Spellr.pwd)
     end
@@ -34,6 +15,24 @@ module Spellr
       end
     end
 
+    # the bulk of this method is copied from fast_ignore
+    def first_line # rubocop:disable Metrics/MethodLength
+      return @first_line if defined?(@first_line)
+
+      @first_line = nil
+
+      file = ::File.new(to_s)
+      @first_line = file.sysread(25)
+      @first_line += file.sysread(50) until @first_line.include?("\n")
+      file.close
+      @first_line
+    rescue ::EOFError, ::SystemCallError
+      # :nocov:
+      file&.close
+      # :nocov:
+      @first_line
+    end
+
     def read_write
       write(yield read)
     end

data/lib/spellr/file_list.rb

@@ -26,11 +26,20 @@ module Spellr
 
     private
 
+    def configured_rules
+      return { gitignore: false } if Spellr.config.suppress_file_rules
+
+      {
+        ignore_rules: Spellr.config.excludes,
+        include_rules: Spellr.config.includes
+      }
+    end
+
     def fast_ignore # rubocop:disable Metrics/MethodLength
       FastIgnore.new(
-        ignore_rules: Spellr.config.excludes,
-        include_rules: Spellr.config.includes,
+        **configured_rules,
         argv_rules: @patterns,
+        follow_symlinks: true,
         root: Spellr.pwd_s
       )
     end

data/lib/spellr/interactive.rb

@@ -58,7 +58,7 @@ module Spellr
       Process.clock_gettime(Process::CLOCK_MONOTONIC)
     end
 
-    def stdin_getch(legal_chars) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def stdin_getch(legal_chars) # rubocop:disable Metrics/MethodLength
       choice = output.stdin.getch
 
       if legal_chars.include?(choice)

data/lib/spellr/interactive_add.rb

@@ -18,7 +18,7 @@ module Spellr
     end
 
     def languages
-      @languages ||= Spellr.config.languages_for(token.location.file.to_path)
+      @languages ||= Spellr.config.languages_for(token.location.file)
     end
 
     def addable_languages

data/lib/spellr/key_tuner/naive_bayes.rb

@@ -13,10 +13,7 @@ class NaiveBayes
 
   YAML_PATH = File.join(__dir__, 'data.yml')
 
-  attr_reader :feature_set
-  attr_reader :num_classes
-  attr_reader :classes
-  attr_reader :features
+  attr_reader :feature_set, :num_classes, :classes, :features
 
   def initialize(path = YAML_PATH)
     load_from_yaml(path)

data/lib/spellr/language.rb

@@ -7,17 +7,12 @@ require 'fast_ignore'
 
 module Spellr
   class Language
-    attr_reader :name
-    attr_reader :key
+    attr_reader :name, :key
 
-    def initialize(name, key: name[0], includes: [], hashbangs: [], locale: [], addable: true) # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
+    def initialize(name, key: name[0], includes: [], hashbangs: [], locale: [], addable: true) # rubocop:disable Metrics/ParameterLists
       @name = name
       @key = key
-      @includes = includes
-      @hashbangs = hashbangs
-      @hashbang_pattern = unless hashbangs.empty?
-        /\A#!.*\b(?:#{hashbangs.map { |s| Regexp.escape(s) }.join('|')})\b/
-      end
+      @includes = includes + hashbangs.map { |h| "#!:#{h}" }
       @locales = Array(locale)
       @addable = addable
     end
@@ -26,10 +21,6 @@ module Spellr
       @addable
     end
 
-    def matches?(file)
-      matches_includes?(file) || matches_hashbangs?(file)
-    end
-
     def wordlists
       default_wordlists.select(&:exist?)
     end
@@ -41,24 +32,18 @@ module Spellr
       )
     end
 
-    private
-
-    def matches_hashbangs?(file)
-      return @includes.empty? unless @hashbang_pattern
-
-      file = Spellr::File.wrap(file)
-      return unless file.hashbang
+    def matches?(file)
+      return true if @includes.empty?
 
-      @hashbang_pattern.match?(file.hashbang)
+      fast_ignore.allowed?(file.to_s, directory: false, content: file.first_line)
     end
 
-    def matches_includes?(file)
-      return @hashbangs.empty? if @includes.empty?
+    private
 
+    def fast_ignore
       @fast_ignore ||= FastIgnore.new(
         include_rules: @includes, gitignore: false, root: Spellr.pwd_s
       )
-      @fast_ignore.allowed?(file.to_s)
     end
 
     def gem_wordlist

data/lib/spellr/line_location.rb

@@ -4,27 +4,22 @@ require_relative 'file'
 
 module Spellr
   class LineLocation
-    attr_reader :line_number
-    attr_reader :char_offset
-    attr_reader :byte_offset
+    attr_reader :line_number, :char_offset, :byte_offset, :file
 
-    def initialize(file = '[String]', line_number = 1, char_offset: 0, byte_offset: 0)
-      @filename = file
+    def initialize(
+      file = ::Spellr::File.new('[string]'),
+      line_number = 1,
+      char_offset: 0,
+      byte_offset: 0
+    )
+      @file = file
       @line_number = line_number
       @char_offset = char_offset
       @byte_offset = byte_offset
     end
 
     def to_s
-      "#{file_relative_path}:#{line_number}"
-    end
-
-    def file_relative_path
-      file.relative_path
-    end
-
-    def file
-      @file ||= Spellr::File.wrap(@filename)
+      "#{file.relative_path}:#{line_number}"
     end
   end
 end

data/lib/spellr/line_tokenizer.rb

@@ -9,8 +9,8 @@ require_relative 'token_regexps'
 
 module Spellr
   class LineTokenizer < StringScanner
-    attr_reader :line
-    attr_reader :skip_key
+    attr_reader :line, :skip_key
+
     alias_method :skip_key?, :skip_key
 
     include TokenRegexps

data/lib/spellr/output_stubbed.rb

@@ -16,7 +16,7 @@ module Spellr
       @stderr ||= StringIO.new
     end
 
-    def marshal_dump # rubocop:disable Metrics/MethodLength
+    def marshal_dump # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       l_exit_code = @exit_code if defined?(@exit_code)
       l_counts = @counts if defined?(@counts)
       l_stdin = @stdin if defined?(@stdin)

data/lib/spellr/token_regexps.rb

@@ -39,7 +39,7 @@ module Spellr
     # literal \ so that i can match on domains in regexps. no-one cares but me.
     URL_HOSTNAME = /(?:[[:alnum:]\-\\]+(?:\.[[:alnum:]\-\\]+)+|localhost|#{URL_IP_ADDRESS})/.freeze
     URL_PORT = /:\d+/.freeze
-    URL_PATH = %r{/(?:[[:alnum:]=@!$&\-/._\\]|%\h{2})+}.freeze
+    URL_PATH = %r{/(?:[[:alnum:]=@!$&~\-/._\\]|%\h{2})+}.freeze
     URL_QUERY = %r{\?(?:[[:alnum:]=!$\-/.\\]|%\h{2})+(?:&(?:[[:alnum:]=!$\-/.\\]|%\h{2})+)*}.freeze
     URL_FRAGMENT = %r{#(?:[[:alnum:]=!$&\-/.\\]|%\h{2})+}.freeze
 
@@ -98,5 +98,6 @@ module Spellr
 
     SPELLR_DISABLE_RE = /spellr:disable/.freeze
     SPELLR_ENABLE_RE = /spellr:enable/.freeze
+    SPELLR_LINE_DISABLE_RE = /spellr:disable[-:]line/.freeze
   end
 end

data/lib/spellr/tokenizer.rb

@@ -7,9 +7,10 @@ require_relative 'line_tokenizer'
 
 module Spellr
   class Tokenizer
-    attr_reader :file
+    attr_reader :file, :filename
 
     def initialize(file, start_at: nil, skip_key: true)
+      @filename = file
       @start_at = start_at || ColumnLocation.new(line_location: LineLocation.new(file))
       @file = file.is_a?(StringIO) || file.is_a?(IO) ? file : ::File.new(file)
       @file.pos = @start_at.line_location.byte_offset
@@ -27,7 +28,7 @@ module Spellr
 
     def each_term(&block)
       file.each_line do |line|
-        prepare_tokenizer_for_line(line).each_term(&block)
+        prepare_tokenizer_for_line(line)&.each_term(&block)
       end
     ensure
       file.close
@@ -35,7 +36,7 @@ module Spellr
 
     def each_token(skip_term_proc: nil) # rubocop:disable Metrics/MethodLength
       each_line_with_stats do |line, line_number, char_offset, byte_offset|
-        prepare_tokenizer_for_line(line).each_token(skip_term_proc: skip_term_proc) do |token|
+        prepare_tokenizer_for_line(line)&.each_token(skip_term_proc: skip_term_proc) do |token|
           token.line = prepare_line(line, line_number, char_offset, byte_offset)
 
           yield token
@@ -45,7 +46,7 @@ module Spellr
 
     def prepare_line(line, line_number, char_offset, byte_offset)
       line_location = LineLocation.new(
-        file, line_number, char_offset: char_offset, byte_offset: byte_offset
+        filename, line_number, char_offset: char_offset, byte_offset: byte_offset
       )
       column_location = ColumnLocation.new(line_location: line_location)
       Token.new(line, location: column_location)
@@ -74,6 +75,8 @@ module Spellr
     attr_reader :line_tokenizer
 
     def prepare_tokenizer_for_line(line)
+      return if line.match?(Spellr::TokenRegexps::SPELLR_LINE_DISABLE_RE)
+
       line_tokenizer.string = line
       line_tokenizer.pos = 0
       line_tokenizer

data/lib/spellr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spellr
-  VERSION = '0.8.2'
+  VERSION = '0.8.7'
 end

data/spellr.gemspec

@@ -14,6 +14,12 @@ Gem::Specification.new do |spec|
   spec.homepage = 'http://github.com/robotdana/spellr'
   spec.license = 'MIT'
 
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  end
+
   spec.required_ruby_version = '>= 2.4'
 
   spec.files = Dir.glob('{lib,exe,wordlists}/**/{*,.*}') + %w{
@@ -28,19 +34,19 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'leftovers', '>= 0.2.2'
+  spec.add_development_dependency 'leftovers', '>= 0.4.0'
   spec.add_development_dependency 'mime-types', '~> 3.3.1'
   spec.add_development_dependency 'nokogiri'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubocop', '~> 0.93.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.44.1'
   spec.add_development_dependency 'simplecov', '~> 0.18.5'
   spec.add_development_dependency 'simplecov-console'
   spec.add_development_dependency 'tty_string', '>= 0.2.1'
   spec.add_development_dependency 'webmock', '~> 3.8'
 
-  spec.add_dependency 'fast_ignore', '>= 0.10.0'
+  spec.add_dependency 'fast_ignore', '>= 0.11.0'
   spec.add_dependency 'parallel', '~> 1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spellr
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.7
 platform: ruby
 authors:
 - Dana Sherson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-21 00:00:00.000000000 Z
+date: 2020-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -112,30 +112,30 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.93.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.93.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.44.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.44.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -198,14 +198,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -299,7 +299,10 @@ files:
 homepage: http://github.com/robotdana/spellr
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: http://github.com/robotdana/spellr
+  source_code_uri: http://github.com/robotdana/spellr
+  changelog_uri: http://github.com/robotdana/spellr/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -315,7 +318,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Spell check your source code