spellr 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b12a7a52fc68f4960a9156f4d500366225de366b3ca20213231a22176c898030
-  data.tar.gz: 816aafdee27ec4c997e96b3726f37f1e08dc22aaee9f29680aee9f86b8481693
+  metadata.gz: e2aaca19a62f3dafd26ff2948289fac3f12e83ca30660b2b17d5d97866b5c8c1
+  data.tar.gz: fe0b3266121b748b26f1425a70c5b9d5e25a9d31a5a4befe66a84be8c6d1a9ee
 SHA512:
-  metadata.gz: 52e520722759e56c001ee0271408a7bb87e47cfb3ed1cba15ae1c208356a26cae1be01f05e72c316a6141e0e7e71aebe3878862de975cf12eedd77e64c2c1c3f
-  data.tar.gz: 3f11b304e48cc73823dd66b23daec1622ab1ee0e94545929a15d0baf80a4fc616a3dfa8f2ec9dda28e9792701d277fb0dc8e3cbbf673531dc8aca3fe9947ffd0
+  metadata.gz: 3b23613dee23ae8a8195d39a2abe55190a4b1b400174c197469391cb18d5d282a99920f5e3b7468030d7aa078ec0fe5d33bcf8b726e65e82dddd55cc9ba9f396
+  data.tar.gz: 2ef4a3eb0f30574fc2b77564af37a0ef0fdc71b03c8377bab597d9fb81d978b49dda614366fe3cafe8d4d01d6e1f98307af7159391fc903c368cf1e0d8a3a493

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v0.5.1
+- Check files in parallel
+- Lots of pure refactoring
+- Capfile is now considered a ruby file by default
+
 # v0.5.0
 - Removed the fetch command it was just unnecessarily slow and awkward. instead use `locale: [US,AU]`
 - Added usage documentation

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spellr (0.5.0)
+    spellr (0.5.1)
       fast_ignore (~> 0.4.0)
 
 GEM
@@ -13,7 +13,7 @@ GEM
     fast_ignore (0.4.1)
     jaro_winkler (1.5.3)
     method_source (0.9.2)
-    parallel (1.17.0)
+    parallel (1.18.0)
     parser (2.6.5.0)
       ast (~> 2.4.0)
     pry (0.12.2)
@@ -21,21 +21,21 @@ GEM
       method_source (~> 0.9.0)
     rainbow (3.0.0)
     rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
     rspec-eventually (0.2.2)
-    rspec-expectations (3.8.5)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.2)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.3)
-    rubocop (0.75.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.6)

data/lib/.spellr.yml

@@ -41,8 +41,10 @@ languages:
       - Gemfile
       - Rakefile
       - config.ru
+      - Capfile
     hashbangs:
       - ruby
+
   html:
     includes:
       - '*.html'

data/lib/spellr/backports.rb

@@ -3,12 +3,10 @@
 class Array
   unless RUBY_VERSION >= '2.4'
     def sum
-      reduce(0) do |total, value|
-        total + if block_given?
-          yield value
-        else
-          value
-        end
+      if block_given?
+        reduce(0) { |total, value| total + yield(value) }
+      else
+        reduce(:+)
       end
     end
   end
@@ -17,3 +15,15 @@ end
 class String
   alias_method :match?, :match unless RUBY_VERSION >= '2.4'
 end
+
+class Hash
+  unless RUBY_VERSION >= '2.5'
+    def slice!(*keys)
+      delete_if { |k| !keys.include?(k) }
+    end
+
+    def slice(*keys)
+      dup.slice!(*keys)
+    end
+  end
+end

data/lib/spellr/base_reporter.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative 'string_format'
+require_relative 'output'
+
+module Spellr
+  class BaseReporter
+    include Spellr::StringFormat
+
+    def parallel?
+      true
+    end
+
+    def initialize(output = nil)
+      @output = output
+    end
+
+    def finish
+      nil
+    end
+
+    def call(token)
+      puts "#{aqua token.location} #{token.line.highlight(token.char_range).strip}"
+    end
+
+    def increment(counter)
+      output.increment(counter)
+    end
+
+    def puts(str)
+      output.puts(str)
+    end
+
+    def print(str)
+      output.print(str)
+    end
+
+    def warn(str)
+      output.warn(str)
+    end
+
+    def exit_code
+      output.exit_code
+    end
+
+    def output
+      @output ||= Spellr::Output.new
+    end
+
+    def counts
+      output.counts
+    end
+  end
+end

data/lib/spellr/check.rb

@@ -5,6 +5,9 @@ require_relative 'tokenizer'
 require_relative 'token'
 require_relative 'column_location'
 require_relative 'line_location'
+require_relative 'output_stubbed'
+
+require 'parallel'
 
 module Spellr
   class InvalidByteSequence
@@ -15,45 +18,76 @@ module Spellr
   end
 
   class Check
-    attr_reader :exit_code
     attr_reader :files, :reporter
 
+    def exit_code
+      reporter.exit_code
+    end
+
     def initialize(files: [], reporter: Spellr.config.reporter)
       @files = files
-      @reporter = reporter
-      @exit_code = 0
+
+      @main_reporter = @reporter = reporter
     end
 
     def check
-      checked = 0
+      return check_parallel if reporter.parallel?
+
       files.each do |file|
-        check_file(file)
-        checked += 1
+        check_and_count_file(file)
+      end
+
+      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(checked) if reporter.respond_to?(:finish)
+      reporter.finish
     end
 
     private
 
-    def check_file(file, start_at: nil, wordlists: Spellr.config.wordlists_for(file)) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      restart_token = catch(:check_file_from) do
-        Spellr::Tokenizer.new(file, start_at: start_at).each_token do |token|
-          next if wordlists.any? { |d| d.include?(token) }
+    def check_and_count_file(file)
+      check_file(file)
+      reporter.output.increment(:checked)
+    rescue InvalidByteSequence
+      # sometimes files are binary
+      reporter.output.warn "Skipped unreadable file: #{file}"
+    end
 
-          start_at = token.location
+    def check_tokens_in_file(file, start_at, wordlist_proc)
+      Spellr::Tokenizer.new(file, start_at: start_at)
+        .each_token(skip_term_proc: wordlist_proc) do |token|
           reporter.call(token)
-          @exit_code = 1
+          reporter.output.exit_code = 1
         end
+    end
+
+    def wordlist_proc_for(file)
+      wordlists = Spellr.config.wordlists_for(file)
+
+      ->(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
-      if restart_token
-        wordlist_arg = restart_token.replacement ? { wordlists: wordlists } : {} # new wordlist cache when adding a word
-        check_file(file, start_at: restart_token.location, **wordlist_arg)
-      end
-    rescue InvalidByteSequence
-      # sometimes files are binary
-      warn "Skipped unreadable file: #{file}" unless Spellr.config.quiet?
+      check_file_from_restart(file, restart_token, wordlist_proc) if restart_token
     end
   end
 end

data/lib/spellr/cli.rb

@@ -18,10 +18,8 @@ module Spellr
 
     def check
       require_relative 'check'
-      unless Spellr.config.valid?
-        Spellr.config.print_errors
-        exit 1
-      end
+
+      validate_config
 
       checker = Spellr::Check.new(files: files)
       checker.check
@@ -29,6 +27,13 @@ module Spellr
       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)
@@ -41,7 +46,8 @@ module Spellr
 
     def quiet_option(_)
       Spellr.config.quiet = true
-      Spellr.config.reporter = ->(_) {}
+      require_relative 'quiet_reporter'
+      Spellr.config.reporter = Spellr::QuietReporter.new
     end
 
     def interactive_option(_)
@@ -89,7 +95,8 @@ module Spellr
         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.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('')

data/lib/spellr/column_location.rb

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

data/lib/spellr/config.rb

@@ -7,7 +7,7 @@ require_relative 'reporter'
 require 'pathname'
 
 module Spellr
-  class Config # rubocop:disable Metrics/ClassLength
+  class Config
     attr_writer :reporter
     attr_reader :config_file
     attr_accessor :quiet
@@ -48,47 +48,17 @@ module Spellr
     end
 
     def includes
-      return @includes if defined?(@includes)
-
-      if @config[:only]
-        warn <<~WARNING
-          \e[33mSpellr: `only:` yaml key with a list of fnmatch rules is deprecated.
-          Please use `includes:` instead, which uses gitignore-inspired rules.
-          see github.com/robotdana/fast_ignore#using-an-includes-list for details\e[0m
-        WARNING
-      end
-
-      @includes = (@config[:includes] || []) + (@config[:only] || [])
+      @includes ||= @config[:includes] || []
     end
 
     def excludes
-      return @excludes if defined?(@excludes)
-
-      if @config[:ignore]
-        warn <<~WARNING
-          \e[33mSpellr: `ignore:` yaml key is deprecated.
-          Please use `excludes:` instead.\e[0m
-        WARNING
-      end
-
-      @excludes = (@config[:excludes] || []) + (@config[:ignore] || [])
+      @excludes ||= @config[:excludes] || []
     end
 
     def color
       @config[:color]
     end
 
-    def clear_cache # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-      remove_instance_variable(:@wordlists) if defined?(@wordlists)
-      remove_instance_variable(:@languages) if defined?(@languages)
-      remove_instance_variable(:@errors) if defined?(@errors)
-      remove_instance_variable(:@word_minimum_length) if defined?(@word_minimum_length)
-      remove_instance_variable(:@key_heuristic_weight) if defined?(@key_heuristic_weight)
-      remove_instance_variable(:@key_minimum_length) if defined?(@key_minimum_length)
-      remove_instance_variable(:@excludes) if defined?(@excludes)
-      remove_instance_variable(:@includes) if defined?(@includes)
-    end
-
     def languages
       @languages ||= @config[:languages].map do |key, args|
         Spellr::Language.new(key, args)
@@ -103,10 +73,6 @@ module Spellr
       languages.select { |l| l.matches?(file) }
     end
 
-    def wordlists
-      @wordlists ||= languages.flat_map(&:wordlists)
-    end
-
     def wordlists_for(file)
       languages_for(file).flat_map(&:wordlists)
     end
@@ -123,21 +89,16 @@ module Spellr
     private
 
     def only_has_one_key_per_language
-      conflicting_languages = languages
-        .group_by(&:key)
-        .values.select { |g| g.length > 1 }
-
-      return if conflicting_languages.empty?
+      conflicting_languages = languages.group_by(&:key).values.select { |g| g.length > 1 }
 
       conflicting_languages.each do |conflicts|
-        errors << "Error: #{conflicts.map(&:name).join(' & ')} share the same language key (#{conflicts.first.key}). "\
-          'Please define one to be different with `key:`'
+        errors << "Error: #{conflicts.map(&:name).join(' & ')} share the same language key "\
+        "(#{conflicts.first.key}). Please define one to be different with `key:`"
       end
     end
 
     def keys_are_single_characters
       bad_languages = languages.select { |l| l.key.length > 1 }
-      return if bad_languages.empty?
 
       bad_languages.each do |language|
         errors << "Error: #{language.name} defines a key that is too long (#{language.key}). "\

data/lib/spellr/config_loader.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'yaml'
+
 module Spellr
   class ConfigLoader
     attr_reader :config_file
@@ -9,6 +11,7 @@ module Spellr
     end
 
     def config_file=(value)
+      # TODO: nicer error message
       ::File.read(value) # raise Errno::ENOENT if the file doesn't exist
       @config_file = value
       @config = nil
@@ -29,10 +32,12 @@ module Spellr
     end
 
     def load_yaml(path)
-      require 'yaml'
-
       return {} unless ::File.exist?(path)
 
+      symbolize_yaml_safe_load(path)
+    end
+
+    def symbolize_yaml_safe_load(path)
       if RUBY_VERSION >= '2.5'
         YAML.safe_load(::File.read(path), symbolize_names: true)
       else
@@ -40,12 +45,11 @@ module Spellr
       end
     end
 
-    def symbolize_names!(obj)
+    def symbolize_names!(obj) # rubocop:disable Metrics/MethodLength
       case obj
       when Hash
         obj.keys.each do |key|
-          value = obj.delete(key)
-          obj[key.to_sym] = symbolize_names!(value)
+          obj[key.to_sym] = symbolize_names!(obj.delete(key))
         end
       when Array
         obj.map! { |ea| symbolize_names!(ea) }
@@ -53,7 +57,7 @@ module Spellr
       obj
     end
 
-    def merge_config(default, project)
+    def merge_config(default, project) # rubocop:disable Metrics/MethodLength
       if project.is_a?(Array) && default.is_a?(Array)
         default | project
       elsif project.is_a?(Hash) && default.is_a?(Hash)

data/lib/spellr/file.rb

@@ -2,8 +2,6 @@
 
 require 'pathname'
 
-# TODO: maybe just extend pathname if you have to
-
 module Spellr
   class File < Pathname
     def self.wrap(file)
@@ -22,5 +20,20 @@ module Spellr
     def first_line
       @first_line ||= each_line.first
     end
+
+    def relative_path
+      @relative_path ||= relative_path_from(Spellr.config.pwd)
+    end
+
+    def insert(string, range)
+      read_write do |body|
+        body[range] = string
+        body
+      end
+    end
+
+    def read_write
+      write(yield read)
+    end
   end
 end

data/lib/spellr/file_list.rb

@@ -12,34 +12,38 @@ module Spellr
       @patterns = patterns
     end
 
+    def each
+      fast_ignore.each do |file|
+        file = Spellr::File.new(file)
+
+        yield(file)
+      end
+    end
+
+    def to_a
+      enum_for(:each).to_a
+    end
+
+    private
+
     # anchored patterns are significantly faster on large codebases
     def cli_patterns
       @patterns.map do |pattern|
-        if pattern.match?(%r{^([/~*]|\.{1,2}/)})
-          pattern
-        else
-          "/#{pattern}"
-        end
+        pattern.sub(%r{^(?!(?:[/~*]|\.{1,2}/))}, '/')
       end
     end
 
-    def each
+    def gitignore_path
       gitignore = ::File.join(Dir.pwd, '.gitignore')
-      gitignore = nil unless ::File.exist?(gitignore)
+      gitignore if ::File.exist?(gitignore)
+    end
 
+    def fast_ignore
       FastIgnore.new(
         ignore_rules: Spellr.config.excludes,
         include_rules: Spellr.config.includes + cli_patterns,
-        gitignore: gitignore
-      ).each do |file|
-        file = Spellr::File.new(file)
-
-        yield(file)
-      end
-    end
-
-    def to_a
-      enum_for(:each).to_a
+        gitignore: gitignore_path
+      )
     end
   end
 end