ulysses 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4e13d121f75e0e2a05613bcce5e1cde731d18ec
+  data.tar.gz: a7fa728bb25f65dc90be147f4a7d734e3f9220bc
+SHA512:
+  metadata.gz: 2558ca71b86d63dfc6b785a66b65af216b4f43b635357fbad898957df045aad8719a1b5071022d1d9c5b7072e11cb6f46246aa23a2c98a30af662b4da576be98
+  data.tar.gz: 558294b9a9c596eb118ebfef2d8893bc7dda1166ecbd6a9bfbdb502cf823ca78b660f7bdaa0f94cfb9cf243aaf5fc5950497b8951ec2f7944b3e8024a58efb4d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at y@whir.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ulysses.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yaodong Zhao
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# Ulysses
+
+This is a library to export your to HTML files. It still in development.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ulysses'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ulysses
+
+## Usage
+
+Get your library:
+
+    library = Ulysses::Library.new
+    
+Get groups from library
+
+    groups = library.groups
+    
+Get children groups:
+
+    group = library.groups.first
+    children = group.children
+    
+Get Sheets:
+
+    group.sheets
+    
+Export sheet to HTML:
+
+    sheet = group.sheets.first
+    html  = sheet.to_html
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yaodong/gem-ulysses. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ulysses"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ulysses.rb

@@ -0,0 +1,11 @@
+require 'nokogiri'
+require 'htmlentities'
+require 'kramdown'
+require 'ulysses/library'
+require 'ulysses/group'
+require 'ulysses/sheet'
+require 'ulysses/exporter'
+
+module Ulysses
+
+end

data/lib/ulysses/exporter.rb

@@ -0,0 +1,287 @@
+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

data/lib/ulysses/group.rb

@@ -0,0 +1,35 @@
+module Ulysses
+  class Group
+
+    attr_reader :dirname
+
+    def initialize(info_file_path)
+      @dirname = File.dirname(info_file_path)
+      @info    = parse_info(info_file_path)
+    end
+
+    def children
+      @info['childOrder'].children.map do |child|
+        Group.new File.join(@dirname, child.content, 'Info.ulgroup') if child.element?
+      end.compact
+    end
+
+    def sheets
+      list = @info['sheetClusters'].children.find { |child| child.element? && child.name == 'array' }
+      list.children.map do |child|
+        Sheet.new File.join(@dirname, child.content) if child.element? && child.name == 'string'
+      end.compact
+    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
+      Hash[*dict]
+    end
+
+  end
+end

data/lib/ulysses/library.rb

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

data/lib/ulysses/sheet.rb

@@ -0,0 +1,28 @@
+module Ulysses
+  class Sheet
+
+    attr_reader :dirname
+
+    def initialize(dirname)
+      @dirname = dirname
+    end
+
+    def reload
+      @content = nil
+      @text    = nil
+    end
+
+    def content
+      @content ||= File.read(File.join(@dirname, 'Content.xml'))
+    end
+
+    def text
+      @text ||= File.read(File.join(@dirname, 'Text.txt'))
+    end
+
+    def to_html
+      Exporter.new(content).to_html
+    end
+
+  end
+end

data/lib/ulysses/version.rb

@@ -0,0 +1,3 @@
+module Ulysses
+  VERSION = '0.3.0'
+end

data/ulysses.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ulysses/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ulysses"
+  spec.version       = Ulysses::VERSION
+  spec.authors       = ["Yaodong Zhao"]
+  spec.email         = ["y@whir.org"]
+
+  spec.summary       = 'Access ulysses library by ruby'
+  spec.description   = 'Access ulysses library by ruby'
+  spec.homepage      = 'https://github.com/yaodong/gem-ulysses'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'nokogiri'
+  spec.add_dependency 'kramdown'
+  spec.add_dependency 'htmlentities'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: ulysses
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Yaodong Zhao
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Access ulysses library by ruby
+email:
+- y@whir.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ulysses.rb
+- lib/ulysses/exporter.rb
+- lib/ulysses/group.rb
+- lib/ulysses/library.rb
+- lib/ulysses/sheet.rb
+- lib/ulysses/version.rb
+- ulysses.gemspec
+homepage: https://github.com/yaodong/gem-ulysses
+licenses:
+- MIT
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Access ulysses library by ruby
+test_files: []