klipbook 0.2.1 → 0.3.0

data/klipbook.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "klipbook"
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ray Grasso"]
-  s.date = "2011-12-27"
+  s.date = "2011-12-29"
   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"]

data/lib/klipbook/book_summary.erb

@@ -83,7 +83,11 @@
           <p>
             <%= ERB::Util.html_escape(clipping.text) %>
           </p>
-          <footer><%= clipping.type %><% if clipping.location %> @ loc <%= clipping.location %><% end %></footer>
+          <footer>
+            <%= clipping.type %>
+            <% if include_pages && clipping.page %> on page <%= clipping.page %><% end %>
+            <% if clipping.location %> @ loc <%= clipping.location %><% end %>
+          </footer>
         </li>
         <% end %>
       <% end %>

data/lib/klipbook/book_summary.rb

@@ -23,7 +23,8 @@ module Klipbook
       title == other.title && author == other.author
     end
 
-    def as_html
+    def as_html(options={})
+      include_pages = options[:include_pages]
       ERB.new(template, 0, '%<>').result(binding)
     end
 

data/lib/klipbook/cli.rb

@@ -16,6 +16,7 @@ module Klipbook
     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'
@@ -26,7 +27,7 @@ module Klipbook
 
       book_number = book_number.to_i
 
-      Klipbook::Runner.new(clippings_file).print_book_summary(book_number, File.open(output_file, 'w'))
+      Klipbook::Runner.new(clippings_file).print_book_summary(book_number, File.open(output_file, 'w'), options)
     end
 
     map '-v' => :version

data/lib/klipbook/clippings_parser.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 module Klipbook
   class ClippingsParser
     def extract_clippings_from(file_text)
@@ -29,15 +31,20 @@ module Klipbook
         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)
-      file_text.gsub("\r", '').split('==========')
+      strip_control_characters(file_text).split('==========')
     end
 
     def valid_metadata?(metadata)
@@ -75,6 +82,15 @@ module Klipbook
       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

data/lib/klipbook/runner.rb

@@ -16,14 +16,14 @@ module Klipbook
       end
     end
 
-    def print_book_summary(book_number, output)
+    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
+      output.write book_summary.as_html(options)
     end
   end
 end

data/lib/klipbook/version.rb

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

data/spec/lib/klipbook/clippings_parser_spec.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'spec_helper'
 
 describe Klipbook::ClippingsParser do
@@ -246,6 +248,10 @@ describe Klipbook::ClippingsParser 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
@@ -264,6 +270,10 @@ describe Klipbook::ClippingsParser 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
@@ -281,6 +291,10 @@ describe Klipbook::ClippingsParser 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
@@ -298,6 +312,10 @@ describe Klipbook::ClippingsParser 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
@@ -330,6 +348,20 @@ describe Klipbook::ClippingsParser do
       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
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: klipbook
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-27 00:00:00.000000000 Z
+date: 2011-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70138331394120 !ruby/object:Gem::Requirement
+  requirement: &70207424507480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70138331394120
+  version_requirements: *70207424507480
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70138331393620 !ruby/object:Gem::Requirement
+  requirement: &70207424506920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70138331393620
+  version_requirements: *70207424506920
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70138331392640 !ruby/object:Gem::Requirement
+  requirement: &70207424506400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70138331392640
+  version_requirements: *70207424506400
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70138331391540 !ruby/object:Gem::Requirement
+  requirement: &70207424505840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70138331391540
+  version_requirements: *70207424505840
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70138331390420 !ruby/object:Gem::Requirement
+  requirement: &70207424505300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70138331390420
+  version_requirements: *70207424505300
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70138331389020 !ruby/object:Gem::Requirement
+  requirement: &70207424504540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70138331389020
+  version_requirements: *70207424504540
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70138331387100 !ruby/object:Gem::Requirement
+  requirement: &70207424502720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70138331387100
+  version_requirements: *70207424502720
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70138331385960 !ruby/object:Gem::Requirement
+  requirement: &70207424500680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70138331385960
+  version_requirements: *70207424500680
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70138331385220 !ruby/object:Gem::Requirement
+  requirement: &70207424499260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70138331385220
+  version_requirements: *70207424499260
 - !ruby/object:Gem::Dependency
   name: guard-cucumber
-  requirement: &70138331384540 !ruby/object:Gem::Requirement
+  requirement: &70207424498260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70138331384540
+  version_requirements: *70207424498260
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &70138331383720 !ruby/object:Gem::Requirement
+  requirement: &70207424497200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70138331383720
+  version_requirements: *70207424497200
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70138331380640 !ruby/object:Gem::Requirement
+  requirement: &70207424494680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70138331380640
+  version_requirements: *70207424494680
 - !ruby/object:Gem::Dependency
   name: rb-fchange
-  requirement: &70138331378720 !ruby/object:Gem::Requirement
+  requirement: &70207424492080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70138331378720
+  version_requirements: *70207424492080
 - !ruby/object:Gem::Dependency
   name: growl_notify
-  requirement: &70138331376960 !ruby/object:Gem::Requirement
+  requirement: &70207424489100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,7 +164,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70138331376960
+  version_requirements: *70207424489100
 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
@@ -224,7 +224,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -915464957452187253
+      hash: 3834565430235223789
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: