spellr 0.8.4 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52262546809e049a6c04f71c067d895e2cd83b865bc1371a4c9c489ca8b8b5b7
-  data.tar.gz: c75f1e3037419fb9e917cac1d808fa3f32a882f0c76bb2a871ddca8ac8b33ea3
+  metadata.gz: 60659d04d7461c60fc7880fe44fa4af1d6b852511affaef3722d8bca7902bebe
+  data.tar.gz: 6327cb52ae02517918e886b774311f09270dc1e96166361962c49f9f01f28506
 SHA512:
-  metadata.gz: 12771b2588b7b8e2bfdfadec6c78cf4dd5f90000730451f8f8f7f066de77aba171a6227fa9c3a0ea914fb3dd7f33cd975b9dcfb2d73d0fb11a03898e460ed489
-  data.tar.gz: bfa05561e73da2b21fe6d2e7a138c8dfae8eda29dcadb83dd5c10e31b5d7b525b18161f8f9cd944b1d58ae1b46022ca2a4e4d05c7efad68d3363540714ca6b16
+  metadata.gz: 1aadb5c07c9ce3fa8899be299810480034d1bfed1e93aa9fe0e07192edb9cac21e8c505908da7757badb0190da5d0251c47cf135306aa60cde8abbee2a4e3db8
+  data.tar.gz: 7fc321f6665f93c4093a46748781eb59ce56930c334298670e5592d63887e97092bc2ab49394ab08f143d8a84a213e4df76a149b6f97065b51f78feebc56e91c

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# v0.9.0
+- Recognize url with _ in query string and zero length path
+- Assume all files are utf8
+
+# v0.8.8
+- output a suggested `spellr --interactive` command with filenames, when running this without --interactive
+
+# 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)
 

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-3.0.
+
 ### 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/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/config_loader.rb

@@ -32,7 +32,7 @@ module Spellr
     def load_yaml(path)
       return {} unless ::File.exist?(path)
 
-      YAML.safe_load(::File.read(path), symbolize_names: true)
+      YAML.safe_load(::File.read(path, encoding: ::Encoding::UTF_8), symbolize_names: true)
     end
 
     def merge_config(default, project) # rubocop:disable Metrics/MethodLength

data/lib/spellr/file.rb

@@ -34,7 +34,7 @@ module Spellr
     end
 
     def read_write
-      write(yield read)
+      write(yield(read(encoding: ::Encoding::UTF_8)), encoding: ::Encoding::UTF_8)
     end
   end
 end

data/lib/spellr/file_list.rb

@@ -26,10 +26,18 @@ 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

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/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,8 +7,7 @@ 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
       @name = name

data/lib/spellr/line_location.rb

@@ -4,10 +4,7 @@ require_relative 'file'
 
 module Spellr
   class LineLocation
-    attr_reader :line_number
-    attr_reader :char_offset
-    attr_reader :byte_offset
-    attr_reader :file
+    attr_reader :line_number, :char_offset, :byte_offset, :file
 
     def initialize(
       file = ::Spellr::File.new('[string]'),

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/reporter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base_reporter'
+require 'shellwords'
 
 module Spellr
   class Reporter < Spellr::BaseReporter
@@ -8,12 +9,31 @@ module Spellr
       puts "\n"
       puts "#{pluralize 'file', counts[:checked]} checked"
       puts "#{pluralize 'error', counts[:total]} found"
+
+      interactive_command if counts[:total].positive?
     end
 
     def call(token)
       super
 
+      filenames << token.location.file.relative_path.to_s
       increment(:total)
     end
+
+    private
+
+    def interactive_command
+      puts "\nto add or replace words interactively, run:"
+      command = ['spellr', '--interactive']
+      # sort is purely for repeatability for tests. so
+      command.concat(counts[:filenames].to_a.sort) unless counts[:filenames].length > 20
+
+      puts "  #{Shellwords.join(command)}"
+    end
+
+    def filenames
+      output.counts[:filenames] = Set.new unless output.counts.key?(:filenames)
+      output.counts[:filenames]
+    end
   end
 end

data/lib/spellr/stringio_with_encoding.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Spellr
+  class StringIOWithEncoding < ::StringIO
+    def each_line(*args, encoding: nil, **kwargs, &block)
+      string.force_encoding(encoding) if encoding && !string.frozen?
+
+      super(*args, **kwargs, &block)
+    end
+  end
+end

data/lib/spellr/token_regexps.rb

@@ -39,8 +39,9 @@ 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_QUERY = %r{\?(?:[[:alnum:]=!$\-/.\\]|%\h{2})+(?:&(?:[[:alnum:]=!$\-/.\\]|%\h{2})+)*}.freeze
+    URL_PATH = %r{/(?:[[:alnum:]=@!$&~\-/._\\]|%\h{2})*}.freeze
+    URL_QUERY_PART = %r{(?:[[:alnum:]=!$\-/._\\]|%\h{2})+}.freeze
+    URL_QUERY = /\?#{URL_QUERY_PART}(?:&#{URL_QUERY_PART})*/.freeze
     URL_FRAGMENT = %r{#(?:[[:alnum:]=!$&\-/.\\]|%\h{2})+}.freeze
 
     # URL can be any valid hostname, it must have either a scheme, userinfo, or path
@@ -98,5 +99,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

@@ -27,8 +27,8 @@ module Spellr
     end
 
     def each_term(&block)
-      file.each_line do |line|
-        prepare_tokenizer_for_line(line).each_term(&block)
+      file.each_line(encoding: ::Encoding::UTF_8) do |line|
+        prepare_tokenizer_for_line(line)&.each_term(&block)
       end
     ensure
       file.close
@@ -36,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
@@ -56,12 +56,14 @@ module Spellr
       char_offset = @start_at.line_location.char_offset
       byte_offset = @start_at.line_location.byte_offset
 
-      file.each_line.with_index(@start_at.line_location.line_number) do |line, line_number|
-        yield line, line_number, char_offset, byte_offset
+      file
+        .each_line(encoding: ::Encoding::UTF_8)
+        .with_index(@start_at.line_location.line_number) do |line, line_number|
+          yield line, line_number, char_offset, byte_offset
 
-        char_offset += line.length
-        byte_offset += line.bytesize
-      end
+          char_offset += line.length
+          byte_offset += line.bytesize
+        end
     ensure
       file.close
     end
@@ -75,6 +77,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.4'
+  VERSION = '0.9.0'
 end

data/lib/spellr/wordlist.rb

@@ -41,7 +41,7 @@ module Spellr
       touch
       @include[term] = true
       insert_sorted(term)
-      @path.write(words.join) # we don't need to clear the cache
+      @path.write(words.join, encoding: ::Encoding::UTF_8) # we don't need to clear the cache
     end
 
     def words
@@ -55,7 +55,7 @@ module Spellr
     end
 
     def write(content)
-      @path.write(content)
+      @path.write(content, encoding: ::Encoding::UTF_8)
 
       clear_cache
     end
@@ -70,7 +70,7 @@ module Spellr
       return if exist?
 
       @path.dirname.mkpath
-      @path.write('')
+      @path.write('', encoding: ::Encoding::UTF_8)
       clear_cache
     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,17 +34,17 @@ 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 'tty_string', '>= 1.1.0'
   spec.add_development_dependency 'webmock', '~> 3.8'
 
   spec.add_dependency 'fast_ignore', '>= 0.11.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spellr
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.9.0
 platform: ruby
 authors:
 - Dana Sherson
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-02 00:00:00.000000000 Z
+date: 2021-06-10 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
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -220,7 +220,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: 
+description:
 email:
 - robot@dana.sh
 executables:
@@ -266,6 +266,7 @@ files:
 - lib/spellr/rake_task.rb
 - lib/spellr/reporter.rb
 - lib/spellr/string_format.rb
+- lib/spellr/stringio_with_encoding.rb
 - lib/spellr/token.rb
 - lib/spellr/token_regexps.rb
 - lib/spellr/tokenizer.rb
@@ -299,8 +300,11 @@ files:
 homepage: http://github.com/robotdana/spellr
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+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:
 - lib
@@ -315,9 +319,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.10
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Spell check your source code
 test_files: []