texsc 0.4.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 287fe4226d8590443fd5fdc6e6f1484f958ebc59fa995b144dd3810e96eb7568
-  data.tar.gz: 5a4cc39bd64baece9b719e30e181c7362ace4c6768562d117a8501aed0efc46f
+  metadata.gz: ef95432484b7b9ba335b54f67ba8a6353ac200f029a02656644b65a08199e9e4
+  data.tar.gz: e8f5f024fe483de15e1aad8818c07b145223914a4adfb3ecb8f3725a22335534
 SHA512:
-  metadata.gz: 6ca3c9aa54f93f8cc592f89210889fb85c7d2078c461465d0fd0a20189a95852ab50524fbf267c443d7eca8ba4264c9d8fec1fcd19e9897928ee0b524c095430
-  data.tar.gz: 23481f20b3e4be353df48a77ec4fab49f689465b9fc2f92b8ff3c2ca557136a6969bb65ae7ffc1c7129128aeb5464d93efb341b3bd85bcd41b8413c67a714d05
+  metadata.gz: 0dc98754b887f94d392eeab60b88bce43f6fe4c6ca73fc668b837d71824ace15d8952851022bdbaf37fbaf7b6e9e9e18d7bdd5e4e5cf8a6ca15e11ad07c7d563
+  data.tar.gz: 36489da384178533cff6b3b7e05d9bed796ff6d735bb3495ed1128a9ec524fad8865a7196f4612ab48b311ec9d947870a592b97cbc2667d6d6144885443a09fd

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.
@@ -55,6 +57,11 @@ this:
 personal_ws-1.1 en 1 utf-8
 ```
 
+To make configuration easier, you can create `.texsc` file next to your
+`.tex` file and place all your command line configuration options over there,
+each one on its own line. You can also have a global configuration file
+at `~/.texsc`, which will be read first.
+
 ## How to contribute
 
 Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).

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,33 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-VERSION = '0.4.3'
+VERSION = '0.7.0'
 
 STDOUT.sync = true
 
 require 'backtrace'
 require 'loog'
 require 'open3'
+require 'shellwords'
 require 'slop'
 
+def config(path)
+  args = []
+  f = File.expand_path(path)
+  if File.exist?(f)
+    body = File.read(f)
+    args += body.split(/\s+/).map(&:strip)
+    puts "Found #{args.length} lines in #{File.absolute_path(f)}"
+  end
+  args
+end
+
 begin
   log = Loog::REGULAR
+  args = config('~/.texsc') + config('.texsc') + 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'
@@ -55,7 +69,8 @@ Options are:"
   rescue Slop::Error => ex
     raise ex.message
   end
-  raise 'Try --help' if opts.arguments.empty?
+  candidates = opts.arguments
+  candidates += Dir['*.tex'] if candidates.empty?
   if opts[:pws]
     log.debug("PWS with an additional dictionary is here: #{opts[:pws]}")
     opts[:pws] = File.expand_path(opts[:pws])
@@ -64,7 +79,7 @@ Options are:"
   end
   errors = 0
   files = 0
-  opts.arguments.each do |f|
+  candidates.each do |f|
     tex = File.read(f)
     ignores = opts[:ignore].map do |e|
       c, o = e.split(':')
@@ -84,12 +99,14 @@ Options are:"
     )
     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)

data/features/cli.feature

@@ -14,7 +14,7 @@ Feature: Command Line Processing
     How are you, my dear friend?
     \end{document}
     """
-    When I run bin/texsc with "article.tex"
+    When I run bin/texsc with ""
     Then Exit code is zero
     And Stdout contains "No spelling errors found in 1 file(s)"
 

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.3'
+  s.version = '0.7.0'
   s.license = 'MIT'
   s.summary = 'Spell Checker for LaTeX'
   s.description = 'Simple command-line spell checker for LaTeX documents'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: texsc
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-27 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -171,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 2
 summary: Spell Checker for LaTeX