Converting checking to use multi-integer-range with a task-based checking.

* Updated unit tests to verify functionality of multiple plugin responses.
* Taught system checking how to identify correct as well as incorrect.
* Updated documentation to reflect plugin logic.

Author: dmoonfire

PLUGINS.md

@@ -30,7 +30,7 @@ A common parameter type is `checkArgs`, this is a hash with the following signat
 
     args = {
       projectPath: "/absolute/path/to/project/root,
-      relativePath: "relative/path/from/projet/root"
+      relativePath: "relative/path/from/project/root"
     }
 
 Below the required methods for the checker instance.
@@ -44,13 +44,13 @@ Below the required methods for the checker instance.
     * If this returns true, then the plugin will considered for processing.
 * providesSpelling(checkArgs): boolean
     * If this returns true, then the plugin will be included when looking for incorrect and correct words via the `check` function.
-* checkArray(checkArgs, words: string[]): boolean?[]
-    * This takes an array of words in a given line. This will be called once for every line inside the buffer. It also also not include words already requested earlier in the buffer.
-    * The output is an array of the same length as words which has three values, one for each word given:
-        * `null`: The checker provides no opinion on correctness.
-        * `false`: The word is specifically false.
-        * `true`: The word is correctly spelled.
-    * True always takes precedence, then false. If every checker provides `null`, then the word is considered spelled correctly.
+* check(checkArgs, text: string): [results]
+    * This takes the entire text buffer and will be called once per buffer.
+    * The output is an array with three parameters, all optional: `{ invertIncorrectAsCorrect: true, incorrect: [ranges], correct: [ranges] }`
+        * The ranges are a zero-based index of a start and stop character (`[1, 23]`).
+        * `invertIncorrectAsCorrect` means take the incorrect range and assume everything not in this list is correct.
+    * Correct words always take precedence, even if another checker indicates a word is incorrect.
+    * If a word or character is neither correct or incorrect, it is considered correct.
 * providesSuggestions(checkArgs): boolean
     * If this returns true, then the plugin will be included when querying for suggested words via the `suggest` function.
 * suggest(checkArgs, word: string): [suggestion: string]

README.md

@@ -1,9 +1,11 @@
-# Spell Check Package [![Build Status](https://travis-ci.org/atom/spell-check.svg?branch=master)](https://travis-ci.org/atom/spell-check)
+# Spell Check package
+[![OS X Build Status](https://travis-ci.org/atom/spell-check.svg?branch=master)](https://travis-ci.org/atom/spell-check) [![Windows Build Status](https://ci.appveyor.com/api/projects/status/1620a5reqw6kdolv/branch/master?svg=true)](https://ci.appveyor.com/project/Atom/spell-check/branch/master) [![Dependency Status](https://david-dm.org/atom/spell-check.svg)](https://david-dm.org/atom/spell-check)
+
+**This is a test package. Disable the built-in `spell-check` module before using it.**
 
 Highlights misspelling in Atom and shows possible corrections.
 
-Use `cmd+shift+:` to bring up the list of corrections when your cursor is on a
-misspelled word.
+Use <kbd>cmd-shift-:</kbd> to bring up the list of corrections when your cursor is on a misspelled word.
 
 By default spell check is enabled for the following files:
 
@@ -12,17 +14,10 @@ By default spell check is enabled for the following files:
 * Git Commit Message
 * AsciiDoc
 
-You can override this from the _Spell Check_ settings in the Settings view
-(<kbd>cmd+,</kbd>). The Grammars config option is a list of scopes for which the package
-will check for spelling errors.
-
-To enable _Spell Check_ for your current file type: put your cursor in the file,
-open the [Command Palette](https://github.com/atom/command-palette)
-(<kbd>cmd+shift+p</kbd>), and run the `Editor: Log Cursor Scope` command. This
-will trigger a notification which will contain a list of scopes. The first scope
-that's listed is the one you should add to the list of scopes in the settings
-for the _Spell Check_ package. Here are some examples: `source.coffee`,
-`text.plain`, `text.html.basic`.
+You can override this from the _Spell Check_ settings in the Settings View (<kbd>cmd-,</kbd>). The Grammars config option is a list of scopes for which the package will check for spelling errors.
+
+To enable _Spell Check_ for your current file type: put your cursor in the file, open the [Command Palette](https://github.com/atom/command-palette)
+(<kbd>cmd-shift-p</kbd>), and run the `Editor: Log Cursor Scope` command. This will trigger a notification which will contain a list of scopes. The first scope that's listed is the one you should add to the list of scopes in the settings for the _Spell Check_ package. Here are some examples: `source.coffee`, `text.plain`, `text.html.basic`.
 
 ## Changing the dictionary
 

appveyor.yml

@@ -0,0 +1,27 @@
+version: "{build}"
+
+platform: x64
+
+branches:
+    only:
+      - master
+
+clone_depth: 10
+
+skip_tags: true
+
+environment:
+  APM_TEST_PACKAGES:
+
+  matrix:
+  - ATOM_CHANNEL: stable
+  - ATOM_CHANNEL: beta
+
+install:
+  - ps: Install-Product node 4
+
+build_script:
+  - ps: iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/atom/ci/master/build-package.ps1'))
+
+test: off
+deploy: off

lib/known-words-checker.coffee

@@ -19,7 +19,8 @@ class KnownWordsChecker
   getId: -> "spell-check:known-words"
   getName: -> "Known Words"
   getPriority: -> 10
-  isEnabled: -> true
+  isEnabled: -> @spelling.sensitive or @spelling.insensitive
+
   getStatus: -> "Working correctly."
   providesSpelling: (args) -> true
   providesSuggestions: (args) -> true
@@ -33,16 +34,6 @@ class KnownWordsChecker
         ranges.push {start: token.start, end: token.end}
     {correct: ranges}
 
-  checkArray: (args, words) ->
-    results = []
-    for word, index in words
-      result = @check args, word
-      if result.correct.length is 0
-        results.push null
-      else
-        results.push true
-    results
-
   suggest: (args, word) ->
     @spelling.suggest word
 

lib/main.coffee

@@ -12,8 +12,7 @@ module.exports =
 
     # Set up our callback to track when settings changed.
     that = this
-    @task.on "spell-check:settings-changed", (ignore) ->
-      console.log("updating views because of change", that)
+    @task.on "spell-check:settings-changed", () ->
       that.updateViews()
 
     # Since the spell-checking is done on another process, we gather up all the
@@ -30,19 +29,19 @@ module.exports =
     @sendGlobalArgs()
 
     atom.config.onDidChange 'spell-check.locales', ({newValue, oldValue}) ->
-      that.globalArgs.locales = atom.config.get('spell-check.locales')
+      that.globalArgs.locales = newValue
       that.sendGlobalArgs()
     atom.config.onDidChange 'spell-check.localePaths', ({newValue, oldValue}) ->
-      that.globalArgs.localePaths = atom.config.get('spell-check.localePaths')
+      that.globalArgs.localePaths = newValue
       that.sendGlobalArgs()
     atom.config.onDidChange 'spell-check.useLocales', ({newValue, oldValue}) ->
-      that.globalArgs.useLocales = atom.config.get('spell-check.useLocales')
+      that.globalArgs.useLocales = newValue
       that.sendGlobalArgs()
     atom.config.onDidChange 'spell-check.knownWords', ({newValue, oldValue}) ->
-      that.globalArgs.knownWords = atom.config.get('spell-check.knownWords')
+      that.globalArgs.knownWords = newValue
       that.sendGlobalArgs()
     atom.config.onDidChange 'spell-check.addKnownWords', ({newValue, oldValue}) ->
-      that.globalArgs.addKnownWords = atom.config.get('spell-check.addKnownWords')
+      that.globalArgs.addKnownWords = newValue
       that.sendGlobalArgs()
 
     # Hook up the UI and processing.
@@ -56,13 +55,14 @@ module.exports =
       # background checking and a cached view of the in-process manager for
       # getting corrections. We used a function to a function because scope
       # wasn't working properly.
-      spellCheckView = new SpellCheckView(editor, @task, (ignore) => @getInstance @globalArgs)
+      spellCheckView = new SpellCheckView(editor, @task, () => @getInstance @globalArgs)
 
       # save the {editor} into a map
       editorId = editor.id
       spellCheckViews[editorId] = {}
       spellCheckViews[editorId]['view'] = spellCheckView
       spellCheckViews[editorId]['active'] = true
+      spellCheckViews[editorId]['editor'] = editor
       @viewsByEditor.set editor, spellCheckView
 
   deactivate: ->
@@ -74,6 +74,12 @@ module.exports =
     @commandSubscription.dispose()
     @commandSubscription = null
 
+    # Clear out the known views.
+    for editorId of spellCheckViews
+      view = spellCheckViews[editorId]
+      view['editor'].destroy()
+    spellCheckViews = {}
+
     # While we have WeakMap.clear, it isn't a function available in ES6. So, we
     # just replace the WeakMap entirely and let the system release the objects.
     @viewsByEditor = new WeakMap

lib/spell-check-handler.coffee

@@ -13,7 +13,7 @@ instance.isTask = true
 #
 # Below the dispatcher for all messages from the server. The type argument is
 # require, how it is handled is based on the type.
-process.on "message", (message) ->
+process.on "message", (message) =>
   switch
     when message.type is "global" then loadGlobalSettings message.global
     when message.type is "checker" then instance.addCheckerPath message.checkerPath