dayone-kindle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e91e2417dc8198ecae3088a1fe6b8730aa93fc5e
+  data.tar.gz: f00a1bc2e8ca3f915239c29264ff94df2313269a
+SHA512:
+  metadata.gz: 5a0387c105b5d61d2bbf118fbb14ad5f1a5af970abe09c87e9d3c1cf07c6662b6d199625003f7bef4543964fc3b7822d79ed9c43a61d9808bedd3688e3aa05e1
+  data.tar.gz: aa0e67f393e5e31a32d7111dad575ff3ee4e577c7ba5a9c399842c8c9d4f4c89c1219e11a980db436f8f8a489aca01a5a12369f0d8998305b3b2659e8f470fd3

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.1
+  - 2.2.2
+  - ruby-head

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake'
+  gem 'minitest-reporters'
+end

data/Gemfile.lock

@@ -0,0 +1,23 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.2)
+    minitest (5.6.1)
+    minitest-reporters (1.0.16)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (10.4.2)
+    ruby-progressbar (1.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest-reporters
+  rake
+
+BUNDLED WITH
+   1.10.4

data/README.md

@@ -0,0 +1,5 @@
+# DayOne Kindle highlights importer [![Build Status](https://travis-ci.org/TimPetricola/dayone-kindle.svg)](https://travis-ci.org/TimPetricola/dayone-kindle)
+
+```
+dayone-kindle --help
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.warning = false
+  t.verbose = true
+end
+
+task default: [:test]

data/bin/dayone-kindle

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+if RUBY_VERSION.to_f < 2.0
+  $stderr.puts 'dayone-kindle require Ruby 2.0+.'
+  exit 1
+end
+
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+require 'optparse'
+
+# resolve bin path, ignoring symlinks
+require 'pathname'
+bin_file = Pathname.new(__FILE__).realpath
+
+# add self to libpath
+$:.unshift File.expand_path('../../lib', bin_file)
+
+require 'dayone-kindle'
+
+DayOneKindle::CLI.run

data/lib/dayone-kindle.rb

@@ -0,0 +1,48 @@
+require 'time'
+require 'fileutils'
+
+# https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/object/try.rb
+class Object
+  def try(*a, &b)
+    try!(*a, &b) if a.empty? || respond_to?(a.first)
+  end
+
+  def try!(*a, &b)
+    if a.empty? && block_given?
+      if b.arity == 0
+        instance_eval(&b)
+      else
+        yield self
+      end
+    else
+      public_send(*a, &b)
+    end
+  end
+end
+
+# https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/array/conversions.rb
+class Array
+  def to_sentence(words_connector: ', ', two_words_connector: ' and ', last_word_connector: ', and ')
+    case length
+    when 0
+      ''
+    when 1
+      "#{self[0]}"
+    when 2
+      "#{self[0]}#{two_words_connector}#{self[1]}"
+    else
+      "#{self[0...-1].join(words_connector)}#{last_word_connector}#{self[-1]}"
+    end
+  end
+end
+
+LIB = File.dirname(File.expand_path(__FILE__))
+
+require LIB + '/dayone-kindle/day_one'
+require LIB + '/dayone-kindle/highlight'
+require LIB + '/dayone-kindle/data_store'
+require LIB + '/dayone-kindle/clipping_parser'
+require LIB + '/dayone-kindle/clippings_parser'
+require LIB + '/dayone-kindle/device'
+require LIB + '/dayone-kindle/cli'
+

data/lib/dayone-kindle/cli.rb

@@ -0,0 +1,81 @@
+module DayOneKindle
+  module CLI
+    def self.dialog(value)
+      script = <<-END
+  tell app "System Events"
+    display dialog "#{value}"
+  end tell
+END
+
+      system('osascript ' + script.split(/\n/).map { |line| "-e '#{line}'" }.join(' ') + '> /dev/null 2>&1')
+    end
+
+    def self.options
+      return @options if @options
+
+      options = {
+        ask_confirmation: true,
+        tags: [],
+        dry_run: false,
+        archive: true
+      }
+
+      optparse = OptionParser.new do |opts|
+        opts.banner = 'Usage: dayone-kindle [options]'
+
+        opts.on '--dry', 'Outputs highlights instead of importing them (use for testing)' do
+          options[:dry_run] = true
+        end
+
+        opts.on '-t', '--tags reading,quote', Array, 'Tags to be saved with highlights' do |t|
+          options[:tags] = t
+        end
+
+        opts.on '--auto-confirm', 'Do not ask for confirmation before import' do
+          options[:ask_confirmation] = false
+        end
+
+        opts.on '--no-archive', 'Do not archive imported highlights on device' do
+          options[:archive] = false
+        end
+      end
+
+      optparse.parse!
+
+      @options = options
+    end
+
+    def self.run
+      tags = options[:tags]
+
+      DayOneKindle::Device.find_at('/Volumes').each do |kindle|
+        next if kindle.highlights.empty?
+
+        if options[:ask_confirmation]
+          label = "#{kindle.name} detected. Highlights will be imported to Day One."
+          next unless dialog(label)
+        end
+
+        store = DayOneKindle::DataStore.new(kindle.highlights, tags)
+        puts "#{store.entries.count} highlights to import"
+
+        puts "Tags: #{tags.empty? ? 'no tags' : tags.join(', ')}"
+
+        if options[:dry_run]
+          puts 'Dry run, no highlight imported'
+        else
+          entries = store.save!
+          puts "#{entries.count} highlights imported with tags"
+
+          if options[:archive]
+            path = kindle.archive_highlights!
+            puts "Highlights archived at #{path}"
+          end
+
+          kindle.clear_highlights!
+          puts 'Highlights cleared from device'
+        end
+      end
+    end
+  end
+end

data/lib/dayone-kindle/clipping_parser.rb

@@ -0,0 +1,81 @@
+module DayOneKindle
+  class ClippingParser
+    attr_reader :raw
+
+    REGEX = %r{^
+      (?<book>.+)\s\((?<authors>.+)\)\n
+      \-\s(?<metadata>.+)\n\n
+      (?<quote>.+)?
+    $}xi
+
+    def initialize(raw)
+      @raw = raw
+    end
+
+    def highlight
+      return unless metadata.match(/Highlight/i)
+      return unless quote
+
+      Highlight.new(
+        book: book,
+        highlight: quote,
+        time: time,
+        page: page,
+        location: location,
+        authors: authors
+      )
+    end
+
+    private
+
+    def book
+      @book ||= begin
+        b = matches.try(:[], :book)
+        b && !b.empty? && b.strip
+      end
+    end
+
+    def quote
+      @quote ||= begin
+        q = matches.try(:[], :quote)
+        q && !q.empty? && q && q.gsub(/ \u00a0/, "\n\n").strip
+      end
+    end
+
+    def time
+      @time ||= begin
+        string = metadata.match(/added on (?<time>.+)/i).try(:[], :time)
+        string && !string.empty? && Time.parse(string.strip)
+      end
+    end
+
+    def page
+      @page ||= begin
+        page = metadata.match(/page (?<page>\d+)/i).try(:[], :page)
+        page && !page.empty? && page.to_i
+      end
+    end
+
+    def location
+      @location ||= begin
+        location = metadata.match(/location (?<location>[\d-]+)/i).try(:[], :location)
+        location && !location.empty? && location
+      end
+    end
+
+    def authors
+      @authors ||= begin
+        string = matches.try(:[], :authors)
+        string && !string.empty? && string.split(';')
+      end
+    end
+
+    def metadata
+      @metadata ||= matches[:metadata]
+    end
+
+    def matches
+      @matches ||= raw.match(REGEX)
+    end
+  end
+end

data/lib/dayone-kindle/clippings_parser.rb

@@ -0,0 +1,15 @@
+module DayOneKindle
+  class ClippingsParser
+    attr_reader :raw
+
+    def initialize(raw)
+      @raw = raw
+    end
+
+    def highlights
+      raw.split("\n==========\n").map do |r|
+        ClippingParser.new(r).highlight
+      end.compact
+    end
+  end
+end

data/lib/dayone-kindle/data_store.rb

@@ -0,0 +1,24 @@
+module DayOneKindle
+  class DataStore
+    attr_reader :entries, :tags
+
+    def initialize(entries, tags = [])
+      @entries = entries
+      @tags = tags
+    end
+
+    def save!
+      entries.map { |entry| save_entry!(entry) }
+    end
+
+    private
+
+    def save_entry!(entry)
+      DayOne::Entry.new(
+        entry.to_markdown,
+        created_at: entry.time,
+        tags: tags
+      ).save!
+    end
+  end
+end

data/lib/dayone-kindle/day_one.rb

@@ -0,0 +1,67 @@
+module DayOneKindle
+  module DayOne
+    def self.journal_location
+      @journal_location ||= begin
+        prefs_file = File.join(ENV['HOME'], 'Library/Group Containers/5U8NS4GX82.dayoneapp/Data/Preferences/dayone.plist')
+        raise 'DayOne preference file not found' unless File.exists?(prefs_file)
+
+        prefs = File.read(prefs_file)
+        match = prefs.match(/<key>JournalPackageURL<\/key>\n\t<string>([^<>]+)<\/string>/)
+        raise 'DayOne journal not found' unless match && match[1]
+        match[1]
+      end
+    end
+
+    class Entry
+      attr_accessor :content, :created_at, :tags
+
+      def initialize(content, options = {})
+        @content = content
+        @tags = options[:tags] || []
+        @created_at = options[:created_at] || Time.now
+      end
+
+      def uuid
+        @uuid ||= `uuidgen`.gsub('-', '').strip
+      end
+
+      def file
+        @file ||= File.join(DayOne::journal_location, 'entries', "#{uuid}.doentry")
+      end
+
+      def to_xml
+        tags_xml = ''
+
+        unless tags.empty?
+          tags_xml = <<XML
+  <key>Tags</key>
+  <array>
+  #{tags.map { |tag| "  <string>#{tag}</string>" }.join("\n  ") }
+  </array>
+XML
+        end
+
+        <<-XML
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+  <key>Creation Date</key>
+  <date>#{created_at.utc.iso8601}</date>
+  <key>Entry Text</key>
+  <string>#{content}</string>
+  #{tags_xml.strip}
+  <key>UUID</key>
+  <string>#{uuid}</string>
+</dict>
+</plist>
+XML
+      end
+
+      def save!
+        File.open(file, 'w') { |f| f.write(to_xml) }
+        uuid
+      end
+    end
+  end
+end

data/lib/dayone-kindle/device.rb

@@ -0,0 +1,52 @@
+module DayOneKindle
+  class Device
+    CLIPPINGS_PATH = '/documents/My Clippings.txt'.freeze
+    VERSION_PATH = '/system/version.txt'.freeze
+    BACKUP_PATH = '/clippings-backups'.freeze
+    BACKUP_NAME = '%Y%m%d-%H%M%S.txt'.freeze
+
+    attr_reader :path, :name, :clippings_path, :clippings_backups_path
+
+    def initialize(path, name)
+      @path = path
+      @name = name
+      @clippings_path = File.join(path, CLIPPINGS_PATH)
+      @clippings_backups_path = File.join(path, BACKUP_PATH)
+    end
+
+    def highlights
+      ClippingsParser.new(raw_clippings).highlights
+    end
+
+    def archive_highlights!
+      Dir.mkdir(clippings_backups_path) unless Dir.exist?(clippings_backups_path)
+      backup_name = Time.now.strftime(BACKUP_NAME)
+      backup_file_path = File.join(clippings_backups_path, backup_name)
+      FileUtils.cp(clippings_path, backup_file_path)
+      backup_file_path
+    end
+
+    def clear_highlights!
+      File.truncate(clippings_path, 0)
+    end
+
+    def self.find_at(mount_path)
+      volumes = Dir.entries(mount_path) - ['.', '..']
+
+      volumes.map do |name|
+        path = File.join(mount_path, name)
+        version_path = File.join(path, VERSION_PATH)
+
+        if File.exist?(version_path) && IO.read(version_path) =~ /^Kindle/
+          new(path, name)
+        end
+      end.compact
+    end
+
+    private
+
+    def raw_clippings
+      File.read(clippings_path).gsub("\r", '')
+    end
+  end
+end

data/lib/dayone-kindle/highlight.rb

@@ -0,0 +1,51 @@
+module DayOneKindle
+  class Highlight
+    attr_reader :book, :highlight, :time, :page, :location, :authors
+
+    def initialize(options)
+      # Faking required named arguments for ruby 2.0 compatibility
+      %i(book highlight time).each do |param|
+        raise ArgumentError, "missing keyword :#{param}" unless options[param]
+        instance_variable_set(:"@#{param}", options[param])
+      end
+
+      @page = options[:page]
+      @location = options[:location]
+      @authors = options[:authors] || []
+    end
+
+    def to_markdown
+      [
+        markdown_header,
+        '',
+        markdown_authors,
+        '',
+        markdown_highlight,
+        '',
+        markdown_meta
+      ].compact.join("\n")
+    end
+
+    private
+
+    def markdown_header
+      "# Quote from #{book || 'a book'}"
+    end
+
+    def markdown_authors
+      return if authors.empty?
+      "By #{authors.map { |a| "*#{a}*" }.to_sentence}."
+    end
+
+    def markdown_meta
+      meta = []
+      meta << "Page #{page}" if page
+      meta << "Location #{location}" if location
+      meta.join(' - ') unless meta.empty?
+    end
+
+    def markdown_highlight
+      '> ' + highlight.gsub(/\n/, "\n>")
+    end
+  end
+end

data/lib/dayone-kindle/version.rb

@@ -0,0 +1,3 @@
+module DayOneKindle
+  VERSION = '0.1.0'
+end

data/test/clipping_parser_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class ClippingParserTest < Minitest::Test
+  def test_parsing
+    clipping = <<EOF
+Shibumi (Trevanian)
+- Your Highlight on Page 121 | Location 1851-1853 | Added on Friday, November 28, 2014 3:31:42 PM
+
+Do not fall into the error of the artisan who boasts of twenty years experience in his craft while in fact he has had only one year of experience—twenty times.
+EOF
+    highlight = DayOneKindle::ClippingParser.new(clipping).highlight
+
+    assert_equal 'Shibumi', highlight.book
+    assert_equal ['Trevanian'], highlight.authors
+    assert_equal 121, highlight.page
+    assert_equal '1851-1853', highlight.location
+    assert_equal Time.new(2014, 11, 28, 15, 31, 42), highlight.time
+  end
+end

data/test/highlight_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class HighlightTest < Minitest::Test
+  def test_to_markdown
+    highlight = DayOneKindle::Highlight.new(
+      book: 'The Pragmatic Programmer: From Journeyman to Master',
+      authors: ['Andrew Hunt', 'David Thomas'],
+      highlight: 'Embrace the fact that debugging is just problem solving, and attack it as such.',
+      time: Time.new(2014, 3, 5, 15, 4, 22),
+      page: 121,
+      location: '1850-1850'
+    )
+
+    expected_markdown = <<EOF
+# Quote from The Pragmatic Programmer: From Journeyman to Master
+
+By *Andrew Hunt* and *David Thomas*.
+
+> Embrace the fact that debugging is just problem solving, and attack it as such.
+
+Page 121 - Location 1850-1850
+EOF
+    expected_markdown.strip!
+
+    assert_equal expected_markdown, highlight.to_markdown
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'minitest/autorun'
+
+require 'minitest/reporters'
+Minitest::Reporters.use!(Minitest::Reporters::DefaultReporter.new(color: true))
+
+require './lib/dayone-kindle'

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: dayone-kindle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Petricola
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+description: 
+email: tim.petricola@gmail.com
+executables:
+- dayone-kindle
+extensions: []
+extra_rdoc_files: []
+files:
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/dayone-kindle
+- lib/dayone-kindle.rb
+- lib/dayone-kindle/cli.rb
+- lib/dayone-kindle/clipping_parser.rb
+- lib/dayone-kindle/clippings_parser.rb
+- lib/dayone-kindle/data_store.rb
+- lib/dayone-kindle/day_one.rb
+- lib/dayone-kindle/device.rb
+- lib/dayone-kindle/highlight.rb
+- lib/dayone-kindle/version.rb
+- test/clipping_parser_test.rb
+- test/highlight_test.rb
+- test/test_helper.rb
+homepage: https://github.com/TimPetricola/dayone-kindle
+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: Import highlights from Kindle to Day One
+test_files:
+- test/clipping_parser_test.rb
+- test/highlight_test.rb
+- test/test_helper.rb