klipbook 0.2.0 → 0.2.1

data/README.md

@@ -36,13 +36,17 @@ Klipbook is a Ruby gem. To install simply run:
 
 Currently [the Amazon highlights site](https://kindle.amazon.com/your_highlights) only shows clippings for books you've purchased on Amazon.
 
+## Supported Devices
+
+Klipbook has been tested on clippings files from 3rd generation Kindles and the Kindle Touch.
+
 ## Tested platforms
 
-Klipbook has been tested on clippings files from 3rd generation Kindles and run using MRI 1.9.3 on Mac OSX Lion and Ubuntu.
+Klipbook has been tested on Mac OSX Lion and Ubuntu using MRI 1.9.3. 
 
 ## Contributing to Klipbook
 
-Fork the project on [Github](https://github.com/grassdog/klipbook) and submit a pull request. 
+Fork the project on [Github](https://github.com/grassdog/klipbook), add tests for your changes, and submit a well described pull request. 
 
 ## Copyright
 

data/klipbook.gemspec

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

@@ -58,7 +58,7 @@ module Klipbook
     end
 
     def extract_type(metadata)
-      type = metadata.scan(/^- (\w+)/).first.first
+      type = metadata.scan(/^-( Your)? (\w+)/).first[1]
       type.downcase.to_sym
     end
 
@@ -67,11 +67,11 @@ module Klipbook
     end
 
     def extract_location(metadata)
-      match = metadata.scan(/Loc\. ([0-9]+-?)/)
+      match = metadata.scan(/Loc(ation|\.) ([0-9]+-?)/)
 
       return nil if match.empty?
 
-      location = match.first.first
+      location = match.first[1]
       location.to_i
     end
 

data/lib/klipbook/version.rb

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

data/spec/lib/klipbook/clippings_parser_spec.rb

@@ -75,6 +75,24 @@ describe Klipbook::ClippingsParser do
       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" +
@@ -92,6 +110,23 @@ describe Klipbook::ClippingsParser do
       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" +
@@ -109,6 +144,23 @@ describe Klipbook::ClippingsParser do
       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" +
@@ -127,6 +179,24 @@ describe Klipbook::ClippingsParser do
       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" +
@@ -145,6 +215,24 @@ describe Klipbook::ClippingsParser do
       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" +
@@ -163,6 +251,24 @@ describe Klipbook::ClippingsParser do
       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 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" +
@@ -179,6 +285,23 @@ describe Klipbook::ClippingsParser 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 date' do
+        subject[:added_on].should == 'Thursday, April 21, 2011, 07:31 AM'
+      end
+    end
   end
 
   describe '#build_clipping_from' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: klipbook
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-19 00:00:00.000000000 Z
+date: 2011-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70349967616040 !ruby/object:Gem::Requirement
+  requirement: &70138331394120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70349967616040
+  version_requirements: *70138331394120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70349967615480 !ruby/object:Gem::Requirement
+  requirement: &70138331393620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349967615480
+  version_requirements: *70138331393620
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70349967614940 !ruby/object:Gem::Requirement
+  requirement: &70138331392640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349967614940
+  version_requirements: *70138331392640
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70349967614380 !ruby/object:Gem::Requirement
+  requirement: &70138331391540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349967614380
+  version_requirements: *70138331391540
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70349967613900 !ruby/object:Gem::Requirement
+  requirement: &70138331390420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70349967613900
+  version_requirements: *70138331390420
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70349967613080 !ruby/object:Gem::Requirement
+  requirement: &70138331389020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349967613080
+  version_requirements: *70138331389020
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70349967611920 !ruby/object:Gem::Requirement
+  requirement: &70138331387100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349967611920
+  version_requirements: *70138331387100
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70349967609080 !ruby/object:Gem::Requirement
+  requirement: &70138331385960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349967609080
+  version_requirements: *70138331385960
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70349967607940 !ruby/object:Gem::Requirement
+  requirement: &70138331385220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349967607940
+  version_requirements: *70138331385220
 - !ruby/object:Gem::Dependency
   name: guard-cucumber
-  requirement: &70349967606880 !ruby/object:Gem::Requirement
+  requirement: &70138331384540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349967606880
+  version_requirements: *70138331384540
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &70349967605840 !ruby/object:Gem::Requirement
+  requirement: &70138331383720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349967605840
+  version_requirements: *70138331383720
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70349967603240 !ruby/object:Gem::Requirement
+  requirement: &70138331380640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349967603240
+  version_requirements: *70138331380640
 - !ruby/object:Gem::Dependency
   name: rb-fchange
-  requirement: &70349967600920 !ruby/object:Gem::Requirement
+  requirement: &70138331378720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349967600920
+  version_requirements: *70138331378720
 - !ruby/object:Gem::Dependency
   name: growl_notify
-  requirement: &70349967597660 !ruby/object:Gem::Requirement
+  requirement: &70138331376960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,7 +164,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349967597660
+  version_requirements: *70138331376960
 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: 15756344665979563
+      hash: -915464957452187253
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: