texsc 0.3.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1338246224d9ddf219b8b4193767dcb6ddc43314ce84e8e1c6379a08176010f2
-  data.tar.gz: 740893c232d33535750f17734ae05e160628a40c4994765db96fad1e1186f468
+  metadata.gz: '08fb045de44fe6a3e9d660fd9231b172a26b7905d98241e39d3086d0d2c4f7d9'
+  data.tar.gz: e2c60a9cb1f3daecd4cf69478c81d427f75cc0629767d2193a6691e7ab83c216
 SHA512:
-  metadata.gz: 308b393c03295b853346781afd52bd68052619240715a00aeb12baca4347bbd646ba1d48c58f774faf0a55f59058149544e604e85b3e29459a8304381e4b5e1e
-  data.tar.gz: d2b2056be3591b0b6c68e7eaa9e96765d8c31ee55dd4ca01591a02168a800d6a59d389d7be6dfa1b7381b73bc9cb423baaddbad9aada087e11dce545f32361c9
+  metadata.gz: bcee7468fdd0ea4671873b1269e8095a9af24e325daeee1493f4d71c0495816686094b6ce32c1eae9bbd114da7c220165d28e86da907957d13439fca2c2dcd4a
+  data.tar.gz: 9d89d67e6d611e7f83e42df8b40058990052396cea5453bfd37d3e0e027de36fb82c942bb4b2ee2a173c5c89ed2fa67624252723728e3212d6186a59d01b6087

data/.rubocop.yml

@@ -11,7 +11,7 @@ Layout/EndOfLine:
 Style/MultilineTernaryOperator:
   Enabled: false
 Metrics/BlockLength:
-  Max: 50
+  Max: 60
 Layout/AlignParameters:
   Enabled: false
 Layout/EmptyLineAfterGuardClause:

data/README.md

@@ -14,6 +14,8 @@
 [![Test Coverage](https://img.shields.io/codecov/c/github/yegor256/texsc.svg)](https://codecov.io/github/yegor256/texsc?branch=master)
 [![Hits-of-Code](https://hitsofcode.com/github/yegor256/texsc)](https://hitsofcode.com/view/github/yegor256/texsc)
 
+Read this blog post: [_Spell Check Your LaTeX Writings Using GNU Aspell_](https://www.yegor256.com/2020/10/06/latex-spell-checking.html)
+
 This tool simplies the usage of [GNU aspell](http://aspell.net/)
 (you must have it installed)
 for spell-checking of LaTeX files.

data/bin/texsc

@@ -21,7 +21,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-VERSION = '0.3.2'
+VERSION = '0.5.0'
 
 STDOUT.sync = true
 
@@ -32,8 +32,18 @@ require 'slop'
 
 begin
   log = Loog::REGULAR
+  args = []
+  if File.exist?('.texsc')
+    cfg = File.new('.texsc')
+    body = File.read(cfg)
+    extra = body.split(/\s+/).map(&:strip)
+    args += extra
+    puts "Found #{body.split(/\n/).length} lines in #{File.absolute_path(cfg)}"
+  end
+  args += ARGV
+
   begin
-    opts = Slop.parse(ARGV, strict: true, help: true) do |o|
+    opts = Slop.parse(args, strict: true, help: true) do |o|
       o.banner = "Usage (#{VERSION}): texsc [options] files
 Options are:"
       o.string '--pws', 'The location of aspell.en.pws file'
@@ -60,6 +70,7 @@ Options are:"
     log.debug("PWS with an additional dictionary is here: #{opts[:pws]}")
     opts[:pws] = File.expand_path(opts[:pws])
     log.debug("The real path of PWS is: #{opts[:pws]}")
+    raise "The PWS file #{opts[:pws].inspect} is not found" unless File.exist?(opts[:pws])
   end
   errors = 0
   files = 0
@@ -73,6 +84,14 @@ Options are:"
       tex = tex.gsub(/\\begin{#{Regexp.escape(i[:cmd])}}.+\\end{#{Regexp.escape(i[:cmd])}}/m, '')
     end
     log.info("Checking #{f} (#{tex.length} chars)...")
+    log.debug(
+      tex.split("\n").each_with_index.map do |t, i|
+        if t.start_with?('---')
+          log.info("Line #{i + 1} starts with '---', this may lead to unexpected errors")
+        end
+        format('%<pos>4d: %<line>s', pos: i + 1, line: t)
+      end.join("\n")
+    )
     cmd = [
       'aspell',
       "--ignore=#{opts['min-word-length']}",
@@ -93,10 +112,16 @@ Options are:"
         raise "Failed to run aspell, exit code is #{status}"
       end
       out = stdout.read
-      unless out.nil?
-        out.split("\n").select { |t| t.start_with?('&') }.each do |t|
-          log.info(t)
-          errors += 1
+      if out.nil?
+        log.info('aspell produced no output, hm...')
+      else
+        lines = out.split("\n")
+        log.debug("aspell produced #{lines.length} lines of output")
+        lines.each_with_index do |t, i|
+          if t.start_with?('&')
+            log.info("[#{i}] #{t}")
+            errors += 1
+          end
         end
       end
     end

data/features/cli.feature

@@ -26,7 +26,7 @@ Feature: Command Line Processing
     How are you, my dear friiend?
     \end{document}
     """
-    When I run bin/texsc with "article.tex"
+    When I run bin/texsc with "--verbose article.tex"
     Then Exit code is not zero
     And Stdout contains "& friiend "
 

data/texsc.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '2.2'
   s.required_ruby_version = '>= 2.3'
   s.name = 'texsc'
-  s.version = '0.3.2'
+  s.version = '0.5.0'
   s.license = 'MIT'
   s.summary = 'Spell Checker for LaTeX'
   s.description = 'Simple command-line spell checker for LaTeX documents'
@@ -46,8 +46,8 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
   s.add_runtime_dependency 'backtrace', '~> 0.3'
   s.add_runtime_dependency 'loog', '~> 0.2'
-  s.add_runtime_dependency 'slop', '~> 4.6'
-  s.add_development_dependency 'codecov', '0.1.10'
+  s.add_runtime_dependency 'slop', '~> 4.8'
+  s.add_development_dependency 'codecov', '0.2.8'
   s.add_development_dependency 'cucumber', '~> 1.3.17'
   s.add_development_dependency 'rake', '12.0.0'
   s.add_development_dependency 'rubocop', '0.61.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: texsc
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-07 00:00:00.000000000 Z
+date: 2020-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4.8'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 0.2.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 0.2.8
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement