texsc 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e32f01e9713f452e0ed430e1b86a0336b60c124493f97c3e85534c9ccb82ecb4
-  data.tar.gz: 969342bbe56d241096a82504328def1a22567779c1f6b97793da92c6c3b6691e
+  metadata.gz: 7afe2218441763abfb00eef1e6c2bfba99071e18dd70b63c5d6e9ed92a2109c1
+  data.tar.gz: 6f57f9a091a1dfeeb19c41cb6faceefb98ed3686726b2037a2d701c67677a655
 SHA512:
-  metadata.gz: 7ea846d38263b985dd1f4e8fc701848e7fba88a661852d1e5aaeb265ca55967544e6ccc1994fadec7e4f5c8542d3743fb8d05c5df1feef795a1b639c124d85d0
-  data.tar.gz: a0e9b64259720b8e39b321de67e99384865a7f2b7c0220e44b5d736b9beef1fe44aad56338177411d61799ad89359a701eda2f54d7550306955eb89ef024c481
+  metadata.gz: aa91ba8ea8c73543141b07bc77a70f303e4d3a1304ef374688283ddb2b7ed78e52e70d0c995cf6c1b840e0ea619af2898f9629f7c5032b2319a3eaf5a5608682
+  data.tar.gz: ca00529d0a63fb9fa78ccbc0f0e36bf2b8b50f3af8c398f9f4db2e42ef0b20a2bfe83b3016a2f3fbfd33d08b4de238b31cf0a71973ac9f7f15857ae685cd1f9c

data/.rubocop.yml

@@ -4,29 +4,15 @@ AllCops:
   DisplayCopNames: true
   TargetRubyVersion: 2.3
 
-Style/ClassAndModuleChildren:
-  Enabled: false
 Metrics/LineLength:
   Max: 100
 Layout/EndOfLine:
   EnforcedStyle: lf
-Metrics/CyclomaticComplexity:
-  Max: 20
-Metrics/MethodLength:
-  Enabled: false
-Layout/MultilineMethodCallIndentation:
-  Enabled: false
-Metrics/ParameterLists:
-  Max: 6
-Metrics/ClassLength:
-  Max: 250
-Metrics/AbcSize:
+Style/MultilineTernaryOperator:
   Enabled: false
 Metrics/BlockLength:
-  Max: 100
-Metrics/PerceivedComplexity:
-  Max: 20
-Style/MultilineTernaryOperator:
+  Max: 50
+Layout/AlignParameters:
   Enabled: false
 Layout/EmptyLineAfterGuardClause:
   Enabled: false

data/.rultor.yml

@@ -1,6 +1,7 @@
 assets:
   rubygems.yml: yegor256/home#assets/rubygems.yml
 install: |
+  sudo apt install -y aspell
   pdd -f /dev/null
   sudo bundle install --no-color "--gemfile=$(pwd)/Gemfile"
 release:

data/.travis.yml

@@ -5,6 +5,10 @@ cache: bundler
 branches:
   only:
     - master
+addons:
+  apt:
+    packages:
+    - aspell
 install:
   - gem install pdd -v 0.20.5
   - travis_retry bundle update

data/README.md

@@ -8,18 +8,41 @@
 [![Build Status](https://travis-ci.org/yegor256/texsc.svg)](https://travis-ci.org/yegor256/texsc)
 [![PDD status](http://www.0pdd.com/svg?name=yegor256/texsc)](http://www.0pdd.com/p?name=yegor256/texsc)
 [![Gem Version](https://badge.fury.io/rb/texsc.svg)](http://badge.fury.io/rb/texsc)
-[![Maintainability](https://api.codeclimate.com/v1/badges/74c909f06d4afa0d8001/maintainability)](https://codeclimate.com/github/yegor256/texsc/maintainability)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7593273bfae71f87ea8c/maintainability)](https://codeclimate.com/github/yegor256/texsc/maintainability)
 
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/takes/texsc/master/LICENSE.txt)
 [![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)
 
-Just run it like this for your LaTeX file:
+This tool simplies the usage of [aspell](http://aspell.net/)
+(you must have it installed)
+for spell-checking of LaTeX files.
+
+First, you install it:
+
+```bash
+$ gem install texsc
+```
+
+Then, you just run it like this for your LaTeX files:
 
 ```bash
 $ texsc article.tex
 ```
 
+You may ignore certain tags or environments using `--ignore` option.
+
+You may also use your own additional dictionary, via `--pws` option.
+The file must contain one word per line:
+they will be ignored during spell checking. Don't forget that
+the first line of the file
+[must contain](http://aspell.net/man-html/Format-of-the-Personal-and-Replacement-Dictionaries.html)
+this:
+
+```
+personal_ws-1.1 en 1 utf-8
+```
+
 ## How to contribute
 
 Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).

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.1.0'
+VERSION = '0.2.0'
 
 STDOUT.sync = true
 
@@ -38,6 +38,8 @@ begin
 Options are:"
       o.string '--pws', 'The location of aspell.en.pws file'
       o.array '--ignore', 'The name of the command or environment to ignore'
+      o.integer '--min-word-length',
+        'The minimum length of the word to be checked', default: 3
       o.bool '--version', 'Print current version' do
         puts VERSION
         exit
@@ -60,6 +62,7 @@ Options are:"
     log.debug("The real path of PWS is: #{opts[:pws]}")
   end
   errors = 0
+  files = 0
   opts.arguments.each do |f|
     tex = File.read(f)
     opts[:ignore].each do |e|
@@ -68,29 +71,35 @@ Options are:"
     log.info("Checking #{f} (#{tex.length} chars)...")
     cmd = [
       'aspell',
-      '--ignore=3',
+      "--ignore=#{opts['min-word-length']}",
       '--dont-tex-check-comments',
       '--lang=en',
       '--mode=tex',
       opts[:pws] ? "-p #{opts[:pws]}" : '',
-      opts[:ignore].map { |e| "--add-tex-command '#{e} p'" }.join(' '),
+      opts[:ignore].map { |e| "--add-tex-command '#{e} pppppooooo'" }.join(' '),
       'pipe'
     ].join(' ')
     log.debug(cmd)
-    Open3.popen3(cmd) do |stdin, stdout, _stderr, _thread|
+    Open3.popen3(cmd) do |stdin, stdout, stderr, thread|
       stdin.print(tex)
       stdin.close
+      status = thread.value.to_i
+      unless status.zero?
+        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
       end
     end
+    files += 1
   end
   unless errors.zero?
-    log.info("#{errors} spelling errors found")
+    log.info("#{errors} spelling errors found in #{files} file(s)")
     exit 1
   end
-  log.info('No spelling errors found, the text is clean')
+  log.info("No spelling errors found in #{files} file(s), the text is clean")
 rescue StandardError => ex
   if opts[:verbose]
     puts Backtrace.new(ex).to_s

data/features/cli.feature

@@ -6,3 +6,82 @@ Feature: Command Line Processing
     Then Exit code is zero
     And Stdout contains "--help"
 
+  Scenario: Good LaTeX can be spell checked
+    Given I have a "article.tex" file with content:
+    """
+    \documentclass{article}
+    \begin{document}
+    How are you, my dear friend?
+    \end{document}
+    """
+    When I run bin/texsc with "article.tex"
+    Then Exit code is zero
+    And Stdout contains "No spelling errors found in 1 file(s)"
+
+  Scenario: Bad LaTeX can be spell checked
+    Given I have a "article.tex" file with content:
+    """
+    \documentclass{article}
+    \begin{document}
+    How are you, my dear friiend?
+    \end{document}
+    """
+    When I run bin/texsc with "article.tex"
+    Then Exit code is not zero
+    And Stdout contains "& friiend 33 21"
+
+  Scenario: Bad LaTeX with PWS can be spell checked
+    Given I have a "article.tex" file with content:
+    """
+    \documentclass{article}
+    \begin{document}
+    How are you, my dear friiend?
+    \end{document}
+    """
+    And I have a "aspell.en.pws" file with content:
+    """
+    personal_ws-1.1 en 1 utf-8
+    hello
+    friiend
+    """
+    When I run bin/texsc with "--pws aspell.en.pws article.tex"
+    Then Exit code is zero
+
+  Scenario: Bad LaTeX with broken PWS can be spell checked
+    Given I have a "article.tex" file with content:
+    """
+    \documentclass{article}
+    \begin{document}
+    How are you, my dear friiend?
+    \end{document}
+    """
+    And I have a "aspell.en.pws" file with content:
+    """
+    friiend
+    """
+    When I run bin/texsc with "--pws aspell.en.pws article.tex"
+    Then Exit code is not zero
+    And Stdout contains "is not in the proper format"
+
+  Scenario: Bad LaTeX with --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}?
+    \end{document}
+    """
+    When I run bin/texsc with "--ignore nospell 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:
+    """
+    \documentclass{article}
+    \begin{document}
+    How are you, my dear ZZZZ?
+    \end{document}
+    """
+    When I run bin/texsc with "--min-word-length=4 article.tex"
+    Then Exit code is zero
+

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.1.0'
+  s.version = '0.2.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.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-01 00:00:00.000000000 Z
+date: 2020-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace