klipbook 2.1.3 → 3.0.0

data/lib/klipbook/commands/list_books.rb

@@ -1,19 +0,0 @@
-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/tohtml.rb

@@ -1,17 +0,0 @@
-module Klipbook::Commands
-  class ToHtml
-    def initialize(books, pretty_printer=Klipbook::ToHtml::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/commands/tojson.rb

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

data/lib/klipbook/sources/invalid_source_error.rb

@@ -1,12 +0,0 @@
-class InvalidSourceError < RuntimeError
-
-  DEFAULT_MESSAGE = "Please provide a valid source.\n" +
-                    "e.g.\n" +
-                    "     file:path/to/my-clippings-file.txt\n" +
-                    "     site:my-kindle-user@blah.com:my-kindle-password"
-
-  def initialize(msg = DEFAULT_MESSAGE)
-    super
-  end
-end
-

data/lib/klipbook/tohtml/html_printer.rb

@@ -1,39 +0,0 @@
-require 'erb'
-
-module Klipbook::ToHtml
-  class HtmlPrinter
-    def initialize(message_stream=$stdout)
-      @message_stream = message_stream
-    end
-
-    def print_to_file(book, output_dir, force)
-      filename = filename_for_book(book)
-      filepath = File.join(output_dir, filename)
-
-      if !force && File.exists?(filepath)
-        @message_stream.puts(Colours.yellow("Skipping ") + filename)
-        return
-      end
-
-      @message_stream.puts(Colours.green("Writing ") + filename)
-      File.open(filepath, 'w') do |f|
-        f.write generate_html(book)
-      end
-    end
-
-    private
-
-    def filename_for_book(book)
-      "#{book.title_and_author}.html"
-    end
-
-    def generate_html(book)
-      ERB.new(template, 0, '%<>').result(book.get_binding)
-    end
-
-    def template
-      @template ||= File.read(File.join(File.dirname(__FILE__), 'html_book_summary.erb'))
-    end
-
-  end
-end

data/lib/klipbook/tojson/book_file.rb

@@ -1,58 +0,0 @@
-require 'json'
-
-module Klipbook::ToJson
-  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)
-          if force
-            replace_book(new_book, message_stream)
-          else
-            message_stream.puts Colours.yellow("Skipping: ") + "#{new_book.title_and_author}"
-          end
-        else
-          message_stream.puts Colours.green("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 Colours.green("Updating: ") + "#{new_book.title_and_author}"
-
-      old_book = find_book(new_book)
-      @books.delete(old_book)
-      @books.push(new_book)
-    end
-  end
-end

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

@@ -1,43 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Klipbook::Commands::ListBooks do
-
-  let (:output) do
-    double("output", puts: nil)
-  end
-
-  describe '#call' do
-
-    subject { Klipbook::Commands::ListBooks.new(books).call(output) }
-
-    context 'when created with no books' do
-
-      let (:books) { [] }
-
-      it 'displays a message saying that the clipping file contains no books' do
-        subject
-        expect(output).to have_received(:puts).with('No books available')
-      end
-    end
-
-    context 'when created with multiple books' do
-      let (:books) do
-        [
-          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
-
-      it 'displays a message describing the book list' do
-        subject
-        expect(output).to have_received(:puts).with('Book list:')
-      end
-
-      it 'displays an indexed list of book titles including the author when available' do
-        subject
-        expect(output).to have_received(:puts).with('[1] My first fake title')
-        expect(output).to have_received(:puts).with('[2] Another fake book by Rock Riphard')
-      end
-    end
-  end
-end

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

@@ -1,36 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Klipbook::Commands::ToHtml do
-
-  let (:it) { Klipbook::Commands::ToHtml.new(books, pretty_printer) }
-
-  let (:pretty_printer) do
-    double(print_to_file: nil)
-  end
-
-  let (:message_stream) do
-    double(puts: nil)
-  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
-      expect(message_stream).to have_received(:puts).with('Using output directory: fake output dir')
-    end
-
-    it 'passes each book to the pretty printer' do
-      subject
-      expect(pretty_printer).to have_received(:print_to_file).with(book_one, output_dir, true)
-      expect(pretty_printer).to have_received(:print_to_file).with(book_two, output_dir, true)
-    end
-  end
-end

data/spec/lib/klipbook/sources/book_spec.rb

@@ -1,33 +0,0 @@
-require 'spec_helper'
-
-RSpec.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.tap do |b|
-          b.title = 'Book title'
-        end
-      end
-
-      it 'only contains the title' do
-        expect(subject).to eq 'Book title'
-      end
-    end
-
-    context 'with an author' do
-      let(:book) do
-        Klipbook::Book.new.tap do |b|
-          b.title = 'Book title'
-          b.author = 'Rob Ripjaw'
-        end
-      end
-
-      it 'contains the title and author' do
-        expect(subject).to eq 'Book title by Rob Ripjaw'
-      end
-    end
-  end
-end

data/spec/lib/klipbook/sources/kindle_device/entry_parser_spec.rb

@@ -1,339 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Klipbook::Sources::KindleDevice::EntryParser do
-
-  describe '#build_entry' do
-    subject { Klipbook::Sources::KindleDevice::EntryParser.new.build_entry(entry_text) }
-
-    context 'passed an empty entry' do
-      let(:entry_text) { "  " }
-
-      it 'returns nil' do
-        expect(subject).to be_nil
-      end
-    end
-
-    context 'passed an incomplete entry' do
-      let(:entry_text) do
-        "Not long enough"
-      end
-
-      it 'returns nil' do
-        expect(subject).to be_nil
-      end
-    end
-
-    context 'passed an entry with the title line "Book title (Author\'s Name)"' do
-      let (:entry_text) do
-        "Book title (Author's Name)\n" +
-        "- Highlight Loc. 466-69  | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "Highlight text\n"
-      end
-
-      it 'extracts the title' do
-        expect(subject.title).to eq 'Book title'
-      end
-
-      it 'extracts the author' do
-        expect(subject.author).to eq "Author's Name"
-      end
-    end
-
-    context 'passed an entry with the title line "Book title (sub title) (Author\'s Name)"' do
-      let (:entry_text) do
-        "Book title (sub title) (Author's Name)\n" +
-        "- Highlight Loc. 466-69  | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "Highlight text\n"
-      end
-
-      it 'extracts the title containing parens' do
-        expect(subject.title).to eq 'Book title (sub title)'
-      end
-
-      it 'extracts the author' do
-        expect(subject.author).to eq "Author's Name"
-      end
-    end
-
-    context 'passed an entry with the title line "Book title"' do
-      let (:entry_text) do
-        "Book title\n" +
-        "- Highlight Loc. 466-69  | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "Highlight text\n"
-      end
-
-      it 'extracts the title' do
-        expect(subject.title).to eq 'Book title'
-      end
-
-      it 'sets author to nil' do
-        expect(subject.author).to be_nil
-      end
-    end
-
-    context 'passed an entry that is a highlight' do
-      let (:entry_text) do
-        "Book title\n" +
-        "- Highlight Loc. 466-69  | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "The first line of the highlight\n" +
-        "The second line of the highlight"
-      end
-
-      it 'returns a highlight' do
-        expect(subject.type).to eq :highlight
-      end
-
-      it 'extracts the highlighted text' do
-        expect(subject.text).to eq "The first line of the highlight\nThe second line of the highlight"
-      end
-    end
-
-    context 'passed an entry that is a 4th-generation highlight' do
-      let (:entry_text) do
-        "Book title\n" +
-        "- Your Highlight Location 466-69 | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "The first line of the highlight\n" +
-        "The second line of the highlight"
-      end
-
-      it 'returns a highlight' do
-        expect(subject.type).to eq :highlight
-      end
-
-      it 'extracts the highlighted text' do
-        expect(subject.text).to eq "The first line of the highlight\nThe second line of the highlight"
-      end
-    end
-
-    context 'passed an entry that is a note' do
-      let (:entry_text) do
-        "Book title\n" +
-        "- Note Loc. 623  | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "The note text"
-      end
-
-      it 'returns a note' do
-        expect(subject.type).to eq :note
-      end
-
-      it 'extracts the note text' do
-        expect(subject.text).to eq "The note text"
-      end
-    end
-
-    context 'passed an entry that is a 4th-generation note' do
-      let (:entry_text) do
-        "Book title\n" +
-        "- Your Note Location 623  | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "The note text"
-      end
-
-      it 'returns a note' do
-        expect(subject.type).to eq :note
-      end
-
-      it 'extracts the note text' do
-        expect(subject.text).to eq "The note text"
-      end
-    end
-
-    context 'passed an entry with a bookmark' do
-      let (:entry_text) do
-        "Book title\n" +
-        "- Bookmark on Page 1 | Loc. 406  | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "\n"
-      end
-
-      it 'returns a bookmark' do
-        expect(subject.type).to eq :bookmark
-      end
-
-      it 'extracts empty text' do
-        expect(subject.text).to eq ""
-      end
-    end
-
-    context 'passed an entry with a 4th-generation bookmark' do
-      let (:entry_text) do
-        "Book title\n" +
-        "- Your Bookmark on Page 1 | Location 406  | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "\n"
-      end
-
-      it 'returns a bookmark' do
-        expect(subject.type).to eq :bookmark
-      end
-
-      it 'extracts empty text' do
-        expect(subject.text).to eq ""
-      end
-    end
-
-    context 'passed an entry with a single location value' do
-      let (:entry_text) do
-        "Book title\n" +
-        "- Highlight Loc. 465 | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "The first line of the highlight\n" +
-        "The second line of the highlight"
-      end
-
-      it 'returns the correct location' do
-        expect(subject.location).to eq 465
-      end
-
-      it 'returns the correct added date' do
-        expect(subject.added_on).to eq DateTime.parse('Thursday, April 21, 2011, 07:31 AM')
-      end
-    end
-
-    context 'passed a 4th-generation entry with a single location value' do
-      let (:entry_text) do
-        "Book title\n" +
-        "- Your Highlight Location 465 | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "The first line of the highlight\n" +
-        "The second line of the highlight"
-      end
-
-      it 'returns the correct location' do
-        expect(subject.location).to eq 465
-      end
-
-      it 'returns the correct added date' do
-        expect(subject.added_on).to eq DateTime.parse('Thursday, April 21, 2011, 07:31 AM')
-      end
-    end
-
-    context 'passed an entry with a location range' do
-      let (:entry_text) do
-        "Book title\n" +
-        "- Highlight Loc. 466-69  | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "The first line of the highlight\n" +
-        "The second line of the highlight"
-      end
-
-      it 'extracts the first element of the location range' do
-        expect(subject.location).to eq 466
-      end
-
-      it 'returns the correct added date' do
-        expect(subject.added_on).to eq DateTime.parse('Thursday, April 21, 2011, 07:31 AM')
-      end
-    end
-
-    context 'passed a 4th-generation entry with a location range' do
-      let (:entry_text) do
-        "Book title\n" +
-        "- Your Highlight Location 466-69  | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "The first line of the highlight\n" +
-        "The second line of the highlight"
-      end
-
-      it 'extracts the first element of the location range' do
-        expect(subject.location).to eq 466
-      end
-
-      it 'returns the correct added date' do
-        expect(subject.added_on).to eq DateTime.parse('Thursday, April 21, 2011, 07:31 AM')
-      end
-    end
-
-    context 'passed an entry with a page number and location range' do
-      let (:entry_text) do
-        "Book title\n" +
-        "- Highlight on Page 171 | Loc. 1858-59  | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "Some highlighted text\n" +
-        "\n"
-      end
-
-      it 'extracts the first element of the location range' do
-        expect(subject.location).to eq 1858
-      end
-
-      it 'extracts the page number' do
-        expect(subject.page).to eq 171
-      end
-
-      it 'returns the correct added date' do
-        expect(subject.added_on).to eq DateTime.parse('Thursday, April 21, 2011, 07:31 AM')
-      end
-    end
-
-    context 'passed a 4th-generation entry with a page number and location range' do
-      let (:entry_text) do
-        "Book title\n" +
-        "- Your Highlight on Page 171 | Location 1858-59  | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "Some highlighted text\n" +
-        "\n"
-      end
-
-      it 'extracts the first element of the location range' do
-        expect(subject.location).to eq 1858
-      end
-
-      it 'extracts the page number' do
-        expect(subject.page).to eq 171
-      end
-
-      it 'returns the correct added date' do
-        expect(subject.added_on).to eq DateTime.parse('Thursday, April 21, 2011, 07:31 AM')
-      end
-    end
-
-    context 'passed an entry with a page number and no location' do
-      let (:entry_text) do
-        "Book title\n" +
-        "- Highlight on Page 9 | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "Clipping"
-      end
-
-      it 'sets location to 0' do
-        expect(subject.location).to eq 0
-      end
-
-      it 'extracts the page number' do
-        expect(subject.page).to eq 9
-      end
-
-      it 'returns the correct added date' do
-        expect(subject.added_on).to eq DateTime.parse('Thursday, April 21, 2011, 07:31 AM')
-      end
-    end
-
-    context 'passed a 4th-generation entry with a page number and no location' do
-      let (:entry_text) do
-        "Book title\n" +
-        "- Your Highlight on Page 9 | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "Clipping"
-      end
-
-      it 'sets location to 0' do
-        expect(subject.location).to eq 0
-      end
-
-      it 'extracts the page number' do
-        expect(subject.page).to eq 9
-      end
-
-      it 'returns the correct added date' do
-        expect(subject.added_on).to eq DateTime.parse('Thursday, April 21, 2011, 07:31 AM')
-      end
-    end
-  end
-end

data/spec/lib/klipbook/sources/kindle_device/file_parser_spec.rb

@@ -1,68 +0,0 @@
-# encoding: UTF-8
-
-require 'spec_helper'
-
-RSpec.describe Klipbook::Sources::KindleDevice::FileParser do
-
-  let(:parser) { Klipbook::Sources::KindleDevice::FileParser.new(entry_parser) }
-
-  let(:entry_parser) do
-    double('parser', build_entry: nil)
-  end
-
-  describe '#extract_entries' do
-    subject { parser.extract_entries(raw_text) }
-
-    context 'called with empty text' do
-
-      let(:raw_text) { '' }
-
-      it 'return an empty set of entries' do
-        expect(subject).to be_empty
-      end
-    end
-
-    context 'called with text containing two entries' do
-      let(:raw_text) do
-        " entry one" +
-        "==========" +
-        " entry two" +
-        "=========="
-      end
-
-      it 'builds two entries with the entries parser and returns them' do
-        entry_one = Object.new
-        entry_two = Object.new
-
-        allow(entry_parser).to receive(:build_entry).with(' entry one') { entry_one }
-        allow(entry_parser).to receive(:build_entry).with(' entry two') { entry_two }
-
-        expect(subject).to eq [ entry_one, entry_two ]
-      end
-    end
-
-    context 'called with text containing carriage return characters' do
-      let(:raw_text) do
-        "Example \r text\r" +
-        "=========="
-      end
-
-      it 'strips carriage returns before calling the entry parser' do
-        subject
-        expect(entry_parser).to have_received(:build_entry).with('Example  text')
-      end
-    end
-
-    context 'called with text containing control characters' do
-      let(:raw_text) do
-        "Example \xef\xbb\xbf text\xef\xbb\xbf" +
-        "=========="
-      end
-
-      it 'strips control characters before calling the entry parser' do
-        subject
-        expect(entry_parser).to have_received(:build_entry).with('Example  text')
-      end
-    end
-  end
-end