klipbook 0.3.0 → 1.0.0

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

@@ -0,0 +1,85 @@
+module Klipbook::Sources
+  module KindleDevice
+    class EntryParser
+
+      def build_entry(entry_text)
+        return nil if invalid_entry?(entry_text)
+
+        lines = split_text_into_lines(entry_text)
+        title_line = lines[0].strip
+        metadata = lines[1].strip
+        text_lines = lines[3..-1]
+
+        type = extract_type(metadata)
+
+        Klipbook::Sources::KindleDevice::Entry.new do |h|
+          h.title = extract_title(title_line)
+          h.author = extract_author(title_line)
+          h.location = extract_location(metadata)
+          h.page = extract_page(metadata)
+          h.added_on = extract_added_date(metadata)
+          h.text = extract_content(text_lines)
+          h.type = extract_type(metadata)
+        end
+      end
+
+    private
+
+      def invalid_entry?(entry_text)
+        entry_text.blank? || incomplete_entry?(entry_text)
+      end
+
+      def incomplete_entry?(entry_text)
+        split_text_into_lines(entry_text).length < 2
+      end
+
+      def split_text_into_lines(entry_text)
+        entry_text.lstrip.lines.to_a
+      end
+
+      def extract_title(title_line)
+        if title_line =~ /\(.+\)\Z/
+          title_line.scan(/(.*)\s+\(.+\)\Z/).first.first
+        else
+          title_line
+        end
+      end
+
+      def extract_author(title_line)
+        match = title_line.scan /\(([^\(]+)\)\Z/
+        match.empty? ? nil : match.first.first
+      end
+
+      def extract_type(metadata)
+        type = metadata.scan(/^-( Your)? (\w+)/).first[1]
+        type.downcase.to_sym
+      end
+
+      def extract_location(metadata)
+        match = metadata.scan(/Loc(ation|\.) ([0-9]+-?)/)
+
+        return 0 if match.empty?
+
+        location = match.first[1]
+        location.to_i
+      end
+
+      def extract_page(metadata)
+        match = metadata.scan(/Page (\d+)/)
+
+        return nil if match.empty?
+
+        location = match.first.first
+        location.to_i
+      end
+
+      def extract_content(text_lines)
+        text_lines.join('').rstrip
+      end
+
+      def extract_added_date(metadata)
+        DateTime.parse(metadata.scan(/Added on (.+)$/i).first.first)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+module Klipbook::Sources
+  module KindleDevice
+    class File
+      def initialize(file_text, max_books, file_parser=FileParser.new)
+        @file_text = file_text
+        @file_parser = file_parser
+        @max_books = max_books
+      end
+
+      def books
+        @books ||= build_books.take(@max_books)
+      end
+
+    private
+
+      def build_books
+        sorted_entries = extract_sorted_entries_from_file_text
+        build_sorted_book_list(sorted_entries)
+      end
+
+      def extract_sorted_entries_from_file_text
+        entries = @file_parser.extract_entries(@file_text)
+        entries.sort { |entry_a, entry_b| entry_a.title <=> entry_b.title }
+      end
+
+      def build_sorted_book_list(sorted_entries)
+        books_from_entries(sorted_entries).sort do |book_a, book_b|
+          -(book_a.last_update <=> book_b.last_update)
+        end
+      end
+
+      def books_from_entries(entries)
+        entries.select { |entry| entry.type != :bookmark }
+               .group_by(&:title)
+               .map { |title, book_entries| book_from_entries(book_entries) }
+      end
+
+      def book_from_entries(entries)
+        entries.sort! { |ea, eb| ea.location <=> eb.location }
+
+        Klipbook::Book.new 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|
+              c.location = e.location
+              c.page = e.page
+              c.text = e.text
+              c.type = e.type
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+
+module Klipbook::Sources
+  module KindleDevice
+    class FileParser
+      def initialize(entry_parser=EntryParser.new)
+        @entry_parser = entry_parser
+      end
+
+      def extract_entries(file_text)
+        entries_text = split_into_raw_entries_text(file_text)
+
+        build_entries(entries_text)
+      end
+
+    private
+
+      def build_entries(entries_text)
+        entries_text.map do |entry_text|
+          @entry_parser.build_entry(entry_text)
+        end.compact
+      end
+
+      def strip_control_characters(file_text)
+        file_text.gsub("\r", '').gsub("\xef\xbb\xbf", '')
+      end
+
+      def split_into_raw_entries_text(file_text)
+        strip_control_characters(file_text).split('==========')
+      end
+    end
+  end
+end

data/lib/klipbook/version.rb

@@ -1,3 +1,3 @@
 module Klipbook
-  VERSION = '0.3.0'
+  VERSION = '1.0.0'
 end

data/lib/klipbook.rb

@@ -1,10 +1,23 @@
 # encoding: utf-8
 require 'klipbook/blank'
 require 'klipbook/version'
-require 'klipbook/clippings_file'
+
+require 'klipbook/sources/kindle_device/file_parser'
+require 'klipbook/sources/kindle_device/entry_parser'
+require 'klipbook/sources/kindle_device/entry'
+require 'klipbook/sources/kindle_device/file'
+
+require 'klipbook/sources/amazon_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/clippings_parser'
-require 'klipbook/book_summary'
-require 'klipbook/runner'
-require 'klipbook/cli'
 
+require 'klipbook/fetcher'
+require 'klipbook/collator'
+require 'klipbook/printer'
+
+require 'klipbook/output/html_summary_writer'
+require 'klipbook/output/book_helpers'

data/spec/lib/klipbook/book_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Klipbook::Book do
+  describe '#title_and_author' do
+
+    subject { book.title_and_author }
+
+    context 'with no author' do
+      let(:book) do
+        Klipbook::Book.new do |b|
+          b.title = 'Book title'
+        end
+      end
+
+      it 'only contains the title' do
+        subject.should == 'Book title'
+      end
+    end
+
+    context 'with an author' do
+      let(:book) do
+        Klipbook::Book.new do |b|
+          b.title = 'Book title'
+          b.author = 'Rob Ripjaw'
+        end
+      end
+
+      it 'contains the title and author' do
+        subject.should == 'Book title by Rob Ripjaw'
+      end
+    end
+  end
+end

data/spec/lib/klipbook/collator_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Klipbook::Collator do
+
+  let (:it) { Klipbook::Collator.new(books, summary_writer) }
+
+  let (:summary_writer) do
+    Object.new.tap do |fake_writer|
+      stub(fake_writer).write
+    end
+  end
+
+  let (:message_stream) do
+    Object.new.tap do |fake_stream|
+      stub(fake_stream).puts
+    end
+  end
+
+  let (:book_one) { Klipbook::Book.new }
+  let (:book_two) { Klipbook::Book.new }
+  let (:books) { [ book_one, book_two ] }
+
+  let(:output_dir) { 'fake output dir' }
+
+  describe '#collate_books' do
+
+    subject { it.collate_books(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 summary writer' do
+      subject
+      summary_writer.should have_received.write(book_one, output_dir, true)
+      summary_writer.should have_received.write(book_two, output_dir, true)
+    end
+  end
+end

data/spec/lib/klipbook/fetcher_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe Klipbook::Fetcher do
+
+  let(:fake_source) do
+    Object.new.tap do |fakey|
+      stub(fakey).books { books }
+    end
+  end
+
+  context 'when created with an invalid source' do
+    it 'raises an error' do
+      expect { Klipbook::Fetcher.new('sdf' , 2) }.to raise_error(InvalidSourceError)
+    end
+  end
+
+  context 'when created with a site source' do
+    subject { fetcher }
+
+    let(:fetcher) { Klipbook::Fetcher.new('site:username@example.com:password', 2) }
+
+    before(:each) do
+      stub(Klipbook::Sources::AmazonSite::Scraper).new { fake_source }
+    end
+
+    it 'creates a site scraper with the provided credentials' do
+      subject
+      Klipbook::Sources::AmazonSite::Scraper.should have_received.new('username@example.com', 'password', 2)
+    end
+
+    describe '#fetch_books' do
+      subject { fetcher.fetch_books }
+
+      let(:books) { [] }
+
+      it 'returns the books returned by the site source' do
+        subject.should == books
+      end
+    end
+  end
+
+  context 'when created with a file source' do
+    subject { fetcher }
+
+    let(:fetcher) { Klipbook::Fetcher.new('file:filename', 2) }
+
+    let(:fake_file) do
+      Object.new.tap do |file|
+        stub(file).read { file_contents }
+      end
+    end
+
+    let(:file_contents) { 'fake contents ' }
+
+    before(:each) do
+      stub(Klipbook::Sources::KindleDevice::File).new { fake_source }
+      stub(File).open { fake_file }
+    end
+
+    it "reads the file's contents from disk" do
+      subject
+      File.should have_received.open('filename', 'r')
+    end
+
+    it '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 }
+
+      let(:books) { [] }
+
+      it 'returns the books returned by the file source' do
+        subject.should == books
+      end
+    end
+  end
+end

data/spec/lib/klipbook/output/html_summary_writer_spec.rb

@@ -0,0 +1,90 @@
+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
+
+  before(:all) do
+    @output_dir = Dir.mktmpdir
+  end
+
+  after(:all) do
+    FileUtils.rm_f(@output_dir)
+  end
+
+  let(:book) do
+    Klipbook::Book.new do |b|
+      b.title = 'Fake book title'
+      b.author = 'Fake Author'
+      b.clippings = []
+    end
+  end
+
+  let(:message_stream) do
+    Object.new.tap do |fake_stream|
+      stub(fake_stream).puts
+    end
+  end
+
+  describe '#write' do
+
+    subject { Klipbook::Output::HtmlSummaryWriter.new(message_stream).write(book, @output_dir, force) }
+
+    let(:force) { false }
+
+    let(:expected_filename) { "Fake book title by Fake Author.html" }
+    let(:expected_filepath) { "#{@output_dir}/Fake book title by Fake Author.html" }
+
+    context 'with no existing summary file' do
+      before(:each) do
+        FileUtils.rm_f(File.join(@output_dir, '*'))
+      end
+
+      it 'writes a file named after the book into the output directory' do
+        subject
+        File.exists?(expected_filepath).should be_true
+      end
+
+      it 'writes a html summary to the file' do
+        subject
+        File.read(expected_filepath).should include("<h1>Fake book title</h1>")
+      end
+    end
+
+    context 'with an existing summary file' do
+      before(:each) do
+        FileUtils.rm_f(expected_filepath)
+        FileUtils.touch(expected_filepath)
+      end
+
+      context "and 'force' set to false" do
+        let(:force) { false }
+
+        it "won't write to the file" do
+          subject
+          File.size(expected_filepath).should == 0
+        end
+
+        it 'prints a message informing that the file is being skipped' do
+          subject
+          message_stream.should have_received.puts("\e[33mSkipping \e[0m#{expected_filename}")
+        end
+      end
+
+      context "and 'force' set to true" do
+        let(:force) { true }
+
+        it 'overwrites the file' do
+          subject
+          File.size(expected_filepath).should > 0
+        end
+
+        it 'prints a message informing that the file is being written' do
+          subject
+          message_stream.should have_received.puts("\e[32mWriting \e[0m#{expected_filename}")
+        end
+      end
+    end
+  end
+end

data/spec/lib/klipbook/printer_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Klipbook::Printer do
+
+  let (:output) do
+    Object.new.tap do |fake_output|
+      stub(fake_output).puts
+    end
+  end
+
+  describe '#print' do
+
+    subject { Klipbook::Printer.new(books).print(output) }
+
+    context 'when created with no books' do
+
+      let (:books) { [] }
+
+      it 'displays a message saying that the clipping file contains no books' do
+        subject
+        output.should have_received.puts('No books available')
+      end
+    end
+
+    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' }
+        ]
+      end
+
+      it 'displays a message describing the book list' do
+        subject
+        output.should have_received.puts('Book list:')
+      end
+
+      it 'displays an indexed list of book titles including the author when available' do
+        subject
+        output.should have_received.puts('[1] My first fake title')
+        output.should have_received.puts('[2] Another fake book by Rock Riphard')
+      end
+    end
+  end
+end