spellr 0.8.1 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e045b4e7f76fa43573c0e28564a4f532dbcc9b35f05ca682e7302274ce0bdbc
-  data.tar.gz: 2918d1f1c2a41c681dc7370180ead18a63a86f991032140f0dea1ac92faad3b0
+  metadata.gz: 31be9d119f5909486cfd46089d224e0bf1a47b815951766fc138bf1a6637dec3
+  data.tar.gz: b621fac32ca57cd912b0167cd02f0fb998c2366b8160247324f2f9e190638704
 SHA512:
-  metadata.gz: d44c69a61badacc0a792f2ec60794847ea722101fc46e5fdce717562e2f3923ce6d95624af75d6c31e4cdcf2e6b017aaa7aa87c28a3f3b3761591658fcea6770
-  data.tar.gz: a607bcdf971179b58c7a1fc4fbf433ef4312724910c74f3731dd5df1127ccc2c9059d836564f00456656d19dfad39b62707663baffd1349bb93352a20f83f9b8
+  metadata.gz: 7a701cb79672ac340ac8d688b1b859189647ed4e1cb0d7c0b869cf55517287330cbf3144283a25a151c36ac00ee7aa1c2da0ee322be3c2e8aabd409b0f104ec8
+  data.tar.gz: 88a37834530501ddfe3bd5e63c667b97a8b0b282fc71b40ab9040e06725bc235798c86d28f1f817ec332f7018bdfcef69f951ad854d93e02b797efdd62b7ef04

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# 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
+  - All output goes through Spellr.config.output. Now we can override it.
+  - tests are twice as fast. Fewer warnings
+- upgrade fast_ignore dependency
+
 # v0.8.1
 - use refinements for backports so that RakeTask doesn't conflict with Rubocop::RakeTask
 

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
 
@@ -175,20 +175,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 +304,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 +329,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,4 @@
 
 require_relative '../lib/spellr/cli'
 
-Spellr::CLI.new(ARGV)
+exit Spellr::CLI.new(ARGV).run

data/lib/.spellr.yml

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

data/lib/spellr.rb

@@ -2,6 +2,7 @@
 
 require_relative 'spellr/backports'
 require_relative 'spellr/config'
+require_relative 'spellr/pwd'
 
 module Spellr
   class Error < StandardError; end
@@ -27,4 +28,8 @@ module Spellr
   def config
     @config ||= Spellr::Config.new
   end
+
+  def exit(status = 0)
+    throw(:spellr_exit, status)
+  end
 end

data/lib/spellr/base_reporter.rb

@@ -40,7 +40,7 @@ module Spellr
     end
 
     def output
-      @output ||= Spellr::Output.new
+      @output ||= Spellr.config.output
     end
 
     def counts

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
@@ -16,7 +17,7 @@ module Spellr
     def initialize(files: [], reporter: Spellr.config.reporter)
       @files = files
 
-      @main_reporter = @reporter = reporter
+      @reporter = reporter
     end
 
     def check

data/lib/spellr/check_dry_run.rb

@@ -7,7 +7,7 @@ module Spellr
   class CheckDryRun < Check
     def check
       files.each do |file|
-        puts file.relative_path
+        @reporter.puts file.relative_path
       end
     end
   end

data/lib/spellr/cli.rb

@@ -1,32 +1,33 @@
 # frozen_string_literal: true
 
+require 'pathname'
 require_relative '../spellr'
 require_relative 'cli_options'
 require_relative 'string_format'
 
 module Spellr
   class CLI
-    attr_reader :argv
-
     def initialize(argv)
+      Spellr.config.reset!
       @argv = argv
-      CLI::Options.parse(@argv)
-      check
-    rescue Spellr::Error => e
-      exit_with_error(e.message)
     end
 
-    def exit_with_error(message)
-      warn Spellr::StringFormat.red(message)
-      exit 1
+    def run
+      catch(:spellr_exit) { check }
+    rescue Spellr::Error => e
+      Spellr.config.output.warn(Spellr::StringFormat.red(e.message)) && 1
+      1
     end
 
+    private
+
     def check
+      CLI::Options.parse(@argv)
       Spellr.config.valid?
       checker = Spellr.config.checker.new(files: files)
       checker.check
 
-      exit checker.exit_code
+      checker.exit_code
     end
 
     def files

data/lib/spellr/cli_options.rb

@@ -9,6 +9,8 @@ module Spellr
     class Options
       class << self
         def parse(argv)
+          @parallel_option = false
+
           options.parse!(argv)
         end
 
@@ -26,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)
@@ -43,7 +48,6 @@ module Spellr
         end
 
         def quiet_option(_)
-          Spellr.config.quiet = true
           require_relative 'quiet_reporter'
           Spellr.config.reporter = Spellr::QuietReporter.new
         end
@@ -55,8 +59,12 @@ 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 = Pathname.pwd.join(file).expand_path
+          file = Spellr.pwd.join(file).expand_path
 
           unless ::File.readable?(file)
             raise Spellr::Config::NotFound, "Config error: #{file} not found or not readable"
@@ -82,15 +90,15 @@ module Spellr
 
         def version_option(_)
           require_relative 'version'
-          puts(Spellr::VERSION)
+          Spellr.config.output.puts(Spellr::VERSION)
 
-          exit
+          Spellr.exit
         end
 
         def options_help(_)
-          puts options.help
+          Spellr.config.output.puts options.help
 
-          exit
+          Spellr.exit
         end
       end
     end

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

@@ -4,16 +4,18 @@ require_relative '../spellr'
 require_relative 'config_loader'
 require_relative 'language'
 require_relative 'config_validator'
+require_relative 'output'
+
 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 :quiet
-    alias_method :quiet?, :quiet
-    attr_accessor :dry_run
+    alias_method :dry_run?, :dry_run
 
     def initialize
       @config = ConfigLoader.new
@@ -45,14 +47,6 @@ module Spellr
       end
     end
 
-    def pwd
-      @pwd ||= Pathname.new(ENV['SPELLR_TEST_PWD'] || Dir.pwd)
-    end
-
-    def pwd_s
-      @pwd_s ||= pwd.to_s
-    end
-
     def languages_for(file)
       languages.select { |l| l.matches?(file) }
     end
@@ -66,12 +60,16 @@ module Spellr
       @config = ConfigLoader.new(value)
     end
 
+    def output
+      @output ||= Spellr::Output.new
+    end
+
     def reporter
       @reporter ||= default_reporter
     end
 
     def checker
-      return dry_run_checker if @dry_run
+      return dry_run_checker if dry_run?
 
       @checker ||= default_checker
     end
@@ -80,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)
@@ -106,10 +104,5 @@ module Spellr
       require_relative 'check_parallel'
       Spellr::CheckParallel
     end
-
-    def clear_pwd
-      remove_instance_variable(:@pwd) if defined?(@pwd)
-      remove_instance_variable(:@pwd_s) if defined?(@pwd_s)
-    end
   end
 end

data/lib/spellr/config_loader.rb

@@ -11,7 +11,7 @@ module Spellr
 
     attr_reader :config_file
 
-    def initialize(config_file = ::File.join(Dir.pwd, '.spellr.yml'))
+    def initialize(config_file = ::File.join(Spellr.pwd, '.spellr.yml'))
       @config_file = config_file
     end
 

data/lib/spellr/config_validator.rb

@@ -23,9 +23,9 @@ module Spellr
 
       # I have no idea how to check for this other than call it
       Timeout.timeout(0.0000000000001) do
-        $stdin.getch
+        Spellr.config.output.stdin.getch
       end
-    rescue Errno::ENOTTY, Errno::ENODEV
+    rescue Errno::ENOTTY, Errno::ENODEV, IOError
       errors << 'CLI error: --interactive is unavailable in a non-interactive terminal'
     rescue Timeout::Error
       nil

data/lib/spellr/file.rb

@@ -4,27 +4,8 @@ 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.config.pwd)
+      @relative_path ||= relative_path_from(Spellr.pwd)
     end
 
     def insert(string, range)
@@ -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,12 +26,21 @@ 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,
-        root: Spellr.config.pwd_s
+        follow_symlinks: true,
+        root: Spellr.pwd_s
       )
     end
   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)
@@ -126,7 +126,7 @@ module Spellr
       case stdin_getch("qaAsSrR?h\u0003\u0004")
       # :nocov:
       when 'q', "\u0003" # ctrl c
-        exit 1
+        Spellr.exit 1
       when 'a', 'A'
         Spellr::InteractiveAdd.new(token, self)
       when 's', "\u0004" # ctrl d

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
-      unless hashbangs.empty?
-        @hashbang_pattern = /\A#!.*\b(?:#{hashbangs.map { |s| Regexp.escape(s) }.join('|')})\b/
-      end
+      @includes = includes + hashbangs.map { |h| "#!:#{h}" }
       @locales = Array(locale)
       @addable = addable
     end
@@ -26,39 +21,29 @@ module Spellr
       @addable
     end
 
-    def matches?(file)
-      matches_includes?(file) || matches_hashbangs?(file)
-    end
-
     def wordlists
       default_wordlists.select(&:exist?)
     end
 
     def project_wordlist
       @project_wordlist ||= Spellr::Wordlist.new(
-        Spellr.config.pwd.join('.spellr_wordlists', "#{name}.txt"),
+        Spellr.pwd.join('.spellr_wordlists', "#{name}.txt"),
         name: name
       )
     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.config.pwd_s
+        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,17 +9,16 @@ require_relative 'token_regexps'
 
 module Spellr
   class LineTokenizer < StringScanner
-    attr_reader :line
-    attr_accessor :disabled
-    alias_method :disabled?, :disabled
-    attr_accessor :skip_key
+    attr_reader :line, :skip_key
+
     alias_method :skip_key?, :skip_key
 
     include TokenRegexps
 
-    def initialize(line, skip_key: true)
+    def initialize(line, skip_key: false)
       @line = line
       @skip_key = skip_key
+      @disabled = false
 
       super(@line.to_s)
     end
@@ -32,7 +31,7 @@ module Spellr
     def each_term
       until eos?
         term = next_term
-        next if !term || disabled?
+        next if !term || @disabled
 
         yield term
       end
@@ -42,7 +41,7 @@ module Spellr
       until eos?
         term = next_term
         next unless term
-        next if disabled? || skip_term_proc&.call(term)
+        next if @disabled || skip_term_proc&.call(term)
 
         yield Token.new(term, line: line, location: column_location(term))
       end
@@ -78,6 +77,8 @@ module Spellr
     end
 
     def skip_key_heuristically
+      return unless skip_key?
+
       possible_key = check(POSSIBLE_KEY_RE)
 
       return unless possible_key
@@ -88,6 +89,7 @@ module Spellr
 
     BAYES_KEY_HEURISTIC = NaiveBayes.new
     def key?(possible_key)
+      return unless possible_key.length >= Spellr.config.key_minimum_length
       # I've come across some large base64 strings by this point they're definitely base64.
       return true if possible_key.length > 200
       return unless possible_key.match?(min_alpha_re) # or there's no point
@@ -96,15 +98,15 @@ module Spellr
     end
 
     def skip_and_track_disable
-      return if disabled?
+      return if @disabled
 
-      skip(SPELLR_DISABLE_RE) && self.disabled = true
+      skip(SPELLR_DISABLE_RE) && @disabled = true
     end
 
     def skip_and_track_enable
-      return unless disabled?
+      return unless @disabled
 
-      skip(SPELLR_ENABLE_RE) && self.disabled = false
+      skip(SPELLR_ENABLE_RE) && @disabled = false
     end
   end
 end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Spellr
+  module_function
+
+  def pwd
+    @pwd ||= Pathname.pwd
+  end
+
+  def pwd_s
+    @pwd_s ||= pwd.to_s
+  end
+end

data/lib/spellr/rake_task.rb

@@ -49,9 +49,8 @@ module Spellr
     end
 
     def run(argv)
-      Spellr::CLI.new(argv)
-    rescue SystemExit => e
-      raise unless e.status == 0
+      status = Spellr::CLI.new(argv).run
+      exit 1 unless status == 0
     end
 
     def argv_or_default(task_argv)

data/lib/spellr/token.rb

@@ -39,7 +39,7 @@ module Spellr
         location.char_offset...(location.char_offset + length)
     end
 
-    def byte_range
+    def byte_range # leftovers:allow i don't want to delete this
       @byte_range ||=
         location.byte_offset...(location.byte_offset + bytesize)
     end
@@ -49,7 +49,7 @@ module Spellr
         location.absolute_char_offset...(location.absolute_char_offset + length)
     end
 
-    def file_byte_range
+    def file_byte_range # leftovers:allow i don't want to delete this
       @file_byte_range ||=
         location.absolute_byte_offset...(location.absolute_byte_offset + bytesize)
     end

data/lib/spellr/token_regexps.rb

@@ -23,7 +23,6 @@ module Spellr
     LEFTOVER_NON_WORD_BITS_RE = %r{[/%#\\]|\d+}.freeze # e.g. a / not starting //a-url.com
     HEX_RE = /(?:#(?:\h{6}|\h{3})|0x\h+)(?![[:alpha:]])/.freeze
     SHELL_COLOR_ESCAPE_RE = /\\(?:e|0?33)\[\d+(;\d+)*m/.freeze
-    PUNYCODE_RE = /xn--[a-v0-9\-]+(?:[[:alpha:]])/.freeze
     # TODO: hex escapes e.g. \xAA.
     # TODO: language aware escapes
     BACKSLASH_ESCAPE_RE = /\\[a-zA-Z]/.freeze
@@ -99,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,13 +7,10 @@ require_relative 'line_tokenizer'
 
 module Spellr
   class Tokenizer
-    attr_reader :file
-    attr_reader :start_at
-
-    attr_accessor :disabled
-    alias_method :disabled?, :disabled
+    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
@@ -21,7 +18,7 @@ module Spellr
       @line_tokenizer = LineTokenizer.new('', skip_key: skip_key)
     end
 
-    def terms
+    def terms # leftovers:test
       enum_for(:each_term).to_a
     end
 
@@ -31,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
@@ -39,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
@@ -49,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)
@@ -78,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.1'
+  VERSION = '0.8.6'
 end

data/lib/spellr/wordlist.rb

@@ -12,7 +12,7 @@ module Spellr
 
     def initialize(file, name: file)
       path = @file = file
-      @path = Spellr.config.pwd.join('.spellr_wordlists').join(path).expand_path
+      @path = Spellr.pwd.join('.spellr_wordlists').join(path).expand_path
       @name = name
       @include = {}
     end

data/lib/spellr/wordlist_reporter.rb

@@ -6,7 +6,7 @@ require_relative 'base_reporter'
 module Spellr
   class WordlistReporter < Spellr::BaseReporter
     def finish
-      output.puts words.sort.join
+      puts words.sort.join unless words.empty?
     end
 
     def call(token)

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,6 +34,7 @@ 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 'mime-types', '~> 3.3.1'
   spec.add_development_dependency 'nokogiri'
   spec.add_development_dependency 'pry'
@@ -40,6 +47,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'tty_string', '>= 0.2.1'
   spec.add_development_dependency 'webmock', '~> 3.8'
 
-  spec.add_dependency 'fast_ignore', '>= 0.6.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.1
+  version: 0.8.6
 platform: ruby
 authors:
 - Dana Sherson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-18 00:00:00.000000000 Z
+date: 2020-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: leftovers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +198,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -247,6 +261,7 @@ files:
 - lib/spellr/line_tokenizer.rb
 - lib/spellr/output.rb
 - lib/spellr/output_stubbed.rb
+- lib/spellr/pwd.rb
 - lib/spellr/quiet_reporter.rb
 - lib/spellr/rake_task.rb
 - lib/spellr/reporter.rb
@@ -284,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:
@@ -300,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