merge

Author: dom

README.md

@@ -121,7 +121,7 @@ For more information, see:
 $ geeknote settings
 Geeknote
 ******************************
-Version: 2.0.12
+Version: 2.0.13
 App dir: /Users/username/.geeknote
 Error log: /Users/username/.geeknote/error.log
 Current editor: vim
@@ -165,6 +165,29 @@ $ geeknote settings --editor
 Current editor is: vim
 ```
 
+##### Enabling Markdown2 Extras
+
+You can enable [Markdown2 Extras](https://github.com/trentm/python-markdown2/wiki/Extras) you want to use while editing notes. To check which settings are currently enabled call:
+
+``` sh
+geeknote settings --extras
+```
+To change the Markdown2 Extras call:
+
+```sh
+geeknote settings --extras "tables, footnotes"
+```
+###### Example
+
+``` sh
+$ geeknote settings --extras
+current markdown2 extras is : ['None']
+$ geeknote settings --extras "tables, footnotes"
+Changes saved.
+$ geeknote settings --extras
+current markdown2 extras is : ['tables', 'footnotes']
+```
+
 ## Working with Notes
 ### Notes: Creating notes
 The main functionality that we need is creating notes in Evernote.
@@ -195,6 +218,7 @@ geeknote create --title <title>
 | ‑‑reminder | date     | Set reminder date and time in either 'yyyy-mm-dd' or 'yyyy-mm-dd HH:MM' format. Alternatively use TOMORROW and WEEK for 24 hours and a week ahead respectively, NONE for a reminder without a time. Use DONE to mark a reminder as completed. |
 | --urls     | url      | Set the URL for the note. |
 | --raw      |          | A flag signifying the content is in raw ENML format. |
+| --rawmd    |          | A flag signifying the content is in raw markdown format. |
 
 ##### Description
 This command allows us to create a new note in Evernote. Geeknote has designed for using in console, so we have some restrictions like inability to use double quotes in **--content** option. But there is a method to avoid it - use stdin stream or file synchronization, we show it later in documentation.
@@ -335,6 +359,7 @@ geeknote edit --note <title or GUID of note to edit>
 | ‑‑reminder | date     | Set reminder date and time in either 'yyyy-mm-dd' or 'yyyy-mm-dd HH:MM' format. Alternatively use TOMORROW and WEEK for 24 hours and a week ahead respectively, NONE for a reminder without a time. Use DONE to mark a reminder as completed. Use DELETE to remove reminder from a note. |
 | --urls     | url      | Set the URL for the note. |
 | --raw      |          | A flag signifying the content is in raw ENML format. |
+| --rawmd    |          | A flag signifying the content is in raw markdown format. |
 
 ##### Examples
 

geeknote.rb

@@ -5,7 +5,7 @@ class Geeknote < Formula
   homepage 'https://github.com/jeffkowalski/geeknote'
   head 'https://github.com/jeffkowalski/geeknote.git'
 
-  depends_on :python
+  depends_on "python"
 
   resource "websocket-client" do
     url "https://files.pythonhosted.org/packages/a7/2b/0039154583cb0489c8e18313aa91ccd140ada103289c5c5d31d80fd6d186/websocket_client-0.40.0.tar.gz"

geeknote/__init__.py

@@ -1 +1 @@
-__version__ = '2.0.12'
+__version__ = '2.0.13'

geeknote/editor.py

@@ -18,7 +18,6 @@
 
 
 class EditorThread(threading.Thread):
-
     def __init__(self, editor):
         threading.Thread.__init__(self)
         self.editor = editor
@@ -55,7 +54,8 @@ def HTMLUnescape(text):
     @staticmethod
     def getImages(contentENML):
         '''
-        creates a list of image resources to save. each has a hash and extension attribute
+        Creates a list of image resources to save.
+        Each has a hash and extension attribute.
         '''
         soup = BeautifulSoup(contentENML.decode('utf-8'))
         imageList = []
@@ -81,7 +81,7 @@ def checklistInENMLtoSoup(soup):
             checked = todo.attrs.get('checked', None) == "true"
             todo.replace_with("[x] " if checked else "[ ] ")
 
-            # EN checklist can appear anywhere, but if they appear at the beggining
+            # EN checklist can appear anywhere, but if they appear at the beginning
             # of a block element, transform it so it ressembles github markdown syntax
             if transform:
                 content = ''.join(unicode(child) for child in parent.children
@@ -154,13 +154,10 @@ def ENMLtoText(contentENML, format='default', imageOptions={'saveImages': False}
             for section in soup.find_all('en-media'):
                 section.replace_with(str(section))
 
-#       content = html2text.html2text(soup.prettify())
-#       content = html2text.html2text(str(soup))
-#       content = html2text.html2text(unicode(soup))
         content = html2text.html2text(str(soup).decode('utf-8'), '')
 
         content = re.sub(r' *\n', os.linesep, content)
-        content = content.replace(unichr(160), " ")
+        content = content.replace(unichr(160), " ") # no-break space
         content = Editor.HTMLUnescape(content)
 
         return content.encode('utf-8')
@@ -175,14 +172,13 @@ def wrapENML(contentHTML):
     @staticmethod
     def checklistInSoupToENML(soup):
         '''
-        Transforms github style checklists `* [ ]` in the BeautifulSoup tree to
-        enml.
+        Transforms github style checklists `* [ ]` in the BeautifulSoup tree to ENML.
         '''
 
         checktodo_re = re.compile(r'\[([ x])\]')
 
-        # To be more github compatible, if in a list all elements begins with `[ ]``
-        # transform it to normal `[ ]` evernote elements
+        # To be more github compatible, if all elements in a list begin with '[ ]',
+        # convert them to en-todo evernote elements
         for ul in soup.find_all('ul'):
             tasks = []
             istodo = True
@@ -194,7 +190,6 @@ def checklistInSoupToENML(soup):
                 reg = checktodo_re.match(li.get_text())
                 istodo = istodo and reg
                 character = reg.group(1) if reg else None
-
                 if character == "x":
                     todo_tag['checked'] = "true"
 
@@ -204,38 +199,32 @@ def checklistInSoupToENML(soup):
                 tasks.append(task)
 
             if istodo:
-                for task in tasks:
+                for task in tasks[::-1]:
                     ul.insert_after(task)
                 ul.extract()
 
-#        # For the rest of elements just replace `[ ]` with the appropriate element
-#        for todo in soup.find_all(text=checktodo_re):
-#            str_re = re.match(r'(.*)\[(.)\](.*)',todo)
-#            pre = str_re.group(1)
-#            post = str_re.group(3)
-#
-#            todo_tag = soup.new_tag('en-todo')
-#            if str_re.group(2) == "x": todo_tag['checked']="true"
-#
-#            todo.replace_with(todo_tag)
-#            todo_tag.insert_before(pre)
-#            todo_tag.insert_after(post)
-
     @staticmethod
     def textToENML(content, raise_ex=False, format='markdown', rawmd=False):
         """
-        Create an ENML format of note.
+        Transform formatted text to ENML
         """
 
         if not isinstance(content, str):
             content = ""
         try:
             content = unicode(content, "utf-8")
-            # add 2 space before new line in paragraph for creating br tags
-            content = re.sub(r'([^\r\n])([\r\n])([^\r\n])', r'\1  \n\3', content)
-            # content = re.sub(r'\r\n', '\n', content)
+            content = re.sub(r'\r\n', '\n', content)
+
+            if format == 'pre':
+                # For the 'pre' format, simply wrap the content with a 'pre' tag.
+                # Do not perform any further parsing/mutation.
+                contentHTML = u''.join(('<pre>', content, '</pre>')).encode("utf-8")
+            elif format == 'markdown':
+                # Markdown format https://daringfireball.net/projects/markdown/basics
+                storage = Storage()
+                extras = storage.getUserprop('markdown2_extras')
 
-            if format == 'markdown':
+                if not rawmd:
                 storage = Storage()
                 extras = storage.getUserprop('markdown2_extras')
 
@@ -246,26 +235,17 @@ def textToENML(content, raise_ex=False, format='markdown', rawmd=False):
 
                 soup = BeautifulSoup(contentHTML, 'html.parser')
                 Editor.checklistInSoupToENML(soup)
-
-                # Non-Pretty HTML output
                 contentHTML = str(soup)
-            elif format == 'pre':
-                #
-                # For the 'pre' format, simply wrap the content with a 'pre' tag. Do
-                # perform any parsing/mutation.
-                #
-                contentHTML = u''.join(('<pre>', content, '</pre>')).encode("utf-8")
             elif format == 'html':
                 # Html to ENML http://dev.evernote.com/doc/articles/enml.php
+                soup = BeautifulSoup(content, 'html.parser')
                 ATTR_2_REMOVE = ["id",
                                  "class",
                                  # "on*",
                                  "accesskey",
                                  "data",
                                  "dynsrc",
-                                 "tabindex"
-                                 ]
-                soup = BeautifulSoup(content, 'html.parser')
+                                 "tabindex"]
 
                 for tag in soup.findAll():
                     if hasattr(tag, 'attrs'):
@@ -275,6 +255,7 @@ def textToENML(content, raise_ex=False, format='markdown', rawmd=False):
                              or k.find('on') == 0])
                 contentHTML = str(soup)
             else:
+                # Plain text format
                 contentHTML = Editor.HTMLEscape(content)
 
                 tmpstr = ''
@@ -285,21 +266,18 @@ def textToENML(content, raise_ex=False, format='markdown', rawmd=False):
                         tmpstr = tmpstr + u'<div>' + l + u'</div>'
 
                 contentHTML = tmpstr.encode("utf-8")
-
-            contentHTML = contentHTML.replace('[x]', '<en-todo checked="true"></en-todo>')
-            contentHTML = contentHTML.replace('[ ]', '<en-todo></en-todo>')
+                contentHTML = contentHTML.replace('[x]', '<en-todo checked="true"></en-todo>')
+                contentHTML = contentHTML.replace('[ ]', '<en-todo></en-todo>')
 
             return Editor.wrapENML(contentHTML)
+
         except:
             import traceback
             traceback.print_exc()
             if raise_ex:
-                raise Exception("Error while parsing text to html."
-                                " Content must be an UTF-8 encode.")
-            logging.error("Error while parsing text to html. "
-                          "Content must be an UTF-8 encode.")
-            out.failureMessage("Error while parsing text to html. "
-                               "Content must be an UTF-8 encode.")
+                raise Exception("Error while parsing text to html.")
+            logging.error("Error while parsing text to html.")
+            out.failureMessage("Error while parsing text to html.")
             return tools.exitErr()
 
     def __init__(self, editor, content, noteExtension, raw=False):

tests/test_editor.py

@@ -18,17 +18,25 @@ def setUp(self):
 **Line 3**
 
 """
-        self.HTML_TEXT = "<h1>Header 1</h1><h2>Header 2</h2><p>Line 1</p><p>"\
-                         "<em>Line 2</em></p><p><strong>Line 3</strong></p>"
+        self.HTML_TEXT = """<h1>Header 1</h1>
+<h2>Header 2</h2>
+<p>Line 1</p>
+<p><em>Line 2</em></p>
+<p><strong>Line 3</strong></p>
+"""
 
     def test_TextToENML(self):
-        self.assertEqual(Editor.textToENML(self.MD_TEXT).replace('\n', ''),
-                         Editor.wrapENML(self.HTML_TEXT).replace('\n', ''))
+        self.assertEqual(Editor.textToENML(self.MD_TEXT),
+                         Editor.wrapENML(self.HTML_TEXT))
 
     def test_ENMLToText(self):
         wrapped = Editor.wrapENML(self.HTML_TEXT)
         self.assertEqual(Editor.ENMLtoText(wrapped), self.MD_TEXT)
 
+    def test_TODO(self):
+        self.assertEqual(Editor.textToENML("- [ ] item 1\n- [x] item 2\n- [ ] item 3"),
+                         Editor.wrapENML("<div><en-todo></en-todo>item 1</div><div><en-todo checked=\"true\"></en-todo>item 2</div><div><en-todo></en-todo>item 3</div>\n"))
+
     def test_htmlEscape(self):
         wrapped = Editor.textToENML(content="<what ever>", format="markdown")
         self.assertEqual(wrapped, """<?xml version="1.0" encoding="UTF-8"?>

tests/test_sandbox.py

@@ -6,7 +6,8 @@
 from geeknote.oauth import GeekNoteAuth
 from random import SystemRandom
 from string import hexdigits
-#from proxyenv.proxyenv import ProxyFactory
+if config.DEV_MODE:
+    from proxyenv.proxyenv import ProxyFactory
 
 
 # see https://docs.python.org/2.7/library/unittest.html §25.3.6