texsc 0.4.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7f17174e45a527a1bbf5d038d2e36afa495654a8fd0144dd7b3d2877b75f8c3
-  data.tar.gz: 811be64333228d2d61a2ba50e1db531d78649017611a8e5e56d4cbaddee7d1c7
+  metadata.gz: 1a0b900b5f83d63e4125937fd67a0ee1f633278fe34a5a38393057fa4a604019
+  data.tar.gz: 2dc1b9b642e1789a7f4bdc0441c46f3bed2de18e4c59fefa93ae313ec19ed208
 SHA512:
-  metadata.gz: afc5ea51b0e7d08da720c549b24dfd6df4547f040830de879e1fa94c084613b1f4549127a74a9f41db5c4f2835f63ec6c85508746f93f75c70229de088723af5
-  data.tar.gz: 516899e654760a261516f170f222d3e6d7ceeec2bf6c6f9963e1632222b62dbb70f24414c2f6b578e034aa9880310ac899bbad176fce0b3ee87fa229fdd136d9
+  metadata.gz: b943bf18daae7bbb2d1af521a6fc2c4e2477347b4c661a90a4a0cc1f97264fa776afadecf0a68422846b48bec9abdbb241f39ddc8df362067b53077ed56a11e3
+  data.tar.gz: cc92c623781f8989dab859ebd07df50cd7c7757ca8f678ddc3be4c6da9065e1610fc8e29735d95a73fff715be3284e2065e897a3362b534ccc04f7c4618c529e

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.2'
+VERSION = '0.6.0'
 
 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'
@@ -55,15 +66,17 @@ 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])
     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
-  opts.arguments.each do |f|
+  candidates.each do |f|
     tex = File.read(f)
     ignores = opts[:ignore].map do |e|
       c, o = e.split(':')
@@ -83,12 +96,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.2'
+  s.version = '0.6.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.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2021-07-16 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