karasuba 0.0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGM4NWZiMzg5MzVmYzRhN2M2NTNmNzc3ZDVlNjk4Njg1NzU5ZDNhZA==
+  data.tar.gz: !binary |-
+    ZDc4OTlmYWEwNjExNjFmMTljNjk1ZGIzOGViNzUyZjcwZjNkZTU0ZQ==
+SHA512:
+  metadata.gz: !binary |-
+    MzJhZmFiMzI4MjQ2NjQ0NTQ1ZjdhYWYyNGI3ZmE1ZTI5NjkyOGI5ODAzYTkx
+    MDJhYWIyZWUwZTRjNDA1MWRhMDRiYTZjNmEwYThjYjJlY2QxMjQxNGIzNmRk
+    NGE0OGEwMzIzODFiNmNlYmM2M2UyNTgxNjk4NDk0MzYyNWZmZTU=
+  data.tar.gz: !binary |-
+    NDU5Mzg1Yjg0YjEzNzg5NzNkNzkyYTc0YjVjZTczMGZkNDU3MDI3NTM0MGM5
+    NGE0ZmFlZmM1YWE2MTJmZTZjNjBjOGJjZjNiZTlmMTYwMWE0ZjA1NmM1ZGNh
+    MGU0NGM0ZDFkMDlhMmMzZjE2MTA1YmE2N2MyMmJjZjI5ZmFmMjE=

data/lib/karasuba.rb

@@ -0,0 +1,35 @@
+require 'nokogiri'
+require 'equivalent-xml'
+
+require 'karasuba/version'
+require 'karasuba/todo'
+require 'karasuba/link'
+require 'karasuba/link_appender'
+require 'karasuba/footer_appender'
+require 'karasuba/parser'
+require 'karasuba/note'
+
+class Karasuba
+  attr_reader :xml, :note
+
+  # @attr note_or_string [String/#content]
+  # @options { ignore_link: { href: [String/Regexp], content: [String/Regexp] },
+  #            stop_link:   { href: [String/Regexp], content: [String/Regexp] } }
+  def initialize(note_or_string, options = {})
+    @xml = if note_or_string.respond_to?(:content)
+      Nokogiri.parse(note_or_string.content)
+    else
+      Nokogiri.parse(note_or_string)
+    end
+    @note = Note.new(xml, options)
+  end
+
+  def equivalent?(doc_or_string)
+    note.equivalent?(doc_or_string)
+  end
+
+  def todos
+    note.todos
+  end
+end
+

data/lib/karasuba/footer_appender.rb

@@ -0,0 +1,62 @@
+class Karasuba
+  # A footer should look like this :
+  # <div title="a-footer-id">
+  #   </br>
+  #   <hr style="margin: 15px 0px;"/>
+  #   <p display="color:#878888;">
+  #     Lorem ipsum<br/>
+  #     Lauren hipsum
+  #   </p>
+  # </div>
+  class FooterAppender
+    attr_reader :append_point
+
+    def initialize(append_point)
+      @append_point = append_point
+    end
+
+    def append_footer(xml_text = '', options = {})
+      hr         = horizontal_rule(options)
+      p          = paragraph(text_nodes(xml_text), options)
+      div        = division(hr, p, options)
+      append_point.next = div
+      div
+    end
+
+    def document
+      append_point.document
+    end
+
+    private
+
+    def break_element(options = {})
+      Nokogiri::XML::Node.new('br', document)
+    end
+
+    def text_nodes(xml_text)
+      Nokogiri::XML::DocumentFragment.parse(xml_text).children
+    end
+
+    def paragraph(nodes, options)
+      p          = Nokogiri::XML::Node.new('p', document)
+      p['style'] = options[:style][:paragraph_style] if options[:style]
+      p.children = Nokogiri::XML::NodeSet.new(document, nodes)
+      p
+    end
+
+    def horizontal_rule(options)
+      hr          = Nokogiri::XML::Node.new('hr', document)
+      hr['style'] = options[:style][:horizontal_rule_style] if options[:style]
+      hr
+    end
+
+    def division(hr, p, options)
+      div          = Nokogiri::XML::Node.new('div', document)
+      div['title'] = options[:title] if options[:title]
+      div['style'] = options[:style][:division_style] if options[:style]
+      br           = break_element
+      div.children = Nokogiri::XML::NodeSet.new(document, [br, hr, p])
+      div
+    end
+  end
+end

data/lib/karasuba/link.rb

@@ -0,0 +1,11 @@
+class Karasuba
+  class Link
+    attr_accessor :element, :href, :text
+
+    def initialize(element, href = '', text = '')
+      @element = element
+      @href    = href
+      @text    = text
+    end
+  end
+end

data/lib/karasuba/link_appender.rb

@@ -0,0 +1,22 @@
+class Karasuba
+  class LinkAppender
+    attr_reader :append_point
+
+    def initialize(append_point)
+      @append_point = append_point
+    end
+
+    def append_link(href, text = '', options = {})
+      node = Nokogiri::XML::Node.new('a', document)
+      node['href'] = href
+      node['style'] = options[:style] if options[:style]
+      node['title'] = options[:title] if options[:title]
+      node.content = text
+      append_point.next = node
+    end
+
+    def document
+      append_point.document
+    end
+  end
+end

data/lib/karasuba/note.rb

@@ -0,0 +1,40 @@
+class Karasuba
+  class Note
+    attr_reader :xml, :todos, :options
+
+    def initialize(xml, options = {})
+      @xml            = xml
+      @options        = options
+      @todos          = []
+      @todo_elements  = xml.xpath('//en-todo')
+      instanciate_todos
+    end
+
+    def append_footer(text, options = {})
+      appender = FooterAppender.new(append_footer_point)
+      appender.append_footer(text, options)
+    end
+
+    def equivalent?(doc_or_string)
+      doc_or_string = Nokogiri.parse(doc_or_string) if doc_or_string.is_a?(String)
+      EquivalentXml.equivalent?(self.xml, doc_or_string, element_order: true, normalize_whitespace: true)
+    end
+
+    def footer?(title)
+      !!self.xml.xpath("//*[attribute::title=\"#{title}\"]").last
+    end
+
+    private
+
+    def instanciate_todos
+      @todos = @todo_elements.map { |todo| Parser.new(todo, options).parse }
+    end
+
+    def append_footer_point
+      # The second part is a hack, it adds a div to the en-note body
+      #   in order to have an append point
+      self.xml.xpath('//en-note/child::*[position()=last()]').first ||
+        ( self.xml.xpath('//en-note').first.children = Nokogiri::XML::Node.new('div', xml))
+    end
+  end
+end

data/lib/karasuba/parser.rb

@@ -0,0 +1,89 @@
+class Karasuba
+  class Parser
+    STOPPING_ELEMENTS     = ['en-todo', 'br', 'en-note']
+    IGNORED_TEXT_ELEMENTS = ['img', 'map', 'table']
+
+    attr_reader :todo
+
+    def initialize(todo_or_element, options = {})
+      @todo        = todo_or_element.is_a?(Todo) ? todo_or_element : Todo.new(todo_or_element, '', [], [], options)
+      @ignore_link = options[:ignore_link]
+      @stop_link   = options[:stop_link]
+    end
+
+    def parse
+      cursor       = todo.element
+      while(cursor = next_element(cursor))
+        stop_todo(cursor) && break if stopping_element?(cursor)
+        todo.following_siblings << cursor
+        if ignore_element?(cursor)
+          @ignore_children = true
+        else
+          if cursor.text?
+            todo.text_sibblings << cursor
+            todo.title << cursor.text
+          end
+        end
+      end
+      todo
+    end
+
+    def stop_todo(cursor)
+      todo.stopped_by_link  = stop_link?(cursor)
+      todo.stopping_sibling = cursor
+    end
+
+    def stopping_element?(el)
+      STOPPING_ELEMENTS.include?(el.name) || stop_link?(el)
+    end
+
+    def ignore_element?(el)
+      IGNORED_TEXT_ELEMENTS.include?(el.name) || ignore_link?(el)
+    end
+
+    def ignore_link?(el)
+      return false unless @ignore_link
+      match_href(el, @ignore_link) && match_content(el, @ignore_link)
+    end
+
+    def stop_link?(el)
+      return false unless @stop_link
+      match_href(el, @stop_link) && match_content(el, @stop_link)
+    end
+
+    def match_href(el, link_options)
+      return true unless link_options[:href]
+      if link_options[:href].is_a?(Regexp)
+        link_options[:href].match(el['href'])
+      else
+        link_options[:href] == el['href']
+      end
+    end
+
+    def match_content(el, link_options)
+      return true unless link_options[:content]
+      if link_options[:content].is_a?(Regexp)
+        link_options[:content].match(el.content)
+      else
+        link_options[:content] == el.content
+      end
+    end
+
+    def next_element(cursor)
+      if @ignore_children
+        @ignore_children = false
+        following_element(cursor)
+      else
+        cursor.children.first || following_element(cursor)
+      end
+    end
+
+    def following_element(cursor)
+      cursor.next || (following_element(cursor.parent) unless is_root?(cursor.parent))
+    end
+
+    def is_root?(element)
+      element.name == 'en-note'
+    end
+  end
+end

data/lib/karasuba/todo.rb

@@ -0,0 +1,119 @@
+class Karasuba
+  class Todo
+    attr_accessor :element, :title, :following_siblings,
+      :stopping_sibling, :text_sibblings, :stopped_by_link, :options
+
+    def initialize(element, title =  '', following_siblings = [], text_sibblings = [], options = {})
+      @element            = element
+      @title              = title
+      @following_siblings = following_siblings
+      @stopping_sibling   = nil
+      @stopping_link      = nil
+      @stopped_by_link    = false
+      @text_sibblings     = text_sibblings
+      @options            = options
+    end
+
+    def update_title(string)
+      @title = string
+      self.text_sibblings.each(&:remove)
+      clean_links
+      el = title_element(string)
+      self.element.next = el
+      reset
+      parse
+      title
+    end
+
+    def checked=(bool)
+      self.element["checked"] = (!!bool).to_s
+    end
+
+    def checked
+      self.element["checked"] == "true"
+    end
+    alias :checked? :checked
+
+    def links(href = nil)
+      regex = Regexp.new(href) if href
+      self.following_siblings.inject([]) do |ary, s|
+        match = if href
+          s.name == 'a' && regex.match(s['href'])
+        else
+          s.name == 'a'
+        end
+        next ary unless match
+        ary << Link.new(s, s['href'], s.text)
+      end
+    end
+
+    def remove_links(href = nil)
+      links(href).each { |link| link.element.remove }
+      reset
+      parse
+      links(href)
+    end
+
+    def clean_links(href = nil)
+      regex = Regexp.new(href) if href
+      links(href).map do |link|
+        match = if href
+                  regex.match(link.href)
+                else
+                  true
+                end
+        next unless match
+        if link.element.xpath('.//text()').empty?
+          link.element.remove
+        end
+      end.compact
+      reset
+      parse
+      links(href)
+    end
+
+    def linked?(href = nil)
+      !links(href).empty?
+    end
+
+    def stopped_by_link?
+      @stopped_by_link
+    end
+
+    def stopping_link
+      return nil unless stopped_by_link?
+      Link.new(stopping_sibling, stopping_sibling['href'], stopping_sibling.text)
+    end
+
+    def append_link(href, text = '', options = {})
+      appender = LinkAppender.new(append_link_point)
+      appender.append_link(href, text, options)
+      reset
+      parse
+      self
+    end
+
+    private
+
+    def reset
+      @title              = ''
+      @following_siblings = []
+      @stopping_sibling   = nil
+      @text_sibblings     = []
+      @stopping_link      = nil
+      @stopped_by_link    = false
+    end
+
+    def parse
+      Parser.new(self, options).parse
+    end
+
+    def append_link_point
+      self.text_sibblings.reverse.find { |s| !s.blank? } || self.element
+    end
+
+    def title_element(string)
+      Nokogiri::XML::Text.new(string, self.element.document)
+    end
+  end
+end

data/lib/karasuba/version.rb

@@ -0,0 +1,3 @@
+class Karasuba
+  VERSION = '0.0.3'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: karasuba
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- antoinelyset
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: equivalent-xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ENML Parser
+email:
+- antoinelyset@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/karasuba.rb
+- lib/karasuba/footer_appender.rb
+- lib/karasuba/link.rb
+- lib/karasuba/link_appender.rb
+- lib/karasuba/note.rb
+- lib/karasuba/parser.rb
+- lib/karasuba/todo.rb
+- lib/karasuba/version.rb
+homepage: https://github.com/antoinelyset/karasuba
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Evernote is using a subset of XML, called ENML. Karabusa is a parser, a friendly
+  reference to Nokogiri
+test_files: []
+has_rdoc: