alfonsox 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46aba9cc362ba13a198ed04c55a31f0c7ea8a8305f1ae89f8b89a7e39e6a3c97
-  data.tar.gz: a4bd31552791e901798ceab360ddc4ad71f8fb342cd285009a1025750d9ccc59
+  metadata.gz: 1eb7a727afac3198e29057bfa16aa7ad179062015f281bae0ec51029ce8de4a4
+  data.tar.gz: a97c686d226547dfa8573621ccdb2cc406bbd2c18b43614e553fb0fb0a1f6c06
 SHA512:
-  metadata.gz: 2dccb7d3ff2ac28df3273762787d5c32a7646c5395c1aa46caa9399c3a7b0c0c3b0c2e446d2a0fc72028c4def6786124fe42096576c1b2261cce99701a1fdf3d
-  data.tar.gz: c74839001cc6b6f18d56d0393ad39676fb43f9af7c8b66eac070d74d8a3701cee1327602373b19df01656c2a69c4ed325da60e5ea38c40a3a4dc634980924f72
+  metadata.gz: f0d8372493aac5c40c420c12fcf8906dd4da59982735f23dc4d8c9dd019b98d50b0a417f6ce6d718ab1a553606e9af8164c0443a91e6e5cadfcf68ac3732e899
+  data.tar.gz: d27ac0b3ae3762e884fefde2fdd346a789a3b43ec8913379ae9b41f691da6029ef6aa93f2cdbc7d774ed1f414bb42d4127d03b82f82acf6f4f3ad0e634824a2a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    alfonsox (0.2.7)
+    alfonsox (0.2.8)
       hunspell (~> 1.1, >= 1.1.0)
       nokogiri (~> 1.8, >= 1.8.5)
 
@@ -22,54 +22,55 @@ GEM
       descendants_tracker (~> 0.0.1)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
-    docile (1.3.1)
+    docile (1.3.2)
     equalizer (0.0.11)
-    ffi (1.9.25)
-    hirb (0.7.3)
+    ffi (1.11.1)
     hunspell (1.1.0)
     ice_nine (0.11.2)
     iniparse (1.4.4)
-    jaro_winkler (1.5.1)
-    json (2.1.0)
+    jaro_winkler (1.5.3)
+    json (2.2.0)
     kwalify (0.7.2)
     mini_portile2 (2.4.0)
     minitest (5.11.3)
     nokogiri (1.10.3)
       mini_portile2 (~> 2.4.0)
-    overcommit (0.46.0)
+    overcommit (0.48.1)
       childprocess (~> 0.6, >= 0.6.3)
       iniparse (~> 1.4)
-    parallel (1.12.1)
-    parser (2.5.3.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
       ast (~> 2.4.0)
-    powerpack (0.1.2)
+    psych (3.1.0)
     rainbow (3.0.0)
     rake (10.5.0)
-    reek (5.2.0)
+    reek (5.4.0)
       codeclimate-engine-rb (~> 0.4.0)
       kwalify (~> 0.7.0)
-      parser (>= 2.5.0.0, < 2.6, != 2.5.1.1)
+      parser (>= 2.5.0.0, < 2.7, != 2.5.1.1)
+      psych (~> 3.1.0)
       rainbow (>= 2.0, < 4.0)
-    rubocop (0.60.0)
+    rubocop (0.72.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
-    simplecov (0.16.1)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    simplecov (0.17.0)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
-    simplecov-console (0.4.2)
+    simplecov-console (0.5.0)
       ansi
-      hirb
       simplecov
+      terminal-table
     simplecov-html (0.10.2)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
     thread_safe (0.3.6)
-    unicode-display_width (1.4.0)
+    unicode-display_width (1.6.0)
     virtus (1.0.5)
       axiom-types (~> 0.1)
       coercible (~> 1.0)

data/README.md

@@ -79,7 +79,14 @@ Dictionaries:
     type: 'rubymine'
     # Optional, by default is '.idea/dictionary.xml'
     path: '.idea/dictionary.xml'
-  
+
+  # Include in this section a file path with a list of custom words or words
+  # Note the file must contain a word per line
+  # that do not appear in other dictionaries
+  WordListFileictionary:
+   type: 'word_list'
+   path: 'your/word/list/file/path'
+ 
   # Include in this section a list of custom words or words
   # that do not appear in other dictionaries
   WordListDictionary:
@@ -150,72 +157,30 @@ $ echo $?
 
 ### Overcommit integration
 
-[Overcommit](https://github.com/sds/overcommit)
-is a project whose aim is to provide developers
+Easiest way of use this project is to use [Overcommit](https://github.com/sds/overcommit).
+For those of you that don't know it, it is a project whose aim is to provide developers
 with tools to check code quality easily.
 
-[Define a new pre-commit hook in your repository](https://github.com/sds/overcommit#repo-specific-hooks):
-
-Add a file **.git-hooks/pre_commit/alfonsox.rb** with the following contents:
-
-```ruby
-# frozen_string_literal: true
-
-module Overcommit::Hook::PreCommit
-  #
-  # Spell check of the code.
-  #
-  class AlfonsoX < Base
-    def run
-      # Create default file config if it does not exist
-
-      # Run rake spellcheck task
-      args = flags + applicable_files
-      result = execute('bundle exec alfonsox', args: args)
-      spellchecking_errors = result.split('\n')
-
-      # Check the if there are spelling errors
-      return :pass if spellchecking_errors.length.zero?
-
-      error_messages(spellchecking_errors)
-    end
-
-    private
-
-    # Create the error messages
-    def error_messages(spellchecking_errors)
-      messages = []
-      spellchecking_errors.each do |spellchecking_error_i|
-        error_location, word = spellchecking_error_i.split(' ')
-        error_file_path, line = error_location.split(':')
-        messages << Overcommit::Hook::Message.new(
-          :error, error_file_path, line, "#{error_location}: #{word}"
-        )
-      end
-      messages
-    end
-  end
-end
-```
-
-Make sure you have a configuration in the root directory of your project with
-the name **.alfonsox.yml**:
+It has a
+[CodeSpellCheck](https://github.com/sds/overcommit/blob/master/lib/overcommit/hook/pre_commit/code_spell_check.rb)
+pre-commit hook that accepts an Alfonso X configuration, by default is:
 
 ```yml
 Paths:
-- '*/**.rb'
+- 'app/*/**.rb'
+- 'lib/**.rb'
+- 'test/**.rb'
 Dictionaries:
   EnglishDictionaryFromGem:
     type: 'hunspell'
     language: 'en_US'
   RubymineDictionary:
     type: 'rubymine'
-  WordListDictionary:
-    type: 'word_list'
-    word_list:
-    - 'alfonso'
 ```
 
+If you want to overwrite it, create an **.alfonsox.yml** file in your
+home directory and write your custom spell-check configuration there.
+
 ### From code
 
 #### Load dictionaries
@@ -288,7 +253,7 @@ I accept contribution and feature requests via PR (GitHub pull requests).
 Create an issue or send me an email before making a PR
 if you are unsure about if your PR is going to be accepted.
 
-Any constructive criticism is welcomed.
+Any suggestion, issue or constructive criticism is also welcomed.
 
 ## Why the name?
 

data/lib/alfonsox/spellchecker/dictionaries.rb

@@ -3,4 +3,5 @@
 require 'alfonsox/spellchecker/dictionary/rubymine'
 require 'alfonsox/spellchecker/dictionary/hunspell'
 require 'alfonsox/spellchecker/dictionary/word_list'
+require 'alfonsox/spellchecker/dictionary/word_list_file'
 require 'alfonsox/spellchecker/dictionary/default'

data/lib/alfonsox/spellchecker/dictionary/hunspell.rb

@@ -10,7 +10,7 @@ module AlfonsoX
       class Hunspell
         # Default hunspell dictionary path
         DEFAULT_PATH = "#{AlfonsoX::DICTIONARIES_PATH}/hunspell"
-        # All atributtes are readable
+        # All attributes are readable
         attr_reader :language, :path
 
         # Construct a hunspell dictionary object for this package
@@ -25,14 +25,12 @@ module AlfonsoX
           new(yml_config['language'], yml_config.fetch('path') { DEFAULT_PATH })
         end
 
+        # Inform if a word is present in this dictionary.
         def word_present?(word)
           @spellchecker.spellcheck(word)
         end
 
-        def similar_words(word)
-          @spellchecker.suggest(word)
-        end
-
+        # Initialize spellchecker attribute
         def initialize_spellchecker(path)
           dictionary_finder = DictionaryFinder.new(@language, path)
           raise "'#{@language}' language Hunspell dictionary not found" unless dictionary_finder.find

data/lib/alfonsox/spellchecker/dictionary/rubymine.rb

@@ -14,23 +14,23 @@ module AlfonsoX
         DEFAULT_PATH = '.idea/dictionaries'
         attr_reader :path
 
+        # Initialize Rubymine dictionary
+        # If path is not present, it will be loaded from #DEFAULT_PATH.
         def initialize(path = nil)
           @path = path || DEFAULT_PATH
           load_dictionaries
         end
 
+        # Load configuration from YML
         def self.from_config(yml_config)
           new(yml_config.fetch('path') { DEFAULT_PATH })
         end
 
+        # Inform if a word is present in this dictionary.
         def word_present?(word)
           @words.include?(word.downcase)
         end
 
-        def similar_words(_word)
-          []
-        end
-
         private
 
         def load_dictionaries

data/lib/alfonsox/spellchecker/dictionary/word_list.rb

@@ -8,16 +8,20 @@ module AlfonsoX
     module Dictionary
       # Custom dictionary loader composed by a word list
       class WordList
+        attr_reader :words
+
         # Initialize a AlfonsoX::SpellChecker::Dictionary::WordList
         # @param [Array<String>] word_list Words that are included in this dictionary
         def initialize(word_list)
           @words = word_list.map(&:downcase)
         end
 
+        # Load from Yml
         def self.from_config(yml_config)
           new(yml_config.fetch('word_list') { [] })
         end
 
+        # Inform if a word is present in this dictionary.
         def word_present?(word)
           @words.include?(word.downcase)
         end

data/lib/alfonsox/spellchecker/dictionary/word_list_file.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+
+# Alfonso X module
+module AlfonsoX
+  module SpellChecker
+    module Dictionary
+      # Custom dictionary loader composed by a word list from a file
+      class WordListFile
+        attr_reader :words
+
+        # Initialize a AlfonsoX::SpellChecker::Dictionary::WordListFile from a file path.
+        # Note the words must be in different lines.
+        # @param [String] word_list_file_path Word list file path.
+        def initialize(word_list_file_path)
+          word_list = ::File.readlines(word_list_file_path).map(&:chomp)
+          @words = word_list.map(&:downcase)
+        end
+
+        # Load from Yml
+        def self.from_config(yml_config)
+          new(yml_config['path'])
+        end
+
+        # Inform if a word is present in this dictionary.
+        def word_present?(word)
+          @words.include?(word.downcase)
+        end
+      end
+    end
+  end
+end

data/lib/alfonsox/spellchecker/main.rb

@@ -35,6 +35,7 @@ module AlfonsoX
           return AlfonsoX::SpellChecker::Dictionary::Hunspell if config_dictionary_type == 'hunspell'
           return AlfonsoX::SpellChecker::Dictionary::Rubymine if config_dictionary_type == 'rubymine'
           return AlfonsoX::SpellChecker::Dictionary::WordList if config_dictionary_type == 'word_list'
+          return AlfonsoX::SpellChecker::Dictionary::WordListFile if config_dictionary_type == 'word_list_file'
           raise "Dictionary type #{config_dictionary_type} is not recognized"
         end
 

data/lib/alfonsox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AlfonsoX
-  VERSION = '0.2.7'
+  VERSION = '0.2.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alfonsox
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Diego J. Romero López
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-29 00:00:00.000000000 Z
+date: 2019-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hunspell
@@ -135,6 +135,7 @@ files:
 - lib/alfonsox/spellchecker/dictionary/hunspell.rb
 - lib/alfonsox/spellchecker/dictionary/rubymine.rb
 - lib/alfonsox/spellchecker/dictionary/word_list.rb
+- lib/alfonsox/spellchecker/dictionary/word_list_file.rb
 - lib/alfonsox/spellchecker/file.rb
 - lib/alfonsox/spellchecker/main.rb
 - lib/alfonsox/spellchecker/word.rb