ST2 compatibility

Author: aziz

.gitignore

@@ -0,0 +1,2 @@
+*.pyc
+*.cache

Note.sublime-settings

@@ -22,5 +22,5 @@
   "tab_completion": true,
 
   "trim_trailing_white_space_on_save": false,
-  "trim_automatic_white_space": false,
+  "trim_automatic_white_space": false
 }

README.md

@@ -20,6 +20,10 @@ It's been designed with these ground rules in mind:
 </p>
 
 ## Usage
+
+**Note:** Although PlainNotes works under SublimeText 2, some features might not be available. We're not actively testing it 
+under SublimeText 2 but will do our best to make it compatible and usable. We appreciate bug reports and pull requests. 
+
 Most of PlainNotes commands are accessible from the SublimeText main menu. You should have a menu item called `Notes` right after `Help`. Although, there are faster and easier ways of running those commnads that are mentioned below.
 
 #### Starting a new note (`super+F4`)

jotter.py

@@ -1,6 +1,12 @@
+# -*- coding: utf-8 -*-
+
 import sublime, sublime_plugin
 import os, time
 
+ST3 = int(sublime.version()) >= 3000
+if not ST3:
+    from codecs import open
+
 
 def settings():
     return sublime.load_settings('Notes.sublime-settings')
@@ -15,11 +21,10 @@ def run(self, edit):
         window = self.view.window()
         output = self.view.window().get_output_panel("jotter")
         self.view.window().run_command("show_panel", {"panel": "output.jotter"})
-        print(settings().get("jotter_color_scheme"))
         output.settings().set("color_scheme", settings().get("jotter_color_scheme"))
         output.settings().set("is_jott", True)
         output.set_syntax_file("Packages/PlainNotes/Note.tmLanguage")
-        sublime.status_message("    ✎ Jot down your note and press ESC when done. It will be saved to your 'Inbox'")
+        sublime.status_message(u"    ✎ Jot down your note and press ESC when done. It will be saved to your 'Inbox'")
         output.set_read_only(False)
         window.focus_view(output)
 
@@ -39,7 +44,7 @@ def run(self, edit):
             w.run_command("hide_panel", {"cancel": True})
             return
 
-        jot = '# ' + time.strftime(settings().get("jotter_date_format")) + ' — ' + time.strftime(settings().get("jotter_time_format")) + u'\n' + text.rstrip(u'\r\n') + u'\n\n'
+        jot = '# ' + time.strftime(settings().get("jotter_date_format")) + u' — ' + time.strftime(settings().get("jotter_time_format")) + u'\n' + text.rstrip(u'\r\n') + u'\n\n'
 
         with open(os.path.join(get_root(), ".brain", "Inbox.note"), mode='r+', encoding='utf-8') as f:
             content = f.read()

lib/headline.py

@@ -1,4 +1,7 @@
-"""Some utility functions for working with headline of Markdown.
+# -*- coding: utf-8 -*-
+
+"""
+Some utility functions for working with headline of Markdown.
 
 Terminologies
 - Headline :: The headline entity OR the text of the headline

lib/helpers.py

@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+
 # Helper functions
 
 def return_sublist(main_list, indices ):

lib/utilities.py

@@ -1,4 +1,7 @@
-"""Some utility functions for working with sublime.
+# -*- coding: utf-8 -*-
+
+"""
+Some utility functions for working with sublime.
 """
 
 

note_headings.py

@@ -1,4 +1,7 @@
-"""This is borrowed from [SmartMarkdown plugin](https://github.com/demon386/SmartMarkdown)
+# -*- coding: utf-8 -*-
+
+"""
+This is borrowed from [SmartMarkdown plugin](https://github.com/demon386/SmartMarkdown)
 Smart folding is a feature borrowed from [Org-mode](http://org-mode.org).
 It enables folding / unfolding the headlines by simply pressing TAB on headlines.
 Global headline folding / unfolding is recommended to be trigged by Shift + TAB,

notes.py

@@ -1,10 +1,15 @@
+# -*- coding: utf-8 -*-
+
 import sublime, sublime_plugin
 import os, fnmatch, re, time, helpers
 from gzip import GzipFile
 from pickle import load, dump
 
 ST3 = int(sublime.version()) >= 3000
 
+if not ST3:
+    from codecs import open
+
 
 def settings():
     return sublime.load_settings('Notes.sublime-settings')
@@ -229,8 +234,10 @@ def run(self):
         self.window = sublime.active_window()
         self.original_cs = self.window.active_view().settings().get("color_scheme")
         current_color = os.path.basename(self.original_cs).replace("Sticky-","").replace(".tmTheme", "")
-        # show_quick_panel(items, on_done, <flags>, <selected_index>, <on_highlighted>)
-        self.window.show_quick_panel(self.colors, self.on_select, 0, self.colors.index(current_color), self.on_highlight)
+        if ST3:
+            self.window.show_quick_panel(self.colors, self.on_select, 0, self.colors.index(current_color), self.on_highlight)
+        else:
+            self.window.show_quick_panel(self.colors, self.on_select, 0, self.colors.index(current_color))
 
     def on_select(self, index):
         global db

notes_index.py

@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+
 import sublime, sublime_plugin
 import os, fnmatch, re
 
@@ -17,7 +19,7 @@ class NotesBufferCommand(sublime_plugin.WindowCommand):
     def run(self):
         view = self.window.new_file()
         view.set_scratch(True)
-        view.set_name("✎ Notes Index")
+        view.set_name(u"✎ Notes Index")
         view.set_syntax_file('Packages/PlainNotes/Notes Index.hidden-tmLanguage')
         view.settings().set('color_scheme', 'Packages/PlainNotes/Color Schemes/Notes-Index.hidden-tmTheme')
         self.window.focus_view(view)
@@ -35,7 +37,7 @@ def run(self, edit):
 
         v.settings().set('notes_buffer_files', lines)
 
-        v.insert(edit, 0, "\n".join([f[0] for f in lines]))
+        v.insert(edit, 0, u"\n".join([f[0] for f in lines]))
         v.set_read_only(True)
 
     def list_files(self, path):
@@ -45,14 +47,14 @@ def list_files(self, path):
             indent = ' ' * TAB_SIZE * (level)
             relpath = os.path.relpath(root, path)
             if not relpath.startswith("."):
-                line_str = '{0}▣ {1}'.format(indent, os.path.relpath(root, path))
+                line_str = u'{0}▣ {1}'.format(indent, os.path.relpath(root, path))
                 lines.append((line_str, root))
             if not relpath.startswith(".brain"):
                 subindent = ' ' * TAB_SIZE * (level + 1)
                 for f in files:
                     for ext in settings().get("note_file_extensions"):  # display only files with given extension
                         if fnmatch.fnmatch(f, "*." + ext):
-                            line_str = '{0}≡ {1}'.format(subindent, re.sub(r'\.note$', '', f))
+                            line_str = u'{0}≡ {1}'.format(subindent, re.sub(r'\.note$', '', f))
                             line_path = os.path.normpath(os.path.join(root, f))
                             lines.append((line_str, line_path))
         return lines