texsc 0.3.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f0e7863fdd9141c6d4d448b60e0feabc45b48bfa2652a93a6bce2cc39fd6087
-  data.tar.gz: 80a989ea2b50f79af5860bb396cbd4a0a6d47aaa9a6bcd368296004c8972b29e
+  metadata.gz: e7f17174e45a527a1bbf5d038d2e36afa495654a8fd0144dd7b3d2877b75f8c3
+  data.tar.gz: 811be64333228d2d61a2ba50e1db531d78649017611a8e5e56d4cbaddee7d1c7
 SHA512:
-  metadata.gz: dc4ee93d540b0fce8255a43bc4c7f1f744de57cd9e38b93f548af9fcc7857d6d8b25bdb3e2012e80a79b3c6c998ec752000a3473aa91919afec550882f0870b9
-  data.tar.gz: 2d430663f77c0726fc498026dfbad83e94424f0d272f506ff0c2082c23dcebe0ab250d1e665df7e731b9cd2018b79fcf6b5cf04dd4bee2ba5442df345603bbb4
+  metadata.gz: afc5ea51b0e7d08da720c549b24dfd6df4547f040830de879e1fa94c084613b1f4549127a74a9f41db5c4f2835f63ec6c85508746f93f75c70229de088723af5
+  data.tar.gz: 516899e654760a261516f170f222d3e6d7ceeec2bf6c6f9963e1632222b62dbb70f24414c2f6b578e034aa9880310ac899bbad176fce0b3ee87fa229fdd136d9

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/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.0'
+VERSION = '0.4.2'
 
 STDOUT.sync = true
 
@@ -65,10 +65,22 @@ Options are:"
   files = 0
   opts.arguments.each do |f|
     tex = File.read(f)
-    opts[:ignore].each do |e|
-      tex = tex.gsub(/\\begin{#{e}}.+\\end{#{e}}/m, '')
+    ignores = opts[:ignore].map do |e|
+      c, o = e.split(':')
+      { cmd: c, opts: o || 'p' }
+    end
+    ignores.each do |i|
+      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']}",
@@ -76,11 +88,7 @@ Options are:"
       '--lang=en',
       '--mode=tex',
       opts[:pws] ? "-p #{opts[:pws]}" : '',
-      opts[:ignore].map do |e|
-        cmd, opts = e.split(':')
-        opts = 'p' if opts.nil?
-        "--add-tex-command '#{cmd} #{opts}'"
-      end.join(' '),
+      ignores.map { |i| "--add-tex-command '#{i[:cmd]} #{i[:opts]}'" }.join(' '),
       'pipe'
     ].join(' ')
     log.debug(cmd)
@@ -92,9 +100,18 @@ Options are:"
         log.error(stderr.read)
         raise "Failed to run aspell, exit code is #{status}"
       end
-      stdout.read.split("\n").select { |t| t.start_with?('&') }.each do |t|
-        log.info(t)
-        errors += 1
+      out = stdout.read
+      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
     files += 1

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 "
 
@@ -85,6 +85,28 @@ Feature: Command Line Processing
     When I run bin/texsc with "--ignore nospell:opp article.tex"
     Then Exit code is zero
 
+  Scenario: Bad LaTeX with complex --ignore can be spell checked
+    Given I have a "article.tex" file with content:
+    """
+    \documentclass{article}
+    \begin{document}
+    How are you, \begin{nospell}{test}friiend\end{nospell}?
+    \end{document}
+    """
+    When I run bin/texsc with "--ignore nospell:p article.tex"
+    Then Exit code is zero
+
+  Scenario: Bad LaTeX with complex --ignore can be spell checked
+    Given I have a "article.tex" file with content:
+    """
+    \documentclass{article}
+    \begin{document}
+    How are you, \begin{Nospell*}{test}friiend\end{Nospell*}?
+    \end{document}
+    """
+    When I run bin/texsc with "--ignore Nospell*:p article.tex"
+    Then Exit code is zero
+
   Scenario: Bad LaTeX with too short words can be spell checked
     Given I have a "article.tex" file with content:
     """

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.0'
+  s.version = '0.4.2'
   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.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-02 00:00:00.000000000 Z
+date: 2020-09-18 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