spellr 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '08e49a55e37f2b63ecb10f8ce5218b6c1baa2c53'
-  data.tar.gz: d2d69cdf740d24670efde7b60389494688d42354
+  metadata.gz: 90aae5e24ba00624fea110acb2efb0a796cbf154
+  data.tar.gz: f46b4df50970c2043937aab35e2771a96ee6a3f9
 SHA512:
-  metadata.gz: a2d76f91252a4c97fa202f91c8500d0829dbf2392f7d4b433f42dfcc851b4402681e7104f2d19ba47d81ff0d74fd7bf4d0ca487edfe450563c7a38555bf64cb0
-  data.tar.gz: 93b0c4758dd2d39fbe50ff9b8434171955fccef32d973998d4a01be4c4f8b2366160e6f6732709ffee77d533601609e68fb43679ab67457b6ca99d6f7af11b10
+  metadata.gz: cc31f2cbe8f1870a4eae00d4fcf1dc88eaf905a5fc477605650c67a50768950da5cd3e6e845405c713be073104c778a4c2d50a1d377a2efb5da0329311c4ce09
+  data.tar.gz: 58763f377f33faa8465fe69e06558da8ed97eb783d3c814dcb642920aa7ecfa99d6ce6488df8e3acace87a9a8a77875ad278919e475246984354260a79ae69f5

data/.spellr.yml

@@ -1,6 +1,5 @@
 ---
 ignore:
-  - '*.spellr_wordlists'
   - wordlists/*
 only:
   - '*.rb'
@@ -11,9 +10,6 @@ only:
   - '*.gemspec'
   - Gemfile
 languages:
-  english:
-    wordlists:
-      - dictionary.txt
   ruby:
     only:
       - README.md

data/.spellr_wordlists/english.txt

@@ -1,3 +1,123 @@
+abc
+addable
+arg
+args
+baz
+bundler
+changelog
+charpos
+cli
+cmd
+codebase
+colours
+config
+configs
+css
+customisations
+cyclomatic
+def
+dict
+diffable
+diffs
+dockerfile
+downloader
+env
+eos
+eot
+erb
+exclusions
+exe
+executables
+exitstatus
+ext
+filename
+filenames
+foo
+gemfile
+gemspec
+getch
+git
+github
+gitignore
+gitignored
+gitkeep
+haml
+hashbang
+hashbangs
+hashbangs
+heuristically
+hml
+hostnames
+href
+htt
+ico
+inclusions
+jbuilder
+jpg
 json
+jsx
+klass
+localhost
+lstripped
+mailto
+marketplacer
+matcher
+matchers
+maths
+merchantability
+multiline
+newlines
+noninfringement
+nonwords
+optparse
+org
+param
+params
+png
+pwd
+rakefile
+rdoc
+readme
+redisplay
+repo
+rspec
+rubocop
+rvm
+scss
+shelljoin
+shellsplit
+shellwords
+sherson
+spellr
+stderr
+stdlib
+stdout
+str
+stringscanner
+strscan
+sublicense
+subwords
+sudo
+svg
+thu
+tlds
+tmp
+todo
+tokenize
+tokenizes
+tsx
+ttf
+txt
+uploader
+uri
+usr
+utf
 woff
+wordlist
+wordlists
+wordn't
+xdescribe
+xit
 xlsx
+yardoc
+yml

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.3.0
+- interactive add to wordlist uses consistent letters rather than random numbers as keys
+- additional wordlists per language can no longer be defined
 # v0.2.0
 - Supports ruby 2.3 - 2.6
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spellr (0.2.0)
+    spellr (0.3.0)
       fast_ignore
       parallel
 

data/lib/.spellr.yml

@@ -3,6 +3,7 @@ word_minimum_length: 3
 
 ignore: # this list is parsed with the .gitignore format
   - /.git/
+  - .spellr_wordlists/
   - .DS_Store
   - Gemfile.lock
   - .rspec_status

data/lib/spellr/cli.rb

@@ -19,6 +19,11 @@ module Spellr
 
     def check
       require_relative 'check'
+      unless Spellr.config.valid?
+        Spellr.config.print_errors
+        exit 1
+      end
+
       checker = Spellr::Check.new(files: files)
       checker.check
 

data/lib/spellr/config.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../spellr'
+require_relative 'config_loader'
 
 module Spellr
   class Config
@@ -10,8 +11,25 @@ module Spellr
     alias_method :quiet?, :quiet
 
     def initialize
-      @config_file = ::File.join(Dir.pwd, '.spellr.yml')
-      load_config
+      @config = ConfigLoader.new
+    end
+
+    def valid?
+      only_has_one_key_per_language
+      keys_are_single_characters
+      errors.empty?
+    end
+
+    def print_errors
+      if $stderr.tty?
+        errors.each { |e| warn "\e[31m#{e}\e[0m" }
+      else
+        errors.each { |e| warn e }
+      end
+    end
+
+    def errors
+      @errors ||= []
     end
 
     def word_minimum_length
@@ -33,26 +51,23 @@ module Spellr
     def clear_cache
       remove_instance_variable(:@wordlists) if defined?(@wordlists)
       remove_instance_variable(:@languages) if defined?(@languages)
+      remove_instance_variable(:@errors) if defined?(@errors)
     end
 
     def languages
       require_relative 'language'
 
       @languages ||= @config[:languages].map do |key, args|
-        [key, Spellr::Language.new(key, args)]
-      end.to_h
+        Spellr::Language.new(key, args)
+      end
     end
 
     def languages_for(file)
-      languages.values.select { |l| l.matches?(file) }
+      languages.select { |l| l.matches?(file) }
     end
 
     def wordlists
-      @wordlists ||= languages.values.flat_map(&:wordlists)
-    end
-
-    def all_wordlist_paths
-      languages.values.flat_map(&:all_wordlist_paths)
+      @wordlists ||= languages.flat_map(&:wordlists)
     end
 
     def wordlists_for(file)
@@ -61,8 +76,7 @@ module Spellr
 
     def config_file=(value)
       ::File.read(value) # raise Errno::ENOENT if the file doesn't exist
-      @config_file = value
-      load_config
+      @config = ConfigLoader.new(value)
     end
 
     def reporter
@@ -71,52 +85,33 @@ module Spellr
 
     private
 
-    def default_reporter
-      require_relative 'reporter'
-
-      Spellr::Reporter.new
-    end
+    def only_has_one_key_per_language
+      conflicting_languages = languages
+        .group_by(&:key)
+        .values.select { |g| g.length > 1 }
 
-    def load_config
-      default_config = load_yaml(::File.join(__dir__, '..', '.spellr.yml'))
-      project_config = load_yaml(config_file)
+      return if conflicting_languages.empty?
 
-      @config = merge_config(default_config, project_config)
+      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:`'
+      end
     end
 
-    def load_yaml(path)
-      require 'yaml'
+    def keys_are_single_characters
+      bad_languages = languages.select { |l| l.key.length > 1 }
+      return if bad_languages.empty?
 
-      return {} unless ::File.exist?(path)
-
-      if RUBY_VERSION >= '2.5'
-        YAML.safe_load(::File.read(path), symbolize_names: true)
-      else
-        symbolize_names!(YAML.safe_load(::File.read(path)))
+      bad_languages.each do |language|
+        errors << "Error: #{language.name} defines a key that is too long (#{language.key}). "\
+          'Please change it to be a single character'
       end
     end
 
-    def symbolize_names!(obj)
-      case obj
-      when Hash
-        obj.keys.each do |key|
-          value = obj.delete(key)
-          obj[key.to_sym] = symbolize_names!(value)
-        end
-      when Array
-        obj.map! { |ea| symbolize_names!(ea) }
-      end
-      obj
-    end
+    def default_reporter
+      require_relative 'reporter'
 
-    def merge_config(default, project)
-      if project.is_a?(Array) && default.is_a?(Array)
-        default | project
-      elsif project.is_a?(Hash) && default.is_a?(Hash)
-        default.merge(project) { |_k, d, p| merge_config(d, p) }
-      else
-        project
-      end
+      Spellr::Reporter.new
     end
   end
 end

data/lib/spellr/config_loader.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Spellr
+  class ConfigLoader
+    attr_reader :config_file
+
+    def initialize(config_file = ::File.join(Dir.pwd, '.spellr.yml'))
+      @config_file = config_file
+    end
+
+    def config_file=(value)
+      ::File.read(value) # raise Errno::ENOENT if the file doesn't exist
+      @config_file = value
+      @config = nil
+    end
+
+    def [](value)
+      load_config unless @config
+      @config[value]
+    end
+
+    private
+
+    def load_config
+      default_config = load_yaml(::File.join(__dir__, '..', '.spellr.yml'))
+      project_config = load_yaml(config_file)
+
+      @config = merge_config(default_config, project_config)
+    end
+
+    def load_yaml(path)
+      require 'yaml'
+
+      return {} unless ::File.exist?(path)
+
+      if RUBY_VERSION >= '2.5'
+        YAML.safe_load(::File.read(path), symbolize_names: true)
+      else
+        symbolize_names!(YAML.safe_load(::File.read(path)))
+      end
+    end
+
+    def symbolize_names!(obj)
+      case obj
+      when Hash
+        obj.keys.each do |key|
+          value = obj.delete(key)
+          obj[key.to_sym] = symbolize_names!(value)
+        end
+      when Array
+        obj.map! { |ea| symbolize_names!(ea) }
+      end
+      obj
+    end
+
+    def merge_config(default, project)
+      if project.is_a?(Array) && default.is_a?(Array)
+        default | project
+      elsif project.is_a?(Hash) && default.is_a?(Hash)
+        default.merge(project) { |_k, d, p| merge_config(d, p) }
+      else
+        project
+      end
+    end
+  end
+end

data/lib/spellr/file_list.rb

@@ -12,10 +12,6 @@ module Spellr
       @patterns = patterns
     end
 
-    def wordlist?(file)
-      Spellr.config.all_wordlist_paths.any? { |w| w == file }
-    end
-
     def config_only?(file)
       Spellr.config.only.empty? || Spellr.config.only.any? { |o| file.fnmatch?(o) }
     end
@@ -31,7 +27,6 @@ module Spellr
       FastIgnore.new(rules: Spellr.config.ignored, gitignore: gitignore).each do |file|
         file = Spellr::File.new(file)
         next unless cli_only?(file)
-        next if wordlist?(file)
         next unless config_only?(file)
 
         yield(file)

data/lib/spellr/interactive.rb

@@ -117,10 +117,10 @@ module Spellr
     # TODO: handle more than 16 options
     def handle_add(token) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       puts "Add #{red(token)} to wordlist:"
-      wordlists = Spellr.config.languages_for(token.location.file).flat_map(&:addable_wordlists)
+      languages = Spellr.config.languages_for(token.location.file)
 
-      wordlists.each_with_index do |wordlist, i|
-        puts "[#{i.to_s(16)}] #{wordlist.name}"
+      languages.each do |wordlist|
+        puts "[#{wordlist.key}] #{wordlist.name}"
       end
       choice = STDIN.getch
       clear_current_line
@@ -128,9 +128,8 @@ module Spellr
       when "\u0003" # ctrl c
         puts '^C again to exit'
         call(token)
-      when /\h/
-        wl = wordlists[choice.to_i(16)]
-        return handle_add(token) unless wl
+      when *languages.map(&:key)
+        wl = languages.find { |w| w.key == choice }.project_wordlist
 
         wl.add(token)
         self.total_added += 1

data/lib/spellr/language.rb

@@ -5,17 +5,18 @@ require_relative 'wordlist'
 module Spellr
   class Language
     attr_reader :name
+    attr_reader :key
 
     def initialize(name, # rubocop:disable Metrics/ParameterLists
-      wordlists: [],
+      key: name[0],
       generate: nil,
       only: [],
       description: '',
       hashbangs: [])
       @name = name
+      @key = key
       @description = description
       @generate = generate
-      @wordlist_paths = wordlists
       @only = only
       @hashbangs = hashbangs
     end
@@ -28,19 +29,9 @@ module Spellr
       return true if file.hashbang && @hashbangs.any? { |h| file.hashbang.include?(h) }
     end
 
-    def config_wordlists
-      @config_wordlists ||= @wordlist_paths.map(&Spellr::Wordlist.method(:new))
-    end
-
-    def all_wordlist_paths
-      @wordlist_paths + default_wordlists.map(&:path)
-    end
-
     def wordlists
-      w = config_wordlists + default_wordlists.select(&:exist?)
-      return generate_wordlist if w.empty?
-
-      w
+      generate_wordlist unless generated_project_wordlist.exist?
+      default_wordlists.select(&:exist?)
     end
 
     def generate_wordlist
@@ -52,11 +43,7 @@ module Spellr
 
       Spellr::CLI.new(generate.shellsplit)
 
-      config_wordlists + default_wordlists
-    end
-
-    def addable_wordlists
-      ((config_wordlists - default_wordlists) + [project_wordlist]).uniq(&:path)
+      default_wordlists
     end
 
     def gem_wordlist
@@ -88,11 +75,6 @@ module Spellr
       wordlists.map(&Spellr::Wordlist.method(:new))
     end
 
-    def custom_addable_wordlists(wordlists)
-      default_paths = default_wordlist_paths
-      wordlists.map { |w| Spellr::Wordlist.new(w) }.reject { |w| default_paths.include?(w.path) }
-    end
-
     def default_wordlists
       [
         gem_wordlist,

data/lib/spellr/tokenizer.rb

@@ -51,7 +51,7 @@ module Spellr
     end
 
     def normalized_terms
-      enum_for(:each_term).lazy.map { |t| Token.normalize(t) }.uniq.sort
+      enum_for(:each_term).map { |t| Token.normalize(t) }.uniq.sort
     end
 
     private

data/lib/spellr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spellr
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spellr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Dana Sherson
@@ -149,7 +149,6 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".spellr.yml"
-- ".spellr_wordlists/dictionary.txt"
 - ".spellr_wordlists/english.txt"
 - ".spellr_wordlists/lorem.txt"
 - ".spellr_wordlists/ruby.txt"
@@ -171,6 +170,7 @@ files:
 - lib/spellr/cli.rb
 - lib/spellr/column_location.rb
 - lib/spellr/config.rb
+- lib/spellr/config_loader.rb
 - lib/spellr/file.rb
 - lib/spellr/file_list.rb
 - lib/spellr/interactive.rb

data/.spellr_wordlists/dictionary.txt

@@ -1,120 +0,0 @@
-abc
-addable
-arg
-args
-baz
-bundler
-changelog
-charpos
-cli
-cmd
-codebase
-colours
-config
-configs
-css
-customisations
-cyclomatic
-def
-dict
-diffable
-diffs
-dockerfile
-downloader
-env
-eos
-eot
-erb
-exclusions
-exe
-executables
-exitstatus
-ext
-filename
-filenames
-foo
-gemfile
-gemspec
-getch
-git
-github
-gitignore
-gitignored
-gitkeep
-haml
-hashbang
-hashbangs
-hashbangs
-heuristically
-hml
-hostnames
-href
-htt
-ico
-inclusions
-jbuilder
-jpg
-jsx
-klass
-localhost
-lstripped
-mailto
-marketplacer
-matcher
-matchers
-maths
-merchantability
-multiline
-newlines
-noninfringement
-nonwords
-optparse
-org
-param
-params
-png
-pwd
-rakefile
-rdoc
-readme
-redisplay
-repo
-rspec
-rubocop
-rvm
-scss
-shelljoin
-shellsplit
-shellwords
-sherson
-spellr
-stderr
-stdlib
-stdout
-str
-stringscanner
-strscan
-sublicense
-subwords
-sudo
-svg
-thu
-tlds
-tmp
-todo
-tokenize
-tokenizes
-tsx
-ttf
-txt
-uploader
-uri
-usr
-utf
-wordlist
-wordlists
-wordn't
-xdescribe
-xit
-yardoc
-yml