spellr 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e045b4e7f76fa43573c0e28564a4f532dbcc9b35f05ca682e7302274ce0bdbc
-  data.tar.gz: 2918d1f1c2a41c681dc7370180ead18a63a86f991032140f0dea1ac92faad3b0
+  metadata.gz: 8ed59cf5b3c7a98c77565b63809433c16e16e9f6445f911623d8f73aab0a42b3
+  data.tar.gz: 20d9208eb6ee13445bf14bf51ae87ef3e4f034bdaab63e2e45614488dbecf3e1
 SHA512:
-  metadata.gz: d44c69a61badacc0a792f2ec60794847ea722101fc46e5fdce717562e2f3923ce6d95624af75d6c31e4cdcf2e6b017aaa7aa87c28a3f3b3761591658fcea6770
-  data.tar.gz: a607bcdf971179b58c7a1fc4fbf433ef4312724910c74f3731dd5df1127ccc2c9059d836564f00456656d19dfad39b62707663baffd1349bb93352a20f83f9b8
+  metadata.gz: 5b947e61408ed87bc8651f8f608550f8520cfbbcedbe22a7323a6dd385aff59bea8bae48d26812e042386bdd29e2cdfb3bbdcc2f4105ba99af2fe14ba5dd542a
+  data.tar.gz: 6cddbbc490a53949a5656ede17c1330dca3d8d1d94b25a3661dfae6c050116824116468890408dfca87d01b24cfe6946a9b3fe62e0965f79402ab800b3b4a649

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 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/exe/spellr

@@ -3,4 +3,4 @@
 
 require_relative '../lib/spellr/cli'
 
-Spellr::CLI.new(ARGV)
+exit Spellr::CLI.new(ARGV).run

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

@@ -16,7 +16,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
 
@@ -43,7 +45,6 @@ module Spellr
         end
 
         def quiet_option(_)
-          Spellr.config.quiet = true
           require_relative 'quiet_reporter'
           Spellr.config.reporter = Spellr::QuietReporter.new
         end
@@ -56,7 +57,7 @@ module Spellr
         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 +83,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/config.rb

@@ -4,6 +4,8 @@ require_relative '../spellr'
 require_relative 'config_loader'
 require_relative 'language'
 require_relative 'config_validator'
+require_relative 'output'
+
 require 'pathname'
 
 module Spellr
@@ -11,9 +13,8 @@ module Spellr
     attr_writer :reporter
     attr_writer :checker
     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 +46,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 +59,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
@@ -106,10 +103,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

@@ -24,7 +24,7 @@ module Spellr
     end
 
     def relative_path
-      @relative_path ||= relative_path_from(Spellr.config.pwd)
+      @relative_path ||= relative_path_from(Spellr.pwd)
     end
 
     def insert(string, range)

data/lib/spellr/file_list.rb

@@ -31,7 +31,7 @@ module Spellr
         ignore_rules: Spellr.config.excludes,
         include_rules: Spellr.config.includes,
         argv_rules: @patterns,
-        root: Spellr.config.pwd_s
+        root: Spellr.pwd_s
       )
     end
   end

data/lib/spellr/interactive.rb

@@ -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/language.rb

@@ -15,8 +15,8 @@ module Spellr
       @key = key
       @includes = includes
       @hashbangs = hashbangs
-      unless hashbangs.empty?
-        @hashbang_pattern = /\A#!.*\b(?:#{hashbangs.map { |s| Regexp.escape(s) }.join('|')})\b/
+      @hashbang_pattern = unless hashbangs.empty?
+        /\A#!.*\b(?:#{hashbangs.map { |s| Regexp.escape(s) }.join('|')})\b/
       end
       @locales = Array(locale)
       @addable = addable
@@ -36,7 +36,7 @@ module Spellr
 
     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
@@ -56,7 +56,7 @@ module Spellr
       return @hashbangs.empty? if @includes.empty?
 
       @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

data/lib/spellr/line_tokenizer.rb

@@ -10,16 +10,15 @@ 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 :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/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

data/lib/spellr/tokenizer.rb

@@ -8,10 +8,6 @@ require_relative 'line_tokenizer'
 module Spellr
   class Tokenizer
     attr_reader :file
-    attr_reader :start_at
-
-    attr_accessor :disabled
-    alias_method :disabled?, :disabled
 
     def initialize(file, start_at: nil, skip_key: true)
       @start_at = start_at || ColumnLocation.new(line_location: LineLocation.new(file))
@@ -21,7 +17,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
 

data/lib/spellr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spellr
-  VERSION = '0.8.1'
+  VERSION = '0.8.2'
 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

@@ -28,6 +28,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 +41,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.10.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.2
 platform: ruby
 authors:
 - Dana Sherson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-18 00:00:00.000000000 Z
+date: 2020-04-21 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.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.10.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