rnote 0.0.2 → 0.0.3

data/bin/rnote

@@ -6,7 +6,7 @@ include GLI::App
 
 program_desc 'Evernote Command Line'
 
-# version Rnote::VERSION
+version Rnote::VERSION
 
 desc 'prompt for input and run an editor when necessary'
 default_value true
@@ -46,9 +46,6 @@ on_error do |exception|
   elsif exception.instance_of?(Evernote::EDAM::Error::EDAMSystemException)
     puts exception.error_message
     true
-  elsif exception.class == Evernote::EDAM::Error::InvalidXmlError
-    puts exception.xml
-    true
   else
     true
   end

data/lib/rnote/cmd/create.rb

@@ -6,10 +6,17 @@ require 'rnote/edit'
 include GLI::App
 
 
-desc 'create a note and launch the editor for it'
+d 'create a new note'
+long_desc <<EOF
+Create a new note and, optionally, launch an editor to provide its content
+
+Unlike most commands, the command line arguments aren't used in a search.
+Instead any command line arguments provided are used for the title of the new note.
+EOF
 command :create do |verb|
-  verb.command :note do |noun|
 
+  d 'create a new note'
+  verb.command :note do |noun|
 
     Rnote::Edit.include_set_options(noun)
     Rnote::Edit.include_editor_options(noun)
@@ -17,7 +24,10 @@ command :create do |verb|
     noun.action do |global_options,options,args|
 
       if args.length > 0
-        raise "create doesn't take a search query"
+        if options[:'set-title']
+          raise "You can't use both --set-title and command line arguments at the same time to set the title of the new note."
+        end
+        options[:'set-title'] = args.join(' ')
       end
 
       edit = Rnote::Edit.new($app.auth)

data/lib/rnote/cmd/edit.rb

@@ -4,11 +4,13 @@ require 'rnote/find'
 
 include GLI::App
 
-
-desc 'Describe edit here'
-arg_name 'Describe arguments to edit here'
+# TODO why doesn't 'desc' work here instead of 'd'. What is over-riding it?
+d 'edit/update a note'
+long_desc 'Edit/update an existing note, usually by launching an editor.'
 command :edit do |verb|
 
+  verb.desc "edit a note"
+
   verb.command :note do |noun|
 
     Rnote::Edit.include_set_options(noun)
@@ -19,7 +21,7 @@ command :edit do |verb|
 
       find = Rnote::Find.new($app.auth,$app.persister)
       note = find.find_note(options.merge(global_options),args)
-
+      
       edit = Rnote::Edit.new($app.auth)
       edit.options(options.merge(global_options))
       edit.note(note)

data/lib/rnote/cmd/find.rb

@@ -4,9 +4,15 @@ require 'rnote/find'
 include GLI::App
 
 
-desc 'search for notes/tags/notebooks'
+d 'search for notes'
+long_desc <<EOF
+Provide a query and find matching notes.   Provides a short summary of each note in the result.
+
+You can run this command before running other commands that require a note to be selected, such as 'edit', or 'remove'. And then specify the result number on the next command line.
+EOF
 command :find do |verb|
 
+  verb.desc 'find notes'
   verb.command :note do |noun|
 
     Rnote::Find.include_search_options(noun)

data/lib/rnote/cmd/login.rb

@@ -3,7 +3,8 @@ require 'highline/import'
 
 include GLI::App
 
-desc 'provide rnote credentials'
+d 'login to evernote'
+long_desc 'Provide credentials and log a user into evernote. The users password is never saved, but an auth token will be.'
 command :login do |c|
   
   c.desc "username"

data/lib/rnote/cmd/logout.rb

@@ -11,7 +11,8 @@ but won't forget about a consumer key, as that by itself is not considered a log
 
 =end
 
-desc 'log user out of rnote'
+d 'logout user'
+long_desc "Log a user out of evernote. This forgets any credential information that may have been cached. currently this does not revoke the token though. It simply forgets what the token was."
 command :logout do |c|
   c.action do |global_options,options,args|
     raise unless args.length == 0

data/lib/rnote/cmd/remove.rb

@@ -6,10 +6,11 @@ include GLI::App
 
 
 
-desc 'remove an item from evernote'
-arg_name 'Describe arguments to remove here'
-command :remove do |verb| 
-  
+d 'remove a note'
+long_desc "Remove a note, but don't expunge it. The note stays in the users Trash"
+command :remove do |verb|
+
+  verb.desc 'remove a note'
   verb.command :note do |noun|
     
     Rnote::Find.include_search_options(noun)

data/lib/rnote/cmd/show.rb

@@ -4,27 +4,37 @@ require 'rnote/find'
 include GLI::App
 
 
-desc 'output notes to the console'
+d 'show note content'
+long_desc "output a note's content to the console."
 command :show do |verb|
 
-  verb.desc 'find and output notes to the console'
+  verb.desc "output a note's content"
   verb.command :note do |noun|
 
     Rnote::Find.include_search_options(noun)
     
     noun.desc 'include title in the output'
     noun.default_value true
-    noun.switch :'include-title', :'inc-title'
+    noun.switch :'include-title', :'inc-title', :'output-title', :'show-title'
+    
+    noun.desc 'which format to output? (txt or enml)'
+    noun.default_value 'txt'
+    noun.flag :format
 
     noun.action do |global_options,options,args|
 
       find = Rnote::Find.new($app.auth,$app.persister)
       note = find.find_note(options.merge(global_options),args)
       
-      content = note.txt_content
       
       puts note.title if options[:'include-title']
-      puts content
+      if options[:format] == 'txt'
+        puts note.txt_content
+      elsif options[:format] == 'enml'
+        puts note.content
+      else
+        raise "Unknown outoput format specified."
+      end
 
     end
 

data/lib/rnote/cmd/who.rb

@@ -1,7 +1,8 @@
 
 include GLI::App
 
-desc 'see which user you are logged in as'
+d 'which user is logged in'
+long_desc 'see what username is logged in, or if your using a developer token instead of a username.'
 command :who do |c|
   c.action do |global_options,options,args|
     raise unless args.length == 0

data/lib/rnote/consumer.rb

@@ -1,3 +1,2 @@
-
 PRODUCTION_CONSUMER_KEY = 'dragonfax'
-PRODUCTION_CONSUMER_SECRET = '5b110ac7e792579c'
+PRODUCTION_CONSUMER_SECRET = '5b110ac7e792579c'

data/lib/rnote/converter.rb

@@ -4,94 +4,160 @@ require 'yaml'
 
 require 'evernote-thrift'
 
-module Evernote::EDAM::Error
 
-  # converting between text formats and enml
-  #
-  # we have two types of conversion
-  #
-  # simple,
-  # single document conversion.
-  # which is enml <=> markdown
-  #
-  # then our own additional wrappers we put on top of those 2 document types
-  # adding metadata to them.
-  # yaml_stream <=> notes attributes
-  # content is just considered an 'attribute' in the latter
-  #
-  # the yaml_stream is just a string
-  # the note attributes get its own class and thats where we stick the conversion routines.
-  
-  class InvalidFormatError < Exception
-  end
-  
-  class InvalidXmlError < InvalidFormatError
+# converting between text formats and enml
+#
+# we have two types of conversion
+#
+# simple,
+# single document conversion.
+# which is enml <=> txt
+#
+# then our own additional wrappers we put on top of those 2 document types
+# adding metadata to them.
+# yaml_stream <=> notes attributes
+# content is just considered an 'attribute' in the latter
+#
+# the yaml_stream is just a string
+# the note attributes get its own class and thats where we stick the conversion routines.
+
+class Evernote::EDAM::Type::Note
+
+  # simple xhtml to txt converter
+  # just tries to convert evernotes simple xhtml. 
+  # the kind its own editors create. Which doesn't involve much nesting.
+  class EnmlDocument < Nokogiri::XML::SAX::Document # Nokogiri SAX parser
+    
+    attr_accessor :_txt, :in_div, :in_pre
+
+    def initialize
+      @_txt = ''
+      @in_div = false
+      @in_pre = false
+      super
+    end
     
-    attr_reader :xml
+    def characters string
+      
+      if ! self.in_div and ! self.in_pre and string == "\n"
+        # ignore lone newlines that occur outside a div
+      else
+        self._txt << string
+      end
+    end
     
-    def initialize(message, xml=nil)
-      @xml = xml
-      super(message)
+    def start_element name, attrs = []
+      case name
+        when 'en-todo'
+          if Hash[attrs]['checked'] == 'true'
+            self._txt << '[X]'
+          else
+            self._txt << '[ ]'
+          end
+        when 'div'
+          self.in_div = true
+        when 'pre'
+          self.in_pre = true
+        else
+          # nothing
+      end
     end
-  end
-  
-  class InvalidMarkdownError < InvalidFormatError
-    def initialize(message, markdown=nil)
-      @markdown = markdown
-      super(message)
+    
+    def end_element name
+      case name
+        when 'div'
+          self.in_div = false
+          # a newline for every div (whether its got a <br> in it or not)
+          self._txt << "\n"
+        when 'pre'
+          self.in_pre = false
+        when 'br'
+          # ignore it, as its always in a div, and every div will be a newline anyways
+        else
+          # nothing
+      end
     end
-  end
-  
-end
-  
-class Evernote::EDAM::Type::Note
-  
-  def self.enml_to_markdown(enml)
-    enml_to_txt(enml)
+    
+    def txt
+      # always remove the last newline. to match up with WYSIWYG interfaces.
+      self._txt.chomp
+    end
+    
   end
 
-  def self.markdown_to_enml(markdown)
-    txt_to_enml(markdown)
-  end
-  
-  def markdown_content=(markdown_content)
-    self.content = self.class.markdown_to_enml(markdown_content)
-  end
-  
-  def markdown_content
-    self.class.enml_to_markdown(content)
-  end
-  
+
   def self.enml_to_txt(enml)
-    document =  Nokogiri::XML::Document.parse(enml)
-    raise Evernote::EDAM::Error::InvalidXmlError.new("invalid xml",enml) unless document.root
-    pre_node = document.root.xpath('pre').first
-    if pre_node
-      pre_node.children.to_ary.select { |child| child.text? }.map { |child| child.to_s }.join('')
-    else
-      document.root.xpath("//text()").text
-    end  
+    raise 'not given xml' if ! enml.start_with? '<?xml'
+
+    sax_document = EnmlDocument.new
+    parser = Nokogiri::XML::SAX::Parser.new(sax_document)
+    parser.parse(enml)
+    
+    enml = sax_document.txt
+
+    enml
   end
   
   def self.txt_to_enml(txt)
-    if txt.start_with? '<?xml'
-      raise Evernote::EDAM::Error::InvalidMarkdownError.new('given xml instead of txt')
-    end
+    raise 'given xml instead of txt' if txt.start_with? '<?xml'
+    
+    # TODO create a proper DOM, with proper xml entity escapes and tag structure
+    
+    # escape any entities
+    txt.gsub!('<','&lt;')
+    txt.gsub!('>','&gt;')
+    
+    # replace todo items 
+    txt.gsub!('[ ]','<en-todo checked="false"/>')
+    txt.gsub!('[X]','<en-todo checked="true"/>')
+    
+    # every newline becomes a <div></div>
+    # an empty line becomes a <div><br/></div>
+    
+    lines = txt.split("\n",-1)
+    lines = [''] if txt == ''
+    raise if lines.length == 0
+    
+    xhtml = lines.map { |string|
+      if string == ''
+        "<div><br/></div>\n"
+      else
+        "<div>#{string}</div>\n"
+      end
+    }.join('')
+      
     <<EOF
 <?xml version='1.0' encoding='utf-8'?>
 <!DOCTYPE en-note SYSTEM "http://xml.evernote.com/pub/enml2.dtd">
 <en-note>
-<pre>#{txt}</pre>
-</en-note>
+#{xhtml}</en-note>
 EOF
   end
   
-  def txt_content=(txt_content)
-    self.content = self.class.txt_to_enml(txt_content)
+  def self.enml_to_format(format,enml)
+    case format
+      when 'enml'
+        enml
+      when 'txt'
+        enml_to_txt(enml)
+      else 
+        raise
+    end
+  end
+  
+  def self.format_to_enml(format,formatted_content)
+    case format
+      when 'enml'
+        formatted_content
+      when 'txt'
+        txt_to_enml(formatted_content)
+      else
+        raise
+    end
   end
   
   def txt_content
-    self.class.enml_to_txt(content)
+    self.class.enml_to_format('txt',self.content)
   end
   
   # The yaml stream is what we give to the user to edit in their editor
@@ -99,25 +165,30 @@ EOF
   # Its just a string, but its composed of 2 parts. the note attributes and the note content.
   #
   # 1. a small yaml document with the note attributes as a hash.
-  # 2. followed by the note content as markdown
-  def yaml_stream=(yaml_stream)
+  # 2. followed by the note content as txt
+  def set_yaml_stream(format,yaml_stream)
 
     m = yaml_stream.match /^(---.+?---\n)(.*)$/m
     raise "failed to parse yaml stream\n#{yaml_stream}" unless m
 
     attributes_yaml = m[1]
-    markdown = m[2]
+    txt = m[2]
 
-    enml = self.class.txt_to_enml(markdown)
+    enml = self.class.format_to_enml(format,txt)
     attributes_hash = YAML.load(attributes_yaml)
+    
+    # process tag names
+    # allow for comma separated tag list
+    tag_names = attributes_hash['tagNames']
+    tag_names = tag_names.split(/\s*,\s*/) if tag_names.instance_of?(String)
 
     self.title = attributes_hash['title']
     self.tagNames = attributes_hash['tagNames']
     self.content = enml
   end
   
-  def yaml_stream
-    YAML.dump({ 'title' => title, 'tagNames' => tagNames }) + "\n---\n" + self.class.enml_to_txt(content)
+  def yaml_stream(format)
+    YAML.dump({ 'title' => title, 'tagNames' => tagNames }) + "\n---\n" + self.class.enml_to_format(format,content)
   end
   
   def summarize

data/lib/rnote/edit.rb

@@ -1,6 +1,7 @@
 
 require 'highline'
 require 'nokogiri'
+require 'tempfile'
 
 class WaitPidTimeout
   
@@ -77,7 +78,7 @@ module Rnote
     def initialize(auth)
       @auth = auth
       @note = Evernote::EDAM::Type::Note.new
-      @note.txt_content = '' # for creating new notes.
+      @note.content = @note.class.format_to_enml('txt','') # for creating new notes.
       @last_saved_note = Evernote::EDAM::Type::Note.new
     end
   
@@ -94,6 +95,10 @@ module Rnote
       noun.desc 'open an interactive editor to modify the note'
       noun.default_value true
       noun.switch :editor
+      
+      noun.desc 'which format do you want to edit the note in? default is "txt", other option is "enml"'
+      noun.default_value 'txt'
+      noun.flag :format
     end
   
     def Edit.has_set_options(options)
@@ -104,6 +109,8 @@ module Rnote
       @options = options
       @use_editor = options[:editor]
       @watch_editor = options[:watch]
+      @format = options[:format]
+      raise "format #{@format} not known" unless %w{txt enml}.include?(@format)
     end
     
     def note(note)
@@ -162,16 +169,104 @@ module Rnote
       end
   
     end
+    
+    # output both forms to a file, and run "diff | less"
+    def show_diff(original,altered)
+      
+      file1 = Tempfile.new('rnote')
+      file2 = Tempfile.new('rnote')
+      begin
+        
+        file1.write(original)
+        file1.close
+        
+        file2.write(altered)
+        file2.close
+        
+        system("diff #{file1.path} #{file2.path} | less")
+          
+        raise "User cnacelled due to lost content." unless agree("Continue editing note?  ")
+          
+      ensure
+        file1.unlink
+        file2.unlink
+      end
+    end
+    
+    # check if we lose content/formating when converting the note
+    # and if so ask the user if they want to continue.
+    def check_for_lost_content
+      
+      converted_content = @note.class.enml_to_format(@format, @note.content)
+      unconverted_content = @note.class.format_to_enml(@format, converted_content)
+      
+      if @note.content != unconverted_content
+        puts "Some content or formatting may be lost in the note due to editing format conversion."
+        reply_continue = ask("Continue editing the note? (yes/no/diff) ") { |q|
+          q.validate = /\A(y|n|d|q|e|c|yes|no|cancel|quit|exit|diff)\Z/i
+          q.responses[:not_valid] = 'Please enter "yes", "no", "diff", or "cancel".'
+          q.responses[:ask_on_error] = :question
+        }
+        
+        case reply_continue.downcase
+          when 'y'
+            # nothing, continue
+          when 'yes'
+            # nothing, continue
+          when 'n'
+            raise "User cancelled due to lost content."
+          when 'no'
+            raise "User cancelled due to lost content."
+          when 'cancel'
+            raise "User cancelled due to lost content."
+          when 'quit'
+            raise "User cancelled due to lost content."
+          when 'exit'
+            raise "User cancelled due to lost content."
+          when 'diff'
+            show_diff(@note.content,converted_content)
+          else
+            raise
+        end
+        
+        
+      end
+    end
+    
+    def md5(filename)
+      # TODO sloppy, switch with non shell command
+      `cat #{filename} | md5`.chomp
+    end
+    
+    # has the file changed since the last time we checked.
+    def has_file_changed(file)
+      
+      @last_mtime ||= nil
+      @last_md5 ||= nil
+      
+      this_mtime = File.mtime(file.path)
+      this_md5 = md5(file.path)
+      
+      changed = this_mtime != @last_mtime && this_md5 != @last_md5
+      
+      @last_mtime = this_mtime
+      @last_md5 = this_md5
+      
+      changed
+    end
+    
   
     def editor
   
       ENV['EDITOR'] ||= 'vim'
+      
+      check_for_lost_content
   
-      file = Tempfile.new(['rnote','md'])
+      file = Tempfile.new(['rnote','.' + @format])
       begin
   
         # fill the tempfile with the yaml stream
-        yaml_stream = @note.yaml_stream
+        yaml_stream = @note.yaml_stream(@format)
         file.write(yaml_stream)
         file.close()
   
@@ -179,7 +274,7 @@ module Rnote
         successful_edit = false
         until successful_edit do
   
-          last_mtime = File.mtime(file.path)
+          has_file_changed(file) # initialize the file change tracking.
   
           # run editor in background
           pid = fork do
@@ -200,31 +295,34 @@ module Rnote
               # timeout exceeded
   
               # has the file changed?
-              this_mtime = File.mtime(file.path)
-              if this_mtime != last_mtime
+              if has_file_changed(file)
                 # protect the running editor from our failures.
                 begin
                   update_note_from_file(file.path)
                 rescue Exception => e
                   $stderr.puts "rnote: an error occured while updating the note: #{e.message}"
                 end
-                last_mtime = this_mtime
               end
             end
           end
   
           # one last update of the note
           # this time we care if there are errors
-          begin
-            update_note_from_file(file.path)
-          rescue Exception => e
-  
-            puts "There was an error while uploading the note"
-            puts e.message
-            puts e.backtrace.join("\n    ")
-  
-            successful_edit = ! agree("Return to editor? (otherwise changes will be lost)  ")
+          if has_file_changed(file)
+            begin
+              update_note_from_file(file.path)
+            rescue Exception => e
+    
+              puts "There was an error while uploading the note"
+              puts e.message
+              puts e.backtrace.join("\n    ")
+    
+              successful_edit = ! agree("Return to editor? (otherwise changes will be lost)  ")
+            else
+              successful_edit = true
+            end
           else
+            # no changes to file, no need to save.
             successful_edit = true
           end
   
@@ -239,7 +337,7 @@ module Rnote
     def update_note_from_file(path)
       
       yaml_stream = File.open(path,'r').read
-      @note.yaml_stream = yaml_stream
+      @note.set_yaml_stream(@format,yaml_stream)
       
       save_note
     end

data/lib/rnote/find.rb

@@ -101,7 +101,7 @@ module Rnote
         # no search options, one argument, and its a small number
         # they are asking to pick from the last search results
         guids = @persister.get_last_search_guids
-        guid = guids[args[0].to_i] # the chosen note
+        guid = guids[args[0].to_i - 1] # the chosen note
         note = get_full_note(guid)
         results = [note] # fake a result set with it.
       else

data/lib/rnote/version.rb

@@ -1,3 +1,3 @@
 module Rnote
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rnote
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-01 00:00:00.000000000 Z
+date: 2013-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -231,3 +231,4 @@ signing_key:
 specification_version: 3
 summary: CLI to Evernote
 test_files: []
+has_rdoc: true