ulysses 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73480e671295c5f65cf31c8cefcdd7a8540756d2
-  data.tar.gz: edb7c0a25b78f238d7d3e4bc010618093de14e60
+  metadata.gz: 3c7b1d519c285491fa42fda0e4f870252021883b
+  data.tar.gz: 38235905aa64dc7ead038ec120bbfb0daaf116c3
 SHA512:
-  metadata.gz: 6a4c39908d0e70c7274bc05225b864d459b38f86458fca1f6562e3e1313b3353f20da98390fc5b4b264259e292f67ba65f9684bab94a84e0d0ea818527851d65
-  data.tar.gz: 7edb67f0772a0e5c9565e8c52b82022f9ce6794ad4df318da83ff1081489db62591e9aec97ba4cd683191ab90efb34589200ea57100a452b4749e878926c61fa
+  metadata.gz: 4ea24651011856c59aa05c7a6d6129b2c256c7b60b42d0a117d77273b772f044f85b32d7686549a6436383f57d2540c1061bd3a0f83bf3dda1450643de902e05
+  data.tar.gz: b64626d3d96e51b58d2e4be8fd58ea6c3ab081fb9f1ad44e9055c69d91a16086cde221d77b86882b7cec816b02dd2b1baa8f40fd2228cce961456a9ec30f9072

data/README.md

@@ -1,5 +1,7 @@
 # Ulysses
 
+[![Join the chat at https://gitter.im/yaodong/gem-ulysses](https://badges.gitter.im/yaodong/gem-ulysses.svg)](https://gitter.im/yaodong/gem-ulysses?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Code Climate](https://codeclimate.com/github/yaodong/gem-ulysses/badges/gpa.svg)](https://codeclimate.com/github/yaodong/gem-ulysses)
+
 This is a library to export your to HTML files. It still in development.
 
 ## Installation

data/lib/ulysses.rb

@@ -4,7 +4,8 @@ require 'kramdown'
 require 'ulysses/library'
 require 'ulysses/group'
 require 'ulysses/sheet'
-require 'ulysses/exporter'
+require 'ulysses/printer'
+require 'ulysses/printer/elements'
 require 'ulysses/version'
 
 module Ulysses

data/lib/ulysses/group.rb

@@ -4,41 +4,58 @@ module Ulysses
     attr_reader :dirname
 
     def initialize(info_file_path)
-      @dirname = File.dirname(info_file_path)
-      @info    = parse_info(info_file_path)
+      @info_file = info_file_path
+      @dirname   = File.dirname(@info_file)
+    end
+
+    def info
+      @info ||= parse_info
     end
 
     def display_name
-      @display_name = @info['displayName'].content
+      @display_name ||= info['displayName'].content
     end
 
     def children
-      return [] if @info['childOrder'].nil?
-      @info['childOrder'].children.map do |child|
-        Group.new File.join(@dirname, child.content, 'Info.ulgroup') if child.element?
-      end.compact
+      @children ||= parse_children
     end
+    alias :groups :children
 
     def sheets
-      list = @info['sheetClusters'].children.select { |c| c.element? && c.name == 'array' }
-      list = list.map do |i|
-        content_node = i.children.find { |c| c.element? && c.name == 'string' }
-        content_node.content
-      end
-      list.map do |dirname|
-        Sheet.new File.join(@dirname, dirname)
-      end
+      @sheets ||= parse_sheets
+    end
+
+    def reload
+      @info, @children, @sheets = nil
     end
 
     private
 
-    def parse_info(file_path)
-      xml  = Nokogiri::XML File.read(file_path)
-      dict = xml.xpath('//dict').children.map do |child|
-        (child.name == 'key' ? child.content : child) if child.element?
-      end.compact
+    def parse_info
+      xml  = Nokogiri::XML File.read(@info_file)
+      dict = xml.xpath('//dict')
+                 .children
+                 .select { |child| child.element? }
+                 .map { |child| child.name == 'key' ? child.content : child }
       Hash[*dict]
     end
 
+    def parse_sheets
+      return [] unless info['sheetClusters']
+      info['sheetClusters']
+          .children
+          .select { |c| c.element? && c.name == 'array' }
+          .map { |i| i.children.find { |c| c.element? && c.name == 'string' }.content }
+          .map { |dir| Sheet.new File.join(@dirname, dir) }
+    end
+
+    def parse_children
+      return [] unless info['childOrder']
+      info['childOrder']
+          .children
+          .select { |child| child.element? }
+          .map { |child| Group.new File.join(@dirname, child.content, 'Info.ulgroup') }
+    end
+
   end
 end

data/lib/ulysses/library.rb

@@ -1,14 +1,25 @@
 module Ulysses
   class Library
 
+    DEFAULT_LIBRARY_DIR = '~/Library/Mobile Documents/X5AZV975AG~com~soulmen~ulysses3/Documents/Library'
+
     attr_reader :dirname
 
     def initialize(dirname = nil)
-      dirname ||= '~/Library/Mobile Documents/X5AZV975AG~com~soulmen~ulysses3/Documents/Library'
-      @dirname = File.expand_path(dirname)
+      @dirname = File.expand_path(dirname ||= DEFAULT_LIBRARY_DIR)
     end
 
     def groups
+      @groups ||= parse_groups
+    end
+
+    def reload
+      @groups = nil
+    end
+
+    private
+
+    def parse_groups
       Dir.glob(File.join @dirname, 'Groups-ulgroup', '*.ulgroup').map do |info_file|
         Group.new info_file
       end

data/lib/ulysses/printer.rb

@@ -0,0 +1,108 @@
+module Ulysses
+  class Printer
+
+    SHEET_CONTENT_XPATH = '/sheet/string[@xml:space="preserve"]'
+
+    def initialize(target)
+      @target        = target
+      @footnotes     = []
+      @annotations   = []
+      @html_entities = HTMLEntities.new
+    end
+
+    def print
+      if @target.is_a? Library
+        print_library(@target)
+      elsif @target.is_a? Group
+        print_group(@target)
+      elsif @target.is_a? Sheet
+        print_sheet(@target)
+      else
+        raise "Unsupported print type: #{@target.class}"
+      end
+    end
+
+    def footnotes
+      @footnotes
+    end
+
+    def annotations
+      @annotations
+    end
+
+    private
+
+    def print_library(library)
+      library.groups.map { |g| print_group(g) }.join("\n")
+    end
+
+    def print_group(group)
+      group.sheets.map { |s| print_sheet(s) }.join("\n") + group.groups.map { |g| print_group(g) }.join("\n")
+    end
+
+    def print_sheet(sheet)
+      paragraphs = sheet.xml.xpath(SHEET_CONTENT_XPATH).children.select { |n| n.element? }
+      paragraphs.map{ |p| print_paragraph(p) }.join("\n")
+    end
+
+    def print_paragraph(p)
+      children = p.children
+      tags     = (children.any? && children.first.name === 'tags') ? parse_tags(children.shift) : []
+      content  = parse_content(children)
+
+      tabs = tags.count('tab')
+      if tabs > 0
+        tags.delete('tab')
+        tags << "tabs_#{tabs}"
+      end
+      tags = tags.uniq.map{|t| normalize_tag(t)}.join(' ')
+      "<p class=\"#{tags}\">#{content}</p>"
+    end
+
+    def parse_content(nodes)
+      nodes.map do |node|
+        if node.text?
+          node.content
+        else
+          send("parse_#{node.name}", node)
+        end
+      end.join
+    end
+
+    def parse_tags(tags)
+      tags.children.map do |tag|
+        if tag.attributes.has_key? 'kind'
+          tag.attributes['kind'].value
+        elsif tag.content === "\t"
+          'tab'
+        end
+      end
+    end
+
+    def parse_escape(node)
+      node.content.gsub /\\(.)/, '\1'
+    end
+
+    def parse_p(node)
+      '<p>' + parse_content(node.children) + '</p>'
+    end
+
+    def parse_string(node)
+      parse_content node.children
+    end
+
+    def parse_element(node)
+      send "parse_element_#{node.attributes['kind'].value}", node
+    end
+
+    def normalize_tag(tag)
+      tag.gsub(/::/, '/')
+          .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+          .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+          .gsub(/([a-z])(\d)/i, '\1_\2')
+          .tr('-', '_')
+          .downcase
+    end
+
+  end
+end

data/lib/ulysses/printer/elements.rb

@@ -0,0 +1,69 @@
+module Ulysses
+  class Printer
+
+    def parse_element_strong(node)
+      '<strong>' + node.content + '</strong>'
+    end
+
+    def parse_element_emph(node)
+      '<em>' + node.content + '</em>'
+    end
+
+    def parse_element_mark(node)
+      '<span class="marked">' + node.content + '</span>'
+    end
+
+    def parse_element_delete(node)
+      '<del>' + node.content + '</del>'
+    end
+
+    def parse_element_inlineComment(node)
+      '<span class="inline-comment">' + node.content + '</span>'
+    end
+
+    def parse_element_code(node)
+      '<code>' + node.content + '</code>'
+    end
+
+    def parse_element_inlineNative(node)
+      '<span class="inline-native">' + node.content + '</span>'
+    end
+
+    def parse_element_link(node)
+      attrs   = parse_element_attributes(node)
+      content = parse_content(node.children.select{ |child| !child.element? || child.name != 'attribute' })
+      '<a href="' + attrs.fetch('URL', '') + '" title="' + attrs.fetch('title', '') + '">' + content + '</a>'
+    end
+
+    def parse_element_image(node)
+      attrs = parse_element_attributes(node)
+      '<img src="' + attrs.fetch('URL', '') + '" alt="' + attrs.fetch('title', '') + '" />'
+    end
+
+    def parse_element_video(node)
+      attrs = parse_element_attributes(node)
+      '<video><source src="' + attrs['URL'] + '" /></video>'
+    end
+
+    def parse_element_footnote(node)
+      attrs = parse_element_attributes(node)
+      @footnotes << attrs['text']
+      '<sup class="footnote-ref"><a href="#fn' + @footnotes.size.to_s + '">' + @footnotes.size.to_s + '</a></sup>'
+    end
+
+    def parse_element_annotation(node)
+      attrs = parse_element_attributes(node)
+      @annotations << attrs['text']
+      '<span class="annotation" data-id="' + @annotations.size.to_s + '">' + @annotations.size.to_s + '</span>'
+    end
+
+    def parse_element_attributes(element)
+      attributes = element.children.select { |child| child.element? && child.name === 'attribute' }
+      attributes.map! do |attr|
+        [attr.attributes['identifier'].value, parse_content(attr.children)]
+      end
+      Hash[attributes]
+    end
+
+  end
+end

data/lib/ulysses/sheet.rb

@@ -7,21 +7,39 @@ module Ulysses
       @dirname = dirname
     end
 
-    def reload
-      @content = nil
-      @text    = nil
+    def markup
+      @markup ||= parse_markup
     end
 
-    def content
-      @content ||= File.read(File.join(@dirname, 'Content.xml'))
+    def xml
+      @xml ||=  Nokogiri::XML(File.read(File.join(@dirname, 'Content.xml')))
     end
 
-    def text
-      @text ||= File.read(File.join(@dirname, 'Text.txt'))
+    def to_html
+      @html ||= Exporter.new(xml).to_html
     end
 
-    def to_html
-      Exporter.new(content).to_html
+    def reload
+      @markup, @xml, @html = nil
+    end
+
+    private
+
+    def parse_xml_attributes(node)
+      Hash[node.attributes.map { |nm, el| [nm.to_sym, el.value] }]
+    end
+
+    def parse_markup
+      segment = xml.xpath('/sheet/markup')[0]
+      markup  = parse_xml_attributes(segment)
+      markup[:definitions] = begin
+        defines = segment.children.select { |node| node.element? }.map do |node|
+          attrs = parse_xml_attributes(node)
+          [attrs[:definition].to_sym, attrs]
+        end
+        Hash[defines]
+      end
+      markup
     end
 
   end

data/lib/ulysses/version.rb

@@ -1,3 +1,3 @@
 module Ulysses
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ulysses
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Yaodong Zhao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-06 00:00:00.000000000 Z
+date: 2016-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -112,9 +112,10 @@ files:
 - bin/console
 - bin/setup
 - lib/ulysses.rb
-- lib/ulysses/exporter.rb
 - lib/ulysses/group.rb
 - lib/ulysses/library.rb
+- lib/ulysses/printer.rb
+- lib/ulysses/printer/elements.rb
 - lib/ulysses/sheet.rb
 - lib/ulysses/version.rb
 - ulysses.gemspec

data/lib/ulysses/exporter.rb

@@ -1,287 +0,0 @@
-module Ulysses
-  class Exporter
-
-    def initialize(sheet_xml)
-      @xml   = Nokogiri::XML sheet_xml
-      @coder = HTMLEntities.new
-      @annotations = []
-      @footnotes   = []
-    end
-
-    def to_html
-      tree = xml_to_tree @xml.xpath('/sheet/string[@xml:space="preserve"]')
-      html = tree_to_html tree
-      html = parse_prefix_tags(html)
-      html = append_footnotes(html)
-      html = append_annotations(html)
-      Kramdown::Document.new(html).to_html
-    end
-
-    private
-
-    def xml_to_tree(xml)
-      xml.children.map do |child|
-        if child.text?
-          child.content
-        elsif child.element?
-          {
-              name: child.name,
-              attributes: Hash[child.attribute_nodes.map { |an| [an.node_name, an.content] }],
-              children: child.children.length > 0 ? xml_to_tree(child) : []
-          }
-        else
-          raise "Unknown node type: #{child.class}"
-        end
-      end
-    end
-
-    def tree_to_html(tree)
-      html = ''
-      tree.each do |node|
-        if node.is_a?(String)
-          html += @coder.encode node
-        else
-          case node[:name]
-            when 'p'
-              html += p_to_html node
-            when 'tags'
-              html += tree_to_html(node[:children])
-            when 'tag'
-              html += prefix_tag_to_placeholder node
-            when 'element'
-              html += element_to_html(node)
-            when 'attribute'
-              html += attribute_to_html(node)
-            when 'string'
-              html += string_to_html(node)
-            else
-              raise "Unknown tree node type: #{node[:name]}"
-          end
-        end
-      end
-      html
-    end
-
-    def p_to_html(node)
-      if node[:children].any?
-        tree_to_html(node[:children])
-      else
-        ''
-      end
-    end
-
-    def inline_tag_to_html(node, tag, attr = nil)
-      open_tag = attr.nil? ? "<#{tag} #{attr}>" : "<#{tag}>"
-      if node[:children].any?
-        open_tag + tree_to_html(node[:children]) + "</#{tag}>"
-      else
-        "#{open_tag}</#{tag}>"
-      end
-    end
-
-    def link_to_html(link)
-      string = '<a'
-      text = ''
-      link[:children].each do |child|
-        if child.is_a? String
-          text = child
-        else
-          identifier = child[:attributes]['identifier']
-          case
-            when 'URL'
-              string += ' url="'+ child[:children].first + '"'
-            when 'title'
-              string += ' title="'+ child[:children].first + '"'
-            else
-              raise "unknown link attr identifier #{identifier}"
-          end
-        end
-      end
-      string + '>' + text + '</a>'
-    end
-
-    def image_to_html(node)
-      html = '<img'
-      node[:children].each do |child|
-        case child[:attributes]['identifier']
-          when 'URL'
-            html += ' url="'+ child[:children].first + '"'
-          when 'title'
-            html += ' title="'+ child[:children].first + '"'
-          else
-            # skip
-        end
-      end
-      html + ' />'
-    end
-
-    def video_to_html(node)
-      source = ''
-      node[:children].each do |child|
-        case child[:attributes]['identifier']
-          when 'URL'
-            source = child[:children].first
-          else
-            # skip
-        end
-      end
-      '<video><source src="' + source + '"></video>'
-    end
-
-    def element_to_html(node)
-      case node[:attributes]['kind']
-        when 'strong'
-          inline_tag_to_html(node, 'strong')
-        when 'emph'
-          inline_tag_to_html(node, 'em')
-        when 'mark'
-          inline_tag_to_html(node, 'span', 'class="marked"')
-        when 'delete'
-          inline_tag_to_html(node, 'del')
-        when 'inlineComment'
-          inline_tag_to_html(node, 'span', 'class="comment"')
-        when 'code'
-          inline_tag_to_html(node, 'code')
-        when 'inlineNative'
-          inline_tag_to_html(node, 'span', 'class="native"')
-        when 'link'
-          link_to_html(node)
-        when 'annotation'
-          @annotations << [node[:children].last, tree_to_html(node[:children].first[:children])]
-          "<placeholder-annotation-#{@annotations.size - 1}/>"
-        when 'image'
-          image_to_html(node)
-        when 'video'
-          video_to_html(node)
-        when 'footnote'
-          string_node = node[:children].first[:children].first
-          @footnotes << tree_to_html(string_node[:children])
-          "<placeholder-footnote-#{@footnotes.size - 1}/>"
-        else
-          raise node
-      end
-    end
-
-    def prefix_tag_to_placeholder(node)
-      case node[:attributes]['kind']
-        when 'codeblock'
-          string = '<<prefix-tag-code-block>>'
-        when 'comment'
-          string = '<<prefix-tag-comment>>'
-        when 'divider'
-          string = '<hr class="divider" />'
-        when 'nativeblock'
-          string = '<<prefix-tag-native-block>>'
-        when 'blockquote'
-          string = '<<prefix-tag-block-quote>>'
-        when 'orderedList'
-          string = node[:children].first
-        when 'unorderedList'
-          string = node[:children].first
-        when 'heading1'
-          string = '<<prefix-tag-heading-1>>'
-        when 'heading2'
-          string = '<<prefix-tag-heading-2>>'
-        when 'heading3'
-          string = '<<prefix-tag-heading-5>>'
-        when 'heading4'
-          string = '<<prefix-tag-heading-4>>'
-        when 'heading5'
-          string = '<<prefix-tag-heading-5>>'
-        when 'heading6'
-          string = '<<prefix-tag-heading-6>>'
-        else
-          if node[:attributes].empty? && node[:children].first == "\t"
-            string = "\t"
-          else
-            raise node
-          end
-      end
-      string
-    end
-
-    def attribute_to_html(node)
-      case node[:attributes]['identifier']
-        when 'text'
-          html = tree_to_html node[:children]
-        else
-          raise "Unknown attribute node type: #{node[:attributes]['identifier']}"
-      end
-      html
-    end
-
-    def string_to_html(node)
-      case node[:attributes]['space']
-        when 'preserve'
-          html = tree_to_html node[:children]
-        else
-          raise "Unknown string node: #{node[:attributes]['space']}"
-      end
-      html
-    end
-
-    def parse_prefix_tags(html)
-      lines = html.split("\n")
-
-      prefix_tags = []
-      lines = lines.map do |line|
-        if /\A<<(prefix-tag[a-z0-9\-]+)>>(.*)\Z/i.match line
-          prefix_tags << $1
-          "<#{$1}>" + $2 + "</#{$1}>"
-        else
-          line
-        end
-      end
-
-      html = lines.join("\n")
-      prefix_tags.uniq.each do |prefix|
-        case prefix
-          when 'prefix-tag-code-block'
-            html_tag = 'pre-code'
-          when 'prefix-tag-native-block'
-            html_tag = 'pre-raw'
-          when 'prefix-tag-comment'
-            html_tag = 'should-delete'
-          when 'prefix-tag-block-quote'
-            html_tag = 'blockquote'
-          when /\Aprefix-tag-heading-(\d)\Z/i
-            html_tag = "h#{$1}"
-          else
-            raise "Unknown prefix tag: #{prefix}"
-        end
-        html.gsub! %r/(<\/?)#{prefix}>/, "\\1#{html_tag}>"
-        html.gsub! %r/<\/#{html_tag}>(\n*)<#{html_tag}>/, "\\1"
-      end
-
-      html.gsub! /<should-delete>.*<\/should-delete>\n?/, ''
-
-      html.gsub! /<pre-code>/, '<pre><code>'
-      html.gsub! /<\/pre-code>/, '</code></pre>'
-
-      html.gsub! /<pre-raw>/, '<p class="raw">'
-      html.gsub! /<\/pre-raw>/, '</p>'
-
-      html
-    end
-
-    def append_footnotes(html)
-      footnote_html = '<div class="footnotes">'
-      @footnotes.each_with_index do |fn, index|
-        html.gsub! /<placeholder-footnote-#{index}\/>/, "<sup><a href=\"#fn#{index}\" id=\"ref#{index}\">#{index}</a></sup>"
-        footnote_html += "<sup id=\"fn#{index}\">#{index}. " + fn + '</sup>'
-      end
-      html + "\n\n" + footnote_html + "</div>\n"
-    end
-
-    def append_annotations(html)
-      annotations_html = '<div class="annotations">'
-      @annotations.each_with_index do |at, index|
-        html.gsub! /<placeholder-annotation-#{index}/, "<span class=\"annotated\" data-annotation=\"#{index}\">#{at[0]}</span>"
-        annotations_html += "<section data-annotation=\"#{index}\">" + at[1] + '</section>'
-      end
-
-      html + "\n\n" + annotations_html + "</div>\n"
-    end
-
-  end
-end