Make title search independent from DocQuery search

CHANGELOG.md

@@ -1,6 +1,3 @@
-## 0.9.0
-- Add an interlink feature
-
 ## 0.8.0
 - Add a feature to delete an empty note automatically when closing its pane
 

README.md

@@ -13,7 +13,6 @@ This Atom package implements the some key features from this amazing app:
 - Modeless operation
 - Mouseless interaction
 - Incremental Search
-- Interlinks
 
 Integrated with Atom, we have several advantages:
 
@@ -48,7 +47,6 @@ Double-quotes also work.
 ## Key Bindings
 
 - `alt-cmd-l`: Toggles the search view.
-- `alt-cmd-o`: Jumps to the referred note when the cursor is on the interlink in the form of [[double-bracketed interlink]].
 
 You can also override `cmd-l` if you want to keep your muscle memory from Notational Velocity and nvALT. Just edit your keymap (Atom menu -> Open Your Keymap) and add the following lines:
 

grammars/nvatom.cson

@@ -1,18 +0,0 @@
-'name': 'nvAtom Github Markdown'
-'scopeName': 'source.gfm.nvatom'
-'patterns': [
-  {
-    'include': 'source.gfm'
-  }
-  {
-    'match': '(?<!\\[)(\\[\\[)([^\\[\\]\|]+)(\\]\\])(?!\\])'
-    'name': 'interlink'
-    'captures':
-      '1':
-        'name': 'punctuation.definition.begin.gfm'
-      '2':
-        'name': 'markup.underline.link.interlink.gfm'
-      '3':
-        'name': 'punctuation.definition.begin.gfm'
-  }
-]

keymaps/notational-velocity.cson

@@ -9,5 +9,3 @@
 # https://atom.io/docs/latest/advanced/keymaps
 'atom-workspace':
   'alt-cmd-l': 'nvatom:toggle'
-'atom-workspace atom-text-editor':
-  'alt-cmd-o': 'nvatom:openInterlink'

lib/interlink.coffee

@@ -1,48 +0,0 @@
-fs = require 'fs-plus'
-path = require 'path'
-{CompositeDisposable} = require 'atom'
-Utility = require './utility'
-
-module.exports =
-class Interlink
-  constructor: ->
-    Interlink.loadGrammarSync()
-    @subscriptions = new CompositeDisposable
-    @subscriptions.add atom.commands.add 'atom-workspace', 'nvatom:openInterlink': => Interlink.openInterlink()
-    @subscriptions.add atom.workspace.observeTextEditors (editor) ->
-      if Utility.isNote(editor.getPath())
-        editor.setGrammar(atom.grammars.grammarForScopeName('source.gfm.nvatom'))
-
-  destroy: ->
-    @subscriptions.dispose()
-
-  @loadGrammarSync: ->
-    unless atom.grammars.grammarForScopeName('source.gfm.nvatom')
-      grammarPath = path.join(atom.packages.resolvePackagePath('nvatom'), 'grammars', 'nvatom.cson')
-      atom.grammars.loadGrammarSync(grammarPath)
-
-  @openInterlink: ->
-    editor = atom.workspace.getActiveTextEditor()
-    return unless editor?
-    return unless Utility.isNote(editor.getPath())
-
-    noteTitle = Interlink.getInterlinkUnderCursor(editor)
-    return unless noteTitle?
-    return unless noteTitle.length
-
-    notePath = Utility.getNotePath(noteTitle)
-
-    unless fs.existsSync(notePath)
-      fs.writeFileSync(notePath, '')
-    atom.workspace.open(notePath)
-
-  @getInterlinkUnderCursor: (editor) ->
-    cursorPosition = editor.getCursorBufferPosition()
-    token = editor.tokenForBufferPosition(cursorPosition)
-    return unless token
-    return unless token.value
-    return unless token.scopes.indexOf('markup.underline.link.interlink.gfm') > -1
-
-    interlink = Utility.trim(token.value)
-    return unless interlink.length
-    return interlink

lib/notational-velocity-view.coffee

@@ -3,15 +3,14 @@ fs = require 'fs-plus'
 _ = require 'underscore-plus'
 {$, $$, SelectListView} = require 'atom-space-pen-views'
 DocQuery = require 'docquery'
-Utility = require './utility'
 
 module.exports =
 class NotationalVelocityView extends SelectListView
   initialize: (state) ->
     @initializedAt = new Date()
     super
-    @addClass('nvatom')
+    @addClass('nvatom from-top overlay')
-    @rootDirectory = Utility.getNoteDirectory()
+    @rootDirectory = atom.config.get('nvatom.directory')
     unless fs.existsSync(@rootDirectory)
       throw new Error("The given directory #{@rootDirectory} does not exist. "
         + "Set the note directory to the existing one from Settings.")
@@ -39,33 +38,6 @@ class NotationalVelocityView extends SelectListView
     @prevCursorPosition = currCursorPosition
     return isCursorProceeded
 
-  selectItem: (filteredItems, filterQuery) ->
-    isCursorProceeded = @isCursorProceeded()
-
-    for item in filteredItems
-      if item.title.toLowerCase() is filterQuery.toLowerCase()
-        # autoselect
-        n = filteredItems.indexOf(item) + 1
-        @selectItemView(@list.find("li:nth-child(#{n})"))
-        return
-
-    for item in filteredItems
-      if item.title.toLowerCase().startsWith(filterQuery.toLowerCase()) and isCursorProceeded
-        # autocomplete
-        @skipPopulateList = true
-        editor = @filterEditorView.model
-        editor.setText(filterQuery + item.title.slice(filterQuery.length))
-        editor.selectLeft(item.title.length - filterQuery.length)
-
-        # autoselect
-        n = filteredItems.indexOf(item) + 1
-        @selectItemView(@list.find("li:nth-child(#{n})"))
-
-  filter: (filterQuery) ->
-    if (filterQuery is "") or (filterQuery is undefined)
-      return @docQuery.documents
-    return @docQuery.search(filterQuery)
-
   getFilterKey: ->
     'filetext'
 
@@ -91,9 +63,10 @@ class NotationalVelocityView extends SelectListView
 
   confirmSelection: ->
     item = @getSelectedItem()
-    sanitizedQuery = Utility.trim(@getFilterQuery())
-    calculatedPath = Utility.getNotePath(sanitizedQuery)
     filePath = null
+    sanitizedQuery = @getFilterQuery().replace(/\s+$/, '')
+    extension = if atom.config.get('nvatom.extensions').length then atom.config.get('nvatom.extensions')[0] else '.md'
+    calculatedPath = path.join(@rootDirectory, sanitizedQuery + extension)
     if item?
       filePath = item.filePath
     else if fs.existsSync(calculatedPath)
@@ -136,24 +109,73 @@ class NotationalVelocityView extends SelectListView
     selectedText = editor.getSelectedText()
     return fullText.substring(0, fullText.length - selectedText.length)
 
+  filterByTitle: (filterQuery) ->
+    if (filterQuery is "") or (filterQuery is undefined)
+      return []
+    filterQuery = filterQuery.toLowerCase()
+    matchingNotes = []
+    filteredNotes = []
+    for note in @docQuery.documents
+      title = note.title.toLowerCase()
+      if title is filterQuery
+        matchingNotes.push(note)
+      else if filteredNotes.length < @maxItems and title.startsWith(filterQuery)
+        filteredNotes.push(note)
+    notes = matchingNotes.concat(filteredNotes)
+    if notes.length > @maxItems
+      notes = notes.slice(0, @maxItems)
+    return notes
+
+  filterByLunr: (filterQuery) ->
+    notes = []
+    if (filterQuery is "") or (filterQuery is undefined)
+      notes = @docQuery.documents
+    else
+      notes = @docQuery.search(filterQuery)
+    if notes.length > @maxItems
+      notes = notes.slice(0, @maxItems)
+    return notes
+
   populateList: ->
     filterQuery = @getFilterQuery()
-    filteredItems = @filter(filterQuery)
+    notesByTitle = @filterByTitle(filterQuery)
+    notesByLunr = @filterByLunr(filterQuery)
+    isCursorProceeded = @isCursorProceeded()
 
     @list.empty()
-    if filteredItems.length
+    if notesByTitle.length + notesByLunr.length == 0
-      @setError(null)
+      @setError(@getEmptyMessage(@docQuery.documents.length, 0))
+      return
 
-      for i in [0...Math.min(filteredItems.length, @maxItems)]
+    @setError(null)
-        item = filteredItems[i]
+    for note in notesByTitle
-        itemView = $(@viewForItem(item))
+      itemView = $(@viewForItem(note))
-        itemView.data('select-list-item', item)
+      itemView.data('select-list-item', note)
-        @list.append(itemView)
+      @list.append(itemView)
 
-      @selectItem(filteredItems, filterQuery)
+    if notesByTitle.length
+      # autoselect
+      @selectItemView(@list.find("li:nth-child(1)"))
 
-    else
+      #autocomplete
-      @setError(@getEmptyMessage(@docQuery.documents.length, filteredItems.length))
+      note = notesByTitle[0]
+      if note.title.toLowerCase() is filterQuery.toLowerCase() or isCursorProceeded
+        @skipPopulateList = true
+        editor = @filterEditorView.model
+        editor.setText(filterQuery + note.title.slice(filterQuery.length))
+        editor.selectLeft(note.title.length - filterQuery.length)
+
+    if @list.length >= @maxItems
+      return
+
+    for note in notesByLunr
+      if @list.length >= @maxItems
+        break
+      if filterQuery?.length and note.title.toLowerCase().startsWith(filterQuery.toLowerCase())
+        continue
+      itemView = $(@viewForItem(note))
+      itemView.data('select-list-item', note)
+      @list.append(itemView)
 
   schedulePopulateList: ->
     unless @skipPopulateList

lib/notational-velocity.coffee

@@ -1,8 +1,6 @@
 path = require 'path'
 fs = require 'fs-plus'
 {CompositeDisposable, Disposable} = require 'atom'
-Interlink = require './interlink'
-Utility = require './utility'
 
 module.exports =
   config:
@@ -24,12 +22,16 @@ module.exports =
       type: 'boolean'
       default: true
 
+  notationalVelocityView: null
 
   activate: (state) ->
     @rootDirectory = @ensureNoteDirectory()
 
+    # Events subscribed to in atom's system can be easily cleaned up with a
+    # CompositeDisposable
     @subscriptions = new CompositeDisposable
 
+    # Register command that toggles this view
     @subscriptions.add atom.commands.add 'atom-workspace',
       'nvatom:toggle': => @createView(state).toggle()
 
@@ -47,15 +49,12 @@ module.exports =
 
     @subscriptions.add atom.workspace.onWillDestroyPaneItem ({item}) => @autosave(item) unless @autodelete(item)
 
-    @interlink = new Interlink()
-
   deactivate: ->
     @subscriptions.dispose()
-    @interlnk?.destroy()
+    @notationalVelocityView.destroy()
-    @notationalVelocityView?.destroy()
 
   serialize: ->
-    notationalVelocityViewState: @notationalVelocityView?.serialize()
+    notationalVelocityViewState: @notationalVelocityView.serialize()
 
   createView: (state, docQuery) ->
     unless @notationalVelocityView?
@@ -67,14 +66,16 @@ module.exports =
     return unless paneItem?.getURI?()?
     return unless paneItem?.isModified?()
     uri = paneItem.getURI()
-    return unless Utility.isNote(uri)
+    return unless uri.indexOf(@rootDirectory) is 0
+    return unless path.extname(uri) in atom.config.get('nvatom.extensions')
     paneItem?.save?()
 
   autodelete: (paneItem) ->
     return false unless paneItem?.getURI?()?
     uri = paneItem.getURI()
-    return false unless Utility.isNote(uri)
+    return false unless uri.indexOf(@rootDirectory) is 0
-    return false unless paneItem.isEmpty()
+    return false unless path.extname(uri) in atom.config.get('nvatom.extensions')
+    return false unless paneItem?.isEmpty()
     fs.unlinkSync(uri)
     noteName = uri.substring(@rootDirectory.length + 1)
     atom.notifications.addInfo("Empty note #{noteName} is deleted.")
@@ -84,7 +85,7 @@ module.exports =
     @autosave(paneItem) for paneItem in atom.workspace.getPaneItems()
 
   ensureNoteDirectory: ->
-    noteDirectory = fs.normalize(atom.config.get('nvatom.directory'))
+    noteDirectory = atom.config.get('nvatom.directory')
     packagesDirectory = path.join(process.env.ATOM_HOME, 'packages')
     defaultNoteDirectory = path.join(packagesDirectory, 'nvatom', 'notebook')
 

lib/utility.coffee

@@ -1,26 +0,0 @@
-path = require 'path'
-fs = require 'fs-plus'
-
-module.exports =
-class Utility
-
-  @getNotePath: (title) -> path.join(Utility.getNoteDirectory(), Utility.trim(title) + Utility.getPrimaryNoteExtension())
-
-  @getNoteDirectory: -> fs.normalize(atom.config.get('nvatom.directory'))
-
-  @getPrimaryNoteExtension: -> if atom.config.get('nvatom.extensions').length then atom.config.get('nvatom.extensions')[0] else '.md'
-
-  @isNote: (filePath) ->
-    return false unless path.extname(filePath) in atom.config.get('nvatom.extensions')
-
-    filePath = fs.normalize(filePath)
-    return true if filePath.startsWith(Utility.getNoteDirectory())
-    return true if filePath.startsWith(fs.realpathSync(Utility.getNoteDirectory()))
-    return false unless fs.existsSync(filePath)
-
-    filePath = fs.realpathSync(filePath)
-    return true if filePath.startsWith(Utility.getNoteDirectory())
-    return true if filePath.startsWith(fs.realpathSync(Utility.getNoteDirectory()))
-    return false
-
-  @trim: (str) -> str?.replace /^\s+|\s+$/g, ''

menus/notational-velocity.cson

@@ -9,10 +9,6 @@
           'label': 'Toggle'
           'command': 'nvatom:toggle'
         }
-        {
-          'label': 'Open Interlink'
-          'command': 'nvatom:openInterlink'
-        }
       ]
     ]
   }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "nvatom",
   "main": "./lib/notational-velocity",
-  "version": "0.9.2",
+  "version": "0.8.1",
   "private": true,
   "contributors": [
     "Seongjae Lee <seongjae@gmail.com>",
@@ -9,13 +9,9 @@
     "Jonathan Hoyt <hoyt@github.com>"
   ],
   "description": "Notational Velocity for Atom",
-  "keywords": [
+  "activationCommands": {
-    "wiki",
+    "atom-workspace": "nvatom:toggle"
-    "notational velocity",
+  },
-    "nvatom",
-    "note",
-    "notetaking"
-  ],
   "repository": "https://github.com/seongjaelee/nvatom",
   "license": "MIT",
   "engines": {
@@ -32,7 +28,5 @@
     "fs-plus": "2.x",
     "underscore-plus": "^1.6.6"
   },
-  "devDependencies": {
+  "devDependencies": {}
-    "temp": "0.8.1"
-  }
 }

spec/interlink-spec.coffee

@@ -1,105 +0,0 @@
-fs = require 'fs-plus'
-path = require 'path'
-temp = require 'temp'
-Interlink = require '../lib/interlink'
-
-temp.track()
-
-describe 'Interlink', ->
-  defaultDirectory = atom.config.get('nvatom.directory')
-  noteDirectory = null
-
-  beforeEach ->
-    workspaceElement = atom.views.getView(atom.workspace)
-    noteDirectory = temp.mkdirSync()
-
-    atom.config.set('nvatom.directory', noteDirectory)
-
-    waitsForPromise ->
-      atom.packages.activatePackage('nvatom')
-
-  afterEach ->
-    atom.config.set('nvatom.directory', defaultDirectory)
-
-  describe 'when getInterlinkUnderCursor is called', ->
-    editor = null
-
-    describe 'under the note directory', ->
-      beforeEach ->
-        waitsForPromise ->
-          atom.workspace.open(path.join(noteDirectory, 'Interlink.md')).then (o) -> editor = o
-
-      it 'returns a trimmed interlink text', ->
-        testdata = [
-          { position: [0, 2], text: '[[Car]]', expected: 'Car' },
-          { position: [0, 2], text: '[[Notational Velocity]]', expected: 'Notational Velocity' },
-          { position: [0, 2], text: '[[한글 Alphabet Test]]', expected: '한글 Alphabet Test' },
-          { position: [0, 2], text: '[[ Car ]]', expected: 'Car' },
-          { position: [0, 2], text: '[[Car/Mini]]', expected: 'Car/Mini' },
-        ]
-
-        for testitem in testdata
-          editor.setText testitem.text
-          editor.setCursorBufferPosition testitem.position
-          expect(Interlink.getInterlinkUnderCursor(editor)).toBe testitem.expected
-
-      it 'returns undefined for invalid text', ->
-        testdata = [
-          { position: [0, 2], text: '[[]]' },
-          { position: [0, 3], text: '[[]]' },
-          { position: [0, 2], text: '[[   ]]' },
-          { position: [0, 1], text: '[Car]' },
-          { position: [0, 2], text: '[[[Car]]]' },
-          { position: [0, 2], text: '[[Car]' },
-          { position: [0, 2], text: '[[Car]]]' },
-          { position: [0, 1], text: 'Car' },
-        ]
-
-        for testitem in testdata
-          editor.setText testitem.text
-          editor.setCursorBufferPosition testitem.position
-          expect(Interlink.getInterlinkUnderCursor(editor)).toBe undefined
-
-    describe 'under a random directory', ->
-      beforeEach ->
-        waitsForPromise ->
-          atom.workspace.open(path.join(temp.mkdirSync(), 'Interlink.md')).then (o) -> editor = o
-
-      it 'does not apply the grammar', ->
-        editor.setText '[[Car]]'
-        editor.setCursorBufferPosition [0, 2]
-        expect(Interlink.getInterlinkUnderCursor(editor)).toBe undefined
-
-  describe 'when openInterlink is called', ->
-    describe 'when the editor path is under the note directory', ->
-      editor = null
-
-      beforeEach ->
-        waitsForPromise ->
-          atom.workspace.open(path.join(noteDirectory, 'Interlink.md')).then (o) -> editor = o
-
-      it 'opens the referred notes', ->
-        editor.setText '[[Car]]'
-        editor.setCursorBufferPosition [0, 2]
-
-        editorPromise = Interlink.openInterlink()
-        expect(editorPromise).not.toBe undefined
-        waitsForPromise ->
-          editorPromise
-
-        runs ->
-          expect(atom.workspace.getActiveTextEditor().getPath().endsWith('Car.md')).toBe true
-
-    describe 'when the editor path is not under the note directory', ->
-      editor = null
-
-      beforeEach ->
-        waitsForPromise ->
-          atom.workspace.open(path.join(temp.mkdirSync(), 'Interlink.md')).then (o) -> editor = o
-
-      it 'does nothing', ->
-        editor.setText '[[Car]]'
-        editor.setCursorBufferPosition [0, 2]
-
-        editorPromise = Interlink.openInterlink()
-        expect(editorPromise).toBe undefined

spec/notational-velocity-spec.coffee

@@ -1,7 +1,4 @@
 path = require 'path'
-temp = require 'temp'
-
-temp.track()
 
 describe "nvAtom", ->
   defaultDirectory = atom.config.get('nvatom.directory')
@@ -10,38 +7,41 @@ describe "nvAtom", ->
 
   beforeEach ->
     workspaceElement = atom.views.getView(atom.workspace)
+    activationPromise = atom.packages.activatePackage('nvatom')
+    atom.config.set('nvatom.directory', 'testdata')
 
   afterEach ->
     atom.config.set('nvatom.directory', defaultDirectory)
 
   describe "when the nvatom:toggle event is triggered", ->
     it "attaches and then detaches the view", ->
-      noteDirectory = path.join(temp.mkdirSync())
+      expect(workspaceElement.querySelector('.nvatom')).not.toExist()
-      atom.config.set('nvatom.directory', noteDirectory)
+
-      
+      # This is an activation event, triggering it will cause the package to be activated.
+      atom.commands.dispatch workspaceElement, 'nvatom:toggle'
+
       waitsForPromise ->
-        atom.packages.activatePackage('nvatom')
+        activationPromise
 
       runs ->
-        expect(workspaceElement.querySelector('.nvatom')).not.toExist()
-
-        atom.commands.dispatch workspaceElement, 'nvatom:toggle'
         expect(workspaceElement.querySelector('.nvatom')).toExist()
-        expect(workspaceElement.querySelector('.nvatom').parentNode.style.display).not.toBe 'none'
-
         atom.commands.dispatch workspaceElement, 'nvatom:toggle'
-        expect(workspaceElement.querySelector('.nvatom').parentNode.style.display).toBe 'none'
 
     it "checks if we banned the default directory under packages directory", ->
-      noteDirectory = path.join(process.env.ATOM_HOME, 'packages', 'nvatom', 'notebook')
+      atom.notifications.clear()
-      atom.config.set('nvatom.directory', noteDirectory)
 
       waitsForPromise ->
-        atom.packages.activatePackage('nvatom')
+        atom.packages.activatePackage('notifications')
 
       runs ->
+        noteDirectoryUnderPackageDirectory = path.join(process.env.ATOM_HOME, 'packages', 'nvatom', 'notebook')
+        atom.config.set('nvatom.directory', noteDirectoryUnderPackageDirectory)
+
+        # This is an activation event, triggering it will cause the package to be activated.
+        atom.commands.dispatch workspaceElement, 'nvatom:toggle'
+
         waitsForPromise ->
-          atom.packages.activatePackage('notifications')
+          activationPromise
 
         runs ->
           notificationContainer = workspaceElement.querySelector('atom-notifications')

spec/utility-spec.coffee

@@ -1,54 +0,0 @@
-fs = require 'fs-plus'
-path = require 'path'
-temp = require 'temp'
-Utility = require '../lib/utility'
-
-temp.track()
-
-describe "utility", ->
-  defaultNoteDirectory = atom.config.get('nvatom.directory')
-  defaultNoteExtensions = atom.config.get('nvatom.extensions')
-
-  afterEach ->
-    atom.config.set('nvatom.directory', defaultDirectory)
-    atom.config.set('nvatom.extensions', defaultNoteExtensions)
-
-  describe 'trim', ->
-    expect(Utility.trim(null)).toBe(undefined)
-    expect(Utility.trim(undefined)).toBe(undefined)
-    expect(Utility.trim('')).toBe('')
-    expect(Utility.trim('  ')).toBe('')
-    expect(Utility.trim('  hello world  ')).toBe('hello world')
-    expect(Utility.trim('  hello world\t\n\r  ')).toBe('hello world')
-
-  describe 'getPrimaryNoteExtension', ->
-    atom.config.set('nvatom.extensions', ['.md', '.markdown'])
-    expect(Utility.getPrimaryNoteExtension()).toBe('.md')
-    atom.config.set('nvatom.extensions', ['.markdown'])
-    expect(Utility.getPrimaryNoteExtension()).toBe('.markdown')
-    atom.config.set('nvatom.extensions', [])
-    expect(Utility.getPrimaryNoteExtension()).toBe('.md')
-
-  describe 'isNote handles symlinks correctly', ->
-    atom.config.set('nvatom.extensions', ['.md', '.markdown'])
-
-    tempDirectoryPath = path.join(temp.mkdirSync())
-    noteDirectoryPath = path.join(temp.mkdirSync())
-    noteDirectoryPathSymlink = path.join(tempDirectoryPath, 'note book')
-    notePath = path.join(noteDirectoryPath, 'note.md')
-    notePathSymlink = path.join(noteDirectoryPathSymlink, 'note symlink.md')
-
-    fs.writeFileSync(notePath, 'dummy')
-    fs.symlinkSync(noteDirectoryPath, noteDirectoryPathSymlink)
-    fs.symlinkSync(notePath, notePathSymlink)
-
-    expect(fs.existsSync(notePath)).toBe(true)
-    expect(fs.existsSync(fs.normalize(notePath))).toBe(true)
-
-    atom.config.set('nvatom.directory', noteDirectoryPath)
-    expect(Utility.isNote(notePath)).toBe(true)
-    expect(Utility.isNote(notePathSymlink)).toBe(true)
-
-    atom.config.set('nvatom.directory', noteDirectoryPathSymlink)
-    expect(Utility.isNote(notePath)).toBe(true)
-    expect(Utility.isNote(notePathSymlink)).toBe(true)