klipbook 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+-m markdown

data/Gemfile

@@ -0,0 +1,19 @@
+source 'http://rubygems.org'
+
+gem 'thor'
+
+group :development do
+  gem 'rspec'
+  gem 'rr'
+  gem 'bundler'
+  gem 'jeweler', '~> 1.6.4'
+  gem 'rcov', '>= 0'
+  gem 'cucumber'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-cucumber'
+  gem 'rb-inotify', :require => false
+  gem 'rb-fsevent', :require => false
+  gem 'rb-fchange', :require => false
+  gem 'growl_notify'
+end

data/Gemfile.lock

@@ -0,0 +1,67 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.0.0)
+    cucumber (1.1.3)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.6.7)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.6)
+    diff-lcs (1.1.3)
+    ffi (1.0.11)
+    gherkin (2.6.7)
+      json (>= 1.4.6)
+    git (1.2.5)
+    growl_notify (0.0.3)
+      rb-appscript
+    guard (0.8.8)
+      thor (~> 0.14.6)
+    guard-cucumber (0.7.4)
+      cucumber (>= 0.10)
+      guard (>= 0.8.3)
+    guard-rspec (0.5.5)
+      guard (>= 0.8.4)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.1)
+    rake (0.9.2.2)
+    rb-appscript (0.6.1)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.4.3.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rcov (0.9.11)
+    rr (1.0.4)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    term-ansicolor (1.0.7)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  cucumber
+  growl_notify
+  guard
+  guard-cucumber
+  guard-rspec
+  jeweler (~> 1.6.4)
+  rb-fchange
+  rb-fsevent
+  rb-inotify
+  rcov
+  rr
+  rspec
+  thor

data/Guardfile

@@ -0,0 +1,19 @@
+
+group 'backend' do
+
+  guard 'rspec', :cli => '--color --format doc' do
+    # Regexp watch patterns are matched with Regexp#match
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})         { |m| "spec/lib/#{m[1]}_spec.rb" }
+
+    # String watch patterns are matched with simple '=='
+    watch('spec/spec_helper.rb') { "spec" }
+  end
+
+  guard 'cucumber' do
+    watch(%r{^features/.+\.feature$})
+    watch(%r{^features/support/.+$})                      { 'features' }
+    watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+  end
+end
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ray Grasso
+
+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,51 @@
+# Klipbook
+
+Klipbook creates a html summary of your Kindle book clippings.
+
+## How does it work?
+
+Copy your clippings file (called "My Clippings.txt" on a 3rd generation Kindle) from your Kindle device to your local drive via USB.
+
+**List the books in your clippings file:**
+
+    $ klipbook list "My Clippings.txt"
+
+    The list of books in your clippings file:
+    [1] The Big Sleep by Raymond Chandler
+    [2] How to jump out of a plane without a parachute and survive by Rip Rockjaw
+
+**Print a html summary for the book of your choice:**
+
+Choose the index of the book you are interested in and print a html summary with the `summarise` command:
+
+    $ klipbook summarise "My Clippings.txt" 1 big-sleep-clippings.html
+
+Keep this nicely formatted html version of your clippings for your own reference.
+
+## Example of a summary file generated by Klipbook
+
+<img src="https://github.com/grassdog/klipbook/raw/master/example.png" alt="Example of a summary file" />
+
+## Installation
+
+Klipbook is a Ruby gem. To install simply run:
+
+    gem install klipbook
+
+## Why not just see your clippings on the Amazon site?
+
+Currently [the Amazon highlights site](https://kindle.amazon.com/your_highlights) only shows clippings for books you purchased on Amazon.
+
+## Tested platforms
+
+Klipbook has been tested on clippings files from 3rd generation Kindles and run using MRI 1.9.3 on Mac OSX Lion and Ubuntu.
+
+
+## Contributing to Klipbook
+
+Fork the project on [Github](https://github.com/grassdog/klipbook) and submit a pull request. 
+
+## Copyright
+
+Copyright (c) 2011 Ray Grasso. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler/setup'
+require 'rake'
+require './lib/klipbook/version.rb'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = 'klipbook'
+  gem.homepage = 'https://github.com/grassdog/klipbook'
+  gem.license = 'MIT'
+  gem.summary = %Q{Klipbook creates a HTML summary of your Kindle book clippings.}
+  gem.description = %Q{Process your Kindle clippings file to generate a nicely formatted compilation of your clippings of the books you've read}
+  gem.email = 'ray.grasso@gmail.com'
+  gem.authors = ['Ray Grasso']
+  gem.version = Klipbook::VERSION
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = Klipbook::VERSION
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "klipbook #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rspec/core/rake_task'
+desc 'Generate code coverage'
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = './spec/**/*_spec.rb' # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = '--format progress'
+end
+
+desc 'Default: run specs'
+task :default => :spec
+

data/bin/klipbook

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+require 'klipbook'
+
+Klipbook::CLI.start
+

data/features/list_books.feature

@@ -0,0 +1,23 @@
+Feature: klipbook lists the books in a clipping file
+  As an avid reader and note taker
+  I want to be shown an indexed list of books in my clipping file
+  So that I can choose which book I want to extract a pretty collated list of notes from
+
+  Scenario: Empty file
+    Given I have a file that contains no clippings
+    When I list the books in the file with klipbook
+    Then I should see the message "Your clippings file contains no books"
+
+  Scenario: File with one book
+    Given I have a file that contains clippings for the book titled "The life of dogs"
+    When I list the books in the file with klipbook
+    Then I should see the message "The list of books in your clippings file:"
+    And I should see the message "[1] The life of dogs"
+
+  Scenario: File with two books
+    Given I have a file that contains clippings for the book titled "The life of dogs"
+    And I have a file that contains clippings for the book titled "A hard day's night"
+    When I list the books in the file with klipbook
+    Then I should see the message "The list of books in your clippings file:"
+    And I should see the message "[1] A hard day's night"
+    And I should see the message "[2] The life of dogs"

data/features/print_book_summary.feature

@@ -0,0 +1,10 @@
+Feature: klipbook outputs a pretty summary of the clippings for a book
+  As an avid reader and note taker
+  I want to see a pretty summary file of the clippings for a book
+  So that I can read a nice summary of my clippings for a book I've read
+
+  Scenario: File with clippings for a book
+    Given I have a file that contains multiple clippings for the book titled "The life of dogs"
+    When I print the summary for book number "1" with klipbook
+    Then I should see a pretty summary for the book "The life of dogs"
+

data/features/step_definitions/klipbook_steps.rb

@@ -0,0 +1,87 @@
+Before do
+  FileUtils.mkdir_p(TEST_DIR)
+  Dir.chdir(TEST_DIR)
+end
+
+After do
+  Dir.chdir(TEST_DIR)
+  FileUtils.rm_rf(TEST_DIR)
+end
+
+class Output
+  def messages
+    @messages ||= []
+  end
+
+  def puts(message)
+    messages << message
+  end
+
+  def write(message)
+    messages << message
+  end
+end
+
+def output
+  @output ||= Output.new
+end
+
+CLIPPING_FILE = 'test_clippings.txt'
+
+Given /^I have a file that contains no clippings$/ do
+  File.open(CLIPPING_FILE, 'w') do |f|
+    f.write ''
+  end
+end
+
+When /^I list the books in the file with klipbook$/ do
+  File.open(CLIPPING_FILE, 'r') do |f|
+    Klipbook::Runner.new(f).list_books(output)
+  end
+end
+
+Then /^I should see the message "([^"]*)"$/ do |message|
+  output.messages.should include(message)
+end
+
+Given /^I have a file that contains clippings for the book titled "([^"]*)"$/ do |book_title|
+  File.open(CLIPPING_FILE, 'a') do |f|
+    f.write <<EOF
+#{book_title}
+- Highlight Loc. 466-69  | Added on Thursday, April 21, 2011, 07:31 AM
+
+A test highlight
+==========
+EOF
+  end
+end
+
+Given /^I have a file that contains multiple clippings for the book titled "([^"]*)"$/ do |book_title|
+  File.open(CLIPPING_FILE, 'a') do |f|
+    f.write <<EOF
+#{book_title}
+- Highlight Loc. 466-69  | Added on Thursday, April 21, 2011, 07:31 AM
+
+A test highlight
+==========
+#{book_title}
+- Highlight Loc. 490  | Added on Thursday, April 21, 2011, 07:36 AM
+
+A second highlight
+==========
+EOF
+  end
+end
+
+When /^I print the summary for book number "([^"]+)" with klipbook/ do |book_number|
+  book_number = book_number.to_i
+
+  File.open(CLIPPING_FILE, 'r') do |f|
+    Klipbook::Runner.new(f).print_book_summary(book_number, output)
+  end
+end
+
+Then /^I should see a pretty summary for the book "([^"]*)"$/ do |book_title|
+  output.messages.first.should include("<h1>#{book_title}</h1")
+end
+

data/features/support/env.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+$LOAD_PATH << File.expand_path('../../../lib', __FILE__)
+require 'klipbook'
+require 'fileutils'
+
+TEST_DIR = File.expand_path('../../../tmp/test', __FILE__)

data/lib/klipbook/blank.rb

@@ -0,0 +1,24 @@
+class String
+
+  # A string is blank if it's empty or contains whitespaces only:
+  #
+  #   "".blank?                 # => true
+  #   "   ".blank?              # => true
+  #   " something here ".blank? # => false
+  #
+  def blank?
+    self !~ /\S/
+  end
+end
+
+class NilClass
+
+  # +nil+ is blank:
+  #
+  #   nil.blank? # => true
+  #
+  def blank?
+    true
+  end
+end
+

data/lib/klipbook/book_summary.erb

@@ -0,0 +1,92 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8"/>
+    <meta name="generator" content="Klipbook"/>
+    <title><%= @clippings.first.title %> - Collated Kindle Clippings</title>
+    <style type="text/css">
+      body {
+        color: #333;
+        font-size: 16px;
+        line-height: 1.5em;
+        font-family: Palatino, Georgia, serif;
+        background-color: #fff;
+        margin: 0px;
+        padding: 20px;
+      }
+      a {
+        text-decoration: none;
+      }
+      a, a:link, a:visited {
+        color: #084ab7;
+      }
+      a:hover {
+        text-decoration: underline;
+      }
+
+      h1 {
+        line-height: 1.1em;
+      }
+
+      h2 {
+        line-height: 1.1em;
+        font-size: 1.3em;
+        color: #555;
+        font-style: italic;
+      }
+
+      ul {
+        margin-top: 2em;
+        width: 43em;
+      }
+
+      ul li {
+        margin: 1.6em 0;
+        list-style: none;
+      }
+
+      ul li p {
+        margin-bottom: .5em;
+      }
+
+      ul li footer {
+        text-align: right;
+        font-size: .85em;
+        color: #8C8C8C;
+      }
+
+      footer {
+        font-size: .85em;
+        margin-left: 20em;
+      }
+
+      footer span {
+        font-style: italic;
+      }
+    </style>
+  </head>
+  <body>
+
+    <h1><%= @clippings.first.title %></h1>
+    <% unless @author.blank? %>
+      <h2>by <%= author %></h2>
+    <% end %>
+
+    <ul>
+      <% @clippings.each do |clipping| %>
+        <% unless clipping.text.blank? %>
+        <li>
+          <p>
+            <%= ERB::Util.html_escape(clipping.text) %>
+          </p>
+          <footer><%= clipping.type %><% if clipping.location %> @ loc <%= clipping.location %><% end %></footer>
+        </li>
+        <% end %>
+      <% end %>
+    </ul>
+
+    <footer>
+      Generated by <a href="https://github.com/grassdog/klipbook">Klipbook <%= Klipbook::VERSION %></a> on <span><%= DateTime.now.strftime('%e %b %Y at %l:%M %P') %></span>
+    </footer>
+  </body>
+</html>

data/lib/klipbook/book_summary.rb

@@ -0,0 +1,34 @@
+require 'erb'
+
+module Klipbook
+  class BookSummary
+    attr_accessor :title, :author, :clippings
+
+    def initialize(title, author, clippings=[])
+      @title = title
+      @author = author
+      @clippings = clippings.sort
+    end
+
+    def hash
+      title.hash ^ author.hash
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    def ==(other)
+      return false unless other.instance_of?(self.class)
+      title == other.title && author == other.author
+    end
+
+    def as_html
+      ERB.new(template, 0, '%<>').result(binding)
+    end
+
+    def template
+      @template ||= File.read(File.join(File.dirname(__FILE__), 'book_summary.erb'))
+    end
+  end
+end

data/lib/klipbook/cli.rb

@@ -0,0 +1,48 @@
+require 'thor'
+
+module Klipbook
+  class CLI < Thor
+
+    desc 'list CLIPPINGS_FILE', 'List the books in the clippings file'
+    def list(clippings_file=nil)
+      if (clippings_file.nil?)
+        puts 'Please provide a CLIPPINGS_FILE'
+        exit 1
+      end
+
+      clippings_file = ensure_clippings_file_exists(clippings_file)
+
+      Klipbook::Runner.new(clippings_file).list_books
+    end
+
+    desc 'summarise CLIPPINGS_FILE  BOOK_NUMBER  OUTPUT_FILE', 'Output an html summary of the clippings for a book'
+    def summarise(clippings_file=nil, book_number=nil, output_file=nil)
+      if (clippings_file.nil? or book_number.nil? or output_file.nil?)
+        puts 'Please provide a CLIPPINGS_FILE, BOOK_NUMBER, and OUTPUT_FILE'
+        exit 1
+      end
+
+      clippings_file = ensure_clippings_file_exists(clippings_file)
+
+      book_number = book_number.to_i
+
+      Klipbook::Runner.new(clippings_file).print_book_summary(book_number, File.open(output_file, 'w'))
+    end
+
+    map '-v' => :version
+    desc 'version', 'Display Klipbook version'
+    def version
+      puts "Klipbook #{Klipbook::VERSION}"
+    end
+
+    no_tasks do
+      def ensure_clippings_file_exists(clippings_file)
+        unless File.exist?(clippings_file)
+          $stderr.puts "Clippings file doesn't exist: #{clippings_file}"
+          exit 1
+        end
+        File.open(clippings_file, 'r')
+      end
+    end
+  end
+end

data/lib/klipbook/clipping.rb

@@ -0,0 +1,15 @@
+require 'ostruct'
+require 'date'
+
+module Klipbook
+  class Clipping < OpenStruct
+    def initialize(attributes)
+      super(attributes)
+      self.added_on = DateTime.strptime(self.added_on, '%A, %B %d, %Y, %I:%M %p') if self.added_on
+    end
+
+    def <=>(other)
+      (self.location || 0) <=> (other.location || 0)
+    end
+  end
+end

data/lib/klipbook/clippings_file.rb

@@ -0,0 +1,50 @@
+module Klipbook
+  class ClippingsFile
+    attr_accessor :books
+
+    def initialize(file_text, parser=Klipbook::ClippingsParser.new)
+      @books = extract_books_from_file_text(parser, file_text)
+    end
+
+   private
+
+    def extract_books_from_file_text(parser, file_text)
+      clippings = parser.extract_clippings_from(file_text)
+
+      group_clippings_into_books(clippings)
+    end
+
+    def group_clippings_into_books(clippings)
+      books = clippings.inject({}) do |new_hash, clipping|
+        new_hash[hash_key_for_book(clipping)] ||= []
+        new_hash[hash_key_for_book(clipping)] << clipping
+        new_hash
+      end
+
+      books = sort_books_by_title(books)
+      books = sort_clippings_by_location(books)
+      build_book_summaries(books)
+    end
+
+    def build_book_summaries(books)
+      books.values.map { |clippings| Klipbook::BookSummary.new(clippings.first.title, clippings.first.author, clippings) }
+    end
+
+    def hash_key_for_book(clipping)
+      "#{clipping.title}#{clipping.author}"
+    end
+
+    def sort_books_by_title(books)
+      Hash[books.sort]
+    end
+
+    def sort_clippings_by_location(books)
+      books.inject({}) do |new_hash, (k, v)|
+        new_hash[k] = v.sort
+        new_hash
+      end
+    end
+  end
+end
+
+