evertils 0.3.14.1 → 0.3.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 718d7296f7fb64fe1e53c51150e94d5dbfca5771
-  data.tar.gz: 1f4a1ff05f39f7e2dfd49a7d525cce45157b5075
+  metadata.gz: 390570a1abaf99659566485a2a510eb04420bd9f
+  data.tar.gz: ab267ee4d649934d9c14f65190fb7141dceb5efc
 SHA512:
-  metadata.gz: d7ac052ae463845c104993eb40e4735629c5094cc438bc9ae4c6c50f1ddc11f36a1909e48601b7003ef33848bf853be929ab4f6f4ff762d75ca56cfd1500153a
-  data.tar.gz: 7e54c227677a05a14621fcc4b20314e2a06c3ac60ed2f57c55b0ffaa7090b5f51cb83ed255a0d299f9e3b1ae86cb4af18e34afb3d80fbdbdb424a1d0cc3d69f3
+  metadata.gz: 465c395234e693c2d2629a2fec71a2aed62ef54c4b30894dc921840604e057a470fb5c323f2b2421703b5a811f70c108e17e4bae25bd7409f28c39db1ab06af2
+  data.tar.gz: 58eaa1cebdf34080a4297eeab8d910919080e1340bffef65db988c33f80f59d05dc0bbc9887ee618c1cce4918b7346ac26f3101f44926e14f3b108e1688d4db1

data/lib/evertils/base.rb

@@ -0,0 +1,7 @@
+module Evertils
+  class Base
+    def initialize
+      @format = Evertils::Helper.load('Formatting')
+    end
+  end
+end

data/lib/evertils/controllers/generate.rb

@@ -17,12 +17,14 @@ module Evertils
       def weekly
         note = Type::Weekly.new(@config)
         note.create if note.should_create?
+        note.add_daily_note_link
       end
 
       # generate monthly notes
       def monthly
         note = Type::Monthly.new(@config)
         note.create if note.should_create?
+        note.add_weekly_note_link
       end
 
       # generate monthly task summary templates

data/lib/evertils/helpers/api-enml-handler.rb

@@ -1,6 +1,8 @@
 module Evertils
   module Helper
     class ApiEnmlHandler
+      include Nokogiri::XML
+
       #
       # @since 0.3.7
       def initialize(config = nil)
@@ -11,7 +13,13 @@ module Evertils
       #
       # @since 0.3.13
       def from_str(str)
-        @xml = Nokogiri::XML::DocumentFragment.parse(str)
+        str.sub!("\n", '')
+        @xml = DocumentFragment.parse(str) do |conf|
+          conf.noblanks
+        end
+
+        fix_dtd
+        clear_empty
       end
 
       #
@@ -36,11 +44,47 @@ module Evertils
         note_xml.inner_html.to_s
       end
 
+      #
+      # @since 0.3.15
+      def clear_empty
+        @xml.css('div').each do |node|
+          children = node.children
+
+          if children.size == 1 && children.first.is_a?(Nokogiri::XML::Text)
+            node.remove if node.text.strip == ''
+          end
+        end
+
+        @xml
+      end
+
+      # Sometimes, the Doctype declaration gets borked by the XML parser
+      # lets replace it with a new DTD if that is the case
+      # @since 0.3.15
+      def fix_dtd
+        if @xml.children[1].is_a?(Text)
+          # remove the existing broken DTD
+          @xml.children[1].remove
+          # create a new one (note: output is overridden in DTD class defined
+          # below ApiEnmlHandler)
+          dtd = DTD.new('DOCTYPE', @xml)
+
+          @xml.children.first.after(dtd)
+        end
+      end
+
       #
       # @since 0.3.1
       def to_enml(hash)
         Evertils::Helper::EvernoteENML.with_list(hash)
       end
     end
+
+    # gross hack to get around nokogiri failing to parse the DTD
+    class DTD < Nokogiri::XML::DTD
+      def to_s
+        return "\n<!DOCTYPE en-note SYSTEM \"http://xml.evernote.com/pub/enml2.dtd\">\n"
+      end
+    end
   end
 end

data/lib/evertils/helpers/xml.rb

@@ -0,0 +1,68 @@
+module Evertils
+  module Helper
+    class Xml < Base
+      attr_accessor :doc
+
+      #
+      # @since 0.3.15
+      def initialize(doc)
+        raise ArgumentError, "doc param required" unless doc
+
+        @doc = doc.first
+      end
+
+      #
+      # @since 0.3.15
+      def a(link, content)
+        conf = {
+          href: link,
+          content: content
+        }
+
+        create(:a, conf)
+      end
+
+      #
+      # @since 0.3.15
+      def br
+        create(:br)
+      end
+
+      #
+      # @since 0.3.15
+      def li(*children)
+        el = create(:li)
+        children.each { |child| el.add_child(child) }
+        el
+      end
+
+      #
+      # @since 0.3.15
+      def div(*children)
+        el = create(:div)
+        children.each { |child| el.add_child(child) }
+        el
+      end
+
+      #
+      # @since 0.3.15
+      def create(element, conf = {})
+        el = Nokogiri::XML::Node.new(element.to_s, @doc)
+
+        return el if conf.empty?
+
+        conf.each_pair do |k, v|
+          if el.respond_to? "#{k}="
+            el.send("#{k}=", v)
+          elsif el.respond_to? k
+            el.send(k, v)
+          else
+            el[k] = v
+          end
+        end
+
+        el
+      end
+    end
+  end
+end

data/lib/evertils/type.rb

@@ -4,13 +4,17 @@ module Evertils
       attr_reader :title, :content, :notebook
 
       COLOUR = 0xffffff
+      MAX_SEARCH_SIZE = 21
 
       #
       # @since 0.3.7
       def initialize(config, *args)
         @model = Evertils::Common::Query::Simple.new
+        @user = @model.user_info[:user]
+        @shard = @model.user_info[:shard]
         @format = Evertils::Helper.load('Formatting')
         @config = config if config
+        @api = Evertils::Helper.load('ApiEnmlHandler', @config)
         @args = args unless args.size.zero?
       end
 
@@ -19,7 +23,7 @@ module Evertils
       def create
         data = {
           title: @title,
-          body: @content,
+          body: @content.delete!("\n"),
           parent_notebook: self.class::NOTEBOOK,
           tags: tags || [],
           colour: self.class::COLOUR
@@ -35,14 +39,54 @@ module Evertils
       #
       # @since 0.3.7
       def should_create?
-        note_title = @format.date_templates[self.class::NOTEBOOK]
-        found = @model.find_note_contents(note_title)
-        result = found.entity.nil?
+        @note = find_note(self.class::NOTEBOOK)
+        @entity = @note.entity
+        result = @note.nil?
 
         Notify.warning "#{self.class.name} skipped, note already exists" unless result
 
         result
       end
+
+      #
+      # @since 0.3.15
+      def morning_note?
+        !caller.grep(/morning/).nil?
+      end
+
+      #
+      # @since 0.3.15
+      def wait_for(notebook)
+        Notify.info('Waiting for...')
+        note = find_note(notebook)
+
+        # didn't find it the first time?  wait and try again
+        if note.entity.nil?
+          (1..MAX_SEARCH_SIZE).each do |iter|
+            Notify.info(" (#{iter}) #{note_title}")
+            note = find_note(notebook, true)
+            break unless note.entity.nil?
+          end
+
+          Notify.info("#{iter} attempts to find #{notebook} note") unless iter.zero?
+        end
+
+        note
+      end
+
+      #
+      # @since 0.3.15
+      def find_note(notebook, sleep = false)
+        sleep(5) if sleep
+        title = @format.date_templates[notebook]
+        @model.find_note_contents(title)
+      end
+
+      #
+      # @since 0.3.15
+      def internal_url_for(note)
+        "evernote:///view/#{@user[:id]}/#{@shard}/#{note.guid}/#{note.guid}/"
+      end
     end
   end
 end

data/lib/evertils/types/daily.rb

@@ -1,9 +1,10 @@
+require 'evertils/helpers/xml'
+
 module Evertils
   module Type
     class Daily < Type::Base
       NOTEBOOK = :Daily
       COLOUR = 0xffe8b7
-      MAX_SEARCH_SIZE = 21
 
       #
       # @since 0.3.7
@@ -24,12 +25,6 @@ module Evertils
 
       private
 
-      #
-      # @since 0.3.13
-      def morning_note?
-        !caller.grep(/morning/).nil?
-      end
-
       #
       # TODO: refactor
       # @since 0.3.13
@@ -37,39 +32,21 @@ module Evertils
         @api = Evertils::Helper.load('ApiEnmlHandler', @config)
         enml = @api.from_str(@format.template_contents(NOTEBOOK))
 
-        Notify.info('Waiting for...')
-        pq = find_priority_queue
-
-        # didn't find the note the first time?  wait and try again
-        if pq.entity.nil?
-          iter = 1
-          loop do
-            iter += 1
-            pq = find_priority_queue(true)
-            break unless pq.entity.nil? || iter == MAX_SEARCH_SIZE
-          end
-
-          Notify.info("#{iter} attempts to find the pq note") unless iter.zero?
-        end
+        pq = wait_for(:'Priority Queue')
 
         guid = pq.entity.guid
-        user = @model.user_info[:user]
-        shard = @model.user_info[:shard]
 
-        a = Nokogiri::XML::Node.new('a', enml)
-        a['href'] = "evernote:///view/#{user[:id]}/#{shard}/#{guid}/#{guid}/"
-        a.content = @format.date_templates[:'Priority Queue']
+        xml_conf = {
+          href: "evernote:///view/#{@user[:id]}/#{@shard}/#{guid}/#{guid}/",
+          content: @format.date_templates[:'Priority Queue']
+        }
+
+        xml = Evertils::Helper.load('Xml', enml)
+        a = xml.create(:a, xml_conf)
 
         enml.at('li:contains("Queue") ul li').children.first.replace(a)
         @content = enml
       end
-
-      def find_priority_queue(sleep = false)
-        sleep(5) if sleep
-        title = @format.date_templates[:'Priority Queue']
-        Notify.info(title)
-        @model.find_note_contents(title)
-      end
     end
   end
 end

data/lib/evertils/types/monthly.rb

@@ -24,14 +24,48 @@ module Evertils
       def should_create?
         today_is_first_of_month = Date.today.day == 1
 
-        monthly_note_title = @format.date_templates[NOTEBOOK]
-        found = @model.find_note_contents(monthly_note_title)
-        result = found.entity.nil? && today_is_first_of_month
+        @note = find_note(NOTEBOOK)
+        @entity = @note.entity
+        result = @note.nil? && today_is_first_of_month
 
         Notify.warning "#{self.class.name} skipped, note already exists" unless result
 
         result
       end
+
+      #
+      # @since 0.3.15
+      def add_weekly_note_link
+        # parse the ENML note data into something we can work with
+        xml = @api.from_str(@entity.content)
+        # include the XML element builder
+        xml_helper = Evertils::Helper.load('Xml', xml)
+        # find the note entity we want to link
+        linked_note = find_note(:Weekly).entity
+
+        # don't add the note link if it is already there
+        unless xml.search("a[href='#{internal_url_for(linked_note)}']").size.zero?
+          return Notify.warning('Weekly note link already exists here, exiting to avoid duplicate content')
+        end
+
+        a = xml_helper.a(
+          internal_url_for(linked_note),
+          @format.date_templates[:Weekly]
+          )
+        li = xml_helper.li(a)
+        br = xml_helper.br
+
+        xml.search('ul:first-child li').after(li)
+
+        # add a line break after the UL if one is not there yet
+        if xml.search('ul:first-child').first.next_element.name != 'br'
+          xml.search('ul:first-child').after(br)
+        end
+
+        @entity.content = xml.to_s
+
+        Notify.success("#{self.class.name} updated, added weekly note link") if @note.update
+      end
     end
   end
 end

data/lib/evertils/types/priority-queue.rb

@@ -3,7 +3,6 @@ module Evertils
     class PriorityQueue < Type::Base
       NOTEBOOK = :'Priority Queue'
       COLOUR = 0xffe8b7
-      MAX_SEARCH_SIZE = 21
 
       #
       # @since 0.3.7
@@ -12,14 +11,7 @@ module Evertils
 
         @handler = Evertils::Helper.load('ApiEnmlHandler', @config)
         @title = @format.date_templates[NOTEBOOK]
-
-        if Date.today.monday?
-          @content = condition_monday
-        elsif Date.today.tuesday?
-          @content = condition_tuesday
-        else
-          @content = condition_default
-        end
+        @content = find_previous
       end
 
       #
@@ -30,77 +22,33 @@ module Evertils
 
       private
 
-      # Get friday's note
-      # @since 0.3.7
-      def condition_monday
-        friday = (Date.today - 3)
-        dow = @format.day_of_week(friday.strftime('%a'))
-        note_title = "Queue For [#{friday.strftime('%B %-d')} - #{dow}]"
-        found = @model.find_note_contents(note_title)
-
-        raise "Queue was not found - #{friday.strftime('%B %-d')}" unless found
-
-        @handler.convert_to_xml(found.entity.content).prepare
-      end
-
-      # Find monday's note
-      # TODO: refactor
+      # Find a previous note
       # @since 0.3.7
-      def condition_tuesday
-        # get monday note
-        monday = (Date.today - 1)
-        dow = @format.day_of_week(monday.strftime('%a'))
-        monday_note_title = "Queue For [#{monday.strftime('%B %-d')} - #{dow}]"
-        monday_note = @model.find_note_contents(monday_note_title)
+      def find_previous
+        day = Date.today
+        note = nil
 
-        if !monday_note.entity.nil?
-          note = monday_note.entity
-        else
-          # if it does not exist, get friday's note
-          friday = (Date.today - 4)
-          dow = @format.day_of_week(friday.strftime('%a'))
-          fri_note_title = "Queue For [#{friday.strftime('%B %-d')} - #{dow}]"
-          fri_note = @model.find_note_contents(fri_note_title)
+        Notify.info('Searching for...')
 
-          if fri_note.entity.nil?
-            # if it does not exist, get $day - 1 note until we find one
-            day = friday
-            iter = 0
+        (1..MAX_SEARCH_SIZE).each do |iter|
+          day -= 1
+          dow = @format.day_of_week(day.strftime('%a'))
 
-            Notify.info('Searching for...')
+          # always skip weekends, even if there is a note for those days
+          next if %i[Sa Su].include?(dow)
 
-            loop do
-              iter += 1
-              day -= 1
-              dow = @format.day_of_week(day.strftime('%a'))
-              note_title = "Queue For [#{day.strftime('%B %-d')} - #{dow}]"
-              query = @model.find_note_contents(note_title)
-              note = query.entity
+          note_title = "Queue For [#{day.strftime('%B %-d')} - #{dow}]"
+          note = @model.find_note_contents(note_title).entity
 
-              Notify.info(" (#{iter}) #{note_title}")
+          Notify.info(" (#{iter}) #{note_title}")
 
-              break unless note.nil? || iter == MAX_SEARCH_SIZE
-            end
-          end
+          break unless note.nil?
         end
 
         raise 'Queue was not found' unless note
 
         @handler.convert_to_xml(note.content).prepare
       end
-
-      # Default action for not-Monday/Tuesday
-      # @since 0.3.7
-      def condition_default
-        yest = (Date.today - 1)
-        dow = @format.day_of_week(yest.strftime('%a'))
-        yest_note_title = "Queue For [#{yest.strftime('%B %-d')} - #{dow}]"
-        found = @model.find_note_contents(yest_note_title).entity
-
-        raise "Queue was not found - #{yest.strftime('%B %-d')}" unless found
-
-        @handler.convert_to_xml(found.content).prepare
-      end
     end
   end
 end

data/lib/evertils/types/weekly.rb

@@ -18,6 +18,40 @@ module Evertils
       def tags
         ["week-#{Date.today.cweek}"]
       end
+
+      #
+      # @since 0.3.15
+      def add_daily_note_link
+        # parse the ENML note data into something we can work with
+        xml = @api.from_str(@entity.content)
+        # include the XML element builder
+        xml_helper = Evertils::Helper.load('Xml', xml)
+        # find the note entity we want to link
+        linked_note = find_note(:Daily).entity
+
+        # don't add the note link if it is already there
+        unless xml.search("a[href='#{internal_url_for(linked_note)}']").size.zero?
+          return Notify.warning('Daily note link already exists here, exiting to avoid duplicate content')
+        end
+
+        a = xml_helper.a(
+          internal_url_for(linked_note),
+          @format.date_templates[:Daily]
+          )
+        li = xml_helper.li(a)
+        br = xml_helper.br
+
+        xml.search('en-note>div:first-child>ul li:last-child').after(li)
+
+        # add a line break after the UL if one is not there yet
+        if xml.search('en-note>div:first-child').first.next_element.name != 'br'
+          xml.search('en-note>div:first-child').after(br)
+        end
+
+        @entity.content = xml.to_s
+
+        Notify.success("#{self.class.name} updated, added daily note link") if @note.update
+      end
     end
   end
 end

data/lib/evertils/version.rb

@@ -1,3 +1,3 @@
 module Evertils
-  VERSION = '0.3.14.1'.freeze
+  VERSION = '0.3.15'.freeze
 end

data/lib/evertils.rb

@@ -18,6 +18,7 @@ require 'nokogiri'
 # include required files
 require 'evertils/kernel'
 require 'evertils/version'
+require 'evertils/base'
 require 'evertils/type'
 require 'evertils/helpers/time'
 require 'evertils/helpers/results'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: evertils
 version: !ruby/object:Gem::Version
-  version: 0.3.14.1
+  version: 0.3.15
 platform: ruby
 authors:
 - Ryan Priebe
@@ -110,6 +110,7 @@ files:
 - com.evertils.plist.dist
 - evertils.gemspec
 - lib/evertils.rb
+- lib/evertils/base.rb
 - lib/evertils/config.rb
 - lib/evertils/configs/templates/daily.enml
 - lib/evertils/configs/templates/monthly-task-summaries.enml
@@ -130,6 +131,7 @@ files:
 - lib/evertils/helpers/formatting.rb
 - lib/evertils/helpers/results.rb
 - lib/evertils/helpers/time.rb
+- lib/evertils/helpers/xml.rb
 - lib/evertils/kernel.rb
 - lib/evertils/request.rb
 - lib/evertils/router.rb