alfonsox 0.1.1 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cee871a10b135714609282f329b904e12cccc9cc1b4d0d9291ea6cc77ee87ed
-  data.tar.gz: 7aadff2c99d553a4fa964bf2bb519e190648a9471674a2464e3c669721f6af9c
+  metadata.gz: 8ca11c18b4eb8c01ef6470328f9f4707283501fff3f7c7ebeddc46cb3b8eba75
+  data.tar.gz: 1fce3b0a3819a688a467d70722186de55735acd3d427c3cba1dae1c1f6d798f6
 SHA512:
-  metadata.gz: 8878a20418c1fc122944db6f5ece7f4a3221ec3e294f37e3e059316c5cf3149eb309037088ea39a860f791ff03c19d1e71380da89768b65d0a825810c8627a81
-  data.tar.gz: 17ac27c4c7615f3b74549f2b7b3d2bda8ab86820b6acad7e69beaac6232d4dfb07d8037a7f6e115c61e61ec633ec474da64d7de9a0ea1565099574231333b2e6
+  metadata.gz: d4c63a337913d15722c4c3edadd94a970fe6c93dd919953b5fa5a5ded821f03cf2f4cd9995a76b1b85fdbd4bd207c95ca2f1467b72dd748d44efabd180dee05c
+  data.tar.gz: 753362cf0d9ffca8386b52c5928accaccf1302e93876e80a4c0b253d5e68990499724674e04c93634e05a88292e6a5cabef980ffdf60c6167b081630acdea80f

data/Gemfile

@@ -1,8 +1,7 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in alfonsox.gemspec
 gemspec
 
 group :development, :test do

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    alfonsox (0.1.1)
-      hunspell
-      nokogiri (>= 1.8.5)
+    alfonsox (0.2.5)
+      hunspell (~> 1.1, >= 1.1.0)
+      nokogiri (~> 1.8, >= 1.8.5)
 
 GEM
   remote: https://rubygems.org/
@@ -91,4 +91,4 @@ DEPENDENCIES
   simplecov-console
 
 BUNDLED WITH
-   1.16.2
+   1.17.3

data/README.md

@@ -21,7 +21,7 @@ gem 'alfonsox'
 And then execute:
 
 ```bash
-$ bundle
+$ bundle install
 ```
 
 Or install it yourself as:
@@ -106,54 +106,9 @@ Dictionaries:
     type: 'rubymine'
 ```
 
-#### Rake task
+#### Comnand line tool
 
-To use the rake task, you have to include the two following lines
-in your project's Rakefile:
-
-```ruby
-alfonsox_gem = Gem::Specification.find_by_name('alfonsox')
-load("#{alfonsox_gem.gem_dir}/Rakefile")
-```
-
-That two lines load all Alfonso X tasks' in your Rakefile.
-
-Our aim is to use **alfonsox:spellcheck** task.
-
-##### Default configuration
-
-There is a [default configuration](/resources/configurations/default.yml)
-that will check US-English spelling and your RubyMine dictionary with your
-custom spellings.
-
-```bash
-bundle exec rake alfonsox:spellcheck
-```
-
-##### Custom configuration
-
-Copy the [default configuration](/resources/configurations/default.yml)
-to your project root directory and modify it
-
-```bash
-bundle exec rake alfonsox:spellcheck[<path/where/alfonsox.yml/file/is>]
-```
-
-e.g.:
-
-```bash
-bundle exec rake alfonsox:spellcheck[.alfonsox.yml]
-```
-
-The rake task will output the spell checking errors, e.g.:
-
-```bash
-$ bundle exec rake alfonsox:spellcheck[./test/resources/config.yml]
-Starting spellcheck using configuration ./test/resources/config.yml
-/Users/diegoj/proyectos/alfonsox/test/alfonsox_test.rb:8 jane
-/Users/diegoj/proyectos/alfonsox/test/alfonsox_test.rb:8 austen
-/Users/diegoj/proyectos/alfonsox/test/alfonsox_test.rb:70 neighbourhood
-```
+Just call **bundle exec alfonsox** and it should work fine, informing of any orthographic error in your code files.
 
 ### Overcommit integration
 
@@ -178,7 +133,7 @@ module Overcommit::Hook::PreCommit
 
       # Run rake spellcheck task
       args = flags + applicable_files
-      result = execute('bundle exec rake alfonsox:spellcheck[.alfonsox.yml]', args: args)
+      result = execute('bundle exec alfonsox', args: args)
       spellchecking_errors = result.split('\n')
 
       # Check the if there are spelling errors

data/Rakefile

@@ -24,20 +24,8 @@ namespace :alfonsox do
   end
 
   desc 'Spell checks a project'
-  task :spellcheck, [:config_path] => [] do |_t, args|
-    if args.config_path
-      puts "Starting spellcheck using configuration #{args.config_path}"
-    else
-      puts 'No custom configuration, starting spellcheck using default configuration'
-    end
-    config_path = args.config_path || ALFONSOX_DEFAULT_CONFIGURATION_PATH
-    spellchecker = AlfonsoX::SpellChecker::Main.from_config(config_path)
-    spellchecker_errors_by_file = spellchecker.check
-    spellchecker_errors_by_file.each do |file_path, spellchecker_errors|
-      spellchecker_errors.each do |spellchecker_error_i|
-        puts "#{file_path}:#{spellchecker_error_i.line} #{spellchecker_error_i.word}"
-      end
-    end
+  task :spellcheck do
+    AlfonsoX::CLI.new.run
   end
 end
 

data/alfonsox.gemspec

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'alfonsox/version'
+require_relative './lib/alfonsox/constants'
+require_relative './lib/alfonsox/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'alfonsox'
@@ -11,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.email         = ['diegojromerolopez@gmail.com']
 
   spec.summary       = 'Spell checker for code'
-  spec.description   = 'Spell checker for code'
-  spec.homepage      = 'https://github.com/diegojromerolopez/alfonsox'
+  spec.description   = 'Tool to detect orthography errors your code files'
+  spec.homepage      = AlfonsoX::REPOSITORY_URL
   spec.license       = 'MIT'
 
   # Specify which files should be added to the gem when it is released.
@@ -22,14 +21,15 @@ Gem::Specification.new do |spec|
       f.match(%r{^(test|spec|features)/})
     end
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = ['alfonsox']
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'hunspell'
-  spec.add_dependency 'nokogiri', '>= 1.8.5'
+  spec.required_ruby_version = '>= 2.4'
+
+  spec.add_dependency 'hunspell', '~> 1.1', '>= 1.1.0'
+  spec.add_dependency 'nokogiri', '~> 1.8', '>= 1.8.5'
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
 end

data/bin/alfonsox

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'alfonsox/cli'
+
+AlfonsoX::CLI.new.run

data/config/default.yml

@@ -0,0 +1,10 @@
+Paths:
+- 'app/*/**.rb'
+- 'lib/**.rb'
+- 'test/**.rb'
+Dictionaries:
+  EnglishDictionaryFromGem:
+    type: 'hunspell'
+    language: 'en_US'
+  RubymineDictionary:
+    type: 'rubymine'

data/lib/alfonsox/cli.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'alfonsox'
+
+# Alfonso X module
+module AlfonsoX
+  # Command Line Interpreter tool for Alfonso X
+  class CLI
+    # Success exit status code
+    SUCCESS_EXIT_STATUS = 0
+
+    # Error exit status code
+    ERROR_EXIT_STATUS = 1
+
+    # Take the config file path
+    def initialize
+      @config_file_path = config_file_path
+    end
+
+    # 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
+      exit_status = SUCCESS_EXIT_STATUS
+      spellchecker_errors_by_file.each do |file_path, spellchecker_errors|
+        spellchecker_errors.each do |spellchecker_error_i|
+          print_spellcheck_error(file_path, spellchecker_error_i)
+          exit_status = ERROR_EXIT_STATUS
+        end
+      end
+
+      print_status(exit_status)
+      exit(exit_status)
+    end
+
+    private
+
+    # Return the config file path
+    # @return [String] config file path that will be used when running Alfonso X tool.
+    def config_file_path
+      repo_config_file_path_yml = File.join(AlfonsoX::Utils.repo_root, AlfonsoX::CONFIG_FILE_NAME)
+      return repo_config_file_path_yml if File.exist?(repo_config_file_path_yml)
+      File.join(AlfonsoX::CONFIG_PATH, 'default.yml')
+    end
+
+    # Shows a lone spellcheck error in the standard error output
+    def print_spellcheck_error(file_path, spellchecker_error)
+      STDERR.puts "#{file_path}:#{spellchecker_error.line} #{spellchecker_error.word}"
+    end
+
+    # Print status of the spellcheck
+    def print_status(exit_status)
+      if exit_status == SUCCESS_EXIT_STATUS
+        print_success_status
+      elsif exit_status == ERROR_EXIT_STATUS
+        print_error_status
+      end
+    end
+
+    # Informs that everything went well
+    def print_success_status
+      STDOUT.puts '✔ Code is spell-checked correctly'
+    end
+
+    # Informs that something went wrong
+    def print_error_status
+      STDERR.puts '✗ Errors in in code spellchecking'
+    end
+  end
+end

data/lib/alfonsox/constants.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Alfonso X module
+module AlfonsoX
+  ROOT_PATH = "#{__dir__}/../.."
+  CONFIG_PATH = "#{AlfonsoX::ROOT_PATH}/config"
+  LIB_PATH = "#{AlfonsoX::ROOT_PATH}/lib"
+  RESOURCES_PATH = "#{AlfonsoX::ROOT_PATH}/resources"
+  DICTIONARIES_PATH = "#{AlfonsoX::RESOURCES_PATH}/dictionaries"
+  DEFAULT_CONFIGURATION_PATH = "#{AlfonsoX::CONFIG_PATH}/config/default.yml"
+
+  # Configuration file name in repositories that use this tool
+  CONFIG_FILE_NAME = '.alfonsox.yml'
+
+  # Alfonso X repository URL
+  REPOSITORY_URL = 'https://github.com/diegojromerolopez/alfonsox'
+end

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

@@ -57,12 +57,17 @@ module AlfonsoX
 
         # Other common but erroneous words in the Ruby-development world
         OTHERS = %w[
+          asc
           autorun
           autotest
+          bigint
           config
           const
           cov
+          datetime
+          desc
           dir
+          env
           formatter
           klass
           rb

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

@@ -9,7 +9,7 @@ module AlfonsoX
       # Hunspell dictionary loader
       class Hunspell
         # Default hunspell dictionary path
-        DEFAULT_PATH = "#{ALFONSOX_DICTIONARIES_PATH}/hunspell"
+        DEFAULT_PATH = "#{AlfonsoX::DICTIONARIES_PATH}/hunspell"
         # All atributtes are readable
         attr_reader :language, :path
 
@@ -43,7 +43,7 @@ module AlfonsoX
       # Finds the dictionary in this Gem
       class DictionaryFinder
         attr_reader :aff_file_path, :dic_file_path
-        PATH = "#{ALFONSOX_DICTIONARIES_PATH}/hunspell"
+        PATH = "#{AlfonsoX::DICTIONARIES_PATH}/hunspell"
 
         def initialize(language, path = nil)
           @language = language
@@ -53,7 +53,7 @@ module AlfonsoX
         end
 
         def find
-          paths = [@path, "#{ALFONSOX_DICTIONARIES_PATH}/hunspell"].compact
+          paths = [@path, "#{AlfonsoX::DICTIONARIES_PATH}/hunspell"].compact
           paths.each do |path|
             @aff_file_path, @dic_file_path = DictionaryFinder.find_from_language(@language, path)
             return true if @aff_file_path && @dic_file_path

data/lib/alfonsox/utils.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'English'
+
+# A Alfonso X module
+module AlfonsoX
+  # Utils for Alfonso X
+  module Utils
+    # Module static methods
+    class << self
+      # Returns an absolute path to the root of the repository.
+      #
+      # Stolen from Overcommit::Utils#repo_root
+      #
+      # We do this ourselves rather than call `git rev-parse --show-toplevel` to
+      # solve an issue where the .git directory might not actually be valid in
+      # tests.
+      #
+      # @return [String] GIT root file path
+      def repo_root
+        result = `git rev-parse --show-toplevel`
+        raise 'Not in git repository' unless $CHILD_STATUS.success?
+        result.chomp("\n")
+      end
+    end
+  end
+end

data/lib/alfonsox/version.rb

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

data/lib/alfonsox.rb

@@ -1,12 +1,8 @@
 # frozen_string_literal: true
 
-# Some useful path constants
-ALFONSOX_LIB_PATH = __dir__
-ALFONSOX_RESOURCES_PATH = "#{__dir__}/../resources"
-ALFONSOX_DICTIONARIES_PATH = "#{ALFONSOX_RESOURCES_PATH}/dictionaries"
-ALFONSOX_DEFAULT_CONFIGURATION_PATH = "#{ALFONSOX_RESOURCES_PATH}/configurations/default.yml"
-
 require 'alfonsox/version'
+require 'alfonsox/constants'
+require 'alfonsox/utils'
 require 'alfonsox/spellchecker/dictionaries'
 require 'alfonsox/spellchecker/main'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alfonsox
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.5
 platform: ruby
 authors:
 - Diego J. Romero López
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-06-11 00:00:00.000000000 Z
+date: 2019-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hunspell
@@ -16,18 +16,27 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.5
@@ -35,6 +44,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.5
@@ -84,20 +96,21 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Spell checker for code
+        version: '0.16'
+description: Tool to detect orthography errors your code files
 email:
 - diegojromerolopez@gmail.com
-executables: []
+executables:
+- alfonsox
 extensions: []
 extra_rdoc_files: []
 files:
@@ -112,9 +125,11 @@ files:
 - README.md
 - Rakefile
 - alfonsox.gemspec
-- bin/console
-- bin/setup
+- bin/alfonsox
+- config/default.yml
 - lib/alfonsox.rb
+- lib/alfonsox/cli.rb
+- lib/alfonsox/constants.rb
 - lib/alfonsox/spellchecker/dictionaries.rb
 - lib/alfonsox/spellchecker/dictionary/default.rb
 - lib/alfonsox/spellchecker/dictionary/hunspell.rb
@@ -123,6 +138,7 @@ files:
 - lib/alfonsox/spellchecker/file.rb
 - lib/alfonsox/spellchecker/main.rb
 - lib/alfonsox/spellchecker/word.rb
+- lib/alfonsox/utils.rb
 - lib/alfonsox/version.rb
 - resources/configurations/default.yml
 - resources/dictionaries/hunspell/README.md
@@ -306,15 +322,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Spell checker for code

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'alfonsox'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here