klipbook 0.3.0 → 1.0.0

data/lib/klipbook/clippings_parser.rb

@@ -1,98 +0,0 @@
-# encoding: UTF-8
-
-module Klipbook
-  class ClippingsParser
-    def extract_clippings_from(file_text)
-      clippings_text_from(file_text).map { |clipping_text| build_clipping_from(clipping_text) }.compact
-    end
-
-    def build_clipping_from(clipping_text)
-      return nil if clipping_text.blank?
-
-      attributes = extract_attributes(clipping_text)
-
-      Clipping.new(attributes)
-    end
-
-    def extract_attributes(clipping_text)
-
-      lines = clipping_text.lstrip.lines.to_a
-
-      return nil if lines.length < 2
-
-      title_line = lines[0].strip
-      metadata = lines[1].strip
-      text_lines = lines[3..-1]
-
-      return nil unless valid_metadata?(metadata)
-
-      {
-        title:    extract_title(title_line),
-        author:   extract_author(title_line),
-        type:     extract_type(metadata),
-        location: extract_location(metadata),
-        page:     extract_page(metadata),
-        added_on: extract_added_date(metadata),
-        text:     extract_text(text_lines)
-      }
-    end
-
-    def strip_control_characters(file_text)
-      file_text.gsub("\r", '').gsub("\xef\xbb\xbf", '')
-    end
-
-  private
-
-    def clippings_text_from(file_text)
-      strip_control_characters(file_text).split('==========')
-    end
-
-    def valid_metadata?(metadata)
-      metadata.match(/^-.*Added on/)
-    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_added_date(metadata)
-      metadata.scan(/Added on (.+)$/i).first.first
-    end
-
-    def extract_location(metadata)
-      match = metadata.scan(/Loc(ation|\.) ([0-9]+-?)/)
-
-      return nil 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_text(text_lines)
-      text_lines.join('').rstrip
-    end
-  end
-end

data/lib/klipbook/runner.rb

@@ -1,29 +0,0 @@
-module Klipbook
-  class Runner
-    def initialize(input_file)
-      @clippings_file = Klipbook::ClippingsFile.new(input_file.read.strip)
-    end
-
-    def list_books(output=$stdout)
-      if @clippings_file.books.empty?
-        output.puts 'Your clippings file contains no books'
-      else
-        output.puts 'The list of books in your clippings file:'
-        @clippings_file.books.each_with_index do |book, index|
-          author = book.author ? " by #{book.author}" : ''
-          output.puts "[#{index + 1}] #{book.title}#{author}"
-        end
-      end
-    end
-
-    def print_book_summary(book_number, output, options={})
-      if book_number < 1 or book_number > @clippings_file.books.length
-        $stderr.puts "Sorry but you must specify a book index between 1 and #{@clippings_file.books.length}"
-        return
-      end
-
-      book_summary = @clippings_file.books[book_number - 1]
-      output.write book_summary.as_html(options)
-    end
-  end
-end

data/spec/lib/klipbook/book_summary_spec.rb

@@ -1,30 +0,0 @@
-require 'spec_helper'
-
-describe Klipbook::BookSummary do
-  describe '#clippings' do
-    subject { Klipbook::BookSummary.new('fake title', 'fake author', clippings).clippings }
-
-    let(:first_clipping) { FakeClipping.new(order: 10) }
-    let(:second_clipping) { FakeClipping.new(order: 22) }
-    let(:third_clipping) { FakeClipping.new(order: 200) }
-
-    let(:clippings) do
-      [
-        third_clipping,
-        second_clipping,
-        first_clipping
-      ]
-    end
-
-    it 'provides clippings in sorted order' do
-      subject.should == [ first_clipping, second_clipping, third_clipping ]
-    end
-  end
-
-  # A fake clipping that will naturally sort even if the order attribute isn't set
-  class FakeClipping < OpenStruct
-    def <=>(other)
-      self.order <=> other.order
-    end
-  end
-end

data/spec/lib/klipbook/clipping_spec.rb

@@ -1,17 +0,0 @@
-require 'spec_helper'
-
-describe Klipbook::Clipping do
-  it 'treats the added_on attribute as a date when created' do
-    clipping = Klipbook::Clipping.new(added_on: "Sunday, December 4, 2011, 07:33 AM")
-    clipping.added_on.should == DateTime.new(2011,12,4,7,33)
-  end
-
-  it 'sort based upon location, treating nils as 0' do
-    first_clipping = Klipbook::Clipping.new(location: nil)
-    second_clipping = Klipbook::Clipping.new(location: 23)
-    third_clipping = Klipbook::Clipping.new(location: 345)
-
-    sorted_clippings = [second_clipping, third_clipping, first_clipping].sort
-    sorted_clippings.should  == [ first_clipping, second_clipping, third_clipping ]
-  end
-end

data/spec/lib/klipbook/clippings_file_spec.rb

@@ -1,60 +0,0 @@
-require 'spec_helper'
-require 'ostruct'
-
-describe Klipbook::ClippingsFile do
-
-  let(:clippings_file) { Klipbook::ClippingsFile.new('', parser) }
-
-  let (:parser) do
-    fake_parser = Object.new
-    stub(fake_parser).extract_clippings_from { clippings }
-    fake_parser
-  end
-
-  describe '#books' do
-    subject { clippings_file.books }
-
-    context 'with an empty clippings file' do
-      let(:clippings) { [] }
-
-      it { should be_empty }
-    end
-
-    context 'with a single clipping for a single book' do
-      let(:clippings) do
-        [ OpenStruct.new(title: 'First fake book title') ]
-      end
-
-      it 'contains an entry for the book' do
-        subject.map(&:title).should == [ 'First fake book title' ]
-      end
-    end
-
-    context 'with clippings for two books' do
-      let(:clippings) do
-        [
-          OpenStruct.new(title: 'Second fake book title'),
-          OpenStruct.new(title: 'First fake book title')
-        ]
-      end
-
-      it 'contains entries for the two books in alphabetical order' do
-        subject.map(&:title).should == [ 'First fake book title', 'Second fake book title' ]
-      end
-    end
-
-    context 'with multiple clippings for two books' do
-      let(:clippings) do
-        [
-          OpenStruct.new(title: 'First fake book title'),
-          OpenStruct.new(title: 'Second fake book title'),
-          OpenStruct.new(title: 'First fake book title')
-        ]
-      end
-
-      it 'contains entries for the two books in alphabetical order' do
-        subject.map(&:title).should == [ 'First fake book title', 'Second fake book title' ]
-      end
-    end
-  end
-end

data/spec/lib/klipbook/clippings_parser_spec.rb

@@ -1,367 +0,0 @@
-# encoding: UTF-8
-
-require 'spec_helper'
-
-describe Klipbook::ClippingsParser do
-
-  describe '#extract_attributes' do
-
-    subject { Klipbook::ClippingsParser.new.extract_attributes(content) }
-
-    context 'on a clipping with the title line "Book title (Author\'s Name)"' do
-      let (:content) 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 as "Book title"' do
-        subject[:title].should == 'Book title'
-      end
-
-      it 'extracts the author as "Author\'s Name"' do
-        subject[:author].should == "Author's Name"
-      end
-    end
-
-    context 'on a clipping with the title line "Book title (sub title) (Author\'s Name)"' do
-      let (:content) 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 as "Book title (sub title)"' do
-        subject[:title].should == 'Book title (sub title)'
-      end
-
-      it 'extracts the author "Author\'s Name"' do
-        subject[:author].should == "Author's Name"
-      end
-    end
-
-    context 'on a clipping with the title line "Book title"' do
-      let (:content) 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 as "Book title"' do
-        subject[:title].should == 'Book title'
-      end
-
-      it 'extracts no author' do
-        subject[:author].should be_nil
-      end
-    end
-
-    context 'on a highlight' do
-      let (:content) 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 'marks the clipping as a highlight' do
-        subject[:type].should == :highlight
-      end
-
-      it 'extracts the highlighted text' do
-        subject[:text].should == "The first line of the highlight\nThe second line of the highlight"
-      end
-    end
-
-    context 'on a 4th-generation highlight' do
-      let (:content) 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 'marks the clipping as a highlight' do
-        subject[:type].should == :highlight
-      end
-
-      it 'extracts the highlighted text' do
-        subject[:text].should == "The first line of the highlight\nThe second line of the highlight"
-      end
-    end
-
-    context 'on a note' do
-      let (:content) do
-        "Book title\n" +
-        "- Note Loc. 623  | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "The note text"
-      end
-
-      it 'marks the clipping as a note' do
-        subject[:type].should == :note
-      end
-
-      it 'extracts the note text' do
-        subject[:text].should == "The note text"
-      end
-    end
-
-    context 'on a 4th-generation note' do
-      let (:content) do
-        "Book title\n" +
-        "- Your Note Location 623  | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "The note text"
-      end
-
-      it 'marks the clipping as a note' do
-        subject[:type].should == :note
-      end
-
-      it 'extracts the note text' do
-        subject[:text].should == "The note text"
-      end
-    end
-
-    context 'on a bookmark' do
-      let (:content) do
-        "Book title\n" +
-        "- Bookmark on Page 1 | Loc. 406  | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "\n"
-      end
-
-      it 'marks the clipping as a bookmark' do
-        subject[:type].should == :bookmark
-      end
-
-      it 'extracts empty text' do
-        subject[:text].should == ''
-      end
-    end
-
-    context 'on a 4th-generation bookmark' do
-      let (:content) 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 'marks the clipping as a bookmark' do
-        subject[:type].should == :bookmark
-      end
-
-      it 'extracts empty text' do
-        subject[:text].should == ''
-      end
-    end
-
-    context 'on a clipping with a single location value' do
-      let (:content) 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 'extracts the location' do
-        subject[:location].should == 465
-      end
-
-      it 'extracts the added_on date' do
-        subject[:added_on].should == 'Thursday, April 21, 2011, 07:31 AM'
-      end
-    end
-
-    context 'on a 4th-generation clipping with a single location value' do
-      let (:content) 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 'extracts the location' do
-        subject[:location].should == 465
-      end
-
-      it 'extracts the added_on date' do
-        subject[:added_on].should == 'Thursday, April 21, 2011, 07:31 AM'
-      end
-    end
-
-    context 'on a clipping with a location range' do
-      let (:content) 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
-        subject[:location].should == 466
-      end
-
-      it 'extracts the added_on date' do
-        subject[:added_on].should == 'Thursday, April 21, 2011, 07:31 AM'
-      end
-    end
-
-    context 'on a 4th-generation clipping with a location range' do
-      let (:content) 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
-        subject[:location].should == 466
-      end
-
-      it 'extracts the added_on date' do
-        subject[:added_on].should == 'Thursday, April 21, 2011, 07:31 AM'
-      end
-    end
-
-    context 'on a highlight with a page number and location range' do
-      let (:content) 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
-        subject[:location].should == 1858
-      end
-
-      it 'extracts the page number' do
-        subject[:page].should == 171
-      end
-
-      it 'extracts the date' do
-        subject[:added_on].should == 'Thursday, April 21, 2011, 07:31 AM'
-      end
-    end
-
-    context 'on a 4th-generation highlight with a page number and location range' do
-      let (:content) 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
-        subject[:location].should == 1858
-      end
-
-      it 'extracts the page number' do
-        subject[:page].should == 171
-      end
-
-      it 'extracts the date' do
-        subject[:added_on].should == 'Thursday, April 21, 2011, 07:31 AM'
-      end
-    end
-
-    context 'on a highlight with a page number and no location' do
-      let (:content) do
-        "Book title\n" +
-        "- Highlight on Page 9 | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "Clipping"
-      end
-
-      it 'extracts no location' do
-        subject[:location].should be_nil
-      end
-
-      it 'extracts the page number' do
-        subject[:page].should == 9
-      end
-
-      it 'extracts the date' do
-        subject[:added_on].should == 'Thursday, April 21, 2011, 07:31 AM'
-      end
-    end
-
-    context 'on a 4th-generation highlight with a page number and no location' do
-      let (:content) do
-        "Book title\n" +
-        "- Your Highlight on Page 9 | Added on Thursday, April 21, 2011, 07:31 AM\n" +
-        "\n" +
-        "Clipping"
-      end
-
-      it 'extracts no location' do
-        subject[:location].should be_nil
-      end
-
-      it 'extracts the page number' do
-        subject[:page].should == 9
-      end
-
-      it 'extracts the date' do
-        subject[:added_on].should == 'Thursday, April 21, 2011, 07:31 AM'
-      end
-    end
-  end
-
-  describe '#build_clipping_from' do
-
-    let(:it) { Klipbook::ClippingsParser.new }
-
-    context 'with an empty string' do
-      subject { it.build_clipping_from("  ") }
-
-      it { should be_nil }
-    end
-
-    it 'builds a clipping using the extracted attributes' do
-      attributes = {
-        title:    'Dummy title',
-        type:     :highlight,
-        location: 42,
-        added_on: '10 August 2011',
-        text:     'Some highlighted text'
-      }
-      stub(it).extract_attributes { attributes }
-      stub(Klipbook::Clipping).new
-
-      it.build_clipping_from('Dummy content')
-
-      Klipbook::Clipping.should have_received.new.with(attributes)
-    end
-  end
-
-  describe "#strip_control_characters" do
-    let(:it) { Klipbook::ClippingsParser.new }
-
-    it "removes all carriage return characters" do
-      processed_text = it.strip_control_characters("An example \r clippings text\r")
-      processed_text.should_not include("\r")
-    end
-
-    it "removes all Unicode byte order marks" do
-      processed_text = it.strip_control_characters("An example \xef\xbb\xbf clippings text\xef\xbb\xbf")
-      processed_text.should_not include("\xef\xbb\xbf")
-    end
-  end
-end
-
-

data/spec/lib/klipbook/runner_spec.rb

@@ -1,87 +0,0 @@
-require 'spec_helper'
-
-describe Klipbook::Runner do
-
-  let (:input_file) do
-    input_file = Object.new
-    stub(input_file).read { '' }
-    input_file
-  end
-
-  let (:output) do
-    output = Object.new
-    stub(output).puts
-    output
-  end
-
-  let (:clippings_file) do
-    clipplings = Object.new
-    stub(clipplings).books { books }
-    clipplings
-  end
-
-  before :each do
-    stub(Klipbook::ClippingsFile).new { clippings_file }
-  end
-
-  describe '#list_books' do
-
-    subject { Klipbook::Runner.new(input_file).list_books(output) }
-
-    context 'with an empty clippings file' do
-
-      let (:books) { [] }
-
-      it 'displays a message saying that the clipping file contains no books' do
-        subject
-        output.should have_received.puts('Your clippings file contains no books')
-      end
-    end
-
-    context 'with a clipping file with multiple books' do
-      let (:books) do
-        [ OpenStruct.new(title: 'My first fake title'), OpenStruct.new(title: 'Another fake book', author: 'Rock Riphard') ]
-      end
-
-      it 'displays a message describing the book list' do
-        subject
-        output.should have_received.puts('The list of books in your clippings file:')
-      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
-
-  describe '#print_book_summary' do
-
-    describe 'with a clipping files with two books' do
-      let (:book_two) do
-        book_two = Object.new
-      end
-
-      let (:books) do
-        [ OpenStruct.new(title: 'My first fake title'), book_two ]
-      end
-
-      [0, 3].each do |book_number|
-        it "displays an error message if the book index requested is #{book_number}" do
-          stub($stderr).puts
-          Klipbook::Runner.new(input_file).print_book_summary(book_number, output)
-          $stderr.should have_received.puts('Sorry but you must specify a book index between 1 and 2')
-        end
-      end
-
-      it 'outputs the html summary of the book selected' do
-        mock_html_output = Object.new
-        stub(output).write
-        stub(book_two).as_html { mock_html_output }
-        Klipbook::Runner.new(input_file).print_book_summary(2, output)
-        output.should have_received.write(mock_html_output)
-      end
-    end
-  end
-end