spellr 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d62f8784cec5a6100e381fe52ad9d8315203c488fb0b6673fa6adc2cac1e4375
-  data.tar.gz: a09e0852f55429b6697c7ac2a1388e4ca1c18ce8b33e1a505789ac091c51fea0
+  metadata.gz: c712613dec647be23db6a02ac4612afe8ec9af7347bb5aae0b6068f4c8b609e6
+  data.tar.gz: ccb5af415199801c8d68b278105cb93156e3ab2d8d73c2a0a5221a7307e39102
 SHA512:
-  metadata.gz: 6b9682c7bd5fe23a14b23393b55166cd743f1abe32f30bcb8990a146441b61b806e261ae9be4679878916e46f485280c97a127904c95edd022f7eb5e68999360
-  data.tar.gz: d1b64e78bed6b152606646afc56db541e07f89bfe3c507b642f2b8f827071656a604b44f63ab39508cdde01b44cf8a09461f70046285d74ad50c2ee98a278a9a
+  metadata.gz: e2003cd517d9e915d8e154474bf404ee64c87796e7a59ea47710e3963c681e90b52cb6a93be80ca1ccfe810062b4882f344b0ac2ba04c6f85ab9685f3bb0bcc6
+  data.tar.gz: 1e8144ed3b9f86b194e91952acfac4536ad432cd47ee2ccadc22dbbc6d5f3d126f6db0a7a219a31a3b0dfb5ff8d7627b470f9ea32c91868edf0e23f102678e48

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# v0.7.0
+- dry_run checks config validity
+- require fast_ignore 0.6.0
+- new interactive UI
+- misc performance improvements
+- drop ruby 2.4 support because simplecov does
+
 # v0.6.0
 - add CSS wordlist from MDN
 - improve html wordlist comprehensiveness from MDN and W3C

data/README.md

@@ -124,37 +124,52 @@ $ spellr --interactive
 You'll be shown each word that's not found in a dictionary, it's location (path:line:column), along with a prompt.
 ```
 file.rb:1:0 notaword
-[r,R,s,S,a,e?]
+[a]dd, [r]eplace, [s]kip, [h]elp, [^C] to exit: [ ]
 ```
 
-Type `?` for this list of what each letter command does
+Type `h` for this list of what each letter command does
 ```
+[a] Add notaword to a word list
 [r] Replace notaword
-[R] Replace all future instances of notaword
+[R] Replace this and all future instances of notaword
 [s] Skip notaword
-[S] Skip all future instances of notaword
-[a] Add notaword to a word list
-[e] Edit the whole line
-[?] Show this help
+[S] Skip this and all future instances of notaword
+[h] Show this help
+[ctrl] + [C] Exit spellr
+
+What do you want to do? [ ]
 ```
 
-If you type `r`, `R` or `e` you'll be shown a prompt with the original word and it prefilled ready for correcting:
+---
+
+If you type `r` or `R` you'll be shown a prompt with the original word and it prefilled ready for correcting:
 ```
 file.txt:1:0 notaword
->> notaword
-=> not_a_word
+[a]dd, [r]eplace, [s]kip, [h]elp, [^C] to exit: [r]
+
+  [^C] to go back
+  Replace notaword with: notaword
 ```
 To submit your choice and continue with the spell checking click enter. Your replacement word will be immediately spellchecked. To instead go back press Ctrl-C once (pressing it twice will exit the spell checking).
 
+Lowercase `r` will correct this particular use of the word, uppercase `R` will also all the future times that word is used.
+
+---
+
 If you instead type `s` or `S` it will skip this word and continue with the spell checking.
 
+Lowercase `s` will skip this particular use of the word, uppercase `S` will also skip future uses of the word.
+
 ---
 
 If you instead type `a` you'll be shown a list of possible wordlists to add to. This list is based on the file path, and is configurable in `.spellr.yml`.
 ```
-Add notaword to wordlist:
-[e] english
-[r] ruby
+file.txt:1:0 notaword
+[a]dd, [r]eplace, [s]kip, [h]elp, [^C] to exit: [a]
+
+  [e] english
+  [^C] to go back
+  Add notaword to which wordlist? [ ]
 ```
 Type `e` to add this word to the english wordlist and continue on through the spell checking. To instead go back to the prompt press Ctrl-C once (pressing it twice will exit the spell checking).
 
@@ -167,6 +182,10 @@ If the tokenizer finds a word you don't want to add to the wordlist (perhaps it'
 # spellr:enable
 ```
 
+This works with any kind of comment, even 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).
@@ -206,8 +225,8 @@ languages:
       - /applies_to/
     key: r # this is the letter used to choose this wordlist when using `spellr --interactive`.
     hashbangs:
-      - ruby # if the hashbang contains ruby, this file will match,
-             # even if it doesn't otherwise match the includes pattern.
+      - ruby # if the file has no extension and the hashbang/shebang contains ruby
+             # this file will match even if it doesn't otherwise match the includes pattern.
 ```
 
 ## Development

data/exe/spellr

@@ -2,4 +2,11 @@
 # frozen_string_literal: true
 
 require_relative '../lib/spellr/cli'
-Spellr::CLI.new(ARGV)
+
+begin
+  Spellr::CLI.new(ARGV).check
+rescue Spellr::Error => e
+  require_relative '../lib/spellr/string_format'
+  warn Spellr::StringFormat.red(e.message)
+  exit 1
+end

data/lib/spellr/backports.rb

@@ -1,27 +1,9 @@
 # frozen_string_literal: true
 
-class Array
-  unless RUBY_VERSION >= '2.4'
-    def sum
-      if block_given?
-        reduce(0) { |total, value| total + yield(value) }
-      else
-        reduce(:+)
-      end
-    end
-  end
-end
-
-class Regexp
-  alias_method :match?, :match unless RUBY_VERSION >= '2.4'
-end
-
-class String
-  alias_method :match?, :match unless RUBY_VERSION >= '2.4'
-end
+ruby_version = Gem::Version.new(RUBY_VERSION)
 
-class Hash
-  unless RUBY_VERSION >= '2.5'
+unless ruby_version >= Gem::Version.new('2.5')
+  class Hash
     def slice!(*keys)
       delete_if { |k| !keys.include?(k) }
     end
@@ -30,4 +12,49 @@ class Hash
       dup.slice!(*keys)
     end
   end
+
+  require 'yaml'
+  module YAML
+    class << self
+      alias_method :safe_load_without_symbolize_names, :safe_load
+      def safe_load(path, *args, symbolize_names: false, **kwargs)
+        if symbolize_names
+          symbolize_names!(safe_load_without_symbolize_names(path, *args, **kwargs))
+        else
+          safe_load_without_symbolize_names(path, *args, **kwargs)
+        end
+      end
+
+      private
+
+      def symbolize_names!(obj) # rubocop:disable Metrics/MethodLength
+        case obj
+        when Hash
+          obj.keys.each do |key| # rubocop:disable Style/HashEachMethods # each_key never finishes.
+            obj[key.to_sym] = symbolize_names!(obj.delete(key))
+          end
+        when Array
+          obj.map! { |ea| symbolize_names!(ea) }
+        end
+        obj
+      end
+    end
+  end
+end
+
+# all this to avoid a deprecation warning
+unless ruby_version >= Gem::Version.new('2.6')
+  require 'yaml'
+  module YAML
+    class << self
+      alias_method :safe_load_without_permitted_classes, :safe_load
+      def safe_load(path, *args, permitted_classes: nil, **kwargs)
+        if permitted_classes
+          safe_load_without_permitted_classes(path, permitted_classes, *args, **kwargs)
+        else
+          safe_load_without_permitted_classes(path, *args, **kwargs)
+        end
+      end
+    end
+  end
 end

data/lib/spellr/base_reporter.rb

@@ -7,10 +7,6 @@ module Spellr
   class BaseReporter
     include Spellr::StringFormat
 
-    def parallel?
-      true
-    end
-
     def initialize(output = nil)
       @output = output
     end

data/lib/spellr/check.rb

@@ -2,24 +2,12 @@
 
 require_relative '../spellr'
 require_relative 'tokenizer'
-require_relative 'token'
-require_relative 'column_location'
-require_relative 'line_location'
-require_relative 'output_stubbed'
-require_relative 'backports'
-
-require 'parallel'
+require_relative 'string_format'
 
 module Spellr
-  class InvalidByteSequence
-    def self.===(error)
-      error.is_a?(ArgumentError) &&
-        /invalid byte sequence/.match?(error.message)
-    end
-  end
-
   class Check
     attr_reader :files, :reporter
+    include StringFormat
 
     def exit_code
       reporter.exit_code
@@ -32,8 +20,6 @@ module Spellr
     end
 
     def check
-      return check_parallel if reporter.parallel?
-
       files.each do |file|
         check_and_count_file(file)
       end
@@ -41,54 +27,28 @@ module Spellr
       reporter.finish
     end
 
-    def check_parallel # rubocop:disable Metrics/MethodLength
-      acc_reporter = @reporter
-      Parallel.each(files, finish: ->(_, _, result) { acc_reporter.output << result }) do |file|
-        @reporter = acc_reporter.class.new(Spellr::OutputStubbed.new)
-        check_and_count_file(file)
-        reporter.output
-      end
-      @reporter = acc_reporter
-
-      reporter.finish
-    end
-
     private
 
     def check_and_count_file(file)
       check_file(file)
       reporter.output.increment(:checked)
-    rescue InvalidByteSequence
+    rescue Spellr::InvalidByteSequence
       # sometimes files are binary
-      reporter.output.warn "Skipped unreadable file: #{file}"
+      reporter.warn "Skipped unreadable file: #{aqua file.relative_path}"
     end
 
-    def check_tokens_in_file(file, start_at, wordlist_proc)
+    def check_file(file, start_at = nil, found_word_proc = wordlist_proc_for(file))
       Spellr::Tokenizer.new(file, start_at: start_at)
-        .each_token(skip_term_proc: wordlist_proc) do |token|
+        .each_token(skip_term_proc: found_word_proc) do |token|
           reporter.call(token)
           reporter.output.exit_code = 1
         end
     end
 
     def wordlist_proc_for(file)
-      wordlists = Spellr.config.wordlists_for(file)
+      wordlists = Spellr.config.wordlists_for(file).sort_by(&:length).reverse
 
       ->(term) { wordlists.any? { |w| w.include?(term) } }
     end
-
-    def check_file_from_restart(file, restart_token, wordlist_proc)
-      # new wordlist cache when adding a word
-      wordlist_proc = wordlist_proc_for(file) unless restart_token.replacement
-      check_file(file, start_at: restart_token.location, wordlist_proc: wordlist_proc)
-    end
-
-    def check_file(file, start_at: nil, wordlist_proc: wordlist_proc_for(file))
-      restart_token = catch(:check_file_from) do
-        check_tokens_in_file(file, start_at, wordlist_proc)
-        nil
-      end
-      check_file_from_restart(file, restart_token, wordlist_proc) if restart_token
-    end
   end
 end

data/lib/spellr/check_dry_run.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative '../spellr'
+require_relative 'check'
+
+module Spellr
+  class CheckDryRun < Check
+    def check
+      files.each do |file|
+        puts file.relative_path
+      end
+    end
+  end
+end

data/lib/spellr/check_interactive.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative '../spellr'
+require_relative 'check'
+
+module Spellr
+  class CheckInteractive < Check
+    private
+
+    def check_file_from_restart(file, restart_token, wordlist_proc)
+      # new wordlist cache when adding a word
+      wordlist_proc = wordlist_proc_for(file) unless restart_token.replacement
+      check_file(file, restart_token.location, wordlist_proc)
+    end
+
+    def check_file(file, start_at = nil, wordlist_proc = wordlist_proc_for(file))
+      restart_token = catch(:check_file_from) do
+        super(file, start_at, wordlist_proc)
+        nil
+      end
+      check_file_from_restart(file, restart_token, wordlist_proc) if restart_token
+    end
+  end
+end

data/lib/spellr/check_parallel.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative '../spellr'
+require_relative 'check'
+require_relative 'output_stubbed'
+require 'parallel'
+
+module Spellr
+  class CheckParallel < Check
+    def check # rubocop:disable Metrics/MethodLength
+      acc_reporter = @reporter
+
+      Parallel.each(files, finish: ->(_, _, result) { acc_reporter.output << result }) do |file|
+        @reporter = acc_reporter.class.new(Spellr::OutputStubbed.new)
+        check_and_count_file(file)
+        reporter.output
+      end
+      @reporter = acc_reporter
+
+      reporter.finish
+    end
+  end
+end

data/lib/spellr/cli.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
-require 'optparse'
-require 'pathname'
-require 'open3'
-
 require_relative '../spellr'
+require_relative 'cli_options'
 
 module Spellr
   class CLI
@@ -12,102 +9,20 @@ module Spellr
 
     def initialize(argv)
       @argv = argv
-
-      parse_command
+      CLI::Options.parse(@argv)
+      Spellr.config.valid?
     end
 
     def check
-      require_relative 'check'
-
-      validate_config
-
-      checker = Spellr::Check.new(files: files)
+      checker = Spellr.config.checker.new(files: files)
       checker.check
 
       exit checker.exit_code
     end
 
-    def validate_config
-      return true if Spellr.config.valid?
-
-      Spellr.config.print_errors
-      exit 1
-    end
-
     def files
       require_relative 'file_list'
-      Spellr::FileList.new(*argv)
-    end
-
-    def wordlist_option(_)
-      require_relative 'wordlist_reporter'
-      Spellr.config.reporter = Spellr::WordlistReporter.new
-    end
-
-    def quiet_option(_)
-      Spellr.config.quiet = true
-      require_relative 'quiet_reporter'
-      Spellr.config.reporter = Spellr::QuietReporter.new
-    end
-
-    def interactive_option(_)
-      require_relative 'interactive'
-      Spellr.config.reporter = Spellr::Interactive.new
-    end
-
-    def config_option(file)
-      Spellr.config.config_file = Pathname.pwd.join(file).expand_path
-    end
-
-    def dry_run_option(_)
-      files.each { |f| puts f.relative_path_from(Pathname.pwd) }
-
-      exit
-    end
-
-    def version_option(_)
-      require_relative 'version'
-      puts(Spellr::VERSION)
-
-      exit
-    end
-
-    def parse_command
-      parse_options
-      check
-    end
-
-    def options_help(_)
-      puts options.help
-
-      exit
-    end
-
-    def parse_options
-      options.parse!(argv)
-    end
-
-    def options # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      @options ||= begin
-        opts = OptionParser.new
-
-        opts.banner = 'Usage: spellr [options] [files]'
-        opts.separator('')
-        opts.on('-w', '--wordlist', 'Outputs errors in wordlist format', &method(:wordlist_option))
-        opts.on('-q', '--quiet', 'Silences output', &method(:quiet_option))
-        opts.on('-i', '--interactive', 'Runs the spell check interactively',
-                &method(:interactive_option))
-        opts.separator('')
-        opts.on('-d', '--dry-run', 'List files to be checked', &method(:dry_run_option))
-        opts.separator('')
-        opts.on('-c', '--config FILENAME', String, <<~HELP, &method(:config_option))
-          Path to the config file (default ./.spellr.yml)
-        HELP
-        opts.on('-v', '--version', 'Returns the current version', &method(:version_option))
-        opts.on('-h', '--help', 'Shows this message', &method(:options_help))
-
-        opts
-      end
+      Spellr::FileList.new(@argv)
     end
   end
 end

data/lib/spellr/cli_options.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'pathname'
+require_relative '../spellr'
+
+module Spellr
+  class CLI
+    class Options
+      class << self
+        def parse(argv)
+          options.parse!(argv)
+        end
+
+        private
+
+        # rubocop:disable Layout/LineLength
+        def options # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+          opts = OptionParser.new
+
+          opts.banner = 'Usage: spellr [options] [files]'
+          opts.separator('')
+          opts.on('-w', '--wordlist', 'Outputs errors in wordlist format', &method(:wordlist_option))
+          opts.on('-q', '--quiet', 'Silences output', &method(:quiet_option))
+          opts.on('-i', '--interactive', 'Runs the spell check interactively', &method(:interactive_option))
+          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.separator('')
+          opts.on('-c', '--config FILENAME', String, <<~HELP, &method(:config_option))
+            Path to the config file (default ./.spellr.yml)
+          HELP
+          opts.on('-v', '--version', 'Returns the current version', &method(:version_option))
+          opts.on('-h', '--help', 'Shows this message', &method(:options_help))
+
+          opts
+        end
+        # rubocop:enable Layout/LineLength
+
+        def wordlist_option(_)
+          require_relative 'wordlist_reporter'
+          Spellr.config.reporter = Spellr::WordlistReporter.new
+        end
+
+        def quiet_option(_)
+          Spellr.config.quiet = true
+          require_relative 'quiet_reporter'
+          Spellr.config.reporter = Spellr::QuietReporter.new
+        end
+
+        def interactive_option(_)
+          require_relative 'interactive'
+          require_relative 'check_interactive'
+          Spellr.config.reporter = Spellr::Interactive.new
+          Spellr.config.checker = Spellr::CheckInteractive unless @parallel_option
+        end
+
+        def config_option(file)
+          file = Pathname.pwd.join(file).expand_path
+
+          unless ::File.readable?(file)
+            raise Spellr::Config::NotFound, "Config error: #{file} not found or not readable"
+          end
+
+          Spellr.config.config_file = file
+        end
+
+        def parallel_option(parallel) # rubocop:disable Metrics/MethodLength
+          @parallel_option = true
+          Spellr.config.checker = if parallel
+            require_relative 'check_parallel'
+            Spellr::CheckParallel
+          else
+            require_relative 'check'
+            Spellr::Check
+          end
+        end
+
+        def dry_run_option(_)
+          Spellr.config.dry_run = true
+        end
+
+        def version_option(_)
+          require_relative 'version'
+          puts(Spellr::VERSION)
+
+          exit
+        end
+
+        def options_help(_)
+          puts options.help
+
+          exit
+        end
+      end
+    end
+  end
+end

data/lib/spellr/column_location.rb

@@ -30,17 +30,15 @@ module Spellr
       line_location.file
     end
 
-    def file_name
-      line_location.file_name
-    end
-
     def to_s
       "#{line_location}:#{char_offset}"
     end
 
+    # :nocov:
     def inspect
       "#<#{self.class.name} #{self}>"
     end
+    # :nocov:
 
     def coordinates
       [line_number, char_offset]