alfonsox 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55888345dcf01140ee8a7603eaaeb1c0976cc8066a5cbd61015324f486686914
-  data.tar.gz: 78640ce9cc851ce6b3e0b154f2840b5c6aa5678518f2ac6ce55e1fe160a2394e
+  metadata.gz: 46aba9cc362ba13a198ed04c55a31f0c7ea8a8305f1ae89f8b89a7e39e6a3c97
+  data.tar.gz: a4bd31552791e901798ceab360ddc4ad71f8fb342cd285009a1025750d9ccc59
 SHA512:
-  metadata.gz: 63de29a23988e785e53ff235ed99bda02cdd1b35408f7939c969febc538b4dc70a607fdae95cfba3258980156e690f4491c235dffc81c0245d1e6bb421ec6095
-  data.tar.gz: 02e19169097964499735b933e8dd41fe9417e435387574db6bea4968cb2ebe2a7a44ae3ca19c3d67484f27a60144c26fc131e2938fae384c0323738aa1b844a1
+  metadata.gz: 2dccb7d3ff2ac28df3273762787d5c32a7646c5395c1aa46caa9399c3a7b0c0c3b0c2e446d2a0fc72028c4def6786124fe42096576c1b2261cce99701a1fdf3d
+  data.tar.gz: c74839001cc6b6f18d56d0393ad39676fb43f9af7c8b66eac070d74d8a3701cee1327602373b19df01656c2a69c4ed325da60e5ea38c40a3a4dc634980924f72

data/.travis.yml

@@ -1,6 +1,8 @@
 before_install:
 - sudo apt-get update
 - sudo apt-get install -y hunspell libhunspell-dev build-essential
+- gem update --system
+- bundle install
 env:
   global:
   - CC_TEST_REPORTER_ID=c6f6f48c884645f1b5cf6adaccd1c837b19989c5b88e430e5c217ca93cbe07dd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    alfonsox (0.2.6)
+    alfonsox (0.2.7)
       hunspell (~> 1.1, >= 1.1.0)
       nokogiri (~> 1.8, >= 1.8.5)
 

data/README.md

@@ -110,6 +110,9 @@ Dictionaries:
 
 Just call **bundle exec alfonsox** and it should work fine, informing of any orthographic error in your code files.
 
+The arguments must be the full paths of the file to be checked. If no arguments are passed to this tool, all files
+that fulfill the paths defined in the configuration file will be checked.
+
 ##### Output
 
 ###### Successful Output
@@ -117,7 +120,7 @@ Just call **bundle exec alfonsox** and it should work fine, informing of any ort
 Note the output is written in standard output (STDOUT).
 
 ```bash
-$ bundle exec alfonsox
+$ bundle exec alfonsox file1 file2 #...
 ✔ Code is spell-checked correctly
 ```
 
@@ -133,7 +136,7 @@ $ echo $?
 Note the output is written in error standard output (STDERR).
 
 ```bash
-$ bundle exec alfonsox
+$ bundle exec alfonsox file1 file2 #...
 /Users/diegoj/proyectos/blobik/app/models/post.rb:2 incorrektword
 ✗ Errors in code spellchecking
 ```

data/lib/alfonsox/cli.rb

@@ -20,7 +20,12 @@ module AlfonsoX
     # Run spell-check on files specified by config file
     def run
       spellchecker = AlfonsoX::SpellChecker::Main.from_config(@config_file_path)
-      spellchecker_errors_by_file = spellchecker.check
+      spellchecker_errors_by_file = if ARGV&.length&.positive?
+                                      spellchecker.check(ARGV)
+                                    else
+                                      spellchecker.check_all
+                                    end
+
       exit_status = SUCCESS_EXIT_STATUS
       spellchecker_errors_by_file.each do |file_path, spellchecker_errors|
         spellchecker_errors.each do |spellchecker_error_i|

data/lib/alfonsox/spellchecker/main.rb

@@ -50,7 +50,7 @@ module AlfonsoX
 
       # Spellcheck all the paths.
       # @return [Array<AlfonsoX::SpellChecker::Word>] array of the incorrect words by file.
-      def check
+      def check_all
         incorrect_words_by_file = {}
         @paths.each do |path|
           rb_file_paths = Dir.glob(path).map { |expanded_path| ::File.realpath(expanded_path) }
@@ -63,6 +63,20 @@ module AlfonsoX
         incorrect_words_by_file
       end
 
+      # Spellcheck some files.
+      # @param [Array<String>] applicable_files List of full file paths that will be spell-checked. Optional.
+      # @return [Array<AlfonsoX::SpellChecker::Word>] array of the incorrect words by file.
+      def check(applicable_files = nil)
+        return check_all unless applicable_files
+        incorrect_words_by_file = {}
+        applicable_files.each do |applicable_file_i|
+          file_incorrect_words = check_file(applicable_file_i)
+          next unless file_incorrect_words.length.positive?
+          incorrect_words_by_file[applicable_file_i] = file_incorrect_words
+        end
+        incorrect_words_by_file
+      end
+
       private
 
       # Spellcheck a file given its file_path.

data/lib/alfonsox/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alfonsox
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Diego J. Romero López