klipbook 0.3.0 → 1.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: klipbook
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-29 00:00:00.000000000 Z
+date: 2012-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: thor
-  requirement: &70207424507480 !ruby/object:Gem::Requirement
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,47 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70207424507480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70207424506920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +69,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70207424506920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70207424506400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +85,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70207424506400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70207424505840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +101,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70207424505840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70207424505300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +117,15 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70207424505300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70207424504540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,21 +133,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70207424504540
-- !ruby/object:Gem::Dependency
-  name: cucumber
-  requirement: &70207424502720 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70207424502720
 - !ruby/object:Gem::Dependency
-  name: guard
-  requirement: &70207424500680 !ruby/object:Gem::Requirement
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +149,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70207424500680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: &70207424499260 !ruby/object:Gem::Requirement
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +165,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70207424499260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-cucumber
-  requirement: &70207424498260 !ruby/object:Gem::Requirement
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +181,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70207424498260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rb-inotify
-  requirement: &70207424497200 !ruby/object:Gem::Requirement
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +197,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70207424497200
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rb-fsevent
-  requirement: &70207424494680 !ruby/object:Gem::Requirement
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +213,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70207424494680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rb-fchange
-  requirement: &70207424492080 !ruby/object:Gem::Requirement
+  name: guard-cucumber
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +229,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70207424492080
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: growl_notify
-  requirement: &70207424489100 !ruby/object:Gem::Requirement
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,7 +245,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70207424489100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Process your Kindle clippings file to generate a nicely formatted compilation
   of the clippings of the books you've read
 email: ray.grasso@gmail.com
@@ -186,26 +272,40 @@ files:
 - Rakefile
 - bin/klipbook
 - example.png
-- features/list_books.feature
-- features/print_book_summary.feature
-- features/step_definitions/klipbook_steps.rb
+- features/collate.feature
+- features/fixtures/clippings-for-three-books.txt
+- features/list.feature
+- features/step_definitions/collate_steps.rb
+- features/step_definitions/list_steps.rb
 - features/support/env.rb
 - klipbook.gemspec
 - lib/klipbook.rb
 - lib/klipbook/blank.rb
-- lib/klipbook/book_summary.erb
-- lib/klipbook/book_summary.rb
-- lib/klipbook/cli.rb
+- lib/klipbook/book.rb
 - lib/klipbook/clipping.rb
-- lib/klipbook/clippings_file.rb
-- lib/klipbook/clippings_parser.rb
-- lib/klipbook/runner.rb
+- lib/klipbook/collator.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/sources/amazon_site/book_scraper.rb
+- lib/klipbook/sources/amazon_site/scraper.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/version.rb
-- spec/lib/klipbook/book_summary_spec.rb
-- spec/lib/klipbook/clipping_spec.rb
-- spec/lib/klipbook/clippings_file_spec.rb
-- spec/lib/klipbook/clippings_parser_spec.rb
-- spec/lib/klipbook/runner_spec.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/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
 - spec/spec_helper.rb
 - spec/support/rspec2.rb
 - spec/support/with_rr.rb
@@ -224,7 +324,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3834565430235223789
+      hash: -434895124641263041
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -233,7 +333,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Klipbook creates a nice html summary of the clippings you've created on your

data/features/list_books.feature

@@ -1,23 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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

@@ -1,87 +0,0 @@
-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/lib/klipbook/book_summary.rb

@@ -1,35 +0,0 @@
-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(options={})
-      include_pages = options[:include_pages]
-      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

@@ -1,49 +0,0 @@
-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'
-    method_option :include_pages, :aliases => '-p', :desc => 'Include page numbers in output when available'
-    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'), options)
-    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/clippings_file.rb

@@ -1,50 +0,0 @@
-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
-
-