spellr 0.8.5 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80438eca6b5b281ceab331e0ab9886fcb9c622cfe1e91ca2762ed10628c44ee1
-  data.tar.gz: 434910ca88653cb6a7d4bb11dabc32e4c782b22df4e65cc488ebaf6439bb3b38
+  metadata.gz: 901a89f14415b3993f210ac2f0f94cb82efdbfc55565f8e1c9fd51347790b3d6
+  data.tar.gz: 113d25fcdfc5d70c9e50f4a061092728c1349452e88e0dd0d6268d10851c47b9
 SHA512:
-  metadata.gz: b14f3fe397b01f9a7e1742246a451e68238833c98e98b6716e36a11bb38d556463d992a0cdb8577f2dac2b65bb39eb0a9f3d050f884814c7449d0b6d2239e013
-  data.tar.gz: 45fe01c33fd31faafd21248751f2a85f38c3807b75eb242fa994ffbdd14735f2dde343cf397b5f14281a24107ca5532d45b4c107b720546ac4994121c5599e58
+  metadata.gz: adcfec5ea17125517f445fb7e895b5ee049d1540f7626ab5c55d835d600b149d844b9a052f2324784038f5098a392a8f51b16d01c56ace9cffa773b34e27bbca
+  data.tar.gz: 922c16526b3e0dd8600ca5ef836de2419dda0237e3b3c2d8a2674d1ca7b0f0dcebf1fe0d0deded671522ee526c7e185a338ef98e762c4385e00b25f8e3ae94e8

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# v0.9.1
+- Assume all files are utf8, more comprehensively. (Sets ::Encoding.default_external and default_internal while running)
+
+# 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
 

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`:
@@ -195,7 +197,7 @@ If your language supports inline comments you can also surround with `spellr:dis
 ```
 ## 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
@@ -304,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.
@@ -317,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/exe/spellr

@@ -3,4 +3,7 @@
 
 require_relative '../lib/spellr/cli'
 
+::Encoding.default_external = ::Encoding::UTF_8
+::Encoding.default_internal = ::Encoding::UTF_8
+
 exit Spellr::CLI.new(ARGV).run

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_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/rake_task.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'rake'
-require 'spellr/cli'
 require 'shellwords'
 
 module Spellr
@@ -36,11 +35,13 @@ module Spellr
       desc("Run spellr (default args: #{escaped_argv})")
     end
 
-    def define_task
+    def define_task # rubocop:disable Metrics/MethodLength
       task(@name, :'*args') do |_, task_argv|
-        argv = argv_or_default(task_argv)
-        write_cli_cmd(argv)
-        run(argv)
+        with_utf_8 do
+          argv = argv_or_default(task_argv)
+          write_cli_cmd(argv)
+          run(argv)
+        end
       end
     end
 
@@ -49,6 +50,7 @@ module Spellr
     end
 
     def run(argv)
+      require 'spellr/cli'
       status = Spellr::CLI.new(argv).run
       exit 1 unless status == 0
     end
@@ -57,5 +59,15 @@ module Spellr
       task_argv = task_argv.to_a.compact
       task_argv.empty? ? @default_argv : task_argv
     end
+
+    def with_utf_8 # rubocop:disable Metrics/MethodLength
+      old_default_external = ::Encoding.default_external
+      old_default_internal = ::Encoding.default_internal
+      ::Encoding.default_external = ::Encoding::UTF_8
+      ::Encoding.default_internal = ::Encoding::UTF_8
+      yield
+      ::Encoding.default_external = old_default_external
+      ::Encoding.default_internal = old_default_internal
+    end
   end
 end

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/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

data/lib/spellr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spellr
-  VERSION = '0.8.5'
+  VERSION = '0.9.1'
 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.5
+  version: 0.9.1
 platform: ruby
 authors:
 - Dana Sherson
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-06 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:
@@ -299,8 +299,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,8 +318,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Spell check your source code
 test_files: []