mdspell 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df6194fb7f2090573a5c8c393c953f91b7c804d6
-  data.tar.gz: e93822857823d5c93b52264ed30b03d44c94be9f
+  metadata.gz: 9486da2132f09b67ecc6d79b83a5701c5838dae7
+  data.tar.gz: 464a9061d93316b14d71e59dc4486193ef58dba5
 SHA512:
-  metadata.gz: cc3bfbf1598db0154ccfc6929db8fe790e5f76ea3df7f618c8a3a657f66bf6146d277eea6ed9a63b98ead8814ca3b4c2df305c30bea6de8676010deaef59a98b
-  data.tar.gz: ab414bf1101f325c63884c1f887027bdf86df3eea897360e730cc55419a942357fa7f91e3178e63d54760b8ad13a0cb6f8afdae09a92b7e2b66e50baebefc92f
+  metadata.gz: a8decde7a93905b67e6851aeca803ec8c5435c990d78c961318891bd23603b8ee612f175867971e32c93917f01b9788236fe6cb7e6979aee15ec98f175913940
+  data.tar.gz: 319d66b9266d9c460b5d814a405f3f027b36a7bfd213786904cb8dddff87da8b9b4c30859d02c41c687120f1e309b3a738fc0cf022c80792e609b2fe4499cf3b

data/README.md

@@ -51,6 +51,27 @@ spec/examples/with_errors.md:5: tobe
 spec/examples/complete.md:24: Unordered
 ```
 
+### Ignore lists
+
+In some cases, there may be words that are legitimately not in the dictionary you are using because they are proper nouns, or obscure technical terms.
+
+You may specify words (or even regular expressions) to ignore via the --ignored flag:
+
+```
+mdspell README.md --ignored config,mdspell,ruby.*,file.ame
+```
+
+Likewise, you may specify this in a config file
+
+```
+ignored:
+- expr1
+- word2
+...
+```
+
+Please note that you should take care to use non-greedy, precise, regular expressions as to not mask legitimate spelling errors.
+
 ## MIT Licensed
 
 See [LICENSE](https://github.com/mtuchowski/mdspell/blob/master/LICENSE) file for full license

data/lib/mdspell/cli.rb

@@ -17,6 +17,12 @@ module MdSpell
            long: '--language LANG',
            description: 'Set documents language'
 
+    option :ignored,
+           short: '-i IGNORED1,IGNORED2,...',
+           long: '--ignored IGNORED1,IGNORED2,...',
+           description: 'CSV of expressions to be ignored',
+           proc: proc { |csv| csv.split(',') }
+
     option :verbose,
            short: '-v',
            long: '--[no-]verbose',
@@ -35,8 +41,10 @@ module MdSpell
     def run(options)
       raise ArgumentError, 'expected Array of command line options' unless options.is_a? Array
 
-      parse_options(options)
+      # Start clean
+      MdSpell::Configuration.reset
 
+      parse_options(options)
       # Load optional config file if it's present.
       if config[:config_file]
         config_filename = File.expand_path(config[:config_file])

data/lib/mdspell/configuration.rb

@@ -9,6 +9,7 @@ module MdSpell
 
     default :config_file, '~/.mdspell'
     default :language, 'en_US'
+    default :ignored, []
     default :verbose, false
     default :version, VERSION
   end

data/lib/mdspell/spell_checker.rb

@@ -29,10 +29,10 @@ module MdSpell
     # Returns found spelling errors.
     def typos
       results = []
-
       FFI::Aspell::Speller.open(Configuration[:language]) do |speller|
         TextLine.scan(document).each do |line|
           line.words.each do |word|
+            next if ignored? word
             unless speller.correct? word
               results << Typo.new(line, word, speller.suggestions(word))
             end
@@ -42,5 +42,24 @@ module MdSpell
 
       results
     end
+
+    private
+
+    def ignored?(word)
+      # For each ignored word / expression, join them together with
+      # An atomic grouping:
+      # http://ruby-doc.org/core-2.1.1/Regexp.html#class-Regexp-label-Atomic+Grouping
+      # And an alternation using the '|' character:
+      # http://ruby-doc.org/core-2.1.1/Regexp.html#class-Regexp-label-Alternation
+      # Compile it the result into a single regular expression,
+      # and save it as an instance variable so we don't need to recompile.
+      return false if Configuration[:ignored].empty?
+      @ignored ||= begin
+        Regexp.new(Configuration[:ignored].map do |e|
+          "(?>#{e})"
+        end.join('|'), Regexp::EXTENDED | Regexp::IGNORECASE)
+      end
+      @ignored =~ word
+    end
   end
 end

data/lib/mdspell/version.rb

@@ -1,4 +1,4 @@
 module MdSpell
   # Current version
-  VERSION = '0.1.8'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdspell
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Marek Tuchowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown