klipbook 1.0.2 → 2.0.0

data/klipbook.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "klipbook"
-  s.version = "1.0.2"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ray Grasso"]
-  s.date = "2012-12-12"
+  s.date = "2013-02-13"
   s.description = "Process your Kindle clippings file to generate a nicely formatted compilation of the clippings of the books you've read"
   s.email = "ray.grasso@gmail.com"
   s.executables = ["klipbook"]
@@ -33,34 +33,39 @@ Gem::Specification.new do |s|
     "features/collate.feature",
     "features/fixtures/clippings-for-three-books.txt",
     "features/list.feature",
+    "features/pretty_print.feature",
     "features/step_definitions/collate_steps.rb",
     "features/step_definitions/list_steps.rb",
+    "features/step_definitions/pretty_print_steps.rb",
     "features/support/env.rb",
     "klipbook.gemspec",
     "lib/klipbook.rb",
-    "lib/klipbook/blank.rb",
-    "lib/klipbook/book.rb",
-    "lib/klipbook/clipping.rb",
-    "lib/klipbook/collator.rb",
+    "lib/klipbook/collate/book_file.rb",
+    "lib/klipbook/commands/collate.rb",
+    "lib/klipbook/commands/list_books.rb",
+    "lib/klipbook/commands/pretty_print.rb",
     "lib/klipbook/config.rb",
-    "lib/klipbook/fetcher.rb",
-    "lib/klipbook/invalid_source_error.rb",
-    "lib/klipbook/output/book_helpers.rb",
-    "lib/klipbook/output/html_book_summary.erb",
-    "lib/klipbook/output/html_summary_writer.rb",
-    "lib/klipbook/printer.rb",
+    "lib/klipbook/pretty_print/html_book_summary.erb",
+    "lib/klipbook/pretty_print/html_printer.rb",
     "lib/klipbook/sources/amazon_site/book_scraper.rb",
     "lib/klipbook/sources/amazon_site/site_scraper.rb",
+    "lib/klipbook/sources/book.rb",
+    "lib/klipbook/sources/book_source.rb",
+    "lib/klipbook/sources/clipping.rb",
+    "lib/klipbook/sources/invalid_source_error.rb",
     "lib/klipbook/sources/kindle_device/entry.rb",
     "lib/klipbook/sources/kindle_device/entry_parser.rb",
     "lib/klipbook/sources/kindle_device/file.rb",
     "lib/klipbook/sources/kindle_device/file_parser.rb",
+    "lib/klipbook/util/blank.rb",
+    "lib/klipbook/util/struct_to_json.rb",
     "lib/klipbook/version.rb",
-    "spec/lib/klipbook/book_spec.rb",
-    "spec/lib/klipbook/collator_spec.rb",
-    "spec/lib/klipbook/fetcher_spec.rb",
-    "spec/lib/klipbook/output/html_summary_writer_spec.rb",
-    "spec/lib/klipbook/printer_spec.rb",
+    "spec/lib/klipbook/collate/book_file_spec.rb",
+    "spec/lib/klipbook/commands/list_books_spec.rb",
+    "spec/lib/klipbook/commands/pretty_print_spec.rb",
+    "spec/lib/klipbook/pretty_print/html_printer_spec.rb",
+    "spec/lib/klipbook/sources/book_source_spec.rb",
+    "spec/lib/klipbook/sources/book_spec.rb",
     "spec/lib/klipbook/sources/kindle_device/entry_parser_spec.rb",
     "spec/lib/klipbook/sources/kindle_device/file_parser_spec.rb",
     "spec/lib/klipbook/sources/kindle_device/file_spec.rb",
@@ -86,7 +91,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<pry>, [">= 0"])
+      s.add_development_dependency(%q<pry-debugger>, [">= 0"])
       s.add_development_dependency(%q<cucumber>, [">= 0"])
       s.add_development_dependency(%q<aruba>, [">= 0"])
       s.add_development_dependency(%q<guard>, [">= 0"])
@@ -102,7 +107,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<bundler>, [">= 0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<pry>, [">= 0"])
+      s.add_dependency(%q<pry-debugger>, [">= 0"])
       s.add_dependency(%q<cucumber>, [">= 0"])
       s.add_dependency(%q<aruba>, [">= 0"])
       s.add_dependency(%q<guard>, [">= 0"])
@@ -119,7 +124,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<bundler>, [">= 0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<pry>, [">= 0"])
+    s.add_dependency(%q<pry-debugger>, [">= 0"])
     s.add_dependency(%q<cucumber>, [">= 0"])
     s.add_dependency(%q<aruba>, [">= 0"])
     s.add_dependency(%q<guard>, [">= 0"])

data/lib/klipbook/collate/book_file.rb

@@ -0,0 +1,54 @@
+require 'json'
+
+module Klipbook::Collate
+  class BookFile
+    attr_reader :books
+
+    def self.from_json(raw_json)
+      if raw_json.blank?
+        books = []
+      else
+        objs = JSON.parse(raw_json)
+        books = objs.map { |o| Klipbook::Book.from_hash(o) }
+      end
+      self.new(books)
+    end
+
+    def initialize(books)
+      @books = books || []
+    end
+
+    def add_books(new_books, force, message_stream=$stdout)
+      new_books.each do |new_book|
+        if book_exists?(new_book)
+          replace_book(new_book, message_stream) if force
+        else
+          message_stream.puts "Adding: #{new_book.title_and_author}"
+          @books.push(new_book)
+        end
+      end
+    end
+
+    def to_json
+      JSON.pretty_generate(@books)
+    end
+
+    private
+
+    def book_exists?(new_book)
+      find_book(new_book)
+    end
+
+    def find_book(new_book)
+      @books.find { |existing_book| existing_book.title_and_author == new_book.title_and_author }
+    end
+
+    def replace_book(new_book, message_stream)
+      message_stream.puts "Updating: #{new_book.title_and_author}"
+
+      old_book = find_book(new_book)
+      @books.delete(old_book)
+      @books.push(new_book)
+    end
+  end
+end

data/lib/klipbook/commands/collate.rb

@@ -0,0 +1,17 @@
+module Klipbook::Commands
+  class Collate
+    def initialize(books, book_file)
+      @books = books
+      @book_file = book_file
+    end
+
+    def call(output_file_path, force, message_stream=$stdout)
+      File.open(output_file_path, 'w') do |output_file|
+        @book_file.add_books(@books, force)
+
+        message_stream.puts "\nWriting book json to file: #{output_file.path}"
+        output_file.puts @book_file.to_json
+      end
+    end
+  end
+end

data/lib/klipbook/commands/list_books.rb

@@ -0,0 +1,19 @@
+module Klipbook::Commands
+  class ListBooks
+    def initialize(books)
+      @books = books
+    end
+
+    def call(output_stream=$stdout)
+      if @books.empty?
+        output_stream.puts 'No books available'
+      else
+        output_stream.puts 'Book list:'
+        @books.each_with_index do |book, index|
+          output_stream.puts "[#{index + 1}] #{book.title_and_author}"
+        end
+      end
+    end
+  end
+end
+

data/lib/klipbook/commands/pretty_print.rb

@@ -0,0 +1,17 @@
+module Klipbook::Commands
+  class PrettyPrint
+    def initialize(books, pretty_printer=Klipbook::PrettyPrint::HtmlPrinter.new)
+      @books = books
+      @pretty_printer = pretty_printer
+    end
+
+    def call(output_dir, force, message_stream=$stdout)
+      message_stream.puts "Using output directory: #{output_dir}"
+
+      @books.each do |book|
+        @pretty_printer.print_to_file(book, output_dir, force)
+      end
+    end
+  end
+end
+

data/lib/klipbook/{output/html_summary_writer.rb → pretty_print/html_printer.rb}

@@ -1,16 +1,14 @@
 require 'erb'
 
-module Klipbook::Output
-  class HtmlSummaryWriter
+module Klipbook::PrettyPrint
+  class HtmlPrinter
     def initialize(message_stream=$stdout)
       @message_stream = message_stream
     end
 
-    def write(book, output_dir, force)
+    def print_to_file(book, output_dir, force)
       require 'rainbow'
 
-      book.extend Klipbook::Output::BookHelpers
-
       filename = filename_for_book(book)
       filepath = File.join(output_dir, filename)
 
@@ -38,5 +36,6 @@ module Klipbook::Output
     def template
       @template ||= File.read(File.join(File.dirname(__FILE__), 'html_book_summary.erb'))
     end
+
   end
 end

data/lib/klipbook/sources/amazon_site/book_scraper.rb

@@ -11,7 +11,7 @@ module Klipbook::Sources
       private
 
       def build_book(page, element)
-        Klipbook::Book.new do |b|
+        Klipbook::Book.new.tap do |b|
           b.asin = element.attribute("id").value.gsub(/_[0-9]+$/, "")
           b.author = element.xpath("span[@class='author']").text.gsub("\n", "").gsub(" by ", "").strip
           b.title = element.xpath("span/a").text
@@ -34,7 +34,7 @@ module Klipbook::Sources
         annotation_id = element.xpath("form/input[@id='annotation_id']").attribute("value").value
         note_text = element.xpath("p/span[@class='noteContent']").text
 
-        highlight = Klipbook::Clipping.new do |c|
+        highlight = Klipbook::Clipping.new.tap do |c|
           c.annotation_id = annotation_id
           c.text = element.xpath("span[@class='highlight']").text
           c.type = :highlight
@@ -44,7 +44,7 @@ module Klipbook::Sources
         if note_text.blank?
           highlight
         else
-          note = Klipbook::Clipping.new do |c|
+          note = Klipbook::Clipping.new.tap do |c|
             c.annotation_id = annotation_id
             c.text = note_text
             c.type = :note

data/lib/klipbook/sources/book.rb

@@ -0,0 +1,28 @@
+Klipbook::Book = Struct.new(:asin, :author, :title, :last_update, :clippings) do
+  def title_and_author
+    author_txt = author ? " by #{author}" : ''
+    "#{title}#{author_txt}"
+  end
+
+  def get_binding
+    binding
+  end
+
+  def location_html(location)
+    if self.asin
+      "<a href=\"kindle://book?action=open&asin=#{asin}&location=#{location}\">loc #{location}</a>"
+    else
+      "loc #{location}"
+    end
+  end
+
+  def self.from_hash(hash)
+    self.new.tap do |b|
+      b.asin = hash['asin']
+      b.author = hash['author']
+      b.title = hash['title']
+      b.last_update = hash['last_update']
+      b.clippings = hash['clippings'].map { |clip| Klipbook::Clipping.from_hash(clip) }
+    end
+  end
+end

data/lib/klipbook/{fetcher.rb → sources/book_source.rb}

@@ -1,29 +1,26 @@
-module Klipbook
-  class Fetcher
+module Klipbook::Sources
+  class BookSource
     def initialize(source_spec, max_books)
-      raise InvalidSourceError unless valid_source(source_spec)
+      raise InvalidSourceError unless valid_source?(source_spec)
 
       if (source_spec =~ /file:(.+)/)
-        raw_file = File.open($1, 'r')
-        @source = Klipbook::Sources::KindleDevice::File.new(raw_file.read.strip, max_books)
+        file_path = $1
+        @source = Klipbook::Sources::KindleDevice::File.new(file_path, max_books)
       elsif (source_spec =~ /site:(.+):(.+)/)
         username = $1
         password = $2
         @source = Klipbook::Sources::AmazonSite::SiteScraper.new(username, password, max_books)
-      else
-        raise InvalidSourceError("Unrecognised source type. Only 'file' and 'site' are supported")
       end
     end
 
-    def fetch_books
+    def books
       @source.books
     end
 
     private
 
-    def valid_source(source_spec)
+    def valid_source?(source_spec)
       source_spec =~ /(file:|site:.+:.+)/
     end
   end
 end
-

data/lib/klipbook/sources/clipping.rb

@@ -0,0 +1,11 @@
+Klipbook::Clipping = Struct.new(:annotation_id, :text, :location, :type, :page) do
+  def self.from_hash(hash)
+    self.new.tap do |b|
+      b.annotation_id = hash['annotation_id']
+      b.text = hash['text']
+      b.location = hash['location']
+      b.type = hash['type']
+      b.page = hash['page']
+    end
+  end
+end

data/lib/klipbook/sources/kindle_device/file.rb

@@ -1,8 +1,8 @@
 module Klipbook::Sources
   module KindleDevice
     class File
-      def initialize(file_text, max_books, file_parser=FileParser.new)
-        @file_text = file_text
+      def initialize(file_path, max_books, file_parser=FileParser.new)
+        @file_text = ::File.open(file_path, 'r') {|f| f.read.strip }
         @file_parser = file_parser
         @max_books = max_books
       end
@@ -38,12 +38,12 @@ module Klipbook::Sources
       def book_from_entries(entries)
         entries.sort! { |ea, eb| ea.location <=> eb.location }
 
-        Klipbook::Book.new do |b|
+        Klipbook::Book.new.tap do |b|
           b.title = entries.first.title
           b.author = entries.first.author
           b.last_update = entries.map(&:added_on).max
           b.clippings = entries.map do |e|
-            Klipbook::Clipping.new do |c|
+            Klipbook::Clipping.new.tap do |c|
               c.location = e.location
               c.page = e.page
               c.text = e.text

data/lib/klipbook/util/struct_to_json.rb

@@ -0,0 +1,11 @@
+class Struct
+  def to_map
+    map = Hash.new
+    self.members.each { |m| map[m] = self[m] }
+    map
+  end
+
+  def to_json(*a)
+    to_map.to_json(*a)
+  end
+end

data/lib/klipbook/version.rb

@@ -1,3 +1,3 @@
 module Klipbook
-  VERSION = '1.0.2'
+  VERSION = '2.0.0'
 end

data/lib/klipbook.rb

@@ -1,7 +1,17 @@
 # encoding: utf-8
-require 'klipbook/blank'
+require 'klipbook/util/blank'
+require 'klipbook/util/struct_to_json'
 require 'klipbook/version'
 
+require 'klipbook/commands/collate'
+require 'klipbook/commands/list_books'
+require 'klipbook/commands/pretty_print'
+
+require 'klipbook/sources/book_source'
+require 'klipbook/sources/book'
+require 'klipbook/sources/clipping'
+require 'klipbook/sources/invalid_source_error'
+
 require 'klipbook/sources/kindle_device/file_parser'
 require 'klipbook/sources/kindle_device/entry_parser'
 require 'klipbook/sources/kindle_device/entry'
@@ -10,14 +20,7 @@ require 'klipbook/sources/kindle_device/file'
 require 'klipbook/sources/amazon_site/site_scraper'
 require 'klipbook/sources/amazon_site/book_scraper'
 
-require 'klipbook/invalid_source_error'
 require 'klipbook/config'
-require 'klipbook/book'
-require 'klipbook/clipping'
-
-require 'klipbook/fetcher'
-require 'klipbook/collator'
-require 'klipbook/printer'
 
-require 'klipbook/output/html_summary_writer'
-require 'klipbook/output/book_helpers'
+require 'klipbook/pretty_print/html_printer'
+require 'klipbook/collate/book_file'

data/spec/lib/klipbook/collate/book_file_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Klipbook::Collate::BookFile do
+
+  describe '.from_json' do
+
+    subject { Klipbook::Collate::BookFile.from_json(json) }
+
+    context 'with empty json' do
+
+      let(:json) { '' }
+
+      its(:books) { should be_empty }
+    end
+  end
+
+  describe '#add_books' do
+    let (:message_stream) do
+      Object.new.tap do |fake_stream|
+        stub(fake_stream).puts
+      end
+    end
+
+    let(:it) do
+      books = [
+        Klipbook::Book.new.tap do |b|
+          b.title = "Book one"
+          b.author = "Author one"
+        end,
+        Klipbook::Book.new.tap do |b|
+          b.title = "Book two"
+          b.author = "Author two"
+        end
+      ]
+      Klipbook::Collate::BookFile.new(books)
+    end
+
+    it "adds any books that don't already exist" do
+      new_book = Klipbook::Book.new.tap do |b|
+        b.title = 'Book three'
+        b.author = 'Author two'
+      end
+
+      it.add_books([ new_book ], false, message_stream)
+      it.books.should have(3).items
+      it.books.should include(new_book)
+    end
+
+    it "replaces books that exist if force is true" do
+      new_book = Klipbook::Book.new.tap do |b|
+        b.title = 'Book one'
+        b.author = 'Author one'
+        b.asin = 'new asin'
+      end
+
+      it.add_books([ new_book ], true, message_stream)
+      it.books.should have(2).items
+      it.books.should include(new_book)
+    end
+
+    it "does not replace existing books if force is false" do
+      new_book = Klipbook::Book.new.tap do |b|
+        b.title = 'Book one'
+        b.author = 'Author one'
+        b.asin = 'new asin'
+      end
+
+      it.add_books([ new_book ], false, message_stream)
+      it.books.should have(2).items
+      it.books.should_not include(new_book)
+    end
+  end
+end

data/spec/lib/klipbook/{printer_spec.rb → commands/list_books_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Klipbook::Printer do
+describe Klipbook::Commands::ListBooks do
 
   let (:output) do
     Object.new.tap do |fake_output|
@@ -8,9 +8,9 @@ describe Klipbook::Printer do
     end
   end
 
-  describe '#print' do
+  describe '#call' do
 
-    subject { Klipbook::Printer.new(books).print(output) }
+    subject { Klipbook::Commands::ListBooks.new(books).call(output) }
 
     context 'when created with no books' do
 
@@ -25,8 +25,8 @@ describe Klipbook::Printer do
     context 'when created with multiple books' do
       let (:books) do
         [
-          Klipbook::Book.new { |b| b.title = 'My first fake title' },
-          Klipbook::Book.new { |b| b.title = 'Another fake book'; b.author = 'Rock Riphard' }
+          Klipbook::Book.new.tap { |b| b.title = 'My first fake title' },
+          Klipbook::Book.new.tap { |b| b.title = 'Another fake book'; b.author = 'Rock Riphard' }
         ]
       end
 

data/spec/lib/klipbook/commands/pretty_print_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Klipbook::Commands::PrettyPrint do
+
+  let (:it) { Klipbook::Commands::PrettyPrint.new(books, pretty_printer) }
+
+  let (:pretty_printer) do
+    Object.new.tap do |fake_printer|
+      stub(fake_printer).print_to_file
+    end
+  end
+
+  let (:message_stream) do
+    Object.new.tap do |fake_stream|
+      stub(fake_stream).puts
+    end
+  end
+
+  let (:book_one) { Klipbook::Book.new('book one') }
+  let (:book_two) { Klipbook::Book.new('book two') }
+  let (:books) { [ book_one, book_two ] }
+
+  let(:output_dir) { 'fake output dir' }
+
+  describe '#call' do
+
+    subject { it.call(output_dir, true, message_stream) }
+
+    it 'prints a message displaying the output directory' do
+      subject
+      message_stream.should have_received.puts('Using output directory: fake output dir')
+    end
+
+    it 'passes each book to the pretty printer' do
+      subject
+      pretty_printer.should have_received.print_to_file(book_one, output_dir, true)
+      pretty_printer.should have_received.print_to_file(book_two, output_dir, true)
+    end
+  end
+end

data/spec/lib/klipbook/{output/html_summary_writer_spec.rb → pretty_print/html_printer_spec.rb}

@@ -3,7 +3,7 @@ require 'spec_helper'
 # This is more of an integration test but what the heck
 # it can live in here for now
 
-describe Klipbook::Output::HtmlSummaryWriter do
+describe Klipbook::PrettyPrint::HtmlPrinter do
 
   before(:all) do
     @output_dir = Dir.mktmpdir
@@ -14,7 +14,7 @@ describe Klipbook::Output::HtmlSummaryWriter do
   end
 
   let(:book) do
-    Klipbook::Book.new do |b|
+    Klipbook::Book.new.tap do |b|
       b.title = 'Fake book title'
       b.author = 'Fake Author'
       b.clippings = []
@@ -27,9 +27,9 @@ describe Klipbook::Output::HtmlSummaryWriter do
     end
   end
 
-  describe '#write' do
+  describe '#print_to_file' do
 
-    subject { Klipbook::Output::HtmlSummaryWriter.new(message_stream).write(book, @output_dir, force) }
+    subject { Klipbook::PrettyPrint::HtmlPrinter.new(message_stream).print_to_file(book, @output_dir, force) }
 
     let(:force) { false }
 

data/spec/lib/klipbook/{fetcher_spec.rb → sources/book_source_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Klipbook::Fetcher do
+describe Klipbook::Sources::BookSource do
 
   let(:fake_source) do
     Object.new.tap do |fakey|
@@ -10,14 +10,14 @@ describe Klipbook::Fetcher do
 
   context 'when created with an invalid source' do
     it 'raises an error' do
-      expect { Klipbook::Fetcher.new('sdf' , 2) }.to raise_error(InvalidSourceError)
+      expect { Klipbook::Sources::BookSource.new('sdf' , 2) }.to raise_error(InvalidSourceError)
     end
   end
 
   context 'when created with a site source' do
-    subject { fetcher }
+    subject { book_source }
 
-    let(:fetcher) { Klipbook::Fetcher.new('site:username@example.com:password', 2) }
+    let(:book_source) { Klipbook::Sources::BookSource.new('site:username@example.com:password', 2) }
 
     before(:each) do
       stub(Klipbook::Sources::AmazonSite::SiteScraper).new { fake_source }
@@ -28,8 +28,8 @@ describe Klipbook::Fetcher do
       Klipbook::Sources::AmazonSite::SiteScraper.should have_received.new('username@example.com', 'password', 2)
     end
 
-    describe '#fetch_books' do
-      subject { fetcher.fetch_books }
+    describe '#books' do
+      subject { book_source.books }
 
       let(:books) { [] }
 
@@ -40,9 +40,9 @@ describe Klipbook::Fetcher do
   end
 
   context 'when created with a file source' do
-    subject { fetcher }
+    subject { book_source }
 
-    let(:fetcher) { Klipbook::Fetcher.new('file:filename', 2) }
+    let(:book_source) { Klipbook::Sources::BookSource.new('file:filename', 2) }
 
     let(:fake_file) do
       Object.new.tap do |file|
@@ -62,18 +62,18 @@ describe Klipbook::Fetcher do
       File.should have_received.open('filename', 'r')
     end
 
-    it 'uses the file contents to create a file source' do
+    pending 'uses the file contents to create a file source' do
       subject
 
       Klipbook::Sources::KindleDevice::File.should have_received.new('fake contents', 2)
     end
 
-    describe '#fetch_books' do
-      subject { fetcher.fetch_books }
+    describe '#books' do
+      subject { book_source.books }
 
       let(:books) { [] }
 
-      it 'returns the books returned by the file source' do
+      pending 'returns the books returned by the file source' do
         subject.should == books
       end
     end