texsc 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66cf2c3cd1fdf24062daf97f76e2a1d2a9bbc7496d4de4b110863fa9a05e34f7
-  data.tar.gz: 9482805d7979f80530858c721bcccb1cc80f9b01a59edf3c79e320a22979a90a
+  metadata.gz: 5c17175ccf4ff188118c169998a047fcffff963bba7bb6c0091e8009ab649765
+  data.tar.gz: 676f6c7eb559122c01aa94850f26341486ca3d69c171a23a8b79a987179919e4
 SHA512:
-  metadata.gz: 37f58dc30b1ccadd1edf187b5264d2f95d078c9502ab946711728c88f08bde644dd78a8285b25cec7f793ea5103cf5c8657e5b312fb04000068e1ed429bb19a6
-  data.tar.gz: 7477be10ec95d87d4a39429fedb65fa132227afa3b14c5238a5e470eaf7e64f9248473cb92d9e3306c5d8f75ad0cb22cb88c2ef0b12075b09dd003d85941e94a
+  metadata.gz: 4c63654aeaf9750b6b4084d112b0ccfd5c3460f679e8361027e2955d0c10a48c714bd8e3d177249fc5d14119697d5cea4544d551e3d5208d9589bfacf89841f2
+  data.tar.gz: b0714b11c3c1dcb4eff8463314c5bf195f373c034dba9600aa1a5c732cc30fcd1b3911970157d5c843d0d5cc67543502629f036c8d4b7861b18444b0fd036aae

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/.simplecov

@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Yegor Bugayenko
+# Copyright (c) 2020-2021 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2020 Yegor Bugayenko
+# Copyright (c) 2020-2021 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

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/Rakefile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2020 Yegor Bugayenko
+# Copyright (c) 2020-2021 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/bin/texsc

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Copyright (c) 2020 Yegor Bugayenko
+# Copyright (c) 2020-2021 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -21,19 +21,30 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-VERSION = '0.4.0'
+VERSION = '0.5.1'
 
 STDOUT.sync = true
 
 require 'backtrace'
 require 'loog'
 require 'open3'
+require 'shellwords'
 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 +71,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
@@ -74,18 +86,23 @@ Options are:"
     end
     log.info("Checking #{f} (#{tex.length} chars)...")
     log.debug(
-      tex.split("\n")
-        .each_with_index.map { |t, i| format('%<pos>4d: %<line>s', pos: i + 1, line: t) }
-        .join("\n")
+      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']}",
+      Shellwords.escape("--ignore=#{opts['min-word-length']}"),
       '--dont-tex-check-comments',
       '--lang=en',
       '--mode=tex',
-      opts[:pws] ? "-p #{opts[:pws]}" : '',
-      ignores.map { |i| "--add-tex-command '#{i[:cmd]} #{i[:opts]}'" }.join(' '),
+      opts[:pws] ? "-p #{Shellwords.escape(opts[:pws])}" : '',
+      ignores.map do |i|
+        "--add-tex-command '#{Shellwords.escape(i[:cmd])} #{Shellwords.escape(i[:opts])}'"
+      end.join(' '),
       'pipe'
     ].join(' ')
     log.debug(cmd)
@@ -102,7 +119,7 @@ Options are:"
         log.info('aspell produced no output, hm...')
       else
         lines = out.split("\n")
-        log.info("aspell produced #{lines.length} lines of output")
+        log.debug("aspell produced #{lines.length} lines of output")
         lines.each_with_index do |t, i|
           if t.start_with?('&')
             log.info("[#{i}] #{t}")

data/features/step_definitions/steps.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2020 Yegor Bugayenko
+# Copyright (c) 2020-2021 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/features/support/env.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2020 Yegor Bugayenko
+# Copyright (c) 2020-2021 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/texsc.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2020 Yegor Bugayenko
+# Copyright (c) 2020-2021 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -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.4.0'
+  s.version = '0.5.1'
   s.license = 'MIT'
   s.summary = 'Spell Checker for LaTeX'
   s.description = 'Simple command-line spell checker for LaTeX documents'
@@ -46,7 +46,7 @@ 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_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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: texsc
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-30 00:00:00.000000000 Z
+date: 2021-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -44,14 +44,14 @@ 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