texsc 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7afe2218441763abfb00eef1e6c2bfba99071e18dd70b63c5d6e9ed92a2109c1
-  data.tar.gz: 6f57f9a091a1dfeeb19c41cb6faceefb98ed3686726b2037a2d701c67677a655
+  metadata.gz: d8063e6182bac05328abe485e362722586fc8c8abc35a80c2446b389b3759924
+  data.tar.gz: 7c38981acf003c3c3c571a3d29f5383c03b801530cf882c47e4623192046ee4b
 SHA512:
-  metadata.gz: aa91ba8ea8c73543141b07bc77a70f303e4d3a1304ef374688283ddb2b7ed78e52e70d0c995cf6c1b840e0ea619af2898f9629f7c5032b2319a3eaf5a5608682
-  data.tar.gz: ca00529d0a63fb9fa78ccbc0f0e36bf2b8b50f3af8c398f9f4db2e42ef0b20a2bfe83b3016a2f3fbfd33d08b4de238b31cf0a71973ac9f7f15857ae685cd1f9c
+  metadata.gz: '044273992290b54e58c86ddcbd8f378b011adc2ecefc86122bf95bd05486840b6dbc041694ac50cd3445cdb7eb161dcda7b4ea8619a070287540d53132ddaae1'
+  data.tar.gz: 2489a77e0cbcf9a2572b5e4a5c1855b7232c71a96f3bf722914d1b0a69c92be3ce5fe85e0363ddff86058ce45826a7bf806f5d1c89bef0a9b7c05e70ef2a59a5

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/.travis.yml

@@ -9,6 +9,7 @@ addons:
   apt:
     packages:
     - aspell
+    - aspell-en
 install:
   - gem install pdd -v 0.20.5
   - travis_retry bundle update

data/README.md

@@ -14,7 +14,7 @@
 [![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)
 
-This tool simplies the usage of [aspell](http://aspell.net/)
+This tool simplies the usage of [GNU aspell](http://aspell.net/)
 (you must have it installed)
 for spell-checking of LaTeX files.
 
@@ -30,7 +30,19 @@ Then, you just run it like this for your LaTeX files:
 $ texsc article.tex
 ```
 
-You may ignore certain tags or environments using `--ignore` option.
+You may ignore certain tags or environments using `--ignore` option
+
+```bash
+$ texsc --ignore=citet,citep --ignore=newminted article.tex
+```
+
+You can specify the method of ignoring,
+as [aspell suggests](http://aspell.net/man-html/The-Options.html#TeX_002fLaTeX-Filter)
+(by default it's 'p'):
+
+```bash
+$ texsc --ignore=newminted:opp article.tex
+```
 
 You may also use your own additional dictionary, via `--pws` option.
 The file must contain one word per line:

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.2.0'
+VERSION = '0.4.1'
 
 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,7 +88,7 @@ Options are:"
       '--lang=en',
       '--mode=tex',
       opts[:pws] ? "-p #{opts[:pws]}" : '',
-      opts[:ignore].map { |e| "--add-tex-command '#{e} pppppooooo'" }.join(' '),
+      ignores.map { |i| "--add-tex-command '#{i[:cmd]} #{i[:opts]}'" }.join(' '),
       'pipe'
     ].join(' ')
     log.debug(cmd)
@@ -88,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,9 +26,9 @@ 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 33 21"
+    And Stdout contains "& friiend "
 
   Scenario: Bad LaTeX with PWS can be spell checked
     Given I have a "article.tex" file with content:
@@ -74,6 +74,39 @@ Feature: Command Line Processing
     When I run bin/texsc with "--ignore nospell 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, my dear \nospell[friiend]{friiend}{friiend}?
+    \end{document}
+    """
+    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.2.0'
+  s.version = '0.4.1'
   s.license = 'MIT'
   s.summary = 'Spell Checker for LaTeX'
   s.description = 'Simple command-line spell checker for LaTeX documents'
@@ -47,7 +47,7 @@ Gem::Specification.new do |s|
   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_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.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-02 00:00:00.000000000 Z
+date: 2020-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -58,14 +58,14 @@ dependencies:
     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